Konfigurowanie dostępu do interfejsu Google Cloud Search API

Zanim użyjesz interfejsu Google Cloud Search API bezpośrednio lub za pomocą pakietu SDK, musisz skonfigurować dostęp do tego interfejsu. W tym dokumencie opisano czynności wymagane do korzystania z interfejsu API REST Google Cloud Search API.

1. Tworzenie projektu interfejsu API

Aby włączyć 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 do zarządzania interfejsami API, włączania rozliczeń, 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 „Konsoli Google Cloud”. Wyświetli się okno z listą bieżących projektów.

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

  4. W polu Nazwa projektu wpisz nazwę projektu.

  5. (Opcjonalnie) Aby edytować identyfikator projektu, kliknij Edytuj. Po utworzeniu projektu nie można zmienić jego identyfikatora, dlatego wybierz taki, który będzie odpowiadał Twoim potrzebom przez cały czas trwania projektu.

  6. Aby przejrzeć lokalizacje w projekcie, kliknij PRZEGLĄD.

  7. Kliknij lokalizację projektu i wybierz Wybierz.

  8. Kliknij Utwórz. Konsola przejdzie do strony Panelu. 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 uzyskać dane logowania, musisz włączyć interfejs Google Cloud Search API i utworzyć konto usługi.

  1. Aby mieć pewność, że pracujesz w nowo utworzonym projekcie, kliknij ikonę po prawej stronie banera konsoli Google Cloud i wybierz nowo utworzony projekt.
  2. Kliknij WŁĄCZ INTERFEJSY API I USŁUGI. Pojawi się strona „Witamy w bibliotece interfejsów API”.
  3. Otwórz stronę 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 Google Cloud Console.

3. Tworzenie danych 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. Na liście Utwórz dane logowania kliknij Konto usługi. Pojawi się strona „Tworzenie konta usługi”.
  3. Wpisz nazwę w polu Nazwa konta usługi.
  4. (Opcjonalnie) Zmień identyfikator konta usługi.
  5. Kliknij Utwórz. Wyświetli się ekran „Uprawnienia konta usługi”.
  6. Kliknij Dalej. Pojawi się ekran „Przyznaj użytkownikom dostęp do tego konta usługi”.
  7. Kliknij kolejno UTWÓRZ KLUCZ i Gotowe. Pojawi się okno „Klucz prywatny został zapisany na komputerze” i kopia klucza prywatnego 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. Identyfikacja adresu e-mail

  1. W konsoli Google Cloud u góry strony wybierz utworzony 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” zapisz wygenerowany adres e-mail, który identyfikuje skonfigurowane konto usługi. Ten adres e-mail jest używany podczas dodawania źródła danych do Cloud Search.

5. Inicjowanie pomocy zewnętrznej

Zanim zaczniesz wywoływać inne interfejsy Cloud Search, musisz zainicjować obsługę Google Cloud Search przez zewnętrznych dostawców.

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ć obsługę przez zewnętrznego dostawcę, musisz utworzyć dane logowania do aplikacji internetowej. Instrukcje tworzenia danych logowania do aplikacji internetowej znajdziesz w artykule Tworzenie danych logowania. Po wykonaniu tego kroku powinieneś mieć identyfikator klienta i tajny klucz klienta.

  2. Aby uzyskać token dostępu, użyj narzędzia Google OAuth 2 Playground:

    1. Kliknij Ustawienia i zaznacz Użyj własnych danych logowania.
    2. Wpisz identyfikator 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. Narzędzie OAuth 2 Playground zwraca kod autoryzacji.
    5. Kliknij Kod autoryzacji wymiany dla tokenów. Zwracany jest token.

  3. Aby zainicjować obsługę Cloud Search przez inne firmy, użyj tego polecenia curl: Pamiętaj, aby zastąpić [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 to nie zadziała, skontaktuj się z zespołem pomocy Cloud Search.

  4. Aby sprawdzić, czy obsługa zewnętrzna jest zainicjowana, użyj wywołania 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

    Po zakończeniu inicjalizacji przez usługę innej firmy pole done będzie zawierać wartość true. Na przykład:

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

Następne kroki

Oto kilka kolejnych kroków, które możesz wykonać:

  1. Jeśli planujesz używać wyszukiwarki Google Cloud z repozitorium danych spoza Google, takim jak Microsoft® SharePoint®, musisz utworzyć źródło danych. Instrukcje dodawania źródła danych znajdziesz w artykule 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 reprezentować dane w repozytorium.