CampaignDraft

キャンペーンの下書き

JSON 表現 
{
  "resourceName": string,
  "status": enum (CampaignDraftStatus),
  "draftId": string,
  "baseCampaign": string,
  "name": string,
  "draftCampaign": string,
  "hasExperimentRunning": boolean,
  "longRunningOperation": string
}
フィールド
resourceName

string

変更不可。キャンペーンの下書きのリソース名です。キャンペーンの下書きのリソース名の形式は次のとおりです。

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

enum (CampaignDraftStatus)

出力のみ。キャンペーンの下書きのステータスです。このフィールドは読み取り専用です。

新しいキャンペーンの下書きを追加すると、ステータスはデフォルトで「PROPOSED」に設定されます。
draftId

string (int64 format)

出力のみ。下書きの ID。

このフィールドは読み取り専用です。
baseCampaign

string

変更不可。下書きが属する基本のキャンペーンです。
name

string

キャンペーンの下書きの名前。

新しいキャンペーンの下書きを作成する場合、このフィールドは必須で、空にはできません。

null（コードポイント 0x0）、NL ラインフィード（コードポイント 0xA）、改行（コードポイント 0xD）の文字を含めることはできません。
draftCampaign

string

出力のみ。下書きの変更を基本のキャンペーンに重ねて表示するキャンペーンのリソース名。

このフィールドは読み取り専用です。
hasExperimentRunning

boolean

出力のみ。現在配信中のこの下書きに基づくテストがあるかどうか。
longRunningOperation

string

出力のみ。下書きのプロモーションの完了をポーリングするために使用できる長時間実行オペレーションのリソース名。この値は、プロモーションの下書きが進行中または終了した場合にのみ設定されます。

CampaignDraftStatus

キャンペーンの下書きのステータス。

列挙型
UNSPECIFIED ステータスが指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
PROPOSED 下書きの初期状態では、広告主様は配信に影響を与えることなく変更の追加を開始できます。
REMOVED キャンペーンの下書きが削除されました。
PROMOTING 広告主様は、下書きの変更を元のキャンペーンに戻すようリクエストしました。広告主は、プロモーション アクションによって返される長時間実行オペレーションをポーリングして、プロモーションのステータスを確認できます。
PROMOTED 下書きの変更点を元のキャンペーンに統合するプロセスが完了しました。
PROMOTE_FAILED 部分的に適用されたため、プロモーションに失敗しました。プロモーションを安全に再試行できないため、元のキャンペーンで問題を修正する必要があります。