Configurar o acesso à API REST do Google Cloud Search

Você deve configurar o acesso à API REST do Google Cloud Search antes de usar essa API diretamente ou por meio de um SDK. Este documento aborda as etapas necessárias para usar a API REST do Google Cloud Search.

1. Crie um projeto de API

Para ativar a API, você deve primeiro criar um projeto do Google Cloud Platform. Este projeto é a base para criar, ativar e usar todos os serviços do Google Cloud Platform (GCP), incluindo 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 "Google Cloud Console". Uma caixa de diálogo listando os projetos atuais é exibida.

  3. Clique em NOVO PROJETO . A tela "Novo Projeto" é exibida.

  4. Insira um nome de projeto no campo Nome do projeto .

  5. (opcional) Clique em Editar para editar o ID do projeto. A ID do projeto não pode ser alterada após a criação do projeto, portanto, escolha uma 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 seu projeto e clique em Selecionar .

  8. Clique em Criar . O console navega para a página Dashboard. O projeto é criado em poucos minutos.

Para obter mais informações sobre como criar e gerenciar projetos, consulte Criação e gerenciamento de projetos .

2. Ative a API

Você precisa ativar a API REST do Cloud Search e criar uma conta de serviço para obter 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 seu projeto recém-criado.
  2. Clique em ATIVAR APIS E SERVIÇOS . A página "Bem-vindo à Biblioteca de APIs" é exibida.
  3. Navegue até a API do Google Cloud Search .
  4. Clique em Ativar . A página "Visão geral" é exibida.

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

3. Crie credenciais de conta de serviço

  1. No Console do Cloud Platform , clique em Credenciais na navegação à esquerda. A página Credencial é exibida.
  2. Na lista suspensa Criar credenciais , selecione Conta de serviço . A página "Criar conta de serviço" é exibida.
  3. Insira um nome no campo Nome da conta de serviço .
  4. (opcional) Edite o ID 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 "Conceder aos usuários acesso a esta conta de serviço" é exibida.
  7. Clique em CRIAR CHAVE e clique em Concluído . Uma caixa de diálogo "Chave privada salva em seu computador" é exibida e uma cópia da chave privada é baixada em seu computador.
  8. Clique em Fechar .

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

4. Identifique o endereço de e-mail

  1. No Console do Cloud Platform , selecione o projeto que você criou na parte superior da página.
  2. Clique no menu de navegação à esquerda do banner do Google Cloud Console.
  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 que você configurou. Este endereço de e-mail é usado ao adicionar uma fonte de dados ao Cloud Search.

5. Inicialize o suporte de terceiros

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

Para inicializar o suporte de terceiros para o Cloud Search:

  1. Seu projeto da plataforma Cloud Search contém credenciais de conta de serviço. No entanto, para inicializar o suporte de terceiros, você deve criar credenciais de aplicativo da web. Para obter instruções sobre como criar credenciais de aplicativo da web, consulte Criar credenciais . Ao concluir esta etapa, você deverá ter um ID do cliente e um arquivo de segredo do cliente.

  2. Use o playground OAuth 2 do Google para obter um token de acesso:

    1. Clique em configurações e marque Usuário suas próprias credenciais de autenticação .
    2. Insira o ID do cliente e o segredo 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 playground OAuth 2 retorna um código de autorização.
    5. Clique em código de autorização do Exchange para tokens . Um token é retornado.
  3. Para inicializar o suporte de terceiros para o Cloud Search, use o seguinte comando curl. Certifique-se de substituir [YOUR_ACCESS_TOKEN] pelo token obtido 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 for bem-sucedido, o corpo da resposta conterá uma instância de operation . Por exemplo:

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

    Se não tiver sucesso, entre em contato com o suporte do Cloud Search.

  4. Use operações.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 for concluída, ela conterá o campo done definido como true . Por exemplo:

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

Próximos passos

Aqui estão alguns próximos passos que você pode tomar:

  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®, você deve criar uma fonte de dados. Para obter instruções sobre como adicionar uma fonte de dados, consulte Adicionar uma fonte de dados à pesquisa .

  2. Depois de configurar sua fonte de dados, você pode criar e registrar o esquema para identificar como o Google Cloud Search deve representar os dados no repositório.