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、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

更新数据源。