Konfigurowanie dostępu do interfejsu API

Oto jak skonfigurować dostęp do interfejsu Data Manager API za pomocą pakietu SDK lub REST.

Wymagania wstępne

Zanim zaczniesz korzystać z interfejsu Data API, sprawdź, czy masz:

  1. Projekt Google Cloud. Możesz użyć dotychczasowego projektu lub utworzyć nowy specjalnie na potrzeby interfejsu Data Manager API.

  2. Konto Google, które ma uprawnienie serviceusage.services.enable w projekcie Google Cloud lub ma rolę, która obejmuje to uprawnienie. Na przykład roles/owner i roles/serviceusage.serviceUsageAdmin obejmują uprawnienie serviceusage.services.enable. Aby sprawdzić swoje uprawnienia, przeczytaj artykuł Wyświetlanie bieżącego dostępu.

  3. Zainstalowany interfejs Google Cloud CLI.

Włącz API

Jeśli nie masz jeszcze włączonego interfejsu Data Manager API, kliknij Włącz interfejs Data Manager API lub wykonaj instrukcje, aby ręcznie wykonać ten krok.

Włączanie interfejsu Data Manager API

Jeśli nie możesz znaleźć interfejsu Data Manager API lub włączenie interfejsu Data Manager API nie powiedzie się, sprawdź, czy Twoje konto Google spełnia wymagania wstępne.

Konfigurowanie uwierzytelniania

Możesz użyć dowolnej z metod uwierzytelniania w Google z wyjątkiem kluczy interfejsu API. Zalecamy zapoznanie się z artykułem Wybieranie odpowiedniej metody uwierzytelniania w zależności od przypadku użycia, aby zdecydować, które podejście jest odpowiednie w Twoim przypadku.

Dwie popularne metody uwierzytelniania to konta użytkowników i konta usługi:

  • Konta użytkowników: reprezentują osoby, które bezpośrednio korzystają z interfejsów API Google i usług Google.
  • Konta usługi: reprezentują aplikacje, a nie osoby, jako użytkowników. Umożliwiają one aplikacjom zarządzanie uwierzytelnianiem i autoryzacją. Na przykład jeśli aplikacja potrzebuje dostępu do zasobów Google Cloud.

Integracja może używać domyślnego uwierzytelniania aplikacji (ADC), aby automatycznie znajdować dane logowania w środowisku. Dzięki temu nie musisz zmieniać kodu klienta w celu uwierzytelnienia.

Aby skonfigurować ADC, wybierz Konto użytkownika lub Konto usługi:

Konto użytkownika

Aby uwierzytelnić się za pomocą danych logowania konta użytkownika:

  1. Skonfiguruj ustawienia platformy uwierzytelniania Google w projekcie.

    1. Otwórz stronę marki w konsoli Google Cloud.

    2. Wybierz projekt.

    3. Wypełnij formularz i kliknij Utwórz.

  2. Zakres interfejsu Data Manager API jest zakresem wrażliwym, dlatego wymagane są te czynności:

    1. Otwórz ustawienia Dostęp do danych w projekcie.

    2. Kliknij Dodaj lub usuń zakresy.

    3. Na liście zakresów zaznacz pole wyboru obok pozycji Data Manager API i kliknij Zaktualizuj.

    4. Kliknij Zapisz.

    5. W konsoli Google Cloud otwórz Odbiorców i zaktualizuj stan publikacji oraz typ użytkownika. Więcej informacji o tych ustawieniach znajdziesz w artykule Zarządzanie odbiorcami aplikacji.

  3. Kliknij Utwórz klienta OAuth2, aby utworzyć klienta OAuth2 w projekcie, lub postępuj zgodnie z instrukcjami, aby utworzyć klienta OAuth2 na komputer. Jeśli masz już klienta OAuth2 na komputery, którego chcesz używać w interfejsie Data Manager API, możesz pominąć ten krok.

    Jeśli klikniesz Utwórz klienta OAuth2, wybierz Aplikacja na komputer, gdy pojawi się prośba o skonfigurowanie klienta OAuth, aby móc go użyć w pozostałych krokach.

    Tworzenie klienta OAuth2

    W ostatnim kroku kliknij POBIERZ KONFIGURACJĘ KLIENTA i zanotuj wybraną lokalizację pobierania.

  4. Wygeneruj lokalny plik ADC, uruchamiając to polecenie. To polecenie uruchamia proces internetowy, w którym wyświetla się prośba o zalogowanie się na konto Google używane w interfejsie API.

    Zastąp PATH_TO_CLIENT_JSON nazwą pobranego pliku JSON.

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Jeśli chcesz używać tych samych danych logowania w przypadku interfejsu Data Manager API i interfejsu Google Ads API, dodaj zakres interfejsu Google Ads API do listy --scopes:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Jeśli chcesz używać tych samych danych logowania w przypadku interfejsu Data Manager API i Display & Video 360 API, dodaj zakres Display & Video 360 API do listy --scopes:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

  5. Aby sprawdzić, czy dane logowania zostały poprawnie skonfigurowane, użyj tego polecenia. Jeśli polecenie zadziała, w konsoli zostanie wyświetlony token dostępu.

    gcloud auth application-default print-access-token

