Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Прежде чем использовать API Google Cloud Search напрямую или через SDK, необходимо настроить доступ к нему. В этом документе описываются шаги, необходимые для использования REST API Google Cloud Search API.
1. Создайте проект API
Чтобы включить API, необходимо сначала создать проект Google Cloud. Этот проект служит основой для создания, включения и использования всех сервисов Google Cloud, включая управление API, выставление счетов, добавление и удаление соавторов и управление разрешениями.
В верхней части страницы нажмите на arrow_drop_down справа от «Google Cloud Console». Откроется диалоговое окно со списком текущих проектов.
Нажмите кнопку НОВЫЙ ПРОЕКТ . Появится экран «Новый проект».
Введите название проекта в поле «Название проекта» .
(необязательно) Нажмите «Изменить» , чтобы изменить идентификатор проекта. Идентификатор проекта нельзя изменить после его создания, поэтому выберите идентификатор, который будет соответствовать вашим потребностям на протяжении всего жизненного цикла проекта.
Чтобы просмотреть места реализации проекта, нажмите кнопку ОБЗОР .
Щелкните по местоположению вашего проекта и нажмите «Выбрать» .
Нажмите «Создать» . Консоль перейдет на страницу «Панель управления». Проект будет создан за несколько минут.
Для получения учетных данных вам необходимо включить API Google Cloud Search и создать учетную запись службы.
Чтобы убедиться, что вы находитесь в только что созданном проекте, щелкните значок arrow_drop_down справа от баннера консоли Google Cloud и выберите только что созданный проект.
Нажмите «ВКЛЮЧИТЬ API И СЕРВИСЫ» . Откроется страница «Добро пожаловать в библиотеку API».
3. Создайте учетные данные сервисной учетной записи.
В консоли Google Cloud нажмите «Учётные данные» в левой навигационной панели. Откроется страница «Учётные данные».
В раскрывающемся списке «Создать учётные данные» выберите «Учётная запись службы ». Откроется страница «Создать учётную запись службы».
Введите имя в поле Имя учетной записи службы .
(необязательно) Измените идентификатор учетной записи службы.
Нажмите «Создать ». Появится экран «Разрешения учётной записи службы».
Нажмите «Продолжить» . Появится экран «Предоставить пользователям доступ к этой учётной записи службы».
Нажмите «СОЗДАТЬ КЛЮЧ» и нажмите «Готово» . Откроется диалоговое окно «Закрытый ключ сохранён на вашем компьютере», и копия закрытого ключа будет загружена на ваш компьютер.
Нажмите меню навигации слева от баннера консоли Google Cloud.
Нажмите IAM и Администрирование > Учетные записи служб .
В списке, в разделе «Идентификатор учётной записи службы», запишите сгенерированный адрес электронной почты, который идентифицирует настроенную вами учётную запись службы. Этот адрес электронной почты используется при добавлении источника данных в Cloud Search.
5. Инициализируйте стороннюю поддержку
Прежде чем вы сможете вызывать любые другие API Cloud Search, необходимо инициализировать стороннюю поддержку Google Cloud Search.
Чтобы инициализировать стороннюю поддержку Cloud Search:
Ваш проект платформы Cloud Search содержит учётные данные сервисной учётной записи. Однако для инициализации сторонней поддержки необходимо создать учётные данные веб-приложения. Инструкции по созданию учётных данных веб-приложения см. в разделе Создание учётных данных . После выполнения этого шага у вас должен быть файл с идентификатором клиента и секретным ключом клиента.
Нажмите «Настройки» и установите флажок «Использовать собственные учетные данные для авторизации» .
Введите идентификатор клиента и секретный код клиента из шага 1.
Нажмите «Закрыть» .
В поле «Области действия» введите https://www.googleapis.com/auth/cloud_search.settings и нажмите «Авторизовать» . Площадка OAuth 2 возвращает код авторизации.
Нажмите «Обменять код авторизации на токены» . Возвращается токен.
Чтобы инициализировать стороннюю поддержку Cloud Search, используйте следующую команду curl. Не забудьте заменить [YOUR_ACCESS_TOKEN] на токен, полученный на шаге 2.
Вот несколько следующих шагов, которые вы можете предпринять:
Если вы планируете использовать Google Cloud Search с хранилищем данных, отличным от Google, например, Microsoft® SharePoint®, необходимо создать источник данных. Инструкции по добавлению источника данных см. в статье Добавление источника данных для поиска .
После настройки источника данных вы можете создать и зарегистрировать схему, чтобы определить, как Google Cloud Search должен представлять данные в репозитории.
[null,null,["Последнее обновление: 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."]]