docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/displayvideo_v1.advertisers.html b/docs/dyn/displayvideo_v1.advertisers.html
index 159783e..c74b9c9 100644
--- a/docs/dyn/displayvideo_v1.advertisers.html
+++ b/docs/dyn/displayvideo_v1.advertisers.html
@@ -124,7 +124,7 @@
<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>
+ <code><a href="#list">list(partnerId=None, filter=None, pageToken=None, orderBy=None, pageSize=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>
@@ -144,36 +144,8 @@
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.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. 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
@@ -190,16 +162,14 @@
},
"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.
+ "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`.
+ },
"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.
#
@@ -211,55 +181,19 @@
# 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`.
+ "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.
},
},
- "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.
- },
- },
- },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
"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:
@@ -300,10 +234,76 @@
# * `TWD` : New Taiwan Dollar
# * `USD` : US Dollar
# * `ZAR` : South African Rand
+ "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.
},
- "displayName": "A String", # Required. The display name of the advertiser.
+ "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.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "version": "A String", # Required. The version of SDF being used.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ },
+ "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.
+ },
+ },
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
#
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ # * 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.
+ "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.
+ "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.
+ },
}
x__xgafv: string, V1 error format.
@@ -315,36 +315,8 @@
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.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. 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
@@ -361,16 +333,14 @@
},
"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.
+ "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`.
+ },
"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.
#
@@ -382,55 +352,19 @@
# 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`.
+ "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.
},
},
- "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.
- },
- },
- },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
"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:
@@ -471,10 +405,76 @@
# * `TWD` : New Taiwan Dollar
# * `USD` : US Dollar
# * `ZAR` : South African Rand
+ "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.
},
- "displayName": "A String", # Required. The display name of the advertiser.
+ "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.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "version": "A String", # Required. The version of SDF being used.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ },
+ "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.
+ },
+ },
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
#
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ # * 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.
+ "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.
+ "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.
+ },
}</pre>
</div>
@@ -522,36 +522,8 @@
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.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. 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
@@ -568,16 +540,14 @@
},
"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.
+ "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`.
+ },
"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.
#
@@ -589,55 +559,19 @@
# 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`.
+ "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.
},
},
- "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.
- },
- },
- },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
"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:
@@ -678,15 +612,81 @@
# * `TWD` : New Taiwan Dollar
# * `USD` : US Dollar
# * `ZAR` : South African Rand
+ "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.
},
- "displayName": "A String", # Required. The display name of the advertiser.
+ "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.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "version": "A String", # Required. The version of SDF being used.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ },
+ "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.
+ },
+ },
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
#
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ # * 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.
+ "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.
+ "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.
+ },
}</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>
+ <code class="details" id="list">list(partnerId=None, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists advertisers that are accessible to the current user.
The order is defined by the order_by
@@ -696,22 +696,6 @@
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.
@@ -732,6 +716,22 @@
`entityStatus="ENTITY_STATUS_ACTIVE"`
The length of this field should be no more than 500 characters.
+ 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`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -745,36 +745,8 @@
#
# 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.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. 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
@@ -791,16 +763,14 @@
},
"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.
+ "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`.
+ },
"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.
#
@@ -812,55 +782,19 @@
# 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`.
+ "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.
},
},
- "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.
- },
- },
- },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
"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:
@@ -901,10 +835,76 @@
# * `TWD` : New Taiwan Dollar
# * `USD` : US Dollar
# * `ZAR` : South African Rand
+ "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.
},
- "displayName": "A String", # Required. The display name of the advertiser.
+ "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.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "version": "A String", # Required. The version of SDF being used.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ },
+ "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.
+ },
+ },
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
#
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ # * 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.
+ "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.
+ "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.
+ },
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results.
@@ -940,36 +940,8 @@
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.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. 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
@@ -986,16 +958,14 @@
},
"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.
+ "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`.
+ },
"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.
#
@@ -1007,55 +977,19 @@
# 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`.
+ "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.
},
},
- "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.
- },
- },
- },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
"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:
@@ -1096,10 +1030,76 @@
# * `TWD` : New Taiwan Dollar
# * `USD` : US Dollar
# * `ZAR` : South African Rand
+ "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.
},
- "displayName": "A String", # Required. The display name of the advertiser.
+ "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.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "version": "A String", # Required. The version of SDF being used.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ },
+ "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.
+ },
+ },
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
#
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ # * 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.
+ "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.
+ "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.
+ },
}
updateMask: string, Required. The mask to control which fields to update.
@@ -1112,36 +1112,8 @@
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.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser. 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
@@ -1158,16 +1130,14 @@
},
"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.
+ "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`.
+ },
"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.
#
@@ -1179,55 +1149,19 @@
# 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`.
+ "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.
},
},
- "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.
- },
- },
- },
+ "displayName": "A String", # Required. The display name of the advertiser.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
"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:
@@ -1268,10 +1202,76 @@
# * `TWD` : New Taiwan Dollar
# * `USD` : US Dollar
# * `ZAR` : South African Rand
+ "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.
},
- "displayName": "A String", # Required. The display name of the advertiser.
+ "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.
+ "sdfConfig": { # Structured Data File (SDF) related settings. # The SDF configuration for the advertiser.
+ #
+ # * Required when
+ # overridePartnerSdfConfig
+ # is `true`.
+ # * Output only when
+ # overridePartnerSdfConfig
+ # is `false`.
+ "version": "A String", # Required. The version of SDF being used.
+ "adminEmail": "A String", # An administrator email address to which the SDF processing status reports
+ # will be sent.
+ },
+ "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.
+ },
+ },
+ "entityStatus": "A String", # Required. Controls whether or not insertion orders and line items of the
+ # advertiser can spend their budgets and bid on inventory.
#
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ # * 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.
+ "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.
+ "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.
+ },
}</pre>
</div>