Jetzt loslegen

Über die Campaign Manager 360 API erhalten Sie programmatischen Zugriff auf Informationen aus Ihrem Campaign Manager 360-Konto. So werden Kampagnen und Berichte genau wie mit den Webdiensten Campaign Manager 360 und Report Builder verwaltet und erstellt.

In diesem Leitfaden werden die ersten Schritte mit der Campaign Manager 360 API beschrieben.

Voraussetzungen

Bevor Sie die Campaign Manager 360 API verwenden können, müssen Sie einige Voraussetzungen erfüllen:

  1. Sie benötigen ein Campaign Manager 360-Konto. Informationen zur Registrierung findest du unter Werbetreibende/Agenturen.

  2. Für den Campaign Manager 360-Konto muss der API-Zugriff aktiviert sein. Bei den meisten Konten ist dies standardmäßig aktiviert. Wenn Sie sich nicht sicher sind, wenden Sie sich an Ihren Kundenbetreuer oder an das Campaign Manager 360-Supportteam.

  3. Sie benötigen ein Nutzerprofil mit Zugriff auf dieses Konto. Bitten Sie Ihren Campaign Manager 360-Kontoadministrator, ein mit diesem Konto verknüpftes Nutzerprofil zu erstellen.

  4. Berechtigungen für Nutzerprofile auf der Benutzeroberfläche von Campaign Manager 360 prüfen Mit diesen wird gesteuert, worauf das Nutzerprofil über die API zugreifen kann. Es gibt keine separaten API-Berechtigungen.

Projekt erstellen

Wenn Sie die Campaign Manager 360 API verwenden möchten, 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 Vorgang geführt und die Campaign Manager 360 API automatisch aktiviert.

Anmeldedaten generieren

Alle Anfragen, die Sie an die Campaign Manager 360 API senden, müssen autorisiert werden. Eine kurze Übersicht über die Autorisierung finden Sie unter Ihre Anwendung autorisieren und bei Google identifizieren.

In der folgenden Anleitung wird Schritt für Schritt erklärt, wie Sie eine OAuth 2.0-Client-ID für den installierten Anwendungsfluss erstellen. Eine Anleitung zum Generieren von Anmeldedaten für die Verwendung mit dem Dienstkontoablauf finden Sie im Leitfaden Dienstkonten.

  1. Führen Sie die Schritte zum Konfigurieren eines Google API Console-Projekts aus.

  2. Öffnen Sie in der API Console die Seite „Anmeldedaten“.
  3. Klicken Sie auf ANMELDEDATEN ERSTELLEN > OAuth-Client-ID.

    1. Wenn Sie noch keinen OAuth-Zustimmungsbildschirm für dieses Projekt konfiguriert haben, werden Sie jetzt dazu aufgefordert. Klicken Sie auf CONSENTIEREN.

    2. Wählen Sie den Nutzertyp aus und klicken Sie auf ERSTELLEN.

    3. Fülle das erste Formular aus. Sie können diese Angaben bei Bedarf später bearbeiten. Klicken Sie abschließend auf Speichern.

    4. Gehen Sie zurück zu Anmeldedaten > ANMELDEDATEN ERSTELLEN > OAuth-Client-ID, um fortzufahren.

  4. Wählen Sie als Anwendungstyp Desktop-App aus, geben Sie einen Namen ein und klicken Sie dann auf Erstellen.

Anschließend werden Ihnen die OAuth 2.0-Client-ID und der Clientschlüssel angezeigt. Sie können sie im JSON-Format herunterladen und zur späteren Verwendung speichern.

Clientbibliothek installieren

Die Campaign Manager 360 API basiert auf HTTP und JSON, sodass jeder HTTP-Standardclient Anfragen an sie senden und die Antworten parsen kann.

Die Google API-Clientbibliotheken bieten jedoch eine bessere Sprachintegration sowie eine höhere Sicherheit und unterstützen auch das Senden autorisierter 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, die Installation mit NuGet zu verwalten.

Öffnen Sie die NuGet-Paketmanager-Konsole und führen Sie den folgenden Befehl aus:

Install-Package Google.Apis.Dfareporting.v3_4

Weitere Informationen

Java

Installieren Sie die aktuelle Campaign Manager 360 API-Clientbibliothek für Java. Wir empfehlen, die Installation mit Maven zu verwalten.

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>v4-rev20220611-1.32.1</version>
  <exclusions>
    <exclusion>
      <groupId>com.google.guava</groupId>
      <artifactId>guava-jdk5</artifactId>
    </exclusion>
  </exclusions>
