Close httplib2 connections.
fetchIncentive(countryCode=None, email=None, languageCode=None, type=None, x__xgafv=None)
Returns incentives for a given user.
close()
Close httplib2 connections.
fetchIncentive(countryCode=None, email=None, languageCode=None, type=None, x__xgafv=None)
Returns incentives for a given user.
Args:
countryCode: string, 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
email: string, 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.
languageCode: string, 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
type: string, Optional. The type of incentive to get. Defaults to ACQUISITION.
Allowed values
UNSPECIFIED - Not specified.
UNKNOWN - Unknown incentive type. Should not be used as a value explicitly.
ACQUISITION - An acquisition incentive.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response from getting the acquisition incentive for a user when they visit a specific marketing page.
"incentiveOffer": { # An acquisition incentive offer for a user. An offer means how the user is treated. An offer can have no incentive or multiple incentives. # Required. The acquisition incentive offer for the user.
"consolidatedTermsAndConditionsUrl": "A String", # Optional. The URL of the terms and conditions for the incentive offer.
"cyoIncentives": { # An incentive offer in the Choose-Your-Own Incentive feature where a user can select from a set of incentives with different money amounts. # CYO incentives. Set when type is CYO_INCENTIVE.
"highOffer": { # An incentive that a user can claim for their account. # Required. The CYO incentive with high target and award amounts.
"incentiveId": "A String", # The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow.
"incentiveTermsAndConditionsUrl": "A String", # 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.
"requirement": { # Requirement for an incentive. # The requirement for this incentive.
"spend": { # Spend requirements for an incentive. # Optional. Spend requirement for an incentive.
"awardAmount": { # Represents an amount of money with its currency type. # 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.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"requiredAmount": { # Represents an amount of money with its currency type. # Required. Amount that user must spend to receive the award amount. Denominated in the currency of the country passed in the get request.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
},
"type": "A String", # The type of the incentive.
},
"lowOffer": { # An incentive that a user can claim for their account. # Required. The CYO incentive with low target and award amounts.
"incentiveId": "A String", # The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow.
"incentiveTermsAndConditionsUrl": "A String", # 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.
"requirement": { # Requirement for an incentive. # The requirement for this incentive.
"spend": { # Spend requirements for an incentive. # Optional. Spend requirement for an incentive.
"awardAmount": { # Represents an amount of money with its currency type. # 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.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"requiredAmount": { # Represents an amount of money with its currency type. # Required. Amount that user must spend to receive the award amount. Denominated in the currency of the country passed in the get request.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
},
"type": "A String", # The type of the incentive.
},
"mediumOffer": { # An incentive that a user can claim for their account. # Required. The CYO incentive with medium target and award amounts.
"incentiveId": "A String", # The incentive ID of this incentive. This is used to identify which incentive is selected by the user in the CYO flow.
"incentiveTermsAndConditionsUrl": "A String", # 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.
"requirement": { # Requirement for an incentive. # The requirement for this incentive.
"spend": { # Spend requirements for an incentive. # Optional. Spend requirement for an incentive.
"awardAmount": { # Represents an amount of money with its currency type. # 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.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"requiredAmount": { # Represents an amount of money with its currency type. # Required. Amount that user must spend to receive the award amount. Denominated in the currency of the country passed in the get request.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
},
"type": "A String", # The type of the incentive.
},
},
"type": "A String", # Required. The type of this acquisition incentive offer.
},
}