docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/displayvideo_v1.advertisers.html b/docs/dyn/displayvideo_v1.advertisers.html
new file mode 100644
index 0000000..159783e
--- /dev/null
+++ b/docs/dyn/displayvideo_v1.advertisers.html
@@ -0,0 +1,1278 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.assets.html">assets()</a></code>
+</p>
+<p class="firstline">Returns the assets Resource.</p>
+
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.campaigns.html">campaigns()</a></code>
+</p>
+<p class="firstline">Returns the campaigns Resource.</p>
+
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.channels.html">channels()</a></code>
+</p>
+<p class="firstline">Returns the channels Resource.</p>
+
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.creatives.html">creatives()</a></code>
+</p>
+<p class="firstline">Returns the creatives Resource.</p>
+
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.insertionOrders.html">insertionOrders()</a></code>
+</p>
+<p class="firstline">Returns the insertionOrders Resource.</p>
+
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.lineItems.html">lineItems()</a></code>
+</p>
+<p class="firstline">Returns the lineItems Resource.</p>
+
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.locationLists.html">locationLists()</a></code>
+</p>
+<p class="firstline">Returns the locationLists Resource.</p>
+
+<p class="toc_element">
+ <code><a href="displayvideo_v1.advertisers.negativeKeywordLists.html">negativeKeywordLists()</a></code>
+</p>
+<p class="firstline">Returns the negativeKeywordLists Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new advertiser.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(advertiserId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes an advertiser.</p>
+<p class="toc_element">
+ <code><a href="#get">get(advertiserId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets an advertiser.</p>
+<p class="toc_element">
+ <code><a href="#list">list(pageToken=None, orderBy=None, pageSize=None, partnerId=None, filter=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists advertisers that are accessible to the current user.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates an existing advertiser.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(body=None, x__xgafv=None)</code>
+ <pre>Creates a new advertiser.
+Returns the newly created advertiser if successful.
+This method can take up to 180 seconds to complete.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A single advertiser in Display & Video 360 (DV360).
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
+ #
+ # * Accepted values are `ENTITY_STATUS_ACTIVE` and
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
+ # * If set to
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
+ # days from when it was first scheduled for deletion.
+ "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+ "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service
+ # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag
+ # containing this ID to the creative tag.
+ "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+ "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA)
+ # compliance.
+ #
+ # Warning: Changing OBA settings may cause the audit status of your creatives
+ # to be reset by some ad exchanges, making them ineligible to serve until
+ # they are re-approved.
+ "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company,
+ # authorize Google to use video creatives associated with this Display &
+ # Video 360 advertiser to provide reporting and features related to the
+ # advertiser's television campaigns.
+ #
+ # Applicable only when the advertiser has a
+ # CM hybrid ad server
+ # configuration.
+ },
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+ "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the advertiser.
+ "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser.
+ # Only integrationCode is currently
+ # applicable to advertiser. Other fields of IntegrationDetails are not
+ # supported and will be ignored if provided.
+ "details": "A String", # Additional details of the entry in string format.
+ #
+ # Must be UTF-8 encoded with a length of no more than 1000 characters.
+ "integrationCode": "A String", # An external identifier to be associated with the entry.
+ # The integration code will show up together with the entry in many
+ # places in the system, for example, reporting.
+ #
+ # Must be UTF-8 encoded with a length of no more than 500 characters.
+ },
+ "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+ "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+ "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
+ # third-party ad servers.
+ # ad servers.
+ "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
+ "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
+ # authorize the sharing of information from the given Floodlight
+ # configuration to this Display & Video 360 advertiser.
+ "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM.
+ "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
+ # advertiser.
+ "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports.
+ "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives.
+ #
+ # If absent or empty in
+ # CreateAdvertiser method, the system
+ # will automatically create a CM site.
+ #
+ # Removing sites from this list may cause DV360 creatives synced from CM to
+ # be deleted. At least one site must be specified.
+ "A String",
+ ],
+ },
+ "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
+ # only.
+ "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled.
+ # This value cannot be changed once set to `true`.
+ },
+ },
+ "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+ "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
+ #
+ # If not specified, the SDF settings of the parent partner are used.
+ "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its
+ # parent partner.
+ #
+ # By default, an advertiser inherits the SDF configuration from the parent
+ # partner. To override the partner configuration, set this field to `true`
+ # and provide the new configuration in
+ # sdfConfig.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ "version": "A String", # Required. The version of SDF being used.
+ },
+ },
+ },
+ "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+ "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website.
+ # The system will send this information to publishers that require website
+ # URL to associate a campaign with an advertiser.
+ #
+ # Provide a URL with no path or query string, beginning with `http:` or
+ # `https:`.
+ # For example, http://www.example.com
+ "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone.
+ # For example, `America/New_York`.
+ #
+ # See more at:
+ # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+ #
+ # For CM hybrid advertisers, the time zone is the same as that of the
+ # associated CM account; for third-party only advertisers, the time zone is
+ # the same as that of the parent partner.
+ "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format.
+ #
+ # Accepted codes and the currencies they represent are:
+ #
+ # Currency Code : Currency Name
+ #
+ # * `ARS` : Argentine Peso
+ # * `AUD` : Australian Dollar
+ # * `BRL` : Brazilian Real
+ # * `CAD` : Canadian Dollar
+ # * `CHF` : Swiss Franc
+ # * `CLP` : Chilean Peso
+ # * `CNY` : Chinese Yuan
+ # * `COP` : Colombian Peso
+ # * `CZK` : Czech Koruna
+ # * `DKK` : Danish Krone
+ # * `EGP` : Egyption Pound
+ # * `EUR` : Euro
+ # * `GBP` : British Pound
+ # * `HKD` : Hong Kong Dollar
+ # * `HUF` : Hungarian Forint
+ # * `IDR` : Indonesian Rupiah
+ # * `ILS` : Israeli Shekel
+ # * `INR` : Indian Rupee
+ # * `JPY` : Japanese Yen
+ # * `KRW` : South Korean Won
+ # * `MXN` : Mexican Pesos
+ # * `MYR` : Malaysian Ringgit
+ # * `NGN` : Nigerian Naira
+ # * `NOK` : Norwegian Krone
+ # * `NZD` : New Zealand Dollar
+ # * `PEN` : Peruvian Nuevo Sol
+ # * `PLN` : Polish Zloty
+ # * `RON` : New Romanian Leu
+ # * `RUB` : Russian Ruble
+ # * `SEK` : Swedish Krona
+ # * `TRY` : Turkish Lira
+ # * `TWD` : New Taiwan Dollar
+ # * `USD` : US Dollar
+ # * `ZAR` : South African Rand
+ },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single advertiser in Display & Video 360 (DV360).
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
+ #
+ # * Accepted values are `ENTITY_STATUS_ACTIVE` and
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
+ # * If set to
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
+ # days from when it was first scheduled for deletion.
+ "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+ "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service
+ # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag
+ # containing this ID to the creative tag.
+ "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+ "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA)
+ # compliance.
+ #
+ # Warning: Changing OBA settings may cause the audit status of your creatives
+ # to be reset by some ad exchanges, making them ineligible to serve until
+ # they are re-approved.
+ "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company,
+ # authorize Google to use video creatives associated with this Display &
+ # Video 360 advertiser to provide reporting and features related to the
+ # advertiser's television campaigns.
+ #
+ # Applicable only when the advertiser has a
+ # CM hybrid ad server
+ # configuration.
+ },
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+ "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the advertiser.
+ "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser.
+ # Only integrationCode is currently
+ # applicable to advertiser. Other fields of IntegrationDetails are not
+ # supported and will be ignored if provided.
+ "details": "A String", # Additional details of the entry in string format.
+ #
+ # Must be UTF-8 encoded with a length of no more than 1000 characters.
+ "integrationCode": "A String", # An external identifier to be associated with the entry.
+ # The integration code will show up together with the entry in many
+ # places in the system, for example, reporting.
+ #
+ # Must be UTF-8 encoded with a length of no more than 500 characters.
+ },
+ "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+ "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+ "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
+ # third-party ad servers.
+ # ad servers.
+ "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
+ "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
+ # authorize the sharing of information from the given Floodlight
+ # configuration to this Display & Video 360 advertiser.
+ "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM.
+ "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
+ # advertiser.
+ "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports.
+ "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives.
+ #
+ # If absent or empty in
+ # CreateAdvertiser method, the system
+ # will automatically create a CM site.
+ #
+ # Removing sites from this list may cause DV360 creatives synced from CM to
+ # be deleted. At least one site must be specified.
+ "A String",
+ ],
+ },
+ "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
+ # only.
+ "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled.
+ # This value cannot be changed once set to `true`.
+ },
+ },
+ "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+ "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
+ #
+ # If not specified, the SDF settings of the parent partner are used.
+ "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its
+ # parent partner.
+ #
+ # By default, an advertiser inherits the SDF configuration from the parent
+ # partner. To override the partner configuration, set this field to `true`
+ # and provide the new configuration in
+ # sdfConfig.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ "version": "A String", # Required. The version of SDF being used.
+ },
+ },
+ },
+ "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+ "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website.
+ # The system will send this information to publishers that require website
+ # URL to associate a campaign with an advertiser.
+ #
+ # Provide a URL with no path or query string, beginning with `http:` or
+ # `https:`.
+ # For example, http://www.example.com
+ "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone.
+ # For example, `America/New_York`.
+ #
+ # See more at:
+ # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+ #
+ # For CM hybrid advertisers, the time zone is the same as that of the
+ # associated CM account; for third-party only advertisers, the time zone is
+ # the same as that of the parent partner.
+ "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format.
+ #
+ # Accepted codes and the currencies they represent are:
+ #
+ # Currency Code : Currency Name
+ #
+ # * `ARS` : Argentine Peso
+ # * `AUD` : Australian Dollar
+ # * `BRL` : Brazilian Real
+ # * `CAD` : Canadian Dollar
+ # * `CHF` : Swiss Franc
+ # * `CLP` : Chilean Peso
+ # * `CNY` : Chinese Yuan
+ # * `COP` : Colombian Peso
+ # * `CZK` : Czech Koruna
+ # * `DKK` : Danish Krone
+ # * `EGP` : Egyption Pound
+ # * `EUR` : Euro
+ # * `GBP` : British Pound
+ # * `HKD` : Hong Kong Dollar
+ # * `HUF` : Hungarian Forint
+ # * `IDR` : Indonesian Rupiah
+ # * `ILS` : Israeli Shekel
+ # * `INR` : Indian Rupee
+ # * `JPY` : Japanese Yen
+ # * `KRW` : South Korean Won
+ # * `MXN` : Mexican Pesos
+ # * `MYR` : Malaysian Ringgit
+ # * `NGN` : Nigerian Naira
+ # * `NOK` : Norwegian Krone
+ # * `NZD` : New Zealand Dollar
+ # * `PEN` : Peruvian Nuevo Sol
+ # * `PLN` : Polish Zloty
+ # * `RON` : New Romanian Leu
+ # * `RUB` : Russian Ruble
+ # * `SEK` : Swedish Krona
+ # * `TRY` : Turkish Lira
+ # * `TWD` : New Taiwan Dollar
+ # * `USD` : US Dollar
+ # * `ZAR` : South African Rand
+ },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(advertiserId, x__xgafv=None)</code>
+ <pre>Deletes an advertiser.
+Deleting an advertiser will delete all of its child resources, for example,
+campaigns, insertion orders and line items.
+A deleted advertiser cannot be recovered.
+
+Args:
+ advertiserId: string, The ID of the advertiser we need to delete. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(advertiserId, x__xgafv=None)</code>
+ <pre>Gets an advertiser.
+
+Args:
+ advertiserId: string, Required. The ID of the advertiser to fetch. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single advertiser in Display & Video 360 (DV360).
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
+ #
+ # * Accepted values are `ENTITY_STATUS_ACTIVE` and
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
+ # * If set to
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
+ # days from when it was first scheduled for deletion.
+ "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+ "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service
+ # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag
+ # containing this ID to the creative tag.
+ "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+ "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA)
+ # compliance.
+ #
+ # Warning: Changing OBA settings may cause the audit status of your creatives
+ # to be reset by some ad exchanges, making them ineligible to serve until
+ # they are re-approved.
+ "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company,
+ # authorize Google to use video creatives associated with this Display &
+ # Video 360 advertiser to provide reporting and features related to the
+ # advertiser's television campaigns.
+ #
+ # Applicable only when the advertiser has a
+ # CM hybrid ad server
+ # configuration.
+ },
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+ "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the advertiser.
+ "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser.
+ # Only integrationCode is currently
+ # applicable to advertiser. Other fields of IntegrationDetails are not
+ # supported and will be ignored if provided.
+ "details": "A String", # Additional details of the entry in string format.
+ #
+ # Must be UTF-8 encoded with a length of no more than 1000 characters.
+ "integrationCode": "A String", # An external identifier to be associated with the entry.
+ # The integration code will show up together with the entry in many
+ # places in the system, for example, reporting.
+ #
+ # Must be UTF-8 encoded with a length of no more than 500 characters.
+ },
+ "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+ "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+ "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
+ # third-party ad servers.
+ # ad servers.
+ "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
+ "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
+ # authorize the sharing of information from the given Floodlight
+ # configuration to this Display & Video 360 advertiser.
+ "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM.
+ "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
+ # advertiser.
+ "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports.
+ "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives.
+ #
+ # If absent or empty in
+ # CreateAdvertiser method, the system
+ # will automatically create a CM site.
+ #
+ # Removing sites from this list may cause DV360 creatives synced from CM to
+ # be deleted. At least one site must be specified.
+ "A String",
+ ],
+ },
+ "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
+ # only.
+ "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled.
+ # This value cannot be changed once set to `true`.
+ },
+ },
+ "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+ "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
+ #
+ # If not specified, the SDF settings of the parent partner are used.
+ "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its
+ # parent partner.
+ #
+ # By default, an advertiser inherits the SDF configuration from the parent
+ # partner. To override the partner configuration, set this field to `true`
+ # and provide the new configuration in
+ # sdfConfig.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ "version": "A String", # Required. The version of SDF being used.
+ },
+ },
+ },
+ "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+ "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website.
+ # The system will send this information to publishers that require website
+ # URL to associate a campaign with an advertiser.
+ #
+ # Provide a URL with no path or query string, beginning with `http:` or
+ # `https:`.
+ # For example, http://www.example.com
+ "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone.
+ # For example, `America/New_York`.
+ #
+ # See more at:
+ # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+ #
+ # For CM hybrid advertisers, the time zone is the same as that of the
+ # associated CM account; for third-party only advertisers, the time zone is
+ # the same as that of the parent partner.
+ "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format.
+ #
+ # Accepted codes and the currencies they represent are:
+ #
+ # Currency Code : Currency Name
+ #
+ # * `ARS` : Argentine Peso
+ # * `AUD` : Australian Dollar
+ # * `BRL` : Brazilian Real
+ # * `CAD` : Canadian Dollar
+ # * `CHF` : Swiss Franc
+ # * `CLP` : Chilean Peso
+ # * `CNY` : Chinese Yuan
+ # * `COP` : Colombian Peso
+ # * `CZK` : Czech Koruna
+ # * `DKK` : Danish Krone
+ # * `EGP` : Egyption Pound
+ # * `EUR` : Euro
+ # * `GBP` : British Pound
+ # * `HKD` : Hong Kong Dollar
+ # * `HUF` : Hungarian Forint
+ # * `IDR` : Indonesian Rupiah
+ # * `ILS` : Israeli Shekel
+ # * `INR` : Indian Rupee
+ # * `JPY` : Japanese Yen
+ # * `KRW` : South Korean Won
+ # * `MXN` : Mexican Pesos
+ # * `MYR` : Malaysian Ringgit
+ # * `NGN` : Nigerian Naira
+ # * `NOK` : Norwegian Krone
+ # * `NZD` : New Zealand Dollar
+ # * `PEN` : Peruvian Nuevo Sol
+ # * `PLN` : Polish Zloty
+ # * `RON` : New Romanian Leu
+ # * `RUB` : Russian Ruble
+ # * `SEK` : Swedish Krona
+ # * `TRY` : Turkish Lira
+ # * `TWD` : New Taiwan Dollar
+ # * `USD` : US Dollar
+ # * `ZAR` : South African Rand
+ },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(pageToken=None, orderBy=None, pageSize=None, partnerId=None, filter=None, x__xgafv=None)</code>
+ <pre>Lists advertisers that are accessible to the current user.
+
+The order is defined by the order_by
+parameter.
+
+A single partner_id is required.
+Cross-partner listing is not supported.
+
+Args:
+ pageToken: string, A token identifying a page of results the server should return.
+Typically, this is the value of
+next_page_token
+returned from the previous call to `ListAdvertisers` method.
+If not specified, the first page of results will be returned.
+ orderBy: string, Field by which to sort the list.
+Acceptable values are:
+
+* `displayName` (default)
+* `entityStatus`
+
+The default sorting order is ascending. To specify descending order for
+a field, a suffix "desc" should be added to the field name. For example,
+`displayName desc`.
+ pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
+default to `100`.
+ partnerId: string, Required. The ID of the partner that the fetched advertisers should all belong to.
+The system only supports listing advertisers for one partner at a time.
+ filter: string, Allows filtering by advertiser properties.
+
+Supported syntax:
+
+* Filter expressions are made up of one or more restrictions.
+* Restrictions can be combined by `AND` or `OR` logical operators. A
+sequence of restrictions implicitly uses `AND`.
+* A restriction has the form of `{field} {operator} {value}`.
+* The operator must be `EQUALS (=)`.
+* Supported fields:
+ - `entityStatus`
+
+Examples:
+
+* All active advertisers under a partner:
+`entityStatus="ENTITY_STATUS_ACTIVE"`
+
+The length of this field should be no more than 500 characters.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "advertisers": [ # The list of advertisers.
+ #
+ # This list will be absent if empty.
+ { # A single advertiser in Display & Video 360 (DV360).
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
+ #
+ # * Accepted values are `ENTITY_STATUS_ACTIVE` and
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
+ # * If set to
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
+ # days from when it was first scheduled for deletion.
+ "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+ "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service
+ # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag
+ # containing this ID to the creative tag.
+ "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+ "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA)
+ # compliance.
+ #
+ # Warning: Changing OBA settings may cause the audit status of your creatives
+ # to be reset by some ad exchanges, making them ineligible to serve until
+ # they are re-approved.
+ "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company,
+ # authorize Google to use video creatives associated with this Display &
+ # Video 360 advertiser to provide reporting and features related to the
+ # advertiser's television campaigns.
+ #
+ # Applicable only when the advertiser has a
+ # CM hybrid ad server
+ # configuration.
+ },
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+ "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the advertiser.
+ "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser.
+ # Only integrationCode is currently
+ # applicable to advertiser. Other fields of IntegrationDetails are not
+ # supported and will be ignored if provided.
+ "details": "A String", # Additional details of the entry in string format.
+ #
+ # Must be UTF-8 encoded with a length of no more than 1000 characters.
+ "integrationCode": "A String", # An external identifier to be associated with the entry.
+ # The integration code will show up together with the entry in many
+ # places in the system, for example, reporting.
+ #
+ # Must be UTF-8 encoded with a length of no more than 500 characters.
+ },
+ "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+ "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+ "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
+ # third-party ad servers.
+ # ad servers.
+ "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
+ "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
+ # authorize the sharing of information from the given Floodlight
+ # configuration to this Display & Video 360 advertiser.
+ "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM.
+ "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
+ # advertiser.
+ "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports.
+ "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives.
+ #
+ # If absent or empty in
+ # CreateAdvertiser method, the system
+ # will automatically create a CM site.
+ #
+ # Removing sites from this list may cause DV360 creatives synced from CM to
+ # be deleted. At least one site must be specified.
+ "A String",
+ ],
+ },
+ "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
+ # only.
+ "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled.
+ # This value cannot be changed once set to `true`.
+ },
+ },
+ "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+ "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
+ #
+ # If not specified, the SDF settings of the parent partner are used.
+ "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its
+ # parent partner.
+ #
+ # By default, an advertiser inherits the SDF configuration from the parent
+ # partner. To override the partner configuration, set this field to `true`
+ # and provide the new configuration in
+ # sdfConfig.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ "version": "A String", # Required. The version of SDF being used.
+ },
+ },
+ },
+ "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+ "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website.
+ # The system will send this information to publishers that require website
+ # URL to associate a campaign with an advertiser.
+ #
+ # Provide a URL with no path or query string, beginning with `http:` or
+ # `https:`.
+ # For example, http://www.example.com
+ "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone.
+ # For example, `America/New_York`.
+ #
+ # See more at:
+ # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+ #
+ # For CM hybrid advertisers, the time zone is the same as that of the
+ # associated CM account; for third-party only advertisers, the time zone is
+ # the same as that of the parent partner.
+ "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format.
+ #
+ # Accepted codes and the currencies they represent are:
+ #
+ # Currency Code : Currency Name
+ #
+ # * `ARS` : Argentine Peso
+ # * `AUD` : Australian Dollar
+ # * `BRL` : Brazilian Real
+ # * `CAD` : Canadian Dollar
+ # * `CHF` : Swiss Franc
+ # * `CLP` : Chilean Peso
+ # * `CNY` : Chinese Yuan
+ # * `COP` : Colombian Peso
+ # * `CZK` : Czech Koruna
+ # * `DKK` : Danish Krone
+ # * `EGP` : Egyption Pound
+ # * `EUR` : Euro
+ # * `GBP` : British Pound
+ # * `HKD` : Hong Kong Dollar
+ # * `HUF` : Hungarian Forint
+ # * `IDR` : Indonesian Rupiah
+ # * `ILS` : Israeli Shekel
+ # * `INR` : Indian Rupee
+ # * `JPY` : Japanese Yen
+ # * `KRW` : South Korean Won
+ # * `MXN` : Mexican Pesos
+ # * `MYR` : Malaysian Ringgit
+ # * `NGN` : Nigerian Naira
+ # * `NOK` : Norwegian Krone
+ # * `NZD` : New Zealand Dollar
+ # * `PEN` : Peruvian Nuevo Sol
+ # * `PLN` : Polish Zloty
+ # * `RON` : New Romanian Leu
+ # * `RUB` : Russian Ruble
+ # * `SEK` : Swedish Krona
+ # * `TRY` : Turkish Lira
+ # * `TWD` : New Taiwan Dollar
+ # * `USD` : US Dollar
+ # * `ZAR` : South African Rand
+ },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results.
+ # Pass this value in the
+ # page_token
+ # field in the subsequent call to `ListAdvertisers` method to retrieve the
+ # next page of results.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(advertiserId, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates an existing advertiser.
+Returns the updated advertiser if successful.
+
+Args:
+ advertiserId: string, Output only. The unique ID of the advertiser. Assigned by the system. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A single advertiser in Display & Video 360 (DV360).
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
+ #
+ # * Accepted values are `ENTITY_STATUS_ACTIVE` and
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
+ # * If set to
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
+ # days from when it was first scheduled for deletion.
+ "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+ "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service
+ # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag
+ # containing this ID to the creative tag.
+ "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+ "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA)
+ # compliance.
+ #
+ # Warning: Changing OBA settings may cause the audit status of your creatives
+ # to be reset by some ad exchanges, making them ineligible to serve until
+ # they are re-approved.
+ "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company,
+ # authorize Google to use video creatives associated with this Display &
+ # Video 360 advertiser to provide reporting and features related to the
+ # advertiser's television campaigns.
+ #
+ # Applicable only when the advertiser has a
+ # CM hybrid ad server
+ # configuration.
+ },
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+ "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the advertiser.
+ "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser.
+ # Only integrationCode is currently
+ # applicable to advertiser. Other fields of IntegrationDetails are not
+ # supported and will be ignored if provided.
+ "details": "A String", # Additional details of the entry in string format.
+ #
+ # Must be UTF-8 encoded with a length of no more than 1000 characters.
+ "integrationCode": "A String", # An external identifier to be associated with the entry.
+ # The integration code will show up together with the entry in many
+ # places in the system, for example, reporting.
+ #
+ # Must be UTF-8 encoded with a length of no more than 500 characters.
+ },
+ "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+ "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+ "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
+ # third-party ad servers.
+ # ad servers.
+ "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
+ "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
+ # authorize the sharing of information from the given Floodlight
+ # configuration to this Display & Video 360 advertiser.
+ "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM.
+ "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
+ # advertiser.
+ "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports.
+ "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives.
+ #
+ # If absent or empty in
+ # CreateAdvertiser method, the system
+ # will automatically create a CM site.
+ #
+ # Removing sites from this list may cause DV360 creatives synced from CM to
+ # be deleted. At least one site must be specified.
+ "A String",
+ ],
+ },
+ "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
+ # only.
+ "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled.
+ # This value cannot be changed once set to `true`.
+ },
+ },
+ "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+ "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
+ #
+ # If not specified, the SDF settings of the parent partner are used.
+ "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its
+ # parent partner.
+ #
+ # By default, an advertiser inherits the SDF configuration from the parent
+ # partner. To override the partner configuration, set this field to `true`
+ # and provide the new configuration in
+ # sdfConfig.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ "version": "A String", # Required. The version of SDF being used.
+ },
+ },
+ },
+ "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+ "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website.
+ # The system will send this information to publishers that require website
+ # URL to associate a campaign with an advertiser.
+ #
+ # Provide a URL with no path or query string, beginning with `http:` or
+ # `https:`.
+ # For example, http://www.example.com
+ "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone.
+ # For example, `America/New_York`.
+ #
+ # See more at:
+ # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+ #
+ # For CM hybrid advertisers, the time zone is the same as that of the
+ # associated CM account; for third-party only advertisers, the time zone is
+ # the same as that of the parent partner.
+ "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format.
+ #
+ # Accepted codes and the currencies they represent are:
+ #
+ # Currency Code : Currency Name
+ #
+ # * `ARS` : Argentine Peso
+ # * `AUD` : Australian Dollar
+ # * `BRL` : Brazilian Real
+ # * `CAD` : Canadian Dollar
+ # * `CHF` : Swiss Franc
+ # * `CLP` : Chilean Peso
+ # * `CNY` : Chinese Yuan
+ # * `COP` : Colombian Peso
+ # * `CZK` : Czech Koruna
+ # * `DKK` : Danish Krone
+ # * `EGP` : Egyption Pound
+ # * `EUR` : Euro
+ # * `GBP` : British Pound
+ # * `HKD` : Hong Kong Dollar
+ # * `HUF` : Hungarian Forint
+ # * `IDR` : Indonesian Rupiah
+ # * `ILS` : Israeli Shekel
+ # * `INR` : Indian Rupee
+ # * `JPY` : Japanese Yen
+ # * `KRW` : South Korean Won
+ # * `MXN` : Mexican Pesos
+ # * `MYR` : Malaysian Ringgit
+ # * `NGN` : Nigerian Naira
+ # * `NOK` : Norwegian Krone
+ # * `NZD` : New Zealand Dollar
+ # * `PEN` : Peruvian Nuevo Sol
+ # * `PLN` : Polish Zloty
+ # * `RON` : New Romanian Leu
+ # * `RUB` : Russian Ruble
+ # * `SEK` : Swedish Krona
+ # * `TRY` : Turkish Lira
+ # * `TWD` : New Taiwan Dollar
+ # * `USD` : US Dollar
+ # * `ZAR` : South African Rand
+ },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+}
+
+ updateMask: string, Required. The mask to control which fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single advertiser in Display & Video 360 (DV360).
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
+ #
+ # * Accepted values are `ENTITY_STATUS_ACTIVE` and
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`.
+ # * If set to
+ # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30
+ # days from when it was first scheduled for deletion.
+ "creativeConfig": { # Creatives related settings of an advertiser. # Required. Creative related settings of the advertiser.
+ "iasClientId": "A String", # An ID for configuring campaign monitoring provided by Integral Ad Service
+ # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag
+ # containing this ID to the creative tag.
+ "dynamicCreativeEnabled": True or False, # Whether or not the advertiser is enabled for dynamic creatives.
+ "obaComplianceDisabled": True or False, # Whether or not to use DV360's Online Behavioral Advertising (OBA)
+ # compliance.
+ #
+ # Warning: Changing OBA settings may cause the audit status of your creatives
+ # to be reset by some ad exchanges, making them ineligible to serve until
+ # they are re-approved.
+ "videoCreativeDataSharingAuthorized": True or False, # By setting this field to `true`, you, on behalf of your company,
+ # authorize Google to use video creatives associated with this Display &
+ # Video 360 advertiser to provide reporting and features related to the
+ # advertiser's television campaigns.
+ #
+ # Applicable only when the advertiser has a
+ # CM hybrid ad server
+ # configuration.
+ },
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. Assigned by the system.
+ "updateTime": "A String", # Output only. The timestamp when the advertiser was last updated. Assigned by the system.
+ "name": "A String", # Output only. The resource name of the advertiser.
+ "integrationDetails": { # Integration details of an entry. # Integration details of the advertiser.
+ # Only integrationCode is currently
+ # applicable to advertiser. Other fields of IntegrationDetails are not
+ # supported and will be ignored if provided.
+ "details": "A String", # Additional details of the entry in string format.
+ #
+ # Must be UTF-8 encoded with a length of no more than 1000 characters.
+ "integrationCode": "A String", # An external identifier to be associated with the entry.
+ # The integration code will show up together with the entry in many
+ # places in the system, for example, reporting.
+ #
+ # Must be UTF-8 encoded with a length of no more than 500 characters.
+ },
+ "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to.
+ "adServerConfig": { # Ad server related settings of an advertiser. # Required. Immutable. Ad server related settings of the advertiser.
+ "cmHybridConfig": { # Settings for advertisers that use both Campaign Manager (CM) and third-party # The configuration for advertisers that use both Campaign Manager (CM) and
+ # third-party ad servers.
+ # ad servers.
+ "cmFloodlightConfigId": "A String", # Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.
+ "cmFloodlightLinkingAuthorized": True or False, # Required. Immutable. By setting this field to `true`, you, on behalf of your company,
+ # authorize the sharing of information from the given Floodlight
+ # configuration to this Display & Video 360 advertiser.
+ "dv360ToCmCostReportingEnabled": True or False, # Whether or not to report DV360 cost to CM.
+ "cmAccountId": "A String", # Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360
+ # advertiser.
+ "dv360ToCmDataSharingEnabled": True or False, # Whether or not to include DV360 data in CM data transfer reports.
+ "cmSyncableSiteIds": [ # A list of CM sites whose placements will be synced to DV360 as creatives.
+ #
+ # If absent or empty in
+ # CreateAdvertiser method, the system
+ # will automatically create a CM site.
+ #
+ # Removing sites from this list may cause DV360 creatives synced from CM to
+ # be deleted. At least one site must be specified.
+ "A String",
+ ],
+ },
+ "thirdPartyOnlyConfig": { # Settings for advertisers that use third-party ad servers only. # The configuration for advertisers that use third-party ad servers
+ # only.
+ "pixelOrderIdReportingEnabled": True or False, # Whether or not order ID reporting for pixels is enabled.
+ # This value cannot be changed once set to `true`.
+ },
+ },
+ "dataAccessConfig": { # Settings that control how advertiser related data may be accessed. # Settings that control how advertiser data may be accessed.
+ "sdfConfig": { # Structured Data Files (SDF) settings of an advertiser. # Structured Data Files (SDF) settings for the advertiser.
+ #
+ # If not specified, the SDF settings of the parent partner are used.
+ "overridePartnerSdfConfig": True or False, # Whether or not this advertiser overrides the SDF configuration of its
+ # parent partner.
+ #
+ # By default, an advertiser inherits the SDF configuration from the parent
+ # partner. To override the partner configuration, set this field to `true`
+ # and provide the new configuration in
+ # sdfConfig.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ "version": "A String", # Required. The version of SDF being used.
+ },
+ },
+ },
+ "generalConfig": { # General settings of an advertiser. # Required. General settings of the advertiser.
+ "domainUrl": "A String", # Required. The domain URL of the advertiser's primary website.
+ # The system will send this information to publishers that require website
+ # URL to associate a campaign with an advertiser.
+ #
+ # Provide a URL with no path or query string, beginning with `http:` or
+ # `https:`.
+ # For example, http://www.example.com
+ "timeZone": "A String", # Output only. The standard TZ database name of the advertiser's time zone.
+ # For example, `America/New_York`.
+ #
+ # See more at:
+ # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+ #
+ # For CM hybrid advertisers, the time zone is the same as that of the
+ # associated CM account; for third-party only advertisers, the time zone is
+ # the same as that of the parent partner.
+ "currencyCode": "A String", # Required. Immutable. Advertiser's currency in ISO 4217 format.
+ #
+ # Accepted codes and the currencies they represent are:
+ #
+ # Currency Code : Currency Name
+ #
+ # * `ARS` : Argentine Peso
+ # * `AUD` : Australian Dollar
+ # * `BRL` : Brazilian Real
+ # * `CAD` : Canadian Dollar
+ # * `CHF` : Swiss Franc
+ # * `CLP` : Chilean Peso
+ # * `CNY` : Chinese Yuan
+ # * `COP` : Colombian Peso
+ # * `CZK` : Czech Koruna
+ # * `DKK` : Danish Krone
+ # * `EGP` : Egyption Pound
+ # * `EUR` : Euro
+ # * `GBP` : British Pound
+ # * `HKD` : Hong Kong Dollar
+ # * `HUF` : Hungarian Forint
+ # * `IDR` : Indonesian Rupiah
+ # * `ILS` : Israeli Shekel
+ # * `INR` : Indian Rupee
+ # * `JPY` : Japanese Yen
+ # * `KRW` : South Korean Won
+ # * `MXN` : Mexican Pesos
+ # * `MYR` : Malaysian Ringgit
+ # * `NGN` : Nigerian Naira
+ # * `NOK` : Norwegian Krone
+ # * `NZD` : New Zealand Dollar
+ # * `PEN` : Peruvian Nuevo Sol
+ # * `PLN` : Polish Zloty
+ # * `RON` : New Romanian Leu
+ # * `RUB` : Russian Ruble
+ # * `SEK` : Swedish Krona
+ # * `TRY` : Turkish Lira
+ # * `TWD` : New Taiwan Dollar
+ # * `USD` : US Dollar
+ # * `ZAR` : South African Rand
+ },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file