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

Прежде чем использовать API Google Cloud Search напрямую или через SDK, необходимо настроить доступ к нему. В этом документе описываются шаги, необходимые для использования 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. Нажмите «ВКЛЮЧИТЬ API И СЕРВИСЫ» . Откроется страница «Добро пожаловать в библиотеку API».
  3. Перейдите к API облачного поиска Google .
  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. Воспользуйтесь площадкой OAuth 2 от Google для получения токена доступа:

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

  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 должен представлять данные в репозитории.