--- title: "POST /v23/customers/{customersId}/campaignDrafts:mutate" method: POST path: "/v23/customers/{customersId}/campaignDrafts:mutate" tags: ["customers"] --- # POST /v23/customers/{customersId}/campaignDrafts:mutate `POST /v23/customers/{customersId}/campaignDrafts:mutate` ## Request - Base URL: `https://searchads360.googleapis.com` - URL: `https://searchads360.googleapis.com/v23/customers/{customersId}/campaignDrafts:mutate` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/doubleclicksearch` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/doubleclicksearch` - TypeScript: (a function with typed inputs; its response is checked against the schema) Creates, updates, or removes campaign drafts. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignDraftError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() ## Path parameters - `customersId` string, required ## Request body - GoogleAdsSearchads360V23ServicesMutateCampaignDraftsRequest: Request message for CampaignDraftService.MutateCampaignDrafts. - `operations` GoogleAdsSearchads360V23ServicesCampaignDraftOperation[]: Required. The list of operations to perform on individual campaign drafts. - `create` GoogleAdsSearchads360V23ResourcesCampaignDraft: A campaign draft. - `baseCampaign` string: Immutable. The base campaign to which the draft belongs. - `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. - `draftId` string, int64: Output only. The ID of the draft. 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. - `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. - `resourceName` 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` 'UNSPECIFIED' | 'UNKNOWN' | 'PROPOSED' | 'REMOVED' | 'PROMOTING' | 'PROMOTED' | 'PROMOTE_FAILED': 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. - `remove` string: Remove operation: The campaign draft is expected to have a valid resource name, in this format: `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}` - `update` GoogleAdsSearchads360V23ResourcesCampaignDraft: A campaign draft. - `baseCampaign` string: Immutable. The base campaign to which the draft belongs. - `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. - `draftId` string, int64: Output only. The ID of the draft. 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. - `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. - `resourceName` 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` 'UNSPECIFIED' | 'UNKNOWN' | 'PROPOSED' | 'REMOVED' | 'PROMOTING' | 'PROMOTED' | 'PROMOTE_FAILED': 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. - `updateMask` string, google-fieldmask: FieldMask that determines which resource fields are modified in an update. - `partialFailure` boolean: If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false. - `responseContentType` 'UNSPECIFIED' | 'RESOURCE_NAME_ONLY' | 'MUTABLE_RESOURCE': The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation. - `validateOnly` boolean: If true, the request is validated but not executed. Only errors are returned, not results. ## Response `200` Successful response - GoogleAdsSearchads360V23ServicesMutateCampaignDraftsResponse: Response message for campaign draft mutate. - `partialFailureError` GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer: The status code, which should be an enum value of google.rpc.Code. - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use. - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `results` GoogleAdsSearchads360V23ServicesMutateCampaignDraftResult[]: All results for the mutate. - `campaignDraft` GoogleAdsSearchads360V23ResourcesCampaignDraft: A campaign draft. - `baseCampaign` string: Immutable. The base campaign to which the draft belongs. - `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. - `draftId` string, int64: Output only. The ID of the draft. 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. - `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. - `resourceName` 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` 'UNSPECIFIED' | 'UNKNOWN' | 'PROPOSED' | 'REMOVED' | 'PROMOTING' | 'PROMOTED' | 'PROMOTE_FAILED': 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. - `resourceName` string: Returned for successful operations. --- [API](https://skmtc.dev/google/apis/searchads360.md) - [All operations](https://skmtc.dev/google/apis/searchads360/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/searchads360/revisions/4a4511f84b18?raw)