Jetzt starten

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

Entwickler können mit der Google Ad Manager API Anwendungen erstellen, mit denen sich unter anderem Inventar verwalten, Aufträge erstellen und Berichte abrufen lassen.

Die Ad Manager API verwendet SOAP. Als Einstiegshilfe stellen wir Clientbibliotheken für Java, .NET, Python, PHP und Ruby zur Verfügung. Führen Sie die folgenden Schritte aus, um Ihre erste API-Anfrage zu senden.

Zugriff auf ein Ad Manager-Netzwerk erhalten

Registrieren Sie sich für ein Ad Manager-Konto, falls Sie noch keines haben. Sie können auch ein Testnetzwerk erstellen, wenn Sie die API in einer separaten Umgebung testen möchten. Für Testzwecke benötigst du kein AdSense-Konto.

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

Anmeldedaten für die Authentifizierung erstellen

Alle Ad Manager API-Anfragen müssen mit OAuth2 authentifiziert werden. Die folgenden Schritte decken den einfachen Anwendungsfall für den Zugriff auf Ihre eigenen Ad Manager-Daten ab. Weitere Informationen und andere Optionen finden Sie unter Authentifizierung.

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

Ad Manager-Netzwerk konfigurieren

  1. Melden Sie sich in Google Ad Manager an.
  2. Klicken Sie in der Seitenleiste auf Admin > Globale Einstellungen.
  3. Klicken Sie unter Allgemeine Einstellungen > API-Zugriff auf den Schieberegler auf Aktiviert.
  4. Klicken Sie unten auf der Seite auf Speichern.

Client einrichten

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

Die Tabs unten enthalten Kurzanleitungen für das Programmieren in den einzelnen Sprachen, für die eine Clientbibliothek vorhanden ist.

Java

Das folgende einfache Beispiel zeigt, wie Sie die Java-Clientbibliothek verwenden. Ausführliche Informationen zur Verwendung finden Sie in der README-Datei in der Clientbibliothek-Distribution.

  1. Anmeldedaten einrichten

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

    curl https://raw.githubusercontent.com/googleads/googleads-java-lib/master/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
    [...]
  2. 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>

  3. Schreiben Sie einen Code und senden Sie eine Anfrage.

    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.v202211.Network;
    import com.google.api.ads.admanager.axis.v202211.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());
      }
    }
    

Python

Das folgende einfache Beispiel zeigt, wie Sie die Python-Clientbibliothek verwenden. Die Python-Clientbibliothek unterstützt Python 3.6 oder höher. Weitere Informationen zur Verwendung finden Sie in der README-Datei in der Clientbibliothek-Distribution.

  1. Installieren Sie die Bibliothek und richten Sie Ihre Anmeldedaten ein.

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

    pip install googleads
    curl https://raw.githubusercontent.com/googleads/googleads-python-lib/master/googleads.yaml \
         -o ~/googleads.yaml
    
  2. 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
    
  3. Führen Sie Code aus und stellen Sie eine Anfrage.
    # 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='v202211')
    
    # 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']))
    

PHP

Das folgende einfache Beispiel zeigt, wie Sie die PHP-Clientbibliothek verwenden.

  1. Installieren Sie die Bibliothek und richten Sie Ihre Anmeldedaten ein.

    Führen Sie in einer Shell die folgenden Befehle aus, um die Clientbibliothek zu installieren, und laden Sie die Datei adsapi_php.ini in Ihr Basisverzeichnis herunter:

    composer require googleads/googleads-php-lib
    curl https://raw.githubusercontent.com/googleads/googleads-php-lib/master/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
  2. 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"
    
  3. Code ausführen und Anfrage senden
    <?php
    require 'vendor/autoload.php';
    use Google\AdsApi\AdManager\AdManagerSession;
    use Google\AdsApi\AdManager\AdManagerSessionBuilder;
    use Google\AdsApi\AdManager\v202211\ApiException;
    use Google\AdsApi\AdManager\v202211\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()
    );
    

.NET

Das folgende einfache Beispiel zeigt, wie Sie die .NET-Clientbibliothek verwenden.

  1. Neues Projekt erstellen

    Öffnen Sie Visual Studio und erstellen Sie ein neues Projekt (z.B. eine Konsolenanwendung).

  2. Erforderliche Bibliotheksreferenzen zum Projekt hinzufügen

    Fügen Sie eine Nuget-Abhängigkeit für Google.Dfp hinzu.

  3. App.config einrichten

    Kopieren Sie src\App.config in Ihr Projektverzeichnis und fügen Sie es Ihrem Projekt hinzu. Wenn Ihre Anwendung eine eigene App.config hat, können Sie die folgenden Knoten in Ihre App.config kopieren:

    • Konfiguration/AdManagerApi
    • configuration/configSections/section[name="AdManagerApi"]
    • Konfiguration/system.net
  4. 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" />
    

  5. Mediathek aufrufen

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

    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 App.config festlegen möchten, finden Sie in diesem Wiki-Artikel alternative Möglichkeiten zur Verwendung der Klasse "UserUser". Weitere 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

Das folgende einfache Beispiel zeigt, wie Sie die Ruby-Clientbibliothek verwenden. Für die Ruby-Clientbibliothek ist Ruby 2.1 oder höher erforderlich.

  1. Installieren Sie das RubyGem und rufen Sie die Konfigurationsdatei ab.

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

    gem install google-dfp-api
    curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/master/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
    

  2. Anmeldedaten einrichten

    Füllen Sie die Pflichtfelder 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
    
  3. Schreiben Sie einen Code und senden Sie eine Anfrage.
    # 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, :v202211)
    
    # Make a request.
    network = network_service.get_current_network()
    
    puts "The current network is %s (%d)." %
            [network[:display_name], network[:network_code]]
    

Weitere Informationen zu den ersten Schritten finden Sie in der README-Datei, die mit der Ruby-Clientbibliothek bereitgestellt wird. Sie können auch unsere vollständige Beispielbibliothek für Ruby nutzen.

Next Steps

Wenn eine Clientbibliothek aktiv ist, können Sie die bereitgestellten Beispiele so ändern, dass sie Ihren Anforderungen entsprechen.

Weitere Informationen zur API finden Sie in der Referenzdokumentation.

Weitere Informationen finden Sie auf der Supportseite.