Authentication

W tym dokumencie opisano, jak uwierzytelniać się w interfejsie API Ad Managera. Sposób uwierzytelniania zależy od używanego interfejsu i środowiska, w którym działa kod, ale wszystkie żądania do interfejsu API muszą zawierać token dostępu z zakresem interfejsu API Ad Managera.

Biblioteki klienta Ad Managera używają domyślnego uwierzytelniania aplikacji do generowania tokenów dostępu z zakresami interfejsu API Ad Managera. Z tego przewodnika dowiesz się, jak skonfigurować domyślne uwierzytelnianie aplikacji.

Jeśli nie używasz biblioteki klienta, musisz utworzyć dane uwierzytelniające i używać ich do autoryzowania żądań.

Więcej informacji o uwierzytelnianiu i autoryzacji znajdziesz w przewodniku Korzystanie z protokołu OAuth 2.0.

Określanie typu uwierzytelniania

Typ uwierzytelniania Opis
Konto usługi Wybierz tę opcję, jeśli chcesz uwierzytelniać się jako dedykowane konto, a nie konkretna osoba.
Więcej informacji
Aplikacja internetowa Wybierz tę opcję, jeśli chcesz uwierzytelniać się jako dowolny użytkownik, który przyzna Twojej aplikacji uprawnienia dostępu do swoich danych w usłudze Ad Manager.
Więcej informacji
Programowanie lokalne Wybierz tę opcję, jeśli chcesz uwierzytelniać się jako własne konto Google lub konto usługi z lokalnego środowiska programistycznego.

Włączanie interfejsu API Ad Managera

  1. Włącz interfejs API Ad Managera w projekcie w chmurze w Konsoli interfejsów API Google.

  2. Jeśli pojawi się taka prośba, wybierz projekt lub utwórz nowy.

Utwórz dane logowania

Kliknij kartę odpowiadającą Twojemu typowi uwierzytelniania i postępuj zgodnie z instrukcjami, aby utworzyć dane logowania:

Konto usługi

W Google Cloud

Aby uwierzytelnić zadanie uruchomione w Google Cloud, użyj danych logowania konta usługi powiązanego z zasobem obliczeniowym, w którym działa Twój kod.

Możesz na przykład podłączyć konto usługi do instancji maszyny wirtualnej Compute Engine, usługi Cloud Run lub zadania Dataflow. To podejście jest preferowaną metodą uwierzytelniania kodu działającego w zasobie obliczeniowym Google Cloud.

Informacje o tym, do których zasobów możesz podłączyć konto usługi, oraz pomoc dotyczącą podłączania konta usługi do zasobu znajdziesz w dokumentacji na temat podłączania konta usługi.

Lokalnie lub u innego dostawcy chmury

Preferowaną metodą konfigurowania uwierzytelniania spoza Google Cloud jest użycie federacji tożsamości zadań. Tworzysz plik konfiguracji danych logowania i ustawiasz zmienną środowiskową GOOGLE_APPLICATION_CREDENTIALS, aby wskazywała na ten plik. To podejście jest bezpieczniejsze niż tworzenie klucza konta usługi.

Jeśli nie możesz skonfigurować federacji tożsamości zadań, musisz utworzyć konto usługi i klucz do niego:

  1. Otwórz stronę Dane logowania w Konsoli interfejsów API Google.

  2. Na stronie Dane logowania kliknij Utwórz dane logowania, a następnie wybierz Konto usługi.

  3. Kliknij adres e-mail konta usługi, dla którego chcesz utworzyć klucz.

  4. Kliknij kartę Klucze.

  5. Kliknij menu Dodaj klucz i wybierz Utwórz nowy klucz.

  6. W polu Typ klucza wybierz JSON i kliknij Utwórz.

  7. Ustaw zmienną środowiskową GOOGLE_APPLICATION_CREDENTIALS na ścieżkę pliku JSON.

