REST Resource: projects.locations.apps.deployments

Recurso: Deployment

Una implementación representa una versión inmutable de la app que se puede consultar. Se usa para implementar una versión de la app con un perfil de canal específico.

Representación 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),
  "agentRegistryDeployment": {
    object (AgentRegistryDeployment)
  }
}
Campos
name

string

Es el identificador. Es el nombre del recurso de la implementación. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
displayName

string

Obligatorio. Es el nombre visible de la implementación.
appVersion

string

Es opcional. Es el nombre del recurso de la versión de la app que se implementará. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version} Usa projects/{project}/locations/{location}/apps/{app}/versions/- para usar la app en borrador.
channelProfile

object (ChannelProfile)

Obligatorio. Es el perfil del canal que se usa en la implementación.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la creación de esta implementación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la última actualización de esta implementación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
etag

string

Solo salida. Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura-modificación-escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
experimentConfig

object (ExperimentConfig)

Es opcional. Es la configuración del experimento para la implementación.
whatsappCredentials

object (WhatsAppCredentials)

Es opcional. Solo entrada. Se requieren credenciales efímeras de WhatsApp cuando se configura un perfil de canal de WhatsApp.
instagramCredentials

object (InstagramCredentials)

Es opcional. Solo entrada. Se requieren credenciales efímeras de Instagram cuando se configura un perfil de canal de Instagram.
modelSettings

object (ModelSettings)

Es opcional. Es la configuración del modelo para la implementación. Anula la configuración del modelo establecida a nivel de la app o del agente. Nota: El reemplazo de la configuración del modelo a nivel de la Deployment está restringido por una lista de entidades permitidas. Comunícate con el equipo de CXAS para habilitar este campo.
modality

enum (Deployment.Modality)

Es opcional. Es la modalidad de la implementación. Nota: La anulación de la modalidad a nivel de la Deployment está controlada por una lista de entidades permitidas. Comunícate con el equipo de CXAS para habilitar este campo.
agentRegistryDeployment

object (AgentRegistryDeployment)

Es opcional. Es la configuración para implementar esta implementación en Agent Registry. Si está presente, esta implementación se publicará en Agent Registry.

ExperimentConfig

Es el experimento para la implementación.

Representación JSON 
{
  "versionRelease": {
    object (ExperimentConfig.VersionRelease)
  }
}
Campos
versionRelease

object (ExperimentConfig.VersionRelease)

Es opcional. Es la versión de lanzamiento del experimento.

ExperimentConfig.VersionRelease

Es la versión de lanzamiento del experimento.

Representación JSON 
{
  "state": enum (ExperimentConfig.State),
  "trafficAllocations": [
    {
      object (ExperimentConfig.VersionRelease.TrafficAllocation)
    }
  ]
}
Campos
state

enum (ExperimentConfig.State)

Es opcional. Es el estado de la versión.
trafficAllocations[]

object (ExperimentConfig.VersionRelease.TrafficAllocation)

Es opcional. Son las asignaciones de tráfico para el lanzamiento de la versión.

ExperimentConfig.State

Es el estado del experimento.

Enums
STATE_UNSPECIFIED Significa que el estado no se especificó.
PENDING Obsoleto: Este estado ya no se usa.
RUNNING Estado de ejecución. El experimento se está ejecutando y es válido.
DONE Obsoleto: Este estado ya no se usa.
EXPIRED Obsoleto: Este estado ya no se usa.

ExperimentConfig.VersionRelease.TrafficAllocation

Es la asignación de tráfico para el lanzamiento de la versión.

Representación JSON 
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
Campos
id

string

Es opcional. Es el ID de la asignación de tráfico. Es una cadena de formato libre de hasta 128 caracteres.
trafficPercentage

integer

Es opcional. Es el porcentaje de tráfico de la asignación de tráfico. Debe estar entre 0 y 100.
appVersion

string

Es opcional. Es la versión de la app de la asignación de tráfico. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

Son credenciales de Meta efímeras para la integración nativa de WhatsApp.

Representación JSON 
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
Campos
authCode

string

Obligatorio. Es el código de autorización de Meta que proporciona el flujo de registro integrado.
pin

string

Obligatorio. Es el PIN de 6 dígitos que creó el usuario para la verificación en dos pasos.
phoneNumber

string

Obligatorio. Número de teléfono con el que se registrará en WhatsApp.
businessAccountId

string

Obligatorio. Es el ID de la cuenta comercial que se usará para el número de teléfono.
wabaId

string

Obligatorio. Es el ID de la cuenta de WhatsApp Business.
conversationProfileId

string

Es opcional. Es el ID del perfil de conversación que se usará para la implementación.

InstagramCredentials

Son credenciales de Meta efímeras para la integración nativa de Instagram.

Representación JSON 
{
  "authCode": string,
  "conversationProfileId": string
}
Campos
authCode

string

Obligatorio. Es el código de autorización de Meta que proporciona el flujo de registro integrado.
conversationProfileId

string

Es opcional. Es el ID del perfil de conversación que se usará para la implementación.

Deployment.Modality

Es la modalidad de la implementación.

Enums
MODALITY_UNSPECIFIED Modalidad desconocida.
MODALITY_TEXT Modalidad de texto.
MODALITY_VOICE Modalidad de voz.
MODALITY_VIDEO Modalidad de video.

AgentRegistryDeployment

Configuración y estado de la implementación de Agent Registry.

Representación JSON 
{
  "agentRegistryServiceName": string
}
Campos
agentRegistryServiceName

string

Es opcional. Solo salida. Es el nombre del recurso del servicio de Agent Registry implementado. Formato: projects/{project}/locations/{location}/services/{service}

Métodos

create

 Crea una implementación nueva en la app especificada.

delete

 Borra la implementación especificada.

get

 Obtiene detalles de la implementación especificada.

getExtendedAgentCard

 Obtiene la tarjeta de agente extendida para el agente autenticado.

list

 Enumera las implementaciones de la app especificada.

patch

 Actualiza la implementación especificada.