blob: aa12bee7497105ab2cf859887415b08932b388f0 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="checks_v1alpha.html">Checks API</a> . <a href="checks_v1alpha.privacypolicy.html">privacypolicy</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#analyze">analyze(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Performs a synchronous analysis of a privacy policy, where the policy content is mapped to privacy categories, data types, and purposes.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="analyze">analyze(body=None, x__xgafv=None)</code>
<pre>Performs a synchronous analysis of a privacy policy, where the policy content is mapped to privacy categories, data types, and purposes.
Args:
body: object, The request body.
The object takes the form of:
{ # Request for the AnalyzePrivacyPolicy method.
&quot;privacyPolicyPageContent&quot;: &quot;A String&quot;, # The HTML content of the privacy policy. This is useful if you&#x27;d like to manage the crawling and rendering of the privacy policy.
&quot;privacyPolicyUri&quot;: &quot;A String&quot;, # The URI that points to the web page for the privacy policy.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing the analyzed privacy policy for the AnalyzePrivacyPolicy method.
&quot;dataPurposeAnnotations&quot;: [ # A list of detected purposes in the privacy policy.
{
&quot;endOffset&quot;: &quot;A String&quot;, # Byte offsets for the end of the purpose of use sentence inside the full text.
&quot;purposeOfUse&quot;: &quot;A String&quot;, # Purpose of use mentioned in the policy.
&quot;score&quot;: 3.14, # Score given by the model representing how confident it was regarding this `text_content` being of `purpose_of_use`.
&quot;startOffset&quot;: &quot;A String&quot;, # Byte offsets for the start of the purpose of use sentence inside the full text.
&quot;textContent&quot;: &quot;A String&quot;, # The bytes of actual text content in the sentence that mentions the purpose of use. This makes it much easier to consume the information.
},
],
&quot;dataTypeAnnotations&quot;: [ # A list of detected data types in the privacy policy.
{
&quot;dataType&quot;: &quot;A String&quot;, # Type of the data mentioned in the policy.
&quot;endOffset&quot;: &quot;A String&quot;, # Byte offsets for the end of the data type sentence inside the full text.
&quot;score&quot;: 3.14, # Score given by the model representing how confident it was regarding this `text_content` being of `data_type`.
&quot;startOffset&quot;: &quot;A String&quot;, # Byte offsets for the start of the data type sentence inside the full text.
&quot;textContent&quot;: &quot;A String&quot;, # Actual text content in the section. This makes it much easier to consume the information. NOTE: This field might contain HTML and does not guarantee a SafeHtml security contract go/safehtmltypecontracts#safehtml.
},
],
&quot;htmlContent&quot;: &quot;A String&quot;, # HTML content for the privacy policy page. The byte offsets in each annotated section will match this content.
&quot;lastUpdatedDateInfo&quot;: { # Information about the date when the privacy policy was last updated. # Information about the date when the privacy policy was last updated.
&quot;endOffset&quot;: &quot;A String&quot;, # Byte offsets for the end of the date text inside the full text.
&quot;lastUpdatedDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date when the privacy policy was last updated.
&quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
&quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
&quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
&quot;startOffset&quot;: &quot;A String&quot;, # Byte offsets for the start of the date text inside the full text.
&quot;textContent&quot;: &quot;A String&quot;, # The bytes of actual text content in the section. Note: - This will correspond to the whole sentence that includes the date. - This field might contain HTML and it is not sanitized.
},
&quot;sectionAnnotations&quot;: [ # A list of detected topics in the privacy policy.
{
&quot;endOffset&quot;: &quot;A String&quot;, # Byte offsets for the end of the section inside the full text.
&quot;score&quot;: 3.14, # Score given by the model representing how confident it was regarding this `text_content` being of `section_type`.
&quot;sectionType&quot;: &quot;A String&quot;, # Detected type of the high-level topic in the policy.
&quot;startOffset&quot;: &quot;A String&quot;, # Byte offsets for the start of the section inside the full text.
&quot;textContent&quot;: &quot;A String&quot;, # Actual text content in the section.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
</body></html>