Jetzt starten

Mit der Google Ad Manager API können Entwickler unter anderem Anwendungen erstellen, die beispielsweise Inventar verwalten oder Aufträge erstellen.

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. Sie benötigen kein AdSense-Konto für Testzwecke.

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

Indem Sie auf die Ad Manager API zugreifen und/oder sie verwenden, stimmen Sie den Nutzungsbedingungen zu.

Authentifizierungsdaten erstellen

Sie müssen alle Ad Manager API-Anfragen mit OAuth2 authentifizieren. 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 Verwaltung > 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, die die Entwicklung von Anwendungen erleichtern.

Auf den folgenden Tabs finden Sie Kurzanleitungen zum Programmieren in jeder der Sprachen, für die eine Clientbibliothek vorhanden ist.

Java

Das folgende Beispiel zeigt die Verwendung der Java-Clientbibliothek. Ausführliche Informationen zur Nutzung finden Sie in der README-Datei in der Clientbibliotheksverteilung.

1. 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
   [...]

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. Erstellen Sie einen Code und stellen 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.v202308.Network;
   import com.google.api.ads.admanager.axis.v202308.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

Das folgende einfache Beispiel zeigt, wie Sie die Python-Clientbibliothek verwenden. Die Python-Clientbibliothek unterstützt Python v3.6+. Ausführlichere Informationen zur Verwendung finden Sie in der Datei README der Clientbibliothek.

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/main/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='v202308')
   
   # 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

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 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

2. Richte deine ~/adsapi_php.ini-Datei 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. Führen Sie Code aus und senden Sie eine Anfrage.
   Dieser Beispielcode muss in der Befehlszeile und nicht in einem Browser ausgeführt werden. Die Datei mit diesem Code 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\v202308\ApiException;
   use Google\AdsApi\AdManager\v202308\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

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, also eine Konsolenanwendung.

2. Ihrem Projekt die erforderlichen Bibliotheksreferenzen 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
   • config/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. Bibliothek anrufen

   Sie können die Bibliothek wie im folgenden C#-Code-Snippet 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 App.config festlegen möchten, finden Sie in diesem Wiki-Artikel weitere Informationen zur Verwendung der Klasse „AdManagerUser“. Ausführliche Informationen zur Verwendung der .NET-Clientbibliothek finden Sie in der Readme-Datei . Wenn Sie die Entwicklung in .NET ohne die Clientbibliothek vornehmen möchten, finden Sie entsprechende Informationen im Wiki „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 Ruby-Gem 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/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
   

   
   
   Wenn während der Installation von Gems ein Fehler wie „cannot load such file -- mkmf (LoadError)“ auftritt, müssen Sie möglicherweise zusätzliche Ruby-Entwicklungsbibliotheken wie ruby-dev, ruby-devel, xcode-select usw. für Ihre spezifische Umgebung installieren.
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. Erstellen Sie einen Code und stellen 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, :v202308)
   
   # 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 detailliertere Anleitung für den Einstieg finden Sie in der Datei README, die mit der Ruby-Clientbibliothek bereitgestellt wird. Sie können sich auch unsere vollständige Beispielbibliothek für Ruby ansehen.

Nächste Schritte

Wenn eine Clientbibliothek eingerichtet und aktiv ist, können Sie die bereitgestellten Beispiele entsprechend Ihren Anforderungen anpassen.

Weitere Informationen zur API finden Sie in der Referenzdokumentation.

Weitere Informationen finden Sie auf unserer Supportseite.