Linux lub macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Aplikacja internetowa

  1. Otwórz stronę Dane logowania w Konsoli interfejsów API Google.

  2. Jeśli pojawi się taka prośba, wybierz projekt, w którym został włączony interfejs API Ad Managera.

  3. Na stronie Dane logowania kliknij Utwórz dane logowania, a następnie wybierz Identyfikator klienta OAuth.

  4. Wybierz typ aplikacji Aplikacja internetowa.

  5. Wypełnij formularz i kliknij Utwórz. Aplikacje, które używają języków i platform takich jak PHP, Java, Python, Ruby i .NET, muszą określać autoryzowane identyfikatory URI przekierowania. Identyfikatory URI przekierowania to punkty końcowe, do których serwer OAuth 2.0 może wysyłać odpowiedzi. Te punkty końcowe muszą być zgodne z regułami weryfikacji Google.

  6. Po utworzeniu danych logowania pobierz plik client_secret.json. Bezpiecznie przechowuj plik w lokalizacji, do której dostęp ma tylko Twoja aplikacja.

Następnie wykonaj czynności opisane w sekcji Uzyskiwanie tokenów dostępu OAuth 2.0.

Programowanie lokalne

Skonfiguruj domyślne uwierzytelnianie aplikacji (ADC) w środowisku lokalnym.

Zainstaluj Google Cloud CLI, a następnie zainicjuj go, uruchamiając to polecenie:

gcloud init

Utwórz lokalne dane uwierzytelniające dla swojego konta Google i ustaw identyfikator projektu na projekt, w którym włączony jest interfejs API Ad Managera:

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

Możesz też uwierzytelnić się jako konto usługi, ustawiając zmienną środowiskową GOOGLE_APPLICATION_CREDENTIALS na ścieżkę pliku klucza.

Linux lub macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Konfigurowanie sieci Ad Managera

Konto usługi

  1. Otwórz sieć Ad Managera.
  2. Kliknij kartę Administrator.
  3. Sprawdź, czy dostęp do interfejsu API jest włączony.
  4. Kliknij przycisk Dodaj użytkownika konta usługi.
  5. Wypełnij formularz, używając adresu e-mail konta usługi. Użytkownik konta usługi musi zostać dodany do odpowiednich ról i zespołów na potrzeby integracji interfejsu API.
  6. Kliknij przycisk Zapisz. Powinien pojawić się komunikat potwierdzający dodanie konta usługi.
  7. Aby wyświetlić istniejących użytkowników konta usługi, otwórz kartę Użytkownicy i kliknij filtr Konto usługi.

Aplikacja internetowa

  1. Otwórz sieć Ad Managera.
  2. Kliknij kartę Administrator.
  3. Sprawdź, czy dostęp do interfejsu API jest włączony.

Programowanie lokalne

  1. Otwórz sieć Ad Managera.
  2. Kliknij kartę Administrator.
  3. Sprawdź, czy dostęp do interfejsu API jest włączony.

Bez biblioteki klienta

Jeśli nie używasz biblioteki klienta, zdecydowanie zalecamy używanie biblioteki OAuth2 do uwierzytelniania.

Szczegółowe instrukcje uzyskiwania tokenów dostępu znajdziesz w artykule Używanie protokołu OAuth2 z interfejsami API Google.

Tokeny dostępu

Dołącz token dostępu do żądania do interfejsu API, dodając parametr zapytania access_token lub wartość nagłówka HTTP Authorization Bearer. Jeśli to możliwe, lepiej używać nagłówka HTTP, ponieważ ciągi zapytań są zwykle widoczne w logach serwera.

Na przykład:

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX

GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

Zakres

Każdy token dostępu jest powiązany z co najmniej 1 zakresem. Zakres określa zbiór zasobów i operacji, na które zezwala token dostępu. Interfejs API Ad Managera ma 2 zakresy. Jeśli Twoja aplikacja nie musi zapisywać danych, zalecamy użycie węższego zakresu admanager.readonly.

Zakres Uprawnienia
https://www.googleapis.com/auth/admanager Wyświetlaj kampanie i zarządzaj nimi w usłudze Google Ad Manager.
https://www.googleapis.com/auth/admanager.readonly Przeglądaj kampanie i dane w usłudze Google Ad Manager.