Updates: Check the release notes for new features and product updates.

REST Resource: brands.agents.integrations

Stay organized with collections Save and categorize content based on your preferences.

Resource: Integration

Information about the integration.

JSON representation
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  }
  // End of list of possible types for union field integration_info.
}
Fields
name

string

Output only. The unique identifier of the integration. Read-only. Defined by the platform.

status

enum (IntegrationStatus)

Output only. Integration status.

Union field integration_info. Detailed information for the integration. integration_info can be only one of the following:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Information about an associated Dialogflow ES project. https://cloud.google.com/dialogflow/es/docs

dialogflowCxIntegration

object (DialogflowCxIntegration)

Information about an associated Dialogflow CX project. https://cloud.google.com/dialogflow/cx/docs/basics

IntegrationStatus

Integration statuses.

Enums
INTEGRATION_STATUS_UNSPECIFIED Integration status is unspecified.
ENABLED Enabled.
DISABLED Disabled.

DialogflowEsIntegration

Information about a Business Messages agent and Dialogflow ES project association.

JSON representation
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Fields
dialogflowProjectId

string

Required. The Dialogflow project ID.

Non-editable. To change this value, you must delete the Dialogflow project from this agent, then create a new integration.

autoResponseStatus

enum (AutoResponseStatus)

Required. If ENABLED, Business Messages automatically sends the Dialogflow responses to users.

dialogflowServiceAccountEmail

string

Output only. The service account that must be configured in the Dialogflow project with the "Dialogflow Console Agent Editor" and "Dialogflow API Client" roles. This is required to provide access to the Dialogflow API.

operationInfo

object (OperationInfo)

Output only. Information about the operating state of the Dialogflow integration.

dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Knowledge bases associated with the Dialogflow project.

Optional

AutoResponseStatus

Dialogflow auto-response status.

Enums
AUTO_RESPONSE_STATUS_UNSPECIFIED Auto-response is unspecified.
ENABLED Auto-response is enabled.
DISABLED Auto-response is disabled.

OperationInfo

The Dialogflow operation information.

JSON representation
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Fields
operationName

string

Output only. The server-assigned name (operation Id), which is only unique within the same service that originally returns it.

operationType

enum (OperationType)

Output only. Dialogflow Operation type.

operationState

enum (OperationState)

Output only. Dialogflow Operation state.

error

object (Status)

Output only. Error result, if any.

OperationType

Dialogflow operation types.

Enums
OPERATION_TYPE_UNSPECIFIED Unspecified type.
ASSOCIATE_DIALOGFLOW Associate Dialogflow.
DISSOCIATE_DIALOGFLOW Dissociate Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Add document to knowledge base.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Delete document from knowledge base.

OperationState

Statuses of operation in Dialogflow.

Enums
OPERATION_STATE_UNSPECIFIED Unspecified state.
PROCESSING Processing.
COMPLETED Completed.
FAILED Failed.

Status

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

JSON representation
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Fields
code

integer

The status code, which should be an enum value of google.rpc.Code.

message

string

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.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Knowledge base information. A knowledge base can have multiple FAQ URLs.

JSON representation
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Fields
name

string

Output only. Knowledgebase ID.

Unique identifier returned by Dialogflow service after creation of a knowledge base. If the brand identifier is "1234", the agent identifier is "5678", the integration identifier is "9092", and the knowledge base identifier is "1111", this parameter resolves to "brands/1234/agents/5678/integrations/9092/knowledgebases/1111".

displayName

string

Required. Knowledge base display name.

documents[]

object (DialogflowDocument)

Knowledge base documents.

Optional

updateTime

string (Timestamp format)

Output only. Time at which the knowledge base was created or updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

A knowledge base document. A document can be either a website URL or a URL to a CSV file. URLs must be publicly available. CSV files must contain one or more question/answer pairs, with one row for each pair.

JSON representation
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
Fields
name

string

System-generated Document ID.

If the brand identifier is "1234", the agent identifier is "5678", the integration identifier is "9092", the knowledge base identifier is "1111", and the document identifier is "2222", this parameter resolves to "brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222".

displayName

string

Required. Display name of a FAQ document.

updateTime

string (Timestamp format)

Output only. Time at which the document was created/updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

operationInfo

object (OperationInfo)

Output only. Operation Information is populated only when a document is added to an existing knowledge base.

Union field content. Content of the document. content can be only one of the following:
faqUrl

string

URL of a FAQ document.

rawContent

string (bytes format)

The raw content of the document.

A base64-encoded string.

DialogflowCxIntegration

Information about a Business Messages agent and Dialogflow CX project association.

JSON representation
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Fields
dialogflowProjectId

string

Required. The Dialogflow project ID.

Non-editable. To change this value, you must delete the Dialogflow project from this agent, then create a new integration.

dialogflowAgentId

string

Required. The Dialogflow Agent ID.

autoResponseStatus

enum (AutoResponseStatus)

Required. If ENABLED, Business Messages automatically sends the Dialogflow responses to users.

dialogflowServiceAccountEmail

string

Output only. The service account that must be configured in the Dialogflow project with the "Dialogflow Console Agent Editor" and "Dialogflow API Client" roles. This is required to provide access to the Dialogflow API.

operationInfo

object (OperationInfo)

Output only. Information about the operating state of the Dialogflow integration.

Methods

create

Create an integration.

delete

Delete an integration.

get

Get an integration.

list

List integrations.

patch

Update an integration.