REST Resource: brands.agents

Ressource : Agent

Entité de conversation qui représente une marque.

Représentation JSON 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  }
  // End of list of possible types for union field detail_info.
}
Champs
name

string

Identifiant unique de l'agent.

Lecture seule. Définie par la plate-forme.
displayName

string

Obligatoire. Nom que l'agent affiche aux utilisateurs. 100 caractères au maximum.

Non modifiable après la validation de l'agent.

Champ d'union detail_info. Contient les champs obligatoires pour le produit concerné.

Obligatoire. detail_info ne peut être qu'un des éléments suivants :
businessMessagesAgent

object (BusinessMessagesAgent)

Informations détaillées sur l'agent pour Business Messages.

BusinessMessagesAgent

Informations sur l'agent spécifiques à Business Messages.

Représentation JSON 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
Champs
logoUrl

string

Facultatif. URL publiquement accessible du logo de l'agent. 50 Ko maximum.

Non modifiable après la validation de l'agent.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Facultatif. Liste des configurations de points d'entrée.

Non modifiable après la validation de l'agent.
conversationalSettings

map (key: string, value: object (ConversationalSetting))

Obligatoire. Paramètres de conversation d'un agent, mappés sur des paramètres régionaux. Les paramètres régionaux sont représentés par une balise de langue IETF BCP 47 bien structurée.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Obligatoire. Paramètres régionaux par défaut de l'agent. Doit correspondre à des paramètres régionaux définis dans conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Obligatoire. Informations sur l'interaction avec l'agent principal. Utilisé lorsque l'utilisateur initie une conversation.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Facultatif. Informations supplémentaires sur les interactions avec l'agent. Permet à l'agent de prendre en charge plusieurs types d'interaction.
customAgentId

string

Facultatif. Identifiant spécifié par le partenaire pour l'agent. L'identifiant est transmis avec tous les messages envoyés à l'agent.
agentTestUrl
(deprecated)

string

Uniquement en sortie. URL permettant de tester l'expérience de conversation de l'agent.

Définie par la plate-forme.
testUrls[]

object (TestUrl)

Uniquement en sortie. URL permettant de tester l'expérience de conversation de l'agent.

Définie par la plate-forme.
phone

object (Phone)

Facultatif. Numéro de téléphone de l'agent à afficher. S'il n'est pas spécifié, l'agent affiche le numéro de téléphone de la marque figurant dans le Google Knowledge Graph, le cas échéant.
authorizationConfig

object (AuthorizationConfig)

Facultatif. Configuration de l'autorisation pour la prise en charge d'OAuth.
nonLocalConfig

object (NonLocalConfig)

Facultatif. Configuration pour les points d'entrée non locaux.
surveyConfig

object (SurveyConfig)

Facultatif. Configuration permettant d'activer les enquêtes personnalisées.

BusinessMessagesEntryPointConfig

Configuration du point d'entrée d'un agent.

Représentation JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Champs
allowedEntryPoint

enum (EntryPoint)

Obligatoire. Surface Google sur laquelle l'agent est activé.

EntryPoint

Surface Google sur laquelle l'agent est activé.

Enums
ENTRY_POINT_UNSPECIFIED Point d'entrée non spécifié.
LOCATION Activez les emplacements pour cet agent.
NON_LOCAL Activez Business Messages pour les points d'entrée non locaux.

SupportedAgentInteraction

Interactions acceptées par un agent.

