API aufrufen

Für diese Anleitung sind mehrere Voraussetzungen erforderlich, die in den vorherigen Schritten konfiguriert wurden. Beginnen Sie mit Einführung, falls Sie dies noch nicht getan haben.

In diesem Leitfaden werden auch Aktualisierungstokens verwendet. Dabei kann ein Nutzer mit ausreichendem Zugriff auf das Google Ads-Konto Ihre App einmalig autorisieren, Offline-API-Aufrufe an das Konto auszuführen, ohne dass der Nutzer weitere Maßnahmen ergreifen muss. Sie können Aktualisierungstokens sowohl für Offline-Workflows wie Cronjobs oder Datenpipelines als auch für interaktive Workflows wie Webanwendungen oder mobile Apps verwenden.

Aktualisierungstoken abrufen

Für die Google Ads API wird OAuth 2.0 als Autorisierungsmechanismus verwendet. Bei der OAuth 2.0-Authentifizierung wird standardmäßig ein Zugriffstoken ausgegeben, das nach einer begrenzten Zeit abläuft. Wenn Sie das Zugriffstoken automatisch verlängern möchten, fordern Sie stattdessen ein Aktualisierungstoken an.

oauth2l

  1. Generieren Sie das Aktualisierungstoken mit dem Tool oauth2l:

    oauth2l fetch --credentials credentials.json --scope adwords \
    --output_format refresh_token

    Die Datei credentials.json stammt aus einem vorherigen Schritt.

  2. Mit dem Befehl oauth2l wird in einem neuen Browserfenster ein Anmeldefenster für ein Google-Konto geöffnet und Sie werden durch die Schritte der OAuth 2.0-Authentifizierung geführt.

    Melden Sie sich mit der E-Mail-Adresse an, die Sie in Schritt 2 angegeben haben.

    Wenn Ihre App nicht überprüft wurde, wird möglicherweise ein Warnbildschirm angezeigt. In solchen Fällen können Sie auf den Link Erweitert anzeigen und dann auf die Option Zu PROJECT_NAME (nicht bestätigt) klicken.

  3. Nachdem Sie die Bereiche überprüft haben, gewähren Sie die Berechtigung, indem Sie auf die Schaltfläche Weiter klicken.

    Im Browser wird ein Prompt mit dem folgenden Text angezeigt:

    Authorization code granted. Close this tab.

    Der Befehl oauth2l gibt das folgende JSON-Snippet aus:

    {
  "client_id": "******.apps.googleusercontent.com",
  "client_secret": "******",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "refresh_token": "******",
  "type": "authorized_user"
}

gcloud-CLI

  1. Generieren Sie das Aktualisierungstoken mit der gcloud CLI:

    gcloud auth application-default \
  login --scopes=https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform \
  --client-id-file=<path_to_credentials.json>

    Die Datei credentials.json stammt aus einem vorherigen Schritt.

  2. Mit dem Befehl gcloud wird in einem neuen Browserfenster ein Anmeldefenster für ein Google-Konto geöffnet und Sie werden durch die Schritte der OAuth 2.0-Authentifizierung geführt.

    Melden Sie sich mit der E-Mail-Adresse an, die Sie in Schritt 2 angegeben haben.

    Wenn Ihre App nicht überprüft wurde, wird möglicherweise ein Warnbildschirm angezeigt. In solchen Fällen können Sie auf den Link Erweitert anzeigen und dann auf die Option Zu PROJECT_NAME (nicht bestätigt) klicken.

  3. Klicken Sie nach der Überprüfung der Bereiche auf die Schaltfläche Weiter, um die Berechtigung zu gewähren.

    Der Browser wechselt zu https://cloud.google.com/sdk/auth_success, was bedeutet, dass die Authentifizierung erfolgreich war.

    Authorization code granted. Close this tab.

    Der Befehl gcloud gibt folgende Ausgabe aus:

    Credentials saved to file: [/****/.config/gcloud/application_default_credentials.json]

    Öffnen Sie jetzt die Datei application_default_credentials.json. Der Inhalt sollte in etwa so aussehen:

    {
  "account": "",
  "client_id": "******.apps.googleusercontent.com",
  "client_secret": "******",
  "refresh_token": "******",
  "type": "authorized_user",
  "universe_domain": "googleapis.com"
}

Sonstiges

Wenn Sie stattdessen curl oder Ihren eigenen HTTP-Client verwenden möchten, finden Sie im Leitfaden OAuth 2.0 für mobile und Desktop-Apps ein Beispiel.

API aufrufen

Wählen Sie den gewünschten Client aus, um eine Anleitung zum Erstellen eines API-Aufrufs zu erhalten:

Java

Die Clientbibliotheksartefakte werden im zentralen Maven-Repository veröffentlicht. Fügen Sie die Clientbibliothek Ihrem Projekt als Abhängigkeit hinzu:

Die Maven-Abhängigkeit lautet:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>34.0.0</version>
</dependency>

Die Gradle-Abhängigkeit lautet:

implementation 'com.google.api-ads:google-ads:34.0.0'

Erstellen Sie eine ~/ads.properties-Datei mit folgendem Inhalt:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

So erstellen Sie ein GoogleAdsClient-Objekt:

GoogleAdsClient googleAdsClient = null;
try {
  googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
  System.err.printf(
      "Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
      fnfe);
  System.exit(1);
} catch (IOException ioe) {
  System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
  System.exit(1);
}

Rufen Sie dann mit der Methode GoogleAdsService.SearchStream einen Kampagnenbericht ab, um die Kampagnen in Ihrem Konto abzurufen. In diesem Leitfaden werden die Details zu Berichten nicht behandelt.

    private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java

C#

