From fed32157524e209d48ce53380fddb39f5a576fef Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 24 May 2023 18:27:00 +0000 Subject: [PATCH] feat(cloudchannel): update the api #### cloudchannel:v1 The following keys were added: - resources.accounts.resources.customers.methods.listPurchasableOffers.parameters.changeOfferPurchase.billingAccount (Total Keys: 2) - resources.accounts.resources.customers.methods.queryEligibleBillingAccounts (Total Keys: 14) - schemas.GoogleCloudChannelV1BillingAccount (Total Keys: 15) - schemas.GoogleCloudChannelV1ChangeOfferRequest.properties.billingAccount.type (Total Keys: 1) - schemas.GoogleCloudChannelV1FetchReportResultsRequest.properties.partitionKeys (Total Keys: 2) - schemas.GoogleCloudChannelV1ListTransferableOffersRequest.properties.billingAccount.type (Total Keys: 1) - schemas.GoogleCloudChannelV1QueryEligibleBillingAccountsResponse (Total Keys: 4) - schemas.GoogleCloudChannelV1Row.properties.partitionKey.type (Total Keys: 1) - schemas.GoogleCloudChannelV1SkuPurchaseGroup (Total Keys: 6) --- ...el_v1.accounts.customers.entitlements.html | 20 +- .../cloudchannel_v1.accounts.customers.html | 58 +++++- docs/dyn/cloudchannel_v1.accounts.html | 3 +- docs/dyn/cloudchannel_v1.accounts.offers.html | 2 +- .../cloudchannel_v1.accounts.reportJobs.html | 14 +- .../dyn/cloudchannel_v1.accounts.reports.html | 6 +- .../documents/cloudchannel.v1.json | 180 ++++++++++++++++-- 7 files changed, 242 insertions(+), 41 deletions(-) diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html index 652a2aec4ef..a1b92609875 100644 --- a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html +++ b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html @@ -214,6 +214,7 @@

Method Details

The object takes the form of: { # Request message for CloudChannelService.ChangeOffer. + "billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts. "offer": "A String", # Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}. "parameters": [ # Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired offer. { # Definition for extended entitlement parameters. @@ -391,6 +392,7 @@

Method Details

"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements. "baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on. }, + "billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement. "commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers. "endTime": "A String", # Output only. Commitment end timestamp. "renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer. @@ -407,7 +409,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the entitlement is created. "name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. "offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. - "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. + "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. { # Definition for extended entitlement parameters. "editable": True or False, # Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. "name": "A String", # Name of the parameter. @@ -424,7 +426,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -488,6 +490,7 @@

Method Details

"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements. "baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on. }, + "billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement. "commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers. "endTime": "A String", # Output only. Commitment end timestamp. "renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer. @@ -504,7 +507,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the entitlement is created. "name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. "offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. - "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. + "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. { # Definition for extended entitlement parameters. "editable": True or False, # Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. "name": "A String", # Name of the parameter. @@ -521,7 +524,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -559,6 +562,7 @@

Method Details

"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements. "baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on. }, + "billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement. "commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers. "endTime": "A String", # Output only. Commitment end timestamp. "renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer. @@ -575,7 +579,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the entitlement is created. "name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. "offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. - "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. + "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. { # Definition for extended entitlement parameters. "editable": True or False, # Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. "name": "A String", # Name of the parameter. @@ -592,7 +596,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -657,7 +661,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Service provisioned for an Entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "suspensionReason": "A String", # Suspension reason for the Entitlement. @@ -772,7 +776,7 @@

Method Details

}, ], "plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer. - "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers. + "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers. "paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month. "duration": 42, # Total duration of Period Type defined. "periodType": "A String", # Period Type. diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.html b/docs/dyn/cloudchannel_v1.accounts.customers.html index 4d5a97df9b8..44478c72edd 100644 --- a/docs/dyn/cloudchannel_v1.accounts.customers.html +++ b/docs/dyn/cloudchannel_v1.accounts.customers.html @@ -103,7 +103,7 @@

