Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / cloudbilling_v1.services.skus.html
blob: f82a183839b11b3f83ee800367f34d55dda7c237 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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="cloudbilling_v1.html">Cloud Billing API</a> . <a href="cloudbilling_v1.services.html">services</a> . <a href="cloudbilling_v1.services.skus.html">skus</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(parent, pageSize=None, currencyCode=None, startTime=None, pageToken=None, endTime=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Lists all publicly available SKUs for a given cloud service.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="list">list(parent, pageSize=None, currencyCode=None, startTime=None, pageToken=None, endTime=None, x__xgafv=None)</code>
86 <pre>Lists all publicly available SKUs for a given cloud service.
87
88Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]89 parent: string, Required. The name of the service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90Example: "services/DA34-426B-A397" (required)
91 pageSize: integer, Requested page size. Defaults to 5000.
92 currencyCode: string, The ISO 4217 currency code for the pricing info in the response proto.
93Will use the conversion rate as of start_time.
94Optional. If not specified USD will be used.
95 startTime: string, Optional inclusive start time of the time range for which the pricing
96versions will be returned. Timestamps in the future are not allowed.
97The time range has to be within a single calendar month in
98America/Los_Angeles timezone. Time range as a whole is optional. If not
99specified, the latest pricing will be returned (up to 12 hours old at
100most).
101 pageToken: string, A token identifying a page of results to return. This should be a
102`next_page_token` value returned from a previous `ListSkus`
103call. If unspecified, the first page of results is returned.
104 endTime: string, Optional exclusive end time of the time range for which the pricing
105versions will be returned. Timestamps in the future are not allowed.
106The time range has to be within a single calendar month in
107America/Los_Angeles timezone. Time range as a whole is optional. If not
108specified, the latest pricing will be returned (up to 12 hours old at
109most).
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
118 { # Response message for `ListSkus`.
119 "nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page,
120 # call `ListSkus` again with the `page_token` field set to this
121 # value. This field is empty if there are no more results to retrieve.
122 "skus": [ # The list of public SKUs of the given service.
123 { # Encapsulates a single SKU in Google Cloud Platform
124 "category": { # Represents the category hierarchy of a SKU. # The category hierarchy of this SKU, purely for organizational purpose.
125 "resourceGroup": "A String", # A group classification for related SKUs.
126 # Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc.
127 "resourceFamily": "A String", # The type of product the SKU refers to.
128 # Example: "Compute", "Storage", "Network", "ApplicationServices" etc.
129 "usageType": "A String", # Represents how the SKU is consumed.
130 # Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc.
131 "serviceDisplayName": "A String", # The display name of the service this SKU belongs to.
132 },
133 "serviceProviderName": "A String", # Identifies the service provider.
134 # This is 'Google' for first party services in Google Cloud Platform.
135 "description": "A String", # A human readable description of the SKU, has a maximum length of 256
136 # characters.
137 "skuId": "A String", # The identifier for the SKU.
138 # Example: "AA95-CD31-42FE"
139 "serviceRegions": [ # List of service regions this SKU is offered at.
140 # Example: "asia-east1"
141 # Service regions can be found at https://cloud.google.com/about/locations/
142 "A String",
143 ],
144 "pricingInfo": [ # A timeline of pricing info for this SKU in chronological order.
145 { # Represents the pricing information for a SKU at a single point of time.
146 "effectiveTime": "A String", # The timestamp from which this pricing was effective within the requested
147 # time range. This is guaranteed to be greater than or equal to the
148 # start_time field in the request and less than the end_time field in the
149 # request. If a time range was not specified in the request this field will
150 # be equivalent to a time within the last 12 hours, indicating the latest
151 # pricing info.
152 "aggregationInfo": { # Represents the aggregation level and interval for pricing of a single SKU. # Aggregation Info. This can be left unspecified if the pricing expression
153 # doesn't require aggregation.
154 "aggregationLevel": "A String",
155 "aggregationCount": 42, # The number of intervals to aggregate over.
156 # Example: If aggregation_level is "DAILY" and aggregation_count is 14,
157 # aggregation will be over 14 days.
158 "aggregationInterval": "A String",
159 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 "summary": "A String", # An optional human readable summary of the pricing information, has a
161 # maximum length of 256 characters.
162 "currencyConversionRate": 3.14, # Conversion rate used for currency conversion, from USD to the currency
163 # specified in the request. This includes any surcharge collected for billing
164 # in non USD currency. If a currency is not specified in the request this
165 # defaults to 1.0.
166 # Example: USD * currency_conversion_rate = JPY
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 "pricingExpression": { # Expresses a mathematical pricing formula. For Example:- # Expresses the pricing formula. See `PricingExpression` for an example.
168 #
169 # `usage_unit: GBy`
170 # `tiered_rates:`
171 # `[start_usage_amount: 20, unit_price: $10]`
172 # `[start_usage_amount: 100, unit_price: $5]`
173 #
174 # The above expresses a pricing formula where the first 20GB is free, the
175 # next 80GB is priced at $10 per GB followed by $5 per GB for additional
176 # usage.
177 "displayQuantity": 3.14, # The recommended quantity of units for displaying pricing info. When
178 # displaying pricing info it is recommended to display:
179 # (unit_price * display_quantity) per display_quantity usage_unit.
180 # This field does not affect the pricing formula and is for display purposes
181 # only.
182 # Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and
183 # the display_quantity is "1000" then the recommended way of displaying the
184 # pricing info is "0.10 USD per 1000 GB"
185 "baseUnit": "A String", # The base unit for the SKU which is the unit used in usage exports.
186 # Example: "By"
187 "usageUnit": "A String", # The short hand for unit of usage this pricing is specified in.
188 # Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".
189 "baseUnitConversionFactor": 3.14, # Conversion factor for converting from price per usage_unit to price per
190 # base_unit, and start_usage_amount to start_usage_amount in base_unit.
191 # unit_price / base_unit_conversion_factor = price per base_unit.
192 # start_usage_amount * base_unit_conversion_factor = start_usage_amount in
193 # base_unit.
194 "usageUnitDescription": "A String", # The unit of usage in human readable form.
195 # Example: "gibi byte".
196 "baseUnitDescription": "A String", # The base unit in human readable form.
197 # Example: "byte".
198 "tieredRates": [ # The list of tiered rates for this pricing. The total cost is computed by
199 # applying each of the tiered rates on usage. This repeated list is sorted
200 # by ascending order of start_usage_amount.
201 { # The price rate indicating starting usage and its corresponding price.
202 "unitPrice": { # Represents an amount of money with its currency type. # The price per unit of usage.
203 # Example: unit_price of amount $10 indicates that each unit will cost $10.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]204 "units": "A String", # The whole units of the amount.
205 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 "nanos": 42, # Number of nano (10^-9) units of the amount.
207 # The value must be between -999,999,999 and +999,999,999 inclusive.
208 # If `units` is positive, `nanos` must be positive or zero.
209 # If `units` is zero, `nanos` can be positive, zero, or negative.
210 # If `units` is negative, `nanos` must be negative or zero.
211 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
213 },
214 "startUsageAmount": 3.14, # Usage is priced at this rate only after this amount.
215 # Example: start_usage_amount of 10 indicates that the usage will be priced
216 # at the unit_price after the first 10 usage_units.
217 },
218 ],
219 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 },
221 ],
222 "name": "A String", # The resource name for the SKU.
223 # Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"
224 },
225 ],
226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
231 <pre>Retrieves the next page of results.
232
233Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237Returns:
238 A request object that you can call 'execute()' on to request the next
239 page. Returns None if there are no more items in the collection.
240 </pre>
241</div>
242
243</body></html>