Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.reportingDataAnnotations.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.reportingDataAnnotations.html">reportingDataAnnotations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a Reporting Data Annotation.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a Reporting Data Annotation.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lookup a single Reporting Data Annotation.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">List all Reporting Data Annotations on a property.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a Reporting Data Annotation.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
106 <pre>Creates a Reporting Data Annotation.
107
108 Args:
109 parent: string, Required. The property for which to create a Reporting Data Annotation. Format: properties/property_id Example: properties/123 (required)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # A Reporting Data Annotation is a comment connected to certain dates for reporting data.
114 &quot;annotationDate&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 # If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
115 &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.
116 &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.
117 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
118 },
119 &quot;annotationDateRange&quot;: { # Represents a Reporting Data Annotation&#x27;s date range, both start and end dates are inclusive. Time zones are based on the parent property. # If set, the Reporting Data Annotation is for a range of dates represented by this field.
120 &quot;endDate&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 # Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date.
121 &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.
122 &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.
123 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
124 },
125 &quot;startDate&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 # Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future.
126 &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.
127 &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.
128 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
129 },
130 },
131 &quot;color&quot;: &quot;A String&quot;, # Required. The color used for display of this Reporting Data Annotation.
132 &quot;description&quot;: &quot;A String&quot;, # Optional. Description for this Reporting Data Annotation.
133 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of this Reporting Data Annotation. Format: &#x27;properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}&#x27; Format: &#x27;properties/123/reportingDataAnnotations/456&#x27;
134 &quot;systemGenerated&quot;: True or False, # Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
135 &quot;title&quot;: &quot;A String&quot;, # Required. Human-readable title for this Reporting Data Annotation.
136 }
137
138 x__xgafv: string, V1 error format.
139 Allowed values
140 1 - v1 error format
141 2 - v2 error format
142
143 Returns:
144 An object of the form:
145
146 { # A Reporting Data Annotation is a comment connected to certain dates for reporting data.
147 &quot;annotationDate&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 # If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
148 &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.
149 &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.
150 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
151 },
152 &quot;annotationDateRange&quot;: { # Represents a Reporting Data Annotation&#x27;s date range, both start and end dates are inclusive. Time zones are based on the parent property. # If set, the Reporting Data Annotation is for a range of dates represented by this field.
153 &quot;endDate&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 # Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date.
154 &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.
155 &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.
156 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
157 },
158 &quot;startDate&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 # Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future.
159 &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.
160 &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.
161 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
162 },
163 },
164 &quot;color&quot;: &quot;A String&quot;, # Required. The color used for display of this Reporting Data Annotation.
165 &quot;description&quot;: &quot;A String&quot;, # Optional. Description for this Reporting Data Annotation.
166 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of this Reporting Data Annotation. Format: &#x27;properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}&#x27; Format: &#x27;properties/123/reportingDataAnnotations/456&#x27;
167 &quot;systemGenerated&quot;: True or False, # Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
168 &quot;title&quot;: &quot;A String&quot;, # Required. Human-readable title for this Reporting Data Annotation.
169 }</pre>
170 </div>
171
172 <div class="method">
173 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
174 <pre>Deletes a Reporting Data Annotation.
175
176 Args:
177 name: string, Required. Resource name of the Reporting Data Annotation to delete. Format: properties/property_id/reportingDataAnnotations/reporting_data_annotation Example: properties/123/reportingDataAnnotations/456 (required)
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183 Returns:
184 An object of the form:
185
186 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
187 }</pre>
188 </div>
189
190 <div class="method">
191 <code class="details" id="get">get(name, x__xgafv=None)</code>
192 <pre>Lookup a single Reporting Data Annotation.
193
194 Args:
195 name: string, Required. Resource name of the Reporting Data Annotation to lookup. Format: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Example: properties/123/reportingDataAnnotations/456 (required)
196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201 Returns:
202 An object of the form:
203
204 { # A Reporting Data Annotation is a comment connected to certain dates for reporting data.
205 &quot;annotationDate&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 # If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
206 &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.
207 &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.
208 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
209 },
210 &quot;annotationDateRange&quot;: { # Represents a Reporting Data Annotation&#x27;s date range, both start and end dates are inclusive. Time zones are based on the parent property. # If set, the Reporting Data Annotation is for a range of dates represented by this field.
211 &quot;endDate&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 # Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date.
212 &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.
213 &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.
214 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
215 },
216 &quot;startDate&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 # Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future.
217 &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.
218 &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.
219 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
220 },
221 },
222 &quot;color&quot;: &quot;A String&quot;, # Required. The color used for display of this Reporting Data Annotation.
223 &quot;description&quot;: &quot;A String&quot;, # Optional. Description for this Reporting Data Annotation.
224 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of this Reporting Data Annotation. Format: &#x27;properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}&#x27; Format: &#x27;properties/123/reportingDataAnnotations/456&#x27;
225 &quot;systemGenerated&quot;: True or False, # Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
226 &quot;title&quot;: &quot;A String&quot;, # Required. Human-readable title for this Reporting Data Annotation.
227 }</pre>
228 </div>
229
230 <div class="method">
231 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
232 <pre>List all Reporting Data Annotations on a property.
233
234 Args:
235 parent: string, Required. Resource name of the property. Format: properties/property_id Example: properties/123 (required)
236 filter: string, Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: * &#x27;name&#x27; * `title` * `description` * `annotation_date` * `annotation_date_range` * `color` Additionally, this API provides the following helper functions: * annotation_duration() : the duration that this annotation marks, [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto). expect a numeric representation of seconds followed by an `s` suffix. * is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the `start_date` and `end_date`. The dates are in ISO-8601 format, for example `2031-06-28`. Supported operations: * `=` : equals * `!=` : not equals * `&lt;` : less than * `&gt;` : greater than * `&lt;=` : less than or equals * `&gt;=` : greater than or equals * `:` : has operator * `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax) match * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax) does not match * `NOT` : Logical not * `AND` : Logical and * `OR` : Logical or Examples: 1. `title=&quot;Holiday Sale&quot;` 2. `description=~&quot;[Bb]ig [Gg]ame.*[Ss]ale&quot;` 3. `is_annotation_in_range(&quot;2025-12-25&quot;, &quot;2026-01-16&quot;) = true` 4. `annotation_duration() &gt;= 172800s AND title:BOGO`
237 pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
238 pageToken: string, Optional. A page token, received from a previous `ListReportingDataAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReportingDataAnnotations` must match the call that provided the page token.
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
243
244 Returns:
245 An object of the form:
246
247 { # Response message for ListReportingDataAnnotation RPC.
248 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
249 &quot;reportingDataAnnotations&quot;: [ # List of Reporting Data Annotations.
250 { # A Reporting Data Annotation is a comment connected to certain dates for reporting data.
251 &quot;annotationDate&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 # If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
252 &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.
253 &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.
254 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
255 },
256 &quot;annotationDateRange&quot;: { # Represents a Reporting Data Annotation&#x27;s date range, both start and end dates are inclusive. Time zones are based on the parent property. # If set, the Reporting Data Annotation is for a range of dates represented by this field.
257 &quot;endDate&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 # Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date.
258 &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.
259 &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.
260 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
261 },
262 &quot;startDate&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 # Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future.
263 &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.
264 &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.
265 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
266 },
267 },
268 &quot;color&quot;: &quot;A String&quot;, # Required. The color used for display of this Reporting Data Annotation.
269 &quot;description&quot;: &quot;A String&quot;, # Optional. Description for this Reporting Data Annotation.
270 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of this Reporting Data Annotation. Format: &#x27;properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}&#x27; Format: &#x27;properties/123/reportingDataAnnotations/456&#x27;
271 &quot;systemGenerated&quot;: True or False, # Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
272 &quot;title&quot;: &quot;A String&quot;, # Required. Human-readable title for this Reporting Data Annotation.
273 },
274 ],
275 }</pre>
276 </div>
277
278 <div class="method">
279 <code class="details" id="list_next">list_next()</code>
280 <pre>Retrieves the next page of results.
281
282 Args:
283 previous_request: The request for the previous page. (required)
284 previous_response: The response from the request for the previous page. (required)
285
286 Returns:
287 A request object that you can call &#x27;execute()&#x27; on to request the next
288 page. Returns None if there are no more items in the collection.
289 </pre>
290 </div>
291
292 <div class="method">
293 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
294 <pre>Updates a Reporting Data Annotation.
295
296 Args:
297 name: string, Required. Identifier. Resource name of this Reporting Data Annotation. Format: &#x27;properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}&#x27; Format: &#x27;properties/123/reportingDataAnnotations/456&#x27; (required)
298 body: object, The request body.
299 The object takes the form of:
300
301 { # A Reporting Data Annotation is a comment connected to certain dates for reporting data.
302 &quot;annotationDate&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 # If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
303 &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.
304 &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.
305 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
306 },
307 &quot;annotationDateRange&quot;: { # Represents a Reporting Data Annotation&#x27;s date range, both start and end dates are inclusive. Time zones are based on the parent property. # If set, the Reporting Data Annotation is for a range of dates represented by this field.
308 &quot;endDate&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 # Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date.
309 &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.
310 &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.
311 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
312 },
313 &quot;startDate&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 # Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future.
314 &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.
315 &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.
316 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
317 },
318 },
319 &quot;color&quot;: &quot;A String&quot;, # Required. The color used for display of this Reporting Data Annotation.
320 &quot;description&quot;: &quot;A String&quot;, # Optional. Description for this Reporting Data Annotation.
321 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of this Reporting Data Annotation. Format: &#x27;properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}&#x27; Format: &#x27;properties/123/reportingDataAnnotations/456&#x27;
322 &quot;systemGenerated&quot;: True or False, # Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
323 &quot;title&quot;: &quot;A String&quot;, # Required. Human-readable title for this Reporting Data Annotation.
324 }
325
326 updateMask: string, Optional. The list of fields to update. Field names must be in snake case (for example, &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331
332 Returns:
333 An object of the form:
334
335 { # A Reporting Data Annotation is a comment connected to certain dates for reporting data.
336 &quot;annotationDate&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 # If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future.
337 &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.
338 &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.
339 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
340 },
341 &quot;annotationDateRange&quot;: { # Represents a Reporting Data Annotation&#x27;s date range, both start and end dates are inclusive. Time zones are based on the parent property. # If set, the Reporting Data Annotation is for a range of dates represented by this field.
342 &quot;endDate&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 # Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date.
343 &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.
344 &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.
345 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
346 },
347 &quot;startDate&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 # Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future.
348 &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.
349 &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.
350 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
351 },
352 },
353 &quot;color&quot;: &quot;A String&quot;, # Required. The color used for display of this Reporting Data Annotation.
354 &quot;description&quot;: &quot;A String&quot;, # Optional. Description for this Reporting Data Annotation.
355 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Resource name of this Reporting Data Annotation. Format: &#x27;properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}&#x27; Format: &#x27;properties/123/reportingDataAnnotations/456&#x27;
356 &quot;systemGenerated&quot;: True or False, # Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted.
357 &quot;title&quot;: &quot;A String&quot;, # Required. Human-readable title for this Reporting Data Annotation.
358 }</pre>
359 </div>
360
361 </body></html>