Die Campaign Manager 360 API bietet programmatischen Zugriff auf Informationen aus Ihrem Campaign Manager 360-Konto. Sie wird zum Verwalten und Erstellen von Kampagnen und Berichten verwendet, genau wie die Webdienste von Campaign Manager 360 und Report Builder.
In dieser Anleitung wird beschrieben, wie Sie die Campaign Manager 360 API verwenden.
Vorbereitung
Bevor Sie die Campaign Manager 360 API verwenden können, müssen Sie einige Voraussetzungen erfüllen:
Sie benötigen ein Campaign Manager 360-Konto. Informationen zur Anmeldung finden Sie unter Werbetreibende/Agenturen.
Für Ihr Campaign Manager 360-Konto muss der API-Zugriff aktiviert sein. Bei den meisten Konten ist diese Option standardmäßig aktiviert. Wenn Sie sich nicht sicher sind, wenden Sie sich an Ihren Kundenbetreuer oder das Campaign Manager 360-Support team.
Sie benötigen ein Nutzerprofil mit Zugriff auf dieses Konto. Bitten Sie den Campaign Manager 360-Kontoadministrator, ein Nutzerprofil zu erstellen, das mit diesem Konto verknüpft ist.
Prüfen Sie die Berechtigungen des Nutzerprofils in der Campaign Manager 360-Benutzeroberfläche. Diese Berechtigungen steuern, auf welche Elemente das Nutzerprofil über die API zugreifen kann. Es gibt keine separaten API-Berechtigungen.
Projekt erstellen
Damit Sie die Campaign Manager 360 API verwenden können, müssen Sie zuerst ein Projekt in der Google API Console erstellen oder auswählen und die API aktivieren. Über diesen Link werden Sie durch den Prozess geführt und die Campaign Manager 360 API wird automatisch aktiviert.
Anmeldedaten generieren
Alle Anfragen, die Sie an die Campaign Manager 360 API senden, müssen autorisiert werden. Eine kurze Übersicht zur Autorisierung finden Sie unter Anwendung autorisieren und bei Google identifizieren.
Die folgende Anleitung führt Sie durch die Erstellung einer OAuth 2.0-Client-ID, die Sie mit dem Ablauf für installierte Anwendungen verwenden können. Eine Anleitung zum Generieren von Anmeldedaten für die Verwendung mit dem Ablauf für Dienstkonten finden Sie im Leitfaden zu Dienstkonten.
Folgen Sie der Anleitung zum Konfigurieren eines Google API Console-Projekts.
- Öffnen Sie in der API Console die Seite Anmeldedaten.
Klicken Sie auf ANMELDEDATEN ERSTELLEN > OAuth-Client-ID.
Wenn Sie zuvor keinen OAuth-Zustimmungsbildschirm für dieses Projekt konfiguriert haben, werden Sie jetzt dazu aufgefordert. Klicken Sie auf ZUSTIMMUNGSBILDSCHIRM KONFIGURIEREN.
Wählen Sie den Nutzertyp aus und klicken Sie auf ERSTELLEN.
Füllen Sie das erste Formular aus. Sie können es später bei Bedarf bearbeiten. Klicken Sie auf Speichern.
Kehren Sie zu Anmeldedaten > ANMELDEDATEN ERSTELLEN > OAuth-Client-ID zurück, um fortzufahren.
Wählen Sie Desktop-Anwendung als Anwendungstyp aus, geben Sie einen Namen ein und klicken Sie auf Erstellen.
Anschließend werden Ihnen eine OAuth 2.0-Client-ID und ein Client-Secret angezeigt, die Sie im JSON-Format herunterladen und für die spätere Verwendung speichern können.
Clientbibliothek installieren
Die Campaign Manager 360 API basiert auf HTTP und JSON. Daher kann jeder Standard-HTTP-Client Anfragen an sie senden und die Antworten parsen.
Die Google API-Clientbibliotheken bieten jedoch eine bessere Sprachintegration sowie eine höhere Sicherheit und unterstützen auch autorisierte Anfragen. Die Clientbibliotheken sind in verschiedenen Programmiersprachen verfügbar. Wenn Sie sie verwenden, müssen Sie HTTP-Anfragen nicht manuell erstellen und die Antworten nicht manuell parsen.
Wählen Sie zuerst die Programmiersprache aus, die Sie für die Entwicklung verwenden.
C#
Installieren Sie die neueste Campaign Manager 360 API-Clientbibliothek für .NET. Wir empfehlen, NuGet zum Verwalten der Installation zu verwenden.
Öffnen Sie die NuGet-Paket-Manager-Konsole und führen Sie den folgenden Befehl aus:
Install-Package Google.Apis.Dfareporting.v5
Weitere Informationen
- Lesen Sie den Entwicklerleitfaden zur Google API-Clientbibliothek für .NET.
Java
Installieren Sie die neueste Campaign Manager 360 API-Clientbibliothek für Java. Wir empfehlen, Maven zum Verwalten der Installation zu verwenden.
Fügen Sie der Datei pom.xml die folgende Abhängigkeit hinzu:
<dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-dfareporting</artifactId> <version>v5-rev20260213-2.0.0</version> <exclusions> <exclusion> <groupId>com.google.guava</groupId> <artifactId>guava-jdk5</artifactId> </exclusion> </exclusions> </dependency>
Weitere Informationen
- Lesen Sie den Entwicklerleitfaden zur Google API-Clientbibliothek für Java.
PHP
Installieren Sie die neueste Campaign Manager 360 API-Clientbibliothek für PHP. Wir empfehlen, Composer zum Verwalten der Installation zu verwenden.
Öffnen Sie ein Terminal und führen Sie den folgenden Befehl aus:
composer require google/apiclient
Wenn Sie die Bibliothek bereits installiert haben und nur auf die neueste Version aktualisieren möchten:
composer update google/apiclient
Je nach System müssen Sie diesen Befehlen möglicherweise sudo voranstellen.
Weitere Informationen
- Lesen Sie den Entwicklerleitfaden zur Google API-Clientbibliothek für PHP.
Python
Installieren Sie die neueste Campaign Manager 360 API-Clientbibliothek für Python. Wir empfehlen, pip zum Verwalten der Installation zu verwenden.
Öffnen Sie ein Terminal und führen Sie den folgenden Befehl aus:
pip install --upgrade google-api-python-client
Je nach System müssen Sie diesen Befehlen möglicherweise sudo voranstellen.
Weitere Informationen
- Durchsuchen Sie die Referenzdokumentation der Bibliothek für die Campaign Manager 360 API.
- Lesen Sie den Entwicklerleitfaden zur Google API-Clientbibliothek für Python (Version 1/2).
Ruby
Installieren Sie die neueste Campaign Manager 360 API-Clientbibliothek für Ruby. Wir empfehlen, RubyGems zum Verwalten der Installation zu verwenden.
Öffnen Sie ein Terminal und führen Sie den folgenden Befehl aus:
gem install google-api-client
Wenn Sie die Bibliothek bereits installiert haben und nur auf die neueste Version aktualisieren möchten:
gem update -y google-api-client
Je nach System müssen Sie diesen Befehlen möglicherweise sudo voranstellen.
Weitere Informationen
- Lesen Sie den Entwicklerleitfaden zur Google API-Clientbibliothek für Ruby.
Weitere unterstützte Sprachen finden Sie auf der Client Libraries Seite.
Anfrage stellen
Nachdem Sie OAuth 2.0-Anmeldedaten erstellt und eine Clientbibliothek installiert haben, können Sie die Campaign Manager 360 API verwenden. In der Kurzanleitung unten erfahren Sie, wie Sie Ihren Client autorisieren und konfigurieren und Ihre erste Anfrage stellen.
C#
Laden Sie die Secrets-Datei des Clients und generieren Sie Autorisierungsanmeldedaten.
Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie dies tun, müssen Sie mit einem Google-Konto angemeldet sein, das Zugriff auf Campaign Manager 360 hat. Ihre Anwendung wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie gerade angemeldet sind.
// Load client secrets from the specified JSON file. GoogleClientSecrets clientSecrets; using(Stream json = new FileStream(pathToJsonFile, FileMode.Open, FileAccess.Read)) { clientSecrets = GoogleClientSecrets.Load(json); } // Create an asynchronous authorization task. // // Note: providing a data store allows auth credentials to be cached, so they survive multiple // runs of the application. This avoids prompting the user for authorization every time the // access token expires, by remembering the refresh token. The "user" value is used to // identify a specific set of credentials within the data store. You may provide different // values here to persist credentials for multiple users to the same data store. Task<UserCredential> authorizationTask = GoogleWebAuthorizationBroker.AuthorizeAsync( clientSecrets.Secrets, OAuthScopes, "user", CancellationToken.None, dataStore); // Authorize and persist credentials to the data store. UserCredential credential = authorizationTask.Result;
Erstellen Sie einen autorisierten Dfareporting-Client.
// Create a Dfareporting service object. // // Note: application name should be replaced with a value that identifies your application. service = new DfareportingService( new BaseClientService.Initializer { HttpClientInitializer = credential, ApplicationName = "C# installed app sample" } );
Führen Sie einen Vorgang aus.
// Retrieve and print all user profiles for the current authorized user. UserProfileList profiles = service.UserProfiles.List().Execute(); foreach (UserProfile profile in profiles.Items) { Console.WriteLine("Found user profile with ID {0} and name \"{1}\".", profile.ProfileId, profile.UserName); }
Java
Laden Sie die Secrets-Datei des Clients und generieren Sie Autorisierungsanmeldedaten.
Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie dies tun, müssen Sie mit einem Google-Konto angemeldet sein, das Zugriff auf Campaign Manager 360 hat. Ihre Anwendung wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie gerade angemeldet sind.
// Load the client secrets JSON file. GoogleClientSecrets clientSecrets = GoogleClientSecrets.load( jsonFactory, Files.newBufferedReader(Paths.get(pathToClientSecretsFile), UTF_8)); // Set up the authorization code flow. // // Note: providing a DataStoreFactory allows auth credentials to be cached, so they survive // multiple runs of the program. This avoids prompting the user for authorization every time the // access token expires, by remembering the refresh token. GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder( httpTransport, jsonFactory, clientSecrets, OAUTH_SCOPES) .setDataStoreFactory(dataStoreFactory) .build(); // Authorize and persist credentials to the data store. // // Note: the "user" value below is used to identify a specific set of credentials in the data // store. You may provide different values here to persist credentials for multiple users to // the same data store. Credential credential = new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
Erstellen Sie einen autorisierten Dfareporting-Client.
// Create a Dfareporting client instance. // // Note: application name below should be replaced with a value that identifies your // application. Suggested format is "MyCompany-ProductName/Version.MinorVersion". Dfareporting reporting = new Dfareporting.Builder(credential.getTransport(), credential.getJsonFactory(), credential) .setApplicationName("dfareporting-java-installed-app-sample") .build();
Führen Sie einen Vorgang aus.
// Retrieve and print all user profiles for the current authorized user. UserProfileList profiles = reporting.userProfiles().list().execute(); for (int i = 0; i < profiles.getItems().size(); i++) { System.out.printf("%d) %s%n", i + 1, profiles.getItems().get(i).getUserName()); }
PHP
Laden Sie die Secrets-Datei des Clients und generieren Sie Autorisierungsanmeldedaten.
Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie dies tun, müssen Sie mit einem Google-Konto angemeldet sein, das Zugriff auf Campaign Manager 360 hat. Ihre Anwendung wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie gerade angemeldet sind.
// Create a Google_Client instance. // // Note: application name should be replaced with a value that identifies // your application. Suggested format is "MyCompany-ProductName". $client = new Google_Client(); $client->setAccessType('offline'); $client->setApplicationName('PHP installed app sample'); $client->setRedirectUri(self::OAUTH_REDIRECT_URI); $client->setScopes(self::$OAUTH_SCOPES); // Load the client secrets file. $client->setAuthConfig($pathToJsonFile); // Try to load cached credentials from the token store. Using a token store // allows auth credentials to be cached, so they survive multiple runs of // the application. This avoids prompting the user for authorization every // time the access token expires, by remembering the refresh token. if (file_exists($tokenStore) && filesize($tokenStore) > 0) { $client->setAccessToken(file_get_contents($tokenStore)); } else { // If no cached credentials were found, authorize and persist // credentials to the token store. print 'Open this URL in your browser and authorize the application.'; printf("\n\n%s\n\n", $client->createAuthUrl()); print 'Enter the authorization code: '; $code = trim(fgets(STDIN)); $client->authenticate($code); file_put_contents($tokenStore, json_encode($client->getAccessToken())); }
Erstellen Sie einen autorisierten Dfareporting-Client.
// Create a Dfareporting service object. $service = new Google_Service_Dfareporting($client);
Führen Sie einen Vorgang aus.
// Retrieve and print all user profiles for the current authorized user. $result = $service->userProfiles->listUserProfiles(); foreach ($result['items'] as $userProfile) { printf( "User profile \"%s\" (ID: %d) found for account %d.\n", $userProfile->getUserName(), $userProfile->getProfileId(), $userProfile->getAccountId() ); }
Python
Laden Sie die Secrets-Datei des Clients und generieren Sie Autorisierungsanmeldedaten.
Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie dies tun, müssen Sie mit einem Google-Konto angemeldet sein, das Zugriff auf Campaign Manager 360 hat. Ihre Anwendung wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie gerade angemeldet sind.
# Set up a Flow object to be used if we need to authenticate. flow = client.flow_from_clientsecrets( path_to_client_secrets_file, scope=OAUTH_SCOPES) # Check whether credentials exist in the credential store. Using a credential # store allows auth credentials to be cached, so they survive multiple runs # of the application. This avoids prompting the user for authorization every # time the access token expires, by remembering the refresh token. storage = Storage(CREDENTIAL_STORE_FILE) credentials = storage.get() # If no credentials were found, go through the authorization process and # persist credentials to the credential store. if credentials is None or credentials.invalid: credentials = tools.run_flow(flow, storage, tools.argparser.parse_known_args()[0]) # Use the credentials to authorize an httplib2.Http instance. http = credentials.authorize(httplib2.Http())
Erstellen Sie einen autorisierten Dfareporting-Client.
# Construct a service object via the discovery service. service = discovery.build('dfareporting', 'v5', http=http)
Führen Sie einen Vorgang aus.
# Construct the request. request = service.userProfiles().list() # Execute request and print response. response = request.execute() for profile in response['items']: print('Found user profile with ID %s and user name "%s".' % (profile['profileId'], profile['userName']))
Ruby
Laden Sie die Secrets-Datei des Clients und generieren Sie Autorisierungsanmeldedaten.
Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie dies tun, müssen Sie mit einem Google-Konto angemeldet sein, das Zugriff auf Campaign Manager 360 hat. Ihre Anwendung wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie gerade angemeldet sind.
# Load client ID from the specified file. client_id = Google::Auth::ClientId.from_file(path_to_json_file) # Set up the user authorizer. # # Note: providing a token store allows auth credentials to be cached, so they # survive multiple runs of the application. This avoids prompting the user for # authorization every time the access token expires, by remembering the # refresh token. authorizer = Google::Auth::UserAuthorizer.new( client_id, [API_NAMESPACE::AUTH_DFAREPORTING], token_store ) # Authorize and persist credentials to the data store. # # Note: the 'user' value below is used to identify a specific set of # credentials in the token store. You may provide different values here to # persist credentials for multiple users to the same token store. authorization = authorizer.get_credentials('user') if authorization.nil? puts format( "Open this URL in your browser and authorize the application.\n\n%s" \ "\n\nEnter the authorization code:", authorizer.get_authorization_url(base_url: OAUTH_REDIRECT_URI) ) code = STDIN.gets.chomp authorization = authorizer.get_and_store_credentials_from_code( base_url: OAUTH_REDIRECT_URI, code: code, user_id: 'user' ) end
Erstellen Sie einen autorisierten Dfareporting-Client.
# Create a Dfareporting service object. # # Note: application name should be replaced with a value that identifies # your application. Suggested format is "MyCompany-ProductName". service = API_NAMESPACE::DfareportingService.new service.authorization = authorization service.client_options.application_name = 'Ruby installed app sample' service.client_options.application_version = '1.0.0'
Führen Sie einen Vorgang aus.
// Retrieve and print all user profiles for the current authorized user. UserProfileList profiles = service.UserProfiles.List().Execute(); foreach (UserProfile profile in profiles.Items) { Console.WriteLine("Found user profile with ID {0} and name \"{1}\".", profile.ProfileId, profile.UserName); }
Weitere Informationen
In der API-Referenz finden Sie Informationen zu allen Diensten, die die API bietet. Auf jeder Detailseite der Methode ist ein eingebetteter API Explorer verfügbar, mit dem Sie Testanfragen direkt über Ihren Browser stellen können.
In unseren anderen Leitfäden werden erweiterte Themen behandelt und End-to-End-Beispiele für häufige Aufgaben bereitgestellt.
Wenn Sie bereit sind, Code zu schreiben, können Sie unsere umfangreiche Sammlung von Codebeispielen durchsuchen, die Sie an Ihre Bedürfnisse anpassen und erweitern können.