Authentication

In diesem Dokument wird beschrieben, wie Sie sich bei der Ad Manager API authentifizieren. Wie Sie sich authentifizieren, hängt von der verwendeten Schnittstelle und der Umgebung ab, in der Ihr Code ausgeführt wird. Alle API-Anfragen müssen jedoch ein Zugriffstoken mit einem Ad Manager API-Bereich enthalten.

Die Ad Manager-Clientbibliotheken verwenden Standardanmeldedaten für Anwendungen, um Zugriffstokens mit Ad Manager API-Bereichen zu generieren. In diesem Leitfaden wird beschrieben, wie Sie Standardanmeldedaten für Anwendungen konfigurieren.

Wenn Sie keine Clientbibliothek verwenden, müssen Sie trotzdem Anmeldedaten erstellen und damit Ihre Anfragen autorisieren.

Weitere Informationen zur Authentifizierung und Autorisierung finden Sie im Leitfaden OAuth 2.0 verwenden.

Authentifizierungstyp ermitteln

Authentifizierungstyp Beschreibung
Dienstkonto Wählen Sie diese Option aus, wenn Sie sich als dediziertes Konto und nicht als bestimmte Person authentifizieren möchten.
Weitere Informationen
Webanwendung Wählen Sie diese Option aus, wenn Sie sich als beliebiger Nutzer authentifizieren möchten, der Ihrer Anwendung die Berechtigung zum Zugriff auf seine Ad Manager-Daten erteilt.
Weitere Informationen
Lokale Entwicklung Wählen Sie diese Option aus, wenn Sie sich in Ihrer lokalen Entwicklungsumgebung mit Ihrem eigenen Google-Konto oder einem Dienstkonto authentifizieren möchten.

Ad Manager API aktivieren

  1. Aktivieren Sie die Ad Manager API in Ihrem Google API Console Cloud-Projekt.

  2. Wählen Sie ein Projekt aus oder erstellen Sie ein neues, wenn Sie dazu aufgefordert werden.

Anmeldedaten erstellen

Klicken Sie auf den Tab für Ihren Authentifizierungstyp und folgen Sie der Anleitung, um Ihre Anmeldedaten zu erstellen:

Dienstkonto

Innerhalb von Google Cloud

Zur Authentifizierung einer in Google Cloud ausgeführten Arbeitslast verwenden Sie die Anmeldedaten des an die Compute-Ressource, in der Ihr Code ausgeführt wird, angehängten Dienstkontos.

Sie können beispielsweise ein Dienstkonto an eine Compute Engine-VM-Instanz, einen Cloud Run-Dienst oder einen Dataflow-Job anhängen. Dieser Ansatz ist die bevorzugte Authentifizierungsmethode für Code, der in einer Google Cloud-Computing-Ressource ausgeführt wird.

Informationen dazu, welche Ressourcen Sie an ein Dienstkonto anhängen können, und Hilfe beim Anhängen des Dienstkontos an die Ressource finden Sie in der Dokumentation zum Anhängen eines Dienstkontos.

Lokal oder bei einem anderen Cloud-Anbieter

Die bevorzugte Methode zum Einrichten der Authentifizierung außerhalb von Google Cloud ist die Verwendung der Workload Identity-Föderation. Sie erstellen eine Konfigurationsdatei für Anmeldedaten und legen die Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS fest, die auf ihn verweist. Dieser Ansatz ist sicherer als das Erstellen eines Dienstkontoschlüssels.

Wenn Sie keine Workload Identity-Föderation konfigurieren können, müssen Sie ein Dienstkonto und einen Schlüssel für das Dienstkonto erstellen:

  1. Öffnen Sie die Seite Google API Console-Seite "Anmeldedaten".

  2. Wählen Sie auf der Seite „Anmeldedaten“ die Option Anmeldedaten erstellen und dann Dienstkonto aus.

  3. Klicken Sie auf die E-Mail-Adresse des Dienstkontos, für das Sie einen Schlüssel erstellen möchten.

  4. Klicken Sie auf den Tab Schlüssel.

  5. Klicken Sie auf das Drop-down-Menü Schlüssel hinzufügen und wählen Sie Neuen Schlüssel erstellen aus.

  6. Wählen Sie als Schlüsseltyp JSON aus und klicken Sie dann auf Erstellen.

  7. Legen Sie für die Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS den Pfad der JSON-Datei fest.

