CampaignDraft

  • Campaign drafts have a resource name format of customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}.

  • The status of a campaign draft is read-only and defaults to PROPOSED when new drafts are added.

  • The draft_id, draft_campaign, has_experiment_running, and long_running_operation fields are output only.

  • A campaign draft is associated with a base_campaign and has a required name.

A campaign draft.

Fields

resource_name

string

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

customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}

status

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.

draft_id

int64

Output only. The ID of the draft.

This field is read-only.

base_campaign

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.

draft_campaign

string

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

This field is read-only.

has_experiment_running

bool

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

long_running_operation

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.