--- title: "POST /v23/customers/{customersId}/CampaignGoalConfigs:mutate" method: POST path: "/v23/customers/{customersId}/CampaignGoalConfigs:mutate" tags: ["customers"] --- # POST /v23/customers/{customersId}/CampaignGoalConfigs:mutate `POST /v23/customers/{customersId}/CampaignGoalConfigs:mutate` ## Request - Base URL: `https://searchads360.googleapis.com` - URL: `https://searchads360.googleapis.com/v23/customers/{customersId}/CampaignGoalConfigs: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) Create or update campaign goal configs. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [CampaignGoalConfigError]() [GoalServicesError]() ## Path parameters - `customersId` string, required ## Request body - GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigsRequest: Request message for CampaignGoalConfigService.MutateCampaignGoalConfigs. - `operations` GoogleAdsSearchads360V23ServicesCampaignGoalConfigOperation[]: Required. The list of operations to perform on the campaign goal configs. - `create` GoogleAdsSearchads360V23ResourcesCampaignGoalConfig: A link between a campaign and a goal enabling campaign-specific optimization. - `campaign` string: Immutable. The resource name of the campaign for this link. - `campaignLoyaltyRetentionSettings` GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings: Loyalty retention campaign goal settings. - `enableBidAdjustmentsForLoyaltyMembers` boolean: Whether to adjust bids for loyalty members. - `showTargetedLoyaltyMemberBenefitsInPla` boolean: Whether to show targeted loyalty member benefits in PLA format in eligible countries. - `valueSettingsOverride` GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings: Lifecycle goal optimization value settings. - `additionalHighLifetimeValue` number, double: High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set. - `additionalValue` number, double: Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value. - `campaignNewCustomerAcquisitionSettings` GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings: New Customer Acquisition campaign goal settings. - `targetOption` 'UNSPECIFIED' | 'UNKNOWN' | 'TARGET_ALL' | 'TARGET_SPECIFIC': New Customer Acquisition goal optimization mode for this campaign. Defaults to TARGET_ALL. Whether the campaign is targeting new customers only. - `valueSettingsOverride` GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings: Lifecycle goal optimization value settings. - `additionalHighLifetimeValue` number, double: High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set. - `additionalValue` number, double: Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value. - `campaignRetentionSettings` GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignRetentionGoalSettings: Retention campaign goal settings. - `targetOption` 'UNSPECIFIED' | 'UNKNOWN' | 'TARGET_ALL' | 'TARGET_SPECIFIC': Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option. - `valueSettingsOverride` GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings: Lifecycle goal optimization value settings. - `additionalHighLifetimeValue` number, double: High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set. - `additionalValue` number, double: Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value. - `goal` string: Immutable. The resource name of the goal this link is attached to. - `goalType` 'UNSPECIFIED' | 'UNKNOWN' | 'CUSTOMER_RETENTION' | 'NEW_CUSTOMER_ACQUISITION' | 'LOYALTY_RETENTION': Output only. The goal type this link is attached to. - `resourceName` string: Immutable. The resource name of the campaign goal config. campaign goal config resource names have the form: `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}` - `remove` string: Remove an existing campaign goal config. - `update` GoogleAdsSearchads360V23ResourcesCampaignGoalConfig: A link between a campaign and a goal enabling campaign-specific optimization. - `campaign` string: Immutable. The resource name of the campaign for this link. - `campaignLoyaltyRetentionSettings` GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings: Loyalty retention campaign goal settings. - `enableBidAdjustmentsForLoyaltyMembers` boolean: Whether to adjust bids for loyalty members. - `showTargetedLoyaltyMemberBenefitsInPla` boolean: Whether to show targeted loyalty member benefits in PLA format in eligible countries. - `valueSettingsOverride` GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings: Lifecycle goal optimization value settings. - `additionalHighLifetimeValue` number, double: High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set. - `additionalValue` number, double: Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value. - `campaignNewCustomerAcquisitionSettings` GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings: New Customer Acquisition campaign goal settings. - `targetOption` 'UNSPECIFIED' | 'UNKNOWN' | 'TARGET_ALL' | 'TARGET_SPECIFIC': New Customer Acquisition goal optimization mode for this campaign. Defaults to TARGET_ALL. Whether the campaign is targeting new customers only. - `valueSettingsOverride` GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings: Lifecycle goal optimization value settings. - `additionalHighLifetimeValue` number, double: High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set. - `additionalValue` number, double: Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value. - `campaignRetentionSettings` GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignRetentionGoalSettings: Retention campaign goal settings. - `targetOption` 'UNSPECIFIED' | 'UNKNOWN' | 'TARGET_ALL' | 'TARGET_SPECIFIC': Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option. - `valueSettingsOverride` GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings: Lifecycle goal optimization value settings. - `additionalHighLifetimeValue` number, double: High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set. - `additionalValue` number, double: Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value. - `goal` string: Immutable. The resource name of the goal this link is attached to. - `goalType` 'UNSPECIFIED' | 'UNKNOWN' | 'CUSTOMER_RETENTION' | 'NEW_CUSTOMER_ACQUISITION' | 'LOYALTY_RETENTION': Output only. The goal type this link is attached to. - `resourceName` string: Immutable. The resource name of the campaign goal config. campaign goal config resource names have the form: `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}` - `updateMask` string, google-fieldmask: FieldMask that determines which fields are modified in an update. - `partialFailure` boolean: Optional. 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. - `validateOnly` boolean: Optional. If true, the request is validated but not executed. Only errors are returned, not results. ## Response `200` Successful response - GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigsResponse: Response message for a campaign goal config 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` GoogleAdsSearchads360V23ServicesMutateCampaignGoalConfigResult[]: All results for the mutate. - `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)