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

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 チームにお問い合わせください。

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

必須。2 段階認証プロセス用にユーザーが作成した 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

 指定されたデプロイを更新します。