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, upewnij się, że masz:

  1. Projekt Google Cloud. Możesz użyć istniejącego 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 rolę obejmującą to uprawnienie. Na przykład role 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 installed.

Włączanie interfejsu API

Jeśli jeszcze tego nie zrobisz, włącz interfejs Data Manager API, klikając Włącz interfejs Data Manager API lub wykonaj te czynności ręcznie.

Włącz interfejs Data Manager API

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

Konfigurowanie uwierzytelniania

Oprócz kluczy interfejsu API możesz używać dowolnych metod uwierzytelniania w Google. Aby zdecydować, które podejście jest odpowiednie w Twoim przypadku, zapoznaj się z artykułem Wybieranie odpowiedniej metody uwierzytelniania.

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 uwierzytelniające 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

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. Zakres interfejsu Data Manager API jest zakresem wrażliwym, dlatego wymagane są 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 zaznacz pole obok pozycji Data Manager API i kliknij Zaktualizuj.

    4. Kliknij Zapisz.

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

  3. Aby utworzyć klienta OAuth2 w projekcie, kliknij Utwórz klienta OAuth2 lub wykonaj instrukcje tworzenia 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 na komputer, aby móc używać klienta w pozostałych krokach.

    Utwórz 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 interfejsach Data Manager API i interfejs Google Ads API, dodaj zakres interfejsu Google Ads API do --scopes listy:

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

    gcloud auth application-default print-access-token

Konto usługi

Aby uwierzytelnić się za pomocą personifikacji konta usługi: W tych krokach używamy personifikacji 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 wykonaj instrukcje, aby wybrać lub utworzyć konto usługi.

    Utwórz konto usługi

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

    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 interfejsach Data Manager API i interfejs Google Ads API, dodaj zakres interfejsu Google Ads 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/adwords,https://www.googleapis.com/auth/cloud-platform"

    Jeśli chcesz używać tych samych danych logowania w interfejsach 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órca tokenów konta usługi.

  5. Aby potwierdzić, że dane logowania są prawidłowo skonfigurowane, użyj tego polecenia. 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łają 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ą połączenie partnerskie z kontem dostawcy danych, wybierz Dostawca danych.

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 partnera danych.

Dodaj adres e-mail użytkownika do konta partnera danych w interfejsie Google Ads wykonując te instrukcje.

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ą połączenie partnerskie z kontem dostawcy danych, wybierz Dostawca danych.

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 partnera 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

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

Dalej
Instalowanie biblioteki klienta