Method: settings.datasources.update

データソースを更新します。

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

HTTP リクエスト

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

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

パスパラメータ

パラメータ
source.name

string

データソース リソースの名前。形式は datasources/{sourceId} です。

データソースの作成時に名前は無視されます。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
フィールド
source.displayName

string

必須。データソースの表示名。最大長は 300 文字です。
source.shortName

string

ソースの略称またはエイリアス。この値は「source」と照合するために使用されます。演算子を使用します。たとえば、略称が <value> の場合、<value> のようなクエリは、このソースの結果のみを返します。値はすべてのデータソースで一意である必要があります。値に使用できるのは英数字（a ～ zA ～ Z0-9）のみです。値の先頭を「google」にすることはできませんmail、gmail、docs、drive、groups、sites、calendar、hangouts、gplus、keep、people、team は指定できません。最大長は 32 文字です。
source.indexingServiceAccounts[]

string

インデックス登録権限を持つサービス アカウントのリスト。
source.disableServing

boolean

検索結果やアシスト結果の表示を無効にします。
source.disableModifications

boolean

true の場合、データソースを読み取り専用モードに設定します。読み取り専用モードでは、このソース内のアイテムのインデックス作成または削除のリクエストは Indexing API によって拒否されます。読み取り専用モードを有効にしても、以前に承認されたデータの処理は停止しません。
source.itemsVisibility[]

object (GSuitePrincipal)

このフィールドでは、データソース レベルのアイテムの公開設定が制限されます。データソース内のアイテムは、このフィールドに含まれるユーザーとグループの結合に制限されます。なお、ユーザーは含まれるアイテムに対する ACL 権限を持っている必要があるため、特定のアイテムに確実にアクセスできるようになるわけではありません。これにより、データソース全体に対する高レベルのアクセス権が付与され、個々のアイテムがこの公開設定の範囲外で共有されることはありません。
source.returnThumbnailUrls

boolean

このデータソースにインデックス登録されているアイテムのサムネイル URI を取得するよう、ユーザーがリクエストできるかどうか。
source.operationIds[]

string

このスキーマで現在実行されている長時間実行オペレーション（LRO）の ID。
debugOptions

object (DebugOptions)

一般的なデバッグ オプション。
updateMask

string (FieldMask format)

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

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

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

レスポンスの本文

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

認証スコープ

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

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

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