Konto usługi

Aby uwierzytelnić się za pomocą podszywania się pod konto usługi, wykonaj te czynności. W tych krokach używa się przyjęcia tożsamości zamiast kluczy konta usługi, ponieważ klucze konta usługi mogą stanowić zagrożenie dla bezpieczeństwa, jeśli nie są starannie zarządzane.

  1. Kliknij przycisk Utwórz konto usługi lub postępuj zgodnie z instrukcjami, aby wybrać lub utworzyć konto usługi.

    Utwórz konto usługi

  2. Przypisz do konta usługi rolę Użytkownik wykorzystania usług (roles/serviceusage.serviceUsageConsumer), która obejmuje serviceusage.services.use uprawnienie umożliwiające kontu usługi wysyłanie żądań do interfejsu API w projekcie.

    gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:SERVICE_ACCOUNT_EMAIL" \
  --role="roles/serviceusage.serviceUsageConsumer"

  3. Przyznaj swojemu kontu Google rolę uprawnień Twórca tokenów konta usługi (roles/iam.serviceAccountTokenCreator) na koncie usługi.

    gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
  --member="user:USER_EMAIL" \
  --role="roles/iam.serviceAccountTokenCreator"

  4. Skonfiguruj ADC, uruchamiając to polecenie:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform"

    Jeśli chcesz używać tych samych danych logowania w przypadku interfejsu Data Manager API i interfejsu Google Ads API, dodaj zakres interfejsu Google Ads API do listy --scopes:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform"

    Jeśli chcesz używać tych samych danych logowania w przypadku interfejsu Data Manager API i Display & Video 360 API, dodaj zakres Display & Video 360 API do listy --scopes:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform"

    Gdy pojawi się prośba o zalogowanie się, zaloguj się na konto Google, które ma rolę twórcy tokenów konta usługi.

  5. Aby sprawdzić, czy dane logowania zostały poprawnie skonfigurowane, użyj tego polecenia. Jeśli polecenie zadziała, w konsoli zostanie wyświetlony token dostępu.

    gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"

Więcej informacji o uwierzytelnianiu i danych logowania aplikacji znajdziesz w artykułach Metody uwierzytelniania w Google i Jak działa domyślne uwierzytelnianie aplikacji.

Konfigurowanie dostępu do konta

Konto użytkownika

Przyznaj adresowi e-mail powiązanemu z użytkownikiem dostęp do Destination.

Konto usługi

Przyznaj adresowi e-mail powiązanemu z kontem usługi dostęp do Destination.

  • Jeśli używasz konta Google Ads, wykonaj konfigurację dostępu do konta, aby dodać konto usługi do konta Google Ads lub nadrzędnego konta menedżera Google Ads.
  • Jeśli korzystasz z konta Display & Video 360, postępuj zgodnie z instrukcjami, aby utworzyć użytkownika Display & Video 360 powiązanego z kontem usługi.
  • Jeśli używasz usługi w Google Analytics, postępuj zgodnie z instrukcjami, aby dodać adres e-mail użytkownika do konta.
  • Jeśli uzyskujesz dostęp do Destination za pomocą konta dostawcy danych z linkiem partnerskim z konta reklamodawcy, wykonaj konfigurację dostępu do konta na koncie dostawcy danych, aby dodać konto usługi i ustawić jego poziom dostępu.

Dalsze kroki

Zainstaluj bibliotekę klienta i uruchom przykłady kodu, aby wypróbować pierwsze żądanie do interfejsu Data Manager API.

Dalej
Instalowanie biblioteki klienta