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

string

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

boolean

検索またはアシスト結果の配信を無効にします。
disableModifications

boolean

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

object (GSuitePrincipal)

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

boolean

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

string

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

Methods

create

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

delete

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

get

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

list

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

patch

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

update

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