REST Resource: projects.locations.apps.deployments

Risorsa: Deployment

Un deployment rappresenta una versione immutabile e interrogabile dell'app. Viene utilizzato per eseguire il deployment di una versione dell'app con un profilo del canale specifico.

Rappresentazione 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)
}
Campi
name

string

Identificatore. Il nome della risorsa del deployment. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

displayName

string

Obbligatorio. Il nome visualizzato del deployment.

appVersion

string

Facoltativo. Il nome risorsa della versione dell'app di cui eseguire il deployment. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version} utilizza projects/{project}/locations/{location}/apps/{app}/versions/- per utilizzare l'app bozza.

channelProfile

object (ChannelProfile)

Obbligatorio. Il profilo del canale utilizzato nel deployment.

createTime

string (Timestamp format)

Solo output. Timestamp di creazione di questo deployment.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento di questo deployment.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

etag

string

Solo output. Etag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.

experimentConfig

object (ExperimentConfig)

Facoltativo. Configurazione dell'esperimento per il deployment.

whatsappCredentials

object (WhatsAppCredentials)

Facoltativo. Solo input. Credenziali WhatsApp temporanee richieste durante la configurazione di un profilo del canale WhatsApp.

instagramCredentials

object (InstagramCredentials)

Facoltativo. Solo input. Le credenziali temporanee di Instagram sono necessarie per configurare un profilo del canale Instagram.

modelSettings

object (ModelSettings)

Facoltativo. Impostazioni del modello per il deployment. Esegue l'override delle impostazioni del modello configurate a livello di app/agente. Nota: l'override delle impostazioni del modello a livello di deployment è protetto da una lista consentita. Contatta il team CXAS per attivare questo campo.

modality

enum (Deployment.Modality)

Facoltativo. La modalità di deployment. Nota: l'override della modalità a livello di deployment è protetto da una lista consentita. Contatta il team CXAS per attivare questo campo.

ExperimentConfig

Esegui un esperimento per il deployment.

Rappresentazione JSON
{
  "versionRelease": {
    object (ExperimentConfig.VersionRelease)
  }
}
Campi
versionRelease

object (ExperimentConfig.VersionRelease)

Facoltativo. Versione di rilascio per l'esperimento.

ExperimentConfig.VersionRelease

Versione di rilascio per l'esperimento.

Rappresentazione JSON
{
  "state": enum (ExperimentConfig.State),
  "trafficAllocations": [
    {
      object (ExperimentConfig.VersionRelease.TrafficAllocation)
    }
  ]
}
Campi
state

enum (ExperimentConfig.State)

Facoltativo. Lo stato del rilascio della versione.

trafficAllocations[]

object (ExperimentConfig.VersionRelease.TrafficAllocation)

Facoltativo. Allocazioni del traffico per il rilascio della versione.

ExperimentConfig.State

Stato dell'esperimento.

Enum
STATE_UNSPECIFIED Stato non specificato.
PENDING Deprecato: questo stato non è più utilizzato.
RUNNING Stato di esecuzione. L'esperimento è in corso ed è valido.
DONE Deprecato: questo stato non è più utilizzato.
EXPIRED Deprecato: questo stato non è più utilizzato.

ExperimentConfig.VersionRelease.TrafficAllocation

Assegnazione del traffico per il rilascio della versione.

Rappresentazione JSON
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
Campi
id

string

Facoltativo. ID dell'assegnazione del traffico. Stringa in formato libero, fino a 128 caratteri.

trafficPercentage

integer

Facoltativo. Percentuale di traffico dell'assegnazione del traffico. Il valore deve essere compreso tra 0 e 100.

appVersion

string

Facoltativo. Versione dell'app dell'assegnazione del traffico. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

Credenziali Meta temporanee per l'integrazione nativa di WhatsApp.

Rappresentazione JSON
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
Campi
authCode

string

Obbligatorio. Il codice di autorizzazione Meta fornito dal flusso di registrazione incorporato.

pin

string

Obbligatorio. Il PIN di 6 cifre creato dall'utente per la verifica in due passaggi.

phoneNumber

string

Obbligatorio. Il numero di telefono con cui registrarsi su WhatsApp.

businessAccountId

string

Obbligatorio. L'ID account aziendale da utilizzare per il numero di telefono.

wabaId

string

Obbligatorio. L'ID account WhatsApp Business.

conversationProfileId

string

Facoltativo. L'ID profilo di conversazione da utilizzare per il deployment.

InstagramCredentials

Credenziali Meta temporanee per l'integrazione nativa di Instagram.

Rappresentazione JSON
{
  "authCode": string,
  "conversationProfileId": string
}
Campi
authCode

string

Obbligatorio. Il codice di autorizzazione Meta fornito dal flusso di registrazione incorporato.

conversationProfileId

string

Facoltativo. L'ID profilo di conversazione da utilizzare per il deployment.

Deployment.Modality

La modalità di deployment.

Enum
MODALITY_UNSPECIFIED Modalità sconosciuta.
MODALITY_TEXT Modalità testo.
MODALITY_VOICE Modalità vocale.
MODALITY_VIDEO Modalità video.

Metodi

create

Crea un nuovo deployment nell'app specificata.

delete

Elimina il deployment specificato.

get

Recupera i dettagli del deployment specificato.

getExtendedAgentCard

Recupera la scheda dell'agente estesa per l'agente autenticato.

list

Elenca i deployment nell'app specificata.

patch

Aggiorna il deployment specificato.