REST Resource: projects.locations.apps.deployments

Ressource : Deployment

Un déploiement représente une version immuable et interrogeable de l'application. Il est utilisé pour déployer une version de l'application avec un profil de canal spécifique.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "appVersion": string,
  "channelProfile": {
    object (ChannelProfile)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "experimentConfig": {
    object (ExperimentConfig)
  },
  "whatsappCredentials": {
    object (WhatsAppCredentials)
  },
  "instagramCredentials": {
    object (InstagramCredentials)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "modality": enum (Deployment.Modality)
}
Champs
name

string

Identifiant. Nom de ressource du déploiement. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
displayName

string

Obligatoire. Nom à afficher du déploiement.
appVersion

string

Facultatif. Nom de ressource de la version de l'application à déployer. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version} Utilisez projects/{project}/locations/{location}/apps/{app}/versions/- pour utiliser l'application brouillon.
channelProfile

object (ChannelProfile)

Obligatoire. Profil de canal utilisé dans le déploiement.
createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la création de ce déploiement.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de ce déploiement.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
etag

string

Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
experimentConfig

object (ExperimentConfig)

Facultatif. Configuration du test pour le déploiement.
whatsappCredentials

object (WhatsAppCredentials)

Facultatif. Uniquement en entrée. Des identifiants WhatsApp éphémères sont requis lors de la configuration d'un profil de canal WhatsApp.
instagramCredentials

object (InstagramCredentials)

Facultatif. Uniquement en entrée. Des identifiants Instagram éphémères sont requis lors de la configuration d'un profil de chaîne Instagram.
modelSettings

object (ModelSettings)

Facultatif. Paramètres du modèle pour le déploiement. Remplace les paramètres du modèle configurés au niveau de l'application/de l'agent. Remarque : Le remplacement des paramètres de modèle au niveau du déploiement est soumis à une liste d'autorisation. Contactez l'équipe CXAS pour activer ce champ.
modality

enum (Deployment.Modality)

Facultatif. Modalité du déploiement. Remarque : La modification de la modalité au niveau du déploiement est limitée par une liste d'autorisation. Contactez l'équipe CXAS pour activer ce champ.

ExperimentConfig

Expérience pour le déploiement.

Représentation JSON 
{
  "versionRelease": {
    object (ExperimentConfig.VersionRelease)
  }
}
Champs
versionRelease

object (ExperimentConfig.VersionRelease)

Facultatif. Version du test.

ExperimentConfig.VersionRelease

Version du test.

Représentation JSON 
{
  "state": enum (ExperimentConfig.State),
  "trafficAllocations": [
    {
      object (ExperimentConfig.VersionRelease.TrafficAllocation)
    }
  ]
}
Champs
state

enum (ExperimentConfig.State)

Facultatif. État de la version.
trafficAllocations[]

object (ExperimentConfig.VersionRelease.TrafficAllocation)

Facultatif. Répartitions du trafic pour la version.

ExperimentConfig.State

État du test.

Enums
STATE_UNSPECIFIED État non spécifié.
PENDING Obsolète : cet état n'est plus utilisé.
RUNNING État d'exécution. Le test est en cours et valide.
DONE Obsolète : cet état n'est plus utilisé.
EXPIRED Obsolète : cet état n'est plus utilisé.

ExperimentConfig.VersionRelease.TrafficAllocation

Répartition du trafic pour la version.

Représentation JSON 
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
Champs
id

string

Facultatif. ID de la répartition du trafic. Chaîne au format libre, jusqu'à 128 caractères.
trafficPercentage

integer

Facultatif. Pourcentage de la répartition du trafic. La valeur doit être comprise entre 0 et 100.
appVersion

string

Facultatif. Version de l'application pour la répartition du trafic. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

Identifiants Meta éphémères pour l'intégration native de WhatsApp.

Représentation JSON 
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
Champs
authCode

string

Obligatoire. Code d'authentification Meta fourni par le flux d'inscription intégré.
pin

string

Obligatoire. Code à six chiffres créé par l'utilisateur pour la validation en deux étapes.
phoneNumber

string

Obligatoire. Numéro de téléphone à enregistrer sur WhatsApp.
businessAccountId

string

Obligatoire. ID du compte professionnel à utiliser pour le numéro de téléphone.
wabaId

string

Obligatoire. ID de compte WhatsApp Business.
conversationProfileId

string

Facultatif. ID du profil de conversation à utiliser pour le déploiement.

InstagramCredentials

Identifiants Meta éphémères pour l'intégration native d'Instagram.

Représentation JSON 
{
  "authCode": string,
  "conversationProfileId": string
}
Champs
authCode

string

Obligatoire. Code d'authentification Meta fourni par le flux d'inscription intégré.
conversationProfileId

string

Facultatif. ID du profil de conversation à utiliser pour le déploiement.

Deployment.Modality

Modalité du déploiement.

Enums
MODALITY_UNSPECIFIED Modalité inconnue.
MODALITY_TEXT Modalité textuelle.
MODALITY_VOICE Modalité vocale.
MODALITY_VIDEO Modalité vidéo

Méthodes

create

 Crée un déploiement dans l'application donnée.

delete

 Supprime le déploiement spécifié.

get

 Obtient les détails du déploiement spécifié.

getExtendedAgentCard

 Récupère la fiche d'agent étendue pour l'agent authentifié.

list

 Liste les déploiements dans l'application spécifiée.

patch

 Met à jour le déploiement spécifié.