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。

メソッド

create

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

delete

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

get

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

list

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

patch

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

update

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