Wywoływanie interfejsu API

Ten przewodnik wymaga podania kilku ustawień wstępnych skonfigurowanych w poprzednich krokach. Zacznij od wstępu.

W tym przewodniku wykorzystywane są też tokeny odświeżania. To proces, w ramach którego użytkownik z odpowiednim dostępem do konta Google Ads może w ramach konfiguracji jednorazowej autoryzować Twoją aplikację do wykonywania wywołań interfejsu API offline na koncie bez dodatkowej interwencji użytkownika. Za pomocą tokenów odświeżania możesz tworzyć zarówno przepływy pracy offline, takie jak zadania cron lub potoki danych, jak i interaktywne przepływy pracy, takie jak aplikacje internetowe lub mobilne.

Pobierz token odświeżania

Interfejs Google Ads API korzysta z protokołu OAuth 2.0 jako mechanizmu autoryzacji. Domyślnie uwierzytelnianie OAuth 2.0 generuje token dostępu, który wygasa po pewnym czasie. Aby automatycznie odnawiać token dostępu, musisz zamiast niego wydać token odświeżania.

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

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

    Plik credentials.json pochodzi z poprzedniego kroku.

  2. Polecenie oauth2l otwiera w nowym oknie przeglądarki okno logowania na konto Google i przechodzi przez proces uwierzytelniania OAuth 2.0.

    Pamiętaj, aby zalogować się za pomocą adresu e-mail z kroku, w którym podano identyfikator klienta logowania.

    Jeśli Twoja aplikacja nie jest zweryfikowana, może pojawić się ekran z ostrzeżeniem. W takiej sytuacji możesz bezpiecznie kliknąć link Pokaż zaawansowane, a potem opcję Przejdź do witryny PROJECT_NAME (nie zweryfikowano).

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

    W przeglądarce pojawi się prompt z tym tekstem:

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

Wywoływanie interfejsu API

Wybierz swojego klienta, aby uzyskać instrukcje wywoływania interfejsu API:

Java

Artefakty 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>30.0.0</version>
</dependency>

Zależność od Gradle:

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

Utwórz plik ~/ads.properties o tej 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

Utwórz obiekt GoogleAdsClient w ten sposób:

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 o kampaniach za pomocą metody GoogleAdsService.SearchStream, aby pobrać kampanie z Twojego konta. W tym przewodniku nie omawiamy szczegółów 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());
      }
    }
  }
}

C#

Pakiety biblioteki klienta są publikowane w repozytorium Nuget.org. Zacznij od dodania nuget odwołania 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 wygeneruj raport o kampaniach za pomocą metody GoogleAdsService.SearchStream, aby pobrać kampanie z Twojego konta. W tym przewodniku nie omawiamy szczegółów raportowania.

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

PHP

Pakiety biblioteki klienta są publikowane w repozytorium Packagist. Przejdź do katalogu głównego projektu i uruchom to polecenie, aby zainstalować bibliotekę i wszystkie jej zależności w katalogu vendor/ głównego katalogu projektu.

composer require googleads/google-ads-php:22.0.0

Utwórz kopię pliku google_ads_php.ini z repozytorium GitHub i zmodyfikuj ją, aby zawierała 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 wygeneruj raport o kampaniach za pomocą metody GoogleAdsService.SearchStream, aby pobrać kampanie z Twojego konta. W tym przewodniku nie omawiamy szczegółów 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
        );
    }
}

Python

Biblioteka klienta rozpowszechniana w PyPI można zainstalować za pomocą polecenia pip w ten sposób:

python -m pip install google-ads==21.3.0

Utwórz kopię pliku google-ads.yaml z repozytorium GitHub i zmodyfikuj ją, aby zawierała 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. Podczas wywoływania metody przekazuj do metody google-ads.yaml ścieżkę jako ciąg znaków:

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

Następnie wygeneruj raport o kampaniach za pomocą metody GoogleAdsService.SearchStream, aby pobrać kampanie z Twojego konta. W tym przewodniku nie omawiamy szczegółów 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.'
            )

Ruby

Klejnoty Ruby z biblioteki klienta są publikowane na stronie hostowania klejnotów w Rubygems. Zalecanym sposobem instalacji jest korzystanie z pakietu. Dodaj wiersz do pliku Gemfile:

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

Następnie uruchom polecenie:

bundle install

Utwórz kopię pliku google_ads_config.rb z repozytorium GitHub i zmodyfikuj ją, aby zawierała 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, podają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 o kampaniach za pomocą metody GoogleAdsService.SearchStream, aby pobrać kampanie z Twojego konta. W tym przewodniku nie omawiamy szczegółów 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

Perl

Biblioteka jest rozpowszechniana na CPAN. Zacznij od skopiowania repozytorium google-ads-perl do wybranego katalogu.

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

Przejdź do katalogu google-ads-perl i uruchom podane niżej polecenie w wierszu poleceń, aby zainstalować wszystkie zależności potrzebne do korzystania z biblioteki.

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

Utwórz kopię pliku googleads.properties z repozytorium GitHub i zmodyfikuj ją, aby zawierała 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 wygeneruj raport o kampaniach za pomocą metody GoogleAdsService.SearchStream, aby pobrać kampanie z Twojego konta. W tym przewodniku nie omawiamy szczegółów 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::V16::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;
}

REST

Zacznij od pobrania tokena dostępu OAuth 2.0 za pomocą klienta HTTP. W tym przewodniku używane jest polecenie 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 wygeneruj raport o kampaniach za pomocą metody GoogleAdsService.SearchStream, aby pobrać kampanie z Twojego konta. W tym przewodniku nie omawiamy szczegółów raportowania.

curl -i -X POST https://googleads.googleapis.com/v16/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"

query.json ma taką zawartość:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}