blob: 32f1506c2b6b08a93aae827dbfa26ff8e4974373 [file] [log] [blame]
Anthonios Partheniou10f4b672021-04-13 14:47:53 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudchannel_v1.html">Cloud Channel API</a> . <a href="cloudchannel_v1.accounts.html">accounts</a> . <a href="cloudchannel_v1.accounts.offers.html">offers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#list">list(parent, filter=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93 <code class="details" id="list">list(parent, filter=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
94 <pre>Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.
95
96Args:
97 parent: string, Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}. (required)
98 filter: string, Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1
99 languageCode: string, Optional. The BCP-47 language code. For example, &quot;en-US&quot;. The response will localize in the corresponding language code, if specified. The default value is &quot;en-US&quot;.
100 pageSize: integer, Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.
101 pageToken: string, Optional. A token for a page of results other than the first page.
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 { # Response message for ListOffers.
111 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
112 &quot;offers&quot;: [ # The list of Offers requested.
113 { # Represents an offer made to resellers for purchase. An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying.
114 &quot;constraints&quot;: { # Represents the constraints for buying the Offer. # Constraints on transacting the Offer.
115 &quot;customerConstraints&quot;: { # Represents constraints required to purchase the Offer for a customer. # Represents constraints required to purchase the Offer for a customer.
116 &quot;allowedCustomerTypes&quot;: [ # Allowed Customer Type.
117 &quot;A String&quot;,
118 ],
119 &quot;allowedRegions&quot;: [ # Allowed geographical regions of the customer.
120 &quot;A String&quot;,
121 ],
122 &quot;promotionalOrderTypes&quot;: [ # Allowed Promotional Order Type. Present for Promotional offers.
123 &quot;A String&quot;,
124 ],
125 },
126 },
127 &quot;endTime&quot;: &quot;A String&quot;, # Output only. End of the Offer validity time.
128 &quot;marketingInfo&quot;: { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the Offer.
129 &quot;defaultLogo&quot;: { # Represents media information. # Default logo.
130 &quot;content&quot;: &quot;A String&quot;, # URL of the media.
131 &quot;title&quot;: &quot;A String&quot;, # Title of the media.
132 &quot;type&quot;: &quot;A String&quot;, # Type of the media.
133 },
134 &quot;description&quot;: &quot;A String&quot;, # Human readable description. Description can contain HTML.
135 &quot;displayName&quot;: &quot;A String&quot;, # Human readable name.
136 },
137 &quot;name&quot;: &quot;A String&quot;, # Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id}
138 &quot;parameterDefinitions&quot;: [ # Parameters required to use current Offer to purchase.
139 { # Parameter&#x27;s definition. Specifies what parameter is required to use the current Offer to purchase.
140 &quot;allowedValues&quot;: [ # If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.
141 { # Data type and value of a parameter.
142 &quot;boolValue&quot;: True or False, # Represents a boolean value.
143 &quot;doubleValue&quot;: 3.14, # Represents a double value.
144 &quot;int64Value&quot;: &quot;A String&quot;, # Represents an int64 value.
145 &quot;protoValue&quot;: { # Represents an &#x27;Any&#x27; proto value.
146 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
147 },
148 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
149 },
150 ],
151 &quot;maxValue&quot;: { # Data type and value of a parameter. # Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.
152 &quot;boolValue&quot;: True or False, # Represents a boolean value.
153 &quot;doubleValue&quot;: 3.14, # Represents a double value.
154 &quot;int64Value&quot;: &quot;A String&quot;, # Represents an int64 value.
155 &quot;protoValue&quot;: { # Represents an &#x27;Any&#x27; proto value.
156 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
157 },
158 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
159 },
160 &quot;minValue&quot;: { # Data type and value of a parameter. # Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.
161 &quot;boolValue&quot;: True or False, # Represents a boolean value.
162 &quot;doubleValue&quot;: 3.14, # Represents a double value.
163 &quot;int64Value&quot;: &quot;A String&quot;, # Represents an int64 value.
164 &quot;protoValue&quot;: { # Represents an &#x27;Any&#x27; proto value.
165 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
166 },
167 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
168 },
169 &quot;name&quot;: &quot;A String&quot;, # Name of the parameter.
170 &quot;optional&quot;: True or False, # If set to true, parameter is optional to purchase this Offer.
171 &quot;parameterType&quot;: &quot;A String&quot;, # Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
172 },
173 ],
174 &quot;plan&quot;: { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer.
175 &quot;billingAccount&quot;: &quot;A String&quot;, # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers.
176 &quot;paymentCycle&quot;: { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month.
177 &quot;duration&quot;: 42, # Total duration of Period Type defined.
178 &quot;periodType&quot;: &quot;A String&quot;, # Period Type.
179 },
180 &quot;paymentPlan&quot;: &quot;A String&quot;, # Describes how a reseller will be billed.
181 &quot;paymentType&quot;: &quot;A String&quot;, # Specifies when the payment needs to happen.
182 &quot;trialPeriod&quot;: { # Represents period in days/months/years. # Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period.
183 &quot;duration&quot;: 42, # Total duration of Period Type defined.
184 &quot;periodType&quot;: &quot;A String&quot;, # Period Type.
185 },
186 },
187 &quot;priceByResources&quot;: [ # Price for each monetizable resource type.
188 { # Represents price by resource type.
189 &quot;price&quot;: { # Represents the price of the Offer. # Price of the Offer. Present if there are no price phases.
190 &quot;basePrice&quot;: { # Represents an amount of money with its currency type. # Base price.
191 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
192 &quot;nanos&quot;: 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.
193 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
194 },
195 &quot;discount&quot;: 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.
196 &quot;effectivePrice&quot;: { # Represents an amount of money with its currency type. # Effective Price after applying the discounts.
197 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
198 &quot;nanos&quot;: 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.
199 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
200 },
201 &quot;externalPriceUri&quot;: &quot;A String&quot;, # Link to external price list, such as link to Google Voice rate card.
202 },
203 &quot;pricePhases&quot;: [ # Specifies the price by time range.
204 { # Specifies the price by the duration of months. For example, a 20% discount for the first six months, then a 10% discount starting on the seventh month.
205 &quot;firstPeriod&quot;: 42, # Defines first period for the phase.
206 &quot;lastPeriod&quot;: 42, # Defines first period for the phase.
207 &quot;periodType&quot;: &quot;A String&quot;, # Defines the phase period type.
208 &quot;price&quot;: { # Represents the price of the Offer. # Price of the phase. Present if there are no price tiers.
209 &quot;basePrice&quot;: { # Represents an amount of money with its currency type. # Base price.
210 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
211 &quot;nanos&quot;: 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.
212 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
213 },
214 &quot;discount&quot;: 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.
215 &quot;effectivePrice&quot;: { # Represents an amount of money with its currency type. # Effective Price after applying the discounts.
216 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
217 &quot;nanos&quot;: 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.
218 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
219 },
220 &quot;externalPriceUri&quot;: &quot;A String&quot;, # Link to external price list, such as link to Google Voice rate card.
221 },
222 &quot;priceTiers&quot;: [ # Price by the resource tiers.
223 { # Defines price at resource tier level. For example, an offer with following definition : * Tier 1: Provide 25% discount for all seats between 1 and 25. * Tier 2: Provide 10% discount for all seats between 26 and 100. * Tier 3: Provide flat 15% discount for all seats above 100. Each of these tiers is represented as a PriceTier.
224 &quot;firstResource&quot;: 42, # First resource for which the tier price applies.
225 &quot;lastResource&quot;: 42, # Last resource for which the tier price applies.
226 &quot;price&quot;: { # Represents the price of the Offer. # Price of the tier.
227 &quot;basePrice&quot;: { # Represents an amount of money with its currency type. # Base price.
228 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
229 &quot;nanos&quot;: 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.
230 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
231 },
232 &quot;discount&quot;: 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.
233 &quot;effectivePrice&quot;: { # Represents an amount of money with its currency type. # Effective Price after applying the discounts.
234 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
235 &quot;nanos&quot;: 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.
236 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
237 },
238 &quot;externalPriceUri&quot;: &quot;A String&quot;, # Link to external price list, such as link to Google Voice rate card.
239 },
240 },
241 ],
242 },
243 ],
244 &quot;resourceType&quot;: &quot;A String&quot;, # Resource Type. Example: SEAT
245 },
246 ],
247 &quot;sku&quot;: { # Represents a product&#x27;s purchasable Stock Keeping Unit (SKU). SKUs represent the different variations of the product. For example, Google Workspace Business Standard and Google Workspace Business Plus are Google Workspace product SKUs. # SKU the offer is associated with.
248 &quot;marketingInfo&quot;: { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the SKU.
249 &quot;defaultLogo&quot;: { # Represents media information. # Default logo.
250 &quot;content&quot;: &quot;A String&quot;, # URL of the media.
251 &quot;title&quot;: &quot;A String&quot;, # Title of the media.
252 &quot;type&quot;: &quot;A String&quot;, # Type of the media.
253 },
254 &quot;description&quot;: &quot;A String&quot;, # Human readable description. Description can contain HTML.
255 &quot;displayName&quot;: &quot;A String&quot;, # Human readable name.
256 },
257 &quot;name&quot;: &quot;A String&quot;, # Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id}
258 &quot;product&quot;: { # A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc. # Product the SKU is associated with.
259 &quot;marketingInfo&quot;: { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the product.
260 &quot;defaultLogo&quot;: { # Represents media information. # Default logo.
261 &quot;content&quot;: &quot;A String&quot;, # URL of the media.
262 &quot;title&quot;: &quot;A String&quot;, # Title of the media.
263 &quot;type&quot;: &quot;A String&quot;, # Type of the media.
264 },
265 &quot;description&quot;: &quot;A String&quot;, # Human readable description. Description can contain HTML.
266 &quot;displayName&quot;: &quot;A String&quot;, # Human readable name.
267 },
268 &quot;name&quot;: &quot;A String&quot;, # Resource Name of the Product. Format: products/{product_id}
269 },
270 },
271 &quot;startTime&quot;: &quot;A String&quot;, # Start of the Offer validity time.
272 },
273 ],
274}</pre>
275</div>
276
277<div class="method">
278 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
279 <pre>Retrieves the next page of results.
280
281Args:
282 previous_request: The request for the previous page. (required)
283 previous_response: The response from the request for the previous page. (required)
284
285Returns:
286 A request object that you can call &#x27;execute()&#x27; on to request the next
287 page. Returns None if there are no more items in the collection.
288 </pre>
289</div>
290
291</body></html>