In diesem Dokument wird die Authentifizierung bei der Ad Manager API beschrieben. 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 dem 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 diesem Leitfaden erfahren Sie, wie Standardanmeldedaten für Anwendungen konfiguriert werden.
Auch wenn Sie keine Clientbibliothek verwenden, müssen Sie Anmeldedaten erstellen. und zum Autorisieren Ihrer Anfragen verwenden.
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, wenn Sie sich als zweckbestimmte Daten authentifizieren möchten
und nicht auf eine bestimmte Person. Weitere Informationen |
| Webanwendung | Wählen Sie diese Option, wenn Sie sich als beliebiger Nutzer authentifizieren möchten
die Ihrer Anwendung die Berechtigung zum Zugriff
für ihre Ad Manager-Daten. Weitere Informationen |
| Lokale Entwicklung | Wählen Sie diese Option, wenn Sie sich als Ihr eigenes authentifizieren möchten Google-Konto oder ein lokales Dienstkonto Entwicklungsumgebung. |
Ad Manager API aktivieren
Aktivieren Sie die Ad Manager API in Ihrem Google API Console Cloud-Projekt.
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 Ihren Authentifizierungstyp und folgen Sie der Anleitung, um Erstellen Sie Ihre Anmeldedaten:
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.
Sie können z. B. ein Dienstkonto an ein virtuelles Compute Engine-Konto VM-Instanz, einen Cloud Run-Dienst oder einen Dataflow-Job. Dieser Ansatz ist die bevorzugte Authentifizierungsmethode für Code, der in einer Google Cloud Computing-Ressource.
Informationen dazu, an welche Ressourcen Sie ein Dienstkonto anhängen können, Informationen zum 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
Dienstkontoschlüssel erstellen.
Wenn Sie die Identitätsföderation von Arbeitslasten nicht konfigurieren können, müssen Sie Erstellen Sie ein Dienstkonto und einen Schlüssel für das Dienstkonto:
Öffnen Sie die Seite Google API Console-Seite "Anmeldedaten".
Wählen Sie auf der Seite „Anmeldedaten“ die Option Anmeldedaten erstellen aus. Wählen Sie Dienstkonto aus.
Klicken Sie auf die E-Mail-Adresse des Dienstkontos, das Sie erstellen möchten für einen Schlüssel.
Klicken Sie auf den Tab Schlüssel.
Klicken Sie auf das Drop-down-Menü Schlüssel hinzufügen und wählen Sie Neuen Schlüssel erstellen aus.
Wählen Sie als Schlüsseltyp JSON aus und klicken Sie dann auf Erstellen.
Legen Sie die Umgebungsvariable
GOOGLE_APPLICATION_CREDENTIALSauf den Pfad fest der JSON-Datei.
Linux oder macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Webanwendung
Öffnen Sie die Seite Google API Console-Seite "Anmeldedaten".
Wenn Sie dazu aufgefordert werden, wählen Sie das Projekt aus, in dem Sie die Ad Manager API aktiviert haben.
Wählen Sie auf der Seite „Anmeldedaten“ die Option Anmeldedaten erstellen aus. Wählen Sie OAuth-Client-ID aus.
Wählen Sie den Anwendungstyp Webanwendung aus.
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 Richtlinien von Google Validierungsregeln.
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 dann 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 dann, indem Sie den folgenden Befehl ausführen: 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 und die Umgebung festlegen
Variable GOOGLE_APPLICATION_CREDENTIALS in den Pfad Ihrer Schlüsseldatei ein.
Linux oder macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Ad Manager-Netzwerk konfigurieren
Dienstkonto
- Rufen Sie Ihr Ad Manager-Netzwerk auf.
- Klicken Sie auf den Tab Verwaltung.
- Prüfen Sie, ob der API-Zugriff aktiviert ist.
- Klicken Sie auf die Schaltfläche Dienstkontonutzer hinzufügen.
- 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.
- Klicken Sie auf Speichern. Es sollte eine Meldung zur Bestätigung angezeigt werden. das Hinzufügen Ihres Dienstkontos.
- Vorhandene Dienstkontonutzer finden Sie auf dem Tab „Nutzer“. Klicken Sie auf den Filter Dienstkonto.
Webanwendung
- Rufen Sie Ihr Ad Manager-Netzwerk auf.
- Klicken Sie auf den Tab Verwaltung.
- Prüfen Sie, ob der API-Zugriff aktiviert ist.
Lokale Entwicklung
- Rufen Sie Ihr Ad Manager-Netzwerk auf.
- Klicken Sie auf den Tab Verwaltung.
- Prüfen Sie, ob der API-Zugriff aktiviert ist.
Ohne Clientbibliothek
Auch wenn Sie keine Clientbibliothek verwenden, wird dringend empfohlen, eine OAuth2-Bibliothek für die Authentifizierung.
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
in Serverprotokollen sichtbar.
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 Gruppe von Ressourcen und Vorgängen, die ein Zugriffstoken zulässt. Der Ad Manager Die REST API hat nur einen Bereich. Die Autorisierung muss beim Nutzer durchgeführt werden. innerhalb des Produkts.
| Umfang | Berechtigungen |
|---|---|
https://www.googleapis.com/auth/admanager
|
Kampagnen abrufen und verwalten in Google Ad Manager. |