Google Ads Customers.Campaign Goal Configs API

openapi: 3.2.0
info:
  title: Google Ads Customers.Campaign Goal Configs API
  description: Manage your Google Ads accounts, campaigns, and reports with this API.
  version: v25
  x-discovery-revision: '20260721'
  contact:
    name: Google
    url: https://developers.google.com/google-ads/api/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://googleads.googleapis.com
  description: Google Ads API production server
security:
- oauth2:
  - https://www.googleapis.com/auth/adwords
tags:
- name: customers.CampaignGoalConfigs
paths:
  /v25/customers/{customersId}/CampaignGoalConfigs:mutate:
    parameters:
    - name: upload_protocol
      in: query
      required: false
      schema:
        type: string
      description: Upload protocol for media (e.g. "raw", "multipart").
    - name: quotaUser
      in: query
      required: false
      schema:
        type: string
      description: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    - name: fields
      in: query
      required: false
      schema:
        type: string
      description: Selector specifying which fields to include in a partial response.
    - name: $.xgafv
      in: query
      required: false
      schema:
        type: string
        enum:
        - '1'
        - '2'
        x-enumDescriptions:
        - v1 error format
        - v2 error format
      description: V1 error format.
    - name: callback
      in: query
      required: false
      schema:
        type: string
      description: JSONP
    - name: prettyPrint
      in: query
      required: false
      schema:
        type: boolean
        default: 'true'
      description: Returns response with indentations and line breaks.
    - name: access_token
      in: query
      required: false
      schema:
        type: string
      description: OAuth access token.
    - name: uploadType
      in: query
      required: false
      schema:
        type: string
      description: Legacy upload protocol for media (e.g. "media", "multipart").
    - name: key
      in: query
      required: false
      schema:
        type: string
      description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    - name: oauth_token
      in: query
      required: false
      schema:
        type: string
      description: OAuth 2.0 token for the current user.
    - name: alt
      in: query
      required: false
      schema:
        x-enumDescriptions:
        - Responses with Content-Type of application/json
        - Media download with context-dependent Content-Type
        - Responses with Content-Type of application/x-protobuf
        type: string
        default: json
        enum:
        - json
        - media
        - proto
      description: Data format for response.
    post:
      operationId: googleads_customers_CampaignGoalConfigs_mutate
      summary: Create or update campaign goal configs
      tags:
      - customers.CampaignGoalConfigs
      description: 'Create or update campaign goal configs. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [CampaignGoalConfigError]()'
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          pattern: ^[^/]+$
          type: string
        description: Required. The ID of the customer whose campaign goal configs are being modified.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleAdsGoogleadsV25Services__MutateCampaignGoalConfigsRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleAdsGoogleadsV25Services__MutateCampaignGoalConfigsResponse'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/adwords
