UpdateObjectCustomContext

オブジェクトのカスタム コンテキストを更新するオプションを記述します。

JSON 表現
{

  // Union field action can be only one of the following:
  "customContextUpdates": {
    object (CustomContextUpdates)
  },
  "clearAll": boolean
  // End of list of possible types for union field action.
}
フィールド
共用体フィールド action。いずれかのアクションを設定する必要があります。action は次のいずれかになります。
customContextUpdates

object (CustomContextUpdates)

特定のカスタム コンテキストに適用する更新のコレクション。これを使用して、キーごとに個々のコンテキストを追加、更新、削除します。

clearAll

boolean

設定する場合は、true に設定する必要があります。また、既存のオブジェクトのカスタム コンテキストはすべて削除されます。

CustomContextUpdates

キーで識別されるカスタム コンテキストに適用する更新のコレクションについて説明します。

JSON 表現
{
  "updates": {
    string: {
      object (ObjectCustomContextPayload)
    },
    ...
  },
  "keysToClear": [
    string
  ]
}
フィールド
updates

map (key: string, value: object (ObjectCustomContextPayload))

省略可。既存のカスタム コンテキストを挿入または更新します。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

keysToClear[]

string

省略可。キーでクリアするカスタム コンテキスト。キーは updateskeysToClear の両方に存在することはできません。

ObjectCustomContextPayload

ユーザー定義オブジェクトのカスタム コンテキストのペイロードについて説明します。

JSON 表現
{
  "value": string
}
フィールド
value

string

オブジェクトカスタムコンテキストの値。設定されている場合、value はカスタムコンテキストの必須フィールドであるため、空の文字列にすることはできません。設定されていない場合、value は無視され、カスタムコンテキストペイロードの value フィールドには変更が加えられません。