Wywoływanie interfejsu API

Ten przewodnik wymaga kilku ustawień wstępnych, które zostały skonfigurowane w poprzednich krokach. Zacznij od Wprowadzenie, jeśli nie wykonano jeszcze raz.

W tym przewodniku wykorzystywano tokeny odświeżania, czyli przepływ pracy, w którym użytkownik z wystarczającym dostępu do konta Google Ads może autoryzować Twoją aplikację (w ramach jednorazowej konfiguracji) może wykonywać wywołania interfejsu API offline na koncie bez dalszej interwencji użytkownika. Ty mogą używać tokenów odświeżania do tworzenia przepływów pracy offline, takich jak zadania cron potoki danych i interaktywne przepływy pracy, np. w internecie lub aplikacjach mobilnych.

Pobierz token odświeżania

Jako mechanizm autoryzacji interfejs Google Ads API używa protokołu OAuth 2.0. Domyślnie protokół OAuth W przypadku uwierzytelniania 2.0 token dostępu wygasa po określonym czasie. Aby automatycznie odnowić token dostępu, wydaj token odświeżania .

oauth2l

  1. Wygeneruj token odświeżania, uruchamiając polecenie Narzędzie oauth2l:

    oauth2l fetch --credentials credentials.json --scope adwords \
    --output_format refresh_token
``` The `credentials.json` file is from a [previous
step](/google-ads/api/docs/get-started/oauth-cloud-project#id-secret).

  1. Polecenie oauth2l otwiera okno logowania na konto Google w nowym oknie przeglądarki i przeprowadzi Cię przez proces uwierzytelniania OAuth 2.0.

    Pamiętaj, aby zalogować się przy użyciu adresu e-mail z kroku, na którym identyfikator klienta używany do logowania.

    Jeśli aplikacja nie jest zweryfikowana, może pojawić się ekran z ostrzeżeniem. W takim można bezpiecznie kliknąć link Pokaż zaawansowane, a następnie kliknąć Otwórz stronę PROJECT_NAME (nie zweryfikowano).

  2. Po sprawdzeniu zakresów przyznaj uprawnienia, klikając przycisk Dalej.

    W przeglądarce pojawi się prośba o potwierdzenie:

    Authorization code granted. Please close this tab.

    Polecenie oauth2l zwraca ten fragment kodu JSON:

    {
  "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"
}

interfejs wiersza poleceń gcloud

  1. Wygeneruj token odświeżania, uruchamiając narzędzie 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>
``` The `credentials.json` file is from a [previous
step](/google-ads/api/docs/get-started/oauth-cloud-project#id-secret).

  1. Polecenie gcloud otwiera okno logowania na konto Google w nowym oknie przeglądarki i przeprowadzi Cię przez proces uwierzytelniania OAuth 2.0.

    Pamiętaj, aby zalogować się przy użyciu adresu e-mail z kroku, na którym identyfikator klienta używany do logowania.

    Jeśli aplikacja jest niezweryfikowana, możesz zobaczyć ekran z ostrzeżeniem. W takim można bezpiecznie kliknąć link Pokaż zaawansowane, a następnie kliknąć Otwórz stronę PROJECT_NAME (nie zweryfikowano).

  2. Po potwierdzeniu zakresów kliknij przycisk Dalej, aby przyznać uprawnienia.

    Przeglądarka otworzy stronę https://cloud.google.com/sdk/auth_success, co sygnalizuje pomyślne uwierzytelnienie.

    Authorization code granted. Please close this tab.

    Polecenie gcloud generuje następujące dane wyjściowe:

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

    Teraz otwórz plik application_default_credentials.json. Ich zawartość powinien wyglądać podobnie do tego:

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

Inne

Jeśli wolisz użyć curl lub własnego klienta HTTP, zapoznaj się z artykułem Przykład znajdziesz w przewodniku po OAuth 2.0 w aplikacjach mobilnych i komputerowych.

Wywoływanie interfejsu API

Wybierz klienta, aby uzyskać instrukcje dotyczące wywoływania interfejsu API:

Java

Elementy biblioteki klienta są publikowane w centralnym repozytorium Maven. Dodaj bibliotekę klienta jako zależność do projektu w ten sposób:

Zależność Maven:

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

Zależność Gradle:

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

Utwórz plik ~/ads.properties z tą zawartością:

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

Aby utworzyć obiekt GoogleAdsClient:

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);
}

