Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.campaignExtensionSettings

Resource: CampaignExtensionSetting

A campaign extension setting.

JSON representation
{
  "resourceName": string,
  "extensionType": enum (ExtensionType),
  "extensionFeedItems": [
    string
  ],
  "device": enum (ExtensionSettingDevice),
  "campaign": string
}
Fields
resourceName

string

Immutable. The resource name of the campaign extension setting. CampaignExtensionSetting resource names have the form:

customers/{customerId}/campaignExtensionSettings/{campaignId}~{extensionType}

extensionType

enum (ExtensionType)

Immutable. The extension type of the customer extension setting.

extensionFeedItems[]

string

The resource names of the extension feed items to serve under the campaign. ExtensionFeedItem resource names have the form:

customers/{customerId}/extensionFeedItems/{feed_item_id}

device

enum (ExtensionSettingDevice)

The device for which the extensions will serve. Optional.

campaign

string

Immutable. The resource name of the campaign. The linked extension feed items will serve under this campaign. Campaign resource names have the form:

customers/{customerId}/campaigns/{campaignId}

Methods

get

Returns the requested campaign extension setting in full detail.

mutate

Creates, updates, or removes campaign extension settings.