Instance Methods

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.

- listPurchasableOffers(customer, changeOfferPurchase_entitlement=None, changeOfferPurchase_newSku=None, createEntitlementPurchase_sku=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)

+ listPurchasableOffers(customer, changeOfferPurchase_billingAccount=None, changeOfferPurchase_entitlement=None, changeOfferPurchase_newSku=None, createEntitlementPurchase_billingAccount=None, createEntitlementPurchase_sku=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the following: * Offers that you can purchase for a customer. * Offers that you can change for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller * INVALID_ARGUMENT: Required request parameters are missing or invalid.

listPurchasableOffers_next()

@@ -123,6 +123,9 @@

Instance Methods

provisionCloudIdentity(customer, body=None, x__xgafv=None)

Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.

+

+ queryEligibleBillingAccounts(customer, skus=None, x__xgafv=None)

+

Lists the billing accounts that are eligible to purchase particular SKUs for a given customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.

transferEntitlements(parent, body=None, x__xgafv=None)

Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

@@ -497,13 +500,15 @@

Method Details

- listPurchasableOffers(customer, changeOfferPurchase_entitlement=None, changeOfferPurchase_newSku=None, createEntitlementPurchase_sku=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None) + listPurchasableOffers(customer, changeOfferPurchase_billingAccount=None, changeOfferPurchase_entitlement=None, changeOfferPurchase_newSku=None, createEntitlementPurchase_billingAccount=None, createEntitlementPurchase_sku=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the following: * Offers that you can purchase for a customer. * Offers that you can change for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller * INVALID_ARGUMENT: Required request parameters are missing or invalid.
 
 Args:
   customer: string, Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}. (required)
+  changeOfferPurchase_billingAccount: string, Optional. Resource name of the new target Billing Account. Provide this Billing Account when setting up billing for a trial subscription. Format: accounts/{account_id}/billing_accounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.
   changeOfferPurchase_entitlement: string, Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
   changeOfferPurchase_newSku: string, Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id}
+  createEntitlementPurchase_billingAccount: string, Optional. Billing account that the result should be restricted to. Format: accounts/{account_id}/billing_accounts/{billing_account_id}.
   createEntitlementPurchase_sku: string, Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}.
   languageCode: string, Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
   pageSize: integer, Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Offers. The maximum value is 1000; the server will coerce values above 1000.
@@ -583,7 +588,7 @@ 

Method Details

}, ], "plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer. - "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers. + "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers. "paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month. "duration": 42, # Total duration of Period Type defined. "periodType": "A String", # Period Type. @@ -969,6 +974,43 @@

Method Details

}
+
+ queryEligibleBillingAccounts(customer, skus=None, x__xgafv=None) +
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.
+
+Args:
+  customer: string, Required. The resource name of the customer to list eligible billing accounts for. Format: accounts/{account_id}/customers/{customer_id}. (required)
+  skus: string, Required. List of SKUs to list eligible billing accounts for. At least one SKU is required. Format: products/{product_id}/skus/{sku_id}. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for QueryEligibleBillingAccounts.
+  "skuPurchaseGroups": [ # List of SKU purchase groups where each group represents a set of SKUs that must be purchased using the same billing account. Each SKU from [QueryEligibleBillingAccountsRequest.skus] will appear in exactly one SKU group.
+    { # Represents a set of SKUs that must be purchased using the same billing account.
+      "billingAccountPurchaseInfos": [ # List of billing accounts that are eligible to purhcase these SKUs.
+        { # Represents a billing account that can be used to make a purchase.
+          "billingAccount": { # Represents a billing account. # The billing account resource.
+            "createTime": "A String", # Output only. The time when this billing account was created.
+            "currencyCode": "A String", # Output only. The 3-letter currency code defined in ISO 4217.
+            "displayName": "A String", # Display name of the billing account.
+            "name": "A String", # Output only. Resource name of the billing account. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.
+            "regionCode": "A String", # Output only. The CLDR region code.
+          },
+        },
+      ],
+      "skus": [ # Resource names of the SKUs included in this group. Format: products/{product_id}/skus/{sku_id}.
+        "A String",
+      ],
+    },
+  ],
+}
+
+
transferEntitlements(parent, body=None, x__xgafv=None)
Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
@@ -985,6 +1027,7 @@ 

