Method: customers.campaigns.enablePMaxBrandGuidelines

Enables Brand Guidelines for Performance Max campaigns.

List of thrown errors: AuthenticationError AssetError AssetLinkError AuthorizationError BrandGuidelinesMigrationError CampaignError HeaderError InternalError MutateError QuotaError RequestError ResourceCountLimitExceededError

HTTP request

POST https://googleads.googleapis.com/v19/customers/{customerId}/campaigns:enablePMaxBrandGuidelines

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose campaigns are being enabled.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "operations": [
    {
      object (EnableOperation)
    }
  ]
}
Fields
operations[]

object (EnableOperation)

Required. The list of individual campaign operations. A maximum of 10 enable operations can be executed in a request.

Response body

Brand Guidelines campaign enablement response.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "results": [
    {
      object (EnablementResult)
    }
  ]
}
Fields
results[]

object (EnablementResult)

Campaign enablement results per campaign.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

EnableOperation

A single enable operation of a campaign.

JSON representation 
{
  "campaign": string,
  "autoPopulateBrandAssets": boolean,
  "brandAssets": {
    object (BrandCampaignAssets)
  },
  "finalUriDomain": string,
  "mainColor": string,
  "accentColor": string,
  "fontFamily": string
}
Fields
campaign

string

Required. The resource name of the campaign to enable.
autoPopulateBrandAssets

boolean

Required. The switch to automatically populate top-performing brand assets. This field is required. If true, top-performing brand assets will be automatically populated. If false, the brandAssets field is required.
brandAssets

object (BrandCampaignAssets)

Optional. The brand assets linked to the campaign. This field is required when the value of autoPopulateBrandAssets is false.
finalUriDomain

string

Optional. The domain of the final uri.
mainColor

string

Optional. Hex code representation of the main brand color, for example #00ff00. mainColor is required when accent color is specified.
accentColor

string

Optional. Hex code representation of the accent brand color, for example #00ff00. accentColor is required when mainColor is specified.
fontFamily

string

Optional. The font family is specified as a string, and must be one of the following: "Open Sans", "Roboto", "Roboto Slab", "Montserrat", "Poppins", "Lato", "Oswald", or "Playfair Display".

BrandCampaignAssets

Assets linked at the campaign level. A businessName and at least one logoAsset are required.

JSON representation 
{
  "businessNameAsset": string,
  "logoAsset": [
    string
  ],
  "landscapeLogoAsset": [
    string
  ]
}
Fields
businessNameAsset

string

Required. The resource name of the business name text asset.
logoAsset[]

string

Required. The resource name of square logo assets.
landscapeLogoAsset[]

string

Optional. The resource name of landscape logo assets.

EnablementResult

A single enablement result of a campaign.

JSON representation 
{
  "campaign": string,
  "enablementError": {
    object (Status)
  }
}
Fields
campaign

string

This indicates the campaign for which enablement was tried, regardless of the outcome.
enablementError

object (Status)

Details of the error when enablement fails.