components:
  schemas:
    GoogleAdsGoogleadsV25Common__CustomerLifecycleOptimizationValueSettings:
      type: object
      properties:
        valueMultiplier:
          format: double
          type: number
          description: Conversion value multiplier.
        additionalValue:
          description: Incremental conversion value.
          type: number
          format: double
        additionalHighLifetimeValue:
          description: Incremental high lifetime conversion value.
          type: number
          format: double
        highLifetimeValueMultiplier:
          format: double
          type: number
          description: High lifetime conversion value multiplier.
      description: Lifecycle goal optimization value settings.
    GoogleAdsGoogleadsV25Services__MutateCampaignGoalConfigsResponse:
      description: Response message for a campaign goal config mutate.
      type: object
      properties:
        partialFailureError:
          $ref: '#/components/schemas/GoogleRpc__Status'
          description: Errors that pertain to operation failures in the partial failure mode.
        results:
          type: array
          description: All results for the mutate.
          items:
            $ref: '#/components/schemas/GoogleAdsGoogleadsV25Services__MutateCampaignGoalConfigResult'
    GoogleAdsGoogleadsV25Resources__CampaignGoalConfig:
      type: object
      properties:
        campaignRetentionSettings:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Common_CampaignGoalSettings_CampaignRetentionGoalSettings'
          description: Retention goal campaign settings.
        campaignNewCustomerAcquisitionSettings:
          description: New customer acquisition goal campaign settings.
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Common_CampaignGoalSettings_CampaignNewCustomerAcquisitionGoalSettings'
        campaignLoyaltyRetentionSettings:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Common_CampaignGoalSettings_CampaignLoyaltyRetentionGoalSettings'
          description: Loyalty retention goal campaign settings.
        goal:
          type: string
          description: Immutable. The resource name of the goal this link is attached to.
        campaign:
          type: string
          description: Immutable. The resource name of the campaign for this link.
        goalType:
          x-enumDescriptions:
          - Not specified.
          - Used for return value only. Represents value unknown in this version.
          - Retention goal, which allows advertisers to optimize campaigns to win back lapsed customers. (https://support.google.com/google-ads/answer/14792043?hl=en)
          - New customer acquisition goal, which allows advertisers to optimize campaigns to acquire new customers.
          - Loyalty retention goal, which allows advertisers to optimize campaigns for retaining loyalty program members.
          type: string
          description: Output only. The goal type this link is attached to.
          enum:
          - UNSPECIFIED
          - UNKNOWN
          - CUSTOMER_RETENTION
          - NEW_CUSTOMER_ACQUISITION
          - LOYALTY_RETENTION
        resourceName:
          description: '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}`'
          type: string
      description: A link between a campaign and a goal enabling campaign-specific optimization.
    GoogleAdsGoogleadsV25Common_CampaignGoalSettings_CampaignLoyaltyRetentionGoalSettings:
      description: Loyalty retention campaign goal settings.
      type: object
      properties:
        enableBidAdjustmentsForLoyaltyMembers:
          type: boolean
          description: Whether to adjust bids for loyalty members.
        showTargetedLoyaltyMemberBenefitsInPla:
          description: Whether to show targeted loyalty member benefits in PLA format in eligible countries.
          type: boolean
        valueSettingsOverride:
          description: Loyalty retention goal campaign specific value settings.
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Common__CustomerLifecycleOptimizationValueSettings'
    GoogleAdsGoogleadsV25Services__CampaignGoalConfigOperation:
      type: object
      properties:
        update:
          description: Update an existing campaign goal config.
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Resources__CampaignGoalConfig'
        updateMask:
          description: FieldMask that determines which fields are modified in an update.
          type: string
          format: google-fieldmask
        create:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Resources__CampaignGoalConfig'
          description: Create a new campaign goal config.
        remove:
          description: Remove an existing campaign goal config.
          type: string
      description: A single mutate operation on the campaign goal config.
    GoogleAdsGoogleadsV25Common_CampaignGoalSettings_CampaignNewCustomerAcquisitionGoalSettings:
      description: New Customer Acquisition campaign goal settings.
      type: object
      properties:
        targetOption:
          x-enumDescriptions:
          - Not specified.
          - Used for return value only. Represents value unknown in this version.
          - The mode is used when the campaign optimizes for all customers, which is the default value.
          - This mode configures the campaign to target only customers who have previously interacted but are now lapsed or disengaged.
          enum:
          - UNSPECIFIED
          - UNKNOWN
          - TARGET_ALL
          - TARGET_SPECIFIC
          description: New Customer Acquisition goal optimization mode for this campaign. Defaults to TARGET_ALL. Whether the campaign is targeting new customers only.
          type: string
        valueSettingsOverride:
          description: New Customer Acquisition goal campaign specific value settings.
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Common__CustomerLifecycleOptimizationValueSettings'
    GoogleAdsGoogleadsV25Common_CampaignGoalSettings_CampaignRetentionGoalSettings:
      type: object
      properties:
        targetOption:
          description: Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option.
          type: string
          x-enumDescriptions:
          - Not specified.
          - Used for return value only. Represents value unknown in this version.
          - The mode is used when the campaign optimizes for all customers, which is the default value.
          - This mode configures the campaign to target only customers who have previously interacted but are now lapsed or disengaged.
          enum:
          - UNSPECIFIED
          - UNKNOWN
          - TARGET_ALL
          - TARGET_SPECIFIC
        valueSettingsOverride:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV25Common__CustomerLifecycleOptimizationValueSettings'
          description: Retention goal campaign specific value settings.
      description: Retention campaign goal settings.
    GoogleRpc__Status:
      description: '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).'
      type: object
      properties:
        message:
          description: 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.
          type: string
        code:
          type: integer
          description: The status code, which should be an enum value of google.rpc.Code.
          format: int32
        details:
          type: array
          description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
          items:
            type: object
            additionalProperties:
              description: Properties of the object. Contains field @type with type URL.
    GoogleAdsGoogleadsV25Services__MutateCampaignGoalConfigResult:
      type: object
      properties:
        resourceName:
          type: string
          description: Returned for successful operations.
      description: The result for the campaign goal config mutate.
    GoogleAdsGoogleadsV25Services__MutateCampaignGoalConfigsRequest:
      type: object
      properties:
        operations:
          description: Required. The list of operations to perform on the campaign goal configs.
          items:
            $ref: '#/components/schemas/GoogleAdsGoogleadsV25Services__CampaignGoalConfigOperation'
          type: array
        validateOnly:
          description: Optional. If true, the request is validated but not executed. Only errors are returned, not results.
          type: boolean
        partialFailure:
          type: boolean
          description: 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.
      description: Request message for CampaignGoalConfigService.MutateCampaignGoalConfigs.
  securitySchemes:
    oauth2:
      type: oauth2
      description: Google OAuth 2.0. Google Ads API additionally requires a developer token in the developer-token header.
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/adwords: See, edit, create, and delete your Google Ads accounts and data.
externalDocs:
  url: https://developers.google.com/google-ads/api/
x-source: https://googleads.googleapis.com/$discovery/rest?version=v25
x-generated-by: API Evangelist enrichment pipeline — mechanical conversion of the first-party Google API Discovery Document