blob: 936c00051ddb7e9a27d8c8a22f5c7536c3913aa8 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070078 <code><a href="#list">list(parent, endTime=None, startTime=None, pageToken=None, pageSize=None, currencyCode=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070085 <code class="details" id="list">list(parent, endTime=None, startTime=None, pageToken=None, pageSize=None, currencyCode=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086 <pre>Lists all publicly available SKUs for a given cloud service.
87
88Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070089 parent: string, Required. The name of the service.
Bu Sun Kim65020912020-05-20 12:08:20 -070090Example: &quot;services/DA34-426B-A397&quot; (required)
91 endTime: string, Optional exclusive end time of the time range for which the pricing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092versions will be returned. Timestamps in the future are not allowed.
93The time range has to be within a single calendar month in
94America/Los_Angeles timezone. Time range as a whole is optional. If not
95specified, the latest pricing will be returned (up to 12 hours old at
96most).
Bu Sun Kim65020912020-05-20 12:08:20 -070097 startTime: string, Optional inclusive start time of the time range for which the pricing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098versions will be returned. Timestamps in the future are not allowed.
99The time range has to be within a single calendar month in
100America/Los_Angeles timezone. Time range as a whole is optional. If not
101specified, the latest pricing will be returned (up to 12 hours old at
102most).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700103 pageToken: string, A token identifying a page of results to return. This should be a
104`next_page_token` value returned from a previous `ListSkus`
105call. If unspecified, the first page of results is returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 pageSize: integer, Requested page size. Defaults to 5000.
107 currencyCode: string, The ISO 4217 currency code for the pricing info in the response proto.
108Will use the conversion rate as of start_time.
109Optional. If not specified USD will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700110 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. To retrieve the next page,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700122 &quot;skus&quot;: [ # The list of public SKUs of the given service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700123 { # Encapsulates a single SKU in Google Cloud Platform
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 &quot;pricingInfo&quot;: [ # A timeline of pricing info for this SKU in chronological order.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700125 { # Represents the pricing information for a SKU at a single point of time.
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 &quot;effectiveTime&quot;: &quot;A String&quot;, # The timestamp from which this pricing was effective within the requested
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127 # time range. This is guaranteed to be greater than or equal to the
128 # start_time field in the request and less than the end_time field in the
129 # request. If a time range was not specified in the request this field will
130 # be equivalent to a time within the last 12 hours, indicating the latest
131 # pricing info.
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 &quot;pricingExpression&quot;: { # Expresses a mathematical pricing formula. For Example:- # Expresses the pricing formula. See `PricingExpression` for an example.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 #
134 # `usage_unit: GBy`
135 # `tiered_rates:`
136 # `[start_usage_amount: 20, unit_price: $10]`
137 # `[start_usage_amount: 100, unit_price: $5]`
138 #
139 # The above expresses a pricing formula where the first 20GB is free, the
140 # next 80GB is priced at $10 per GB followed by $5 per GB for additional
141 # usage.
Bu Sun Kim65020912020-05-20 12:08:20 -0700142 &quot;displayQuantity&quot;: 3.14, # The recommended quantity of units for displaying pricing info. When
143 # displaying pricing info it is recommended to display:
144 # (unit_price * display_quantity) per display_quantity usage_unit.
145 # This field does not affect the pricing formula and is for display purposes
146 # only.
147 # Example: If the unit_price is &quot;0.0001 USD&quot;, the usage_unit is &quot;GB&quot; and
148 # the display_quantity is &quot;1000&quot; then the recommended way of displaying the
149 # pricing info is &quot;0.10 USD per 1000 GB&quot;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700150 &quot;usageUnitDescription&quot;: &quot;A String&quot;, # The unit of usage in human readable form.
151 # Example: &quot;gibi byte&quot;.
152 &quot;usageUnit&quot;: &quot;A String&quot;, # The short hand for unit of usage this pricing is specified in.
153 # Example: usage_unit of &quot;GiBy&quot; means that usage is specified in &quot;Gibi Byte&quot;.
154 &quot;tieredRates&quot;: [ # The list of tiered rates for this pricing. The total cost is computed by
155 # applying each of the tiered rates on usage. This repeated list is sorted
156 # by ascending order of start_usage_amount.
157 { # The price rate indicating starting usage and its corresponding price.
158 &quot;unitPrice&quot;: { # Represents an amount of money with its currency type. # The price per unit of usage.
159 # Example: unit_price of amount $10 indicates that each unit will cost $10.
160 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount.
161 # The value must be between -999,999,999 and +999,999,999 inclusive.
162 # If `units` is positive, `nanos` must be positive or zero.
163 # If `units` is zero, `nanos` can be positive, zero, or negative.
164 # If `units` is negative, `nanos` must be negative or zero.
165 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
166 &quot;currencyCode&quot;: &quot;A String&quot;, # The 3-letter currency code defined in ISO 4217.
167 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount.
168 # For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
169 },
170 &quot;startUsageAmount&quot;: 3.14, # Usage is priced at this rate only after this amount.
171 # Example: start_usage_amount of 10 indicates that the usage will be priced
172 # at the unit_price after the first 10 usage_units.
173 },
174 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700175 &quot;baseUnitDescription&quot;: &quot;A String&quot;, # The base unit in human readable form.
176 # Example: &quot;byte&quot;.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700177 &quot;baseUnit&quot;: &quot;A String&quot;, # The base unit for the SKU which is the unit used in usage exports.
178 # Example: &quot;By&quot;
179 &quot;baseUnitConversionFactor&quot;: 3.14, # Conversion factor for converting from price per usage_unit to price per
180 # base_unit, and start_usage_amount to start_usage_amount in base_unit.
181 # unit_price / base_unit_conversion_factor = price per base_unit.
182 # start_usage_amount * base_unit_conversion_factor = start_usage_amount in
183 # base_unit.
184 },
185 &quot;currencyConversionRate&quot;: 3.14, # Conversion rate used for currency conversion, from USD to the currency
186 # specified in the request. This includes any surcharge collected for billing
187 # in non USD currency. If a currency is not specified in the request this
188 # defaults to 1.0.
189 # Example: USD * currency_conversion_rate = JPY
190 &quot;summary&quot;: &quot;A String&quot;, # An optional human readable summary of the pricing information, has a
191 # maximum length of 256 characters.
192 &quot;aggregationInfo&quot;: { # Represents the aggregation level and interval for pricing of a single SKU. # Aggregation Info. This can be left unspecified if the pricing expression
193 # doesn&#x27;t require aggregation.
194 &quot;aggregationInterval&quot;: &quot;A String&quot;,
195 &quot;aggregationCount&quot;: 42, # The number of intervals to aggregate over.
196 # Example: If aggregation_level is &quot;DAILY&quot; and aggregation_count is 14,
197 # aggregation will be over 14 days.
198 &quot;aggregationLevel&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700199 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700200 },
201 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700202 &quot;serviceProviderName&quot;: &quot;A String&quot;, # Identifies the service provider.
203 # This is &#x27;Google&#x27; for first party services in Google Cloud Platform.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700204 &quot;skuId&quot;: &quot;A String&quot;, # The identifier for the SKU.
205 # Example: &quot;AA95-CD31-42FE&quot;
206 &quot;category&quot;: { # Represents the category hierarchy of a SKU. # The category hierarchy of this SKU, purely for organizational purpose.
207 &quot;resourceGroup&quot;: &quot;A String&quot;, # A group classification for related SKUs.
208 # Example: &quot;RAM&quot;, &quot;GPU&quot;, &quot;Prediction&quot;, &quot;Ops&quot;, &quot;GoogleEgress&quot; etc.
209 &quot;serviceDisplayName&quot;: &quot;A String&quot;, # The display name of the service this SKU belongs to.
210 &quot;usageType&quot;: &quot;A String&quot;, # Represents how the SKU is consumed.
211 # Example: &quot;OnDemand&quot;, &quot;Preemptible&quot;, &quot;Commit1Mo&quot;, &quot;Commit1Yr&quot; etc.
212 &quot;resourceFamily&quot;: &quot;A String&quot;, # The type of product the SKU refers to.
213 # Example: &quot;Compute&quot;, &quot;Storage&quot;, &quot;Network&quot;, &quot;ApplicationServices&quot; etc.
214 },
215 &quot;name&quot;: &quot;A String&quot;, # The resource name for the SKU.
216 # Example: &quot;services/DA34-426B-A397/skus/AA95-CD31-42FE&quot;
217 &quot;description&quot;: &quot;A String&quot;, # A human readable description of the SKU, has a maximum length of 256
218 # characters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700219 &quot;serviceRegions&quot;: [ # List of service regions this SKU is offered at.
220 # Example: &quot;asia-east1&quot;
221 # Service regions can be found at https://cloud.google.com/about/locations/
222 &quot;A String&quot;,
223 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700224 },
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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700238 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700239 page. Returns None if there are no more items in the collection.
240 </pre>
241</div>
242
243</body></html>