GoogleAdsGoogleadsV25Services__FetchIncentiveResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-fetch-incentive-response-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__FetchIncentiveResponse",
  "description": "Response from getting the acquisition incentive for a user when they visit a specific marketing page.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-incentives-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__FetchIncentiveResponse",
  "type": "object",
  "properties": {
    "incentiveOffer": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__IncentiveOffer",
      "description": "Required. The acquisition incentive offer for the user."
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Services_IncentiveRequirement_Spend": {
      "type": "object",
      "properties": {
        "awardAmount": {
          "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.",
          "$ref": "#/$defs/GoogleType__Money"
        },
        "requiredAmount": {
          "description": "Required. Amount that user must spend to receive the award amount. Denominated in the currency of the country passed in the get request.",
          "$ref": "#/$defs/GoogleType__Money"
        }
      },
      "description": "Spend requirements for an incentive."
    },
    "GoogleAdsGoogleadsV25Services_Incentive_Requirement": {
      "description": "Requirement for an incentive.",
      "type": "object",
      "properties": {
        "spend": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Services_IncentiveRequirement_Spend",
          "description": "Optional. Spend requirement for an incentive."
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__CyoIncentives": {
      "type": "object",
      "properties": {
        "mediumOffer": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__Incentive",
          "description": "Required. The CYO incentive with medium target and award amounts."
        },
        "lowOffer": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__Incentive",
          "description": "Required. The CYO incentive with low target and award amounts."
        },
        "highOffer": {
          "description": "Required. The CYO incentive with high target and award amounts.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__Incentive"
        }
      },
      "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."
    },
    "GoogleAdsGoogleadsV25Services__Incentive": {
      "description": "An incentive that a user can claim for their account.",
      "type": "object",
      "properties": {
        "requirement": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Services_Incentive_Requirement",
          "description": "The requirement for this incentive."
        },
        "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."
        },
        "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."
        },
        "incentiveType": {
          "description": "The type of the incentive.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Unknown incentive type. Should not be used as a value explicitly.",
            "An acquisition incentive."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ACQUISITION"
          ]
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__IncentiveOffer": {
      "type": "object",
      "properties": {
        "consolidatedTermsAndConditionsUrl": {
          "description": "Optional. The URL of the terms and conditions for the incentive offer.",
          "type": "string"
        },
        "cyoIncentives": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__CyoIncentives",
          "description": "CYO incentives. Set when type is CYO_INCENTIVE."
        },
        "offerType": {
          "description": "Required. The type of this acquisition incentive offer.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Unknown offer type.",
            "An offer with no incentive.",
            "A CYO (Choose-Your-Own) offer with multiple incentives to choose from."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "NO_INCENTIVE",
            "CYO_INCENTIVE"
          ]
        }
      },
      "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."
    },
    "GoogleType__Money": {
      "description": "Represents an amount of money with its currency type.",
      "type": "object",
      "properties": {
        "currencyCode": {
          "description": "The three-letter currency code defined in ISO 4217.",
          "type": "string"
        },
        "nanos": {
          "format": "int32",
          "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"
        },
        "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"
        }
      }
    }
  }
}