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

詳細については、承認ガイドをご覧ください。