Business Communications

  • The businesscommunications.googleapis.com service is used for managing business communications, including brands, agents, locations, and partners.

  • Using Google-provided samples is recommended for calling this service, but custom libraries can also be used with the provided API request information.

  • The service provides a Discovery Document and a service endpoint (https://businesscommunications.googleapis.com) for API interaction.

  • Various REST resources are available for managing different aspects of business communications, including creating, deleting, getting, listing, and patching data for brands, agents, locations, and partners.

  • There is also a resource to list Google predefined survey questions.

Service: businesscommunications.googleapis.com

To call this service, we recommend that you use the Google-provided samples. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://businesscommunications.googleapis.com

REST Resource: v1.brands

Methods
create POST /v1/brands
Creates a new brand.
delete DELETE /v1/{name=brands/*}
Deletes a brand.
get GET /v1/{name=brands/*}
Gets information about a brand.
list GET /v1/brands
Lists all the brands accessible to the user making the request.
patch PATCH /v1/{brand.name=brands/*}
Updates information about a brand.

REST Resource: v1.brands.agents

Methods
create POST /v1/{parent=brands/*}/agents
Creates a new agent to represent a brand.
delete DELETE /v1/{name=brands/*/agents/*}
Deletes an agent.
get GET /v1/{name=brands/*/agents/*}
Get information about an agent.
getLaunch GET /v1/{name=brands/*/agents/*/launch}
Gets the launch information for an agent.
getVerification GET /v1/{name=brands/*/agents/*/verification}
Gets the verification information for an agent.
list GET /v1/{parent=brands/*}/agents
Lists all the agents associated with a brand.
patch PATCH /v1/{agent.name=brands/*/agents/*}
Updates information about an agent.
requestLaunch POST /v1/{name=brands/*/agents/*}:requestLaunch
Begins the launch process for an agent.
requestVerification POST /v1/{name=brands/*/agents/*}:requestVerification
Begins business information verification for an agent.
updateLaunch PATCH /v1/{agentLaunch.name=brands/*/agents/*/launch}
Updates the launch information for an agent.
updateVerification PATCH /v1/{agentVerification.name=brands/*/agents/*/verification}
Updates the verification state for an agent.

REST Resource: v1.brands.agents.integrations

Methods
create POST /v1/{parent=brands/*/agents/*}/integrations
Create an integration.
delete DELETE /v1/{name=brands/*/agents/*/integrations/*}
Delete an integration.
get GET /v1/{name=brands/*/agents/*/integrations/*}
Get an integration.
list GET /v1/{parent=brands/*/agents/*}/integrations
List integrations.
patch PATCH /v1/{integration.name=brands/*/agents/*/integrations/*}
Update an integration.

REST Resource: v1.brands.locations

Methods
create POST /v1/{parent=brands/*}/locations
Creates a new location for a brand.
delete DELETE /v1/{name=brands/*/locations/*}
Deletes a location.
get GET /v1/{name=brands/*/locations/*}
Get information about a location.
getLaunch GET /v1/{name=brands/*/locations/*/launch}
Gets the launch information for a location.
getVerification GET /v1/{name=brands/*/locations/*/verification}
Gets the verification information for a location.
list GET /v1/{parent=brands/*}/locations
Lists all the locations for a brand.
patch PATCH /v1/{location.name=brands/*/locations/*}
Updates information about a location.
requestLaunch POST /v1/{name=brands/*/locations/*}:requestLaunch
Begins the launch process for a location.
requestVerification POST /v1/{name=brands/*/locations/*}:requestVerification
Begins verification for a location.
updateLaunch PATCH /v1/{locationLaunch.name=brands/*/locations/*/launch}
Updates the launch information for a location.

REST Resource: v1.partners

Methods
get GET /v1/{name=partners/*}
Get the information about the partner.
patch PATCH /v1/{partner.name=partners/*}
Updates the information for a partner.

REST Resource: v1.surveyQuestions

Methods
list GET /v1/surveyQuestions
Lists all Google predefined survey questions.