googleapis
Version:
Google APIs Client Library for Node.js
1,188 lines (1,187 loc) • 128 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace cloudbilling_v1beta {
export interface Options extends GlobalOptions {
version: 'v1beta';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Billing API
*
* Allows developers to manage billing for their Google Cloud Platform projects programmatically.
*
* @example
* ```js
* const {google} = require('googleapis');
* const cloudbilling = google.cloudbilling('v1beta');
* ```
*/
export class Cloudbilling {
context: APIRequestContext;
billingAccounts: Resource$Billingaccounts;
skuGroups: Resource$Skugroups;
skus: Resource$Skus;
v1beta: Resource$V1beta;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A local representation of the query used to fetch the data. This is used instead of the raw QueryBillingDataRequest to avoid pulling in Cloud Policy Enforcement (CPE) resource_type annotations into the response payload, which causes ESF validation failures.
*/
export interface Schema$AgenticQueryInfo {
/**
* The columns queried.
*/
columns?: string | null;
/**
* The filter applied to the query.
*/
filter?: string | null;
/**
* The group-by clause applied to the query.
*/
groupBy?: string | null;
/**
* The row limit applied to the query.
*/
limit?: number | null;
/**
* The order-by clause applied to the query.
*/
orderBy?: string | null;
/**
* The parents (e.g. projects, billing accounts) queried.
*/
parents?: string[] | null;
/**
* The view queried.
*/
view?: string | null;
}
/**
* An ordered collection of elements of arbitrary count.
*/
export interface Schema$Array {
/**
* The elements of the array.
*/
element?: Schema$ValueProto[];
}
/**
* Encapsulates billing data.
*/
export interface Schema$BillingData {
/**
* Information about columns.
*/
columnInfo?: Schema$ColumnInfo[];
/**
* Rows.
*/
rows?: Schema$Row[];
}
/**
* Specifies a Billing data resource that can be used for authorization to access billing data.
*/
export interface Schema$BillingDataResource {
/**
* Optional. If not provided the billing account currently associated with the resource will be used.
*/
billingAccount?: string | null;
/**
* Required. Resource name for an entitity that can be used for authorization to access billing data such as `projects/{project\}` or `billingAccounts/{billing_account\}`
*/
resource?: string | null;
}
/**
* Represents a column header.
*/
export interface Schema$ColumnInfo {
/**
* Name of the column.
*/
column?: string | null;
}
/**
* A dataset used to support an insight, suitable for UI rendering (tables/charts).
*/
export interface Schema$DataSet {
/**
* Output only. Actual billing data returned from the Data Mart. Uses the formal message from the Billing Data Service.
*/
billingData?: Schema$BillingData;
/**
* Output only. The query used to fetch this data.
*/
queryInfo?: Schema$AgenticQueryInfo;
/**
* Output only. A suggested chart for the data set, used for UI rendering.
*/
suggestedChart?: Schema$SuggestedChart;
}
/**
* A datetime value.
*/
export interface Schema$Datetime {
/**
* Represents bit field encoding of year/month/day/hour/minute/second. See class DatetimeValue in civil_time.h for details of encoding.
*/
bitFieldDatetimeSeconds?: string | null;
/**
* Non-negative fractions of a second at nanosecond resolution.
*/
nanos?: number | null;
}
/**
* A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html).
*/
export interface Schema$Decimal {
/**
* The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -\> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -\> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -\> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -\> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-\> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' \}; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
*/
value?: string | null;
}
/**
* Encapsulates all structured data and the completed summary.
*/
export interface Schema$FinalResult {
/**
* Output only. Data sets used to support the insights, suitable for UI rendering (tables/charts).
*/
dataSets?: Schema$DataSet[];
/**
* Output only. Contains the full natural language analysis, including thoughts, reasoning, and references.
*/
fullAnalysis?: string | null;
/**
* Output only. A list of discrete insights gleaned from the data.
*/
insights?: Schema$Insight[];
/**
* Output only. Links to interoperable tools (e.g., pre-filtered Cost Reports or BQE queries).
*/
interopLinks?: Schema$InteropLink[];
/**
* Output only. A list of suggested follow-up queries for the user.
*/
suggestedQueries?: Schema$SuggestedQuery[];
/**
* Output only. The full natural language summary (re-sent for consistency).
*/
summary?: string | null;
}
/**
* Request for GenerateInsights.
*/
export interface Schema$GenerateInsightsRequest {
/**
* Optional. Filters cost data by service id. Follows https://google.aip.dev/160 for the filter syntax. eg. filter: "service = 'C7E2-9256-1C43'"
*/
filter?: string | null;
/**
* Optional. Overrides the maximum iterations for any selected strategy.
*/
overriddenMaxIterationCounts?: number | null;
/**
* Optional. The billing account or projects to analyze.
*/
parents?: Schema$BillingDataResource[];
/**
* Required. The natural language prompt from the user.
*/
prompt?: string | null;
/**
* Optional. Additional context for personalization (e.g., user persona, role).
*/
userContext?: Schema$UserContext;
}
/**
* Response for GenerateInsights.
*/
export interface Schema$GenerateInsightsResponse {
/**
* Output only. The final structured results and metadata. Usually sent as the final message in the stream.
*/
finalResult?: Schema$FinalResult;
/**
* Output only. The request was rejected (e.g. out of scope).
*/
rejection?: Schema$Rejection;
/**
* Output only. A chunk of the natural language summary (customer-facing). The UI can append these chunks to provide a real-time "typing" effect.
*/
summaryChunk?: string | null;
/**
* Output only. A chunk of the agent's internal reasoning process. The UI can use this to render a "Thinking..." log or status.
*/
thoughtChunk?: string | null;
}
/**
* Encapsulates the aggregation information such as aggregation level and interval for a billing account price.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo {
/**
* Interval at which usage is aggregated to compute cost. Example: "MONTHLY" interval indicates that usage is aggregated every month.
*/
interval?: string | null;
/**
* Level at which usage is aggregated to compute cost. Example: "ACCOUNT" level indicates that usage is aggregated across all projects in a single account.
*/
level?: string | null;
}
/**
* Encapsulates the latest price for a billing account SKU.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaBillingAccountPrice {
/**
* ISO-4217 currency code for the price.
*/
currencyCode?: string | null;
/**
* Resource name for the latest billing account price.
*/
name?: string | null;
/**
* Background information on the origin of the price.
*/
priceReason?: Schema$GoogleCloudBillingBillingaccountpricesV1betaPriceReason;
/**
* Rate price metadata. Billing account SKUs with `Rate` price are offered by pricing tiers. The price can have 1 or more rate pricing tiers.
*/
rate?: Schema$GoogleCloudBillingBillingaccountpricesV1betaRate;
/**
* Type of the price. The possible values are: ["unspecified", "rate"].
*/
valueType?: string | null;
}
/**
* Encapsulates a default price which is the current list price.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaDefaultPrice {
}
/**
* Encapsulates a discount off the list price, anchored to the list price as of a fixed time.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaFixedDiscount {
/**
* Percentage of the fixed discount.
*/
discountPercent?: Schema$Decimal;
/**
* Type of the fixed discount scope which indicates the source of the discount. It can have values such as 'unspecified' and 'sku-group'.
*/
discountScopeType?: string | null;
/**
* Time that the fixed discount is anchored to.
*/
fixTime?: string | null;
/**
* SKU group where the fixed discount comes from.
*/
skuGroup?: string | null;
}
/**
* Encapsulates a set fixed price applicable during the terms of a contract agreement.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaFixedPrice {
}
/**
* Encapsulates a discount off the current list price, not anchored to any list price as of a fixed time.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaFloatingDiscount {
/**
* Percentage of the floating discount.
*/
discountPercent?: Schema$Decimal;
/**
* Type of the floating discount scope which indicates the source of the discount. It can have values such as 'unspecified' and 'sku-group'.
*/
discountScopeType?: string | null;
/**
* SKU group where the floating discount comes from.
*/
skuGroup?: string | null;
}
/**
* Response message for ListBillingAccountPrices.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaListBillingAccountPricesResponse {
/**
* The returned billing account prices.
*/
billingAccountPrices?: Schema$GoogleCloudBillingBillingaccountpricesV1betaBillingAccountPrice[];
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Encapsulates a contract feature that the list price (DefaultPrice) will be used for the price if the current list price drops lower than the custom fixed price. Available to new contracts after March 21, 2022. Applies to all fixed price SKUs in the contract, including FixedPrice, FixedDiscount, MigratedPrice, and MergedPrice.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaListPriceAsCeiling {
}
/**
* Encapsulates a price after merging from multiple sources. With merged tiers, each individual tier can be from a different source with different discount types.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaMergedPrice {
}
/**
* Encapsulates a price migrated from other SKUs.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaMigratedPrice {
/**
* Source SKU where the discount is migrated from. Format: billingAccounts/{billing_account\}/skus/{sku\}
*/
sourceSku?: string | null;
}
/**
* Encapsulates a price reason which contains background information about the origin of the price.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaPriceReason {
/**
* Default price which is the current list price.
*/
defaultPrice?: Schema$GoogleCloudBillingBillingaccountpricesV1betaDefaultPrice;
/**
* Discount off the list price, anchored to the list price as of a fixed time.
*/
fixedDiscount?: Schema$GoogleCloudBillingBillingaccountpricesV1betaFixedDiscount;
/**
* Fixed price applicable during the terms of a contract agreement.
*/
fixedPrice?: Schema$GoogleCloudBillingBillingaccountpricesV1betaFixedPrice;
/**
* Discount off the current list price, not anchored to any list price as of a fixed time.
*/
floatingDiscount?: Schema$GoogleCloudBillingBillingaccountpricesV1betaFloatingDiscount;
/**
* Contract feature that the list price (DefaultPrice) will be used for the price if the current list price drops lower than the custom fixed price. Available to new contracts after March 21, 2022. Applies to all fixed price SKUs in the contract, including FixedPrice, FixedDiscount, MigratedPrice, and MergedPrice.
*/
listPriceAsCeiling?: Schema$GoogleCloudBillingBillingaccountpricesV1betaListPriceAsCeiling;
/**
* Price after merging from multiple sources.
*/
mergedPrice?: Schema$GoogleCloudBillingBillingaccountpricesV1betaMergedPrice;
/**
* Price migrated from other SKUs.
*/
migratedPrice?: Schema$GoogleCloudBillingBillingaccountpricesV1betaMigratedPrice;
/**
* Type of the price reason. It can have values such as 'unspecified', 'default-price', 'fixed-price', 'fixed-discount', 'floating-discount', 'migrated-price', 'merged-price', 'list-price-as-ceiling'.
*/
type?: string | null;
}
/**
* Encapsulates a `Rate` price. Billing account SKUs with `Rate` price are offered by pricing tiers. The price have 1 or more rate pricing tiers.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaRate {
/**
* Aggregation info for tiers such as aggregation level and interval.
*/
aggregationInfo?: Schema$GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo;
/**
* All tiers associated with the `Rate` price.
*/
tiers?: Schema$GoogleCloudBillingBillingaccountpricesV1betaRateTier[];
/**
* Unit info such as name and quantity.
*/
unitInfo?: Schema$GoogleCloudBillingBillingaccountpricesV1betaUnitInfo;
}
/**
* Encapsulates a rate price tier.
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaRateTier {
/**
* Negotiated contract price specific for a billing account.
*/
contractPrice?: Schema$Money;
/**
* Percentage of effective discount calculated using the current list price per pricing tier. Formula used: effective_discount_percent = (list_price - contract_price) / list_price × 100 If list_price and contract_price are zero, this field is the same as `discount_percent` of FixedDiscount and FloatingDiscount. If your contract does NOT have the feature LIST_PRICE_AS_CEILING enabled, the effective_discount_percent can be negative if the SKU has a FixedDiscount and the current list price is lower than the list price on the date of the contract agreement. See the `FixedDiscount.fix_time` on when the discount was set. If you have questions regarding pricing per SKU, contact your Account team for more details.
*/
effectiveDiscountPercent?: Schema$Decimal;
/**
* List price of one tier.
*/
listPrice?: Schema$Money;
/**
* Lower bound amount for a tier. Tiers 0-100, 100-200 will be represented with two tiers with `start_amount` 0 and 100.
*/
startAmount?: Schema$Decimal;
}
/**
* Encapsulates the unit information for a Rate
*/
export interface Schema$GoogleCloudBillingBillingaccountpricesV1betaUnitInfo {
/**
* Shorthand for the unit. Example: GiBy.mo.
*/
unit?: string | null;
/**
* Human-readable description of the unit. Example: gibibyte month.
*/
unitDescription?: string | null;
/**
* Unit quantity for the tier. Example: if the RateTier price is $1 per 1000000 Bytes, then `unit_quantity` is set to 1000000.
*/
unitQuantity?: Schema$Decimal;
}
/**
* Encapsulates a Google Cloud service visible to a billing account.
*/
export interface Schema$GoogleCloudBillingBillingaccountservicesV1betaBillingAccountService {
/**
* Description of the BillingAccountService. Example: "BigQuery", "Compute Engine".
*/
displayName?: string | null;
/**
* Resource name for the BillingAccountService. Example: "billingAccounts/012345-567890-ABCDEF/services/DA34-426B-A397".
*/
name?: string | null;
/**
* Identifier for the service. It is the string after the collection identifier "services/". Example: "DA34-426B-A397".
*/
serviceId?: string | null;
}
/**
* Response message for ListBillingAccountServices.
*/
export interface Schema$GoogleCloudBillingBillingaccountservicesV1betaListBillingAccountServicesResponse {
/**
* The returned billing account services.
*/
billingAccountServices?: Schema$GoogleCloudBillingBillingaccountservicesV1betaBillingAccountService[];
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Encapsulates a SKU that is part of a billing account SKU group.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaBillingAccountSkuGroupSku {
/**
* BillingAccountService that the BillingAccountSkuGroupSku belongs to.
*/
billingAccountService?: string | null;
/**
* Description of the BillingAccountSkuGroupSku. Example: "A2 Instance Core running in Hong Kong".
*/
displayName?: string | null;
/**
* Geographic metadata that applies to the BillingAccountSkuGroupSku.
*/
geoTaxonomy?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomy;
/**
* Resource name for the BillingAccountSkuGroupSku. Example: "billingAccounts/012345-567890-ABCDEF/skuGroups/0e6403d1-4694-44d2-a696-7a78b1a69301/skus/AA95-CD31-42FE".
*/
name?: string | null;
/**
* List of product categories that apply to the BillingAccountSkuGroupSku.
*/
productTaxonomy?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaProductTaxonomy;
/**
* Unique identifier for the SKU. It is the string after the collection identifier "skus/" Example: "AA95-CD31-42FE".
*/
skuId?: string | null;
}
/**
* Encapsulates geographic metadata, such as regions and multi-regions like `us-east4` or `European Union`.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomy {
/**
* Global geographic metadata with no regions.
*/
globalMetadata?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyGlobal;
/**
* Multi-regional geographic metadata with 2 or more regions.
*/
multiRegionalMetadata?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyMultiRegional;
/**
* Regional geographic metadata with 1 region.
*/
regionalMetadata?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyRegional;
/**
* Type of geographic taxonomy associated with the billing account SKU group SKU.
*/
type?: string | null;
}
/**
* Encapsulates a global geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyGlobal {
}
/**
* Encapsulates a multi-regional geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyMultiRegional {
/**
* Google Cloud regions associated with the multi-regional geographic taxonomy.
*/
regions?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyRegion[];
}
/**
* Encapsulates a Google Cloud region.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyRegion {
/**
* Description of a Google Cloud region. Example: "us-west2".
*/
region?: string | null;
}
/**
* Encapsulates a regional geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyRegional {
/**
* Google Cloud region associated with the regional geographic taxonomy.
*/
region?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaGeoTaxonomyRegion;
}
/**
* Response message for ListBillingAccountSkuGroupSkus.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaListBillingAccountSkuGroupSkusResponse {
/**
* The returned billing account SKU group SKUs.
*/
billingAccountSkuGroupSkus?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaBillingAccountSkuGroupSku[];
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Encapsulates product categories, such as `Serverless`, `Cloud Run`, `TaskQueue`, and others.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaProductTaxonomy {
/**
* All product categories that the billing account SKU group SKU belong to.
*/
taxonomyCategories?: Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaTaxonomyCategory[];
}
/**
* Encapsulates a product category.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupskusV1betaTaxonomyCategory {
/**
* Name of the product category.
*/
category?: string | null;
}
/**
* Encapsulates a stock keeping (SKU) group visible to a billing account. A SKU group represents a collection of SKUs that are related to each other. For example, the `AI Platform APIs` SKU group includes SKUs from the Cloud Dialogflow API, the Cloud Text-to-Speech API, and additional related APIs.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupsV1betaBillingAccountSkuGroup {
/**
* Description of the BillingAccountSkuGroup. Example: "A2 VMs (1 Year CUD)".
*/
displayName?: string | null;
/**
* Resource name for the BillingAccountSkuGroup. Example: "billingAccounts/012345-567890-ABCDEF/skuGroups/0e6403d1-4694-44d2-a696-7a78b1a69301".
*/
name?: string | null;
}
/**
* Response message for ListBillingAccountSkuGroups.
*/
export interface Schema$GoogleCloudBillingBillingaccountskugroupsV1betaListBillingAccountSkuGroupsResponse {
/**
* The returned publicly listed billing account SKU groups.
*/
billingAccountSkuGroups?: Schema$GoogleCloudBillingBillingaccountskugroupsV1betaBillingAccountSkuGroup[];
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Encapsulates a stock keeping unit (SKU) visible to a billing account. A SKU distinctly identifies a resource that you can purchase. For a list of available SKUs, see [SKUs](https://cloud.google.com/skus).
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaBillingAccountSku {
/**
* BillingAccountService that the BillingAccountSku belongs to.
*/
billingAccountService?: string | null;
/**
* Description of the BillingAccountSku. Example: "A2 Instance Core running in Hong Kong".
*/
displayName?: string | null;
/**
* Geographic metadata that applies to the BillingAccountSku.
*/
geoTaxonomy?: Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomy;
/**
* Resource name for the BillingAccountSku. Example: "billingAccounts/012345-567890-ABCDEF/skus/AA95-CD31-42FE".
*/
name?: string | null;
/**
* List of product categories that apply to the BillingAccountSku.
*/
productTaxonomy?: Schema$GoogleCloudBillingBillingaccountskusV1betaProductTaxonomy;
/**
* Unique identifier for the SKU. It is the string after the collection identifier "skus/" Example: "AA95-CD31-42FE".
*/
skuId?: string | null;
}
/**
* Encapsulates geographic metadata, such as regions and multi-regions like `us-east4` or `European Union`.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomy {
/**
* Global geographic metadata with no regions.
*/
globalMetadata?: Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyGlobal;
/**
* Multi-regional geographic metadata with 2 or more regions.
*/
multiRegionalMetadata?: Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyMultiRegional;
/**
* Regional geographic metadata with 1 region.
*/
regionalMetadata?: Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyRegional;
/**
* Type of geographic taxonomy associated with the billing account SKU.
*/
type?: string | null;
}
/**
* Encapsulates a global geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyGlobal {
}
/**
* Encapsulates a multi-regional geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyMultiRegional {
/**
* Google Cloud regions associated with the multi-regional geographic taxonomy.
*/
regions?: Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyRegion[];
}
/**
* Encapsulates a Google Cloud region.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyRegion {
/**
* Description of a Google Cloud region. Example: "us-west2".
*/
region?: string | null;
}
/**
* Encapsulates a regional geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyRegional {
/**
* Google Cloud region associated with the regional geographic taxonomy.
*/
region?: Schema$GoogleCloudBillingBillingaccountskusV1betaGeoTaxonomyRegion;
}
/**
* Response message for ListBillingAccountSkus.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaListBillingAccountSkusResponse {
/**
* The returned billing account SKUs.
*/
billingAccountSkus?: Schema$GoogleCloudBillingBillingaccountskusV1betaBillingAccountSku[];
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Encapsulates product categories, such as `Serverless`, `Cloud Run`, `TaskQueue`, and others.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaProductTaxonomy {
/**
* All product categories that the billing account SKU belong to.
*/
taxonomyCategories?: Schema$GoogleCloudBillingBillingaccountskusV1betaTaxonomyCategory[];
}
/**
* Encapsulates a product category.
*/
export interface Schema$GoogleCloudBillingBillingaccountskusV1betaTaxonomyCategory {
/**
* Name of the product category.
*/
category?: string | null;
}
/**
* Encapsulates the aggregation information such as aggregation level and interval for a price.
*/
export interface Schema$GoogleCloudBillingPricesV1betaAggregationInfo {
/**
* Interval at which usage is aggregated to compute cost. Example: "MONTHLY" interval indicates that usage is aggregated every month.
*/
interval?: string | null;
/**
* Level at which usage is aggregated to compute cost. Example: "ACCOUNT" level indicates that usage is aggregated across all projects in a single account.
*/
level?: string | null;
}
/**
* Response message for ListPrices.
*/
export interface Schema$GoogleCloudBillingPricesV1betaListPricesResponse {
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The returned publicly listed prices.
*/
prices?: Schema$GoogleCloudBillingPricesV1betaPrice[];
}
/**
* Encapsulates the latest price for a SKU.
*/
export interface Schema$GoogleCloudBillingPricesV1betaPrice {
/**
* ISO-4217 currency code for the price.
*/
currencyCode?: string | null;
/**
* Resource name for the latest price.
*/
name?: string | null;
/**
* Rate price metadata. SKUs with `Rate` price are offered by pricing tiers. The price can have 1 or more rate pricing tiers.
*/
rate?: Schema$GoogleCloudBillingPricesV1betaRate;
/**
* Type of the price. It can have values: ["unspecified", "rate"].
*/
valueType?: string | null;
}
/**
* Encapsulates a `Rate` price. SKUs with `Rate` price are offered by pricing tiers. The price have 1 or more rate pricing tiers.
*/
export interface Schema$GoogleCloudBillingPricesV1betaRate {
/**
* Aggregation info for tiers such as aggregation level and interval.
*/
aggregationInfo?: Schema$GoogleCloudBillingPricesV1betaAggregationInfo;
/**
* All tiers associated with the `Rate` price.
*/
tiers?: Schema$GoogleCloudBillingPricesV1betaRateTier[];
/**
* Unit info such as name and quantity.
*/
unitInfo?: Schema$GoogleCloudBillingPricesV1betaUnitInfo;
}
/**
* Encapsulates a rate price tier.
*/
export interface Schema$GoogleCloudBillingPricesV1betaRateTier {
/**
* List price of one tier.
*/
listPrice?: Schema$Money;
/**
* Lower bound amount for a tier. Tiers 0-100, 100-200 will be represented with two tiers with `start_amount` 0 and 100.
*/
startAmount?: Schema$Decimal;
}
/**
* Encapsulates the unit information for a Rate
*/
export interface Schema$GoogleCloudBillingPricesV1betaUnitInfo {
/**
* Shorthand for the unit. Example: GiBy.mo.
*/
unit?: string | null;
/**
* Human-readable description of the unit. Example: gibibyte month.
*/
unitDescription?: string | null;
/**
* Unit quantity for the tier. Example: if the RateTier price is $1 per 1000000 Bytes, then `unit_quantity` is set to 1000000.
*/
unitQuantity?: Schema$Decimal;
}
/**
* Encapsulates geographic metadata, such as regions and multi-regions like `us-east4` or `European Union`.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomy {
/**
* Global geographic metadata with no regions.
*/
globalMetadata?: Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyGlobal;
/**
* Multi-regional geographic metadata with 2 or more regions.
*/
multiRegionalMetadata?: Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyMultiRegional;
/**
* Regional geographic metadata with 1 region.
*/
regionalMetadata?: Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyRegional;
/**
* Type of geographic taxonomy associated with the SKU group SKU.
*/
type?: string | null;
}
/**
* Encapsulates a global geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyGlobal {
}
/**
* Encapsulates a multi-regional geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyMultiRegional {
/**
* Google Cloud regions associated with the multi-regional geographic taxonomy.
*/
regions?: Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyRegion[];
}
/**
* Encapsulates a Google Cloud region.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyRegion {
/**
* Description of a Google Cloud region. Example: "us-west2".
*/
region?: string | null;
}
/**
* Encapsulates a regional geographic taxonomy.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyRegional {
/**
* Google Cloud region associated with the regional geographic taxonomy.
*/
region?: Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomyRegion;
}
/**
* Response message for ListSkuGroupSkus.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaListSkuGroupSkusResponse {
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The returned SKU group SKUs.
*/
skuGroupSkus?: Schema$GoogleCloudBillingSkugroupskusV1betaSkuGroupSku[];
}
/**
* Encapsulates product categories, such as `Serverless`, `Cloud Run`, `TaskQueue`, and others.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaProductTaxonomy {
/**
* All product categories that the SKU group SKU belongs to.
*/
taxonomyCategories?: Schema$GoogleCloudBillingSkugroupskusV1betaTaxonomyCategory[];
}
/**
* Encapsulates a publicly listed stock keeping unit (SKU) that is part of a publicly listed SKU group. A SKU group represents a collection of SKUs that are related to each other. For example, the `AI Platform APIs` SKU group includes SKUs from the Cloud Dialogflow API, the Cloud Text-to-Speech API, and additional related APIs.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaSkuGroupSku {
/**
* Description of the SkuGroupSku. Example: "A2 Instance Core running in Hong Kong".
*/
displayName?: string | null;
/**
* Geographic metadata that applies to the SkuGroupSku.
*/
geoTaxonomy?: Schema$GoogleCloudBillingSkugroupskusV1betaGeoTaxonomy;
/**
* Resource name for the SkuGroupSku. Example: "skuGroups/0e6403d1-4694-44d2-a696-7a78b1a69301/skus/AA95-CD31-42FE".
*/
name?: string | null;
/**
* List of product categories that apply to the SkuGroupSku.
*/
productTaxonomy?: Schema$GoogleCloudBillingSkugroupskusV1betaProductTaxonomy;
/**
* Service that the SkuGroupSku belongs to.
*/
service?: string | null;
/**
* Unique identifier for the SKU. It is the string after the collection identifier "skus/" Example: "AA95-CD31-42FE".
*/
skuId?: string | null;
}
/**
* Encapsulates a product category.
*/
export interface Schema$GoogleCloudBillingSkugroupskusV1betaTaxonomyCategory {
/**
* Name of the product category.
*/
category?: string | null;
}
/**
* Response message for ListSkuGroups.
*/
export interface Schema$GoogleCloudBillingSkugroupsV1betaListSkuGroupsResponse {
/**
* Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The returned publicly listed SKU groups.
*/
skuGroups?: Schema$GoogleCloudBillingSkugroupsV1betaSkuGroup[];
}
/**
* Encapsulates a publicly listed stock keeping unit (SKU) group. A SKU group represents a collection of SKUs that are related to each other. For example, the `AI Platform APIs` SKU group includes SKUs from the Cloud Dialogflow API, the Cloud Text-to-Speech API, and additional related APIs.
*/
export interface Schema$GoogleCloudBillingSkugroupsV1betaSkuGroup {
/**
* Description of the SKU group. Example: "A2 VMs (1 Year CUD)".
*/
displayName?: string | null;
/**
* Resource name for the SKU group. Example: "skuGroups/0e6403d1-4694-44d2-a696-7a78b1a69301".
*/
name?: string | null;
}
/**
* e.g. insight: title: "Cost Increase (The Explanation)" description: "Your cost increase was driven by Vertex AI Online Prediction in us-central1..." severity: INFO
*/
export interface Schema$Insight {
/**
* Output only. The description of the insight.
*/
description?: string | null;
/**
* Output only. The severity of the insight, used for UI rendering (e.g., color-coding).
*/
severity?: string | null;
/**
* Output only. The title of the insight.
*/
title?: string | null;
}
/**
* A link to interoperable tools (e.g., pre-filtered Cost Reports, BQE queries).
*/
export interface Schema$InteropLink {
/**
* Output only. The label of the link, suitable for UI rendering.
*/
label?: string | null;
/**
* Output only. The type of the interop link, e.g., "COST_REPORT", "BQE_QUERY", etc.
*/
linkType?: string | null;
/**
* Output only. The URL of the link.
*/
url?: string | null;
}
/**
* An unordered mapping from key to value, represented as a collection of map entries.
*/
export interface Schema$Map {
/**
* Represents the map entries in the map.
*/
entry?: Schema$MapEntry[];
}
/**
* A single entry in a Map, representing the mapping between `key` and `value`.
*/
export interface Schema$MapEntry {
/**
* Represents the serialized map key for the entry.
*/
key?: Schema$ValueProto;
/**
* Represents the serialized map value of the entry.
*/
value?: Schema$ValueProto;
}
/**
* Represents an amount of money with its currency type.
*/
export interface Schema$Money {
/**
* The three-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* 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.
*/
nanos?: number | null;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string | null;
}
/**
* A range of values, bounded by the values 'start' (inclusive) and 'end' (exclusive). A range has an element type, and values must be of this element type. A range is contiguous, ie it contains all values of the given element type starting at 'start' and ending before 'end'. A "null" value on start or end represents an unbounded start or end value respectively. Start and end values must always be present.
*/
export interface Schema$Range {
/**
* Represents the end of the range.
*/
end?: Schema$ValueProto;
/**
* Represents the start of the range.
*/
start?: Schema$ValueProto;
}
/**
* Encapsulates details about why a request was rejected.
*/
export interface Schema$Rejection {
/**
* Output only. A user-facing message explaining the rejection.
*/
displayMessage?: string | null;
/**
* Output only. The reason for the rejection.
*/
reason?: string | null;
}
/**
* Represents a row in the query result.
*/
export interface Schema$Row {
/**
* Values for a row in the column order.
*/
values?: Schema$ValueProto[];
}
/**
* A collection of fields. The count, order, and type of the fields is determined by the type associated with this value.
*/
export interface Schema$Struct {
/**
* The fields in the struct
*/
field?: Schema$ValueProto[];
}
/**
* A suggested chart for the data set, used for UI rendering.
*/
export interface Schema$SuggestedChart {
/**
* The title of the chart.
*/
chartTitle?: string | null;
/**
* The type of the chart.
*/
chartType?: string | null;
/**
* The field used for the series (e.g., color-coding). Optional, but recommended for time-series data.
*/
seriesField?: string | null;
/**
* The field used for the x-axis.
*/
xAxisField?: string | null;
/**
* The label of the x-axis.
*/
xAxisLabel?: string | null;
/**
* The field used for the y-axis.
*/
yAxisField?: string | null;
/**
* The label of the y-axis.
*/
yAxisLabel?: string | null;
}
/**
* A suggested follow-up query for the user.
*/
export interface Schema$SuggestedQuery {
/**
* The natural language query.
*/
query?: string | null;
}
/**
* Additional context for personalization (e.g., user persona, role).
*/
export interface Schema$UserContext {
/**
* Optional. The user's persona (e.g., FinOps Manager, Developer).
*/
persona?: string | null;
/**
* Optional. The user's role (e.g., Billing Admin, Project Owner, etc.).
*/
role?: string | null;
}
/**
* This is a copy of storage/googlesql/public/value.proto. ValueProto represents the serialized form of the googlesql::Value. The intention is to support multiple languages including Java and C++, so we must be sensitive to the distinction between Java Strings and byte arrays or ByteStrings. We also want to support use-cases which do not want to serialize a copy of the GoogleSQL type for every instance (which might be very repetitive). Therefore, unlike googlesql::Value, ValueProto does not carry full type information with every instance, and can only be fully interpreted with an associated TypeProto.
*/
export interface Schema$ValueProto {
/**
* An array of value
*/
arrayValue?: Schema$Array;
/**
* Encoded bignumeric value. For the encoding format see documentation for BigNumericValue::SerializeAsProtoBytes().
*/
bignumericValue?: string | null;
/**
* Primitive for bool.
*/
boolValue?: boolean | null;
/**
* Primitive for bytes.
*/
bytesValue?: string | null;
/**
* primitive for datetime
*/
datetimeValue?: Schema$Datetime;