Google

Cloud Channel API

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,…

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 46

accounts

  • POSTConfirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by…/v1/:parent:checkCloudIdentityAccountsExistConfirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: *…
  • GETLists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or…/v1/:account:listSubscribers?integrator=string&pageSize=0&pageToken=stringLists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: *…
  • POSTList TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request/v1/:parent:listTransferableOffersList TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement…
  • POSTList TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request/v1/:parent:listTransferableSkusList 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…
  • POSTRegisters a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or…/v1/:account:registerRegisters a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber,…
  • POSTUnregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services…/v1/:account:unregisterUnregisters 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.channelPartnerLinks

  • GETList ChannelPartnerLinks belonging to a distributor/v1/:parent/channelPartnerLinks?pageSize=0&pageToken=string&view=UNSPECIFIEDList ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller…
  • POSTInitiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller…/v1/:parent/channelPartnerLinksInitiates 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…

operations

  • GETLists operations that match the specified filter in the request/v1/:name?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
  • DELETEDeletes a long-running operation/v1/:nameDeletes 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…
  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…

accounts.customers.customerRepricingConfigs

  • PATCHUpdates a CustomerRepricingConfig/v1/:nameUpdates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing…
  • GETLists information about how a Reseller modifies their bill before sending it to a Customer/v1/:parent/customerRepricingConfigs?filter=string&pageSize=0&pageToken=stringLists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making…
  • POSTCreates a CustomerRepricingConfig/v1/:parent/customerRepricingConfigsCreates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the…

accounts.channelPartnerLinks.channelPartnerRepricingConfigs

  • GETLists information about how a Reseller modifies their bill before sending it to a ChannelPartner/v1/:parent/channelPartnerRepricingConfigs?filter=string&pageSize=0&pageToken=stringLists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account…
  • POSTCreates a ChannelPartnerRepricingConfig/v1/:parent/channelPartnerRepricingConfigsCreates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the…

accounts.customers

  • GETList Customers/v1/:parent/customers?filter=string&pageSize=0&pageToken=stringList Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.…
  • POSTCreates a new Customer resource under the reseller or distributor account/v1/:parent/customersCreates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: * The reseller account making the…
  • POSTImports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a…/v1/:parent/customers:importImports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer…
  • GETLists the following: * Offers that you can purchase for a customer/v1/:customer:listPurchasableOffers?changeOfferPurchase.billingAccount=string&changeOfferPurchase.entitlement=string&changeOfferPurchase.newSku=string&createEntitlementPurchase.billingAccount=string&createEntitlementPurchase.sku=string&languageCode=string&pageSize=0&pageToken=stringLists the following: * Offers that you can purchase for a customer. * Offers that you can change for an entitlement. Possible error codes: *…
  • GETLists the following: * SKUs that you can purchase for a customer * SKUs that you can upgrade or downgrade for an…/v1/:customer:listPurchasableSkus?changeOfferPurchase.changeType=CHANGE_TYPE_UNSPECIFIED&changeOfferPurchase.entitlement=string&createEntitlementPurchase.product=string&languageCode=string&pageSize=0&pageToken=stringLists the following: * SKUs that you can purchase for a customer * SKUs that you can upgrade or downgrade for an entitlement. Possible error codes: *…
  • POSTCreates a Cloud Identity for the given customer using the customer's information, or the information provided here/v1/:customer:provisionCloudIdentityCreates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED:…
  • GETLists the billing accounts that are eligible to purchase particular SKUs for a given customer/v1/:customer:queryEligibleBillingAccounts?skus=stringLists the billing accounts that are eligible to purchase particular SKUs for a given customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't…
  • POSTTransfers customer entitlements to new reseller/v1/:parent:transferEntitlementsTransfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is…
  • POSTTransfers customer entitlements from their current reseller to Google/v1/:parent:transferEntitlementsToGoogleTransfers customer entitlements from their current reseller to Google. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller.…

