REST Resource: brands.agents

Ressource : Agent

Entité conversationnelle 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)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // 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 pour les 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.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

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

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 accessible au public 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 à 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 les interactions avec l'agent principal. Utilisé lorsque l'utilisateur entame une conversation.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Facultatif. Informations supplémentaires sur les interactions avec l'agent. Permet à l'agent d'accepter plusieurs types d'interactions.
customAgentId

string

Facultatif. Identifiant de l'agent, spécifié par le partenaire. 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 que l'agent doit afficher. Si vous n'indiquez aucune valeur, l'agent affiche le numéro de téléphone de la marque figurant dans Google Knowledge Graph, le cas échéant.
authorizationConfig

object (AuthorizationConfig)

Facultatif. Configuration de l'autorisation pour l'assistance OAuth.
nonLocalConfig

object (NonLocalConfig)

Facultatif. Configuration pour des 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. Surfaces Google sur lesquelles l'agent est activé pour apparaître.

EntryPoint

Surfaces Google sur lesquelles l'agent est activé pour apparaître.

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 du représentant humain.

InteractionType

Type d'interaction compatible avec l'agent.

Enums
INTERACTION_TYPE_UNSPECIFIED Interaction non spécifiée.
BOT Interaction avec le 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 où la messagerie est disponible. Vous pouvez regrouper les heures de plusieurs jours. Par exemple : * 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

Les messages ne sont pas disponibles s'il y a des écarts de disponibilité (par exemple, si aucune disponibilité le dimanche n'est précisée).

Les horaires des robots n'ont aucune incidence sur la disponibilité. Les agents réservés aux bots affichent toujours un message de bienvenue, tandis que les agents disposant de paramètres de représentation à la fois humain et de bot 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é des messages.

Heures

Période pendant laquelle la messagerie 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 compris dans la plage du jour de la semaine.
timeZone

string

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

enum (DayOfWeek)

Obligatoire. Jour de début.
endDay

enum (DayOfWeek)

Obligatoire. Jour 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 de configuration pour la prise en charge du protocole 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 le transfert d'appel.
regionCodes[]

string

Obligatoire. Liste des codes régionaux du CLDR des pays dans lesquels l'agent est autorisé à lancer des 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ée
WEB_CHAT Chat Web.
PHONE Option Téléphone.
EMAIL E-mail.
FAQS Option FAQ.
TWITTER Option Twitter.
WHATSAPP WhatsApp.

SurveyConfig

Détails de 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 incluses dans une enquête.
customSurveys

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

Questions d'enquête personnalisées pour un agent, mappées à 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'une 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. Les questions personnalisées ne doivent pas comporter plus de 200 caractères.
responseOptions[]

object (SurveyResponse)

Obligatoire. Liste des réponses affichée avec la question. Maximum : 12.

Type

Type de question de l'enquête.

Enums
TYPE_UNSPECIFIED Type de question d'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 du partenaire.

SurveyResponse

Contenu des réponses à une question d'enquête.

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

string

Obligatoire. Texte qui s'affiche dans l'enquête et qui est 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.

RcsBusinessMessagingAgent

Informations sur l'agent spécifiquement liées à RCS Business Messaging.

Représentation JSON 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
Champs
description

string

Obligatoire. Description de l'agent visible par les utilisateurs. 100 caractères au maximum.
logoUri

string

Obligatoire. URL accessible au public du logo de l'agent. 50 Ko maximum.

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

string

Obligatoire. URL publique de l'image héros de l'agent. 200 Ko maximum.

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

object (PhoneEntry)

Obligatoire. Numéros de téléphone associés à l'agent.
emails[]

object (EmailEntry)

Facultatif. Adresses e-mail associées à l'agent.
websites[]

object (WebEntry)

Facultatif. Sites Web associés à l'agent. Maximum : 3
privacy

object (WebEntry)

Obligatoire. Règles de confidentialité associées à l'agent.
termsConditions

object (WebEntry)

Obligatoire. Conditions d'utilisation associées à l'agent.
color

string

Obligatoire. Couleur du thème de l'agent visible par les utilisateurs au format hexadécimal. (par exemple, #FF6347).
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Obligatoire. Configuration de la facturation pour l'agent.
agentUseCase

enum (AgentUseCase)

Facultatif. Cas d'utilisation d'un bot.
hostingRegion

enum (HostingRegion)

Obligatoire. Région d'hébergement d'un agent.

PhoneEntry

Numéro de téléphone associé à l'agent.

Représentation JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Champs
phoneNumber

object (Phone)

Obligatoire. Numéro de téléphone au format E.164. Par exemple, +12223334444.
label

string

Obligatoire. Libellé du numéro de téléphone.

EmailEntry

Adresse e-mail associée à l'agent.

Représentation JSON 
{
  "address": string,
  "label": string
}
Champs
address

string

Obligatoire. Adresse e-mail
label

string

Obligatoire. Libellé de l'adresse e-mail.

WebEntry

Ressource Web associée à l'agent.

Représentation JSON 
{
  "uri": string,
  "label": string
}
Champs
uri

string

Obligatoire. URI accessible au public associé à l'agent. Vous devez utiliser le protocole HTTP ou HTTPS.
label

string

Facultatif. Étiquette de l'URI.

RcsBusinessMessagingAgentBillingConfig

Configuration de la facturation pour l'agent.

Représentation JSON 
{
  "billingCategory": enum (BillingCategory)
}
Champs
billingCategory

enum (BillingCategory)

Catégorie de facturation de l'agent.

BillingCategory

Catégories de facturation acceptées

Enums
BILLING_CATEGORY_UNSPECIFIED Catégorie non spécifiée.
CONVERSATIONAL_LEGACY Ancienne catégorie permettant de gérer la configuration de facturation des agents existants.
CONVERSATIONAL Elle est conçue pour des sessions plus longues et plus complexes au cours desquelles l'utilisateur et la marque échangent une série de messages.
SINGLE_MESSAGE Remplace les SMS par une fonctionnalité de messagerie plus riche. Jamais facturé en tant que CONVERSATIONAL.
BASIC_MESSAGE Le modèle de facturation est semblable à celui des SMS. Jamais facturé en tant que CONVERSATIONAL.

AgentUseCase

Types de cas d'utilisation d'agent utilisés dans le stockage.

Enums
AGENT_USE_CASE_UNSPECIFIED Cas d'utilisation non spécifié.
TRANSACTIONAL Agents qui n'envoient que des messages essentiels, nécessaires et urgents.
PROMOTIONAL Agents qui envoient des messages commerciaux, marketing et promotionnels Type par défaut.
OTP Les agents qui n'envoient que des mots de passe à usage unique
MULTI_USE Agents pouvant répondre à plusieurs cas d'utilisation

HostingRegion

Régions d'hébergement possibles d'un agent, utilisées pour acheminer correctement les messages P2A vers le serveur régionalisé.

Enums
HOSTING_REGION_UNSPECIFIED Région d'hébergement non spécifiée.
NORTH_AMERICA l'Amérique du Nord.
EUROPE l'Europe.
ASIA_PACIFIC Asie-Pacifique.

Méthodes

create

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

delete
(deprecated)

 Obsolète: la suppression de l'agent est obsolète.

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

 Répertorie tous les agents associés à une marque.

patch

 Met à jour les informations sur un agent.

requestLaunch

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

requestVerification

 Lance la validation des informations sur l'établissement d'un agent.

updateLaunch

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

updateVerification

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