Authentication

Z tego dokumentu dowiesz się, jak uwierzytelnić się w interfejsie API Ad Managera. Jak zależy od używanego interfejsu i środowiska, w którym jest uruchomiony, ale wszystkie żądania interfejsu API muszą zawierać token dostępu z parametrem Zakres interfejsu API Ad Managera.

Biblioteki klienta Ad Managera używają domyślnych danych logowania aplikacji. do generowania tokenów dostępu w zakresie interfejsu API Ad Managera. W tym przewodniku widać, jak skonfigurować domyślne dane logowania aplikacji.

Nawet jeśli nie korzystasz z biblioteki klienta, musisz utworzyć dane logowania i używać ich do autoryzowania żądań.

Więcej informacji o uwierzytelnianiu i autoryzowaniu znajdziesz w Przewodnik po używaniu 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 a nie konkretnej osobie.
Więcej informacji
Aplikacja internetowa Wybierz tę opcję, jeśli chcesz się uwierzytelnić jako dowolny użytkownik kto zezwoli Twojej aplikacji na dostęp swoich danych Ad Managera.
Więcej informacji
Programowanie lokalne Wybierz tę opcję, jeśli chcesz się uwierzytelnić jako własne konta Google lub konta usługi z lokalnego w środowisku programistycznym.

Włączanie interfejsu Ad Manager API

  1. Włącz interfejs API Ad Managera w Projekt Cloud Console 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ę odpowiedniego typu uwierzytelniania i postępuj zgodnie z instrukcjami utwórz swoje dane logowania:

Konto usługi

W Google Cloud

Do uwierzytelnienia zadania uruchomionego w Google Cloud użyjesz danych logowania konto usługi połączone z zasobem obliczeniowym, w którym znajduje się Twój kod w domu.

Możesz na przykład połączyć konto usługi z maszyną wirtualną Compute Engine maszynie wirtualnej, usłudze Cloud Run lub zadaniu Dataflow. To podejście to preferowana metoda uwierzytelniania w przypadku kodu działającego w Google Cloud zasobów obliczeniowych.

Aby uzyskać informacje o zasobach, do których możesz dołączyć konto usługi, i pomoc dotyczącą dołączania konta usługi do zasobu, zapoznaj się z dokumentacji dotyczącej dołączania konta usługi.

Lokalnie lub u innego dostawcy chmury

Preferowaną metodą konfiguracji uwierzytelniania spoza Google Cloud jest korzystać z federacji tożsamości zadań; tworzysz pliku konfiguracji danych logowania i ustaw GOOGLE_APPLICATION_CREDENTIALS wskazującą zmienną środowiskową. To rozwiązanie jest bezpieczniejsze niż przez utworzenie klucza konta usługi.

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

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

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

  3. Kliknij adres e-mail konta usługi, które 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 Konsoli interfejsów API Google.

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

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

  4. Jako typ aplikacji wybierz Aplikacja internetowa.

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

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

Następnie wykonaj czynności umożliwiające uzyskanie tokenów dostępu OAuth 2.0.

Programowanie lokalne

Skonfiguruj domyślne dane logowania aplikacji (ADC) w swoim ś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, w którym włączony jest interfejs Ad Manager API:

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 i ustawić środowisko GOOGLE_APPLICATION_CREDENTIALS do ścieżki 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. Upewnij się, że Dostęp API jest włączony.
  4. Kliknij przycisk Dodaj użytkownika konta usługi.
  5. Wypełnij formularz, korzystając z adresu e-mail konta usługi. użytkownika konta usługi należy dodać do odpowiednich ról i zespołów integracji z interfejsem API.
  6. Kliknij przycisk Zapisz. Powinien wyświetlić się komunikat z potwierdzeniem po dodaniu konta usługi.
  7. Aby wyświetlić istniejących użytkowników konta usługi, otwórz kartę Użytkownicy, a następnie klikając filtr Konto usługi.

Aplikacja internetowa

  1. Otwórz sieć Ad Managera.
  2. Kliknij kartę Administrator.
  3. Upewnij się, że Dostęp API jest włączony.

Programowanie lokalne

  1. Otwórz sieć Ad Managera.
  2. Kliknij kartę Administrator.
  3. Upewnij się, że Dostęp API jest włączony.

Bez biblioteki klienta

Jeśli nie korzystasz z biblioteki klienta, zdecydowanie zalecamy użycie biblioteki OAuth2 do uwierzytelniania.

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

Tokeny dostępu

Umieść swój token dostępu w żądaniu do interfejsu API, umieszczając w nim Parametr zapytania access_token lub wartość nagłówka HTTP Bearer Authorization. W miarę możliwości preferowany jest nagłówek HTTP, ponieważ ciągi zapytań są zwykle widoczne w dziennikach serwerów.

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 kontroluje zbiór zasobów i operacji, na które zezwala token dostępu. W usłudze Ad Manager Interfejs API REST ma tylko 1 zakres. Autoryzacja powinna być wykonywana na poziomie użytkownika na poziomie usługi.

Zakres Uprawnienia
https://www.googleapis.com/auth/admanager Wyświetlanie kampanii i zarządzanie nimi o usłudze Google Ad Manager.