Authentication

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

In den Ad Manager-Clientbibliotheken werden Standardanmeldedaten für Anwendungen verwendet. um Zugriffstokens mit Ad Manager API-Bereich zu generieren. In dieser Anleitung wird beschrieben, wie Sie Standardanmeldedaten für Anwendungen konfigurieren.

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

Weitere Informationen zur Authentifizierung und Autorisierung finden Sie in der Leitfaden OAuth 2.0 verwenden

Authentifizierungstyp ermitteln

Authentifizierungstyp Beschreibung
Dienstkonto Wählen Sie diese Option aus, wenn Sie sich als bestimmtes Konto und nicht als eine 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 über Ihr eigenes Google-Konto oder ein Dienstkonto aus Ihrer lokalen Entwicklungsumgebung authentifizieren möchten.

Ad Manager API aktivieren

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

  2. Wenn Sie dazu aufgefordert werden, wählen Sie ein Projekt aus oder erstellen Sie ein neues.

Anmeldedaten erstellen

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

Dienstkonto

Innerhalb von Google Cloud

Zum Authentifizieren einer Arbeitslast, die in Google Cloud ausgeführt wird, verwenden Sie die Anmeldedaten Das Dienstkonto, das mit der Rechenressource verknüpft ist, in der sich Ihr Code befindet ausgeführt wird.

Beispiel: Sie können 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, um die Authentifizierung außerhalb von Google Cloud einzurichten, ist um die Workload Identity-Föderation zu verwenden. erstellen Sie ein Anmeldedaten-Konfigurationsdatei und legen Sie GOOGLE_APPLICATION_CREDENTIALS fest um darauf zu verweisen. 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, das Sie erstellen möchten für einen Schlüssel.

  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 auf Nachfrage das Projekt aus, in dem Sie die Ad Manager API aktiviert haben.

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

  4. Wählen Sie den Anwendungstyp Webanwendung aus.

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

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

Folgen Sie der Anleitung unter OAuth 2.0-Zugriffstoken abrufen.

Lokale Entwicklung

Richten Sie Standardanmeldedaten für Anwendungen 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, 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 der 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. Die Dienstkontonutzer muss den entsprechenden Rollen und Teams hinzugefügt werden für Ihre API-Integration.
  6. Klicken Sie auf Speichern. Es sollte eine Meldung zur Bestätigung angezeigt werden. das Hinzufügen Ihres Dienstkontos.
  7. Rufen Sie vorhandene Dienstkontonutzer auf, indem Sie den Tab „Nutzer“ aufrufen und dann auf den Filter Dienstkonto klicken.

Webanwendung

  1. Rufen Sie Ihr Ad Manager-Netzwerk auf.
  2. Klicken Sie auf den Tab Verwalten.
  3. Der API-Zugriff muss aktiviert sein.

Lokale Entwicklung

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

Ohne Clientbibliothek

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

Eine ausführliche Anleitung zum Abrufen von Zugriffstokens finden Sie unter OAuth2 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 ein Bearer-Wert für den Authorization-HTTP-Header. Nach Möglichkeit ist der HTTP-Header die bessere Wahl, da Abfragestrings in der Regel die in den Serverprotokollen 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 Bereichen verknüpft. Ein Umfang steuert die Ressourcen und Vorgänge, die mit einem Zugriffstoken zulässig sind. Die Ad Manager API hat nur einen Umfang. Die Autorisierung sollte auf Nutzerebene innerhalb des Produkts erfolgen.

Umfang Berechtigungen
https://www.googleapis.com/auth/admanager Kampagnen abrufen und verwalten in Google Ad Manager.