blob: 159783e07c40d015962099fbe97dd56d9bf6ce89 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="displayvideo_v1.advertisers.assets.html">assets()</a></code>
79</p>
80<p class="firstline">Returns the assets Resource.</p>
81
82<p class="toc_element">
83 <code><a href="displayvideo_v1.advertisers.campaigns.html">campaigns()</a></code>
84</p>
85<p class="firstline">Returns the campaigns Resource.</p>
86
87<p class="toc_element">
88 <code><a href="displayvideo_v1.advertisers.channels.html">channels()</a></code>
89</p>
90<p class="firstline">Returns the channels Resource.</p>
91
92<p class="toc_element">
93 <code><a href="displayvideo_v1.advertisers.creatives.html">creatives()</a></code>
94</p>
95<p class="firstline">Returns the creatives Resource.</p>
96
97<p class="toc_element">
98 <code><a href="displayvideo_v1.advertisers.insertionOrders.html">insertionOrders()</a></code>
99</p>
100<p class="firstline">Returns the insertionOrders Resource.</p>
101
102<p class="toc_element">
103 <code><a href="displayvideo_v1.advertisers.lineItems.html">lineItems()</a></code>
104</p>
105<p class="firstline">Returns the lineItems Resource.</p>
106
107<p class="toc_element">
108 <code><a href="displayvideo_v1.advertisers.locationLists.html">locationLists()</a></code>
109</p>
110<p class="firstline">Returns the locationLists Resource.</p>
111
112<p class="toc_element">
113 <code><a href="displayvideo_v1.advertisers.negativeKeywordLists.html">negativeKeywordLists()</a></code>
114</p>
115<p class="firstline">Returns the negativeKeywordLists Resource.</p>
116
117<p class="toc_element">
118 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
119<p class="firstline">Creates a new advertiser.</p>
120<p class="toc_element">
121 <code><a href="#delete">delete(advertiserId, x__xgafv=None)</a></code></p>
122<p class="firstline">Deletes an advertiser.</p>
123<p class="toc_element">
124 <code><a href="#get">get(advertiserId, x__xgafv=None)</a></code></p>
125<p class="firstline">Gets an advertiser.</p>
126<p class="toc_element">
127 <code><a href="#list">list(pageToken=None, orderBy=None, pageSize=None, partnerId=None, filter=None, x__xgafv=None)</a></code></p>
128<p class="firstline">Lists advertisers that are accessible to the current user.</p>
129<p class="toc_element">
130 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
131<p class="firstline">Retrieves the next page of results.</p>
132<p class="toc_element">
133 <code><a href="#patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
134<p class="firstline">Updates an existing advertiser.</p>
135<h3>Method Details</h3>
136<div class="method">
137 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
138 <pre>Creates a new advertiser.
139Returns the newly created advertiser if successful.
140This method can take up to 180 seconds to complete.
141
142Args:
143 body: object, The request body.
144 The object takes the form of:
145
146{ # A single advertiser in Display &amp; Video 360 (DV360).
147 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the
148 # advertiser can spend their budgets and bid on inventory.
149 #
150 # * Accepted values are `ENTITY_STATUS_ACTIVE` and
151 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
152 # * If set to
153 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
154 # days from when it was first scheduled for deletion.
155 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
156 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service
157 # (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag
158 # containing this ID to the creative tag.
159 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
160 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA)
161 # compliance.
162 #
163 # Warning: Changing OBA settings may cause the audit status of your creatives
164 # to be reset by some ad exchanges, making them ineligible to serve until
165 # they are re-approved.
166 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company,
167 # authorize Google to use video creatives associated with this Display &amp;
168 # Video 360 advertiser to provide reporting and features related to the
169 # advertiser&#x27;s television campaigns.
170 #
171 # Applicable only when the advertiser has a
172 # CM hybrid ad server
173 # configuration.
174 },
175 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
176 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
177 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
178 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser.
179 # Only integrationCode is currently
180 # applicable to advertiser. Other fields of IntegrationDetails are not
181 # supported and will be ignored if provided.
182 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
183 #
184 # Must be UTF-8 encoded with a length of no more than 1000 characters.
185 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
186 # The integration code will show up together with the entry in many
187 # places in the system, for example, reporting.
188 #
189 # Must be UTF-8 encoded with a length of no more than 500 characters.
190 },
191 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
192 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
193 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
194 # third-party ad servers.
195 # ad servers.
196 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
197 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
198 # authorize the sharing of information from the given Floodlight
199 # configuration to this Display &amp; Video 360 advertiser.
200 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
201 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
202 # advertiser.
203 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
204 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives.
205 #
206 # If absent or empty in
207 # CreateAdvertiser method, the system
208 # will automatically create a CM site.
209 #
210 # Removing sites from this list may cause DV360 creatives synced from CM to
211 # be deleted. At least one site must be specified.
212 &quot;A String&quot;,
213 ],
214 },
215 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
216 # only.
217 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled.
218 # This value cannot be changed once set to `true`.
219 },
220 },
221 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
222 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
223 #
224 # If not specified, the SDF settings of the parent partner are used.
225 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its
226 # parent partner.
227 #
228 # By default, an advertiser inherits the SDF configuration from the parent
229 # partner. To override the partner configuration, set this field to `true`
230 # and provide the new configuration in
231 # sdfConfig.
232 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
233 #
234 # * Required when
235 # overridePartnerSdfConfig
236 # is `true`.
237 # * Output only when
238 # overridePartnerSdfConfig
239 # is `false`.
240 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports
241 # will be sent.
242 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
243 },
244 },
245 },
246 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
247 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website.
248 # The system will send this information to publishers that require website
249 # URL to associate a campaign with an advertiser.
250 #
251 # Provide a URL with no path or query string, beginning with `http:` or
252 # `https:`.
253 # For example, http://www.example.com
254 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone.
255 # For example, `America/New_York`.
256 #
257 # See more at:
258 # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
259 #
260 # For CM hybrid advertisers, the time zone is the same as that of the
261 # associated CM account; for third-party only advertisers, the time zone is
262 # the same as that of the parent partner.
263 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format.
264 #
265 # Accepted codes and the currencies they represent are:
266 #
267 # Currency Code : Currency Name
268 #
269 # * `ARS` : Argentine Peso
270 # * `AUD` : Australian Dollar
271 # * `BRL` : Brazilian Real
272 # * `CAD` : Canadian Dollar
273 # * `CHF` : Swiss Franc
274 # * `CLP` : Chilean Peso
275 # * `CNY` : Chinese Yuan
276 # * `COP` : Colombian Peso
277 # * `CZK` : Czech Koruna
278 # * `DKK` : Danish Krone
279 # * `EGP` : Egyption Pound
280 # * `EUR` : Euro
281 # * `GBP` : British Pound
282 # * `HKD` : Hong Kong Dollar
283 # * `HUF` : Hungarian Forint
284 # * `IDR` : Indonesian Rupiah
285 # * `ILS` : Israeli Shekel
286 # * `INR` : Indian Rupee
287 # * `JPY` : Japanese Yen
288 # * `KRW` : South Korean Won
289 # * `MXN` : Mexican Pesos
290 # * `MYR` : Malaysian Ringgit
291 # * `NGN` : Nigerian Naira
292 # * `NOK` : Norwegian Krone
293 # * `NZD` : New Zealand Dollar
294 # * `PEN` : Peruvian Nuevo Sol
295 # * `PLN` : Polish Zloty
296 # * `RON` : New Romanian Leu
297 # * `RUB` : Russian Ruble
298 # * `SEK` : Swedish Krona
299 # * `TRY` : Turkish Lira
300 # * `TWD` : New Taiwan Dollar
301 # * `USD` : US Dollar
302 # * `ZAR` : South African Rand
303 },
304 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser.
305 #
306 # Must be UTF-8 encoded with a maximum size of 240 bytes.
307}
308
309 x__xgafv: string, V1 error format.
310 Allowed values
311 1 - v1 error format
312 2 - v2 error format
313
314Returns:
315 An object of the form:
316
317 { # A single advertiser in Display &amp; Video 360 (DV360).
318 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the
319 # advertiser can spend their budgets and bid on inventory.
320 #
321 # * Accepted values are `ENTITY_STATUS_ACTIVE` and
322 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
323 # * If set to
324 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
325 # days from when it was first scheduled for deletion.
326 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
327 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service
328 # (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag
329 # containing this ID to the creative tag.
330 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
331 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA)
332 # compliance.
333 #
334 # Warning: Changing OBA settings may cause the audit status of your creatives
335 # to be reset by some ad exchanges, making them ineligible to serve until
336 # they are re-approved.
337 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company,
338 # authorize Google to use video creatives associated with this Display &amp;
339 # Video 360 advertiser to provide reporting and features related to the
340 # advertiser&#x27;s television campaigns.
341 #
342 # Applicable only when the advertiser has a
343 # CM hybrid ad server
344 # configuration.
345 },
346 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
347 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
348 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
349 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser.
350 # Only integrationCode is currently
351 # applicable to advertiser. Other fields of IntegrationDetails are not
352 # supported and will be ignored if provided.
353 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
354 #
355 # Must be UTF-8 encoded with a length of no more than 1000 characters.
356 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
357 # The integration code will show up together with the entry in many
358 # places in the system, for example, reporting.
359 #
360 # Must be UTF-8 encoded with a length of no more than 500 characters.
361 },
362 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
363 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
364 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
365 # third-party ad servers.
366 # ad servers.
367 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
368 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
369 # authorize the sharing of information from the given Floodlight
370 # configuration to this Display &amp; Video 360 advertiser.
371 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
372 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
373 # advertiser.
374 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
375 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives.
376 #
377 # If absent or empty in
378 # CreateAdvertiser method, the system
379 # will automatically create a CM site.
380 #
381 # Removing sites from this list may cause DV360 creatives synced from CM to
382 # be deleted. At least one site must be specified.
383 &quot;A String&quot;,
384 ],
385 },
386 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
387 # only.
388 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled.
389 # This value cannot be changed once set to `true`.
390 },
391 },
392 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
393 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
394 #
395 # If not specified, the SDF settings of the parent partner are used.
396 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its
397 # parent partner.
398 #
399 # By default, an advertiser inherits the SDF configuration from the parent
400 # partner. To override the partner configuration, set this field to `true`
401 # and provide the new configuration in
402 # sdfConfig.
403 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
404 #
405 # * Required when
406 # overridePartnerSdfConfig
407 # is `true`.
408 # * Output only when
409 # overridePartnerSdfConfig
410 # is `false`.
411 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports
412 # will be sent.
413 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
414 },
415 },
416 },
417 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
418 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website.
419 # The system will send this information to publishers that require website
420 # URL to associate a campaign with an advertiser.
421 #
422 # Provide a URL with no path or query string, beginning with `http:` or
423 # `https:`.
424 # For example, http://www.example.com
425 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone.
426 # For example, `America/New_York`.
427 #
428 # See more at:
429 # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
430 #
431 # For CM hybrid advertisers, the time zone is the same as that of the
432 # associated CM account; for third-party only advertisers, the time zone is
433 # the same as that of the parent partner.
434 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format.
435 #
436 # Accepted codes and the currencies they represent are:
437 #
438 # Currency Code : Currency Name
439 #
440 # * `ARS` : Argentine Peso
441 # * `AUD` : Australian Dollar
442 # * `BRL` : Brazilian Real
443 # * `CAD` : Canadian Dollar
444 # * `CHF` : Swiss Franc
445 # * `CLP` : Chilean Peso
446 # * `CNY` : Chinese Yuan
447 # * `COP` : Colombian Peso
448 # * `CZK` : Czech Koruna
449 # * `DKK` : Danish Krone
450 # * `EGP` : Egyption Pound
451 # * `EUR` : Euro
452 # * `GBP` : British Pound
453 # * `HKD` : Hong Kong Dollar
454 # * `HUF` : Hungarian Forint
455 # * `IDR` : Indonesian Rupiah
456 # * `ILS` : Israeli Shekel
457 # * `INR` : Indian Rupee
458 # * `JPY` : Japanese Yen
459 # * `KRW` : South Korean Won
460 # * `MXN` : Mexican Pesos
461 # * `MYR` : Malaysian Ringgit
462 # * `NGN` : Nigerian Naira
463 # * `NOK` : Norwegian Krone
464 # * `NZD` : New Zealand Dollar
465 # * `PEN` : Peruvian Nuevo Sol
466 # * `PLN` : Polish Zloty
467 # * `RON` : New Romanian Leu
468 # * `RUB` : Russian Ruble
469 # * `SEK` : Swedish Krona
470 # * `TRY` : Turkish Lira
471 # * `TWD` : New Taiwan Dollar
472 # * `USD` : US Dollar
473 # * `ZAR` : South African Rand
474 },
475 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser.
476 #
477 # Must be UTF-8 encoded with a maximum size of 240 bytes.
478 }</pre>
479</div>
480
481<div class="method">
482 <code class="details" id="delete">delete(advertiserId, x__xgafv=None)</code>
483 <pre>Deletes an advertiser.
484Deleting an advertiser will delete all of its child resources, for example,
485campaigns, insertion orders and line items.
486A deleted advertiser cannot be recovered.
487
488Args:
489 advertiserId: string, The ID of the advertiser we need to delete. (required)
490 x__xgafv: string, V1 error format.
491 Allowed values
492 1 - v1 error format
493 2 - v2 error format
494
495Returns:
496 An object of the form:
497
498 { # A generic empty message that you can re-use to avoid defining duplicated
499 # empty messages in your APIs. A typical example is to use it as the request
500 # or the response type of an API method. For instance:
501 #
502 # service Foo {
503 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
504 # }
505 #
506 # The JSON representation for `Empty` is empty JSON object `{}`.
507 }</pre>
508</div>
509
510<div class="method">
511 <code class="details" id="get">get(advertiserId, x__xgafv=None)</code>
512 <pre>Gets an advertiser.
513
514Args:
515 advertiserId: string, Required. The ID of the advertiser to fetch. (required)
516 x__xgafv: string, V1 error format.
517 Allowed values
518 1 - v1 error format
519 2 - v2 error format
520
521Returns:
522 An object of the form:
523
524 { # A single advertiser in Display &amp; Video 360 (DV360).
525 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the
526 # advertiser can spend their budgets and bid on inventory.
527 #
528 # * Accepted values are `ENTITY_STATUS_ACTIVE` and
529 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
530 # * If set to
531 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
532 # days from when it was first scheduled for deletion.
533 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
534 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service
535 # (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag
536 # containing this ID to the creative tag.
537 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
538 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA)
539 # compliance.
540 #
541 # Warning: Changing OBA settings may cause the audit status of your creatives
542 # to be reset by some ad exchanges, making them ineligible to serve until
543 # they are re-approved.
544 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company,
545 # authorize Google to use video creatives associated with this Display &amp;
546 # Video 360 advertiser to provide reporting and features related to the
547 # advertiser&#x27;s television campaigns.
548 #
549 # Applicable only when the advertiser has a
550 # CM hybrid ad server
551 # configuration.
552 },
553 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
554 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
555 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
556 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser.
557 # Only integrationCode is currently
558 # applicable to advertiser. Other fields of IntegrationDetails are not
559 # supported and will be ignored if provided.
560 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
561 #
562 # Must be UTF-8 encoded with a length of no more than 1000 characters.
563 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
564 # The integration code will show up together with the entry in many
565 # places in the system, for example, reporting.
566 #
567 # Must be UTF-8 encoded with a length of no more than 500 characters.
568 },
569 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
570 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
571 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
572 # third-party ad servers.
573 # ad servers.
574 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
575 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
576 # authorize the sharing of information from the given Floodlight
577 # configuration to this Display &amp; Video 360 advertiser.
578 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
579 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
580 # advertiser.
581 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
582 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives.
583 #
584 # If absent or empty in
585 # CreateAdvertiser method, the system
586 # will automatically create a CM site.
587 #
588 # Removing sites from this list may cause DV360 creatives synced from CM to
589 # be deleted. At least one site must be specified.
590 &quot;A String&quot;,
591 ],
592 },
593 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
594 # only.
595 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled.
596 # This value cannot be changed once set to `true`.
597 },
598 },
599 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
600 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
601 #
602 # If not specified, the SDF settings of the parent partner are used.
603 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its
604 # parent partner.
605 #
606 # By default, an advertiser inherits the SDF configuration from the parent
607 # partner. To override the partner configuration, set this field to `true`
608 # and provide the new configuration in
609 # sdfConfig.
610 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
611 #
612 # * Required when
613 # overridePartnerSdfConfig
614 # is `true`.
615 # * Output only when
616 # overridePartnerSdfConfig
617 # is `false`.
618 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports
619 # will be sent.
620 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
621 },
622 },
623 },
624 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
625 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website.
626 # The system will send this information to publishers that require website
627 # URL to associate a campaign with an advertiser.
628 #
629 # Provide a URL with no path or query string, beginning with `http:` or
630 # `https:`.
631 # For example, http://www.example.com
632 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone.
633 # For example, `America/New_York`.
634 #
635 # See more at:
636 # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
637 #
638 # For CM hybrid advertisers, the time zone is the same as that of the
639 # associated CM account; for third-party only advertisers, the time zone is
640 # the same as that of the parent partner.
641 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format.
642 #
643 # Accepted codes and the currencies they represent are:
644 #
645 # Currency Code : Currency Name
646 #
647 # * `ARS` : Argentine Peso
648 # * `AUD` : Australian Dollar
649 # * `BRL` : Brazilian Real
650 # * `CAD` : Canadian Dollar
651 # * `CHF` : Swiss Franc
652 # * `CLP` : Chilean Peso
653 # * `CNY` : Chinese Yuan
654 # * `COP` : Colombian Peso
655 # * `CZK` : Czech Koruna
656 # * `DKK` : Danish Krone
657 # * `EGP` : Egyption Pound
658 # * `EUR` : Euro
659 # * `GBP` : British Pound
660 # * `HKD` : Hong Kong Dollar
661 # * `HUF` : Hungarian Forint
662 # * `IDR` : Indonesian Rupiah
663 # * `ILS` : Israeli Shekel
664 # * `INR` : Indian Rupee
665 # * `JPY` : Japanese Yen
666 # * `KRW` : South Korean Won
667 # * `MXN` : Mexican Pesos
668 # * `MYR` : Malaysian Ringgit
669 # * `NGN` : Nigerian Naira
670 # * `NOK` : Norwegian Krone
671 # * `NZD` : New Zealand Dollar
672 # * `PEN` : Peruvian Nuevo Sol
673 # * `PLN` : Polish Zloty
674 # * `RON` : New Romanian Leu
675 # * `RUB` : Russian Ruble
676 # * `SEK` : Swedish Krona
677 # * `TRY` : Turkish Lira
678 # * `TWD` : New Taiwan Dollar
679 # * `USD` : US Dollar
680 # * `ZAR` : South African Rand
681 },
682 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser.
683 #
684 # Must be UTF-8 encoded with a maximum size of 240 bytes.
685 }</pre>
686</div>
687
688<div class="method">
689 <code class="details" id="list">list(pageToken=None, orderBy=None, pageSize=None, partnerId=None, filter=None, x__xgafv=None)</code>
690 <pre>Lists advertisers that are accessible to the current user.
691
692The order is defined by the order_by
693parameter.
694
695A single partner_id is required.
696Cross-partner listing is not supported.
697
698Args:
699 pageToken: string, A token identifying a page of results the server should return.
700Typically, this is the value of
701next_page_token
702returned from the previous call to `ListAdvertisers` method.
703If not specified, the first page of results will be returned.
704 orderBy: string, Field by which to sort the list.
705Acceptable values are:
706
707* `displayName` (default)
708* `entityStatus`
709
710The default sorting order is ascending. To specify descending order for
711a field, a suffix &quot;desc&quot; should be added to the field name. For example,
712`displayName desc`.
713 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
714default to `100`.
715 partnerId: string, Required. The ID of the partner that the fetched advertisers should all belong to.
716The system only supports listing advertisers for one partner at a time.
717 filter: string, Allows filtering by advertiser properties.
718
719Supported syntax:
720
721* Filter expressions are made up of one or more restrictions.
722* Restrictions can be combined by `AND` or `OR` logical operators. A
723sequence of restrictions implicitly uses `AND`.
724* A restriction has the form of `{field} {operator} {value}`.
725* The operator must be `EQUALS (=)`.
726* Supported fields:
727 - `entityStatus`
728
729Examples:
730
731* All active advertisers under a partner:
732`entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot;`
733
734The length of this field should be no more than 500 characters.
735 x__xgafv: string, V1 error format.
736 Allowed values
737 1 - v1 error format
738 2 - v2 error format
739
740Returns:
741 An object of the form:
742
743 {
744 &quot;advertisers&quot;: [ # The list of advertisers.
745 #
746 # This list will be absent if empty.
747 { # A single advertiser in Display &amp; Video 360 (DV360).
748 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the
749 # advertiser can spend their budgets and bid on inventory.
750 #
751 # * Accepted values are `ENTITY_STATUS_ACTIVE` and
752 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
753 # * If set to
754 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
755 # days from when it was first scheduled for deletion.
756 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
757 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service
758 # (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag
759 # containing this ID to the creative tag.
760 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
761 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA)
762 # compliance.
763 #
764 # Warning: Changing OBA settings may cause the audit status of your creatives
765 # to be reset by some ad exchanges, making them ineligible to serve until
766 # they are re-approved.
767 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company,
768 # authorize Google to use video creatives associated with this Display &amp;
769 # Video 360 advertiser to provide reporting and features related to the
770 # advertiser&#x27;s television campaigns.
771 #
772 # Applicable only when the advertiser has a
773 # CM hybrid ad server
774 # configuration.
775 },
776 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
777 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
778 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
779 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser.
780 # Only integrationCode is currently
781 # applicable to advertiser. Other fields of IntegrationDetails are not
782 # supported and will be ignored if provided.
783 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
784 #
785 # Must be UTF-8 encoded with a length of no more than 1000 characters.
786 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
787 # The integration code will show up together with the entry in many
788 # places in the system, for example, reporting.
789 #
790 # Must be UTF-8 encoded with a length of no more than 500 characters.
791 },
792 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
793 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
794 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
795 # third-party ad servers.
796 # ad servers.
797 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
798 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
799 # authorize the sharing of information from the given Floodlight
800 # configuration to this Display &amp; Video 360 advertiser.
801 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
802 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
803 # advertiser.
804 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
805 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives.
806 #
807 # If absent or empty in
808 # CreateAdvertiser method, the system
809 # will automatically create a CM site.
810 #
811 # Removing sites from this list may cause DV360 creatives synced from CM to
812 # be deleted. At least one site must be specified.
813 &quot;A String&quot;,
814 ],
815 },
816 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
817 # only.
818 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled.
819 # This value cannot be changed once set to `true`.
820 },
821 },
822 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
823 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
824 #
825 # If not specified, the SDF settings of the parent partner are used.
826 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its
827 # parent partner.
828 #
829 # By default, an advertiser inherits the SDF configuration from the parent
830 # partner. To override the partner configuration, set this field to `true`
831 # and provide the new configuration in
832 # sdfConfig.
833 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
834 #
835 # * Required when
836 # overridePartnerSdfConfig
837 # is `true`.
838 # * Output only when
839 # overridePartnerSdfConfig
840 # is `false`.
841 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports
842 # will be sent.
843 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
844 },
845 },
846 },
847 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
848 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website.
849 # The system will send this information to publishers that require website
850 # URL to associate a campaign with an advertiser.
851 #
852 # Provide a URL with no path or query string, beginning with `http:` or
853 # `https:`.
854 # For example, http://www.example.com
855 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone.
856 # For example, `America/New_York`.
857 #
858 # See more at:
859 # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
860 #
861 # For CM hybrid advertisers, the time zone is the same as that of the
862 # associated CM account; for third-party only advertisers, the time zone is
863 # the same as that of the parent partner.
864 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format.
865 #
866 # Accepted codes and the currencies they represent are:
867 #
868 # Currency Code : Currency Name
869 #
870 # * `ARS` : Argentine Peso
871 # * `AUD` : Australian Dollar
872 # * `BRL` : Brazilian Real
873 # * `CAD` : Canadian Dollar
874 # * `CHF` : Swiss Franc
875 # * `CLP` : Chilean Peso
876 # * `CNY` : Chinese Yuan
877 # * `COP` : Colombian Peso
878 # * `CZK` : Czech Koruna
879 # * `DKK` : Danish Krone
880 # * `EGP` : Egyption Pound
881 # * `EUR` : Euro
882 # * `GBP` : British Pound
883 # * `HKD` : Hong Kong Dollar
884 # * `HUF` : Hungarian Forint
885 # * `IDR` : Indonesian Rupiah
886 # * `ILS` : Israeli Shekel
887 # * `INR` : Indian Rupee
888 # * `JPY` : Japanese Yen
889 # * `KRW` : South Korean Won
890 # * `MXN` : Mexican Pesos
891 # * `MYR` : Malaysian Ringgit
892 # * `NGN` : Nigerian Naira
893 # * `NOK` : Norwegian Krone
894 # * `NZD` : New Zealand Dollar
895 # * `PEN` : Peruvian Nuevo Sol
896 # * `PLN` : Polish Zloty
897 # * `RON` : New Romanian Leu
898 # * `RUB` : Russian Ruble
899 # * `SEK` : Swedish Krona
900 # * `TRY` : Turkish Lira
901 # * `TWD` : New Taiwan Dollar
902 # * `USD` : US Dollar
903 # * `ZAR` : South African Rand
904 },
905 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser.
906 #
907 # Must be UTF-8 encoded with a maximum size of 240 bytes.
908 },
909 ],
910 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
911 # Pass this value in the
912 # page_token
913 # field in the subsequent call to `ListAdvertisers` method to retrieve the
914 # next page of results.
915 }</pre>
916</div>
917
918<div class="method">
919 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
920 <pre>Retrieves the next page of results.
921
922Args:
923 previous_request: The request for the previous page. (required)
924 previous_response: The response from the request for the previous page. (required)
925
926Returns:
927 A request object that you can call &#x27;execute()&#x27; on to request the next
928 page. Returns None if there are no more items in the collection.
929 </pre>
930</div>
931
932<div class="method">
933 <code class="details" id="patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</code>
934 <pre>Updates an existing advertiser.
935Returns the updated advertiser if successful.
936
937Args:
938 advertiserId: string, Output only. The unique ID of the advertiser. Assigned by the system. (required)
939 body: object, The request body.
940 The object takes the form of:
941
942{ # A single advertiser in Display &amp; Video 360 (DV360).
943 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the
944 # advertiser can spend their budgets and bid on inventory.
945 #
946 # * Accepted values are `ENTITY_STATUS_ACTIVE` and
947 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
948 # * If set to
949 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
950 # days from when it was first scheduled for deletion.
951 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
952 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service
953 # (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag
954 # containing this ID to the creative tag.
955 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
956 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA)
957 # compliance.
958 #
959 # Warning: Changing OBA settings may cause the audit status of your creatives
960 # to be reset by some ad exchanges, making them ineligible to serve until
961 # they are re-approved.
962 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company,
963 # authorize Google to use video creatives associated with this Display &amp;
964 # Video 360 advertiser to provide reporting and features related to the
965 # advertiser&#x27;s television campaigns.
966 #
967 # Applicable only when the advertiser has a
968 # CM hybrid ad server
969 # configuration.
970 },
971 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
972 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
973 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
974 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser.
975 # Only integrationCode is currently
976 # applicable to advertiser. Other fields of IntegrationDetails are not
977 # supported and will be ignored if provided.
978 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
979 #
980 # Must be UTF-8 encoded with a length of no more than 1000 characters.
981 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
982 # The integration code will show up together with the entry in many
983 # places in the system, for example, reporting.
984 #
985 # Must be UTF-8 encoded with a length of no more than 500 characters.
986 },
987 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
988 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
989 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
990 # third-party ad servers.
991 # ad servers.
992 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
993 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
994 # authorize the sharing of information from the given Floodlight
995 # configuration to this Display &amp; Video 360 advertiser.
996 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
997 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
998 # advertiser.
999 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
1000 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives.
1001 #
1002 # If absent or empty in
1003 # CreateAdvertiser method, the system
1004 # will automatically create a CM site.
1005 #
1006 # Removing sites from this list may cause DV360 creatives synced from CM to
1007 # be deleted. At least one site must be specified.
1008 &quot;A String&quot;,
1009 ],
1010 },
1011 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
1012 # only.
1013 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled.
1014 # This value cannot be changed once set to `true`.
1015 },
1016 },
1017 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1018 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
1019 #
1020 # If not specified, the SDF settings of the parent partner are used.
1021 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its
1022 # parent partner.
1023 #
1024 # By default, an advertiser inherits the SDF configuration from the parent
1025 # partner. To override the partner configuration, set this field to `true`
1026 # and provide the new configuration in
1027 # sdfConfig.
1028 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
1029 #
1030 # * Required when
1031 # overridePartnerSdfConfig
1032 # is `true`.
1033 # * Output only when
1034 # overridePartnerSdfConfig
1035 # is `false`.
1036 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports
1037 # will be sent.
1038 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1039 },
1040 },
1041 },
1042 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1043 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website.
1044 # The system will send this information to publishers that require website
1045 # URL to associate a campaign with an advertiser.
1046 #
1047 # Provide a URL with no path or query string, beginning with `http:` or
1048 # `https:`.
1049 # For example, http://www.example.com
1050 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone.
1051 # For example, `America/New_York`.
1052 #
1053 # See more at:
1054 # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
1055 #
1056 # For CM hybrid advertisers, the time zone is the same as that of the
1057 # associated CM account; for third-party only advertisers, the time zone is
1058 # the same as that of the parent partner.
1059 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format.
1060 #
1061 # Accepted codes and the currencies they represent are:
1062 #
1063 # Currency Code : Currency Name
1064 #
1065 # * `ARS` : Argentine Peso
1066 # * `AUD` : Australian Dollar
1067 # * `BRL` : Brazilian Real
1068 # * `CAD` : Canadian Dollar
1069 # * `CHF` : Swiss Franc
1070 # * `CLP` : Chilean Peso
1071 # * `CNY` : Chinese Yuan
1072 # * `COP` : Colombian Peso
1073 # * `CZK` : Czech Koruna
1074 # * `DKK` : Danish Krone
1075 # * `EGP` : Egyption Pound
1076 # * `EUR` : Euro
1077 # * `GBP` : British Pound
1078 # * `HKD` : Hong Kong Dollar
1079 # * `HUF` : Hungarian Forint
1080 # * `IDR` : Indonesian Rupiah
1081 # * `ILS` : Israeli Shekel
1082 # * `INR` : Indian Rupee
1083 # * `JPY` : Japanese Yen
1084 # * `KRW` : South Korean Won
1085 # * `MXN` : Mexican Pesos
1086 # * `MYR` : Malaysian Ringgit
1087 # * `NGN` : Nigerian Naira
1088 # * `NOK` : Norwegian Krone
1089 # * `NZD` : New Zealand Dollar
1090 # * `PEN` : Peruvian Nuevo Sol
1091 # * `PLN` : Polish Zloty
1092 # * `RON` : New Romanian Leu
1093 # * `RUB` : Russian Ruble
1094 # * `SEK` : Swedish Krona
1095 # * `TRY` : Turkish Lira
1096 # * `TWD` : New Taiwan Dollar
1097 # * `USD` : US Dollar
1098 # * `ZAR` : South African Rand
1099 },
1100 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser.
1101 #
1102 # Must be UTF-8 encoded with a maximum size of 240 bytes.
1103}
1104
1105 updateMask: string, Required. The mask to control which fields to update.
1106 x__xgafv: string, V1 error format.
1107 Allowed values
1108 1 - v1 error format
1109 2 - v2 error format
1110
1111Returns:
1112 An object of the form:
1113
1114 { # A single advertiser in Display &amp; Video 360 (DV360).
1115 &quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not insertion orders and line items of the
1116 # advertiser can spend their budgets and bid on inventory.
1117 #
1118 # * Accepted values are `ENTITY_STATUS_ACTIVE` and
1119 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
1120 # * If set to
1121 # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
1122 # days from when it was first scheduled for deletion.
1123 &quot;creativeConfig&quot;: { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
1124 &quot;iasClientId&quot;: &quot;A String&quot;, # An ID for configuring campaign monitoring provided by Integral Ad Service
1125 # (IAS). The DV360 system will append an IAS &quot;Campaign Monitor&quot; tag
1126 # containing this ID to the creative tag.
1127 &quot;dynamicCreativeEnabled&quot;: True or False, # Whether or not the advertiser is enabled for dynamic creatives.
1128 &quot;obaComplianceDisabled&quot;: True or False, # Whether or not to use DV360&#x27;s Online Behavioral Advertising (OBA)
1129 # compliance.
1130 #
1131 # Warning: Changing OBA settings may cause the audit status of your creatives
1132 # to be reset by some ad exchanges, making them ineligible to serve until
1133 # they are re-approved.
1134 &quot;videoCreativeDataSharingAuthorized&quot;: True or False, # By setting this field to `true`, you, on behalf of your company,
1135 # authorize Google to use video creatives associated with this Display &amp;
1136 # Video 360 advertiser to provide reporting and features related to the
1137 # advertiser&#x27;s television campaigns.
1138 #
1139 # Applicable only when the advertiser has a
1140 # CM hybrid ad server
1141 # configuration.
1142 },
1143 &quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser. Assigned by the system.
1144 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
1145 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the advertiser.
1146 &quot;integrationDetails&quot;: { # Integration details of an entry. # Integration details of the advertiser.
1147 # Only integrationCode is currently
1148 # applicable to advertiser. Other fields of IntegrationDetails are not
1149 # supported and will be ignored if provided.
1150 &quot;details&quot;: &quot;A String&quot;, # Additional details of the entry in string format.
1151 #
1152 # Must be UTF-8 encoded with a length of no more than 1000 characters.
1153 &quot;integrationCode&quot;: &quot;A String&quot;, # An external identifier to be associated with the entry.
1154 # The integration code will show up together with the entry in many
1155 # places in the system, for example, reporting.
1156 #
1157 # Must be UTF-8 encoded with a length of no more than 500 characters.
1158 },
1159 &quot;partnerId&quot;: &quot;A String&quot;, # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
1160 &quot;adServerConfig&quot;: { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
1161 &quot;cmHybridConfig&quot;: { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
1162 # third-party ad servers.
1163 # ad servers.
1164 &quot;cmFloodlightConfigId&quot;: &quot;A String&quot;, # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
1165 &quot;cmFloodlightLinkingAuthorized&quot;: True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
1166 # authorize the sharing of information from the given Floodlight
1167 # configuration to this Display &amp; Video 360 advertiser.
1168 &quot;dv360ToCmCostReportingEnabled&quot;: True or False, # Whether or not to report DV360 cost to CM.
1169 &quot;cmAccountId&quot;: &quot;A String&quot;, # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
1170 # advertiser.
1171 &quot;dv360ToCmDataSharingEnabled&quot;: True or False, # Whether or not to include DV360 data in CM data transfer reports.
1172 &quot;cmSyncableSiteIds&quot;: [ # A list of CM sites whose placements will be synced to DV360 as creatives.
1173 #
1174 # If absent or empty in
1175 # CreateAdvertiser method, the system
1176 # will automatically create a CM site.
1177 #
1178 # Removing sites from this list may cause DV360 creatives synced from CM to
1179 # be deleted. At least one site must be specified.
1180 &quot;A String&quot;,
1181 ],
1182 },
1183 &quot;thirdPartyOnlyConfig&quot;: { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
1184 # only.
1185 &quot;pixelOrderIdReportingEnabled&quot;: True or False, # Whether or not order ID reporting for pixels is enabled.
1186 # This value cannot be changed once set to `true`.
1187 },
1188 },
1189 &quot;dataAccessConfig&quot;: { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
1190 &quot;sdfConfig&quot;: { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
1191 #
1192 # If not specified, the SDF settings of the parent partner are used.
1193 &quot;overridePartnerSdfConfig&quot;: True or False, # Whether or not this advertiser overrides the SDF configuration of its
1194 # parent partner.
1195 #
1196 # By default, an advertiser inherits the SDF configuration from the parent
1197 # partner. To override the partner configuration, set this field to `true`
1198 # and provide the new configuration in
1199 # sdfConfig.
1200 &quot;sdfConfig&quot;: { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
1201 #
1202 # * Required when
1203 # overridePartnerSdfConfig
1204 # is `true`.
1205 # * Output only when
1206 # overridePartnerSdfConfig
1207 # is `false`.
1208 &quot;adminEmail&quot;: &quot;A String&quot;, # An administrator email address to which the SDF processing status reports
1209 # will be sent.
1210 &quot;version&quot;: &quot;A String&quot;, # Required. The version of SDF being used.
1211 },
1212 },
1213 },
1214 &quot;generalConfig&quot;: { # General settings of an advertiser. # Required. General settings of the advertiser.
1215 &quot;domainUrl&quot;: &quot;A String&quot;, # Required. The domain URL of the advertiser&#x27;s primary website.
1216 # The system will send this information to publishers that require website
1217 # URL to associate a campaign with an advertiser.
1218 #
1219 # Provide a URL with no path or query string, beginning with `http:` or
1220 # `https:`.
1221 # For example, http://www.example.com
1222 &quot;timeZone&quot;: &quot;A String&quot;, # Output only. The standard TZ database name of the advertiser&#x27;s time zone.
1223 # For example, `America/New_York`.
1224 #
1225 # See more at:
1226 # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
1227 #
1228 # For CM hybrid advertisers, the time zone is the same as that of the
1229 # associated CM account; for third-party only advertisers, the time zone is
1230 # the same as that of the parent partner.
1231 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Immutable. Advertiser&#x27;s currency in ISO 4217 format.
1232 #
1233 # Accepted codes and the currencies they represent are:
1234 #
1235 # Currency Code : Currency Name
1236 #
1237 # * `ARS` : Argentine Peso
1238 # * `AUD` : Australian Dollar
1239 # * `BRL` : Brazilian Real
1240 # * `CAD` : Canadian Dollar
1241 # * `CHF` : Swiss Franc
1242 # * `CLP` : Chilean Peso
1243 # * `CNY` : Chinese Yuan
1244 # * `COP` : Colombian Peso
1245 # * `CZK` : Czech Koruna
1246 # * `DKK` : Danish Krone
1247 # * `EGP` : Egyption Pound
1248 # * `EUR` : Euro
1249 # * `GBP` : British Pound
1250 # * `HKD` : Hong Kong Dollar
1251 # * `HUF` : Hungarian Forint
1252 # * `IDR` : Indonesian Rupiah
1253 # * `ILS` : Israeli Shekel
1254 # * `INR` : Indian Rupee
1255 # * `JPY` : Japanese Yen
1256 # * `KRW` : South Korean Won
1257 # * `MXN` : Mexican Pesos
1258 # * `MYR` : Malaysian Ringgit
1259 # * `NGN` : Nigerian Naira
1260 # * `NOK` : Norwegian Krone
1261 # * `NZD` : New Zealand Dollar
1262 # * `PEN` : Peruvian Nuevo Sol
1263 # * `PLN` : Polish Zloty
1264 # * `RON` : New Romanian Leu
1265 # * `RUB` : Russian Ruble
1266 # * `SEK` : Swedish Krona
1267 # * `TRY` : Turkish Lira
1268 # * `TWD` : New Taiwan Dollar
1269 # * `USD` : US Dollar
1270 # * `ZAR` : South African Rand
1271 },
1272 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the advertiser.
1273 #
1274 # Must be UTF-8 encoded with a maximum size of 240 bytes.
1275 }</pre>
1276</div>
1277
1278</body></html>