EnableOperation

  • A single operation enables a campaign.

  • The resource name of the campaign to enable is required.

  • The switch to automatically populate top-performing brand assets is a required boolean field.

  • Brand assets are optionally linked but required if auto-populating brand assets is false.

  • Optional fields include final URI domain, main and accent color (required if the other is specified), and font family (limited to specific options).

A single enable operation of a campaign.

Fields

campaign

string

Required. The resource name of the campaign to enable.

auto_populate_brand_assets

bool

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 brand_assets field is required.

brand_assets

BrandCampaignAssets

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

final_uri_domain

string

Optional. The domain of the final uri.

main_color

string

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

accent_color

string

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

font_family

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".