REST Resource: settings.datasources

リソース: DataSource

データソースは、インデックスに登録するアイテムの論理名前空間です。すべてのアイテムはデータソースに属している必要があります。これは、アイテムを Cloud Search にインデックス登録するための前提条件です。

JSON 表現
{
  "name": string,
  "displayName": string,
  "shortName": string,
  "indexingServiceAccounts": [
    string
  ],
  "disableServing": boolean,
  "disableModifications": boolean,
  "itemsVisibility": [
    {
      object (GSuitePrincipal)
    }
  ],
  "returnThumbnailUrls": boolean,
  "operationIds": [
    string
  ]
}
フィールド
name

string

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

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

displayName

string

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

shortName

string

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

indexingServiceAccounts[]

string

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

disableServing

boolean

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

disableModifications

boolean

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

itemsVisibility[]

object (GSuitePrincipal)

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

returnThumbnailUrls

boolean

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

operationIds[]

string

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

メソッド

create

データソースを作成します。

delete

データソースを削除します。

get

データソースを取得します。

list

データソースを一覧表示します。

patch

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

update

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