Konfigurowanie dostępu do interfejsu API

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

Wymagania wstępne

  1. Projekt Google Cloud lub konto Google, które ma być właścicielem projektu.

  2. Zainstalowany interfejs wiersza poleceń Google Cloud CLI.

Włącz API

Jeśli nie masz jeszcze włączonego interfejsu Data Manager API w projekcie Google Cloud, kliknij Włącz interfejs Data Manager API lub postępuj zgodnie z instrukcjami, aby wykonać ten krok ręcznie.

Włączanie interfejsu Data Manager API

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

Konfigurowanie uwierzytelniania

Możesz użyć dowolnej metody uwierzytelniania w Google oprócz kluczy interfejsu API. Zalecamy zapoznanie się z artykułem Wybieranie odpowiedniej metody uwierzytelniania dla danego przypadku użycia, aby zdecydować, które podejście jest odpowiednie dla Twojego przypadku użycia.

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 ludzi, jako użytkowników. Umożliwiają aplikacjom zarządzanie uwierzytelnianiem i autoryzacją. Na przykład gdy aplikacja potrzebuje dostępu do zasobów Google Cloud.

Integracja może używać domyślnego uwierzytelniania aplikacji (ADC) do automatycznego znajdowania danych uwierzytelniających w środowisku, dzięki czemu nie musisz zmieniać kodu klienta w celu uwierzytelnienia.

Wybierz Konto użytkownika lub Konto usługi, aby skonfigurować ADC:

Konto użytkownika

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

  1. Skonfiguruj ustawienia platformy uwierzytelniania Google dla swojego projektu.

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

    2. Wybierz projekt.

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

  2. Interfejs Data Manager API używa zakresów poufnych, dlatego musisz wykonać 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 znajdź Data Manager API i zaznacz pole wyboru przy każdym zakresie, którego wymaga Twoja aplikacja:

      • .../auth/datamanager: wybierz ten zakres w przypadku standardowych operacji interfejsu API, takich jak zarządzanie danymi klientów, listami odbiorców i zdarzeniami. Jest to podstawowy zakres używany w tym przewodniku.

      • .../auth/datamanager.partnerlink: wybierz ten zakres tylko wtedy, gdy jesteś dostawcą danych i tworzysz lub usuwasz połączenia partnerów na kontach reklamodawców.

    4. Kliknij Aktualizuj.

    5. Kliknij Zapisz.

    6. W konsoli Google Cloud otwórz Odbiorcy i skonfiguruj ustawienia na potrzeby początkowego etapu programowania:

      • Ustaw Stan publikacji na Testowanie.
      • Ustaw Typ użytkownika na Wewnętrzny (jeśli projekt jest w organizacji Google Workspace) lub Zewnętrzny (jeśli nie jest).
      • Jeśli używasz opcji Zewnętrzny, dodaj konta Google, których używasz do generowania danych logowania, jako Użytkownicy testowi.

      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 komputerze. Możesz pominąć ten krok, jeśli masz już klienta OAuth2 na komputery, którego chcesz używać z interfejsem Data Manager API.

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

    Tworzenie klienta OAuth2

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

  4. Wygeneruj lokalny plik ADC, uruchamiając poniższe polecenie. To polecenie uruchamia proces internetowy, w którym pojawi się prośba o zalogowanie się na konto Google używane z interfejsem 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 interfejsu 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. Sprawdź, czy dane logowania są prawidłowo skonfigurowane, używając tego polecenia. Jeśli polecenie zadziała, wyświetli token dostępu w konsoli.

    gcloud auth application-default print-access-token

Konto usługi

Oto instrukcje tworzenia konta usługi i używania przyjęcia tożsamości konta usługi do uwierzytelniania w lokalnym środowisku programistycznym. W tych krokach używamy personifikacji zamiast kluczy kont usługi, ponieważ klucze kont usługi mogą stanowić zagrożenie dla bezpieczeństwa, jeśli nie są odpowiednio zarządzane.

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

    Tworzenie konta usługi

  2. Przypisz do konta usługi rolę uprawnień konsument Wykorzystania usług (roles/serviceusage.serviceUsageConsumer), która obejmuje uprawnienie serviceusage.services.use 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. Przypisz do swojego konta 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 interfejsu 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, zaloguj się na konto Google, które ma rolę Twórca tokenów konta usługi.

  5. Sprawdź, czy dane logowania są prawidłowo skonfigurowane, używając 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

Wybierz kartę odpowiadającą Twojemu przypadkowi użycia.

  • Jeśli używasz danych logowania do konta Google, które jest użytkownikiem na kontach reklamodawców, którymi chcesz zarządzać, wybierz Reklamodawca.
  • Wybierz Dostawca danych, jeśli używasz danych logowania do konta Google, które jest użytkownikiem na koncie dostawcy danych, i chcesz zarządzać kontami reklamodawców, które mają połączenie partnerskie z kontem dostawcy danych. Konta dostawców danych są wydawane dopiero po przejściu procesu zatwierdzania. Aby rozpocząć, wypełnij formularz zgłoszenia zainteresowania.

Reklamodawca

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

Postępuj zgodnie z instrukcjami, aby dodać adres e-mail użytkownika do konta Google Ads lub nadrzędnego konta menedżera Google Ads.

Display & Video 360

Postępuj zgodnie z instrukcjami, aby dodać adres e-mail użytkownika do konta.

Google Analytics

Postępuj zgodnie z instrukcjami, aby dodać adres e-mail użytkownika do konta.

Dostawca danych

Przyznaj adresowi e-mail powiązanemu z użytkownikiem dostęp do konta dostawcy danych. Dostawcy danych zwykle używają konta usługi, aby uzyskać dostęp do interfejsu API. Jeśli jednak używasz konta użytkownika do testowania lub innych celów, musisz przyznać mu dostęp do konta dostawcy danych.

Dodaj adres e-mail użytkownika do konta dostawcy danych w interfejsie Google Ads, postępując zgodnie z tymi instrukcjami.

Konto usługi

Wybierz kartę odpowiadającą Twojemu przypadkowi użycia.

  • Jeśli używasz danych logowania do konta Google, które jest użytkownikiem na kontach reklamodawców, którymi chcesz zarządzać, wybierz Reklamodawca.
  • Wybierz Dostawca danych, jeśli używasz danych logowania do konta Google, które jest użytkownikiem na koncie dostawcy danych, i chcesz zarządzać kontami reklamodawców, które mają połączenie partnerskie z kontem dostawcy danych. Konta dostawców danych są wydawane dopiero po przejściu procesu zatwierdzania. Aby rozpocząć, wypełnij formularz zgłoszenia zainteresowania.

Reklamodawca

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

Dokończ konfigurowanie dostępu do konta, aby dodać konto usługi do konta Google Ads lub do nadrzędnego konta menedżera Google Ads.

Display & Video 360

Postępuj zgodnie z instrukcjami, aby utworzyć użytkownika Display & Video 360 powiązanego z kontem usługi.

Google Analytics

Postępuj zgodnie z instrukcjami, aby dodać adres e-mail konta usługi do konta.

Dostawca danych

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

Dostęp do konta dostawcy danych jest zarządzany w interfejsie Google Ads. Aby dodać konto usługi i ustawić jego poziom dostępu, wykonaj czynności opisane w artykule Konfigurowanie dostępu do konta.

Dalsze kroki

Dalej
Instalowanie biblioteki klienta