REST Resource: brands.agents.integrations

Ressource: Intégration

Informations sur l'intégration.

Représentation JSON 
{
  "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.
}
Champs
name

string

Uniquement en sortie. Identifiant unique de l'intégration. Lecture seule. Définie par la plate-forme.
status

enum (IntegrationStatus)

Uniquement en sortie. État de l'intégration.
Champ d'union integration_info. Informations détaillées sur l'intégration. integration_info ne peut être qu'un des éléments suivants :
dialogflowEsIntegration

object (DialogflowEsIntegration)

Informations sur un projet Dialogflow ES associé. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Informations sur un projet Dialogflow CX associé. https://cloud.google.com/dialogflow/cx/docs/basics

IntegrationStatus

États d'intégration

Enums
INTEGRATION_STATUS_UNSPECIFIED L'état de l'intégration n'est pas spécifié.
ENABLED Activé
DISABLED Désactivée.

DialogflowEsIntegration

Informations sur un agent Business Messages et l'association de projet Dialogflow ES.

Représentation JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Champs
dialogflowProjectId

string

Obligatoire. ID du projet Dialogflow.

Non modifiable. Pour modifier cette valeur, vous devez supprimer le projet Dialogflow de cet agent, puis créer une intégration.
autoResponseStatus

enum (AutoResponseStatus)

Obligatoire. Si la valeur est ENABLED, Business Messages envoie automatiquement les réponses Dialogflow aux utilisateurs.
dialogflowServiceAccountEmail

string

Uniquement en sortie. Compte de service qui doit être configuré dans le projet Dialogflow avec les rôles "Éditeur d'agent de la console Dialogflow" et "Client de l'API Dialogflow". Cette étape est nécessaire pour fournir l'accès à l'API Dialogflow.
operationInfo

object (OperationInfo)

Uniquement en sortie. Informations sur l'état de fonctionnement de l'intégration Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Bases de connaissances associées au projet Dialogflow

Facultatif

AutoResponseStatus

État de la réponse automatique Dialogflow.

Enums
AUTO_RESPONSE_STATUS_UNSPECIFIED La réponse automatique n'est pas spécifiée.
ENABLED La réponse automatique est activée.
DISABLED La réponse automatique est désactivée.

OperationInfo

Informations sur l'opération Dialogflow.

Représentation JSON 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Champs
operationName

string

Uniquement en sortie. Nom attribué par le serveur (ID d'opération), qui est unique au sein du service qui le renvoie initialement.
operationType

enum (OperationType)

Uniquement en sortie. Type d'opération Dialogflow.
operationState

enum (OperationState)

Uniquement en sortie. État de l'opération Dialogflow.
error

object (Status)

Uniquement en sortie. Résultat de l'erreur, le cas échéant.

OperationType

Types d'opérations Dialogflow.

Enums
OPERATION_TYPE_UNSPECIFIED Type non spécifié.
ASSOCIATE_DIALOGFLOW Associer Dialogflow
DISSOCIATE_DIALOGFLOW Dissociez Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Ajout du document à la base de connaissances.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Supprimer le document de la base de connaissances.

OperationState

États des opérations dans Dialogflow.

Enums
OPERATION_STATE_UNSPECIFIED État non spécifié.
PROCESSING Traitement en cours.
COMPLETED Terminé.
FAILED Échec.

État

Le type Status définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.

Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.

Représentation JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Champs
code

integer

Code d'état, qui doit être une valeur d'énumération de google.rpc.Code.
message

string

Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details, ou localisé par le client.
details[]

object

Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Informations de la base de connaissances. Une base de connaissances peut comporter plusieurs URL de questions fréquentes.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Champs
name

string

Uniquement en sortie. ID de la base de connaissances.

Identifiant unique renvoyé par le service Dialogflow après la création d'une base de connaissances. Si l'identifiant de marque est "1234", l'identifiant d'agent est "5678", l'identifiant d'intégration est "9092" et l'identifiant de la base de connaissances est "1111", ce paramètre est résolu en "brands/1234/agents/5678/integrations/9092/knowledgebases/1111".
displayName

string

Obligatoire. Nom à afficher de la base de connaissances.
documents[]

object (DialogflowDocument)

Documents de la base de connaissances.

Facultatif
updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la base de connaissances a été créée ou mise à jour.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Document de la base de connaissances. Il peut s'agir d'une URL de site Web ou d'une URL de fichier CSV. Les URL doivent être accessibles au public. Les fichiers CSV doivent contenir une ou plusieurs paires question/réponse, avec une ligne par paire.

Représentation JSON 
{
  "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.
}
Champs
name

string

ID du document généré par le système

Si l'identifiant de marque est "1234", l'identifiant de l'agent est "5678", l'identifiant d'intégration est "9092", l'identifiant de la base de connaissances est "1111" et l'identifiant du document est "2222", ce paramètre est résolu en "brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222".
displayName

string

Obligatoire. Nom à afficher d'un document de FAQ.
updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le document a été créé/mis à jour.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Uniquement en sortie. Les informations sur les opérations ne sont renseignées que lorsqu'un document est ajouté à une base de connaissances existante.
Champ d'union content. Contenu du document. content ne peut être qu'un des éléments suivants :
faqUrl

string

URL d'un document de FAQ.
rawContent

string (bytes format)

Contenu brut du document.

Chaîne encodée en base64.

DialogflowCxIntegration

Informations sur un agent Business Messages et l'association de projet Dialogflow CX.

Représentation JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Champs
dialogflowProjectId

string

Obligatoire. ID du projet Dialogflow.

Non modifiable. Pour modifier cette valeur, vous devez supprimer le projet Dialogflow de cet agent, puis créer une intégration.
dialogflowAgentId

string

Obligatoire. ID de l'agent Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

Obligatoire. Si la valeur est ENABLED, Business Messages envoie automatiquement les réponses Dialogflow aux utilisateurs.
dialogflowServiceAccountEmail

string

Uniquement en sortie. Compte de service qui doit être configuré dans le projet Dialogflow avec les rôles "Éditeur d'agent de la console Dialogflow" et "Client de l'API Dialogflow". Cette étape est nécessaire pour fournir l'accès à l'API Dialogflow.
operationInfo

object (OperationInfo)

Uniquement en sortie. Informations sur l'état de fonctionnement de l'intégration Dialogflow.

Méthodes

create

 Créez une intégration.

delete

 Supprimer une intégration

get

 obtenir une intégration ;

list

 Listez les intégrations.

patch

 Mettre à jour une intégration