Die Clientbibliothekspakete werden im Nuget.org-Repository veröffentlicht. Fügen Sie zuerst eine NuGet-Referenz zum Paket Google.Ads.GoogleAds hinzu.

dotnet add package Google.Ads.GoogleAds --version 18.1.0

Erstellen Sie ein GoogleAdsConfig-Objekt mit den entsprechenden Einstellungen und verwenden Sie es, um ein GoogleAdsClient-Objekt zu erstellen.

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "APPLICATION",
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******",
    LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);

Rufen Sie dann mit der Methode GoogleAdsService.SearchStream einen Kampagnenbericht ab, um die Kampagnen in Ihrem Konto abzurufen. In diesem Leitfaden werden die Details zu Berichten nicht behandelt.

    public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V18.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs

PHP

Die Pakete der Clientbibliothek werden im Packagist-Repository veröffentlicht. Wechseln Sie in das Stammverzeichnis Ihres Projekts und führen Sie den folgenden Befehl aus, um die Bibliothek und alle zugehörigen Abhängigkeiten im Verzeichnis vendor/ des Stammverzeichnisses Ihres Projekts zu installieren.

composer require googleads/google-ads-php:25.0.0

Erstellen Sie eine Kopie der Datei google_ads_php.ini aus dem GitHub-Repository und ändern Sie sie so, dass Ihre Anmeldedaten enthalten sind.

[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"

[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"

Erstellen Sie eine Instanz des GoogleAdsClient-Objekts.

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

Rufen Sie dann mit der Methode GoogleAdsService.SearchStream einen Kampagnenbericht ab, um die Kampagnen in Ihrem Konto abzurufen. In diesem Leitfaden werden die Details zu Berichten nicht behandelt.

    public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php

Python

Die Clientbibliothek wird über PyPI vertrieben und kann mit dem Befehl pip so installiert werden:

python -m pip install google-ads==21.3.0

Erstellen Sie eine Kopie der Datei google-ads.yaml aus dem GitHub-Repository und ändern Sie sie so, dass Ihre Anmeldedaten enthalten sind.

client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE

Rufen Sie die Methode GoogleAdsClient.load_from_storage auf, um eine GoogleAdsClient-Instanz zu erstellen. Übergeben Sie den Pfad zu Ihrer google-ads.yaml als String an die Methode, wenn Sie sie aufrufen:

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

Rufen Sie dann mit der Methode GoogleAdsService.SearchStream einen Kampagnenbericht ab, um die Kampagnen in Ihrem Konto abzurufen. In diesem Leitfaden werden die Details zu Berichten nicht behandelt.

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

    query = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py

Ruby

Die Ruby-Gems für die Clientbibliothek werden auf der Rubygems-Hosting-Website veröffentlicht. Wir empfehlen die Installation mit Bundler. Fügen Sie Ihrer Gemfile eine Zeile hinzu:

gem 'google-ads-googleads', '~> 30.0.0'

Führen Sie dann diesen Befehl aus:

bundle install

Erstellen Sie eine Kopie der Datei google_ads_config.rb aus dem GitHub-Repository und ändern Sie sie so, dass Ihre Anmeldedaten enthalten sind.

Google::Ads::GoogleAds::Config.new do |c|
  c.client_id = 'INSERT_CLIENT_ID_HERE'
  c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
  c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
  c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end

Erstellen Sie eine GoogleAdsClient-Instanz, indem Sie den Pfad zum Speicherort dieser Datei übergeben.

client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')

Rufen Sie dann mit der Methode GoogleAdsService.SearchStream einen Kampagnenbericht ab, um die Kampagnen in Ihrem Konto abzurufen. In diesem Leitfaden werden die Details zu Berichten nicht behandelt.

    def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb

Perl

Die Bibliothek wird über CPAN vertrieben. Klonen Sie zuerst das google-ads-perl-Repository in das Verzeichnis Ihrer Wahl.

git clone https://github.com/googleads/google-ads-perl.git

Wechseln Sie in das Verzeichnis google-ads-perl und führen Sie den folgenden Befehl in der Eingabeaufforderung aus, um alle Abhängigkeiten zu installieren, die für die Verwendung der Bibliothek erforderlich sind.

cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps

Erstellen Sie eine Kopie der Datei googleads.properties aus dem GitHub-Repository und ändern Sie sie so, dass Ihre Anmeldedaten enthalten sind.

clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Erstellen Sie eine Client-Instanz, indem Sie den Pfad zum Speicherort dieser Datei übergeben.

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

Rufen Sie dann mit der Methode GoogleAdsService.SearchStream einen Kampagnenbericht ab, um die Kampagnen in Ihrem Konto abzurufen. In diesem Leitfaden werden die Details zu Berichten nicht behandelt.

    sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V18::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}
get_campaigns.pl

REST

Rufen Sie zuerst mit einem HTTP-Client ein OAuth 2.0-Zugriffstoken ab. In dieser Anleitung wird der Befehl curl verwendet.

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Rufen Sie dann mit der Methode GoogleAdsService.SearchStream einen Kampagnenbericht ab, um die Kampagnen in Ihrem Konto abzurufen. In diesem Leitfaden werden die Details zu Berichten nicht behandelt.

curl -i -X POST https://googleads.googleapis.com/v18/customers/CUSTOMER_ID/googleAds:searchStream \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer ACCESS_TOKEN" \
   -H "developer-token: DEVELOPER_TOKEN" \
   -H "login-customer-id: LOGIN_CUSTOMER_ID" \
   --data-binary "@query.json"

Der Inhalt von query.json sieht so aus:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}
Zurück
Tools und Bibliotheken herunterladen
Weiter
Häufige Fehler