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

Resource: CampaignAsset

A link between a Campaign and an Asset.

JSON representation
{
  "resourceName": string,
  "fieldType": enum (AssetFieldType),
  "status": enum (AssetLinkStatus),
  "campaign": string,
  "asset": string
}
Fields
resourceName

string

Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form:

customers/{customerId}/campaignAssets/{campaignId}~{asset_id}~{fieldType}

fieldType

enum (AssetFieldType)

Immutable. Role that the asset takes under the linked campaign. Required.

status

enum (AssetLinkStatus)

Status of the campaign asset.

campaign

string

Immutable. The campaign to which the asset is linked.

asset

string

Immutable. The asset which is linked to the campaign.

Methods

get

Returns the requested campaign asset in full detail.

mutate

Creates, updates, or removes campaign assets.