Looking for a REST API? The Ad Manager API (Beta) is now available.

Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Los gehts

Mit der Google Ad Manager SOAP API können Sie Apps erstellen, mit denen Sie beispielsweise Inventar verwalten, Aufträge einrichten und Berichte erstellen können.

Für den Einstieg bieten wir Clientbibliotheken für Java, .NET, Python, PHP und Ruby an.

So stellen Sie Ihre erste API-Anfrage:

Falls Sie noch kein Ad Manager-Konto haben, registrieren Sie sich für eines. Sie können auch ein Testnetzwerk erstellen, wenn Sie die API in einer separaten Umgebung testen möchten. Für Testzwecke benötigen Sie kein AdSense-Konto.

Notieren Sie sich Ihren Netzwerkcode. Sie finden ihn in der URL, wenn Sie sich in Ihrem Netzwerk anmelden. In der URL https://admanager.google.com/1234#home ist 1234 beispielsweise Ihr Netzwerkcode.

Authentifizierungsdaten erstellen

Sie müssen alle Ad Manager SOAP API-Anfragen mit OAuth 2.0 authentifizieren. In den folgenden Schritten wird der Anwendungsfall des Zugriffs auf Ihre eigenen Ad Manager-Daten beschrieben. Weitere Informationen und Optionen finden Sie unter Authentifizierung.

Öffnen Sie in der Google API Console die Seite „Anmeldedaten“.
Wählen Sie im Projektmenü Projekt erstellen aus, geben Sie einen Namen für das Projekt ein und bearbeiten Sie optional die angegebene Projekt-ID. Klicken Sie auf Erstellen.
Wählen Sie auf der Seite „Anmeldedaten“ die Option Anmeldedaten erstellen und dann Dienstkontoschlüssel aus.
Wählen Sie Neues Dienstkonto und JSON als Schlüsseltyp aus.
Klicken Sie auf Erstellen, um eine Datei mit einem privaten Schlüssel herunterzuladen.

Ad Manager-Netzwerk konfigurieren

Melden Sie sich in Google Ad Manager an.
Klicken Sie in der Seitenleiste auf Admin > Globale Einstellungen.
Klicken Sie unter Allgemeine Einstellungen > API-Zugriff auf den Schieberegler, um die Option zu aktivieren.
Klicken Sie unten auf der Seite auf den Button Speichern.

Client einrichten

Laden Sie eine der Ad Manager-Clientbibliotheken herunter. Die Bibliotheken bieten Wrapper-Funktionen und Features, mit denen sich Anwendungen einfacher und schneller entwickeln lassen.

Die folgenden Tabs enthalten Kurzanleitungen für das Programmieren in den einzelnen Sprachen, für die es eine Clientbibliothek gibt.

Java

Hier ist ein einfaches Beispiel für die Verwendung der Java-Clientbibliothek. Ausführlichere Informationen zur Verwendung finden Sie in der README in der Clientbibliotheksdistribution.

Anmeldedaten einrichten

Führen Sie in einer Shell den folgenden Befehl aus:

curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties

Öffnen Sie die Datei ~/ads.properties und füllen Sie die folgenden Felder aus:

[...]
api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE
api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE
api.admanager.networkCode=INSERT_NETWORK_CODE_HERE
[...]

Abhängigkeiten angeben

Bearbeiten Sie die Datei pom.xml und fügen Sie dem Tag dependencies Folgendes hinzu. Die aktuelle Versionsnummer finden Sie auf GitHub.

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>ads-lib</artifactId>
  <version>RELEASE</version>
</dependency>
<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>dfp-axis</artifactId>
  <version>RELEASE</version>
</dependency>

Code schreiben und Anfrage stellen

import com.google.api.ads.common.lib.auth.OfflineCredentials;
import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
import com.google.api.ads.admanager.axis.factory.AdManagerServices;
import com.google.api.ads.admanager.axis.v202608.Network;
import com.google.api.ads.admanager.axis.v202608.NetworkServiceInterface;
import com.google.api.ads.admanager.lib.client.AdManagerSession;
import com.google.api.client.auth.oauth2.Credential;