Method Details

"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements. "baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on. }, + "billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement. "commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers. "endTime": "A String", # Output only. Commitment end timestamp. "renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer. @@ -1001,7 +1044,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the entitlement is created. "name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. "offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. - "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. + "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. { # Definition for extended entitlement parameters. "editable": True or False, # Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. "name": "A String", # Name of the parameter. @@ -1018,7 +1061,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. @@ -1080,6 +1123,7 @@

Method Details

"associationInfo": { # Association links that an entitlement has to other entitlements. # Association information to other entitlements. "baseEntitlement": "A String", # The name of the base entitlement, for which this entitlement is an add-on. }, + "billingAccount": "A String", # Optional. The billing account resource name that is used to pay for this entitlement. "commitmentSettings": { # Commitment settings for commitment-based offers. # Commitment settings for a commitment-based Offer. Required for commitment based offers. "endTime": "A String", # Output only. Commitment end timestamp. "renewalSettings": { # Renewal settings for renewable Offers. # Optional. Renewal settings applicable for a commitment-based Offer. @@ -1096,7 +1140,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the entitlement is created. "name": "A String", # Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. "offer": "A String", # Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. - "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. + "parameters": [ # Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount. { # Definition for extended entitlement parameters. "editable": True or False, # Output only. Specifies whether this parameter is allowed to be changed. For example, for a Google Workspace Business Starter entitlement in commitment plan, num_units is editable when entitlement is active. "name": "A String", # Name of the parameter. @@ -1113,7 +1157,7 @@

Method Details

], "provisionedService": { # Service provisioned for an entitlement. # Output only. Service provisioning details for the entitlement. "productId": "A String", # Output only. The product pertaining to the provisioning resource as specified in the Offer. - "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount." + "provisioningId": "A String", # Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount." "skuId": "A String", # Output only. The SKU pertaining to the provisioning resource as specified in the Offer. }, "provisioningState": "A String", # Output only. Current provisioning state of the entitlement. diff --git a/docs/dyn/cloudchannel_v1.accounts.html b/docs/dyn/cloudchannel_v1.accounts.html index 622f36449ca..dcd996e652c 100644 --- a/docs/dyn/cloudchannel_v1.accounts.html +++ b/docs/dyn/cloudchannel_v1.accounts.html @@ -217,6 +217,7 @@

Method Details

The object takes the form of: { # Request message for CloudChannelService.ListTransferableOffers + "billingAccount": "A String", # Optional. The Billing Account to look up Offers for. Format: accounts/{account_id}/billing_accounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts. "cloudIdentityId": "A String", # Customer's Cloud Identity ID "customerName": "A String", # A reseller should create a customer and use the resource name of that customer here. "languageCode": "A String", # Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US". @@ -300,7 +301,7 @@

Method Details

}, ], "plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer. - "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers. + "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers. "paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month. "duration": 42, # Total duration of Period Type defined. "periodType": "A String", # Period Type. diff --git a/docs/dyn/cloudchannel_v1.accounts.offers.html b/docs/dyn/cloudchannel_v1.accounts.offers.html index eeb9572080f..52770e634ce 100644 --- a/docs/dyn/cloudchannel_v1.accounts.offers.html +++ b/docs/dyn/cloudchannel_v1.accounts.offers.html @@ -174,7 +174,7 @@

Method Details

}, ], "plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer. - "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers. + "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers. "paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month. "duration": 42, # Total duration of Period Type defined. "periodType": "A String", # Period Type. diff --git a/docs/dyn/cloudchannel_v1.accounts.reportJobs.html b/docs/dyn/cloudchannel_v1.accounts.reportJobs.html index fe8a75d3c8d..2da553e23fe 100644 --- a/docs/dyn/cloudchannel_v1.accounts.reportJobs.html +++ b/docs/dyn/cloudchannel_v1.accounts.reportJobs.html @@ -101,6 +101,9 @@

