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órego chcesz używać jako właściciela projektu.

    • Jeśli nie masz projektu, proces konfiguracji w następnej sekcji utworzy go dla Ciebie.

    • Jeśli masz już projekt, upewnij się, że Twoje konto Google ma rolę, która umożliwia włączanie interfejsów API w projekcie, np. Właściciel, Edytujący, lub Administrator korzystania z usługi. Aby sprawdzić swoją rolę, otwórz stronę Uprawnienia w konsoli Google Cloud, wybierz swój projekt i znajdź swoje konto Google na liście.

      Więcej informacji znajdziesz w artykule Wyświetlanie bieżącego dostępu.

  2. Zainstalowany interfejs wiersza poleceń Google Cloud zainstalowany.

Włączanie interfejsu API

Jeśli jeszcze tego nie zrobisz, włącz interfejs Data Manager API w projekcie w chmurze Google Cloud, klikając Włącz interfejs Data Manager API lub wykonaj instrukcje, aby wykonać ten krok ręcznie.

Włącz interfejs Data Manager API

Jeśli nie możesz znaleźć interfejsu Data Manager API lub kliknięcie Włącz interfejs Data Manager API nie działa, sprawdź czy Twoje konto Google spełnia wymagania wstępne.

Konfigurowanie uwierzytelniania

Oprócz kluczy interfejsu API możesz użyć dowolnej metody uwierzytelniania w Google. 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. Umożliwiają aplikacjom zarządzanie uwierzytelnianiem i autoryzacją. Na przykład jeśli aplikacja musi uzyskać dostęp do zasobów Google Cloud.

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

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

Konto użytkownika

Oto czynności, które musisz wykonać, aby uwierzytelnić się za pomocą danych logowania do konta użytkownika:

  1. Skonfiguruj ustawienia platformy Google Auth dla swojego projektu.

    1. W konsoli Google Cloud otwórz stronę Branding.

    2. Wybierz projekt.

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

  2. Interfejs Data Manager API używa zakresów związanych z poufnymi danymi, dlatego musisz wykonać te czynności:

    1. Otwórz ustawienia dostępu do danych w projekcie.

    2. Kliknij Dodaj lub usuń zakresy.

    3. Na liście zakresów znajdź Data Manager API i zaznacz pole obok każdego zakresu, którego wymaga Twoja aplikacja:

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

      • .../auth/datamanager.partnerlink: wybierz ten zakres tylko wtedy, gdy jesteś dostawcą danych, który tworzy lub usuwa linki partnerskie na kontach reklamodawców.

    4. Kliknij Aktualizuj.

    5. Kliknij Zapisz.

    6. W konsoli Google Cloud otwórz sekcję Odbiorcy i skonfiguruj ustawienia na potrzeby wstępnego tworzenia:

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

      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. Jeśli masz już klienta OAuth2 na komputerze , którego chcesz używać w interfejsie Data Manager API, możesz pominąć ten krok.

    Jeśli klikniesz Utwórz klienta OAuth2, gdy pojawi się prośba o skonfigurowanie klienta OAuth, wybierz aplikacja komputerowa, aby móc używać klienta 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 musisz zalogować 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 interfejsie Data Manager API i w Google Ads API, dodaj zakres 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 interfejsie Data Manager API i Display & Video 360 API, dodaj zakres Display & Video 360 API do --scopes listy:

    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. Użyj tego polecenia, aby sprawdzić, czy dane logowania są prawidłowo skonfigurowane. Jeśli polecenie zadziała, wyświetli w konsoli token dostępu.

    gcloud auth application-default print-access-token

Konto usługi

Oto czynności, które musisz wykonać, aby utworzyć konto usługi i użyć przyjęcia tożsamości konta usługi do uwierzytelnienia w lokalnym środowisku programistycznym. Te czynności używają 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ą odpowiednio zarządzane.

  1. Kliknij ten przycisk Utwórz konto usługi lub postępuj zgodnie z instrukcjami w celu wybrania lub utworzenia konta usługi.

    Utwórz konto usługi

  2. Przyznaj kontu usługi rolę konsument Wykorzystania usług IAM (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 interfejsie Data Manager API i w Google Ads API, dodaj zakres 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 interfejsie Data Manager API i Display & Video 360 API, dodaj zakres Display & Video 360 API do --scopes listy:

    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. Użyj tego polecenia, aby sprawdzić, czy dane logowania są prawidłowo skonfigurowane. Jeśli polecenie zadziała, wyświetli w konsoli 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 w 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.
  • 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ą link partnerski do konta dostawcy danych, wybierz Dostawca danych. Konta dostawców danych są przyznawane tylko 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 do uzyskiwania dostępu 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 wykonując te czynności.

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.
  • 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ą link partnerski do konta dostawcy danych, wybierz Dostawca danych. Konta dostawców danych są przyznawane tylko 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.

Aby dodać konto usługi do konta Google Ads lub nadrzędnego konta menedżera Google Ads, skonfiguruj dostęp do konta.

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 sekcji Konfigurowanie dostępu do konta.

Dalsze kroki

Dalej
Instalowanie biblioteki klienta