public class App {
  public static void main(String[] args) throws Exception {
    Credential oAuth2Credential = new OfflineCredentials.Builder()
        .forApi(Api.AD_MANAGER)
        .fromFile()
        .build()
        .generateCredential();

    // Construct an AdManagerSession.
    AdManagerSession session = new AdManagerSession.Builder()
        .fromFile()
        .withOAuth2Credential(oAuth2Credential)
        .build();

    // Construct a Google Ad Manager service factory, which can only be used once per
    // thread, but should be reused as much as possible.
    AdManagerServices adManagerServices = new AdManagerServices();

    // Retrieve the appropriate service
    NetworkServiceInterface networkService = adManagerServices.get(session,
        NetworkServiceInterface.class);

    // Make a request
    Network network = networkService.getCurrentNetwork();

    System.out.printf("Current network has network code '%s' and display" +
        " name '%s'.%n", network.getNetworkCode(), network.getDisplayName());
  }
}

Auf GitHub ansehen

Python

Hier ist ein einfaches Beispiel für die Verwendung der Python-Clientbibliothek. Die Python-Clientbibliothek unterstützt Python v3.6+. Weitere Informationen zur Verwendung finden Sie in der README in der Clientbibliothek.

Installieren Sie die Bibliothek und richten Sie Ihre Anmeldedaten ein.

Führen Sie die folgenden Befehle in einer Shell aus:

python3 -m pip install googleads
curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \
     -o ~/googleads.yaml

Richten Sie die Datei ~/googleads.yaml ein.

Füllen Sie die folgenden Felder aus:

ad_manager:
  application_name: INSERT_APPLICATION_NAME_HERE
  network_code: INSERT_NETWORK_CODE_HERE
  path_to_private_key_file: INSERT_PATH_TO_FILE_HERE

Code ausführen und eine Anfrage stellen

# Import the library.
from googleads import ad_manager

# Initialize a client object, by default uses the credentials in ~/googleads.yaml.
client = ad_manager.AdManagerClient.LoadFromStorage()

# Initialize a service.
network_service = client.GetService('NetworkService', version='v202608')

# Make a request.
current_network = network_service.getCurrentNetwork()

print("Current network has network code '%s' and display name '%s'." %
        (current_network['networkCode'], current_network['displayName']))

Auf GitHub ansehen

PHP

Hier ist ein einfaches Beispiel für die Verwendung der PHP-Clientbibliothek.

Installieren Sie die Bibliothek und richten Sie Ihre Anmeldedaten ein.
Führen Sie die folgenden Befehle in einer Shell aus, um die Clientbibliothek zu installieren und die Datei adsapi_php.ini in Ihr Basisverzeichnis herunterzuladen:
```
composer require googleads/googleads-php-lib
curl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
```

Richten Sie die Datei ~/adsapi_php.ini ein.

Füllen Sie die folgenden Felder aus:

[AD_MANAGER]
networkCode = "INSERT_NETWORK_CODE_HERE"
applicationName = "INSERT_APPLICATION_NAME_HERE"

[OAUTH2]
jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE"
scopes = "https://www.googleapis.com/auth/dfp"

Code ausführen und Anfrage stellen

Dieser Beispielcode muss über die Befehlszeile und nicht über einen Browser ausgeführt werden. Die Datei, die diesen Code enthält, muss sich im Stammverzeichnis des Projektverzeichnisses befinden, in dem composer require ausgeführt wurde.

<?php
require 'vendor/autoload.php';
use Google\AdsApi\AdManager\AdManagerSession;
use Google\AdsApi\AdManager\AdManagerSessionBuilder;
use Google\AdsApi\AdManager\v202608\ApiException;
use Google\AdsApi\AdManager\v202608\ServiceFactory;
use Google\AdsApi\Common\OAuth2TokenBuilder;

// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();
// Construct an API session configured from a properties file and the OAuth2
// credentials above.
$session = (new AdManagerSessionBuilder())
    ->fromFile()
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

// Get a service.
$serviceFactory = new ServiceFactory();
$networkService = $serviceFactory->createNetworkService($session);

// Make a request
$network = $networkService->getCurrentNetwork();
printf(
    "Network with code %d and display name '%s' was found.\n",
    $network->getNetworkCode(),
    $network->getDisplayName()
);

Auf GitHub ansehen

.NET

Hier ist ein einfaches Beispiel für die Verwendung der .NET-Clientbibliothek.

Neues Projekt erstellen
Öffnen Sie Visual Studio und erstellen Sie ein neues Projekt (Konsolenanwendung).
Erforderliche Bibliotheksreferenzen zum Projekt hinzufügen
Fügen Sie eine NuGet-Abhängigkeit für Google.Dfp hinzu.
App.config einrichten
Kopieren Sie „src\App.config“ in Ihr Projektverzeichnis und fügen Sie die Datei Ihrem Projekt hinzu. Wenn Ihre Anwendung eine eigene App.config hat, können Sie die folgenden Knoten in Ihre App.config kopieren:
- configuration/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- configuration/system.net