Method Details

{ # Request message for CloudChannelReportsService.FetchReportResults. "pageSize": 42, # Optional. Requested page size of the report. The server may return fewer results than requested. If you don't specify a page size, the server uses a sensible default (may change over time). The maximum value is 30,000; the server will change larger values to 30,000. "pageToken": "A String", # Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call. + "partitionKeys": [ # Optional. List of keys specifying which report partitions to return. If empty, returns all partitions. + "A String", + ], } x__xgafv: string, V1 error format. @@ -115,12 +118,12 @@

Method Details

"nextPageToken": "A String", # Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results. "reportMetadata": { # The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults. # The metadata for the report results (display name, columns, row count, and date ranges). "dateRange": { # A representation of usage or invoice date ranges. # The date range of reported usage. - "invoiceEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The latest invoice date (exclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the following month. + "invoiceEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "invoiceStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The earliest invoice date (inclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the given month. + "invoiceStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -155,12 +158,12 @@

Method Details

}, }, "precedingDateRange": { # A representation of usage or invoice date ranges. # The usage dates immediately preceding `date_range` with the same duration. Use this to calculate trending usage and costs. This is only populated if you request trending data. For example, if `date_range` is July 1-15, `preceding_date_range` will be June 16-30. - "invoiceEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The latest invoice date (exclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the following month. + "invoiceEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "invoiceStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The earliest invoice date (inclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the given month. + "invoiceStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -194,7 +197,7 @@

Method Details

"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, }, - "report": { # The ID and description of a report that was used to generate report data. For example, "GCP Daily Spend", "Google Workspace License Activity", etc. # Details of the completed report. + "report": { # The ID and description of a report that was used to generate report data. For example, "Google Cloud Daily Spend", "Google Workspace License Activity", etc. # Details of the completed report. "columns": [ # The list of columns included in the report. This defines the schema of the report results. { # The definition of a report column. Specifies the data properties in the corresponding position of the report rows. "columnId": "A String", # The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in RunReportJobRequest.filter. To see all reports and their columns, call CloudChannelReportsService.ListReports. @@ -210,6 +213,7 @@

Method Details

}, "rows": [ # The report's lists of values. Each row follows the settings and ordering of the columns from `report_metadata`. { # A row of report values. + "partitionKey": "A String", # The key for the partition this row belongs to. This field is empty if the report is not partitioned. "values": [ # The list of values in the row. { # A single report value. "dateTimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # A value of type `google.type.DateTime` (year, month, day, hour, minute, second, and UTC offset or timezone.) diff --git a/docs/dyn/cloudchannel_v1.accounts.reports.html b/docs/dyn/cloudchannel_v1.accounts.reports.html index 91c94ad5d22..f26597088b5 100644 --- a/docs/dyn/cloudchannel_v1.accounts.reports.html +++ b/docs/dyn/cloudchannel_v1.accounts.reports.html @@ -112,7 +112,7 @@

Method Details

{ # Response message for CloudChannelReportsService.ListReports. "nextPageToken": "A String", # Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results. "reports": [ # The reports available to the partner. - { # The ID and description of a report that was used to generate report data. For example, "GCP Daily Spend", "Google Workspace License Activity", etc. + { # The ID and description of a report that was used to generate report data. For example, "Google Cloud Daily Spend", "Google Workspace License Activity", etc. "columns": [ # The list of columns included in the report. This defines the schema of the report results. { # The definition of a report column. Specifies the data properties in the corresponding position of the report rows. "columnId": "A String", # The unique name of the column (for example, customer_domain, channel_partner, customer_cost). You can use column IDs in RunReportJobRequest.filter. To see all reports and their columns, call CloudChannelReportsService.ListReports. @@ -153,12 +153,12 @@

Method Details

{ # Request message for CloudChannelReportsService.RunReportJob. "dateRange": { # A representation of usage or invoice date ranges. # Optional. The range of usage or invoice dates to include in the result. - "invoiceEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The latest invoice date (exclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the following month. + "invoiceEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "invoiceStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The earliest invoice date (inclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the given month. + "invoiceStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index 179812f8921..7b674707ca3 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -935,6 +935,11 @@ "customer" ], "parameters": { + "changeOfferPurchase.billingAccount": { + "description": "Optional. Resource name of the new target Billing Account. Provide this Billing Account when setting up billing for a trial subscription. Format: accounts/{account_id}/billing_accounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.", + "location": "query", + "type": "string" + }, "changeOfferPurchase.entitlement": { "description": "Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "location": "query", @@ -945,6 +950,11 @@ "location": "query", "type": "string" }, + "createEntitlementPurchase.billingAccount": { + "description": "Optional. Billing account that the result should be restricted to. Format: accounts/{account_id}/billing_accounts/{billing_account_id}.", + "location": "query", + "type": "string" + }, "createEntitlementPurchase.sku": { "description": "Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}.", "location": "query", @@ -1110,6 +1120,37 @@ "https://www.googleapis.com/auth/apps.order" ] }, + "queryEligibleBillingAccounts": { + "description": "Lists the billing accounts that are eligible to purchase particular SKUs for a given customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.", + "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:queryEligibleBillingAccounts", + "httpMethod": "GET", + "id": "cloudchannel.accounts.customers.queryEligibleBillingAccounts", + "parameterOrder": [ + "customer" + ], + "parameters": { + "customer": { + "description": "Required. The resource name of the customer to list eligible billing accounts for. Format: accounts/{account_id}/customers/{customer_id}.", + "location": "path", + "pattern": "^accounts/[^/]+/customers/[^/]+$", + "required": true, + "type": "string" + }, + "skus": { + "description": "Required. List of SKUs to list eligible billing accounts for. At least one SKU is required. Format: products/{product_id}/skus/{sku_id}.", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v1/{+customer}:queryEligibleBillingAccounts", + "response": { + "$ref": "GoogleCloudChannelV1QueryEligibleBillingAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/apps.order" + ] + }, "transferEntitlements": { "description": "Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:transferEntitlements", @@ -2055,7 +2096,7 @@ } } }, - "revision": "20230415", + "revision": "20230522", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -2099,6 +2140,49 @@ }, "type": "object" }, + "GoogleCloudChannelV1BillingAccount": { + "description": "Represents a billing account.", + "id": "GoogleCloudChannelV1BillingAccount", + "properties": { + "createTime": { + "description": "Output only. The time when this billing account was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "currencyCode": { + "description": "Output only. The 3-letter currency code defined in ISO 4217.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Display name of the billing account.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the billing account. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.", + "readOnly": true, + "type": "string" + }, + "regionCode": { + "description": "Output only. The CLDR region code.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudChannelV1BillingAccountPurchaseInfo": { + "description": "Represents a billing account that can be used to make a purchase.", + "id": "GoogleCloudChannelV1BillingAccountPurchaseInfo", + "properties": { + "billingAccount": { + "$ref": "GoogleCloudChannelV1BillingAccount", + "description": "The billing account resource." + } + }, + "type": "object" + }, "GoogleCloudChannelV1CancelEntitlementRequest": { "description": "Request message for CloudChannelService.CancelEntitlement.", "id": "GoogleCloudChannelV1CancelEntitlementRequest", @@ -2114,6 +2198,10 @@ "description": "Request message for CloudChannelService.ChangeOffer.", "id": "GoogleCloudChannelV1ChangeOfferRequest", "properties": { + "billingAccount": { + "description": "Optional. The billing account resource name that is used to pay for this entitlement when setting up billing on a trial subscription. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.", + "type": "string" + }, "offer": { "description": "Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}.", "type": "string" @@ -2672,11 +2760,11 @@ "properties": { "invoiceEndDate": { "$ref": "GoogleTypeDate", - "description": "The latest invoice date (exclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the following month." + "description": "The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month." }, "invoiceStartDate": { "$ref": "GoogleTypeDate", - "description": "The earliest invoice date (inclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the given month." + "description": "The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month." }, "usageEndDateTime": { "$ref": "GoogleTypeDateTime", @@ -2746,6 +2834,10 @@ "$ref": "GoogleCloudChannelV1AssociationInfo", "description": "Association information to other entitlements." }, + "billingAccount": { + "description": "Optional. The billing account resource name that is used to pay for this entitlement.", + "type": "string" + }, "commitmentSettings": { "$ref": "GoogleCloudChannelV1CommitmentSettings", "description": "Commitment settings for a commitment-based Offer. Required for commitment based offers." @@ -2766,7 +2858,7 @@ "type": "string" }, "parameters": { - "description": "Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.", + "description": "Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.", "items": { "$ref": "GoogleCloudChannelV1Parameter" }, @@ -3040,6 +3132,13 @@ "pageToken": { "description": "Optional. A token that specifies a page of results beyond the first page. Obtained through FetchReportResultsResponse.next_page_token of the previous CloudChannelReportsService.FetchReportResults call.", "type": "string" + }, + "partitionKeys": { + "description": "Optional. List of keys specifying which report partitions to return. If empty, returns all partitions.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3339,6 +3438,10 @@ "description": "Request message for CloudChannelService.ListTransferableOffers", "id": "GoogleCloudChannelV1ListTransferableOffersRequest", "properties": { + "billingAccount": { + "description": "Optional. The Billing Account to look up Offers for. Format: accounts/{account_id}/billing_accounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.", + "type": "string" + }, "cloudIdentityId": { "description": "Customer's Cloud Identity ID", "type": "string" @@ -3629,13 +3732,15 @@ "PARAMETER_TYPE_UNSPECIFIED", "INT64", "STRING", - "DOUBLE" + "DOUBLE", + "BOOLEAN" ], "enumDescriptions": [ "Not used.", "Int64 type.", "String type.", - "Double type." + "Double type.", + "Boolean type." ], "type": "string" } @@ -3686,7 +3791,7 @@ "id": "GoogleCloudChannelV1Plan", "properties": { "billingAccount": { - "description": "Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers.", + "description": "Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers.", "type": "string" }, "paymentCycle": { @@ -3792,8 +3897,8 @@ "GB (used for storage SKUs).", "Active licensed users(for Voice SKUs).", "Voice usage.", - "For IaaS SKUs like Google Cloud Platform, monetization is based on usage accrued on your billing account irrespective of the type of monetizable resource. This enum represents an aggregated resource/container for all usage SKUs on a billing account. Currently, only applicable to Google Cloud Platform.", - "For Google Cloud Platform subscriptions like Anthos or SAP." + "For IaaS SKUs like Google Cloud, monetization is based on usage accrued on your billing account irrespective of the type of monetizable resource. This enum represents an aggregated resource/container for all usage SKUs on a billing account. Currently, only applicable to Google Cloud.", + "For Google Cloud subscriptions like Anthos or SAP." ], "type": "string" } @@ -3909,7 +4014,7 @@ "type": "string" }, "provisioningId": { - "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount.\"", + "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.\"", "readOnly": true, "type": "string" }, @@ -3943,6 +4048,20 @@ }, "type": "object" }, + "GoogleCloudChannelV1QueryEligibleBillingAccountsResponse": { + "description": "Response message for QueryEligibleBillingAccounts.", + "id": "GoogleCloudChannelV1QueryEligibleBillingAccountsResponse", + "properties": { + "skuPurchaseGroups": { + "description": "List of SKU purchase groups where each group represents a set of SKUs that must be purchased using the same billing account. Each SKU from [QueryEligibleBillingAccountsRequest.skus] will appear in exactly one SKU group.", + "items": { + "$ref": "GoogleCloudChannelV1SkuPurchaseGroup" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudChannelV1RegisterSubscriberRequest": { "description": "Request Message for RegisterSubscriber.", "id": "GoogleCloudChannelV1RegisterSubscriberRequest", @@ -4005,7 +4124,7 @@ "type": "object" }, "GoogleCloudChannelV1Report": { - "description": "The ID and description of a report that was used to generate report data. For example, \"GCP Daily Spend\", \"Google Workspace License Activity\", etc.", + "description": "The ID and description of a report that was used to generate report data. For example, \"Google Cloud Daily Spend\", \"Google Workspace License Activity\", etc.", "id": "GoogleCloudChannelV1Report", "properties": { "columns": { @@ -4223,6 +4342,10 @@ "description": "A row of report values.", "id": "GoogleCloudChannelV1Row", "properties": { + "partitionKey": { + "description": "The key for the partition this row belongs to. This field is empty if the report is not partitioned.", + "type": "string" + }, "values": { "description": "The list of values in the row.", "items": { @@ -4297,6 +4420,27 @@ }, "type": "object" }, + "GoogleCloudChannelV1SkuPurchaseGroup": { + "description": "Represents a set of SKUs that must be purchased using the same billing account.", + "id": "GoogleCloudChannelV1SkuPurchaseGroup", + "properties": { + "billingAccountPurchaseInfos": { + "description": "List of billing accounts that are eligible to purhcase these SKUs.", + "items": { + "$ref": "GoogleCloudChannelV1BillingAccountPurchaseInfo" + }, + "type": "array" + }, + "skus": { + "description": "Resource names of the SKUs included in this group. Format: products/{product_id}/skus/{sku_id}.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudChannelV1StartPaidServiceRequest": { "description": "Request message for CloudChannelService.StartPaidService.", "id": "GoogleCloudChannelV1StartPaidServiceRequest", @@ -4663,11 +4807,11 @@ "properties": { "invoiceEndDate": { "$ref": "GoogleTypeDate", - "description": "The latest invoice date (exclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the following month." + "description": "The latest invoice date (inclusive). If this value is not the last day of a month, this will move it forward to the last day of the given month." }, "invoiceStartDate": { "$ref": "GoogleTypeDate", - "description": "The earliest invoice date (inclusive). If your product uses monthly invoices, and this value is not the beginning of a month, this will adjust the date to the first day of the given month." + "description": "The earliest invoice date (inclusive). If this value is not the first day of a month, this will move it back to the first day of the given month." }, "usageEndDateTime": { "$ref": "GoogleTypeDateTime", @@ -4693,6 +4837,10 @@ "$ref": "GoogleCloudChannelV1alpha1AssociationInfo", "description": "Association information to other entitlements." }, + "billingAccount": { + "description": "Optional. The billing account resource name that is used to pay for this entitlement.", + "type": "string" + }, "channelPartnerId": { "description": "Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is generally used in 2-tier ordering, where the order is placed by a top-level distributor on behalf of their channel partner or reseller. Required for distributors. Deprecated: `channel_partner_id` has been moved to the Customer.", "type": "string" @@ -4727,7 +4875,7 @@ "type": "string" }, "parameters": { - "description": "Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For GCP billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.", + "description": "Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. For Google Workspace, the following Parameters may be accepted as input: - max_units: The maximum assignable units for a flexible offer OR - num_units: The total commitment for commitment-based offers The response may additionally include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. For Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.", "items": { "$ref": "GoogleCloudChannelV1alpha1Parameter" }, @@ -4949,7 +5097,7 @@ "type": "string" }, "provisioningId": { - "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount.\"", + "description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud, this is the Billing Account ID of the billing subaccount.\"", "readOnly": true, "type": "string" }, @@ -5024,7 +5172,7 @@ "type": "object" }, "GoogleCloudChannelV1alpha1Report": { - "description": "The ID and description of a report that was used to generate report data. For example, \"GCP Daily Spend\", \"Google Workspace License Activity\", etc.", + "description": "The ID and description of a report that was used to generate report data. For example, \"Google Cloud Daily Spend\", \"Google Workspace License Activity\", etc.", "id": "GoogleCloudChannelV1alpha1Report", "properties": { "columns": {