Настройте доступ к API Google Cloud Search.

Прежде чем использовать этот API напрямую или через SDK, необходимо настроить доступ к API Google Cloud Search. В этом документе описаны шаги, необходимые для использования REST API Google Cloud Search API.

1. Создайте проект API

Чтобы включить API, сначала необходимо создать проект Google Cloud. Этот проект формирует основу для создания, включения и использования всех сервисов Google Cloud, включая управление API, включение выставления счетов, добавление и удаление соавторов, а также управление разрешениями.

  1. Откройте консоль Google Cloud .

  2. Вверху страницы нажмите справа от «Google Cloud Console». Появится диалоговое окно со списком текущих проектов.

  3. Нажмите НОВЫЙ ПРОЕКТ . Появится экран «Новый проект».

  4. Введите имя проекта в поле «Имя проекта» .

  5. (необязательно) Нажмите «Изменить», чтобы изменить идентификатор проекта. Идентификатор проекта нельзя изменить после его создания, поэтому выберите идентификатор, который соответствует вашим потребностям на протяжении всего срока действия проекта.

  6. Чтобы просмотреть местоположения проекта, нажмите ОБЗОР .

  7. Нажмите на местоположение вашего проекта и нажмите «Выбрать» .

  8. Нажмите Создать . Консоль перейдет на страницу панели мониторинга. Проект создается в течение нескольких минут.

Дополнительную информацию о создании проектов и управлении ими см. в разделе Создание проектов и управление ими .

2. Включите API

Вам необходимо включить API Google Cloud Search и создать учетную запись службы для получения учетных данных.

  1. Чтобы убедиться, что вы находитесь в только что созданном проекте, щелкните справа от баннера консоли Google Cloud и выберите только что созданный проект.
  2. Нажмите ВКЛЮЧИТЬ APIS И СЕРВИСЫ . Появится страница «Добро пожаловать в библиотеку API».
  3. Перейдите к API Google Cloud Search .
  4. Нажмите Включить . Появится страница «Обзор».

Дополнительную информацию о включении и отключении API см. в разделе «Управление API в консоли Google Cloud».

3. Создайте учетные данные сервисной учетной записи.

  1. В консоли Google Cloud нажмите «Учетные данные» на левой панели навигации. Появится страница учетных данных.
  2. В раскрывающемся списке Создать учетные данные выберите Учетная запись службы . Появится страница «Создать учетную запись службы».
  3. Введите имя в поле Имя учетной записи службы .
  4. (необязательно) Измените идентификатор учетной записи службы.
  5. Нажмите Создать . Появится экран «Разрешения сервисной учетной записи».
  6. Нажмите Продолжить . Появится экран «Предоставить пользователям доступ к этой учетной записи службы».
  7. Нажмите СОЗДАТЬ КЛЮЧ и нажмите Готово . Появится диалоговое окно «Закрытый ключ сохранен на вашем компьютере», и копия закрытого ключа загрузится на ваш компьютер.
  8. Нажмите Закрыть .

Дополнительную информацию об учетных записях служб см. в разделе Учетные записи служб, веб-приложения и установленные приложения.

4. Определите адрес электронной почты

  1. В консоли Google Cloud выберите созданный вами проект вверху страницы.
  2. Нажмите меню навигации слева от баннера консоли Google Cloud.
  3. Нажмите IAM и Администрирование > Учетные записи служб .
  4. В списке в разделе «Идентификатор учетной записи службы» запишите сгенерированный адрес электронной почты, который идентифицирует настроенную вами учетную запись службы. Этот адрес электронной почты используется при добавлении источника данных в Cloud Search.

5. Инициализируйте стороннюю поддержку.

Прежде чем вы сможете вызывать любые другие API Cloud Search, вам необходимо инициализировать стороннюю поддержку Google Cloud Search.

Чтобы инициализировать стороннюю поддержку Cloud Search:

  1. Ваш проект платформы Cloud Search содержит учетные данные сервисной учетной записи. Однако для инициализации сторонней поддержки необходимо создать учетные данные веб-приложения. Инструкции по созданию учетных данных веб-приложения см. в разделе Создание учетных данных . По завершении этого шага у вас должен быть идентификатор клиента и секретный файл клиента.

  2. Используйте площадку Google OAuth 2 для получения токена доступа:

    1. Нажмите «Настройки» и установите флажок «Пользователь имеет свои учетные данные» .
    2. Введите идентификатор клиента и секрет клиента из шага 1.
    3. Нажмите Закрыть .
    4. В поле «Области» введите https://www.googleapis.com/auth/cloud_search.settings и нажмите «Авторизовать» . Игровая площадка OAuth 2 возвращает код авторизации.
    5. Нажмите «Код авторизации Exchange для токенов» . Токен возвращается.

  3. Чтобы инициализировать стороннюю поддержку Cloud Search, используйте следующую команду Curl. Обязательно замените [YOUR_ACCESS_TOKEN] токеном, полученным на шаге 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

    В случае успеха тело ответа содержит экземпляр operation . Например:

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

    В случае неудачи обратитесь в службу поддержки Cloud Search.

  4. Используйте Operations.get , чтобы убедиться, что инициализирована сторонняя поддержка:

    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

    Когда сторонняя инициализация завершена, она содержит поле done со значением true . Например:

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

Следующие шаги

Вот несколько следующих шагов, которые вы можете предпринять:

  1. Если вы планируете использовать Google Cloud Search с хранилищем данных, не принадлежащим Google, например Microsoft® SharePoint®, вам необходимо создать источник данных. Инструкции по добавлению источника данных см. в разделе Добавление источника данных для поиска .

  2. Настроив источник данных, вы можете создать и зарегистрировать схему , чтобы определить, как Google Cloud Search должен представлять данные в репозитории.