--- title: "PATCH /v4/advertisers/{advertisersId}" method: PATCH path: "/v4/advertisers/{advertisersId}" tags: ["advertisers"] --- # PATCH /v4/advertisers/{advertisersId} `PATCH /v4/advertisers/{advertisersId}` ## Request - Base URL: `https://displayvideo.googleapis.com` - URL: `https://displayvideo.googleapis.com/v4/advertisers/{advertisersId}` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/display-video` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/display-video` - TypeScript: (a function with typed inputs; its response is checked against the schema) Updates an existing advertiser. Returns the updated advertiser if successful. ## Path parameters - `advertisersId` string, required ## Query parameters - `updateMask` string, google-fieldmask ## Request body - Advertiser: A single advertiser in Display & Video 360 (DV360). - `adServerConfig` AdvertiserAdServerConfig: Ad server related settings of an advertiser. - `cmHybridConfig` CmHybridConfig: Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. - `cmAccountId` string, int64: Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser. - `cmAdvertiserIds` string[]: Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration. - `cmFloodlightConfigId` string, int64: Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser. - `cmFloodlightLinkingAuthorized` boolean: 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. - `cmSyncableSiteIds` string[]: A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified. - `dv360ToCmCostReportingEnabled` boolean: Whether or not to report DV360 cost to CM360. - `dv360ToCmDataSharingEnabled` boolean: Whether or not to include DV360 data in CM360 data transfer reports. - `thirdPartyOnlyConfig` ThirdPartyOnlyConfig: Settings for advertisers that use third-party ad servers only. - `pixelOrderIdReportingEnabled` boolean: Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`. - `advertiserId` string, int64: Output only. The unique ID of the advertiser. Assigned by the system. - `billingConfig` AdvertiserBillingConfig: Billing related settings of an advertiser. - `billingProfileId` string, int64: Required. The ID of a billing profile assigned to the advertiser. - `containsEuPoliticalAds` 'EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN' | 'CONTAINS_EU_POLITICAL_ADVERTISING' | 'DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING': Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day. - `creativeConfig` AdvertiserCreativeConfig: Creatives related settings of an advertiser. - `dynamicCreativeEnabled` boolean: Whether or not the advertiser is enabled for dynamic creatives. - `iasClientId` string, int64: 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. - `obaComplianceDisabled` boolean: Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091). - `videoCreativeDataSharingAuthorized` boolean: 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 CM360 hybrid ad server configuration. - `dataAccessConfig` AdvertiserDataAccessConfig: Settings that control how advertiser related data may be accessed. - `sdfConfig` AdvertiserSdfConfig: Structured Data Files (SDF) settings of an advertiser. - `overridePartnerSdfConfig` boolean: 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` SdfConfig: Structured Data File (SDF) related settings. - `adminEmail` string: An administrator email address to which the SDF processing status reports will be sent. - `version` 'SDF_VERSION_UNSPECIFIED' | 'SDF_VERSION_3_1' | 'SDF_VERSION_4' | 'SDF_VERSION_4_1' | 'SDF_VERSION_4_2' | 'SDF_VERSION_5' | 'SDF_VERSION_5_1' | 'SDF_VERSION_5_2' | 'SDF_VERSION_5_3' | 'SDF_VERSION_5_4' | 'SDF_VERSION_5_5' | 'SDF_VERSION_6' | 'SDF_VERSION_7' | 'SDF_VERSION_7_1' | 'SDF_VERSION_8' | 'SDF_VERSION_8_1' | 'SDF_VERSION_9' | 'SDF_VERSION_9_1' | 'SDF_VERSION_9_2' | 'SDF_VERSION_10' | 'SDF_VERSION_10_1': Required. The version of SDF being used. - `defaultBusinessName` string: Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. - `defaultLogoAssetId` string, int64: Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. - `displayName` string: Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - `entityStatus` 'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION': 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`, `ENTITY_STATUS_PAUSED` 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. - `generalConfig` AdvertiserGeneralConfig: General settings of an advertiser. - `currencyCode` 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 - `domainUrl` 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` 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 CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner. - `integrationDetails` IntegrationDetails: Integration details of an entry. - `details` string: Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. - `integrationCode` 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. - `name` string: Output only. The resource name of the advertiser. - `partnerId` string, int64: Required. Immutable. The unique ID of the partner that the advertiser belongs to. - `prismaEnabled` boolean: Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. - `servingConfig` AdvertiserTargetingConfig: Targeting settings related to ad serving of an advertiser. - `exemptTvFromViewabilityTargeting` boolean: Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. - `updateTime` string, google-datetime: Output only. The timestamp when the advertiser was last updated. Assigned by the system. ## Response `200` Successful response - Advertiser: A single advertiser in Display & Video 360 (DV360). - `adServerConfig` AdvertiserAdServerConfig: Ad server related settings of an advertiser. - `cmHybridConfig` CmHybridConfig: Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. - `cmAccountId` string, int64: Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser. - `cmAdvertiserIds` string[]: Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration. - `cmFloodlightConfigId` string, int64: Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser. - `cmFloodlightLinkingAuthorized` boolean: 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. - `cmSyncableSiteIds` string[]: A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified. - `dv360ToCmCostReportingEnabled` boolean: Whether or not to report DV360 cost to CM360. - `dv360ToCmDataSharingEnabled` boolean: Whether or not to include DV360 data in CM360 data transfer reports. - `thirdPartyOnlyConfig` ThirdPartyOnlyConfig: Settings for advertisers that use third-party ad servers only. - `pixelOrderIdReportingEnabled` boolean: Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`. - `advertiserId` string, int64: Output only. The unique ID of the advertiser. Assigned by the system. - `billingConfig` AdvertiserBillingConfig: Billing related settings of an advertiser. - `billingProfileId` string, int64: Required. The ID of a billing profile assigned to the advertiser. - `containsEuPoliticalAds` 'EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN' | 'CONTAINS_EU_POLITICAL_ADVERTISING' | 'DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING': Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING`, then the following will happen: * Any new line items created under this advertiser will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` within a day. - `creativeConfig` AdvertiserCreativeConfig: Creatives related settings of an advertiser. - `dynamicCreativeEnabled` boolean: Whether or not the advertiser is enabled for dynamic creatives. - `iasClientId` string, int64: 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. - `obaComplianceDisabled` boolean: Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. [Learn more](//support.google.com/displayvideo/answer/14315795). If you choose to set this field to `true`, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate [form](//support.google.com/legal/troubleshooter/1114905?sjid=6787484030557261960-EU#ts=2981967%2C2982031%2C12980091). - `videoCreativeDataSharingAuthorized` boolean: 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 CM360 hybrid ad server configuration. - `dataAccessConfig` AdvertiserDataAccessConfig: Settings that control how advertiser related data may be accessed. - `sdfConfig` AdvertiserSdfConfig: Structured Data Files (SDF) settings of an advertiser. - `overridePartnerSdfConfig` boolean: 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` SdfConfig: Structured Data File (SDF) related settings. - `adminEmail` string: An administrator email address to which the SDF processing status reports will be sent. - `version` 'SDF_VERSION_UNSPECIFIED' | 'SDF_VERSION_3_1' | 'SDF_VERSION_4' | 'SDF_VERSION_4_1' | 'SDF_VERSION_4_2' | 'SDF_VERSION_5' | 'SDF_VERSION_5_1' | 'SDF_VERSION_5_2' | 'SDF_VERSION_5_3' | 'SDF_VERSION_5_4' | 'SDF_VERSION_5_5' | 'SDF_VERSION_6' | 'SDF_VERSION_7' | 'SDF_VERSION_7_1' | 'SDF_VERSION_8' | 'SDF_VERSION_8_1' | 'SDF_VERSION_9' | 'SDF_VERSION_9_1' | 'SDF_VERSION_9_2' | 'SDF_VERSION_10' | 'SDF_VERSION_10_1': Required. The version of SDF being used. - `defaultBusinessName` string: Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. - `defaultLogoAssetId` string, int64: Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. - `displayName` string: Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. - `entityStatus` 'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION': 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`, `ENTITY_STATUS_PAUSED` 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. - `generalConfig` AdvertiserGeneralConfig: General settings of an advertiser. - `currencyCode` 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 - `domainUrl` 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` 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 CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner. - `integrationDetails` IntegrationDetails: Integration details of an entry. - `details` string: Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. - `integrationCode` 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. - `name` string: Output only. The resource name of the advertiser. - `partnerId` string, int64: Required. Immutable. The unique ID of the partner that the advertiser belongs to. - `prismaEnabled` boolean: Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. - `servingConfig` AdvertiserTargetingConfig: Targeting settings related to ad serving of an advertiser. - `exemptTvFromViewabilityTargeting` boolean: Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. - `updateTime` string, google-datetime: Output only. The timestamp when the advertiser was last updated. Assigned by the system. --- [API](https://skmtc.dev/google/apis/displayvideo.md) - [All operations](https://skmtc.dev/google/apis/displayvideo/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/displayvideo/revisions/d80b56b6703a?raw)