Para usar essa API diretamente ou por um SDK, configure o acesso à API Google Cloud Search. Este documento abrange as etapas necessárias para usar a API REST da API Google Cloud Search.
1. Criar um projeto de API
Para ativar a API, crie primeiro um projeto do Google Cloud. Esse projeto é a base para criar, ativar e usar todos os serviços do Google Cloud, incluindo gerenciamento de APIs, ativação de faturamento, adição e remoção de colaboradores e gerenciamento de permissões.
Abra o Console do Google Cloud.
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.Clique em NOVO PROJETO. A tela "New Project" será exibida.
Digite um nome de projeto no campo Nome do projeto.
(Opcional) Clique em Editar para modificar 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.
Para procurar locais do projeto, clique em PROCURAR.
Clique em um local para o projeto e depois em Selecionar.
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
É necessário ativar a API Google Cloud Search e criar uma conta de serviço para receber as credenciais.
- 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.
- Clique em ATIVAR APIS E SERVIÇOS. A página "Bem-vindo à biblioteca de APIs" será exibida.
- Acesse a API do Google Cloud Search.
- 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
- No Console do Google Cloud, clique em Credenciais na navegação à esquerda. A página "Credenciais" será exibida.
- Na lista suspensa Criar credenciais, selecione Conta de serviço. A página "Criar conta de serviço" será exibida.
- Digite um nome no campo Nome da conta de serviço.
- (opcional) Edite o código da conta de serviço.
- Clique em Criar. A tela "Permissões da conta de serviço" será exibida.
- Clique em Continuar. A tela "Conceda aos usuários acesso a esta conta de serviço" será exibida.
- Clique em CRIAR CHAVE e depois em Concluído. A caixa de diálogo "Chave privada salva no seu computador" será exibida, e uma cópia da chave privada será salva no seu computador.
- 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 o endereço de e-mail
- No Console do Google Cloud, selecione o projeto que você criou na parte superior da página.
- Clique no menu de navegação à esquerda do banner do console do Google Cloud.
- Clique em IAM e Admin > Contas de serviço.
- 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 do Cloud Search:
O projeto da plataforma do Cloud Search contém credenciais da conta de serviço. No entanto, para inicializar o suporte de terceiros, é necessário criar credenciais de aplicativos da Web. Consulte Criar credenciais para instruções sobre como criar credenciais de aplicativos da Web. Ao concluir esta etapa, você terá um ID e um arquivo de chave secreta do cliente.
Use o OAuth 2 Playground do Google para receber um token de acesso:
- Clique em "Configurações" e marque Usar suas próprias credenciais de autenticação.
- Insira o ID e a chave secreta do cliente da etapa 1.
- Clique em Fechar.
- 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. - Clique em Trocar código de autorização dos tokens. Um token é retornado.
Para inicializar o suporte de terceiros ao Cloud Search, use o seguinte comando curl. Substitua
[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 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 fazer isso, entre em contato com o suporte do Cloud Search.
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 do terceiro for concluída, ela vai conter o campo
done
definido comotrue
. 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:
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.
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.