</dependency>

Weitere Informationen

PHP

Installieren Sie die aktuelle Campaign Manager 360 API-Clientbibliothek für PHP. Wir empfehlen, die Installation mit Composer zu verwalten.

Ö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 den Ausdruck sudo voranstellen.

Weitere Informationen

Python

Installieren Sie die aktuelle Campaign Manager 360 API-Clientbibliothek für Python. Wir empfehlen, die Installation mit pip zu verwalten.

Ö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 den Ausdruck sudo voranstellen.

Weitere Informationen

Ruby

Installieren Sie die aktuelle Campaign Manager 360 API-Clientbibliothek für Ruby. Wir empfehlen, RubyGems zum Verwalten Ihrer 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 den Ausdruck sudo voranstellen.

Weitere Informationen

Weitere unterstützte Sprachen finden Sie auf der Seite Clientbibliotheken.

Anfrage stellen

Nachdem Sie die OAuth 2.0-Anmeldedaten erstellt und eine Clientbibliothek installiert haben, können Sie die Campaign Manager 360 API verwenden. Folgen Sie der Anleitung unten, um zu erfahren, wie Sie Ihren Client autorisieren, konfigurieren und Ihre erste Anfrage stellen.

C#

  1. Laden Sie die Datei mit den Clientschlüsseln und generieren Sie Anmeldedaten für die Autorisierung.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie zustimmen, sollten Sie in einem Google-Konto angemeldet sein, mit dem Sie auf Campaign Manager 360 zugreifen können. Ihre App wird für den Zugriff auf Daten im Namen des aktuell angemeldeten Kontos autorisiert.

    // 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;
    
  2. 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"
        }
    );
    
  3. 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

  1. Laden Sie die Datei mit den Clientschlüsseln und generieren Sie Anmeldedaten für die Autorisierung.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie zustimmen, sollten Sie in einem Google-Konto angemeldet sein, mit dem Sie auf Campaign Manager 360 zugreifen können. Ihre App wird für den Zugriff auf Daten im Namen des aktuell angemeldeten Kontos autorisiert.

    // 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");
    
  2. 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();
    
  3. 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

  1. Laden Sie die Datei mit den Clientschlüsseln und generieren Sie Anmeldedaten für die Autorisierung.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie zustimmen, sollten Sie in einem Google-Konto angemeldet sein, mit dem Sie auf Campaign Manager 360 zugreifen können. Ihre App wird für den Zugriff auf Daten im Namen des aktuell angemeldeten Kontos autorisiert.

    // 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()));
    }
    
  2. Erstellen Sie einen autorisierten Dfareporting-Client.

    // Create a Dfareporting service object.
    $service = new Google_Service_Dfareporting($client);
    
  3. 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

  1. Laden Sie die Datei mit den Clientschlüsseln und generieren Sie Anmeldedaten für die Autorisierung.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie zustimmen, sollten Sie in einem Google-Konto angemeldet sein, mit dem Sie auf Campaign Manager 360 zugreifen können. Ihre App wird für den Zugriff auf Daten im Namen des aktuell angemeldeten Kontos autorisiert.

    # 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())
    
  2. Erstellen Sie einen autorisierten Dfareporting-Client.

    # Construct a service object via the discovery service.
    service = discovery.build('dfareporting', 'v4', http=http)
    
  3. 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

  1. Laden Sie die Datei mit den Clientschlüsseln und generieren Sie Anmeldedaten für die Autorisierung.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie aufgefordert, eine Autorisierungsaufforderung in Ihrem Browser zu akzeptieren. Bevor Sie zustimmen, sollten Sie in einem Google-Konto angemeldet sein, mit dem Sie auf Campaign Manager 360 zugreifen können. Ihre App wird für den Zugriff auf Daten im Namen des aktuell angemeldeten Kontos autorisiert.

    # 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
    
  2. 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'
    
  3. 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 zu bieten hat. Jede Detailseite einer Methode enthält den eingebetteten API Explorer, mit dem Sie Testanfragen direkt über Ihren Browser senden können.

In unseren anderen Leitfäden finden Sie Informationen zu erweiterten Themen sowie End-to-End-Beispiele für häufige Aufgaben.

Wenn Sie bereit sind, mit dem Schreiben von Code zu beginnen, sehen Sie sich unsere umfangreiche Sammlung von Codebeispielen an, die bei Bedarf angepasst und erweitert werden können.