1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="paymentsresellersubscription_v1.html">Payments Reseller Subscription API</a> . <a href="paymentsresellersubscription_v1.partners.html">partners</a> . <a href="paymentsresellersubscription_v1.partners.promotions.html">promotions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#findEligible">findEligible(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Currently, it is only enabeld for **YouTube**. Finds 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.</p>
<p class="toc_element">
<code><a href="#findEligible_next">findEligible_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Currently, it doesn't support **YouTube** promotions. Retrieves the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="findEligible">findEligible(parent, body=None, x__xgafv=None)</code>
<pre>Currently, it is only enabeld for **YouTube**. Finds 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. 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. 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.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="findEligible_next">findEligible_next()</code>
<pre>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.
</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Currently, it doesn't support **YouTube** promotions. Retrieves 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. 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. 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.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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.
</pre>
</div>
</body></html>
|
