Debian Codegraph @

docs/dyn/dfareporting_v5.floodlightActivities.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_v5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v5.floodlightActivities.html">floodlightActivities</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="#delete">delete(profileId, id, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes an existing floodlight activity.</p>
83 <p class="toc_element">
84 <code><a href="#generatetag">generatetag(profileId, floodlightActivityId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Generates a tag for a floodlight activity.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets one floodlight activity by ID.</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Inserts a new floodlight activity.</p>
92 <p class="toc_element">
93 <code><a href="#list">list(profileId, advertiserId=None, floodlightActivityGroupIds=None, floodlightActivityGroupName=None, floodlightActivityGroupTagString=None, floodlightActivityGroupType=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, tagString=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves a list of floodlight activities, possibly filtered. This method supports paging.</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Updates an existing floodlight activity. This method supports patch semantics.</p>
101 <p class="toc_element">
102 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates an existing floodlight activity.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(profileId, id, x__xgafv=None)</code>
112 <pre>Deletes an existing floodlight activity.
113
114 Args:
115 profileId: string, User profile ID associated with this request. (required)
116 id: string, Floodlight activity ID. (required)
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121 </pre>
122 </div>
123
124 <div class="method">
125 <code class="details" id="generatetag">generatetag(profileId, floodlightActivityId=None, x__xgafv=None)</code>
126 <pre>Generates a tag for a floodlight activity.
127
128 Args:
129 profileId: string, User profile ID associated with this request. (required)
130 floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136 Returns:
137 An object of the form:
138
139 { # Floodlight Activity GenerateTag Response
140 &quot;floodlightActivityTag&quot;: &quot;A String&quot;, # Generated tag for this Floodlight activity. For Google tags, this is the event snippet.
141 &quot;globalSiteTagGlobalSnippet&quot;: &quot;A String&quot;, # The global snippet section of a Google tag. The Google tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.
142 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivitiesGenerateTagResponse&quot;.
143 }</pre>
144 </div>
145
146 <div class="method">
147 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
148 <pre>Gets one floodlight activity by ID.
149
150 Args:
151 profileId: string, User profile ID associated with this request. (required)
152 id: string, Floodlight activity ID. (required)
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158 Returns:
159 An object of the form:
160
161 { # Contains properties of a Floodlight activity.
162 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
163 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
164 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
165 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
166 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
167 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
168 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
169 &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.
170 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
171 },
172 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
173 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
174 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
175 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
176 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
177 { # Dynamic Tag
178 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
179 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
180 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
181 },
182 ],
183 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
184 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
185 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
186 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
187 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
188 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
189 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
190 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
191 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
192 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
193 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
194 &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.
195 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
196 },
197 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
198 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
199 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
200 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
201 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
202 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
203 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
204 &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.
205 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
206 },
207 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
208 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
209 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
210 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
211 { # Publisher Dynamic Tag
212 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
213 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
214 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
215 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
216 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
217 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
218 },
219 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
220 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
221 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
222 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
223 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
224 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
225 &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.
226 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
227 },
228 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
229 },
230 ],
231 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
232 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
233 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
234 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
235 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
236 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
237 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
238 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
239 &quot;A String&quot;,
240 ],
241 }</pre>
242 </div>
243
244 <div class="method">
245 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
246 <pre>Inserts a new floodlight activity.
247
248 Args:
249 profileId: string, User profile ID associated with this request. (required)
250 body: object, The request body.
251 The object takes the form of:
252
253 { # Contains properties of a Floodlight activity.
254 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
255 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
256 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
257 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
258 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
259 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
260 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
261 &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.
262 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
263 },
264 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
265 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
266 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
267 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
268 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
269 { # Dynamic Tag
270 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
271 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
272 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
273 },
274 ],
275 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
276 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
277 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
278 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
279 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
280 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
281 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
282 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
283 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
284 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
285 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
286 &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.
287 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
288 },
289 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
290 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
291 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
292 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
293 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
294 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
295 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
296 &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.
297 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
298 },
299 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
300 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
301 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
302 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
303 { # Publisher Dynamic Tag
304 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
305 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
306 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
307 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
308 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
309 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
310 },
311 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
312 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
313 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
314 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
315 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
316 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
317 &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.
318 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
319 },
320 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
321 },
322 ],
323 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
324 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
325 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
326 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
327 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
328 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
329 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
330 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
331 &quot;A String&quot;,
332 ],
333 }
334
335 x__xgafv: string, V1 error format.
336 Allowed values
337 1 - v1 error format
338 2 - v2 error format
339
340 Returns:
341 An object of the form:
342
343 { # Contains properties of a Floodlight activity.
344 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
345 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
346 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
347 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
348 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
349 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
350 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
351 &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.
352 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
353 },
354 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
355 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
356 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
357 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
358 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
359 { # Dynamic Tag
360 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
361 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
362 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
363 },
364 ],
365 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
366 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
367 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
368 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
369 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
370 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
371 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
372 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
373 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
374 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
375 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
376 &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.
377 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
378 },
379 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
380 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
381 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
382 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
383 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
384 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
385 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
386 &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.
387 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
388 },
389 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
390 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
391 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
392 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
393 { # Publisher Dynamic Tag
394 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
395 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
396 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
397 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
398 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
399 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
400 },
401 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
402 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
403 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
404 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
405 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
406 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
407 &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.
408 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
409 },
410 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
411 },
412 ],
413 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
414 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
415 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
416 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
417 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
418 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
419 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
420 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
421 &quot;A String&quot;,
422 ],
423 }</pre>
424 </div>
425
426 <div class="method">
427 <code class="details" id="list">list(profileId, advertiserId=None, floodlightActivityGroupIds=None, floodlightActivityGroupName=None, floodlightActivityGroupTagString=None, floodlightActivityGroupType=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, tagString=None, x__xgafv=None)</code>
428 <pre>Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
429
430 Args:
431 profileId: string, User profile ID associated with this request. (required)
432 advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
433 floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
434 floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
435 floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
436 floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
437 Allowed values
438 COUNTER -
439 SALE -
440 floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
441 ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
442 maxResults: integer, Maximum number of results to return.
443 pageToken: string, Value of the nextPageToken from the previous result page.
444 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, &quot;floodlightactivity*2015&quot; will return objects with names like &quot;floodlightactivity June 2015&quot;, &quot;floodlightactivity April 2015&quot;, or simply &quot;floodlightactivity 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;floodlightactivity&quot; will match objects with name &quot;my floodlightactivity activity&quot;, &quot;floodlightactivity 2015&quot;, or simply &quot;floodlightactivity&quot;.
445 sortField: string, Field by which to sort the list.
446 Allowed values
447 ID -
448 NAME -
449 sortOrder: string, Order of sorted results.
450 Allowed values
451 ASCENDING - Ascending order.
452 DESCENDING - Descending order.
453 tagString: string, Select only floodlight activities with the specified tag string.
454 x__xgafv: string, V1 error format.
455 Allowed values
456 1 - v1 error format
457 2 - v2 error format
458
459 Returns:
460 An object of the form:
461
462 { # Floodlight Activity List Response
463 &quot;floodlightActivities&quot;: [ # Floodlight activity collection.
464 { # Contains properties of a Floodlight activity.
465 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
466 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
467 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
468 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
469 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
470 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
471 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
472 &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.
473 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
474 },
475 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
476 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
477 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
478 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
479 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
480 { # Dynamic Tag
481 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
482 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
483 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
484 },
485 ],
486 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
487 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
488 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
489 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
490 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
491 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
492 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
493 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
494 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
495 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
496 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
497 &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.
498 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
499 },
500 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
501 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
502 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
503 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
504 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
505 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
506 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
507 &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.
508 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
509 },
510 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
511 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
512 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
513 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
514 { # Publisher Dynamic Tag
515 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
516 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
517 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
518 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
519 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
520 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
521 },
522 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
523 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
524 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
525 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
526 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
527 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
528 &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.
529 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
530 },
531 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
532 },
533 ],
534 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
535 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
536 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
537 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
538 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
539 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
540 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
541 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
542 &quot;A String&quot;,
543 ],
544 },
545 ],
546 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivitiesListResponse&quot;.
547 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
548 }</pre>
549 </div>
550
551 <div class="method">
552 <code class="details" id="list_next">list_next()</code>
553 <pre>Retrieves the next page of results.
554
555 Args:
556 previous_request: The request for the previous page. (required)
557 previous_response: The response from the request for the previous page. (required)
558
559 Returns:
560 A request object that you can call &#x27;execute()&#x27; on to request the next
561 page. Returns None if there are no more items in the collection.
562 </pre>
563 </div>
564
565 <div class="method">
566 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
567 <pre>Updates an existing floodlight activity. This method supports patch semantics.
568
569 Args:
570 profileId: string, User profile ID associated with this request. (required)
571 id: string, Required. EventTag ID. (required)
572 body: object, The request body.
573 The object takes the form of:
574
575 { # Contains properties of a Floodlight activity.
576 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
577 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
578 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
579 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
580 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
581 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
582 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
583 &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.
584 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
585 },
586 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
587 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
588 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
589 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
590 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
591 { # Dynamic Tag
592 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
593 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
594 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
595 },
596 ],
597 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
598 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
599 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
600 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
601 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
602 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
603 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
604 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
605 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
606 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
607 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
608 &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.
609 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
610 },
611 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
612 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
613 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
614 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
615 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
616 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
617 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
618 &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.
619 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
620 },
621 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
622 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
623 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
624 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
625 { # Publisher Dynamic Tag
626 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
627 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
628 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
629 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
630 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
631 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
632 },
633 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
634 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
635 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
636 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
637 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
638 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
639 &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.
640 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
641 },
642 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
643 },
644 ],
645 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
646 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
647 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
648 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
649 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
650 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
651 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
652 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
653 &quot;A String&quot;,
654 ],
655 }
656
657 x__xgafv: string, V1 error format.
658 Allowed values
659 1 - v1 error format
660 2 - v2 error format
661
662 Returns:
663 An object of the form:
664
665 { # Contains properties of a Floodlight activity.
666 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
667 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
668 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
669 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
670 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
671 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
672 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
673 &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.
674 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
675 },
676 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
677 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
678 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
679 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
680 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
681 { # Dynamic Tag
682 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
683 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
684 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
685 },
686 ],
687 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
688 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
689 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
690 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
691 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
692 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
693 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
694 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
695 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
696 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
697 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
698 &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.
699 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
700 },
701 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
702 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
703 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
704 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
705 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
706 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
707 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
708 &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.
709 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
710 },
711 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
712 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
713 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
714 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
715 { # Publisher Dynamic Tag
716 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
717 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
718 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
719 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
720 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
721 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
722 },
723 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
724 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
725 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
726 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
727 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
728 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
729 &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.
730 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
731 },
732 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
733 },
734 ],
735 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
736 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
737 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
738 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
739 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
740 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
741 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
742 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
743 &quot;A String&quot;,
744 ],
745 }</pre>
746 </div>
747
748 <div class="method">
749 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
750 <pre>Updates an existing floodlight activity.
751
752 Args:
753 profileId: string, User profile ID associated with this request. (required)
754 body: object, The request body.
755 The object takes the form of:
756
757 { # Contains properties of a Floodlight activity.
758 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
759 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
760 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
761 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
762 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
763 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
764 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
765 &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.
766 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
767 },
768 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
769 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
770 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
771 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
772 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
773 { # Dynamic Tag
774 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
775 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
776 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
777 },
778 ],
779 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
780 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
781 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
782 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
783 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
784 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
785 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
786 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
787 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
788 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
789 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
790 &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.
791 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
792 },
793 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
794 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
795 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
796 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
797 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
798 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
799 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
800 &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.
801 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
802 },
803 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
804 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
805 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
806 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
807 { # Publisher Dynamic Tag
808 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
809 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
810 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
811 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
812 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
813 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
814 },
815 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
816 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
817 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
818 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
819 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
820 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
821 &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.
822 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
823 },
824 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
825 },
826 ],
827 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
828 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
829 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
830 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
831 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
832 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
833 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
834 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
835 &quot;A String&quot;,
836 ],
837 }
838
839 x__xgafv: string, V1 error format.
840 Allowed values
841 1 - v1 error format
842 2 - v2 error format
843
844 Returns:
845 An object of the form:
846
847 { # Contains properties of a Floodlight activity.
848 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this floodlight activity. This is a read-only field that can be left blank.
849 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s advertiser or the existing activity&#x27;s advertiser.
850 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
851 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
852 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
853 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
854 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
855 &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.
856 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
857 },
858 &quot;attributionEnabled&quot;: True or False, # Whether the activity is enabled for attribution.
859 &quot;cacheBustingType&quot;: &quot;A String&quot;, # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
860 &quot;conversionCategory&quot;: &quot;A String&quot;, # Required. The conversion category of the activity.
861 &quot;countingMethod&quot;: &quot;A String&quot;, # Counting method for conversions for this floodlight activity. This is a required field.
862 &quot;defaultTags&quot;: [ # Dynamic floodlight tags.
863 { # Dynamic Tag
864 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
865 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
866 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
867 },
868 ],
869 &quot;expectedUrl&quot;: &quot;A String&quot;, # URL where this tag will be deployed. If specified, must be less than 256 characters long.
870 &quot;floodlightActivityGroupId&quot;: &quot;A String&quot;, # Floodlight activity group ID of this floodlight activity. This is a required field.
871 &quot;floodlightActivityGroupName&quot;: &quot;A String&quot;, # Name of the associated floodlight activity group. This is a read-only field.
872 &quot;floodlightActivityGroupTagString&quot;: &quot;A String&quot;, # Tag string of the associated floodlight activity group. This is a read-only field.
873 &quot;floodlightActivityGroupType&quot;: &quot;A String&quot;, # Type of the associated floodlight activity group. This is a read-only field.
874 &quot;floodlightConfigurationId&quot;: &quot;A String&quot;, # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group&#x27;s floodlight configuration or from the existing activity&#x27;s floodlight configuration.
875 &quot;floodlightConfigurationIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
876 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
877 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
878 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
879 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
880 &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.
881 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
882 },
883 &quot;floodlightTagType&quot;: &quot;A String&quot;, # The type of Floodlight tag this activity will generate. This is a required field.
884 &quot;id&quot;: &quot;A String&quot;, # ID of this floodlight activity. This is a read-only, auto-generated field.
885 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
886 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
887 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
888 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
889 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
890 &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.
891 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
892 },
893 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#floodlightActivity&quot;.
894 &quot;name&quot;: &quot;A String&quot;, # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
895 &quot;notes&quot;: &quot;A String&quot;, # General notes or implementation instructions for the tag.
896 &quot;publisherTags&quot;: [ # Publisher dynamic floodlight tags.
897 { # Publisher Dynamic Tag
898 &quot;clickThrough&quot;: True or False, # Whether this tag is applicable only for click-throughs.
899 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
900 &quot;dynamicTag&quot;: { # Dynamic Tag # Dynamic floodlight tag.
901 &quot;id&quot;: &quot;A String&quot;, # ID of this dynamic tag. This is a read-only, auto-generated field.
902 &quot;name&quot;: &quot;A String&quot;, # Name of this tag.
903 &quot;tag&quot;: &quot;A String&quot;, # Tag code.
904 },
905 &quot;siteId&quot;: &quot;A String&quot;, # Site ID of this dynamic tag.
906 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
907 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
908 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
909 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
910 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
911 &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.
912 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
913 },
914 &quot;viewThrough&quot;: True or False, # Whether this tag is applicable only for view-throughs.
915 },
916 ],
917 &quot;secure&quot;: True or False, # Whether this tag should use SSL.
918 &quot;sslCompliant&quot;: True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
919 &quot;sslRequired&quot;: True or False, # Whether this floodlight activity must be SSL-compliant.
920 &quot;status&quot;: &quot;A String&quot;, # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
921 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
922 &quot;tagFormat&quot;: &quot;A String&quot;, # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
923 &quot;tagString&quot;: &quot;A String&quot;, # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. 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 activities of the same activity group. This field is read-only after insertion.
924 &quot;userDefinedVariableTypes&quot;: [ # List of the user-defined variables used by this conversion tag. These map to the &quot;u[1-100]=&quot; in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
925 &quot;A String&quot;,
926 ],
927 }</pre>
928 </div>
929
930 </body></html>