Anmeldedaten einrichten

Öffnen Sie „App.config“ und bearbeiten Sie die folgenden Schlüssel:

<add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" />
<add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" />
<add key="OAuth2Mode" value="SERVICE_ACCOUNT" />
<add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />

Anruf an die Bibliothek tätigen

Sie können die Bibliothek wie im folgenden C#-Code-Snippet gezeigt aufrufen:

Auf GitHub ansehen

AdManagerUser user = new AdManagerUser();
      using (InventoryService inventoryService = user.GetService<InventoryService>())
            {
                // Create a statement to select ad units.
                int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT;
                StatementBuilder statementBuilder =
                    new StatementBuilder().OrderBy("id ASC").Limit(pageSize);

                // Retrieve a small amount of ad units at a time, paging through until all
                // ad units have been retrieved.
                int totalResultSetSize = 0;
                do
                {
                    AdUnitPage page =
                        inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement());

                    // Print out some information for each ad unit.
                    if (page.results != null)
                    {
                        totalResultSetSize = page.totalResultSetSize;
                        int i = page.startIndex;
                        foreach (AdUnit adUnit in page.results)
                        {
                            Console.WriteLine(
                                "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++,
                                adUnit.id, adUnit.name);
                        }
                    }

                    statementBuilder.IncreaseOffsetBy(pageSize);
                } while (statementBuilder.GetOffset() < totalResultSetSize);

                Console.WriteLine("Number of results found: {0}", totalResultSetSize);
            }

Wenn Sie Ihre Anmeldedaten nicht in der Datei „App.config“ festlegen möchten, finden Sie in diesem Wiki-Artikel alternative Möglichkeiten zur Verwendung der Klasse „AdManagerUser“. Ausführliche Informationen zur Verwendung der .NET-Clientbibliothek finden Sie in der README-Datei. Wenn Sie in .NET ohne die Clientbibliothek entwickeln möchten, lesen Sie den Wiki-Artikel „NoClientLibrary“.

Ruby

Hier ist ein einfaches Beispiel für die Verwendung der Ruby-Clientbibliothek. Für die Ruby-Clientbibliothek ist Ruby 2.1 oder höher erforderlich.

Installieren Sie das Ruby-Gem und rufen Sie die Konfigurationsdatei ab.
Führen Sie die folgenden Befehle in einer Shell aus:
```
gem install google-dfp-api
curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
```
Wenn Sie während der Installation Ihrer Gems einen Fehler wie „cannot load such file -- mkmf (LoadError)“ erhalten, müssen Sie möglicherweise zusätzliche Ruby-Entwicklungsbibliotheken wie ruby-dev, ruby-devel, xcode-select usw. für Ihre jeweilige Umgebung installieren.
Anmeldedaten einrichten
Füllen Sie die erforderlichen Felder in der Datei ~/ad_manager_api.yml aus. Wenn Sie noch keine OAuth2-Schlüsseldatei haben, müssen Sie die Schritte zum Erstellen Ihrer OAuth2-Anmeldedaten ausführen.
```
:authentication:
  :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
  :application_name: INSERT_APPLICATION_NAME_HERE
  :network_code: INSERT_NETWORK_CODE_HERE
```

Code schreiben und Anfrage stellen

# Import the library.
require 'ad_manager_api'

# Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default).
ad_manager = AdManagerApi::Api.new

# Get a service instance.
network_service = ad_manager.service(:NetworkService, :v202608)

# Make a request.
network = network_service.get_current_network()

puts "The current network is %s (%d)." %
        [network[:display_name], network[:network_code]]

Auf GitHub ansehen

Eine ausführlichere Anleitung für die ersten Schritte finden Sie in der README, die mit der Ruby-Clientbibliothek verteilt wird. Sehen Sie sich auch unsere vollständige Beispielbibliothek für Ruby an.

Nächste Schritte

Wenn Sie eine Clientbibliothek eingerichtet haben, können Sie die bereitgestellten Beispiele an Ihre Anforderungen anpassen.

Weitere Informationen zur API finden Sie in der Referenzdokumentation.

Wenn du Hilfe benötigst, besuche unsere Supportseite.

Los gehts Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Zugriff auf ein Ad Manager-Netzwerk erhalten

Authentifizierungsdaten erstellen

Ad Manager-Netzwerk konfigurieren

Client einrichten

Java

Python

PHP

.NET

Ruby

Nächste Schritte

Los gehts