Method: settings.searchapplications.patch

検索アプリケーションを更新します。

注: この API を実行するには、管理者アカウントが必要です。

HTTP リクエスト

PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}

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

パスパラメータ

パラメータ
searchApplication.name

string

検索アプリの名前。

形式: searchapplications/{applicationId}。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

settings.searchapplications.patch にのみ適用されます。

更新するフィールドを制御するマスクを更新します。フィールドパスの例: searchApplication.name、searchApplication.displayName。

  • updateMask が空でない場合、updateMask で指定されたフィールドのみが更新されます。
  • updateMask でフィールドを指定しても、searchApplication で値を指定しないと、そのフィールドはクリアされます。
  • updateMask が存在しない場合、空の場合、または値が * の場合、すべてのフィールドが更新されます。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/cloud_search.settings.query
  • https://www.googleapis.com/auth/cloud_search.settings
  • https://www.googleapis.com/auth/cloud_search

詳しくは、認可ガイドをご覧ください。