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

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

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

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

  1. Откройте облачную консоль Google .

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

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

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

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

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

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

  8. Щелкните Создать . Консоль перейдет на страницу Dashboard. Проект создается за несколько минут.

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

2. Включите API

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

  1. Чтобы убедиться, что вы находитесь во вновь созданном проекте, щелкните значок справа от баннера консоли Google Cloud и выберите только что созданный проект.
  2. Щелкните ВКЛЮЧИТЬ API И УСЛУГИ . Появится страница «Добро пожаловать в библиотеку API».
  3. Перейдите к Google Cloud Search API .
  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 должен представлять данные в репозитории.