type Draft (v201806)

The interface object which contains the basic information of a draft. Entity specific information in the campaign tree are represented by their respective entities objects with a corresponding draftId.


Namespace
https://adwords.google.com/api/adwords/cm/v201806

Field

draftId

xsd:long

This field can be selected using the value "DraftId".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: ADD.
This field is required and should not be null when it is contained within Operators : SET.

baseCampaignId

xsd:long

This field can be selected using the value "BaseCampaignId".
This field can be filtered on.
This field is required and should not be null.

draftName

xsd:string

This field can be selected using the value "DraftName".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : ADD.
The length of this string should be between 1 and 1024, inclusive, in UTF-8 bytes, (trimmed).

draftStatus

DraftStatus


Enumerations
UNKNOWN
Invalid status. Should not be used except for detecting values that are incorrect, or values that are not yet known to the user.
PROPOSED
Initial state of the draft, the advertiser can start adding changes with no effect on serving.
PROMOTED
The process to merge changes in the draft back to the original campaign has completedly successfully. The advertiser cannot set this status directly. To move the draft to this status, set the draft to status PROMOTING and the status will be updated to PROMOTED when the changes are applied to the original campaign.
PROMOTING
The advertiser requested to merge changes in the draft back into the original campaigns. The update to the original campaign will be kicked off asynchronously and the status will be updated to PROMOTED or PROMOTE_FAILED upon completion.
ARCHIVED
The advertiser has archived the draft.
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. More details about the errors are available through getErrors in the DraftService API.The advertiser cannot set this status directly. To promote the draft, set the draft in state PROMOTING and the status will be updated to PROMOTE_FAILED if errors are encountered while applying changes to the original campaign.

This field can be selected using the value "DraftStatus".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: ADD.

draftCampaignId

xsd:long

The campaign id that references the draft version of the original campaign.

This field can be selected using the value "DraftCampaignId".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

hasRunningTrial

xsd:boolean

True, if a trial created from this draft is running. Only available via the Get action.

This field can be selected using the value "HasRunningTrial".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.