Konfigurowanie dostępu do interfejsu Google Cloud Search API

Aby korzystać z tego interfejsu bezpośrednio lub za pomocą pakietu SDK, musisz skonfigurować dostęp do interfejsu Google Cloud Search API. Ten dokument zawiera opis czynności, które należy wykonać, aby korzystać z interfejsu Google Cloud Search API REST API.

1. Tworzenie projektu API

Aby włączyć ten interfejs API, musisz najpierw utworzyć projekt Google Cloud. Ten projekt stanowi podstawę do tworzenia, włączania i używania wszystkich usług Google Cloud, w tym zarządzania interfejsami API, włączania płatności, dodawania i usuwania współpracowników oraz zarządzania uprawnieniami.

  1. Otwórz konsolę Google Cloud.

  2. U góry strony kliknij po prawej stronie pozycji „Google Cloud Console”. Pojawi się okno z listą bieżących projektów.

  3. Kliknij NOWY PROJEKT. Pojawi się ekran „Nowy projekt”.

  4. Wpisz nazwę projektu w polu Nazwa projektu.

  5. (Opcjonalnie) Kliknij Edytuj, aby edytować identyfikator projektu. Po utworzeniu projektu nie można zmienić identyfikatora projektu, więc wybierz taki, który spełnia Twoje potrzeby przez cały okres istnienia projektu.

  6. Aby przeglądać lokalizacje dla projektu, kliknij PRZEGLĄDAJ.

  7. Kliknij lokalizację projektu i kliknij Wybierz.

  8. Kliknij Utwórz. Konsola otworzy stronę Panel. Projekt zostanie utworzony w ciągu kilku minut.

Więcej informacji o tworzeniu projektów i zarządzaniu nimi znajdziesz w artykule Tworzenie projektów i zarządzanie nimi.

2. Włącz API

Aby uzyskiwać dane logowania, musisz włączyć interfejs Google Cloud Search API i utworzyć konto usługi.

  1. Aby mieć pewność, że korzystasz z nowo utworzonego projektu, kliknij ikonę po prawej stronie banera konsoli Google Cloud i wybierz nowo utworzony projekt.
  2. Kliknij WŁĄCZ INTERFEJSY API I USŁUGI. Wyświetli się strona „Witamy w bibliotece interfejsów API”.
  3. Otwórz interfejs Google Cloud Search API.
  4. Kliknij Włącz. Pojawi się strona „Przegląd”.

Więcej informacji o włączaniu i wyłączaniu interfejsów API znajdziesz w artykule Zarządzanie interfejsami API w konsoli Google Cloud.

3. Utwórz dane logowania do konta usługi

  1. W konsoli Google Cloud kliknij Dane logowania w menu nawigacyjnym po lewej stronie. Pojawi się strona Dane logowania.
  2. Z listy Utwórz dane logowania wybierz Konto usługi. Pojawi się strona „Utwórz konto usługi”.
  3. Wpisz nazwę w polu Nazwa konta usługi.
  4. (Opcjonalnie) Edytuj identyfikator konta usługi.
  5. Kliknij Utwórz. Pojawi się ekran „Uprawnienia konta usługi”.
  6. Kliknij Dalej. Pojawi się ekran „Przyznaj użytkownikom dostęp do tego konta usługi”.
  7. Kliknij UTWÓRZ KLUCZ i kliknij Gotowe. Pojawi się okno „Klucz prywatny zapisany na komputerze”, a jego kopia zostanie pobrana na komputer.
  8. Kliknij Zamknij.

Więcej informacji o kontach usługi znajdziesz w artykule Konta usługi, aplikacje internetowe i zainstalowane aplikacje.

4. Podaj adres e-mail

  1. U góry strony w konsoli Google Cloud wybierz utworzony przez siebie projekt.
  2. Kliknij menu nawigacyjne po lewej stronie banera konsoli Google Cloud.
  3. Kliknij Administracja > Konta usługi.
  4. Na liście w sekcji „Identyfikator konta usługi” zanotuj wygenerowany adres e-mail identyfikujący skonfigurowane konto usługi. Ten adres e-mail jest używany podczas dodawania źródła danych do Cloud Search.

5. Inicjowanie pomocy innej firmy

Zanim będzie można wywoływać inne interfejsy Cloud Search API, musisz zainicjować obsługę Google Cloud Search przez firmy zewnętrzne.

Aby zainicjować obsługę Cloud Search przez inne firmy:

  1. Twój projekt platformy Cloud Search zawiera dane logowania do konta usługi. Jednak aby zainicjować pomoc innych firm, musisz utworzyć dane logowania do aplikacji internetowej. Instrukcje tworzenia danych logowania do aplikacji internetowej znajdziesz w sekcji Tworzenie danych logowania. Po wykonaniu tego kroku otrzymasz identyfikator klienta i plik z tajnym kluczem klienta.

  2. Aby uzyskać token dostępu, skorzystaj z narzędzia Google OAuth 2 do testowania:

    1. Kliknij Ustawienia i zaznacz Używaj własnych danych uwierzytelniających.
    2. Wpisz identyfikator klienta i tajny klucz klienta z kroku 1.
    3. Kliknij Zamknij.
    4. W polu zakresów wpisz https://www.googleapis.com/auth/cloud_search.settings i kliknij Autoryzuj. Środowisko testowe OAuth 2 zwraca kod autoryzacji.
    5. Kliknij Exchange authorization code for tokens (Kod autoryzacji wymiany dla tokenów). Zwracany jest token.

  3. Aby zainicjować obsługę zewnętrznej usługi Cloud Search, użyj tego polecenia curl. Zastąp [YOUR_ACCESS_TOKEN] tokenem uzyskanym w kroku 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

    Jeśli operacja się uda, treść odpowiedzi będzie zawierała wystąpienie obiektu operation. Przykład:

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

    Jeśli się to nie uda, skontaktuj się z zespołem pomocy Cloud Search.

  4. Użyj polecenia operations.get, aby sprawdzić, czy zainicjowano obsługę zewnętrzną:

    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

    Po zakończeniu inicjowania usługi zewnętrznej pole done będzie ustawione na true. Na przykład:

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

Dalsze kroki

Oto kilka czynności, które możesz wykonać:

  1. Jeśli zamierzasz używać Google Cloud Search z repozytorium danych innym niż Google, np. Microsoft® SharePoint®, musisz utworzyć źródło danych. Instrukcje dodawania źródła danych znajdziesz w sekcji Dodawanie źródła danych do wyszukiwania.

  2. Po skonfigurowaniu źródła danych możesz utworzyć i zarejestrować schemat, aby określić, jak Google Cloud Search ma przedstawiać dane w repozytorium.