Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
É necessário configurar o acesso à API Google Cloud Search para poder usar essa API diretamente ou por meio de 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 gerenciamento de APIs, ativação de faturamento, adição e remoção de colaboradores e gerenciamento de permissões.
Na parte de cima da página, clique em
arrow_drop_down
à direita de "Console do Google Cloud". Será exibida uma caixa de diálogo que lista os projetos atuais.
Clique em NOVO PROJETO. A tela "Novo projeto" é exibida.
Digite um nome no campo Nome do projeto.
(opcional) Clique em Editar para editar o código do projeto. O código do projeto não pode ser alterado após a criação do projeto, portanto, escolha um código que atenda às suas necessidades durante a vida útil do projeto.
Para procurar locais para o projeto, clique em PROCURAR.
Clique em um local para seu projeto e em Selecionar.
Clique em Criar. O Console acessa a página "Painel". O projeto é criado em poucos minutos.
É necessário ativar a API Google Cloud Search e criar uma conta de serviço para conseguir as credenciais.
Para garantir que você esteja no projeto mais recente, clique no ícone arrow_drop_down à 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 "Olá! Esta é a Biblioteca de APIs" aparece.
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" é 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. Uma tela "Permissões da conta de serviço" vai aparecer.
Clique em Continuar. A tela "Conceder aos usuários acesso a essa conta de serviço"
aparece.
Clique em CRIAR CHAVE e em Concluído. A caixa de diálogo "Chave privada salva no seu computador" será exibida, e será feito o download de uma cópia da chave privada em seu computador.
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, é preciso inicializar o suporte
de terceiros para o Google Cloud Search.
Para inicializar o suporte a terceiros no Cloud Search:
O projeto da plataforma Cloud Search contém credenciais de conta de serviço.
No entanto, para inicializar o suporte a terceiros, é necessário criar credenciais de aplicativo da Web. Para instruções sobre como criar credenciais de
aplicativo da Web, consulte
Criar credenciais.
Ao concluir esta etapa, você terá um arquivo de ID e chave secreta do cliente.
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 a terceiros no Cloud Search, use o seguinte comando curl. Substitua [YOUR_ACCESS_TOKEN] pelo token obtido na etapa 2.
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.
[null,null,["Última atualização 2025-08-29 UTC."],[],[],null,["# Configure access to the Google Cloud Search API\n\nYou must configure access to the Google Cloud Search API before you can\nuse this API either directly or through an SDK. This document\ncovers the steps required to use the Google Cloud Search API REST API.\n\n1. Create an API project\n------------------------\n\nTo enable the API, you must first create an Google Cloud project. This\nproject forms the basis for creating, enabling, and using all Google Cloud\nservices, including managing APIs, enabling billing, adding and\nremoving collaborators, and managing permissions.\n\n1. Open the [Google Cloud console](https://console.cloud.google.com/apis/dashboard).\n\n2. At the top of the page, click\n arrow_drop_down\n to the right of \"Google Cloud Console.\" A dialog listing current projects\n appears.\n\n3. Click **NEW PROJECT**. The \"New Project\" screen appears.\n\n4. Enter a project name in the **Project Name** field.\n\n5. (optional) Click **Edit** to edit the Project ID. The project ID can't be\n changed after the project is created, so choose an\n ID that meets your needs for the lifetime of the project.\n\n6. To browse locations for the project, click **BROWSE**.\n\n7. Click on a location for your project and click **Select**.\n\n8. Click **Create**. The console navigates to the Dashboard page. The project\n is created within a few minutes.\n\nFor further information on creating and managing projects, refer to\n[Creating and Managing Projects](https://support.google.com/cloud#topic=6158848).\n\n2. Enable the API\n-----------------\n\nYou need to enable the Google Cloud Search API and create a service account to\nobtain credentials.\n\n1. To ensure you are on the newly created project, click the arrow_drop_down icon to the right of the Google Cloud console banner and select your newly-created project.\n2. Click **ENABLE APIS AND SERVICES**. The \"Welcome to API Library\" page appears.\n3. Navigate to the [Google Cloud Search API](https://console.cloud.google.com/apis/api/cloudsearch.googleapis.com).\n4. Click **Enable**. The \"Overview\" page appears.\n\nFor further information on enabling and disabling APIs, refer to\n[Manage APIs in the Google Cloud console](https://support.google.com/cloud/answer/6326510)\n| **Note:** Different Cloud Search APIs require different accounts to execute (admin, service, and user). For further information, refer to the [reference documentation](/workspace/cloud-search/docs/reference) for the method you want to call.\n\n3. Create service account credentials\n-------------------------------------\n\n1. In the [Google Cloud console](https://console.cloud.google.com/apis/library), click **Credentials** in the left navigation. The Credential page appears.\n2. From the **Create credentials** drop-down list, select **Service account**. The \"Create service account\" page appears.\n3. Enter a name in the **Service account name** field.\n4. (optional) Edit the service account ID.\n5. Click **Create**. A \"Service account permissions\" screen appears.\n6. Click **Continue**. A \"Grant users access to this service account\" screen appears.\n7. Click **CREATE KEY** and click **Done**. A \"Private key saved to your computer\" dialog appears and a copy of the private key downloads to your computer.\n8. Click **Close**.\n\nFor further information on service accounts, refer to\n[Service accounts, web applications, and installed applications](https://support.google.com/cloud/answer/6158849#serviceaccounts)\n\n4. Identify email address\n-------------------------\n\n1. From the [Google Cloud console](https://console.cloud.google.com/apis/dashboard), select the project you created at the top of the page.\n2. Click the Navigation menu to the left of the Google Cloud console banner.\n3. Click **IAM and Admin** \\\u003e **Service accounts**.\n4. In the list, under \"Service account ID,\" make note of the generated email address that identifies the service account you configured. This email address is used when adding a data source to Cloud Search.\n\n5. Initialize third-party support\n---------------------------------\n\nBefore you can call any other Cloud Search APIs, you must initialize third-party\nsupport for Google Cloud Search.\n| **Note:** If you successfully executed the Cloud Search tutorial, you have already initialized third-party support for Cloud Search and can skip this step.\n\nTo initialize third-party support for Cloud Search:\n\n1. Your Cloud Search platform project contains service account credentials.\n However, for the sake of initializing third-party support, you must create web\n application credentials. For instructions on how to create web application\n credentials, refer to\n [Create credentials](/workspace/guides/create-credentials).\n Upon completing this step, you should have a client ID and client secret file.\n\n2. Use\n [Google's OAuth 2 playground](https://developers.google.com/oauthplayground/)\n to obtain an access token:\n\n 1. Click settings and check **User your own auth credentials**.\n 2. Enter the client ID and client secret from step 1.\n 3. Click **Close**.\n 4. In the scopes field, type `https://www.googleapis.com/auth/cloud_search.settings` and click **Authorize**. The OAuth 2 playground returns an authorization code.\n 5. Click **Exchange authorization code for tokens**. A token is returned.\n3. To initialize third-party support for Cloud Search, use the following curl\n command. Be sure to substitute `[YOUR_ACCESS_TOKEN]` with the token obtained in\n step 2.\n\n curl --request POST \\\n 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data '{}' \\\n --compressed\n\n If successful, the response body contains an instance of\n [`operation`](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation). For\n example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n }\n\n If unsuccessful, contact Cloud Search support.\n4. Use [operations.get](/workspace/cloud-search/docs/reference/rest/v1/operations/get) to verify that\n third-party support is initialized:\n\n curl \\\n 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=\n [YOUR_API_KEY]' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --compressed\n\n When the third-party initialization is complete, it contains the\n field `done` set to `true`. For example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n done: true\n }\n\nNext Steps\n----------\n\nHere are few next steps you might take:\n\n1. If you plan on using Google Cloud Search with a non-Google data repository,\n such as Microsoft® SharePoint®, you\n must create a data source. For instructions on\n adding a data source, refer to\n [Add a data source to search](https://support.google.com/a/answer/7056471).\n\n2. Once you set up your data source, you can\n [create and register schema](/workspace/cloud-search/docs/guides/schema-guide) to identify\n how Google Cloud Search should represent the data in the repository."]]
