Configurar o acesso à API Google Cloud Search

É necessário configurar o acesso à API Google Cloud Search para poder usá-la diretamente ou por um SDK. Este documento mostra as etapas necessárias para usar a API REST do Google Cloud Search.

1. Criar um projeto de API

Para ativar a API, primeiro crie um projeto do Google Cloud. Esse projeto é a base para criar, ativar e usar todos os serviços do Google Cloud, incluindo gerenciar APIs, ativar o faturamento, adicionar e remover colaboradores e gerenciar permissões.

  1. Abra o Console do Google Cloud.

  2. Na parte superior da página, clique em à direita de "Console do Google Cloud". Será exibida uma caixa de diálogo que lista os projetos atuais.

  3. Clique em NOVO PROJETO. A tela "New Project" será exibida.

  4. Digite o nome do projeto no campo Project Name.

  5. (Opcional) Clique em Edit para editar o ID do projeto. O ID do projeto não pode ser alterado após a criação do projeto. Portanto, escolha um ID que atenda às suas necessidades durante a vida útil do projeto.

  6. Para procurar locais para o projeto, clique em BROWSE.

  7. Clique em um local para o projeto e em Selecionar.

  8. Clique em Criar. O Console acessa a página "Painel". O projeto é criado em poucos minutos.

Para mais informações sobre como criar e gerenciar projetos, consulte Como criar e gerenciar projetos.

2. Ativar a API

Você precisa ativar a API Google Cloud Search e criar uma conta de serviço para receber credenciais.

  1. Para garantir que você esteja no projeto recém-criado, clique no ícone à direita do banner do console do Google Cloud e selecione o projeto recém-criado.
  2. Clique em ATIVAR APIS E SERVIÇOS. A página "Conheça a biblioteca de APIs" vai aparecer.
  3. Acesse a API do Google Cloud Search.
  4. Selecione Ativar. A página "Visão geral" será exibida.

Para mais informações sobre como ativar e desativar APIs, consulte Gerenciar APIs no console do Google Cloud.

3. Criar credenciais de conta de serviço

  1. No Console do Google Cloud, clique em Credenciais no painel de navegação à esquerda. A página "Credenciais" será exibida.
  2. Na lista suspensa Criar credenciais, selecione Conta de serviço. A página "Criar conta de serviço" é exibida.
  3. Digite um nome no campo Nome da conta de serviço.
  4. (opcional) Edite o código da conta de serviço.
  5. Clique em Criar. A tela "Permissões da conta de serviço" é exibida.
  6. Clique em Continuar. A tela "Conceda aos usuários acesso a essa conta de serviço" é exibida.
  7. Clique em CRIAR CHAVE e clique em Concluído. Uma caixa de diálogo "Chave privada salva no seu computador" será exibida, e uma cópia da chave privada será transferida para o computador.
  8. Clique em Fechar.

Para mais informações sobre contas de serviço, consulte Contas de serviço, aplicativos da Web e aplicativos instalados

4. Identificar endereço de e-mail

  1. No Console do Google Cloud, selecione o projeto criado na parte superior da página.
  2. Clique no menu de navegação à esquerda do banner do console do Google Cloud.
  3. Clique em IAM e Admin > Contas de serviço.
  4. Na lista, em "ID da conta de serviço", anote o endereço de e-mail gerado que identifica a conta de serviço configurada. Esse endereço de e-mail é usado quando você adiciona uma origem de dados ao Cloud Search.

5. Inicializar suporte de terceiros

Antes de chamar outras APIs do Cloud Search, inicialize o suporte de terceiros para o Google Cloud Search.

Para inicializar o suporte de terceiros no Cloud Search:

  1. O projeto da plataforma do Cloud Search contém as credenciais da conta de serviço. No entanto, para inicializar o suporte de terceiros, você precisa criar credenciais de aplicativos da Web. Para instruções sobre como criar credenciais de aplicativos da Web, consulte Criar credenciais. Ao concluir essa etapa, você vai ter um ID e um arquivo da chave secreta do cliente.

  2. Use o OAuth 2 Playground do Google para receber um token de acesso:

    1. Clique em "Configurações" e marque Usar suas próprias credenciais de autenticação.
    2. Insira o ID e a chave secreta do cliente da etapa 1.
    3. Clique em Fechar.
    4. No campo de escopos, digite https://www.googleapis.com/auth/cloud_search.settings e clique em Autorizar. O OAuth 2 Playground retorna um código de autorização.
    5. Clique em Trocar código de autorização dos tokens. Um token é retornado.
  3. Para inicializar o suporte de terceiros no Cloud Search, use o seguinte comando curl. Lembre-se de substituir [YOUR_ACCESS_TOKEN] pelo token recebido na etapa 2.

    curl --request POST \
    'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{}' \
      --compressed
    

    Se funcionar, o corpo da resposta vai ter uma instância de operation. Por exemplo:

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    }
    

    Se não der certo, entre em contato com o suporte do Cloud Search.

  4. Use operations.get para verificar se o suporte de terceiros foi inicializado:

    curl \
    'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
    [YOUR_API_KEY]' \
    --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
    --header 'Accept: application/json' \
    --compressed
    

    Quando a inicialização de terceiros é concluída, ela contém o campo done definido como true. Exemplo:

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    done: true
    }
    

Próximas etapas

Veja algumas das próximas etapas que podem ser seguidas:

  1. Se você planeja usar o Google Cloud Search com um repositório de dados que não seja do Google, como o Microsoft® SharePoint®, é necessário criar uma origem de dados. Para instruções sobre como adicionar uma origem de dados, consulte Adicionar uma origem de dados para pesquisa.

  2. Depois de configurar a origem de dados, é possível criar e registrar esquemas para identificar como o Google Cloud Search representa os dados no repositório.