{ "servicePath": "", "fullyEncodeReservedExpansion": true, "rootUrl": "https://cloudchannel.googleapis.com/", "ownerName": "Google", "baseUrl": "https://cloudchannel.googleapis.com/", "parameters": { "key": { "location": "query", "type": "string", "description": "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." }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "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.", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "default": "json", "type": "string", "enum": [ "json", "media", "proto" ], "location": "query", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" } }, "basePath": "", "description": "The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.", "canonicalName": "Cloudchannel", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/apps.order": { "description": "Manage users on your domain" }, "https://www.googleapis.com/auth/apps.reports.usage.readonly": { "description": "View usage reports for your Google Workspace domain" } } } }, "version": "v1", "title": "Cloud Channel API", "ownerDomain": "google.com", "batchPath": "batch", "name": "cloudchannel", "version_module": true, "id": "cloudchannel:v1", "resources": { "products": { "methods": { "list": { "path": "v1/products", "httpMethod": "GET", "id": "cloudchannel.products.list", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1ListProductsResponse" }, "flatPath": "v1/products", "parameters": { "pageToken": { "location": "query", "description": "Optional. A token for a page of results other than the first page.", "type": "string" }, "account": { "description": "Required. The resource name of the reseller account. Format: accounts/{account_id}.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Products. The maximum value is 1000; the server will coerce values above 1000.", "type": "integer" }, "languageCode": { "description": "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\".", "type": "string", "location": "query" } }, "description": "Lists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid." } }, "resources": { "skus": { "methods": { "list": { "description": "Lists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "parameters": { "parent": { "description": "Required. The resource name of the Product to list SKUs for. Parent uses the format: products/{product_id}. Supports products/- to retrieve SKUs for all products.", "location": "path", "pattern": "^products/[^/]+$", "type": "string", "required": true }, "account": { "description": "Required. Resource name of the reseller. Format: accounts/{account_id}.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. A token for a page of results other than the first page. Optional.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.", "type": "integer", "location": "query", "format": "int32" }, "languageCode": { "location": "query", "description": "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\".", "type": "string" } }, "response": { "$ref": "GoogleCloudChannelV1ListSkusResponse" }, "flatPath": "v1/products/{productsId}/skus", "id": "cloudchannel.products.skus.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}/skus", "httpMethod": "GET" } } } } }, "operations": { "methods": { "delete": { "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^operations/.*$", "type": "string", "required": true } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "path": "v1/{+name}", "flatPath": "v1/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.operations.delete" }, "cancel": { "path": "v1/{+name}:cancel", "httpMethod": "POST", "id": "cloudchannel.operations.cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/operations/{operationsId}:cancel", "parameters": { "name": { "required": true, "type": "string", "pattern": "^operations/.*$", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" } }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "The name of the operation resource.", "pattern": "^operations/.*$" } }, "id": "cloudchannel.operations.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/operations/{operationsId}", "path": "v1/{+name}", "httpMethod": "GET" }, "list": { "httpMethod": "GET", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.operations.list", "flatPath": "v1/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "name": { "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^operations$", "type": "string", "required": true }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } }, "accounts": { "methods": { "checkCloudIdentityAccountsExist": { "request": { "$ref": "GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest" }, "description": "Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. 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. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}", "location": "path", "pattern": "^accounts/[^/]+$" } }, "flatPath": "v1/accounts/{accountsId}:checkCloudIdentityAccountsExist", "response": { "$ref": "GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.checkCloudIdentityAccountsExist", "httpMethod": "POST", "path": "v1/{+parent}:checkCloudIdentityAccountsExist" }, "listTransferableSkus": { "flatPath": "v1/accounts/{accountsId}:listTransferableSkus", "response": { "$ref": "GoogleCloudChannelV1ListTransferableSkusResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.listTransferableSkus", "httpMethod": "POST", "path": "v1/{+parent}:listTransferableSkus", "request": { "$ref": "GoogleCloudChannelV1ListTransferableSkusRequest" }, "description": "List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's TransferableSku.", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+$", "description": "Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}", "location": "path" } } }, "register": { "parameterOrder": [ "account" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.register", "flatPath": "v1/accounts/{accountsId}:register", "response": { "$ref": "GoogleCloudChannelV1RegisterSubscriberResponse" }, "httpMethod": "POST", "path": "v1/{+account}:register", "description": "Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * 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 topic name with the registered service email address.", "request": { "$ref": "GoogleCloudChannelV1RegisterSubscriberRequest" }, "parameters": { "account": { "pattern": "^accounts/[^/]+$", "location": "path", "description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "required": true, "type": "string" } } }, "listTransferableOffers": { "flatPath": "v1/accounts/{accountsId}:listTransferableOffers", "response": { "$ref": "GoogleCloudChannelV1ListTransferableOffersResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.listTransferableOffers", "httpMethod": "POST", "path": "v1/{+parent}:listTransferableOffers", "request": { "$ref": "GoogleCloudChannelV1ListTransferableOffersRequest" }, "description": "List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The customer provided incorrect reseller information when generating auth token. * The reseller account making the request is different from the reseller account in the query. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU.", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+$", "location": "path", "description": "Required. The resource name of the reseller's account." } } }, "unregister": { "parameters": { "account": { "pattern": "^accounts/[^/]+$", "location": "path", "description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "required": true, "type": "string" } }, "request": { "$ref": "GoogleCloudChannelV1UnregisterSubscriberRequest" }, "description": "Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * 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 topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", "httpMethod": "POST", "path": "v1/{+account}:unregister", "flatPath": "v1/accounts/{accountsId}:unregister", "response": { "$ref": "GoogleCloudChannelV1UnregisterSubscriberResponse" }, "parameterOrder": [ "account" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.unregister" }, "listSubscribers": { "parameters": { "pageSize": { "description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", "type": "integer", "location": "query", "format": "int32" }, "account": { "type": "string", "required": true, "description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "location": "path", "pattern": "^accounts/[^/]+$" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.", "type": "string" }, "integrator": { "description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", "type": "string", "location": "query" } }, "description": "Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * 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: A list of service email addresses.", "path": "v1/{+account}:listSubscribers", "httpMethod": "GET", "id": "cloudchannel.accounts.listSubscribers", "parameterOrder": [ "account" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1ListSubscribersResponse" }, "flatPath": "v1/accounts/{accountsId}:listSubscribers" } }, "resources": { "reports": { "methods": { "run": { "request": { "$ref": "GoogleCloudChannelV1RunReportJobRequest" }, "description": "Begins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`). Possible error codes: * PERMISSION_DENIED: The user doesn't have access to this report. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The report identifier was not found. * 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. To get the results of report generation, call CloudChannelReportsService.FetchReportResults with the RunReportJobResponse.report_job. Deprecated: Please use [Export Channel Services data to BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.", "parameters": { "name": { "pattern": "^accounts/[^/]+/reports/[^/]+$", "description": "Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, `613bf59q`). Name uses the format: accounts/{account_id}/reports/{report_id}", "location": "path", "required": true, "type": "string" } }, "deprecated": true, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/accounts/{accountsId}/reports/{reportsId}:run", "id": "cloudchannel.accounts.reports.run", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.reports.usage.readonly" ], "path": "v1/{+name}:run", "httpMethod": "POST" }, "list": { "parameters": { "pageToken": { "description": "Optional. A token that specifies a page of results beyond the first page. Obtained through ListReportsResponse.next_page_token of the previous CloudChannelReportsService.ListReports call.", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+$", "location": "path", "description": "Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}" }, "pageSize": { "description": "Optional. Requested page size of the report. The server might return fewer results than requested. If unspecified, returns 20 reports. The maximum value is 100.", "type": "integer", "location": "query", "format": "int32" }, "languageCode": { "description": "Optional. The BCP-47 language code, such as \"en-US\". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is \"en-US\".", "type": "string", "location": "query" } }, "deprecated": true, "description": "Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result. Deprecated: Please use [Export Channel Services data to BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.", "httpMethod": "GET", "path": "v1/{+parent}/reports", "flatPath": "v1/accounts/{accountsId}/reports", "response": { "$ref": "GoogleCloudChannelV1ListReportsResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.reports.usage.readonly" ], "id": "cloudchannel.accounts.reports.list" } }, "deprecated": true }, "reportJobs": { "deprecated": true, "methods": { "fetchReportResults": { "path": "v1/{+reportJob}:fetchReportResults", "httpMethod": "POST", "id": "cloudchannel.accounts.reportJobs.fetchReportResults", "parameterOrder": [ "reportJob" ], "scopes": [ "https://www.googleapis.com/auth/apps.reports.usage.readonly" ], "response": { "$ref": "GoogleCloudChannelV1FetchReportResultsResponse" }, "flatPath": "v1/accounts/{accountsId}/reportJobs/{reportJobsId}:fetchReportResults", "deprecated": true, "parameters": { "reportJob": { "location": "path", "description": "Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}", "pattern": "^accounts/[^/]+/reportJobs/[^/]+$", "type": "string", "required": true } }, "description": "Retrieves data generated by CloudChannelReportsService.RunReportJob. Deprecated: Please use [Export Channel Services data to BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead.", "request": { "$ref": "GoogleCloudChannelV1FetchReportResultsRequest" } } } }, "offers": { "methods": { "list": { "description": "Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "parameters": { "filter": { "location": "query", "description": "Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1", "type": "string" }, "pageToken": { "description": "Optional. A token for a page of results other than the first page.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.", "type": "integer", "location": "query", "format": "int32" }, "languageCode": { "location": "query", "description": "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\".", "type": "string" }, "showFutureOffers": { "description": "Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.", "type": "boolean", "location": "query" }, "parent": { "type": "string", "required": true, "description": "Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.", "location": "path", "pattern": "^accounts/[^/]+$" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.offers.list", "flatPath": "v1/accounts/{accountsId}/offers", "response": { "$ref": "GoogleCloudChannelV1ListOffersResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/offers" } } }, "channelPartnerLinks": { "methods": { "get": { "parameters": { "view": { "enumDescriptions": [ "The default / unset value. The API will default to the BASIC view.", "Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.", "Includes all fields." ], "location": "query", "description": "Optional. The level of granularity the ChannelPartnerLink will display.", "enum": [ "UNSPECIFIED", "BASIC", "FULL" ], "type": "string" }, "name": { "description": "Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.", "location": "path", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$", "type": "string", "required": true } }, "description": "Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. 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. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.", "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudChannelV1ChannelPartnerLink" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}", "id": "cloudchannel.accounts.channelPartnerLinks.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ] }, "patch": { "parameters": { "name": { "description": "Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner.", "location": "path", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$", "type": "string", "required": true } }, "description": "Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. 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. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * 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 updated ChannelPartnerLink resource.", "request": { "$ref": "GoogleCloudChannelV1UpdateChannelPartnerLinkRequest" }, "httpMethod": "PATCH", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.channelPartnerLinks.patch", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}", "response": { "$ref": "GoogleCloudChannelV1ChannelPartnerLink" } }, "list": { "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+$", "location": "path", "description": "Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id}" }, "pageSize": { "description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, server will pick a default size (25). The maximum value is 200; the server will coerce values above 200.", "type": "integer", "location": "query", "format": "int32" }, "view": { "description": "Optional. The level of granularity the ChannelPartnerLink will display.", "location": "query", "enumDescriptions": [ "The default / unset value. The API will default to the BASIC view.", "Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.", "Includes all fields." ], "type": "string", "enum": [ "UNSPECIFIED", "BASIC", "FULL" ] }, "pageToken": { "description": "Optional. A token for a page of results other than the first page. Obtained using ListChannelPartnerLinksResponse.next_page_token of the previous CloudChannelService.ListChannelPartnerLinks call.", "type": "string", "location": "query" } }, "description": "List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. 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: The list of the distributor account's ChannelPartnerLink resources.", "httpMethod": "GET", "path": "v1/{+parent}/channelPartnerLinks", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks", "response": { "$ref": "GoogleCloudChannelV1ListChannelPartnerLinksResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.channelPartnerLinks.list" }, "create": { "request": { "$ref": "GoogleCloudChannelV1ChannelPartnerLink" }, "description": "Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. 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. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * 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 new ChannelPartnerLink resource.", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+$", "description": "Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id}", "location": "path" } }, "response": { "$ref": "GoogleCloudChannelV1ChannelPartnerLink" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks", "id": "cloudchannel.accounts.channelPartnerLinks.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}/channelPartnerLinks", "httpMethod": "POST" } }, "resources": { "customers": { "methods": { "delete": { "httpMethod": "DELETE", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.channelPartnerLinks.customers.delete", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "description": "Required. The resource name of the customer to delete.", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/customers/[^/]+$", "type": "string", "required": true } }, "description": "Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request." }, "patch": { "httpMethod": "PATCH", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.channelPartnerLinks.customers.patch", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}", "response": { "$ref": "GoogleCloudChannelV1Customer" }, "parameters": { "name": { "location": "path", "description": "Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/customers/[^/]+$", "type": "string", "required": true }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "The update mask that applies to the resource. Optional.", "type": "string" } }, "description": "Updates an existing Customer resource for the reseller or distributor. 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. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource.", "request": { "$ref": "GoogleCloudChannelV1Customer" } }, "import": { "id": "cloudchannel.accounts.channelPartnerLinks.customers.import", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1Customer" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers:import", "path": "v1/{+parent}/customers:import", "httpMethod": "POST", "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", "request": { "$ref": "GoogleCloudChannelV1ImportCustomerRequest" }, "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}", "location": "path", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$" } } }, "list": { "description": "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.", "parameters": { "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results other than the first page. Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.", "type": "string" }, "filter": { "location": "query", "description": "Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.", "type": "string" } }, "response": { "$ref": "GoogleCloudChannelV1ListCustomersResponse" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers", "id": "cloudchannel.accounts.channelPartnerLinks.customers.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}/customers", "httpMethod": "GET" }, "create": { "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$", "description": "Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}", "location": "path" } }, "request": { "$ref": "GoogleCloudChannelV1Customer" }, "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", "path": "v1/{+parent}/customers", "httpMethod": "POST", "response": { "$ref": "GoogleCloudChannelV1Customer" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers", "id": "cloudchannel.accounts.channelPartnerLinks.customers.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ] }, "get": { "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}", "location": "path", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/customers/[^/]+$" } }, "description": "Returns the requested Customer resource. 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. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.", "path": "v1/{+name}", "httpMethod": "GET", "id": "cloudchannel.accounts.channelPartnerLinks.customers.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1Customer" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}" } } }, "channelPartnerRepricingConfigs": { "methods": { "create": { "response": { "$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs", "id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}/channelPartnerRepricingConfigs", "httpMethod": "POST", "request": { "$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig" }, "description": "Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any ChannelPartner or RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month. * The contained ChannelPartnerRepricingConfig.repricing_config value must be different from the value used in the current config for a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$", "description": "Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}", "location": "path" } } }, "get": { "response": { "$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs/{channelPartnerRepricingConfigsId}", "id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+name}", "httpMethod": "GET", "description": "Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resource, otherwise returns an error.", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/channelPartnerRepricingConfigs/[^/]+$", "type": "string", "required": true } } }, "delete": { "httpMethod": "DELETE", "path": "v1/{+name}", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs/{channelPartnerRepricingConfigsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.delete", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the channel partner repricing config rule to delete.", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/channelPartnerRepricingConfigs/[^/]+$", "type": "string", "required": true } }, "description": "Deletes the given ChannelPartnerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The ChannelPartnerRepricingConfig is active or in the past. * NOT_FOUND: No ChannelPartnerRepricingConfig found for the name in the request." }, "patch": { "description": "Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateChannelPartnerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.", "request": { "$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig" }, "parameters": { "name": { "type": "string", "required": true, "description": "Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.", "location": "path", "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+/channelPartnerRepricingConfigs/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.patch", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs/{channelPartnerRepricingConfigsId}", "response": { "$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig" }, "httpMethod": "PATCH", "path": "v1/{+name}" }, "list": { "parameters": { "filter": { "location": "query", "description": "Optional. A filter for [CloudChannelService.ListChannelPartnerRepricingConfigs] results (channel_partner_link only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set `parent=accounts/{account_id}/channelPartnerLinks/-`. Example: `channel_partner_link = accounts/account_id/channelPartnerLinks/c1` OR `channel_partner_link = accounts/account_id/channelPartnerLinks/c2`.", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListChannelPartnerRepricingConfigsResponse.next_page_token of the previous CloudChannelService.ListChannelPartnerRepricingConfigs call.", "type": "string", "location": "query" }, "parent": { "pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$", "location": "path", "description": "Required. The resource name of the account's ChannelPartnerLink. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.", "required": true, "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100.", "type": "integer" } }, "description": "Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * Channel Partner ID * RepricingConfig.effective_invoice_month * ChannelPartnerRepricingConfig.update_time If unsuccessful, returns an error.", "path": "v1/{+parent}/channelPartnerRepricingConfigs", "httpMethod": "GET", "id": "cloudchannel.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1ListChannelPartnerRepricingConfigsResponse" }, "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/channelPartnerRepricingConfigs" } } } } }, "customers": { "methods": { "patch": { "flatPath": "v1/accounts/{accountsId}/customers/{customersId}", "response": { "$ref": "GoogleCloudChannelV1Customer" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.patch", "httpMethod": "PATCH", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudChannelV1Customer" }, "description": "Updates an existing Customer resource for the reseller or distributor. 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. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource.", "parameters": { "name": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/customers/[^/]+$", "description": "Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}", "location": "path" }, "updateMask": { "description": "The update mask that applies to the resource. Optional.", "type": "string", "location": "query", "format": "google-fieldmask" } } }, "import": { "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", "request": { "$ref": "GoogleCloudChannelV1ImportCustomerRequest" }, "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+$", "description": "Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}", "location": "path" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.import", "flatPath": "v1/accounts/{accountsId}/customers:import", "response": { "$ref": "GoogleCloudChannelV1Customer" }, "httpMethod": "POST", "path": "v1/{+parent}/customers:import" }, "transferEntitlements": { "path": "v1/{+parent}:transferEntitlements", "httpMethod": "POST", "id": "cloudchannel.accounts.customers.transferEntitlements", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:transferEntitlements", "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the reseller's customer account that will receive transferred entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id}", "pattern": "^accounts/[^/]+/customers/[^/]+$", "type": "string", "required": true } }, "description": "Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * 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.", "request": { "$ref": "GoogleCloudChannelV1TransferEntitlementsRequest" } }, "listPurchasableSkus": { "description": "Lists the following: * SKUs that you can purchase for a customer * SKUs that you can upgrade or downgrade 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.", "parameters": { "changeOfferPurchase.entitlement": { "description": "Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "type": "string", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. A token for a page of results other than the first page.", "type": "string" }, "customer": { "description": "Required. The resource name of the customer to list SKUs for. Format: accounts/{account_id}/customers/{customer_id}.", "location": "path", "pattern": "^accounts/[^/]+/customers/[^/]+$", "type": "string", "required": true }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.", "type": "integer" }, "languageCode": { "location": "query", "description": "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\".", "type": "string" }, "createEntitlementPurchase.product": { "description": "Required. List SKUs belonging to this Product. Format: products/{product_id}. Supports products/- to retrieve SKUs for all products.", "type": "string", "location": "query" }, "changeOfferPurchase.changeType": { "enumDescriptions": [ "Not used.", "SKU is an upgrade on the current entitlement.", "SKU is a downgrade on the current entitlement." ], "description": "Required. Change Type for the entitlement.", "location": "query", "enum": [ "CHANGE_TYPE_UNSPECIFIED", "UPGRADE", "DOWNGRADE" ], "type": "string" } }, "id": "cloudchannel.accounts.customers.listPurchasableSkus", "parameterOrder": [ "customer" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1ListPurchasableSkusResponse" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:listPurchasableSkus", "path": "v1/{+customer}:listPurchasableSkus", "httpMethod": "GET" }, "provisionCloudIdentity": { "description": "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. * You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265 * 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.", "request": { "$ref": "GoogleCloudChannelV1ProvisionCloudIdentityRequest" }, "parameters": { "customer": { "pattern": "^accounts/[^/]+/customers/[^/]+$", "location": "path", "description": "Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}", "required": true, "type": "string" } }, "parameterOrder": [ "customer" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.provisionCloudIdentity", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:provisionCloudIdentity", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "path": "v1/{+customer}:provisionCloudIdentity" }, "delete": { "path": "v1/{+name}", "httpMethod": "DELETE", "id": "cloudchannel.accounts.customers.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}", "parameters": { "name": { "description": "Required. The resource name of the customer to delete.", "location": "path", "pattern": "^accounts/[^/]+/customers/[^/]+$", "type": "string", "required": true } }, "description": "Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request." }, "list": { "parameters": { "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results other than the first page. Obtained through ListCustomersResponse.next_page_token of the previous CloudChannelService.ListCustomers call.", "type": "string" }, "filter": { "location": "query", "description": "Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.", "type": "string" }, "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the reseller account to list customers from. Parent uses the format: accounts/{account_id}.", "pattern": "^accounts/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.", "type": "integer", "location": "query", "format": "int32" } }, "description": "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.", "path": "v1/{+parent}/customers", "httpMethod": "GET", "id": "cloudchannel.accounts.customers.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1ListCustomersResponse" }, "flatPath": "v1/accounts/{accountsId}/customers" }, "create": { "parameters": { "parent": { "description": "Required. The resource name of reseller account in which to create the customer. Parent uses the format: accounts/{account_id}", "location": "path", "pattern": "^accounts/[^/]+$", "type": "string", "required": true } }, "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", "request": { "$ref": "GoogleCloudChannelV1Customer" }, "path": "v1/{+parent}/customers", "httpMethod": "POST", "id": "cloudchannel.accounts.customers.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1Customer" }, "flatPath": "v1/accounts/{accountsId}/customers" }, "listPurchasableOffers": { "parameterOrder": [ "customer" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.listPurchasableOffers", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:listPurchasableOffers", "response": { "$ref": "GoogleCloudChannelV1ListPurchasableOffersResponse" }, "httpMethod": "GET", "path": "v1/{+customer}:listPurchasableOffers", "description": "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 * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: Required request parameters are missing or invalid.", "parameters": { "changeOfferPurchase.entitlement": { "description": "Required. Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. A token for a page of results other than the first page.", "type": "string", "location": "query" }, "createEntitlementPurchase.sku": { "location": "query", "description": "Required. SKU that the result should be restricted to. Format: products/{product_id}/skus/{sku_id}.", "type": "string" }, "customer": { "description": "Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.", "location": "path", "pattern": "^accounts/[^/]+/customers/[^/]+$", "type": "string", "required": true }, "pageSize": { "description": "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.", "type": "integer", "location": "query", "format": "int32" }, "languageCode": { "description": "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\".", "type": "string", "location": "query" }, "createEntitlementPurchase.billingAccount": { "location": "query", "description": "Optional. Billing account that the result should be restricted to. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.", "type": "string" }, "changeOfferPurchase.billingAccount": { "location": "query", "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}/billingAccounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.", "type": "string" }, "changeOfferPurchase.newSku": { "description": "Optional. Resource name of the new target SKU. Provide this SKU when upgrading or downgrading an entitlement. Format: products/{product_id}/skus/{sku_id}", "type": "string", "location": "query" } } }, "get": { "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}", "pattern": "^accounts/[^/]+/customers/[^/]+$" } }, "description": "Returns the requested Customer resource. 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. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.", "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudChannelV1Customer" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}", "id": "cloudchannel.accounts.customers.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ] }, "transferEntitlementsToGoogle": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:transferEntitlementsToGoogle", "id": "cloudchannel.accounts.customers.transferEntitlementsToGoogle", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}:transferEntitlementsToGoogle", "httpMethod": "POST", "request": { "$ref": "GoogleCloudChannelV1TransferEntitlementsToGoogleRequest" }, "description": "Transfers customer entitlements from their current reseller to Google. 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. * 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 response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.", "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the reseller's customer account where the entitlements transfer from. Parent uses the format: accounts/{account_id}/customers/{customer_id}", "pattern": "^accounts/[^/]+/customers/[^/]+$", "type": "string", "required": true } } }, "queryEligibleBillingAccounts": { "id": "cloudchannel.accounts.customers.queryEligibleBillingAccounts", "parameterOrder": [ "customer" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1QueryEligibleBillingAccountsResponse" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:queryEligibleBillingAccounts", "path": "v1/{+customer}:queryEligibleBillingAccounts", "httpMethod": "GET", "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.", "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/[^/]+$", "type": "string", "required": true }, "skus": { "repeated": true, "description": "Required. List of SKUs to list eligible billing accounts for. At least one SKU is required. Format: products/{product_id}/skus/{sku_id}.", "type": "string", "location": "query" } } } }, "resources": { "customerRepricingConfigs": { "methods": { "delete": { "id": "cloudchannel.accounts.customers.customerRepricingConfigs.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/customerRepricingConfigs/{customerRepricingConfigsId}", "path": "v1/{+name}", "httpMethod": "DELETE", "description": "Deletes the given CustomerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The CustomerRepricingConfig is active or in the past. * NOT_FOUND: No CustomerRepricingConfig found for the name in the request.", "parameters": { "name": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/customers/[^/]+/customerRepricingConfigs/[^/]+$", "location": "path", "description": "Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}." } } }, "list": { "response": { "$ref": "GoogleCloudChannelV1ListCustomerRepricingConfigsResponse" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/customerRepricingConfigs", "id": "cloudchannel.accounts.customers.customerRepricingConfigs.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}/customerRepricingConfigs", "httpMethod": "GET", "description": "Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * Customer ID * RepricingConfig.EntitlementGranularity.entitlement * RepricingConfig.effective_invoice_month * CustomerRepricingConfig.update_time If unsuccessful, returns an error.", "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.", "pattern": "^accounts/[^/]+/customers/[^/]+$", "type": "string", "required": true }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The maximum number of repricing configs to return. The service may return fewer than this value. If unspecified, returns a maximum of 50 rules. The maximum value is 100; values above 100 will be coerced to 100.", "type": "integer" }, "pageToken": { "description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListCustomerRepricingConfigsResponse.next_page_token of the previous CloudChannelService.ListCustomerRepricingConfigs call.", "type": "string", "location": "query" }, "filter": { "description": "Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] results (customer only). You can use this filter when you support a BatchGet-like query. To use the filter, you must set `parent=accounts/{account_id}/customers/-`. Example: customer = accounts/account_id/customers/c1 OR customer = accounts/account_id/customers/c2.", "type": "string", "location": "query" } } }, "patch": { "id": "cloudchannel.accounts.customers.customerRepricingConfigs.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1CustomerRepricingConfig" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/customerRepricingConfigs/{customerRepricingConfigsId}", "path": "v1/{+name}", "httpMethod": "PATCH", "description": "Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.", "request": { "$ref": "GoogleCloudChannelV1CustomerRepricingConfig" }, "parameters": { "name": { "location": "path", "description": "Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.", "pattern": "^accounts/[^/]+/customers/[^/]+/customerRepricingConfigs/[^/]+$", "type": "string", "required": true } } }, "create": { "httpMethod": "POST", "path": "v1/{+parent}/customerRepricingConfigs", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/customerRepricingConfigs", "response": { "$ref": "GoogleCloudChannelV1CustomerRepricingConfig" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.customerRepricingConfigs.create", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/customers/[^/]+$", "location": "path", "description": "Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}" } }, "request": { "$ref": "GoogleCloudChannelV1CustomerRepricingConfig" }, "description": "Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month. * The contained CustomerRepricingConfig.repricing_config value must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error." }, "get": { "parameters": { "name": { "location": "path", "description": "Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.", "pattern": "^accounts/[^/]+/customers/[^/]+/customerRepricingConfigs/[^/]+$", "type": "string", "required": true } }, "description": "Gets information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The CustomerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error.", "httpMethod": "GET", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.customerRepricingConfigs.get", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/customerRepricingConfigs/{customerRepricingConfigsId}", "response": { "$ref": "GoogleCloudChannelV1CustomerRepricingConfig" } } } }, "entitlements": { "methods": { "listEntitlementChanges": { "description": "List entitlement history. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different. * INVALID_ARGUMENT: Missing or invalid required fields in the request. * NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter. * INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support. Return value: List of EntitlementChanges.", "parameters": { "parent": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the entitlement for which to list entitlement changes. The `-` wildcard may be used to match entitlements across a customer. Formats: * accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} * accounts/{account_id}/customers/{customer_id}/entitlements/-", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$" }, "pageSize": { "description": "Optional. The maximum number of entitlement changes to return. The service may return fewer than this value. If unspecified, returns at most 10 entitlement changes. The maximum value is 50; the server will coerce values above 50.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "description": "Optional. Filters applied to the list results.", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. A page token, received from a previous CloudChannelService.ListEntitlementChanges call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CloudChannelService.ListEntitlementChanges must match the call that provided the page token.", "type": "string", "location": "query" } }, "id": "cloudchannel.accounts.customers.entitlements.listEntitlementChanges", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1ListEntitlementChangesResponse" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:listEntitlementChanges", "path": "v1/{+parent}:listEntitlementChanges", "httpMethod": "GET" }, "changeRenewalSettings": { "description": "Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. * 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.", "request": { "$ref": "GoogleCloudChannelV1ChangeRenewalSettingsRequest" }, "parameters": { "name": { "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.entitlements.changeRenewalSettings", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:changeRenewalSettings", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "path": "v1/{+name}:changeRenewalSettings" }, "suspend": { "path": "v1/{+name}:suspend", "httpMethod": "POST", "id": "cloudchannel.accounts.customers.entitlements.suspend", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:suspend", "parameters": { "name": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$", "description": "Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "location": "path" } }, "description": "Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_ACTIVE: Entitlement is not active. * 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.", "request": { "$ref": "GoogleCloudChannelV1SuspendEntitlementRequest" } }, "startPaidService": { "httpMethod": "POST", "path": "v1/{+name}:startPaidService", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:startPaidService", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.entitlements.startPaidService", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the entitlement to start a paid service for. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "location": "path", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$" } }, "request": { "$ref": "GoogleCloudChannelV1StartPaidServiceRequest" }, "description": "Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. * 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." }, "changeOffer": { "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$" } }, "request": { "$ref": "GoogleCloudChannelV1ChangeOfferRequest" }, "description": "Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Offer or Entitlement resource not found. * 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.", "path": "v1/{+name}:changeOffer", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:changeOffer", "id": "cloudchannel.accounts.customers.entitlements.changeOffer", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ] }, "list": { "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements", "response": { "$ref": "GoogleCloudChannelV1ListEntitlementsResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.entitlements.list", "httpMethod": "GET", "path": "v1/{+parent}/entitlements", "description": "Lists Entitlements belonging to a 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: A list of the customer's Entitlements.", "parameters": { "parent": { "pattern": "^accounts/[^/]+/customers/[^/]+$", "location": "path", "description": "Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id}/customers/{customer_id}", "required": true, "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. Requested page size. Server might return fewer results than requested. If unspecified, return at most 50 entitlements. The maximum value is 100; the server will coerce values above 100.", "type": "integer" }, "pageToken": { "description": "Optional. A token for a page of results other than the first page. Obtained using ListEntitlementsResponse.next_page_token of the previous CloudChannelService.ListEntitlements call.", "type": "string", "location": "query" } } }, "activate": { "parameters": { "name": { "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$", "location": "path", "description": "Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "required": true, "type": "string" } }, "request": { "$ref": "GoogleCloudChannelV1ActivateEntitlementRequest" }, "description": "Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. 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. * NOT_FOUND: Entitlement resource not found. * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. * 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.", "httpMethod": "POST", "path": "v1/{+name}:activate", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:activate", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.entitlements.activate" }, "create": { "request": { "$ref": "GoogleCloudChannelV1CreateEntitlementRequest" }, "description": "Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family. * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (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. * 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.", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/customers/[^/]+$", "location": "path", "description": "Required. The resource name of the reseller's customer account in which to create the entitlement. Parent uses the format: accounts/{account_id}/customers/{customer_id}" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements", "id": "cloudchannel.accounts.customers.entitlements.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}/entitlements", "httpMethod": "POST" }, "cancel": { "parameters": { "name": { "description": "Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "location": "path", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$", "type": "string", "required": true } }, "request": { "$ref": "GoogleCloudChannelV1CancelEntitlementRequest" }, "description": "Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. * 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 response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.", "httpMethod": "POST", "path": "v1/{+name}:cancel", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:cancel", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.customers.entitlements.cancel" }, "get": { "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudChannelV1Entitlement" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}", "id": "cloudchannel.accounts.customers.entitlements.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "parameters": { "name": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$", "description": "Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "location": "path" } }, "description": "Returns the requested Entitlement resource. 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 entitlement was not found. Return value: The requested Entitlement resource." }, "changeParameters": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:changeParameters", "id": "cloudchannel.accounts.customers.entitlements.changeParameters", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+name}:changeParameters", "httpMethod": "POST", "request": { "$ref": "GoogleCloudChannelV1ChangeParametersRequest" }, "description": "Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan. * NOT_FOUND: Entitlement resource not found. * 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.", "parameters": { "name": { "description": "Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "location": "path", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$", "type": "string", "required": true } } }, "lookupOffer": { "description": "Returns the requested Offer resource. Possible error codes: * PERMISSION_DENIED: The entitlement doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource.", "parameters": { "entitlement": { "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$" } }, "id": "cloudchannel.accounts.customers.entitlements.lookupOffer", "parameterOrder": [ "entitlement" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "response": { "$ref": "GoogleCloudChannelV1Offer" }, "flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:lookupOffer", "path": "v1/{+entitlement}:lookupOffer", "httpMethod": "GET" } } } } }, "skuGroups": { "methods": { "list": { "description": "Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the SkuGroup resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of SkuGroup.display_name If unsuccessful, returns an error.", "parameters": { "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupsResponse.next_page_token of the previous CloudChannelService.ListSkuGroups call.", "type": "string" }, "parent": { "description": "Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}.", "location": "path", "pattern": "^accounts/[^/]+$", "type": "string", "required": true }, "pageSize": { "description": "Optional. The maximum number of SKU groups to return. The service may return fewer than this value. If unspecified, returns a maximum of 1000 SKU groups. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "location": "query", "format": "int32" } }, "flatPath": "v1/accounts/{accountsId}/skuGroups", "response": { "$ref": "GoogleCloudChannelV1ListSkuGroupsResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.accounts.skuGroups.list", "httpMethod": "GET", "path": "v1/{+parent}/skuGroups" } }, "resources": { "billableSkus": { "methods": { "list": { "description": "Lists the Billable SKUs in a given SKU group. Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support. Return Value: If successful, the BillableSku resources. The data for each resource is displayed in the ascending order of: * BillableSku.service_display_name * BillableSku.sku_display_name If unsuccessful, returns an error.", "parameters": { "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results beyond the first page. Obtained through ListSkuGroupBillableSkusResponse.next_page_token of the previous CloudChannelService.ListSkuGroupBillableSkus call.", "type": "string" }, "parent": { "required": true, "type": "string", "pattern": "^accounts/[^/]+/skuGroups/[^/]+$", "location": "path", "description": "Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}." }, "pageSize": { "description": "Optional. The maximum number of SKUs to return. The service may return fewer than this value. If unspecified, returns a maximum of 100000 SKUs. The maximum value is 100000; values above 100000 will be coerced to 100000.", "type": "integer", "location": "query", "format": "int32" } }, "response": { "$ref": "GoogleCloudChannelV1ListSkuGroupBillableSkusResponse" }, "flatPath": "v1/accounts/{accountsId}/skuGroups/{skuGroupsId}/billableSkus", "id": "cloudchannel.accounts.skuGroups.billableSkus.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "path": "v1/{+parent}/billableSkus", "httpMethod": "GET" } } } } } } }, "integrators": { "methods": { "registerSubscriber": { "parameters": { "integrator": { "description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", "location": "path", "pattern": "^integrators/[^/]+$", "type": "string", "required": true } }, "description": "Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * 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 topic name with the registered service email address.", "request": { "$ref": "GoogleCloudChannelV1RegisterSubscriberRequest" }, "httpMethod": "POST", "path": "v1/{+integrator}:registerSubscriber", "parameterOrder": [ "integrator" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.integrators.registerSubscriber", "flatPath": "v1/integrators/{integratorsId}:registerSubscriber", "response": { "$ref": "GoogleCloudChannelV1RegisterSubscriberResponse" } }, "unregisterSubscriber": { "parameterOrder": [ "integrator" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.integrators.unregisterSubscriber", "flatPath": "v1/integrators/{integratorsId}:unregisterSubscriber", "response": { "$ref": "GoogleCloudChannelV1UnregisterSubscriberResponse" }, "httpMethod": "POST", "path": "v1/{+integrator}:unregisterSubscriber", "description": "Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * 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 topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", "request": { "$ref": "GoogleCloudChannelV1UnregisterSubscriberRequest" }, "parameters": { "integrator": { "pattern": "^integrators/[^/]+$", "location": "path", "description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", "required": true, "type": "string" } } }, "listSubscribers": { "httpMethod": "GET", "path": "v1/{+integrator}:listSubscribers", "flatPath": "v1/integrators/{integratorsId}:listSubscribers", "response": { "$ref": "GoogleCloudChannelV1ListSubscribersResponse" }, "parameterOrder": [ "integrator" ], "scopes": [ "https://www.googleapis.com/auth/apps.order" ], "id": "cloudchannel.integrators.listSubscribers", "parameters": { "account": { "location": "query", "description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "type": "string" }, "integrator": { "type": "string", "required": true, "location": "path", "description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", "pattern": "^integrators/[^/]+$" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", "type": "integer", "location": "query", "format": "int32" } }, "description": "Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * 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: A list of service email addresses." } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "documentationLink": "https://cloud.google.com/channel", "mtlsRootUrl": "https://cloudchannel.mtls.googleapis.com/", "kind": "discovery#restDescription", "discoveryVersion": "v1", "schemas": { "GoogleCloudChannelV1ContactInfo": { "id": "GoogleCloudChannelV1ContactInfo", "description": "Contact information for a customer account.", "type": "object", "properties": { "firstName": { "description": "The customer account contact's first name. Optional for Team customers.", "type": "string" }, "title": { "description": "Optional. The customer account contact's job title.", "type": "string" }, "phone": { "description": "The customer account's contact phone number.", "type": "string" }, "email": { "description": "The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.", "type": "string" }, "displayName": { "description": "Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name.", "type": "string", "readOnly": true }, "lastName": { "description": "The customer account contact's last name. Optional for Team customers.", "type": "string" } } }, "GoogleCloudChannelV1CreateEntitlementRequest": { "id": "GoogleCloudChannelV1CreateEntitlementRequest", "description": "Request message for CloudChannelService.CreateEntitlement", "type": "object", "properties": { "entitlement": { "description": "Required. The entitlement to create.", "$ref": "GoogleCloudChannelV1Entitlement" }, "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } } }, "GoogleCloudChannelV1alpha1EntitlementEvent": { "description": "Represents Pub/Sub message content describing entitlement update.", "type": "object", "properties": { "entitlement": { "description": "Resource name of an entitlement of the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "type": "string" }, "eventType": { "description": "Type of event which happened for the entitlement.", "type": "string", "enumDescriptions": [ "Not used.", "A new entitlement was created.", "The offer type associated with an entitlement was changed. This is not triggered if an entitlement converts from a commit offer to a flexible offer as part of a renewal.", "Annual commitment for a commit plan was changed.", "An annual entitlement was renewed.", "Entitlement was suspended.", "Entitlement was unsuspended.", "Entitlement was cancelled.", "Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).", "The renewal settings of an entitlement has changed.", "Paid service has started on trial entitlement.", "License was assigned to or revoked from a user.", "License cap was changed for the entitlement." ], "enum": [ "TYPE_UNSPECIFIED", "CREATED", "PRICE_PLAN_SWITCHED", "COMMITMENT_CHANGED", "RENEWED", "SUSPENDED", "ACTIVATED", "CANCELLED", "SKU_CHANGED", "RENEWAL_SETTING_CHANGED", "PAID_SERVICE_STARTED", "LICENSE_ASSIGNMENT_CHANGED", "LICENSE_CAP_CHANGED" ] } }, "id": "GoogleCloudChannelV1alpha1EntitlementEvent" }, "GoogleCloudChannelV1TransferableOffer": { "description": "TransferableOffer represents an Offer that can be used in Transfer. Read-only.", "type": "object", "properties": { "offer": { "$ref": "GoogleCloudChannelV1Offer", "description": "Offer with parameter constraints updated to allow the Transfer." }, "priceReferenceId": { "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" } }, "id": "GoogleCloudChannelV1TransferableOffer" }, "GoogleCloudChannelV1RepricingConfigEntitlementGranularity": { "description": "Applies the repricing configuration at the entitlement level.", "type": "object", "properties": { "entitlement": { "description": "Resource name of the entitlement. Format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "type": "string" } }, "id": "GoogleCloudChannelV1RepricingConfigEntitlementGranularity" }, "GoogleCloudChannelV1ReportValue": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1ReportValue", "description": "A single report value.", "properties": { "intValue": { "description": "A value of type `int`.", "type": "string", "format": "int64" }, "dateValue": { "description": "A value of type `google.type.Date` (year, month, day).", "$ref": "GoogleTypeDate" }, "dateTimeValue": { "$ref": "GoogleTypeDateTime", "description": "A value of type `google.type.DateTime` (year, month, day, hour, minute, second, and UTC offset or timezone.)" }, "moneyValue": { "description": "A value of type `google.type.Money` (currency code, whole units, decimal units).", "$ref": "GoogleTypeMoney" }, "decimalValue": { "$ref": "GoogleTypeDecimal", "description": "A value of type `google.type.Decimal`, representing non-integer numeric values." }, "stringValue": { "description": "A value of type `string`.", "type": "string" } } }, "GoogleCloudChannelV1RepricingConfigChannelPartnerGranularity": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1RepricingConfigChannelPartnerGranularity", "description": "Applies the repricing configuration at the channel partner level. The channel partner value is derived from the resource name. Takes an empty json object. Deprecated: This is no longer supported. Use RepricingConfig.EntitlementGranularity instead.", "properties": {} }, "GoogleCloudChannelV1DiscountComponent": { "id": "GoogleCloudChannelV1DiscountComponent", "description": "Represents a single component of the total discount applicable on a Price.", "type": "object", "properties": { "discountType": { "description": "Type of the discount.", "type": "string", "enumDescriptions": [ "Not used.", "Regional discount.", "Promotional discount.", "Sales-provided discount.", "Reseller margin.", "Deal code discount." ], "enum": [ "DISCOUNT_TYPE_UNSPECIFIED", "REGIONAL_DISCOUNT", "PROMOTIONAL_DISCOUNT", "SALES_DISCOUNT", "RESELLER_MARGIN", "DEAL_CODE" ] }, "discountPercentage": { "format": "double", "description": "Discount percentage, represented as decimal. For example, a 20% discount will be represented as 0.2.", "type": "number" }, "discountAbsolute": { "$ref": "GoogleTypeMoney", "description": "Fixed value discount." } } }, "GoogleCloudChannelV1Constraints": { "id": "GoogleCloudChannelV1Constraints", "description": "Represents the constraints for buying the Offer.", "type": "object", "properties": { "customerConstraints": { "description": "Represents constraints required to purchase the Offer for a customer.", "$ref": "GoogleCloudChannelV1CustomerConstraints" } } }, "GoogleCloudChannelV1CommitmentSettings": { "description": "Commitment settings for commitment-based offers.", "type": "object", "properties": { "renewalSettings": { "description": "Optional. Renewal settings applicable for a commitment-based Offer.", "$ref": "GoogleCloudChannelV1RenewalSettings" }, "startTime": { "description": "Output only. Commitment start timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "endTime": { "description": "Output only. Commitment end timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "id": "GoogleCloudChannelV1CommitmentSettings" }, "GoogleCloudChannelV1PriceByResource": { "description": "Represents price by resource type.", "type": "object", "properties": { "resourceType": { "description": "Resource Type. Example: SEAT", "type": "string", "enumDescriptions": [ "Not used.", "Seat.", "Monthly active user.", "GB (used for storage SKUs).", "Active licensed users(for Voice SKUs).", "Voice usage.", "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." ], "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "SEAT", "MAU", "GB", "LICENSED_USER", "MINUTES", "IAAS_USAGE", "SUBSCRIPTION" ] }, "price": { "$ref": "GoogleCloudChannelV1Price", "description": "Price of the Offer. Present if there are no price phases." }, "pricePhases": { "description": "Specifies the price by time range.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1PricePhase" } } }, "id": "GoogleCloudChannelV1PriceByResource" }, "GoogleCloudChannelV1RegisterSubscriberRequest": { "id": "GoogleCloudChannelV1RegisterSubscriberRequest", "description": "Request Message for RegisterSubscriber.", "type": "object", "properties": { "integrator": { "description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", "type": "string" }, "account": { "description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "type": "string" }, "serviceAccount": { "description": "Required. Service account that provides subscriber access to the registered topic.", "type": "string" } } }, "GoogleCloudChannelV1Price": { "id": "GoogleCloudChannelV1Price", "description": "Represents the price of the Offer.", "type": "object", "properties": { "discount": { "format": "double", "description": "Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.", "type": "number" }, "discountComponents": { "description": "Breakdown of the discount into its components. This will be empty if there is no discount present.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1DiscountComponent" } }, "basePrice": { "$ref": "GoogleTypeMoney", "description": "Base price." }, "effectivePrice": { "$ref": "GoogleTypeMoney", "description": "Effective Price after applying the discounts." }, "externalPriceUri": { "description": "Link to external price list, such as link to Google Voice rate card.", "type": "string" }, "pricePeriod": { "description": "The time period with respect to which base and effective prices are defined. Example: 1 month, 6 months, 1 year, etc.", "$ref": "GoogleCloudChannelV1Period" } } }, "GoogleCloudChannelV1RepricingCondition": { "description": "Represents the various repricing conditions you can use for a conditional override.", "type": "object", "properties": { "skuGroupCondition": { "$ref": "GoogleCloudChannelV1SkuGroupCondition", "description": "SKU Group condition for override." } }, "id": "GoogleCloudChannelV1RepricingCondition" }, "GoogleCloudChannelV1alpha1RunReportJobResponse": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1alpha1RunReportJobResponse", "description": "Response message for CloudChannelReportsService.RunReportJob.", "properties": { "reportJob": { "description": "Pass `report_job.name` to FetchReportResultsRequest.report_job to retrieve the report's results.", "$ref": "GoogleCloudChannelV1alpha1ReportJob" }, "reportMetadata": { "$ref": "GoogleCloudChannelV1alpha1ReportResultsMetadata", "description": "The metadata for the report's results (display name, columns, row count, and date range). If you view this before the operation finishes, you may see incomplete data." } } }, "GoogleCloudChannelV1Report": { "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.", "properties": { "name": { "description": "Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, `613bf59q`). Name uses the format: accounts/{account_id}/reports/{report_id}", "type": "string" }, "columns": { "description": "The list of columns included in the report. This defines the schema of the report results.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1Column" } }, "displayName": { "description": "A human-readable name for this report.", "type": "string" }, "description": { "description": "A description of other aspects of the report, such as the products it supports.", "type": "string" } }, "id": "GoogleCloudChannelV1Report", "type": "object", "deprecated": true }, "GoogleCloudChannelV1ChannelPartnerLink": { "description": "Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.", "type": "object", "properties": { "linkState": { "description": "Required. State of the channel partner link.", "type": "string", "enumDescriptions": [ "Not used.", "An invitation has been sent to the reseller to create a channel partner link.", "Status when the reseller is active.", "Status when the reseller has been revoked by the distributor.", "Status when the reseller is suspended by Google or distributor." ], "enum": [ "CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED", "INVITED", "ACTIVE", "REVOKED", "SUSPENDED" ] }, "channelPartnerCloudIdentityInfo": { "$ref": "GoogleCloudChannelV1CloudIdentityInfo", "description": "Output only. Cloud Identity info of the channel partner (IR).", "readOnly": true }, "name": { "description": "Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.", "type": "string", "readOnly": true }, "publicId": { "readOnly": true, "description": "Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.", "type": "string" }, "inviteLinkUri": { "description": "Output only. URI of the web page where partner accepts the link invitation.", "type": "string", "readOnly": true }, "updateTime": { "description": "Output only. Timestamp of when the channel partner link is updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "resellerCloudIdentityId": { "description": "Required. Cloud Identity ID of the linked reseller.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp of when the channel partner link is created.", "type": "string" } }, "id": "GoogleCloudChannelV1ChannelPartnerLink" }, "GoogleCloudChannelV1UnregisterSubscriberRequest": { "description": "Request Message for UnregisterSubscriber.", "type": "object", "properties": { "account": { "description": "Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave this field empty/unset.", "type": "string" }, "serviceAccount": { "description": "Required. Service account to unregister from subscriber access to the topic.", "type": "string" }, "integrator": { "description": "Optional. Resource name of the integrator. Required if account is not provided. Otherwise, leave this field empty/unset.", "type": "string" } }, "id": "GoogleCloudChannelV1UnregisterSubscriberRequest" }, "GoogleCloudChannelV1Media": { "id": "GoogleCloudChannelV1Media", "description": "Represents media information.", "type": "object", "properties": { "type": { "description": "Type of the media.", "type": "string", "enumDescriptions": [ "Not used.", "Type of image." ], "enum": [ "MEDIA_TYPE_UNSPECIFIED", "MEDIA_TYPE_IMAGE" ] }, "content": { "description": "URL of the media.", "type": "string" }, "title": { "description": "Title of the media.", "type": "string" } } }, "GoogleCloudChannelV1EntitlementEvent": { "description": "Represents Pub/Sub message content describing entitlement update.", "type": "object", "properties": { "entitlement": { "description": "Resource name of an entitlement of the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "type": "string" }, "eventType": { "enumDescriptions": [ "Not used.", "A new entitlement was created.", "The offer type associated with an entitlement was changed. This is not triggered if an entitlement converts from a commit offer to a flexible offer as part of a renewal.", "Annual commitment for a commit plan was changed.", "An annual entitlement was renewed.", "Entitlement was suspended.", "Entitlement was unsuspended.", "Entitlement was cancelled.", "Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).", "The renewal settings of an entitlement has changed.", "Paid service has started on trial entitlement.", "License was assigned to or revoked from a user.", "License cap was changed for the entitlement." ], "enum": [ "TYPE_UNSPECIFIED", "CREATED", "PRICE_PLAN_SWITCHED", "COMMITMENT_CHANGED", "RENEWED", "SUSPENDED", "ACTIVATED", "CANCELLED", "SKU_CHANGED", "RENEWAL_SETTING_CHANGED", "PAID_SERVICE_STARTED", "LICENSE_ASSIGNMENT_CHANGED", "LICENSE_CAP_CHANGED" ], "description": "Type of event which happened for the entitlement.", "type": "string" } }, "id": "GoogleCloudChannelV1EntitlementEvent" }, "GoogleCloudChannelV1ImportCustomerRequest": { "id": "GoogleCloudChannelV1ImportCustomerRequest", "description": "Request message for CloudChannelService.ImportCustomer", "type": "object", "properties": { "channelPartnerId": { "description": "Optional. Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is required for 2-tier transfer scenarios and can be provided via the request Parent binding as well.", "type": "string" }, "domain": { "description": "Required. Customer domain.", "type": "string" }, "primaryAdminEmail": { "description": "Required. Customer's primary admin email.", "type": "string" }, "customer": { "description": "Optional. Specifies the customer that will receive imported Cloud Identity information. Format: accounts/{account_id}/customers/{customer_id}", "type": "string" }, "authToken": { "description": "Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.", "type": "string" }, "cloudIdentityId": { "description": "Required. Customer's Cloud Identity ID", "type": "string" }, "overwriteIfExists": { "description": "Required. Choose to overwrite an existing customer if found. This must be set to true if there is an existing customer with a conflicting region code or domain.", "type": "boolean" } } }, "GoogleCloudChannelV1UnregisterSubscriberResponse": { "id": "GoogleCloudChannelV1UnregisterSubscriberResponse", "description": "Response Message for UnregisterSubscriber.", "type": "object", "properties": { "topic": { "description": "Name of the topic the service account subscriber access was removed from.", "type": "string" } } }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "GoogleCloudChannelV1alpha1CustomerEvent": { "description": "Represents Pub/Sub message content describing customer update.", "type": "object", "properties": { "customer": { "description": "Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}", "type": "string" }, "eventType": { "description": "Type of event which happened for the customer.", "type": "string", "enumDescriptions": [ "Not used.", "Primary domain for customer was changed.", "Primary domain of the customer has been verified." ], "enum": [ "TYPE_UNSPECIFIED", "PRIMARY_DOMAIN_CHANGED", "PRIMARY_DOMAIN_VERIFIED" ] } }, "id": "GoogleCloudChannelV1alpha1CustomerEvent" }, "GoogleCloudChannelV1TransferEntitlementsResponse": { "id": "GoogleCloudChannelV1TransferEntitlementsResponse", "description": "Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation.", "type": "object", "properties": { "entitlements": { "items": { "$ref": "GoogleCloudChannelV1Entitlement" }, "description": "The transferred entitlements.", "type": "array" } } }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "items": { "$ref": "GoogleLongrunningOperation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleLongrunningListOperationsResponse" }, "GoogleCloudChannelV1Offer": { "id": "GoogleCloudChannelV1Offer", "description": "Represents an offer made to resellers for purchase. An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying.", "type": "object", "properties": { "name": { "description": "Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id}", "type": "string" }, "marketingInfo": { "description": "Marketing information for the Offer.", "$ref": "GoogleCloudChannelV1MarketingInfo" }, "dealCode": { "description": "The deal code of the offer to get a special promotion or discount.", "type": "string" }, "endTime": { "description": "Output only. End of the Offer validity time.", "type": "string", "readOnly": true, "format": "google-datetime" }, "constraints": { "$ref": "GoogleCloudChannelV1Constraints", "description": "Constraints on transacting the Offer." }, "plan": { "description": "Describes the payment plan for the Offer.", "$ref": "GoogleCloudChannelV1Plan" }, "parameterDefinitions": { "description": "Parameters required to use current Offer to purchase.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1ParameterDefinition" } }, "sku": { "description": "SKU the offer is associated with.", "$ref": "GoogleCloudChannelV1Sku" }, "priceByResources": { "items": { "$ref": "GoogleCloudChannelV1PriceByResource" }, "description": "Price for each monetizable resource type.", "type": "array" }, "startTime": { "format": "google-datetime", "description": "Start of the Offer validity time.", "type": "string" } } }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" } } }, "GoogleCloudChannelV1AdminUser": { "description": "Information needed to create an Admin User for Google Workspace.", "type": "object", "properties": { "email": { "description": "Primary email of the admin user.", "type": "string" }, "givenName": { "description": "Given name of the admin user.", "type": "string" }, "familyName": { "description": "Family name of the admin user.", "type": "string" } }, "id": "GoogleCloudChannelV1AdminUser" }, "GoogleCloudChannelV1BillableSku": { "description": "Represents the Billable SKU information.", "type": "object", "properties": { "sku": { "description": "Resource name of Billable SKU. Format: billableSkus/{sku}. Example: billableSkus/6E1B-6634-470F\".", "type": "string" }, "skuDisplayName": { "description": "Unique human readable name for the SKU.", "type": "string" }, "serviceDisplayName": { "description": "Unique human readable name for the Service.", "type": "string" }, "service": { "description": "Resource name of Service which contains Repricing SKU. Format: services/{service}. Example: \"services/B7D9-FDCB-15D8\".", "type": "string" } }, "id": "GoogleCloudChannelV1BillableSku" }, "GoogleCloudChannelV1alpha1DateRange": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1alpha1DateRange", "description": "A representation of usage or invoice date ranges.", "properties": { "invoiceEndDate": { "$ref": "GoogleTypeDate", "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." }, "usageStartDateTime": { "description": "The earliest usage date time (inclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage start date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.", "$ref": "GoogleTypeDateTime" }, "invoiceStartDate": { "$ref": "GoogleTypeDate", "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": { "description": "The latest usage date time (exclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage end date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.", "$ref": "GoogleTypeDateTime" } } }, "GoogleCloudChannelV1ListOffersResponse": { "id": "GoogleCloudChannelV1ListOffersResponse", "description": "Response message for ListOffers.", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" }, "offers": { "description": "The list of Offers requested. The pricing information for each Offer only includes the base price. Effective prices and discounts aren't populated.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1Offer" } } } }, "GoogleCloudChannelV1Value": { "id": "GoogleCloudChannelV1Value", "description": "Data type and value of a parameter.", "type": "object", "properties": { "boolValue": { "description": "Represents a boolean value.", "type": "boolean" }, "int64Value": { "format": "int64", "description": "Represents an int64 value.", "type": "string" }, "stringValue": { "description": "Represents a string value.", "type": "string" }, "protoValue": { "description": "Represents an 'Any' proto value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "doubleValue": { "format": "double", "description": "Represents a double value.", "type": "number" } } }, "GoogleTypeDate": { "id": "GoogleTypeDate", "description": "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", "type": "object", "properties": { "year": { "format": "int32", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer" }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer", "format": "int32" }, "day": { "format": "int32", "description": "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.", "type": "integer" } } }, "GoogleCloudChannelV1ListPurchasableSkusResponse": { "description": "Response message for ListPurchasableSkus.", "type": "object", "properties": { "purchasableSkus": { "description": "The list of SKUs requested.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1PurchasableSku" } }, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" } }, "id": "GoogleCloudChannelV1ListPurchasableSkusResponse" }, "GoogleCloudChannelV1alpha1Column": { "type": "object", "deprecated": true, "description": "The definition of a report column. Specifies the data properties in the corresponding position of the report rows.", "properties": { "columnId": { "description": "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.", "type": "string" }, "dataType": { "description": "The type of the values for this column.", "type": "string", "enumDescriptions": [ "Not used.", "ReportValues for this column will use string_value.", "ReportValues for this column will use int_value.", "ReportValues for this column will use decimal_value.", "ReportValues for this column will use money_value.", "ReportValues for this column will use date_value.", "ReportValues for this column will use date_time_value." ], "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING", "INT", "DECIMAL", "MONEY", "DATE", "DATE_TIME" ] }, "displayName": { "description": "The column's display name.", "type": "string" } }, "id": "GoogleCloudChannelV1alpha1Column" }, "GoogleCloudChannelV1ListTransferableOffersRequest": { "description": "Request message for CloudChannelService.ListTransferableOffers", "type": "object", "properties": { "cloudIdentityId": { "description": "Customer's Cloud Identity ID", "type": "string" }, "sku": { "description": "Required. The SKU to look up Offers for.", "type": "string" }, "pageToken": { "description": "A token for a page of results other than the first page. Obtained using ListTransferableOffersResponse.next_page_token of the previous CloudChannelService.ListTransferableOffers call.", "type": "string" }, "customerName": { "description": "A reseller should create a customer and use the resource name of that customer here.", "type": "string" }, "billingAccount": { "description": "Optional. The Billing Account to look up Offers for. Format: accounts/{account_id}/billingAccounts/{billing_account_id}. This field is only relevant for multi-currency accounts. It should be left empty for single currency accounts.", "type": "string" }, "pageSize": { "description": "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.", "type": "integer", "format": "int32" }, "languageCode": { "description": "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\".", "type": "string" } }, "id": "GoogleCloudChannelV1ListTransferableOffersRequest" }, "GoogleCloudChannelV1BillingAccountPurchaseInfo": { "id": "GoogleCloudChannelV1BillingAccountPurchaseInfo", "description": "Represents a billing account that can be used to make a purchase.", "type": "object", "properties": { "billingAccount": { "$ref": "GoogleCloudChannelV1BillingAccount", "description": "The billing account resource." } } }, "GoogleCloudChannelV1Period": { "id": "GoogleCloudChannelV1Period", "description": "Represents period in days/months/years.", "type": "object", "properties": { "duration": { "format": "int32", "description": "Total duration of Period Type defined.", "type": "integer" }, "periodType": { "enumDescriptions": [ "Not used.", "Day.", "Month.", "Year." ], "enum": [ "PERIOD_TYPE_UNSPECIFIED", "DAY", "MONTH", "YEAR" ], "description": "Period Type.", "type": "string" } } }, "GoogleCloudChannelV1TransferEntitlementsRequest": { "description": "Request message for CloudChannelService.TransferEntitlements.", "type": "object", "properties": { "entitlements": { "description": "Required. The new entitlements to create or transfer.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1Entitlement" } }, "authToken": { "description": "The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.", "type": "string" }, "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } }, "id": "GoogleCloudChannelV1TransferEntitlementsRequest" }, "GoogleCloudChannelV1ListReportsResponse": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1ListReportsResponse", "description": "Response message for CloudChannelReportsService.ListReports.", "properties": { "nextPageToken": { "description": "Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results.", "type": "string" }, "reports": { "items": { "$ref": "GoogleCloudChannelV1Report" }, "description": "The reports available to the partner.", "type": "array" } } }, "GoogleCloudChannelV1Entitlement": { "description": "An entitlement is a representation of a customer's ability to use a service.", "type": "object", "properties": { "offer": { "description": "Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.", "type": "string" }, "billingAccount": { "description": "Optional. The billing account resource name that is used to pay for this entitlement.", "type": "string" }, "createTime": { "description": "Output only. The time at which the entitlement is created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "purchaseOrderId": { "description": "Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.", "type": "string" }, "provisioningState": { "enum": [ "PROVISIONING_STATE_UNSPECIFIED", "ACTIVE", "SUSPENDED" ], "type": "string", "enumDescriptions": [ "Not used.", "The entitlement is currently active.", "The entitlement is currently suspended." ], "description": "Output only. Current provisioning state of the entitlement.", "readOnly": true }, "commitmentSettings": { "description": "Commitment settings for a commitment-based Offer. Required for commitment based offers.", "$ref": "GoogleCloudChannelV1CommitmentSettings" }, "priceReferenceId": { "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" }, "updateTime": { "description": "Output only. The time at which the entitlement is updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "provisionedService": { "description": "Output only. Service provisioning details for the entitlement.", "readOnly": true, "$ref": "GoogleCloudChannelV1ProvisionedService" }, "suspensionReasons": { "items": { "enumDescriptions": [ "Not used.", "Entitlement was manually suspended by the Reseller.", "Trial ended.", "Entitlement renewal was canceled.", "Entitlement was automatically suspended on creation for pending ToS acceptance on customer.", "Other reasons (internal reasons, abuse, etc.)." ], "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "RESELLER_INITIATED", "TRIAL_ENDED", "RENEWAL_WITH_TYPE_CANCEL", "PENDING_TOS_ACCEPTANCE", "OTHER" ], "type": "string" }, "readOnly": true, "description": "Output only. Enumerable of all current suspension reasons for an entitlement.", "type": "array" }, "trialSettings": { "readOnly": true, "description": "Output only. Settings for trial offers.", "$ref": "GoogleCloudChannelV1TrialSettings" }, "name": { "description": "Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.", "type": "string", "readOnly": true }, "associationInfo": { "description": "Association information to other entitlements.", "$ref": "GoogleCloudChannelV1AssociationInfo" }, "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 Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1Parameter" } } }, "id": "GoogleCloudChannelV1Entitlement" }, "GoogleCloudChannelV1ParameterDefinition": { "description": "Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.", "type": "object", "properties": { "parameterType": { "enumDescriptions": [ "Not used.", "Int64 type.", "String type.", "Double type.", "Boolean type." ], "enum": [ "PARAMETER_TYPE_UNSPECIFIED", "INT64", "STRING", "DOUBLE", "BOOLEAN" ], "description": "Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.", "type": "string" }, "minValue": { "description": "Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.", "$ref": "GoogleCloudChannelV1Value" }, "maxValue": { "$ref": "GoogleCloudChannelV1Value", "description": "Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types." }, "name": { "description": "Name of the parameter.", "type": "string" }, "allowedValues": { "items": { "$ref": "GoogleCloudChannelV1Value" }, "description": "If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.", "type": "array" }, "optional": { "description": "If set to true, parameter is optional to purchase this Offer.", "type": "boolean" } }, "id": "GoogleCloudChannelV1ParameterDefinition" }, "GoogleCloudChannelV1alpha1CommitmentSettings": { "id": "GoogleCloudChannelV1alpha1CommitmentSettings", "description": "Commitment settings for commitment-based offers.", "type": "object", "properties": { "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Commitment end timestamp.", "type": "string" }, "startTime": { "description": "Output only. Commitment start timestamp.", "type": "string", "readOnly": true, "format": "google-datetime" }, "renewalSettings": { "$ref": "GoogleCloudChannelV1alpha1RenewalSettings", "description": "Optional. Renewal settings applicable for a commitment-based Offer." } } }, "GoogleCloudChannelV1PriceTier": { "description": "Defines price at resource tier level. For example, an offer with following definition : * Tier 1: Provide 25% discount for all seats between 1 and 25. * Tier 2: Provide 10% discount for all seats between 26 and 100. * Tier 3: Provide flat 15% discount for all seats above 100. Each of these tiers is represented as a PriceTier.", "type": "object", "properties": { "firstResource": { "description": "First resource for which the tier price applies.", "type": "integer", "format": "int32" }, "lastResource": { "format": "int32", "description": "Last resource for which the tier price applies.", "type": "integer" }, "price": { "description": "Price of the tier.", "$ref": "GoogleCloudChannelV1Price" } }, "id": "GoogleCloudChannelV1PriceTier" }, "GoogleCloudChannelV1ListCustomersResponse": { "description": "Response message for CloudChannelService.ListCustomers.", "type": "object", "properties": { "customers": { "items": { "$ref": "GoogleCloudChannelV1Customer" }, "description": "The customers belonging to a reseller or distributor.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListCustomersRequest.page_token to obtain that page.", "type": "string" } }, "id": "GoogleCloudChannelV1ListCustomersResponse" }, "GoogleCloudChannelV1alpha1Period": { "description": "Represents period in days/months/years.", "type": "object", "properties": { "duration": { "description": "Total duration of Period Type defined.", "type": "integer", "format": "int32" }, "periodType": { "enumDescriptions": [ "Not used.", "Day.", "Month.", "Year." ], "enum": [ "PERIOD_TYPE_UNSPECIFIED", "DAY", "MONTH", "YEAR" ], "description": "Period Type.", "type": "string" } }, "id": "GoogleCloudChannelV1alpha1Period" }, "GoogleCloudChannelV1CancelEntitlementRequest": { "description": "Request message for CloudChannelService.CancelEntitlement.", "type": "object", "properties": { "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } }, "id": "GoogleCloudChannelV1CancelEntitlementRequest" }, "GoogleCloudChannelV1SkuGroupCondition": { "id": "GoogleCloudChannelV1SkuGroupCondition", "description": "A condition that applies the override if a line item SKU is found in the SKU group.", "type": "object", "properties": { "skuGroup": { "description": "Specifies a SKU group (https://cloud.google.com/skus/sku-groups). Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: \"accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041\".", "type": "string" } } }, "GoogleCloudChannelV1EntitlementChange": { "id": "GoogleCloudChannelV1EntitlementChange", "description": "Change event entry for Entitlement order history", "type": "object", "properties": { "parameters": { "items": { "$ref": "GoogleCloudChannelV1Parameter" }, "description": "Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc.", "type": "array" }, "entitlement": { "description": "Required. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}", "type": "string" }, "activationReason": { "description": "The Entitlement's activation reason", "type": "string", "enumDescriptions": [ "Not used.", "Reseller reactivated a suspended Entitlement.", "Customer accepted pending terms of service.", "Reseller updated the renewal settings on an entitlement that was suspended due to cancellation, and this update reactivated the entitlement.", "Other reasons (Activated temporarily for cancellation, added a payment plan to a trial entitlement, etc.)" ], "enum": [ "ACTIVATION_REASON_UNSPECIFIED", "RESELLER_REVOKED_SUSPENSION", "CUSTOMER_ACCEPTED_PENDING_TOS", "RENEWAL_SETTINGS_CHANGED", "OTHER_ACTIVATION_REASON" ] }, "otherChangeReason": { "description": "e.g. purchase_number change reason, entered by CRS.", "type": "string" }, "operator": { "description": "Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty.", "type": "string" }, "createTime": { "description": "The submitted time of the change.", "type": "string", "format": "google-datetime" }, "offer": { "description": "Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}.", "type": "string" }, "provisionedService": { "$ref": "GoogleCloudChannelV1ProvisionedService", "description": "Service provisioned for an Entitlement." }, "changeType": { "description": "The change action type.", "type": "string", "enumDescriptions": [ "Not used.", "New Entitlement was created.", "Price plan associated with an Entitlement was changed.", "Number of seats committed for a commitment Entitlement was changed.", "An annual Entitlement was renewed.", "Entitlement was suspended.", "Entitlement was activated.", "Entitlement was cancelled.", "Entitlement was upgraded or downgraded for ex. from Google Workspace Business Standard to Google Workspace Business Plus.", "The settings for renewal of an Entitlement have changed.", "Use for Google Workspace subscription. Either a trial was converted to a paid subscription or a new subscription with no trial is created.", "License cap was changed for the entitlement.", "The suspension details have changed (but it is still suspended).", "The trial end date was extended.", "Entitlement started trial." ], "enum": [ "CHANGE_TYPE_UNSPECIFIED", "CREATED", "PRICE_PLAN_SWITCHED", "COMMITMENT_CHANGED", "RENEWED", "SUSPENDED", "ACTIVATED", "CANCELLED", "SKU_CHANGED", "RENEWAL_SETTING_CHANGED", "PAID_SUBSCRIPTION_STARTED", "LICENSE_CAP_CHANGED", "SUSPENSION_DETAILS_CHANGED", "TRIAL_END_DATE_EXTENDED", "TRIAL_STARTED" ] }, "operatorType": { "description": "Operator type responsible for the change.", "type": "string", "enumDescriptions": [ "Not used.", "Customer service representative.", "System auto job.", "Customer user.", "Reseller user." ], "enum": [ "OPERATOR_TYPE_UNSPECIFIED", "CUSTOMER_SERVICE_REPRESENTATIVE", "SYSTEM", "CUSTOMER", "RESELLER" ] }, "cancellationReason": { "enumDescriptions": [ "Not used.", "Reseller triggered a cancellation of the service.", "Relationship between the reseller and customer has ended due to a transfer.", "Entitlement transferred away from reseller while still keeping other entitlement(s) with the reseller." ], "enum": [ "CANCELLATION_REASON_UNSPECIFIED", "SERVICE_TERMINATED", "RELATIONSHIP_ENDED", "PARTIAL_TRANSFER" ], "description": "Cancellation reason for the Entitlement.", "type": "string" }, "suspensionReason": { "description": "Suspension reason for the Entitlement.", "type": "string", "enumDescriptions": [ "Not used.", "Entitlement was manually suspended by the Reseller.", "Trial ended.", "Entitlement renewal was canceled.", "Entitlement was automatically suspended on creation for pending ToS acceptance on customer.", "Other reasons (internal reasons, abuse, etc.)." ], "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "RESELLER_INITIATED", "TRIAL_ENDED", "RENEWAL_WITH_TYPE_CANCEL", "PENDING_TOS_ACCEPTANCE", "OTHER" ] } } }, "GoogleCloudChannelV1alpha1ReportJob": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1alpha1ReportJob", "description": "The result of a RunReportJob operation. Contains the name to use in FetchReportResultsRequest.report_job and the status of the operation.", "properties": { "reportStatus": { "description": "The current status of report generation.", "$ref": "GoogleCloudChannelV1alpha1ReportStatus" }, "name": { "description": "Required. The resource name of a report job. Name uses the format: `accounts/{account_id}/reportJobs/{report_job_id}`", "type": "string" } } }, "GoogleLongrunningCancelOperationRequest": { "id": "GoogleLongrunningCancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "GoogleCloudChannelV1Parameter": { "id": "GoogleCloudChannelV1Parameter", "description": "Definition for extended entitlement parameters.", "type": "object", "properties": { "value": { "$ref": "GoogleCloudChannelV1Value", "description": "Value of the parameter." }, "editable": { "readOnly": true, "description": "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.", "type": "boolean" }, "name": { "description": "Name of the parameter.", "type": "string" } } }, "GoogleCloudChannelV1RepricingConfig": { "description": "Configuration for repricing a Google bill over a period of time.", "type": "object", "properties": { "channelPartnerGranularity": { "$ref": "GoogleCloudChannelV1RepricingConfigChannelPartnerGranularity", "description": "Applies the repricing configuration at the channel partner level. Only ChannelPartnerRepricingConfig supports this value. Deprecated: This is no longer supported. Use RepricingConfig.entitlement_granularity instead.", "deprecated": true }, "entitlementGranularity": { "$ref": "GoogleCloudChannelV1RepricingConfigEntitlementGranularity", "description": "Required. Applies the repricing configuration at the entitlement level. Note: If a ChannelPartnerRepricingConfig using RepricingConfig.EntitlementGranularity becomes effective, then no existing or future RepricingConfig.ChannelPartnerGranularity will apply to the RepricingConfig.EntitlementGranularity.entitlement. This is the recommended value for both CustomerRepricingConfig and ChannelPartnerRepricingConfig." }, "effectiveInvoiceMonth": { "$ref": "GoogleTypeDate", "description": "Required. The YearMonth when these adjustments activate. The Day field needs to be \"0\" since we only accept YearMonth repricing boundaries." }, "adjustment": { "description": "Required. Information about the adjustment.", "$ref": "GoogleCloudChannelV1RepricingAdjustment" }, "conditionalOverrides": { "items": { "$ref": "GoogleCloudChannelV1ConditionalOverride" }, "description": "The conditional overrides to apply for this configuration. If you list multiple overrides, only the first valid override is used. If you don't list any overrides, the API uses the normal adjustment and rebilling basis.", "type": "array" }, "rebillingBasis": { "description": "Required. The RebillingBasis to use for this bill. Specifies the relative cost based on repricing costs you will apply.", "type": "string", "enumDescriptions": [ "Not used.", "Use the list cost, also known as the MSRP.", "Pass through all discounts except the Reseller Program Discount. If this is the default cost base and no adjustments are specified, the output cost will be exactly what the customer would see if they viewed the bill in the Google Cloud Console." ], "enum": [ "REBILLING_BASIS_UNSPECIFIED", "COST_AT_LIST", "DIRECT_CUSTOMER_COST" ] } }, "id": "GoogleCloudChannelV1RepricingConfig" }, "GoogleCloudChannelV1ListSkusResponse": { "id": "GoogleCloudChannelV1ListSkusResponse", "description": "Response message for ListSkus.", "type": "object", "properties": { "skus": { "description": "The list of SKUs requested.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1Sku" } }, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" } } }, "GoogleCloudChannelV1alpha1RenewalSettings": { "description": "Renewal settings for renewable Offers.", "type": "object", "properties": { "paymentCycle": { "description": "Describes how frequently the reseller will be billed, such as once per month.", "$ref": "GoogleCloudChannelV1alpha1Period" }, "disableCommitment": { "description": "If true, disables commitment-based offer on renewal and switches to flexible or pay as you go. Deprecated: Use `payment_plan` instead.", "type": "boolean", "deprecated": true }, "resizeUnitCount": { "description": "If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.", "type": "boolean" }, "paymentPlan": { "description": "Describes how a reseller will be billed.", "type": "string", "enumDescriptions": [ "Not used.", "Commitment.", "No commitment.", "Free.", "Trial.", "Price and ordering not available through API." ], "enum": [ "PAYMENT_PLAN_UNSPECIFIED", "COMMITMENT", "FLEXIBLE", "FREE", "TRIAL", "OFFLINE" ] }, "enableRenewal": { "description": "If false, the plan will be completed at the end date.", "type": "boolean" }, "paymentOption": { "description": "Set if enable_renewal=true. Deprecated: Use `payment_cycle` instead.", "enumDescriptions": [ "Not used.", "Paid in yearly installments.", "Paid in monthly installments." ], "type": "string", "deprecated": true, "enum": [ "PAYMENT_OPTION_UNSPECIFIED", "ANNUAL", "MONTHLY" ] }, "scheduledRenewalOffer": { "readOnly": true, "description": "Output only. The offer resource name that the entitlement will renew on at the end date. Takes the form: accounts/{account_id}/offers/{offer_id}.", "type": "string" } }, "id": "GoogleCloudChannelV1alpha1RenewalSettings" }, "GoogleCloudChannelV1Row": { "id": "GoogleCloudChannelV1Row", "description": "A row of report values.", "properties": { "values": { "items": { "$ref": "GoogleCloudChannelV1ReportValue" }, "description": "The list of values in the row.", "type": "array" }, "partitionKey": { "description": "The key for the partition this row belongs to. This field is empty if the report is not partitioned.", "type": "string" } }, "deprecated": true, "type": "object" }, "GoogleTypeTimeZone": { "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "type": "object", "properties": { "id": { "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", "type": "string" }, "version": { "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", "type": "string" } }, "id": "GoogleTypeTimeZone" }, "GoogleCloudChannelV1RegisterSubscriberResponse": { "description": "Response Message for RegisterSubscriber.", "type": "object", "properties": { "topic": { "description": "Name of the topic the subscriber will listen to.", "type": "string" } }, "id": "GoogleCloudChannelV1RegisterSubscriberResponse" }, "GoogleCloudChannelV1QueryEligibleBillingAccountsResponse": { "id": "GoogleCloudChannelV1QueryEligibleBillingAccountsResponse", "description": "Response message for QueryEligibleBillingAccounts.", "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1SkuPurchaseGroup" } } } }, "GoogleCloudChannelV1ListSubscribersResponse": { "description": "Response Message for ListSubscribers.", "type": "object", "properties": { "serviceAccounts": { "items": { "type": "string" }, "description": "List of service accounts which have subscriber access to the topic.", "type": "array" }, "topic": { "description": "Name of the topic registered with the reseller.", "type": "string" }, "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudChannelV1ListSubscribersResponse" }, "GoogleCloudChannelV1ChangeOfferRequest": { "id": "GoogleCloudChannelV1ChangeOfferRequest", "description": "Request message for CloudChannelService.ChangeOffer.", "type": "object", "properties": { "purchaseOrderId": { "description": "Optional. Purchase order id provided by the reseller.", "type": "string" }, "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" }, "priceReferenceId": { "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" }, "parameters": { "items": { "$ref": "GoogleCloudChannelV1Parameter" }, "description": "Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired offer.", "type": "array" }, "offer": { "description": "Required. New Offer. Format: accounts/{account_id}/offers/{offer_id}.", "type": "string" }, "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" } } }, "GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest": { "description": "Request message for CloudChannelService.CheckCloudIdentityAccountsExist.", "type": "object", "properties": { "domain": { "description": "Required. Domain to fetch for Cloud Identity account customers, including domain and team customers. For team customers, please use the domain for their emails.", "type": "string" }, "primaryAdminEmail": { "description": "Optional. Primary admin email to fetch for Cloud Identity account team customer.", "type": "string" } }, "id": "GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest" }, "GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse": { "id": "GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse", "description": "Response message for CloudChannelService.CheckCloudIdentityAccountsExist.", "type": "object", "properties": { "cloudIdentityAccounts": { "items": { "$ref": "GoogleCloudChannelV1CloudIdentityCustomerAccount" }, "description": "The Cloud Identity accounts associated with the domain.", "type": "array" } } }, "GoogleTypeDateTime": { "id": "GoogleTypeDateTime", "description": "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.", "type": "object", "properties": { "utcOffset": { "format": "google-duration", "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", "type": "string" }, "timeZone": { "$ref": "GoogleTypeTimeZone", "description": "Time zone." }, "day": { "format": "int32", "description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.", "type": "integer" }, "nanos": { "description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", "type": "integer", "format": "int32" }, "month": { "description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.", "type": "integer", "format": "int32" }, "seconds": { "format": "int32", "description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.", "type": "integer" }, "minutes": { "description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", "type": "integer", "format": "int32" }, "year": { "format": "int32", "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.", "type": "integer" }, "hours": { "format": "int32", "description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "type": "integer" } } }, "GoogleCloudChannelV1ListEntitlementsResponse": { "description": "Response message for CloudChannelService.ListEntitlements.", "type": "object", "properties": { "entitlements": { "items": { "$ref": "GoogleCloudChannelV1Entitlement" }, "description": "The reseller customer's entitlements.", "type": "array" }, "nextPageToken": { "description": "A token to list the next page of results. Pass to ListEntitlementsRequest.page_token to obtain that page.", "type": "string" } }, "id": "GoogleCloudChannelV1ListEntitlementsResponse" }, "GoogleCloudChannelV1ListSkuGroupsResponse": { "description": "Response message for ListSkuGroups.", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListSkuGroupsRequest.page_token to obtain that page.", "type": "string" }, "skuGroups": { "items": { "$ref": "GoogleCloudChannelV1SkuGroup" }, "description": "The list of SKU groups requested.", "type": "array" } }, "id": "GoogleCloudChannelV1ListSkuGroupsResponse" }, "GoogleCloudChannelV1alpha1Parameter": { "id": "GoogleCloudChannelV1alpha1Parameter", "description": "Definition for extended entitlement parameters.", "type": "object", "properties": { "name": { "description": "Name of the parameter.", "type": "string" }, "value": { "$ref": "GoogleCloudChannelV1alpha1Value", "description": "Value of the parameter." }, "editable": { "readOnly": true, "description": "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.", "type": "boolean" } } }, "GoogleCloudChannelV1PricePhase": { "description": "Specifies the price by the duration of months. For example, a 20% discount for the first six months, then a 10% discount starting on the seventh month.", "type": "object", "properties": { "lastPeriod": { "format": "int32", "description": "Defines first period for the phase.", "type": "integer" }, "price": { "description": "Price of the phase. Present if there are no price tiers.", "$ref": "GoogleCloudChannelV1Price" }, "periodType": { "description": "Defines the phase period type.", "type": "string", "enumDescriptions": [ "Not used.", "Day.", "Month.", "Year." ], "enum": [ "PERIOD_TYPE_UNSPECIFIED", "DAY", "MONTH", "YEAR" ] }, "firstPeriod": { "description": "Defines first period for the phase.", "type": "integer", "format": "int32" }, "priceTiers": { "items": { "$ref": "GoogleCloudChannelV1PriceTier" }, "description": "Price by the resource tiers.", "type": "array" } }, "id": "GoogleCloudChannelV1PricePhase" }, "GoogleCloudChannelV1alpha1ReportStatus": { "description": "Status of a report generation process.", "properties": { "endTime": { "format": "google-datetime", "description": "The report generation's completion time.", "type": "string" }, "state": { "enumDescriptions": [ "Not used.", "Report processing started.", "Data generated from the report is being staged.", "Report data is available for access.", "Report failed." ], "enum": [ "STATE_UNSPECIFIED", "STARTED", "WRITING", "AVAILABLE", "FAILED" ], "description": "The current state of the report generation process.", "type": "string" }, "startTime": { "description": "The report generation's start time.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudChannelV1alpha1ReportStatus", "type": "object", "deprecated": true }, "GoogleCloudChannelV1TransferEligibility": { "id": "GoogleCloudChannelV1TransferEligibility", "description": "Specifies transfer eligibility of a SKU.", "type": "object", "properties": { "description": { "description": "Localized description if reseller is not eligible to transfer the SKU.", "type": "string" }, "ineligibilityReason": { "description": "Specified the reason for ineligibility.", "type": "string", "enumDescriptions": [ "Not used.", "Reseller needs to accept TOS before transferring the SKU.", "Reseller not eligible to sell the SKU.", "SKU subscription is suspended", "The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265" ], "enum": [ "REASON_UNSPECIFIED", "PENDING_TOS_ACCEPTANCE", "SKU_NOT_ELIGIBLE", "SKU_SUSPENDED", "CHANNEL_PARTNER_NOT_AUTHORIZED_FOR_SKU" ] }, "isEligible": { "description": "Whether reseller is eligible to transfer the SKU.", "type": "boolean" } } }, "GoogleCloudChannelV1RepricingAdjustment": { "description": "A type that represents the various adjustments you can apply to a bill.", "type": "object", "properties": { "percentageAdjustment": { "$ref": "GoogleCloudChannelV1PercentageAdjustment", "description": "Flat markup or markdown on an entire bill." } }, "id": "GoogleCloudChannelV1RepricingAdjustment" }, "GoogleCloudChannelV1TransferEntitlementsToGoogleRequest": { "description": "Request message for CloudChannelService.TransferEntitlementsToGoogle.", "type": "object", "properties": { "entitlements": { "items": { "$ref": "GoogleCloudChannelV1Entitlement" }, "description": "Required. The entitlements to transfer to Google.", "type": "array" }, "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } }, "id": "GoogleCloudChannelV1TransferEntitlementsToGoogleRequest" }, "GoogleCloudChannelV1alpha1TrialSettings": { "description": "Settings for trial offers.", "type": "object", "properties": { "trial": { "description": "Determines if the entitlement is in a trial or not: * `true` - The entitlement is in trial. * `false` - The entitlement is not in trial.", "type": "boolean" }, "endTime": { "description": "Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example [Epoch converter](https://www.epochconverter.com).", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudChannelV1alpha1TrialSettings" }, "GoogleCloudChannelV1alpha1ProvisionedService": { "description": "Service provisioned for an entitlement.", "type": "object", "properties": { "provisioningId": { "readOnly": true, "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.", "type": "string" }, "productId": { "description": "Output only. The product pertaining to the provisioning resource as specified in the Offer.", "type": "string", "readOnly": true }, "skuId": { "readOnly": true, "description": "Output only. The SKU pertaining to the provisioning resource as specified in the Offer.", "type": "string" } }, "id": "GoogleCloudChannelV1alpha1ProvisionedService" }, "GoogleCloudChannelV1ListEntitlementChangesResponse": { "id": "GoogleCloudChannelV1ListEntitlementChangesResponse", "description": "Response message for CloudChannelService.ListEntitlementChanges", "type": "object", "properties": { "entitlementChanges": { "description": "The list of entitlement changes.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1EntitlementChange" } }, "nextPageToken": { "description": "A token to list the next page of results.", "type": "string" } } }, "GoogleCloudChannelV1ListCustomerRepricingConfigsResponse": { "id": "GoogleCloudChannelV1ListCustomerRepricingConfigsResponse", "description": "Response message for CloudChannelService.ListCustomerRepricingConfigs.", "type": "object", "properties": { "customerRepricingConfigs": { "items": { "$ref": "GoogleCloudChannelV1CustomerRepricingConfig" }, "description": "The repricing configs for this channel partner.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListCustomerRepricingConfigsRequest.page_token to obtain that page.", "type": "string" } } }, "GoogleCloudChannelV1alpha1OpportunityEvent": { "id": "GoogleCloudChannelV1alpha1OpportunityEvent", "description": "Represents Pub/Sub message content describing opportunity updates.", "type": "object", "properties": { "opportunity": { "description": "Resource name of the opportunity. Format: opportunities/{opportunity}", "type": "string" }, "eventType": { "enumDescriptions": [ "Not used.", "New opportunity created.", "Existing opportunity updated.", "Partner has been detached from the opportunity and can no longer access it." ], "enum": [ "TYPE_UNSPECIFIED", "CREATED", "UPDATED", "PARTNER_DETACHED" ], "description": "Type of event which happened for the opportunity.", "type": "string" }, "partner": { "description": "Resource name of the partner. Format: partners/{partner}", "type": "string" } } }, "GoogleCloudChannelV1alpha1Entitlement": { "id": "GoogleCloudChannelV1alpha1Entitlement", "description": "An entitlement is a representation of a customer's ability to use a service.", "type": "object", "properties": { "associationInfo": { "$ref": "GoogleCloudChannelV1alpha1AssociationInfo", "description": "Association information to other entitlements." }, "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 Google Cloud billing subaccounts, the following Parameter may be accepted as input: - display_name: The display name of the billing subaccount.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1alpha1Parameter" } }, "updateTime": { "description": "Output only. The time at which the entitlement is updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "provisionedService": { "description": "Output only. Service provisioning details for the entitlement.", "readOnly": true, "$ref": "GoogleCloudChannelV1alpha1ProvisionedService" }, "suspensionReasons": { "items": { "type": "string", "enumDescriptions": [ "Not used.", "Entitlement was manually suspended by the Reseller.", "Trial ended.", "Entitlement renewal was canceled.", "Entitlement was automatically suspended on creation for pending ToS acceptance on customer.", "Other reasons (internal reasons, abuse, etc.)." ], "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "RESELLER_INITIATED", "TRIAL_ENDED", "RENEWAL_WITH_TYPE_CANCEL", "PENDING_TOS_ACCEPTANCE", "OTHER" ] }, "description": "Output only. Enumerable of all current suspension reasons for an entitlement.", "type": "array", "readOnly": true }, "trialSettings": { "description": "Output only. Settings for trial offers.", "readOnly": true, "$ref": "GoogleCloudChannelV1alpha1TrialSettings" }, "name": { "description": "Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}.", "type": "string", "readOnly": true }, "numUnits": { "description": "Number of units for a commitment-based Offer. For example, for seat-based Offers, this would be the number of seats; for license-based Offers, this would be the number of licenses. Required for creating commitment-based Offers. Deprecated: Use `parameters` instead.", "type": "integer", "deprecated": true, "format": "int32" }, "provisioningState": { "type": "string", "enumDeprecated": [ false, false, true, true, true, false ], "enum": [ "PROVISIONING_STATE_UNSPECIFIED", "ACTIVE", "CANCELED", "COMPLETE", "PENDING", "SUSPENDED" ], "description": "Output only. Current provisioning state of the entitlement.", "readOnly": true, "enumDescriptions": [ "Not used.", "The entitlement is currently active.", "The entitlement was canceled. After an entitlement is `CANCELED`, its status will not change. Deprecated: Canceled entitlements will no longer be visible.", "The entitlement reached end of term and was not renewed. After an entitlement is `COMPLETE`, its status will not change. Deprecated: This is represented as ProvisioningState=SUSPENDED and suspensionReason in (TRIAL_ENDED, RENEWAL_WITH_TYPE_CANCEL)", "The entitlement is pending. Deprecated: This is represented as ProvisioningState=SUSPENDED and suspensionReason=PENDING_TOS_ACCEPTANCE", "The entitlement is currently suspended." ] }, "commitmentSettings": { "$ref": "GoogleCloudChannelV1alpha1CommitmentSettings", "description": "Commitment settings for a commitment-based Offer. Required for commitment based offers." }, "priceReferenceId": { "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" }, "channelPartnerId": { "deprecated": true, "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" }, "offer": { "description": "Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}.", "type": "string" }, "billingAccount": { "description": "Optional. The billing account resource name that is used to pay for this entitlement.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the entitlement is created.", "type": "string" }, "assignedUnits": { "description": "The current number of users that are assigned a license for the product defined in provisioned_service.skuId. Read-only. Deprecated: Use `parameters` instead.", "type": "integer", "deprecated": true, "format": "int32" }, "purchaseOrderId": { "description": "Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements.", "type": "string" }, "maxUnits": { "deprecated": true, "format": "int32", "description": "Maximum number of units for a non commitment-based Offer, such as Flexible, Trial or Free entitlements. For commitment-based entitlements, this is a read-only field, which only the internal support team can update. Deprecated: Use `parameters` instead.", "type": "integer" } } }, "GoogleCloudChannelV1ChannelPartnerRepricingConfig": { "id": "GoogleCloudChannelV1ChannelPartnerRepricingConfig", "description": "Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).", "type": "object", "properties": { "name": { "readOnly": true, "description": "Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.", "type": "string" }, "repricingConfig": { "$ref": "GoogleCloudChannelV1RepricingConfig", "description": "Required. The configuration for bill modifications made by a reseller before sending it to ChannelPartner." }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp of an update to the repricing rule. If `update_time` is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month.", "type": "string" } } }, "GoogleTypeDecimal": { "id": "GoogleTypeDecimal", "description": "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).", "type": "object", "properties": { "value": { "description": "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` -\u003e `2.5`). - Replacing a zero-length integer value with `0` (`.5` -\u003e `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -\u003e `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -\u003e `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` \u003c-\u003e `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.", "type": "string" } } }, "GoogleCloudChannelV1ListChannelPartnerLinksResponse": { "description": "Response message for CloudChannelService.ListChannelPartnerLinks.", "type": "object", "properties": { "channelPartnerLinks": { "items": { "$ref": "GoogleCloudChannelV1ChannelPartnerLink" }, "description": "The Channel partner links for a reseller.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page.", "type": "string" } }, "id": "GoogleCloudChannelV1ListChannelPartnerLinksResponse" }, "GoogleCloudChannelV1TrialSettings": { "id": "GoogleCloudChannelV1TrialSettings", "description": "Settings for trial offers.", "type": "object", "properties": { "trial": { "description": "Determines if the entitlement is in a trial or not: * `true` - The entitlement is in trial. * `false` - The entitlement is not in trial.", "type": "boolean" }, "endTime": { "format": "google-datetime", "description": "Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example [Epoch converter](https://www.epochconverter.com).", "type": "string" } } }, "GoogleCloudChannelV1CloudIdentityInfo": { "description": "Cloud Identity information for the Cloud Channel Customer.", "type": "object", "properties": { "isDomainVerified": { "readOnly": true, "description": "Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers.", "type": "boolean" }, "phoneNumber": { "description": "Phone number associated with the Cloud Identity.", "type": "string" }, "alternateEmail": { "description": "The alternate email.", "type": "string" }, "adminConsoleUri": { "description": "Output only. URI of Customer's Admin console dashboard.", "type": "string", "readOnly": true }, "eduData": { "description": "Edu information about the customer.", "$ref": "GoogleCloudChannelV1EduData" }, "primaryDomain": { "readOnly": true, "description": "Output only. The primary domain name.", "type": "string" }, "languageCode": { "description": "Language code.", "type": "string" }, "customerType": { "description": "CustomerType indicates verification type needed for using services.", "type": "string", "enumDescriptions": [ "Not used.", "Domain-owning customer which needs domain verification to use services.", "Team customer which needs email verification to use services." ], "enum": [ "CUSTOMER_TYPE_UNSPECIFIED", "DOMAIN", "TEAM" ] } }, "id": "GoogleCloudChannelV1CloudIdentityInfo" }, "GoogleCloudChannelV1alpha1ReportResultsMetadata": { "description": "The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults.", "properties": { "rowCount": { "description": "The total number of rows of data in the final report.", "type": "string", "format": "int64" }, "dateRange": { "$ref": "GoogleCloudChannelV1alpha1DateRange", "description": "The date range of reported usage." }, "report": { "$ref": "GoogleCloudChannelV1alpha1Report", "description": "Details of the completed report." }, "precedingDateRange": { "description": "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.", "$ref": "GoogleCloudChannelV1alpha1DateRange" } }, "id": "GoogleCloudChannelV1alpha1ReportResultsMetadata", "type": "object", "deprecated": true }, "GoogleCloudChannelV1RenewalSettings": { "description": "Renewal settings for renewable Offers.", "type": "object", "properties": { "paymentCycle": { "$ref": "GoogleCloudChannelV1Period", "description": "Describes how frequently the reseller will be billed, such as once per month." }, "resizeUnitCount": { "description": "If true and enable_renewal = true, the unit (for example seats or licenses) will be set to the number of active units at renewal time.", "type": "boolean" }, "paymentPlan": { "description": "Describes how a reseller will be billed.", "type": "string", "enumDescriptions": [ "Not used.", "Commitment.", "No commitment.", "Free.", "Trial.", "Price and ordering not available through API." ], "enum": [ "PAYMENT_PLAN_UNSPECIFIED", "COMMITMENT", "FLEXIBLE", "FREE", "TRIAL", "OFFLINE" ] }, "enableRenewal": { "description": "If false, the plan will be completed at the end date.", "type": "boolean" } }, "id": "GoogleCloudChannelV1RenewalSettings" }, "GoogleCloudChannelV1DateRange": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1DateRange", "description": "A representation of usage or invoice date ranges.", "properties": { "invoiceStartDate": { "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.", "$ref": "GoogleTypeDate" }, "usageEndDateTime": { "description": "The latest usage date time (exclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage end date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time.", "$ref": "GoogleTypeDateTime" }, "invoiceEndDate": { "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.", "$ref": "GoogleTypeDate" }, "usageStartDateTime": { "$ref": "GoogleTypeDateTime", "description": "The earliest usage date time (inclusive). If you use time groupings (daily, weekly, etc), each group uses midnight to midnight (Pacific time). The usage start date is rounded down to include all usage from the specified date. We recommend that clients pass `usage_start_date_time` in Pacific time." } } }, "GoogleCloudChannelV1Sku": { "id": "GoogleCloudChannelV1Sku", "description": "Represents a product's purchasable Stock Keeping Unit (SKU). SKUs represent the different variations of the product. For example, Google Workspace Business Standard and Google Workspace Business Plus are Google Workspace product SKUs.", "type": "object", "properties": { "name": { "description": "Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id}", "type": "string" }, "marketingInfo": { "description": "Marketing information for the SKU.", "$ref": "GoogleCloudChannelV1MarketingInfo" }, "product": { "$ref": "GoogleCloudChannelV1Product", "description": "Product the SKU is associated with." } } }, "GoogleCloudChannelV1ListProductsResponse": { "id": "GoogleCloudChannelV1ListProductsResponse", "description": "Response message for ListProducts.", "type": "object", "properties": { "products": { "description": "List of Products requested.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1Product" } }, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" } } }, "GoogleCloudChannelV1BillingAccount": { "description": "Represents a billing account.", "type": "object", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time when this billing account was created.", "type": "string" }, "displayName": { "description": "Display name of the billing account.", "type": "string" }, "currencyCode": { "readOnly": true, "description": "Output only. The 3-letter currency code defined in ISO 4217.", "type": "string" }, "regionCode": { "readOnly": true, "description": "Output only. The CLDR region code.", "type": "string" }, "name": { "description": "Output only. Resource name of the billing account. Format: accounts/{account_id}/billingAccounts/{billing_account_id}.", "type": "string", "readOnly": true } }, "id": "GoogleCloudChannelV1BillingAccount" }, "GoogleCloudChannelV1CustomerEvent": { "description": "Represents Pub/Sub message content describing customer update.", "type": "object", "properties": { "eventType": { "description": "Type of event which happened for the customer.", "type": "string", "enumDescriptions": [ "Not used.", "Primary domain for customer was changed.", "Primary domain of the customer has been verified." ], "enum": [ "TYPE_UNSPECIFIED", "PRIMARY_DOMAIN_CHANGED", "PRIMARY_DOMAIN_VERIFIED" ] }, "customer": { "description": "Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}", "type": "string" } }, "id": "GoogleCloudChannelV1CustomerEvent" }, "GoogleTypePostalAddress": { "description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "type": "object", "properties": { "recipients": { "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", "type": "array", "items": { "type": "string" } }, "revision": { "format": "int32", "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", "type": "integer" }, "postalCode": { "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).", "type": "string" }, "locality": { "description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.", "type": "string" }, "sublocality": { "description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", "type": "string" }, "administrativeArea": { "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.", "type": "string" }, "organization": { "description": "Optional. The name of the organization at the address.", "type": "string" }, "addressLines": { "description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", "type": "array", "items": { "type": "string" } }, "regionCode": { "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", "type": "string" }, "languageCode": { "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", "type": "string" }, "sortingCode": { "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (Côte d'Ivoire).", "type": "string" } }, "id": "GoogleTypePostalAddress" }, "GoogleCloudChannelV1EduData": { "description": "Required Edu Attributes", "type": "object", "properties": { "instituteSize": { "enumDescriptions": [ "Not used.", "1 - 100", "101 - 500", "501 - 1,000", "1,001 - 2,000", "2,001 - 5,000", "5,001 - 10,000", "10,001 +" ], "enum": [ "INSTITUTE_SIZE_UNSPECIFIED", "SIZE_1_100", "SIZE_101_500", "SIZE_501_1000", "SIZE_1001_2000", "SIZE_2001_5000", "SIZE_5001_10000", "SIZE_10001_OR_MORE" ], "description": "Size of the institute.", "type": "string" }, "instituteType": { "description": "Designated institute type of customer.", "type": "string", "enumDescriptions": [ "Not used.", "Elementary/Secondary Schools & Districts", "Higher Education Universities & Colleges" ], "enum": [ "INSTITUTE_TYPE_UNSPECIFIED", "K12", "UNIVERSITY" ] }, "website": { "description": "Web address for the edu customer's institution.", "type": "string" } }, "id": "GoogleCloudChannelV1EduData" }, "GoogleCloudChannelV1OperationMetadata": { "id": "GoogleCloudChannelV1OperationMetadata", "description": "Provides contextual information about a google.longrunning.Operation.", "type": "object", "properties": { "operationType": { "enumDescriptions": [ "Not used.", "Long Running Operation was triggered by CreateEntitlement.", "Long Running Operation was triggered by ChangeRenewalSettings.", "Long Running Operation was triggered by StartPaidService.", "Long Running Operation was triggered by ActivateEntitlement.", "Long Running Operation was triggered by SuspendEntitlement.", "Long Running Operation was triggered by CancelEntitlement.", "Long Running Operation was triggered by TransferEntitlements.", "Long Running Operation was triggered by TransferEntitlementsToGoogle.", "Long Running Operation was triggered by ChangeOffer.", "Long Running Operation was triggered by ChangeParameters.", "Long Running Operation was triggered by ProvisionCloudIdentity." ], "enum": [ "OPERATION_TYPE_UNSPECIFIED", "CREATE_ENTITLEMENT", "CHANGE_RENEWAL_SETTINGS", "START_PAID_SERVICE", "ACTIVATE_ENTITLEMENT", "SUSPEND_ENTITLEMENT", "CANCEL_ENTITLEMENT", "TRANSFER_ENTITLEMENTS", "TRANSFER_ENTITLEMENTS_TO_GOOGLE", "CHANGE_OFFER", "CHANGE_PARAMETERS", "PROVISION_CLOUD_IDENTITY" ], "description": "The RPC that initiated this Long Running Operation.", "type": "string" } } }, "GoogleCloudChannelV1ReportJob": { "id": "GoogleCloudChannelV1ReportJob", "description": "The result of a RunReportJob operation. Contains the name to use in FetchReportResultsRequest.report_job and the status of the operation.", "properties": { "reportStatus": { "$ref": "GoogleCloudChannelV1ReportStatus", "description": "The current status of report generation." }, "name": { "description": "Required. The resource name of a report job. Name uses the format: `accounts/{account_id}/reportJobs/{report_job_id}`", "type": "string" } }, "deprecated": true, "type": "object" }, "GoogleTypeMoney": { "description": "Represents an amount of money with its currency type.", "type": "object", "properties": { "nanos": { "description": "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.", "type": "integer", "format": "int32" }, "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "units": { "format": "int64", "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "type": "string" } }, "id": "GoogleTypeMoney" }, "GoogleCloudChannelV1ListTransferableOffersResponse": { "id": "GoogleCloudChannelV1ListTransferableOffersResponse", "description": "Response message for CloudChannelService.ListTransferableOffers.", "type": "object", "properties": { "transferableOffers": { "items": { "$ref": "GoogleCloudChannelV1TransferableOffer" }, "description": "Information about Offers for a customer that can be used for transfer.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListTransferableOffersRequest.page_token to obtain that page.", "type": "string" } } }, "GoogleCloudChannelV1ChangeRenewalSettingsRequest": { "description": "Request message for CloudChannelService.ChangeRenewalSettings.", "type": "object", "properties": { "renewalSettings": { "$ref": "GoogleCloudChannelV1RenewalSettings", "description": "Required. New renewal settings." }, "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } }, "id": "GoogleCloudChannelV1ChangeRenewalSettingsRequest" }, "GoogleCloudChannelV1AssociationInfo": { "description": "Association links that an entitlement has to other entitlements.", "type": "object", "properties": { "baseEntitlement": { "description": "The name of the base entitlement, for which this entitlement is an add-on.", "type": "string" } }, "id": "GoogleCloudChannelV1AssociationInfo" }, "GoogleCloudChannelV1SkuGroup": { "id": "GoogleCloudChannelV1SkuGroup", "description": "Represents the SKU group information.", "type": "object", "properties": { "name": { "description": "Resource name of SKU group. Format: accounts/{account}/skuGroups/{sku_group}. Example: \"accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041\".", "type": "string" }, "displayName": { "description": "Unique human readable identifier for the SKU group.", "type": "string" } } }, "GoogleCloudChannelV1SkuPurchaseGroup": { "id": "GoogleCloudChannelV1SkuPurchaseGroup", "description": "Represents a set of SKUs that must be purchased using the same billing account.", "type": "object", "properties": { "skus": { "description": "Resource names of the SKUs included in this group. Format: products/{product_id}/skus/{sku_id}.", "type": "array", "items": { "type": "string" } }, "billingAccountPurchaseInfos": { "items": { "$ref": "GoogleCloudChannelV1BillingAccountPurchaseInfo" }, "description": "List of billing accounts that are eligible to purhcase these SKUs.", "type": "array" } } }, "GoogleCloudChannelV1TransferableSku": { "id": "GoogleCloudChannelV1TransferableSku", "description": "TransferableSku represents information a reseller needs to view existing provisioned services for a customer that they do not own. Read-only.", "type": "object", "properties": { "sku": { "description": "The SKU pertaining to the provisioning resource as specified in the Offer.", "$ref": "GoogleCloudChannelV1Sku" }, "transferEligibility": { "description": "Describes the transfer eligibility of a SKU.", "$ref": "GoogleCloudChannelV1TransferEligibility" }, "legacySku": { "$ref": "GoogleCloudChannelV1Sku", "description": "Optional. The customer to transfer has an entitlement with the populated legacy SKU." } } }, "GoogleCloudChannelV1PurchasableOffer": { "id": "GoogleCloudChannelV1PurchasableOffer", "description": "Offer that you can purchase for a customer. This is used in the ListPurchasableOffer API response.", "type": "object", "properties": { "offer": { "description": "Offer.", "$ref": "GoogleCloudChannelV1Offer" }, "priceReferenceId": { "description": "Optional. Price reference ID for the offer. Only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", "type": "string" } } }, "GoogleCloudChannelV1ListChannelPartnerRepricingConfigsResponse": { "id": "GoogleCloudChannelV1ListChannelPartnerRepricingConfigsResponse", "description": "Response message for CloudChannelService.ListChannelPartnerRepricingConfigs.", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListChannelPartnerRepricingConfigsRequest.page_token to obtain that page.", "type": "string" }, "channelPartnerRepricingConfigs": { "items": { "$ref": "GoogleCloudChannelV1ChannelPartnerRepricingConfig" }, "description": "The repricing configs for this channel partner.", "type": "array" } } }, "GoogleCloudChannelV1alpha1Value": { "description": "Data type and value of a parameter.", "type": "object", "properties": { "protoValue": { "description": "Represents an 'Any' proto value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "doubleValue": { "description": "Represents a double value.", "type": "number", "format": "double" }, "boolValue": { "description": "Represents a boolean value.", "type": "boolean" }, "int64Value": { "format": "int64", "description": "Represents an int64 value.", "type": "string" }, "stringValue": { "description": "Represents a string value.", "type": "string" } }, "id": "GoogleCloudChannelV1alpha1Value" }, "GoogleCloudChannelV1FetchReportResultsResponse": { "description": "Response message for CloudChannelReportsService.FetchReportResults. Contains a tabular representation of the report results.", "properties": { "reportMetadata": { "$ref": "GoogleCloudChannelV1ReportResultsMetadata", "description": "The metadata for the report results (display name, columns, row count, and date ranges)." }, "nextPageToken": { "description": "Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results.", "type": "string" }, "rows": { "description": "The report's lists of values. Each row follows the settings and ordering of the columns from `report_metadata`.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1Row" } } }, "id": "GoogleCloudChannelV1FetchReportResultsResponse", "type": "object", "deprecated": true }, "GoogleCloudChannelV1StartPaidServiceRequest": { "id": "GoogleCloudChannelV1StartPaidServiceRequest", "description": "Request message for CloudChannelService.StartPaidService.", "type": "object", "properties": { "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } } }, "GoogleCloudChannelV1Product": { "description": "A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc.", "type": "object", "properties": { "name": { "description": "Resource Name of the Product. Format: products/{product_id}", "type": "string" }, "marketingInfo": { "description": "Marketing information for the product.", "$ref": "GoogleCloudChannelV1MarketingInfo" } }, "id": "GoogleCloudChannelV1Product" }, "GoogleCloudChannelV1MarketingInfo": { "description": "Represents the marketing information for a Product, SKU or Offer.", "type": "object", "properties": { "defaultLogo": { "$ref": "GoogleCloudChannelV1Media", "description": "Default logo." }, "displayName": { "description": "Human readable name.", "type": "string" }, "description": { "description": "Human readable description. Description can contain HTML.", "type": "string" } }, "id": "GoogleCloudChannelV1MarketingInfo" }, "GoogleCloudChannelV1ListTransferableSkusResponse": { "description": "Response message for CloudChannelService.ListTransferableSkus.", "type": "object", "properties": { "transferableSkus": { "description": "Information about existing SKUs for a customer that needs a transfer.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1TransferableSku" } }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListTransferableSkusRequest.page_token to obtain that page.", "type": "string" } }, "id": "GoogleCloudChannelV1ListTransferableSkusResponse" }, "GoogleCloudChannelV1alpha1TransferEntitlementsResponse": { "description": "Response message for CloudChannelService.TransferEntitlements. This is put in the response field of google.longrunning.Operation.", "type": "object", "properties": { "entitlements": { "description": "The transferred entitlements.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1alpha1Entitlement" } } }, "id": "GoogleCloudChannelV1alpha1TransferEntitlementsResponse" }, "GoogleCloudChannelV1ListPurchasableOffersResponse": { "id": "GoogleCloudChannelV1ListPurchasableOffersResponse", "description": "Response message for ListPurchasableOffers.", "type": "object", "properties": { "purchasableOffers": { "items": { "$ref": "GoogleCloudChannelV1PurchasableOffer" }, "description": "The list of Offers requested.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" } } }, "GoogleCloudChannelV1ProvisionCloudIdentityRequest": { "description": "Request message for CloudChannelService.ProvisionCloudIdentity", "type": "object", "properties": { "cloudIdentityInfo": { "description": "CloudIdentity-specific customer information.", "$ref": "GoogleCloudChannelV1CloudIdentityInfo" }, "validateOnly": { "description": "Validate the request and preview the review, but do not post it.", "type": "boolean" }, "user": { "$ref": "GoogleCloudChannelV1AdminUser", "description": "Admin user information." } }, "id": "GoogleCloudChannelV1ProvisionCloudIdentityRequest" }, "GoogleCloudChannelV1RunReportJobRequest": { "id": "GoogleCloudChannelV1RunReportJobRequest", "description": "Request message for CloudChannelReportsService.RunReportJob.", "properties": { "filter": { "description": "Optional. A structured string that defines conditions on dimension columns to restrict the report output. Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, \u003c, \u003e, \u003c=, and \u003e=) using `column_id` as keys. For example: `(customer:\"accounts/C123abc/customers/S456def\" OR customer:\"accounts/C123abc/customers/S789ghi\") AND invoice_start_date.year \u003e= 2022`", "type": "string" }, "dateRange": { "$ref": "GoogleCloudChannelV1DateRange", "description": "Optional. The range of usage or invoice dates to include in the result." }, "languageCode": { "description": "Optional. The BCP-47 language code, such as \"en-US\". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is \"en-US\".", "type": "string" } }, "deprecated": true, "type": "object" }, "GoogleCloudChannelV1FetchReportResultsRequest": { "type": "object", "deprecated": true, "description": "Request message for CloudChannelReportsService.FetchReportResults.", "properties": { "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.", "type": "array", "items": { "type": "string" } }, "pageSize": { "format": "int32", "description": "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.", "type": "integer" } }, "id": "GoogleCloudChannelV1FetchReportResultsRequest" }, "GoogleCloudChannelV1ReportResultsMetadata": { "description": "The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults.", "properties": { "dateRange": { "description": "The date range of reported usage.", "$ref": "GoogleCloudChannelV1DateRange" }, "rowCount": { "description": "The total number of rows of data in the final report.", "type": "string", "format": "int64" }, "report": { "description": "Details of the completed report.", "$ref": "GoogleCloudChannelV1Report" }, "precedingDateRange": { "description": "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.", "$ref": "GoogleCloudChannelV1DateRange" } }, "id": "GoogleCloudChannelV1ReportResultsMetadata", "type": "object", "deprecated": true }, "GoogleCloudChannelV1UpdateChannelPartnerLinkRequest": { "id": "GoogleCloudChannelV1UpdateChannelPartnerLinkRequest", "description": "Request message for CloudChannelService.UpdateChannelPartnerLink", "type": "object", "properties": { "channelPartnerLink": { "description": "Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates.", "$ref": "GoogleCloudChannelV1ChannelPartnerLink" }, "updateMask": { "format": "google-fieldmask", "description": "Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state.", "type": "string" } } }, "GoogleCloudChannelV1ListTransferableSkusRequest": { "description": "Request message for CloudChannelService.ListTransferableSkus", "type": "object", "properties": { "authToken": { "description": "Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.", "type": "string" }, "cloudIdentityId": { "description": "Customer's Cloud Identity ID", "type": "string" }, "pageToken": { "description": "A token for a page of results other than the first page. Obtained using ListTransferableSkusResponse.next_page_token of the previous CloudChannelService.ListTransferableSkus call. Optional.", "type": "string" }, "customerName": { "description": "A reseller is required to create a customer and use the resource name of the created customer here. Customer_name uses the format: accounts/{account_id}/customers/{customer_id}", "type": "string" }, "pageSize": { "format": "int32", "description": "The requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. Optional.", "type": "integer" }, "languageCode": { "description": "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\". Optional.", "type": "string" } }, "id": "GoogleCloudChannelV1ListTransferableSkusRequest" }, "GoogleCloudChannelV1PercentageAdjustment": { "id": "GoogleCloudChannelV1PercentageAdjustment", "description": "An adjustment that applies a flat markup or markdown to an entire bill.", "type": "object", "properties": { "percentage": { "$ref": "GoogleTypeDecimal", "description": "The percentage of the bill to adjust. For example: Mark down by 1% =\u003e \"-1.00\" Mark up by 1% =\u003e \"1.00\" Pass-Through =\u003e \"0.00\"" } } }, "GoogleCloudChannelV1CustomerConstraints": { "description": "Represents constraints required to purchase the Offer for a customer.", "type": "object", "properties": { "allowedRegions": { "items": { "type": "string" }, "description": "Allowed geographical regions of the customer.", "type": "array" }, "promotionalOrderTypes": { "items": { "type": "string", "enumDescriptions": [ "Not used.", "Order used for new customers, trial conversions and upgrades.", "All orders for transferring an existing customer.", "Orders for modifying an existing customer's promotion on the same SKU." ], "enum": [ "PROMOTIONAL_TYPE_UNSPECIFIED", "NEW_UPGRADE", "TRANSFER", "PROMOTION_SWITCH" ] }, "description": "Allowed Promotional Order Type. Present for Promotional offers.", "type": "array" }, "allowedCustomerTypes": { "items": { "type": "string", "enumDescriptions": [ "Not used.", "Domain-owning customer which needs domain verification to use services.", "Team customer which needs email verification to use services." ], "enum": [ "CUSTOMER_TYPE_UNSPECIFIED", "DOMAIN", "TEAM" ] }, "description": "Allowed Customer Type.", "type": "array" } }, "id": "GoogleCloudChannelV1CustomerConstraints" }, "GoogleCloudChannelV1RunReportJobResponse": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1RunReportJobResponse", "description": "Response message for CloudChannelReportsService.RunReportJob.", "properties": { "reportJob": { "description": "Pass `report_job.name` to FetchReportResultsRequest.report_job to retrieve the report's results.", "$ref": "GoogleCloudChannelV1ReportJob" }, "reportMetadata": { "description": "The metadata for the report's results (display name, columns, row count, and date range). If you view this before the operation finishes, you may see incomplete data.", "$ref": "GoogleCloudChannelV1ReportResultsMetadata" } } }, "GoogleCloudChannelV1SuspendEntitlementRequest": { "id": "GoogleCloudChannelV1SuspendEntitlementRequest", "description": "Request message for CloudChannelService.SuspendEntitlement.", "type": "object", "properties": { "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } } }, "GoogleCloudChannelV1Customer": { "id": "GoogleCloudChannelV1Customer", "description": "Entity representing a customer of a reseller or distributor.", "type": "object", "properties": { "cloudIdentityId": { "readOnly": true, "description": "Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.", "type": "string" }, "domain": { "description": "Required. The customer's primary domain. Must match the primary contact email's domain.", "type": "string" }, "primaryContactInfo": { "description": "Primary contact info.", "$ref": "GoogleCloudChannelV1ContactInfo" }, "name": { "description": "Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}", "type": "string", "readOnly": true }, "updateTime": { "description": "Output only. Time when the customer was updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "correlationId": { "description": "Optional. External CRM ID for the customer. Populated only if a CRM ID exists for this customer.", "type": "string" }, "cloudIdentityInfo": { "readOnly": true, "description": "Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.", "$ref": "GoogleCloudChannelV1CloudIdentityInfo" }, "customerAttestationState": { "description": "Optional. Indicate if a customer is attesting about the correctness of provided information. Only required if creating a GCP Entitlement.", "type": "string", "enumDescriptions": [ "Default value if not set yet", "Customer is exempt from attesting based on exemption list at https://cloud.google.com/terms/direct-tos-exemptions. Contact information of customer will be mandatory.", "Customer is not exempt and has verified the information provided is correct. Contact information of customer will be mandatory." ], "enum": [ "CUSTOMER_ATTESTATION_STATE_UNSPECIFIED", "EXEMPT", "NON_EXEMPT_AND_INFO_VERIFIED" ] }, "languageCode": { "description": "Optional. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "orgPostalAddress": { "description": "Required. The organization address for the customer. To enforce US laws and embargoes, we require a region, postal code, and address lines. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.", "$ref": "GoogleTypePostalAddress" }, "orgDisplayName": { "description": "Required. Name of the organization that the customer entity represents.", "type": "string" }, "channelPartnerId": { "description": "Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.", "type": "string" }, "alternateEmail": { "description": "Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time when the customer was created.", "type": "string" } } }, "GoogleCloudChannelV1ChangeParametersRequest": { "description": "Request message for CloudChannelService.ChangeParameters.", "type": "object", "properties": { "parameters": { "items": { "$ref": "GoogleCloudChannelV1Parameter" }, "description": "Required. Entitlement parameters to update. You can only change editable parameters. To view the available Parameters for a request, refer to the Offer.parameter_definitions from the desired offer.", "type": "array" }, "purchaseOrderId": { "description": "Optional. Purchase order ID provided by the reseller.", "type": "string" }, "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } }, "id": "GoogleCloudChannelV1ChangeParametersRequest" }, "GoogleCloudChannelV1ConditionalOverride": { "description": "Specifies the override to conditionally apply.", "type": "object", "properties": { "adjustment": { "description": "Required. Information about the applied override's adjustment.", "$ref": "GoogleCloudChannelV1RepricingAdjustment" }, "repricingCondition": { "$ref": "GoogleCloudChannelV1RepricingCondition", "description": "Required. Specifies the condition which, if met, will apply the override." }, "rebillingBasis": { "enumDescriptions": [ "Not used.", "Use the list cost, also known as the MSRP.", "Pass through all discounts except the Reseller Program Discount. If this is the default cost base and no adjustments are specified, the output cost will be exactly what the customer would see if they viewed the bill in the Google Cloud Console." ], "enum": [ "REBILLING_BASIS_UNSPECIFIED", "COST_AT_LIST", "DIRECT_CUSTOMER_COST" ], "description": "Required. The RebillingBasis to use for the applied override. Shows the relative cost based on your repricing costs.", "type": "string" } }, "id": "GoogleCloudChannelV1ConditionalOverride" }, "GoogleCloudChannelV1ReportStatus": { "id": "GoogleCloudChannelV1ReportStatus", "description": "Status of a report generation process.", "properties": { "state": { "enumDescriptions": [ "Not used.", "Report processing started.", "Data generated from the report is being staged.", "Report data is available for access.", "Report failed." ], "enum": [ "STATE_UNSPECIFIED", "STARTED", "WRITING", "AVAILABLE", "FAILED" ], "description": "The current state of the report generation process.", "type": "string" }, "startTime": { "description": "The report generation's start time.", "type": "string", "format": "google-datetime" }, "endTime": { "format": "google-datetime", "description": "The report generation's completion time.", "type": "string" } }, "deprecated": true, "type": "object" }, "GoogleCloudChannelV1alpha1ChannelPartnerEvent": { "description": "Represents Pub/Sub messages about updates to a Channel Partner. You can retrieve updated values through the ChannelPartnerLinks API.", "type": "object", "properties": { "channelPartner": { "description": "Resource name for the Channel Partner Link. Channel_partner uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}", "type": "string" }, "eventType": { "enumDescriptions": [ "Default value. Does not display if there are no errors.", "The Channel Partner link state changed.", "The Channel Partner's Partner Advantage information changed. This can entail the Channel Partner's authorization to sell a product in a particular region." ], "enum": [ "TYPE_UNSPECIFIED", "LINK_STATE_CHANGED", "PARTNER_ADVANTAGE_INFO_CHANGED" ], "description": "Type of event which happened for the channel partner.", "type": "string" } }, "id": "GoogleCloudChannelV1alpha1ChannelPartnerEvent" }, "GoogleCloudChannelV1alpha1OperationMetadata": { "id": "GoogleCloudChannelV1alpha1OperationMetadata", "description": "Provides contextual information about a google.longrunning.Operation.", "type": "object", "properties": { "operationType": { "enumDescriptions": [ "Not used.", "Long Running Operation was triggered by CreateEntitlement.", "Long Running Operation was triggered by ChangeQuantity.", "Long Running Operation was triggered by ChangeRenewalSettings.", "Long Running Operation was triggered by ChangePlan.", "Long Running Operation was triggered by StartPaidService.", "Long Running Operation was triggered by ChangeSku.", "Long Running Operation was triggered by ActivateEntitlement.", "Long Running Operation was triggered by SuspendEntitlement.", "Long Running Operation was triggered by CancelEntitlement.", "Long Running Operation was triggered by TransferEntitlements.", "Long Running Operation was triggered by TransferEntitlementsToGoogle.", "Long Running Operation was triggered by ChangeOffer.", "Long Running Operation was triggered by ChangeParameters.", "Long Running Operation was triggered by ProvisionCloudIdentity." ], "enum": [ "OPERATION_TYPE_UNSPECIFIED", "CREATE_ENTITLEMENT", "CHANGE_QUANTITY", "CHANGE_RENEWAL_SETTINGS", "CHANGE_PLAN", "START_PAID_SERVICE", "CHANGE_SKU", "ACTIVATE_ENTITLEMENT", "SUSPEND_ENTITLEMENT", "CANCEL_ENTITLEMENT", "TRANSFER_ENTITLEMENTS", "TRANSFER_ENTITLEMENTS_TO_GOOGLE", "CHANGE_OFFER", "CHANGE_PARAMETERS", "PROVISION_CLOUD_IDENTITY" ], "description": "The RPC that initiated this Long Running Operation.", "type": "string" } } }, "GoogleCloudChannelV1PurchasableSku": { "description": "SKU that you can purchase. This is used in ListPurchasableSku API response.", "type": "object", "properties": { "sku": { "$ref": "GoogleCloudChannelV1Sku", "description": "SKU" } }, "id": "GoogleCloudChannelV1PurchasableSku" }, "GoogleCloudChannelV1ListSkuGroupBillableSkusResponse": { "id": "GoogleCloudChannelV1ListSkuGroupBillableSkusResponse", "description": "Response message for ListSkuGroupBillableSkus.", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListSkuGroupBillableSkusRequest.page_token to obtain that page.", "type": "string" }, "billableSkus": { "items": { "$ref": "GoogleCloudChannelV1BillableSku" }, "description": "The list of billable SKUs in the requested SKU group.", "type": "array" } } }, "GoogleCloudChannelV1ProvisionedService": { "id": "GoogleCloudChannelV1ProvisionedService", "description": "Service provisioned for an entitlement.", "type": "object", "properties": { "productId": { "readOnly": true, "description": "Output only. The product pertaining to the provisioning resource as specified in the Offer.", "type": "string" }, "skuId": { "readOnly": true, "description": "Output only. The SKU pertaining to the provisioning resource as specified in the Offer.", "type": "string" }, "provisioningId": { "readOnly": true, "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.", "type": "string" } } }, "GoogleCloudChannelV1ActivateEntitlementRequest": { "id": "GoogleCloudChannelV1ActivateEntitlementRequest", "description": "Request message for CloudChannelService.ActivateEntitlement.", "type": "object", "properties": { "requestId": { "description": "Optional. You can specify an optional unique request ID, and if you need to retry your request, the server will know to ignore the request if it's complete. For example, you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if it received the original operation with the same request ID. If it did, it will ignore the second request. The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported (`00000000-0000-0000-0000-000000000000`).", "type": "string" } } }, "GoogleCloudChannelV1SubscriberEvent": { "description": "Represents information which resellers will get as part of notification from Pub/Sub.", "type": "object", "properties": { "customerEvent": { "$ref": "GoogleCloudChannelV1CustomerEvent", "description": "Customer event sent as part of Pub/Sub event to partners." }, "entitlementEvent": { "$ref": "GoogleCloudChannelV1EntitlementEvent", "description": "Entitlement event sent as part of Pub/Sub event to partners." } }, "id": "GoogleCloudChannelV1SubscriberEvent" }, "GoogleCloudChannelV1alpha1SubscriberEvent": { "id": "GoogleCloudChannelV1alpha1SubscriberEvent", "description": "Represents information which resellers will get as part of notification from Pub/Sub.", "type": "object", "properties": { "channelPartnerEvent": { "$ref": "GoogleCloudChannelV1alpha1ChannelPartnerEvent", "description": "Channel Partner event sent as part of Pub/Sub event to partners." }, "customerEvent": { "description": "Customer event sent as part of Pub/Sub event to partners.", "$ref": "GoogleCloudChannelV1alpha1CustomerEvent" }, "entitlementEvent": { "$ref": "GoogleCloudChannelV1alpha1EntitlementEvent", "description": "Entitlement event sent as part of Pub/Sub event to partners." }, "opportunityEvent": { "$ref": "GoogleCloudChannelV1alpha1OpportunityEvent", "description": "Opportunity event sent as part of Pub/Sub event to partners/integrators." } } }, "GoogleCloudChannelV1Plan": { "id": "GoogleCloudChannelV1Plan", "description": "The payment plan for the Offer. Describes how to make a payment.", "type": "object", "properties": { "trialPeriod": { "description": "Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period.", "$ref": "GoogleCloudChannelV1Period" }, "billingAccount": { "description": "Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers.", "type": "string" }, "paymentType": { "description": "Specifies when the payment needs to happen.", "type": "string", "enumDescriptions": [ "Not used.", "Prepay. Amount has to be paid before service is rendered.", "Postpay. Reseller is charged at the end of the Payment cycle." ], "enum": [ "PAYMENT_TYPE_UNSPECIFIED", "PREPAY", "POSTPAY" ] }, "paymentPlan": { "description": "Describes how a reseller will be billed.", "type": "string", "enumDescriptions": [ "Not used.", "Commitment.", "No commitment.", "Free.", "Trial.", "Price and ordering not available through API." ], "enum": [ "PAYMENT_PLAN_UNSPECIFIED", "COMMITMENT", "FLEXIBLE", "FREE", "TRIAL", "OFFLINE" ] }, "paymentCycle": { "$ref": "GoogleCloudChannelV1Period", "description": "Describes how frequently the reseller will be billed, such as once per month." } } }, "GoogleCloudChannelV1CloudIdentityCustomerAccount": { "description": "Entity representing a Cloud Identity account that may be associated with a Channel Services API partner.", "type": "object", "properties": { "customerCloudIdentityId": { "description": "If existing = true, the Cloud Identity ID of the customer.", "type": "string" }, "channelPartnerCloudIdentityId": { "description": "If existing = true, and is 2-tier customer, the channel partner of the customer.", "type": "string" }, "owned": { "description": "Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner (with active subscriptions or purchase consents).", "type": "boolean" }, "customerType": { "description": "If existing = true, the type of the customer.", "type": "string", "enumDescriptions": [ "Not used.", "Domain-owning customer which needs domain verification to use services.", "Team customer which needs email verification to use services." ], "enum": [ "CUSTOMER_TYPE_UNSPECIFIED", "DOMAIN", "TEAM" ] }, "existing": { "description": "Returns true if a Cloud Identity account exists for a specific domain.", "type": "boolean" }, "customerName": { "description": "If owned = true, the name of the customer that owns the Cloud Identity account. Customer_name uses the format: accounts/{account_id}/customers/{customer_id}", "type": "string" } }, "id": "GoogleCloudChannelV1CloudIdentityCustomerAccount" }, "GoogleCloudChannelV1alpha1Report": { "id": "GoogleCloudChannelV1alpha1Report", "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.", "properties": { "displayName": { "description": "A human-readable name for this report.", "type": "string" }, "description": { "description": "A description of other aspects of the report, such as the products it supports.", "type": "string" }, "name": { "description": "Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, `613bf59q`). Name uses the format: accounts/{account_id}/reports/{report_id}", "type": "string" }, "columns": { "description": "The list of columns included in the report. This defines the schema of the report results.", "type": "array", "items": { "$ref": "GoogleCloudChannelV1alpha1Column" } } }, "deprecated": true, "type": "object" }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleCloudChannelV1Column": { "deprecated": true, "type": "object", "id": "GoogleCloudChannelV1Column", "description": "The definition of a report column. Specifies the data properties in the corresponding position of the report rows.", "properties": { "displayName": { "description": "The column's display name.", "type": "string" }, "columnId": { "description": "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.", "type": "string" }, "dataType": { "enumDescriptions": [ "Not used.", "ReportValues for this column will use string_value.", "ReportValues for this column will use int_value.", "ReportValues for this column will use decimal_value.", "ReportValues for this column will use money_value.", "ReportValues for this column will use date_value.", "ReportValues for this column will use date_time_value." ], "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING", "INT", "DECIMAL", "MONEY", "DATE", "DATE_TIME" ], "description": "The type of the values for this column.", "type": "string" } } }, "GoogleCloudChannelV1CustomerRepricingConfig": { "description": "Configuration for how a reseller will reprice a Customer.", "type": "object", "properties": { "updateTime": { "description": "Output only. Timestamp of an update to the repricing rule. If `update_time` is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month.", "type": "string", "readOnly": true, "format": "google-datetime" }, "repricingConfig": { "description": "Required. The configuration for bill modifications made by a reseller before sending it to customers.", "$ref": "GoogleCloudChannelV1RepricingConfig" }, "name": { "description": "Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.", "type": "string", "readOnly": true } }, "id": "GoogleCloudChannelV1CustomerRepricingConfig" }, "GoogleCloudChannelV1alpha1AssociationInfo": { "id": "GoogleCloudChannelV1alpha1AssociationInfo", "description": "Association links that an entitlement has to other entitlements.", "type": "object", "properties": { "baseEntitlement": { "description": "The name of the base entitlement, for which this entitlement is an add-on.", "type": "string" } } } }, "revision": "20260504", "protocol": "rest" }