REST Resource: brands.agents.integrations

Ressource: Integration

Informationen zur Integration.

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

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

string

Nur Ausgabe Die eindeutige ID der Integration. Schreibgeschützt. Von der Plattform definiert.
status

enum (IntegrationStatus)

Nur Ausgabe Integrationsstatus.
Union-Feld integration_info. Detaillierte Informationen für die Integration. Für integration_info ist nur einer der folgenden Werte zulässig:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Informationen zu einem verknüpften Dialogflow ES-Projekt. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Informationen zu einem verknüpften Dialogflow CX-Projekt. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

Informationen zum Webhook für einen Agent. Wenn ein Webhook auf Agent-Ebene konfiguriert ist, wird der Webhook auf Partnerebene überschrieben.

IntegrationStatus

Integrationsstatus.

Enums
INTEGRATION_STATUS_UNSPECIFIED Integrationsstatus ist nicht angegeben.
ENABLED Aktiviert.
DISABLED Deaktiviert.

DialogflowEsIntegration

Informationen zu einem Business Messages-Agent und einer Dialogflow ES-Projektverknüpfung.

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

string

Erforderlich. Die Dialogflow-Projekt-ID.

Kann nicht bearbeitet werden. Wenn Sie diesen Wert ändern möchten, müssen Sie das Dialogflow-Projekt aus diesem Agent löschen und dann eine neue Integration erstellen.
autoResponseStatus

enum (AutoResponseStatus)

Erforderlich. Wenn ENABLED, sendet Business Messages die Dialogflow-Antworten automatisch an die Nutzer.
dialogflowServiceAccountEmail

string

Nur Ausgabe Das Dienstkonto, das im Dialogflow-Projekt mit den Rollen „Dialogflow Console Agent Editor“ und „Dialogflow API Client“ konfiguriert werden muss. Dies ist erforderlich, um Zugriff auf die Dialogflow API zu gewähren.
operationInfo

object (OperationInfo)

Nur Ausgabe Informationen zum Betriebsstatus der Dialogflow-Integration.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Mit dem Dialogflow-Projekt verknüpfte Wissensdatenbanken.

Optional

AutoResponseStatus

Status der automatischen Antwort von Dialogflow.

Enums
AUTO_RESPONSE_STATUS_UNSPECIFIED Automatische Antwort ist nicht angegeben.
ENABLED Automatische Antworten sind aktiviert.
DISABLED Automatische Antworten sind deaktiviert.

OperationInfo

Die Informationen zum Dialogflow-Vorgang.

JSON-Darstellung 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Felder
operationName

string

Nur Ausgabe Der vom Server zugewiesene Name (Vorgangs-ID), der nur innerhalb des Dienstes eindeutig ist, der sie ursprünglich zurückgibt.
operationType

enum (OperationType)

Nur Ausgabe Dialogflow-Vorgangstyp.
operationState

enum (OperationState)

Nur Ausgabe Dialogflow-Vorgangsstatus.
error

object (Status)

Nur Ausgabe Fehlerergebnis, falls vorhanden.

OperationType

Dialogflow-Vorgangstypen.

Enums
OPERATION_TYPE_UNSPECIFIED Nicht definierter Typ.
ASSOCIATE_DIALOGFLOW Dialogflow verknüpfen.
DISSOCIATE_DIALOGFLOW Dialogflow trennen.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Dokument zur Wissensdatenbank hinzufügen.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Dokument aus der Wissensdatenbank löschen.

OperationState

Betriebsstatus in Dialogflow.

Enums
OPERATION_STATE_UNSPECIFIED Nicht angegebener Zustand.
PROCESSING Wird verarbeitet.
COMPLETED Abgeschlossen.
FAILED Fehlgeschlagen.

Status

Mit dem Typ Status wird ein logisches Fehlermodell definiert, das für verschiedene Programmierumgebungen wie REST APIs und RPC APIs geeignet ist. Dieses Modell wird von gRPC verwendet. Jede Status-Meldung enthält die folgenden drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.

Weitere Informationen zu diesem Fehlermodell und zur Arbeit damit finden Sie in der API-Designanleitung.

