REST Resource: projects.locations.apps.deployments

资源：Deployment

部署表示应用的不可变且可查询的版本。它用于部署具有特定渠道配置的应用版本。

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)
}
字段
name

string

标识符。相应部署的资源名称。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
displayName

string

必需。部署的显示名称。
appVersion

string

可选。要部署的应用版本的资源名称。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version} 使用 projects/{project}/locations/{location}/apps/{app}/versions/- 来使用草稿应用。
channelProfile

object (ChannelProfile)

必需。部署中使用的渠道配置文件。
createTime

string (Timestamp format)

仅限输出。相应部署的创建时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。相应部署上次更新时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
etag

string

仅限输出。用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。
experimentConfig

object (ExperimentConfig)

可选。部署的实验配置。
whatsappCredentials

object (WhatsAppCredentials)

可选。仅限输入。配置 WhatsApp 渠道配置文件时需要临时 WhatsApp 凭据。
instagramCredentials

object (InstagramCredentials)

可选。仅限输入。配置 Instagram 频道个人资料时需要提供临时 Instagram 凭据。
modelSettings

object (ModelSettings)

可选。部署的模型设置。替换在应用/代理级配置的模型设置。注意：部署级模型设置替换功能受许可名单限制。请与 CXAS 团队联系以启用此字段。
modality

enum (Deployment.Modality)

可选。部署的模态。注意：部署级模态替换功能受许可名单限制。请与 CXAS 团队联系以启用此字段。

ExperimentConfig

部署的实验。

JSON 表示法 
{
  "versionRelease": {
    object (ExperimentConfig.VersionRelease)
  }
}
字段
versionRelease

object (ExperimentConfig.VersionRelease)

可选。实验的版本发布。

ExperimentConfig.VersionRelease

实验的版本发布。

JSON 表示法 
{
  "state": enum (ExperimentConfig.State),
  "trafficAllocations": [
    {
      object (ExperimentConfig.VersionRelease.TrafficAllocation)
    }
  ]
}
字段
state

enum (ExperimentConfig.State)

可选。版本发布的状态。
trafficAllocations[]

object (ExperimentConfig.VersionRelease.TrafficAllocation)

可选。版本发布的流量分配。

ExperimentConfig.State

实验的状态。

枚举
STATE_UNSPECIFIED 未指定状态。
PENDING 已弃用：此状态不再使用。
RUNNING 运行状态。实验正在运行且有效。
DONE 已弃用：此状态不再使用。
EXPIRED 已弃用：此状态不再使用。

ExperimentConfig.VersionRelease.TrafficAllocation

版本发布的流量分配。

JSON 表示法 
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
字段
id

string

可选。流量分配的 ID。自由格式的字符串，最多 128 个字符。
trafficPercentage

integer

可选。流量分配的流量百分比。必须介于 0 到 100 之间。
appVersion

string

可选。流量分配的应用版本。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

用于 WhatsApp 原生集成的临时 Meta 凭据。

JSON 表示法 
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
字段
authCode

string

必需。嵌入式注册流程提供的 Meta 授权代码。
pin

string

必需。用户为两步验证创建的 6 位数 PIN 码。
phoneNumber

string

必需。用于注册 WhatsApp 的手机号码。
businessAccountId

string

必需。要用于手机号码的商家账号 ID。
wabaId

string

必需。WhatsApp Business 账号 ID。
conversationProfileId

string

可选。要用于部署的对话配置文件 ID。

InstagramCredentials

用于 Instagram 原生集成的临时 Meta 凭据。

JSON 表示法 
{
  "authCode": string,
  "conversationProfileId": string
}
字段
authCode

string

必需。嵌入式注册流程提供的 Meta 授权代码。
conversationProfileId

string

可选。要用于部署的对话配置文件 ID。

Deployment.Modality

部署的模态。

枚举
MODALITY_UNSPECIFIED 未知模态。
MODALITY_TEXT 文本模态。
MODALITY_VOICE 语音模态。
MODALITY_VIDEO 视频模态。

方法

create

 在给定应用中创建新部署。

delete

 删除指定的部署。

get

 获取指定部署的详细信息。

getExtendedAgentCard

 获取经过身份验证的代理的扩展代理卡片。

list

 列出给定应用中的部署。

patch

 更新指定的部署。