Debian Codegraph @

docs/dyn/dfareporting_v4.floodlightActivityGroups.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="dfareporting_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.floodlightActivityGroups.html">floodlightActivityGroups</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="#get">get(profileId, id, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets one floodlight activity group by ID.</p>
83 <p class="toc_element">
84 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Inserts a new floodlight activity group.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(profileId, advertiserId=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates an existing floodlight activity group. This method supports patch semantics.</p>
95 <p class="toc_element">
96 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an existing floodlight activity group.</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="get">get(profileId, id, x__xgafv=None)</code>
106 <pre>Gets one floodlight activity group by ID.
107
108 Args:
109 profileId: string, User profile ID associated with this request. (required)
110 id: string, Floodlight activity Group ID. (required)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116 Returns:
117 An object of the form:
118
119 { # Contains properties of a Floodlight activity group.
120 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
121 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
122 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
123 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
124 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
125 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
126 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
127 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
128 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
129 },
130 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
131 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
132 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
133 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
134 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
135 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
136 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
137 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
138 },
139 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
140 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
141 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
142 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
143 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
144 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
145 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
146 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
147 },
148 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
149 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
150 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
151 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
152 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
153 }</pre>
154 </div>
155
156 <div class="method">
157 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
158 <pre>Inserts a new floodlight activity group.
159
160 Args:
161 profileId: string, User profile ID associated with this request. (required)
162 body: object, The request body.
163 The object takes the form of:
164
165 { # Contains properties of a Floodlight activity group.
166 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
167 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
168 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
169 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
170 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
171 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
172 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
173 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
174 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
175 },
176 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
177 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
178 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
179 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
180 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
181 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
182 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
183 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
184 },
185 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
186 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
187 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
188 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
189 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
190 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
191 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
192 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
193 },
194 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
195 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
196 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
197 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
198 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
199 }
200
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206 Returns:
207 An object of the form:
208
209 { # Contains properties of a Floodlight activity group.
210 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
211 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
212 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
213 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
214 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
215 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
216 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
217 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
218 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
219 },
220 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
221 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
222 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
223 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
224 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
225 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
226 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
227 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
228 },
229 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
230 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
231 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
232 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
233 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
234 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
235 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
236 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
237 },
238 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
239 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
240 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
241 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
242 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
243 }</pre>
244 </div>
245
246 <div class="method">
247 <code class="details" id="list">list(profileId, advertiserId=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)</code>
248 <pre>Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
249
250 Args:
251 profileId: string, User profile ID associated with this request. (required)
252 advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
253 floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
254 ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
255 maxResults: integer, Maximum number of results to return.
256 pageToken: string, Value of the nextPageToken from the previous result page.
257 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, &quot;floodlightactivitygroup*2015&quot; will return objects with names like &quot;floodlightactivitygroup June 2015&quot;, &quot;floodlightactivitygroup April 2015&quot;, or simply &quot;floodlightactivitygroup 2015&quot;. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of &quot;floodlightactivitygroup&quot; will match objects with name &quot;my floodlightactivitygroup activity&quot;, &quot;floodlightactivitygroup 2015&quot;, or simply &quot;floodlightactivitygroup&quot;.
258 sortField: string, Field by which to sort the list.
259 Allowed values
260 ID -
261 NAME -
262 sortOrder: string, Order of sorted results.
263 Allowed values
264 ASCENDING - Ascending order.
265 DESCENDING - Descending order.
266 type: string, Select only floodlight activity groups with the specified floodlight activity group type.
267 Allowed values
268 COUNTER -
269 SALE -
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275 Returns:
276 An object of the form:
277
278 { # Floodlight Activity Group List Response
279 &quot;floodlightActivityGroups&quot;: [ # Floodlight activity group collection.
280 { # Contains properties of a Floodlight activity group.
281 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
282 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
283 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
284 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
285 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
286 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
287 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
288 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
289 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
290 },
291 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
292 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
293 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
294 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
295 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
296 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
297 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
298 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
299 },
300 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
301 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
302 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
303 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
304 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
305 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
306 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
307 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
308 },
309 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
310 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
311 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
312 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
313 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
314 },
315 ],
316 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroupsListResponse&quot;.
317 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
318 }</pre>
319 </div>
320
321 <div class="method">
322 <code class="details" id="list_next">list_next()</code>
323 <pre>Retrieves the next page of results.
324
325 Args:
326 previous_request: The request for the previous page. (required)
327 previous_response: The response from the request for the previous page. (required)
328
329 Returns:
330 A request object that you can call &#x27;execute()&#x27; on to request the next
331 page. Returns None if there are no more items in the collection.
332 </pre>
333 </div>
334
335 <div class="method">
336 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
337 <pre>Updates an existing floodlight activity group. This method supports patch semantics.
338
339 Args:
340 profileId: string, User profile ID associated with this request. (required)
341 id: string, Required. EventTag ID. (required)
342 body: object, The request body.
343 The object takes the form of:
344
345 { # Contains properties of a Floodlight activity group.
346 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
347 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
348 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
349 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
350 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
351 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
352 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
353 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
354 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
355 },
356 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
357 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
358 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
359 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
360 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
361 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
362 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
363 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
364 },
365 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
366 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
367 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
368 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
369 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
370 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
371 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
372 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
373 },
374 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
375 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
376 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
377 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
378 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
379 }
380
381 x__xgafv: string, V1 error format.
382 Allowed values
383 1 - v1 error format
384 2 - v2 error format
385
386 Returns:
387 An object of the form:
388
389 { # Contains properties of a Floodlight activity group.
390 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
391 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
392 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
393 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
394 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
395 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
396 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
397 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
398 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
399 },
400 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
401 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
402 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
403 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
404 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
405 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
406 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
407 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
408 },
409 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
410 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
411 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
412 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
413 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
414 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
415 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
416 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
417 },
418 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
419 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
420 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
421 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
422 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
423 }</pre>
424 </div>
425
426 <div class="method">
427 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
428 <pre>Updates an existing floodlight activity group.
429
430 Args:
431 profileId: string, User profile ID associated with this request. (required)
432 body: object, The request body.
433 The object takes the form of:
434
435 { # Contains properties of a Floodlight activity group.
436 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
437 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
438 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
439 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
440 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
441 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
442 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
443 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
444 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
445 },
446 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
447 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
448 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
449 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
450 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
451 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
452 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
453 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
454 },
455 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
456 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
457 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
458 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
459 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
460 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
461 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
462 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
463 },
464 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
465 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
466 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
467 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
468 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
469 }
470
471 x__xgafv: string, V1 error format.
472 Allowed values
473 1 - v1 error format
474 2 - v2 error format
475
476 Returns:
477 An object of the form:
478
479 { # Contains properties of a Floodlight activity group.
480 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
481 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration&#x27;s advertiser or from the existing activity group&#x27;s advertiser.
482 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
483 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
484 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
485 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
486 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
487 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
488 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
489 },
490 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity group. This is a required field.
491 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
492 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
493 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
494 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
495 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
496 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
497 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
498 },
499 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity group. This is a read-only, auto-generated field.
500 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
501 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
502 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
503 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
504 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
505 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
506 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
507 },
508 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivityGroup&quot;.
509 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
510 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
511 &quot;tagString&quot;: &quot;A String&quot;, # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
512 &quot;type&quot;: &quot;A String&quot;, # Type of the floodlight activity group. This is a required field that is read-only after insertion.
513 }</pre>
514 </div>
515
516 </body></html>