Debian Codegraph @

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