Configurar o acesso à API Google Cloud Search

É preciso configurar o acesso à API do Google Cloud Search antes de usá-la diretamente ou por meio de um SDK. Este documento aborda as etapas necessárias para usar a API REST da API Google Cloud Search.

1. Criar um projeto de API

Para ativar a API, você precisa primeiro criar um projeto do Google Cloud. Esse projeto forma a base para criar, ativar e usar todos os serviços do Google Cloud, incluindo o gerenciamento de APIs, ativação de faturamento, adição e remoção de colaboradores e gerenciamento de 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 Nome do projeto.

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

  6. Para procurar locais do projeto, clique em PROCURAR.

  7. Clique em um local para seu projeto e depois 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 as 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 "Welcome to API Library" será exibida.
  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 na 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" será 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" será exibida.
  6. Clique em Continuar. A tela "Conceder acesso a esta conta de serviço" será exibida.
  7. Clique em CRIAR CHAVE e em Concluído. A caixa de diálogo "Chave privada salva no seu computador" será exibida, e o download de uma cópia dela será feito no 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 que você criou na parte de cima 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 o suporte de terceiros

Antes de chamar qualquer outra API do Cloud Search, você precisa inicializar o suporte de terceiros para o Google Cloud Search.

Para inicializar o suporte de terceiros para o Cloud Search:

  1. Seu projeto de plataforma do Cloud Search contém as credenciais da conta de serviço. No entanto, para inicializar o suporte de terceiros, é necessário criar credenciais de aplicativos da Web. Para instruções sobre como fazer isso, consulte Criar credenciais. Ao concluir esta etapa, você terá um ID e um arquivo de 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 a opção 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 para o Cloud Search, use o seguinte comando curl. Substitua [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. Exemplo:

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

    Se não conseguir, 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 estiver concluída, ela conterá 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.