Method: projects.locations.userStores.patch

ユーザー ストアを更新します。

HTTP リクエスト

PATCH https://discoveryengine.googleapis.com/v1alpha/{userStore.name=projects/*/locations/*/userStores/*}

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userStore.name

string

変更不可。ユーザー ストアの完全なリソース名（projects/{project}/locations/{location}/userStores/{userStore} 形式）。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

省略可。更新するフィールドのリスト。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には UserStore のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には UserStore のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.userStores.update

詳細については、IAM のドキュメントをご覧ください。