Linux oder macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Webanwendung

  1. Öffnen Sie die Seite Google API Console-Seite "Anmeldedaten".

  2. Wählen Sie bei Aufforderung das Projekt aus, für das Sie die Ad Manager API aktiviert haben.

  3. Wählen Sie auf der Seite „Anmeldedaten“ Anmeldedaten erstellen und dann OAuth-Client-ID aus.

  4. Wählen Sie den Anwendungstyp Webanwendung aus.

  5. Füllen Sie das Formular aus und klicken Sie auf Erstellen. Für Anwendungen, die Sprachen und Frameworks wie PHP, Java, Python, Ruby und .NET verwenden, müssen autorisierte Weiterleitungs-URIs angegeben werden. Die Weiterleitungs-URIs sind die Endpunkte, an die der OAuth 2.0-Server Antworten senden kann. Diese Endpunkte müssen den Validierungsregeln von Google entsprechen.

  6. Laden Sie nach Erstellung Ihrer Anmeldedaten die Datei client_secret.json herunter. Speichern Sie die Datei an einem sicheren Speicherort, auf den nur Ihre Anwendung zugreifen kann.

Folgen Sie nun der Anleitung zum Abrufen von OAuth 2.0-Zugriffstokens.

Lokale Entwicklung

Richten Sie Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) in Ihrer lokalen Umgebung ein.

Installieren Sie die Google Cloud CLI und initialisieren Sie sie mit folgendem Befehl:

gcloud init

Erstellen Sie lokale Anmeldedaten zur Authentifizierung für Ihr Google-Konto und legen Sie die Projekt-ID für ein Projekt fest, in dem die Ad Manager API aktiviert ist:

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

Alternativ können Sie sich als Dienstkonto authentifizieren, indem Sie die Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS auf den Pfad Ihrer Schlüsseldatei festlegen.

Linux oder macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Ad Manager-Netzwerk konfigurieren

Dienstkonto

  1. Rufen Sie Ihr Ad Manager-Netzwerk auf.
  2. Klicken Sie auf den Tab Verwalten.
  3. Prüfen Sie, ob API-Zugriff aktiviert ist.
  4. Klicken Sie auf die Schaltfläche Dienstkontonutzer hinzufügen.
  5. Füllen Sie das Formular mit der E-Mail-Adresse des Dienstkontos aus. Der Dienstkontonutzer muss den entsprechenden Rollen und Teams für Ihre API-Integration hinzugefügt werden.
  6. Klicken Sie auf Speichern. Es sollte eine Meldung angezeigt werden, die bestätigt, dass Ihr Dienstkonto hinzugefügt wurde.
  7. Wenn Sie vorhandene Dienstkontonutzer aufrufen möchten, klicken Sie auf den Tab „Nutzer“ und dann auf den Filter Dienstkonto.

Webanwendung

  1. Rufen Sie Ihr Ad Manager-Netzwerk auf.
  2. Klicken Sie auf den Tab Verwalten.
  3. Prüfen Sie, ob API-Zugriff aktiviert ist.

Lokale Entwicklung

  1. Rufen Sie Ihr Ad Manager-Netzwerk auf.
  2. Klicken Sie auf den Tab Verwalten.
  3. Prüfen Sie, ob API-Zugriff aktiviert ist.

Ohne Clientbibliothek

Wenn Sie keine Clientbibliothek verwenden, empfehlen wir dringend, für die Authentifizierung eine OAuth2-Bibliothek zu verwenden.

Eine ausführliche Anleitung zum Abrufen von Zugriffstokens finden Sie unter OAuth 2.0 mit Google APIs verwenden.

Zugriffstokens

Fügen Sie Ihr Zugriffstoken in eine Anfrage an die API ein, indem Sie entweder einen access_token-Abfrageparameter oder einen Authorization-HTTP-Header Bearer-Wert einfügen. Wenn möglich, sollte der HTTP-Header verwendet werden, da Abfragestrings in der Regel in Serverlogs sichtbar sind.

Beispiel:

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

Umfang

Jedes Zugriffstoken ist mit einem oder mehreren Zugriffsbereichen verknüpft. Ein Bereich steuert die Menge der Ressourcen und Vorgänge, die ein Zugriffstoken zulässt. Die Ad Manager API hat zwei Bereiche. Wir empfehlen, den eingeschränkteren Bereich admanager.readonly zu verwenden, wenn Ihre Anwendung keine Daten schreiben muss.

Umfang Berechtigungen
https://www.googleapis.com/auth/admanager Sie können Ihre Kampagnen in Google Ad Manager aufrufen und verwalten.
https://www.googleapis.com/auth/admanager.readonly Kampagnen und Daten in Google Ad Manager aufrufen