Następnie wygeneruj raport kampanii, używając metody GoogleAdsService.SearchStream, aby pobrać dane kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.

    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#

Pakiety biblioteki klienta są publikowane w witrynie Nuget.org . Zacznij od dodania odniesienie do pakietu Google.Ads.GoogleAds.

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

Utwórz obiekt GoogleAdsConfig z odpowiednimi ustawieniami i użyj go do utworzenia obiektu GoogleAdsClient.

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

Następnie uruchom raport o kampaniach, korzystając z metody GoogleAdsService.SearchStream, aby pobrać kampanie z konta. W tym przewodniku nie omówiono szczegółów: raportowania.

    public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V17.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

Pakiety z bibliotek klienta są publikowane w Packagist . Zmień na: katalogu głównym projektu i uruchom następujące polecenie, aby ją zainstalować i wszystkie jej zależności znajdziesz w katalogu vendor/ katalogu w katalogu głównym projektu.

composer require googleads/google-ads-php:25.0.0

Utwórz kopię pliku google_ads_php.ini z repozytorium GitHub i zmień go, aby zawierał Twoje dane logowania.

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

Utwórz instancję obiektu GoogleAdsClient.

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

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

Następnie uruchom raport o kampaniach, korzystając z metody GoogleAdsService.SearchStream, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.

    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

Biblioteka klienta jest rozpowszechniana na stronie PyPI. Można ją zainstalować za pomocą polecenia pip w ten sposób:

python -m pip install google-ads==21.3.0

Utwórz kopię google-ads.yaml z repozytorium GitHub i zmodyfikuj je, tak aby zawierało Twoje dane logowania.

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

Utwórz instancję GoogleAdsClient, wywołując metodę GoogleAdsClient.load_from_storage. Podaj ścieżkę do swojego google-ads.yaml jako ciąg znaków występujący w metodzie:

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

Następnie uruchom raport o kampaniach, korzystając z metody GoogleAdsService.SearchStream, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.

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

Pakiety Ruby dla biblioteki klienta są publikowane w witrynie hostującej pakiety Rubygems. Zalecany sposób aby zainstalować, używa narzędzia tworzenia pakietów. Dodaj wiersz do pliku Gemfile:

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

Następnie uruchom polecenie:

bundle install

Utwórz kopię google_ads_config.rb z repozytorium GitHub i zmodyfikuj go, tak aby zawierał Twoje dane logowania.

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

Utwórz instancję GoogleAdsClient, przekazując ścieżkę do miejsca, w którym przechowujesz ten plik.

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

Następnie wygeneruj raport kampanii, używając metody GoogleAdsService.SearchStream, aby pobrać dane kampanie na koncie. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.

    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

Biblioteka jest rozpowszechniana na stronie CPAN Zacznij od sklonowania w repozytorium google-ads-perl w wybranym katalogu.

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

Przejdź do katalogu google-ads-perl i uruchom następujące polecenie pod adresem wiersza poleceń, aby zainstalować wszystkie zależności niezbędne do korzystania z biblioteki.

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

Utwórz kopię googleads.properties z repozytorium GitHub i zmodyfikuj go, tak aby zawierał Twoje dane logowania.

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

Utwórz instancję Client, przekazując ścieżkę do miejsca, w którym przechowujesz ten plik.

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

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

Następnie uruchom raport o kampaniach, korzystając z metody GoogleAdsService.SearchStream, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.

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

Zacznij od pobrania tokena dostępu OAuth 2.0 za pomocą klienta HTTP. Ten przewodnik korzysta z polecenia curl.

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

Następnie uruchom raport o kampaniach, korzystając z metody GoogleAdsService.SearchStream, aby pobrać kampanie z konta. Ten przewodnik nie zawiera szczegółowych informacji na temat raportowania.

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"

Zawartość pliku query.json:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}
Wstecz
Pobierz narzędzia i biblioteki
Dalej
Typowe błędy