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> の場合、source:<value> のようなクエリはこのソースの結果のみを返します。この値はすべてのデータソースで一意である必要があります。値には英数字（a ～ zA ～ Z0 ～ 9）のみを使用してください。先頭を「google」にすることはできません。また、mail、gmail、docs、drive、groups、sites、calendar、hangouts、gplus、keep、people、teams のいずれかにすることはできません。最大文字数は 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

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