Method: settings.datasources.update

Atualiza uma fonte de dados.

Observação:é necessário ter uma conta de administrador para executar esta API.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
source.name

string

O nome do recurso da fonte de dados. Formato: datasources/{sourceId}.

O nome é ignorado ao criar uma fonte de dados.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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
}
Campos
source.displayName

string

Obrigatório. Nome de exibição da fonte de dados. O tamanho máximo é de 300 caracteres.
source.shortName

string

Um nome curto ou alias para a origem. Esse valor será usado para corresponder ao operador "source". Por exemplo, se o nome curto for <value>, consultas como source:<value> só retornarão resultados para esta origem. O valor precisa ser exclusivo em todas as fontes de dados. O valor precisa conter apenas caracteres alfanuméricos (a-zA-Z0-9). O valor não pode começar com "google" nem ser: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, team. O tamanho máximo é de 32 caracteres.
source.indexingServiceAccounts[]

string

Lista de contas de serviço que têm acesso de indexação.
source.disableServing

boolean

Desative a exibição de resultados de pesquisa ou assistência.
source.disableModifications

boolean

Se verdadeiro, configura a fonte de dados para o modo somente leitura. No modo somente leitura, a API Indexing rejeita todas as solicitações de indexação ou exclusão de itens nessa origem. Ativar o modo somente leitura não interrompe o processamento dos dados aceitos anteriormente.
source.itemsVisibility[]

object (GSuitePrincipal)

Esse campo restringe a visibilidade de itens no nível da fonte de dados. Os itens na fonte de dados são restritos à união de usuários e grupos incluídos nesse campo. Isso não garante o acesso a um item específico, já que os usuários precisam ter permissões da ACL nos itens contidos. Isso garante um acesso de alto nível a toda a fonte de dados e que os itens individuais não são compartilhados fora dessa visibilidade.
source.returnThumbnailUrls

boolean

Pode uma solicitação do usuário para receber o URI de miniatura dos itens indexados nessa fonte de dados.
source.operationIds[]

string

IDs das operações de longa duração (LROs) em execução no momento para este esquema.
debugOptions

object (DebugOptions)

Opções de depuração comuns.
updateMask

string (FieldMask format)

Aplicável apenas a settings.datasources.patch.

Atualização da máscara para controlar quais campos serão atualizados. Exemplos de caminhos de campo: name, displayName.

  • Se updateMask não estiver vazio, somente os campos especificados em updateMask serão atualizados.
  • Se você especificar um campo na updateMask, mas não especificar o valor dele na origem, esse campo será apagado.
  • Se o updateMask não estiver presente, vazio ou tiver o valor *, todos os campos serão atualizados.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos de 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

Para mais informações, consulte o Guia de autorização.