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

Resource: CampaignDraft

A campaign draft.

JSON representation
{
  "resourceName": string,
  "status": enum (CampaignDraftStatus),
  "draftId": string,
  "baseCampaign": string,
  "name": string,
  "draftCampaign": string,
  "hasExperimentRunning": boolean,
  "longRunningOperation": string
}
Fields
resourceName

string

Immutable. The resource name of the campaign draft. Campaign draft resource names have the form:

customers/{customerId}/campaignDrafts/{base_campaign_id}~{draftId}

status

enum (CampaignDraftStatus)

Output only. The status of the campaign draft. This field is read-only.

When a new campaign draft is added, the status defaults to PROPOSED.

draftId

string (int64 format)

Output only. The ID of the draft.

This field is read-only.

baseCampaign

string

Immutable. The base campaign to which the draft belongs.

name

string

The name of the campaign draft.

This field is required and should not be empty when creating new campaign drafts.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

draftCampaign

string

Output only. Resource name of the Campaign that results from overlaying the draft changes onto the base campaign.

This field is read-only.

hasExperimentRunning

boolean

Output only. Whether there is an experiment based on this draft currently serving.

longRunningOperation

string

Output only. The resource name of the long-running operation that can be used to poll for completion of draft promotion. This is only set if the draft promotion is in progress or finished.

CampaignDraftStatus

Possible statuses of a campaign draft.

Enums
UNSPECIFIED The status has not been specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PROPOSED Initial state of the draft, the advertiser can start adding changes with no effect on serving.
REMOVED The campaign draft is removed.
PROMOTING Advertiser requested to promote draft's changes back into the original campaign. Advertiser can poll the long running operation returned by the promote action to see the status of the promotion.
PROMOTED The process to merge changes in the draft back to the original campaign has completed successfully.
PROMOTE_FAILED The promotion failed after it was partially applied. Promote cannot be attempted again safely, so the issue must be corrected in the original campaign.

Methods

get

Returns the requested campaign draft in full detail.

listAsyncErrors

Returns all errors that occurred during CampaignDraft promote.

mutate

Creates, updates, or removes campaign drafts.

promote

Promotes the changes in a draft back to the base campaign.