Cloud Channel API (cloudchannel:v1)

2024-09-11

2 new methods | 2 removed methods

Additions

    Methods
  • cloudchannel.integrators.registerSubscriber

      Path: v1/{+integrator}:registerSubscriber

      Flat Path: v1/integrators/{integratorsId}:registerSubscriber

      HTTP Method: POST

      Parameters:

        integrator

          Description: Optional. Resource name of the integrator.

          Pattern: ^integrators/[^/]+$

          Location: path

          Required: Yes

          Type: string

        account

          Description: Optional. Resource name of the account.

          Location: query

          Type: string

        serviceAccount

          Description: Required. Service account that provides subscriber access to the registered topic.

          Location: query

          Type: string

      Parameter Order: integrator

      Scopes: https://www.googleapis.com/auth/apps.order

      Description: 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.

  • cloudchannel.integrators.unregisterSubscriber

      Path: v1/{+integrator}:unregisterSubscriber

      Flat Path: v1/integrators/{integratorsId}:unregisterSubscriber

      HTTP Method: POST

      Parameters:

        integrator

          Description: Optional. Resource name of the integrator.

          Pattern: ^integrators/[^/]+$

          Location: path

          Required: Yes

          Type: string

        account

          Description: Optional. Resource name of the account.

          Location: query

          Type: string

        serviceAccount

          Description: Required. Service account to unregister from subscriber access to the topic.

          Location: query

          Type: string

      Parameter Order: integrator

      Scopes: https://www.googleapis.com/auth/apps.order

      Description: 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.

Deletions

    Methods
  • cloudchannel.integrators.register

      Path: v1/{+integrator}:register

      Flat Path: v1/integrators/{integratorsId}:register

      HTTP Method: POST

      Parameters:

        integrator

          Description: Optional. Resource name of the integrator.

          Pattern: ^integrators/[^/]+$

          Location: path

          Required: Yes

          Type: string

        account

          Description: Optional. Resource name of the account.

          Location: query

          Type: string

        serviceAccount

          Description: Required. Service account that provides subscriber access to the registered topic.

          Location: query

          Type: string

      Parameter Order: integrator

      Scopes: https://www.googleapis.com/auth/apps.order

      Description: 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.

  • cloudchannel.integrators.unregister

      Path: v1/{+integrator}:unregister

      Flat Path: v1/integrators/{integratorsId}:unregister

      HTTP Method: POST

      Parameters:

        integrator

          Description: Optional. Resource name of the integrator.

          Pattern: ^integrators/[^/]+$

          Location: path

          Required: Yes

          Type: string

        account

          Description: Optional. Resource name of the account.

          Location: query

          Type: string

        serviceAccount

          Description: Required. Service account to unregister from subscriber access to the topic.

          Location: query

          Type: string

      Parameter Order: integrator

      Scopes: https://www.googleapis.com/auth/apps.order

      Description: 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.