JSON-Darstellung 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.
message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede Fehlermeldung an den Nutzer sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.
details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Informationen aus der Wissensdatenbank Eine Wissensdatenbank kann mehrere FAQ-URLs haben.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Felder
name

string

Nur Ausgabe Wissensdatenbank-ID

Eindeutige Kennung, die vom Dialogflow-Dienst nach dem Erstellen einer Wissensdatenbank zurückgegeben wird. Wenn die Marken-ID „1234“, die Agent-ID „5678“, die Integrations-ID „9092“ und die Kennung der Wissensdatenbank „1111“ ist, wird dieser Parameter in „brands/1234/agents/5678/integrations/9092/knowledgebases/1111“ aufgelöst.
displayName

string

Erforderlich. Anzeigename der Wissensdatenbank.
documents[]

object (DialogflowDocument)

Dokumente aus der Wissensdatenbank

Optional
updateTime

string (Timestamp format)

Nur Ausgabe Zeitpunkt, zu dem die Wissensdatenbank erstellt oder aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Ein Wissensdatenbankdokument. Ein Dokument kann entweder eine Website-URL oder eine URL zu einer CSV-Datei sein. URLs müssen öffentlich verfügbar sein. CSV-Dateien müssen ein oder mehrere Frage-Antwort-Paare mit einer Zeile pro Paar enthalten.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Vom System generierte Dokument-ID.

Wenn die Marken-ID „1234“, die Agent-ID „5678“, die Integrations-ID „9092“, die ID der Wissensdatenbank „1111“ und die Dokument-ID „2222“ lautet, wird dieser Parameter in „brands/1234/agents/5678/integrations/9092/knowledgebases/111122“ aufgelöst.
displayName

string

Erforderlich. Anzeigename eines FAQs-Dokuments.
updateTime

string (Timestamp format)

Nur Ausgabe Zeitpunkt, zu dem das Dokument erstellt/aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Nur Ausgabe Vorgangsinformationen werden nur ausgefüllt, wenn ein Dokument einer vorhandenen Wissensdatenbank hinzugefügt wird.
Union-Feld content. Inhalt des Dokuments. Für content ist nur einer der folgenden Werte zulässig:
faqUrl

string

URL eines FAQs-Dokuments.
rawContent

string (bytes format)

Der Rohinhalt des Dokuments.

Ein base64-codierter String.

DialogflowCxIntegration

Informationen zu einem Business Messages-Agent und einer Dialogflow CX-Projektverknüpfung.

JSON-Darstellung 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Felder
dialogflowProjectId

string

Erforderlich. Die Dialogflow-Projekt-ID.

Kann nicht bearbeitet werden. Wenn Sie diesen Wert ändern möchten, müssen Sie das Dialogflow-Projekt aus diesem Agent löschen und dann eine neue Integration erstellen.
dialogflowAgentId

string

Erforderlich. Die Dialogflow-Agent-ID.
autoResponseStatus

enum (AutoResponseStatus)

Erforderlich. Wenn ENABLED, sendet Business Messages die Dialogflow-Antworten automatisch an die Nutzer.
dialogflowServiceAccountEmail

string

Nur Ausgabe Das Dienstkonto, das im Dialogflow-Projekt mit den Rollen „Dialogflow Console Agent Editor“ und „Dialogflow API Client“ konfiguriert werden muss. Dies ist erforderlich, um Zugriff auf die Dialogflow API zu gewähren.
operationInfo

object (OperationInfo)

Nur Ausgabe Informationen zum Betriebsstatus der Dialogflow-Integration.

AgentWebhookIntegration

Informationen zum Webhook für einen Business Messages-Agent.

JSON-Darstellung 
{
  "webhookUri": string,
  "verificationToken": string
}
Felder
webhookUri

string

Erforderlich. Die Webhook-URL, an die die Nachrichten gesendet werden.
verificationToken

string

Nur Eingabe. Das Bestätigungstoken

Methoden

create

 Integration erstellen

delete

 Eine Integration löschen.

get

 Rufen Sie eine Integration ab.

list

 Integrationen auflisten.

patch

 Integration aktualisieren