accounts.customers.entitlements

  • POSTActivates a previously suspended entitlement/v1/:name:activateActivates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement…
  • POSTUpdates the Offer for an existing customer entitlement/v1/:name:changeOfferUpdates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of…
  • POSTChange parameters of the entitlement/v1/:name:changeParametersChange parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible…
  • POSTUpdates the renewal settings for an existing customer entitlement/v1/:name:changeRenewalSettingsUpdates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a…
  • GETLists Entitlements belonging to a customer/v1/:parent/entitlements?pageSize=0&pageToken=stringLists Entitlements belonging to a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT:…
  • POSTCreates an entitlement for a customer/v1/:parent/entitlementsCreates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not…
  • GETList entitlement history/v1/:parent:listEntitlementChanges?filter=string&pageSize=0&pageToken=stringList entitlement history. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.…
  • GETReturns the requested Offer resource/v1/:entitlement:lookupOfferReturns the requested Offer resource. Possible error codes: * PERMISSION_DENIED: The entitlement doesn't belong to the reseller. * INVALID_ARGUMENT: Required…
  • POSTStarts paid service for a trial entitlement/v1/:name:startPaidServiceStarts 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…
  • POSTSuspends a previously fulfilled entitlement/v1/:name:suspendSuspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: * PERMISSION_DENIED: The customer…

accounts.offers

  • GETLists the Offers the reseller can sell/v1/:parent/offers?filter=string&languageCode=string&pageSize=0&pageToken=string&showFutureOffers=trueLists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

accounts.reportJobs

  • POSTRetrieves data generated by CloudChannelReportsService.RunReportJob/v1/:reportJob:fetchReportResultsRetrieves data generated by CloudChannelReportsService.RunReportJob. Deprecated: Please use Export Channel Services data to BigQuery instead.

accounts.reports

  • GETLists the reports that RunReportJob can run/v1/:parent/reports?languageCode=string&pageSize=0&pageToken=stringLists 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:…
  • POSTBegins generation of data for a given report/v1/:name:runBegins generation of data for a given report. The report identifier is a UID (for example, 613bf59q). Possible error codes: * PERMISSION_DENIED: The user…

accounts.skuGroups

  • GETLists the Rebilling supported SKU groups the account is authorized to sell/v1/:parent/skuGroups?pageSize=0&pageToken=stringLists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups Possible Error Codes: *…

accounts.skuGroups.billableSkus

  • GETLists the Billable SKUs in a given SKU group/v1/:parent/billableSkus?pageSize=0&pageToken=stringLists 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…

integrators

  • GETLists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or…/v1/:integrator:listSubscribers?account=string&pageSize=0&pageToken=stringLists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. Possible error codes: *…
  • POSTRegisters a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or…/v1/:integrator:registerSubscriberRegisters a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator. After you create a subscriber,…
  • POSTUnregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services…/v1/:integrator:unregisterSubscriberUnregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator. If there are no service…

products

  • GETLists the Products the reseller is authorized to sell/v1/products?account=string&languageCode=string&pageSize=0&pageToken=stringLists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

products.skus

  • GETLists the SKUs for a product the reseller is authorized to sell/v1/:parent/skus?account=string&languageCode=string&pageSize=0&pageToken=stringLists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

API details

Base URL
https://cloudchannel.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
46 operations on 39 pathsPOST 25GET 19PATCH 1DELETE 1
Main resources
accounts.customers.entitlements 10accounts.customers 9accounts 6accounts.customers.customerRepricingConfigs 3integrators 3operations 3accounts.channelPartnerLinks 2accounts.channelPartnerLinks.channelPartnerRepricingConfigs 2accounts.reports 2accounts.offers 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Cloud Channel API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Channel API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by…” (POST /v1/:parent:checkCloudIdentityAccountsExist), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Channel API?

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,… It is listed under Developer tools and has 46 endpoints.

Who publishes the Cloud Channel API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Channel API?

Requests go to https://cloudchannel.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Channel API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the Cloud Channel API have?

46 operations on 39 paths (25 POST, 19 GET, 1 PATCH, 1 DELETE). The largest groups are accounts.customers.entitlements, accounts.customers, accounts, accounts.customers.customerRepricingConfigs.

Is forking the Cloud Channel API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.