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),
  "agentRegistryDeployment": {
    object (AgentRegistryDeployment)
  }
}
欄位
name

string

ID。部署作業的資源名稱。格式：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 正規化，並使用 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 正規化，並使用 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 團隊聯絡。
agentRegistryDeployment

object (AgentRegistryDeployment)

選用。將這個部署項目部署至 Agent Registry 的設定。如果存在，這個部署作業就會發布至 Agent Registry。

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 影片模態。

AgentRegistryDeployment

Agent Registry 部署作業的設定和狀態。

JSON 表示法 
{
  "agentRegistryServiceName": string
}
欄位
agentRegistryServiceName

string

選用。僅供輸出。已部署的 Agent Registry 服務資源名稱。格式：projects/{project}/locations/{location}/services/{service}

方法

create

 在指定應用程式中建立新的部署作業。

delete

 刪除指定的部署作業。

get

 取得指定部署作業的詳細資料。

getExtendedAgentCard

 取得已驗證代理的擴充代理卡。

list

 列出指定應用程式中的部署作業。

patch

 更新指定的部署作業。