Method: settings.datasources.update

Обновляет источник данных.

Примечание. Для выполнения этого API требуется учетная запись администратора.

HTTP-запрос

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
source.name

string

Имя ресурса источника данных. Формат: источники данных/{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» и не может быть одним из следующих: почта, Gmail, документы, диск, группы, сайты, календарь, Hangouts, Gplus, Keep, люди, команды. Его максимальная длина — 32 символа.

source.indexingServiceAccounts[]

string

Список учетных записей служб, имеющих доступ к индексированию.

source.disableServing

boolean

Отключите показ любых результатов поиска или помощи.

source.disableModifications

boolean

Если это правда, переводит источник данных в режим только для чтения. В режиме только для чтения API индексирования отклоняет любые запросы на индексирование или удаление элементов в этом источнике. Включение режима только для чтения не останавливает обработку ранее принятых данных.

source.itemsVisibility[]

object ( GSuitePrincipal )

Это поле ограничивает видимость элементов на уровне источника данных. Элементы в источнике данных ограничены объединением пользователей и групп, включенных в это поле. Обратите внимание, что это не гарантирует доступ к конкретному элементу, поскольку пользователям необходимо иметь разрешения ACL для содержащихся элементов. Это обеспечивает высокий уровень доступа ко всему источнику данных и то, что отдельные элементы не будут доступны за пределами этой видимости.

source.returnThumbnailUrls

boolean

Может ли пользователь запросить URI миниатюр для элементов, проиндексированных в этом источнике данных.

source.operationIds[]

string

Идентификаторы длительных операций (LRO), которые в данный момент выполняются для этой схемы.

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

Дополнительную информацию см. в руководстве по авторизации .