Konfigurowanie dostępu do interfejsu Google Cloud Search API

Zanim zaczniesz korzystać z interfejsu Google Cloud Search API bezpośrednio lub za pomocą pakietu SDK, musisz skonfigurować do niego dostęp. W tym dokumencie opisujemy czynności, które należy wykonać, aby korzystać z interfejsu Google Cloud Search API REST.

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 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 „Konsola 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) Kliknij Edytuj, aby edytować identyfikator projektu. Po utworzeniu projektu nie można zmienić jego identyfikatora, więc wybierz taki, który będzie Ci odpowiadać przez cały okres jego istnienia.

  6. Aby przejrzeć lokalizacje projektu, kliknij PRZEGLĄDAJ.

  7. Kliknij lokalizację projektu i kliknij Wybierz.

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

  1. Aby upewnić się, że jesteś 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. Wyświetli się strona „Witamy w bibliotece interfejsów API”.
  3. Otwórz Google Cloud Search API.
  4. Kliknij Włącz. Wyświetli 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 po lewej stronie. Pojawi się strona Dane logowania.
  2. Na liście Utwórz dane logowania wybierz Konto usługi. Pojawi się strona „Utwórz konto usługi”.
  3. W polu Nazwa konta usługi wpisz odpowiednią nazwę.
  4. (Opcjonalnie) Edytuj 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 UTWÓRZ KLUCZ i Gotowe. Pojawi się okno „Klucz prywatny został zapisany na komputerze”, a 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 aplikacje zainstalowane.

4. Określanie adresu e-mail

  1. W konsoli Google Cloud wybierz u góry strony 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” 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 obsługi innych firm

Zanim wywołasz inne interfejsy Cloud Search API, musisz zainicjować obsługę innych firm w Google Cloud Search.

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

  1. Projekt platformy Cloud Search zawiera dane logowania do konta usługi. Aby jednak zainicjować obsługę zewnętrznych dostawców, musisz utworzyć dane logowania aplikacji internetowej. Instrukcje tworzenia danych logowania aplikacji internetowej znajdziesz w artykule Tworzenie danych logowania. Po wykonaniu tego kroku powinny być dostępne pliki identyfikatora klienta i tajnego klucza klienta.

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

    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 Wymień kod autoryzacji na tokeny. Zwracany jest token.

  3. Aby zainicjować obsługę Cloud Search przez firmy zewnętrzne, 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 pomoże, skontaktuj się z zespołem pomocy Cloud Search.

  4. Użyj 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 przez firmę zewnętrzną zawiera pole done ustawione na 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ć 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 artykule Dodawanie źródła danych do wyszukiwania.

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