class Accounts extends Resource (View source)

The "accounts" collection of methods.

Typical usage is:

 $cloudchannelService = new Google\Service\Cloudchannel(...);
 $accounts = $cloudchannelService->accounts;

Methods

checkCloudIdentityAccountsExist(string $parent, GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest $postBody, array $optParams = [])

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. (accounts.checkCloudIdentityAccountsExist)

listSubscribers(string $account, array $optParams = [])

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. 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. (accounts.listSubscribers)

listTransferableOffers(string $parent, GoogleCloudChannelV1ListTransferableOffersRequest $postBody, array $optParams = [])

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.

listTransferableSkus(string $parent, GoogleCloudChannelV1ListTransferableSkusRequest $postBody, array $optParams = [])

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. (accounts.listTransferableSkus)

register(string $account, GoogleCloudChannelV1RegisterSubscriberRequest $postBody, array $optParams = [])

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. 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.

unregister(string $account, GoogleCloudChannelV1UnregisterSubscriberRequest $postBody, array $optParams = [])

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. 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. (accounts.unregister)

Details

GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse checkCloudIdentityAccountsExist(string $parent, GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest $postBody, array $optParams = [])

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. (accounts.checkCloudIdentityAccountsExist)

Parameters

string $parent

Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}

GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1CheckCloudIdentityAccountsExistResponse

Exceptions

Exception

GoogleCloudChannelV1ListSubscribersResponse listSubscribers(string $account, array $optParams = [])

Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. 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. (accounts.listSubscribers)

Parameters

string $account

Optional. Resource name of the account.

array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1ListSubscribersResponse

Exceptions

Exception

GoogleCloudChannelV1ListTransferableOffersResponse listTransferableOffers(string $parent, GoogleCloudChannelV1ListTransferableOffersRequest $postBody, array $optParams = [])

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.

(accounts.listTransferableOffers)

Parameters

string $parent

Required. The resource name of the reseller's account.

GoogleCloudChannelV1ListTransferableOffersRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1ListTransferableOffersResponse

Exceptions

Exception

GoogleCloudChannelV1ListTransferableSkusResponse listTransferableSkus(string $parent, GoogleCloudChannelV1ListTransferableSkusRequest $postBody, array $optParams = [])

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. (accounts.listTransferableSkus)

Parameters

string $parent

Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}

GoogleCloudChannelV1ListTransferableSkusRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1ListTransferableSkusResponse

Exceptions

Exception

GoogleCloudChannelV1RegisterSubscriberResponse register(string $account, GoogleCloudChannelV1RegisterSubscriberRequest $postBody, array $optParams = [])

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. 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.

(accounts.register)

Parameters

string $account

Optional. Resource name of the account.

GoogleCloudChannelV1RegisterSubscriberRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1RegisterSubscriberResponse

Exceptions

Exception

GoogleCloudChannelV1UnregisterSubscriberResponse unregister(string $account, GoogleCloudChannelV1UnregisterSubscriberRequest $postBody, array $optParams = [])

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. 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. (accounts.unregister)

Parameters

string $account

Optional. Resource name of the account.

GoogleCloudChannelV1UnregisterSubscriberRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1UnregisterSubscriberResponse

Exceptions

Exception