Close httplib2 connections.
findEligible(parent, body=None, x__xgafv=None)
To find eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen.
Retrieves the next page of results.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
To retrieve the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account.
Retrieves the next page of results.
close()
Close httplib2 connections.
findEligible(parent, body=None, x__xgafv=None)
To find eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen.
Args:
parent: string, Required. The parent, the partner that can resell. Format: partners/{partner} (required)
body: object, The request body.
The object takes the form of:
{ # Request to find eligible promotions for the current user.
"filter": "A String", # Optional. Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `applicableProducts` - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`
"pageSize": 42, # Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
"pageToken": "A String", # Optional. A page token, received from a previous `ListPromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotions` must match the call that provided the page token.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing the found promotions for the current user.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
"promotions": [ # The promotions for the current user.
{ # A Promotion resource that defines a promotion for a subscription that can be resold.
"applicableProducts": [ # Output only. The product ids this promotion can be applied to.
"A String",
],
"endTime": "A String", # Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely.
"freeTrialDuration": { # Describes the length of a period of a time. # Optional. Specifies the duration of the free trial of the subscription when promotion_type is PROMOTION_TYPE_FREE_TRIAL
"count": 42, # number of duration units to be included.
"unit": "A String", # The unit used for the duration
},
"introductoryPricingDetails": { # The details of a introductory pricing promotion. # Optional. Specifies the introductory pricing details when the promotion_type is PROMOTION_TYPE_INTRODUCTORY_PRICING.
"introductoryPricingSpecs": [ # Output only. Specifies the introductory pricing periods.
{ # The duration of an introductory pricing promotion.
"discountAmount": { # Describes the amount unit including the currency code. # Output only. The discount amount. The value is positive.
"amountMicros": "A String", # Required. Amount in micros (1_000_000 micros = 1 currency unit)
"currencyCode": "A String", # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
},
"discountRatioMicros": "A String", # Output only. The discount percentage in micros. For example, 50,000 represents 5%.
"recurrenceCount": 42, # Output only. Output Only. The duration of an introductory offer in billing cycles.
"regionCode": "A String", # Output only. 2-letter ISO region code where the product is available in. Ex. "US".
},
],
},
"name": "A String", # Identifier. Response only. Resource name of the subscription promotion. It will have the format of "partners/{partner_id}/promotion/{promotion_id}"
"promotionType": "A String", # Output only. Output Only. Specifies the type of the promotion.
"regionCodes": [ # Output only. 2-letter ISO region code where the promotion is available in. Ex. "US" Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1
"A String",
],
"startTime": "A String", # Optional. Specifies the start time (inclusive) of the period that the promotion is available in.
"titles": [ # Output only. Localized human readable name of the promotion.
{ # Localized variant of a text in a particular language.
"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
"text": "A String", # Localized string in the language corresponding to language_code below.
},
],
},
],
}
findEligible_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
To retrieve the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account.
Args:
parent: string, Required. The parent, the partner that can resell. Format: partners/{partner} (required)
filter: string, Optional. Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `applicableProducts` - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`
pageSize: integer, Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListPromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotions` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response that contains the promotions.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
"promotions": [ # The promotions for the specified partner.
{ # A Promotion resource that defines a promotion for a subscription that can be resold.
"applicableProducts": [ # Output only. The product ids this promotion can be applied to.
"A String",
],
"endTime": "A String", # Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely.
"freeTrialDuration": { # Describes the length of a period of a time. # Optional. Specifies the duration of the free trial of the subscription when promotion_type is PROMOTION_TYPE_FREE_TRIAL
"count": 42, # number of duration units to be included.
"unit": "A String", # The unit used for the duration
},
"introductoryPricingDetails": { # The details of a introductory pricing promotion. # Optional. Specifies the introductory pricing details when the promotion_type is PROMOTION_TYPE_INTRODUCTORY_PRICING.
"introductoryPricingSpecs": [ # Output only. Specifies the introductory pricing periods.
{ # The duration of an introductory pricing promotion.
"discountAmount": { # Describes the amount unit including the currency code. # Output only. The discount amount. The value is positive.
"amountMicros": "A String", # Required. Amount in micros (1_000_000 micros = 1 currency unit)
"currencyCode": "A String", # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
},
"discountRatioMicros": "A String", # Output only. The discount percentage in micros. For example, 50,000 represents 5%.
"recurrenceCount": 42, # Output only. Output Only. The duration of an introductory offer in billing cycles.
"regionCode": "A String", # Output only. 2-letter ISO region code where the product is available in. Ex. "US".
},
],
},
"name": "A String", # Identifier. Response only. Resource name of the subscription promotion. It will have the format of "partners/{partner_id}/promotion/{promotion_id}"
"promotionType": "A String", # Output only. Output Only. Specifies the type of the promotion.
"regionCodes": [ # Output only. 2-letter ISO region code where the promotion is available in. Ex. "US" Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1
"A String",
],
"startTime": "A String", # Optional. Specifies the start time (inclusive) of the period that the promotion is available in.
"titles": [ # Output only. Localized human readable name of the promotion.
{ # Localized variant of a text in a particular language.
"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
"text": "A String", # Localized string in the language corresponding to language_code below.
},
],
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.