Google Ads Incentives API

openapi: 3.2.0
info:
  title: Google Ads Incentives API
  version: v26
  description: Generated from Google's published Discovery document for Google Ads API (googleads v26, revision 20261110). 1 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://googleads.googleapis.com
tags:
- name: Incentives
paths:
  /v26/incentives:fetchIncentive:
    get:
      operationId: googleads.incentives.fetchIncentive
      summary: Fetch incentive incentives
      description: Returns incentives for a given user.
      parameters:
      - name: countryCode
        in: query
        required: false
        description: 'Optional. User''s country code. If not provided, the server will default to "US". Possible country codes: https://developers.google.com/google-ads/api/data/codes-formats#country_codes'
        schema:
          type: string
      - name: email
        in: query
        required: false
        description: Optional. Email of the user that the requested incentive is meant for. Will be used for channel partners who do NOT use OAuth to authenticate on behalf of user.
        schema:
          type: string
      - name: incentiveType
        in: query
        required: false
        description: Optional. The type of incentive to get. Defaults to ACQUISITION.
        schema:
          enum:
          - UNSPECIFIED
          - UNKNOWN
          - ACQUISITION
          type: string
      - name: languageCode
        in: query
        required: false
        description: 'Optional. User''s language code. If not provided, the server will default to "en". Possible language codes: https://developers.google.com/google-ads/api/data/codes-formats#languages'
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services__FetchIncentiveResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/adwords
      - apiKey: []
      tags:
      - Incentives
components:
  schemas:
    GoogleAdsGoogleadsV26Services_Incentive_Requirement:
      properties:
        spend:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services_IncentiveRequirement_Spend'
          description: Optional. Spend requirement for an incentive.
      description: Requirement for an incentive.
      type: object
    GoogleType__Money:
      description: Represents an amount of money with its currency type.
      type: object
      properties:
        nanos:
          description: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
          type: integer
          format: int32
        units:
          description: The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
          type: string
          format: int64
        currencyCode:
          type: string
          description: The three-letter currency code defined in ISO 4217.
    GoogleAdsGoogleadsV26Services_IncentiveRequirement_Spend:
      description: Spend requirements for an incentive.
      type: object
      properties:
        awardAmount:
          $ref: '#/components/schemas/GoogleType__Money'
          description: Required. Amount in free spend that user will be granted after spending target amount. Denominated in the currency of the country passed in the get request.
        requiredAmount:
          $ref: '#/components/schemas/GoogleType__Money'
          description: Required. Amount that user must spend to receive the award amount. Denominated in the currency of the country passed in the get request.
    GoogleAdsGoogleadsV26Services__FetchIncentiveResponse:
      properties:
        incentiveOffer:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services__IncentiveOffer'
          description: Required. The acquisition incentive offer for the user.
      description: Response from getting the acquisition incentive for a user when they visit a specific marketing page.
      type: object
    GoogleAdsGoogleadsV26Services__CyoIncentives:
      type: object
      properties:
        lowOffer:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services__Incentive'
          description: Required. The CYO incentive with low target and award amounts.
        mediumOffer:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services__Incentive'
          description: Required. The CYO incentive with medium target and award amounts.
        highOffer:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services__Incentive'
          description: Required. The CYO incentive with high target and award amounts.
      description: An incentive offer in the Choose-Your-Own Incentive feature where a user can select from a set of incentives with different money amounts.
    GoogleAdsGoogleadsV26Services__Incentive:
      description: An incentive that a user can claim for their account.
      type: object
      properties:
        incentiveTermsAndConditionsUrl:
          type: string
          description: The URL of the terms and conditions for THIS incentive offer ONLY. This is different from the terms_and_conditions_url field in AcquisitionIncentiveOffer which is a combination of all the Incentive offers in a CYO offer.
        incentiveId:
          format: int64
          type: string
          description: The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow.
        incentiveType:
          type: string
          enum:
          - UNSPECIFIED
          - UNKNOWN
          - ACQUISITION
          description: The type of the incentive.
        requirement:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services_Incentive_Requirement'
          description: The requirement for this incentive.
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    GoogleAdsGoogleadsV26Services__IncentiveOffer:
      description: An acquisition incentive offer for a user. An offer means how the user is treated. An offer can have no incentive or multiple incentives.
      properties:
        consolidatedTermsAndConditionsUrl:
          description: Optional. The URL of the terms and conditions for the incentive offer.
          type: string
        cyoIncentives:
          $ref: '#/components/schemas/GoogleAdsGoogleadsV26Services__CyoIncentives'
          description: CYO incentives. Set when type is CYO_INCENTIVE.
        offerType:
          type: string
          description: Required. The type of this acquisition incentive offer.
          enum:
          - UNSPECIFIED
          - UNKNOWN
          - NO_INCENTIVE
          - CYO_INCENTIVE
      type: object
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      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-provenance:
  method: harvested
  publisher: Google
  source: https://googleads.googleapis.com/$discovery/rest?version=v26
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261110)