Représentation JSON 
{
  "interactionType": enum (InteractionType),

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
Champs
interactionType

enum (InteractionType)

Obligatoire. Type d'interaction accepté par l'agent.
Champ d'union representative. Informations détaillées sur le type de configuration. Obligatoire. representative ne peut être qu'un des éléments suivants :
botRepresentative

object (BotRepresentative)

Détails du représentant du bot.
humanRepresentative

object (HumanRepresentative)

Détails relatifs au représentant humain

InteractionType

Type d'interaction compatible avec l'agent.

Enums
INTERACTION_TYPE_UNSPECIFIED Interaction non spécifiée.
BOT Interaction du bot.
HUMAN Interaction humaine.

BotRepresentative

Détails pour le représentant du bot.

Représentation JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Champs
botMessagingAvailability

object (MessagingAvailability)

Obligatoire. Disponibilité de la messagerie des bots.

MessagingAvailability

Heures de chaque jour de la semaine pendant lesquelles l'option Messages est disponible. Vous pouvez regrouper les heures de plusieurs jours. Exemples : * 08:00-16:00 PDT du lundi au mercredi * 10:00-14:00 PDT du jeudi au vendredi * 15:00 – 18:00 PDT du jeudi au vendredi * 10:00-14:00 PDT du samedi au samedi

Si des créneaux sont indisponibles (par exemple, aucun créneau n'est précisé le dimanche), vous ne pouvez pas envoyer de messages à ces horaires.

Ces horaires n'ont aucune incidence sur la disponibilité. Les agents "bot uniquement" affichent toujours un message de bienvenue, tandis que les agents avec des paramètres "humains" et "représentatifs de bots" ne prennent en compte que les représentants humains lorsqu'ils définissent la disponibilité.

Représentation JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Champs
hours[]

object (Hours)

Obligatoire. Heures de disponibilité de l'option Messages.

Heures

Période (en heures) pendant laquelle l'option Messages est disponible.

Représentation JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Champs
startTime

object (TimeOfDay)

Obligatoire. Heure de début de chaque jour de la plage du jour de la semaine.
endTime

object (TimeOfDay)

Obligatoire. Heure de fin de chaque jour de la plage du jour de la semaine.
timeZone

string

Obligatoire. Fuseau horaire de l'IANA pour les heures. Par exemple, "America/Los_Angeles".
startDay

enum (DayOfWeek)

Obligatoire. Jour de début.
endDay

enum (DayOfWeek)

Obligatoire. Date de fin. Inclut le jour spécifié.

TimeOfDay

Représente une heure de la journée. La date et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. Une API peut choisir d'autoriser des secondes intercalaires. Les types associés sont google.type.Date et google.protobuf.Timestamp.

Représentation JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Champs
hours

integer

Heure de la journée au format 24 heures. Elle doit être comprise entre 0 à 23. Une API peut choisir d'autoriser la valeur "24:00:00" pour des cas tels que l'heure de fermeture des bureaux.
minutes

integer

Minutes de l'heure de la journée. Elles doivent être comprises entre 0 à 59.
seconds

integer

Secondes de l'heure de la journée. Elles doivent normalement être comprises entre 0 et 59. Une API peut autoriser la valeur 60 si elle autorise les secondes intercalaires.
nanos

integer

Fractions de secondes en nanosecondes. La valeur doit être comprise entre 0 et 999 999 999.

DayOfWeek

Représente un jour de la semaine.

Enums
DAY_OF_WEEK_UNSPECIFIED Le jour de la semaine n'est pas spécifié.
MONDAY Lundi
TUESDAY Mardi
WEDNESDAY Mercredi
THURSDAY Jeudi
FRIDAY Vendredi
SATURDAY Samedi
SUNDAY Dimanche

HumanRepresentative

Détails pour le représentant humain.

Représentation JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Champs
humanMessagingAvailability

object (MessagingAvailability)

Obligatoire. Disponibilité de la messagerie humaine.

AuthorizationConfig

Informations sur la configuration permettant de prendre en charge OAuth dans Business Messages.

Représentation JSON 
{
  "endpointUrl": string
}
Champs
endpointUrl

string

URL du point de terminaison auquel l'utilisateur se connecte.

NonLocalConfig

Configuration permettant d'activer les points d'entrée non locaux.

Représentation JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Champs
contactOption

object (ContactOption)

Obligatoire. Coordonnées de l'agent qui s'affichent lorsque l'utilisateur clique sur le bouton "Nous contacter".
enabledDomains[]

string

Obligatoire. Domaines à activer pour le point d'entrée des liens annexes.
phoneNumber

object (Phone)

Obligatoire. Numéro de téléphone de l'agent. Ignore le champ phone pour les conversations démarrées à partir de points d'entrée non locaux. Ce numéro de téléphone sera utilisé pour toutes les régions configurées.
callDeflectionPhoneNumbers[]

object (Phone)

Obligatoire. Liste des numéros de téléphone pour la redirection d'appel.
regionCodes[]

string

Obligatoire. Liste des codes régionaux CLDR des pays où l'agent est autorisé à lancer les points d'entrée NON_LOCAL. Obligatoire pour les points d'entrée NON_LOCAL.

ContactOption

Coordonnées affichées en plus du bouton de messagerie

Représentation JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Champs
url

string

Obligatoire. URL pour laquelle les options de contact sont disponibles.
options[]

enum (Option)

Obligatoire. Liste des options de contact disponibles pour l'URL spécifiée.

Option

Options de contact.

Enums
OPTION_UNSPECIFIED Non spécifié
WEB_CHAT Option de chat Web.
PHONE Option par téléphone.
EMAIL Option "E-mail".
FAQS Option FAQ.
TWITTER Option Twitter.
WHATSAPP Option WhatsApp.

SurveyConfig

Détails de la configuration permettant de prendre en charge les questions d'enquête personnalisées.

Représentation JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Champs
templateQuestionIds[]

string

Liste des ID des modèles de questions inclus dans une enquête.
customSurveys

map (key: string, value: object (CustomSurveyConfig))

Questions d'enquête personnalisées pour un agent, mappées sur des paramètres régionaux. Les paramètres régionaux sont représentés par une balise de langue IETF BCP 47 bien structurée.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Configuration d'enquête personnalisée pour un agent.

Représentation JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Champs
customQuestions[]

object (SurveyQuestion)

Liste de questions personnalisées.

SurveyQuestion

Le contenu détaillé de chaque question de l'enquête.

Représentation JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Champs
name

string

Obligatoire. Identifiant unique de la question.
questionType

enum (Type)

Uniquement en sortie. Type de question.
questionContent

string

Obligatoire. Contenu des questions. 200 caractères maximum pour les questions personnalisées.
responseOptions[]

object (SurveyResponse)

Obligatoire. Liste de réponses affichée avec la question. 12 maximum

Type

Type de question de l'enquête.

Enums
TYPE_UNSPECIFIED Type de question de l'enquête inconnu.
GOOGLE_STANDARD_QUESTION Question d'enquête standard de Google.
GOOGLE_TEMPLATE_QUESTION Modèle de question d'enquête fourni par Google.
PARTNER_CUSTOM_QUESTION Question d'enquête personnalisée par le partenaire.

SurveyResponse

Contenu d'une réponse à une question d'enquête

Représentation JSON 
{
  "content": string,
  "postbackData": string
}
Champs
content

string

Obligatoire. Texte affiché dans l'enquête et renvoyé à l'agent lorsque l'utilisateur appuie dessus. 35 caractères maximum.
postbackData

string

Chaîne que l'agent reçoit lorsque l'utilisateur appuie sur la réponse à la question.

Méthodes

create

 Crée un agent pour représenter une marque.

delete

 Supprime un agent.

get

 Obtenez des informations sur un agent.

getLaunch

 Récupère les informations de lancement d'un agent.

getVerification

 Récupère les informations de validation d'un agent.

list

 Affiche la liste de tous les agents associés à une marque.

patch

 Met à jour les informations concernant un agent.

requestLaunch

 Démarre le processus de lancement d'un agent.

requestVerification

 Démarre la validation des informations sur l'établissement pour un agent.

updateLaunch

 Met à jour les informations de lancement d'un agent.

updateVerification

 Met à jour l'état de validation d'un agent.