Клиентские библиотеки

Клиентские библиотеки Google Ads API предоставляют высокоуровневые представления и базовые строительные блоки функций Google Ads API, что упрощает быструю разработку приложений. Если вы только начинаете работать с API, сначала попробуйте клиентскую библиотеку.

Клиентская библиотека Источник Распространение Примеры кода
Java google-ads-java Maven, tar.gz, zip Посмотреть на GitHub
.NET google-ads-dotnet NuGet, tar.gz, zip Посмотреть на GitHub
PHP google-ads-php Composer, tar.gz, zip Посмотреть на GitHub
Python google-ads-python PyPI, tar.gz, zip Посмотреть на GitHub
Ruby google-ads-ruby RubyGems, tar.gz, zip Посмотреть на GitHub
Perl google-ads-perl CPAN, tar.gz, zip Посмотреть на GitHub

общественные библиотеки;

Нам известно о нескольких библиотеках, которые поддерживаются сообществом разработчиков ПО с открытым исходным кодом. Мы ведем этот список, чтобы помочь заинтересованным разработчикам найти их. Мы не тестируем, не поддерживаем и не развиваем эти библиотеки, поэтому вы используете их на свой страх и риск. Если у вас есть вопросы, обратитесь к владельцам проектов с открытым исходным кодом.

Если вы знаете библиотеку, которой нет в списке, нажмите Отправить отзыв в верхней части страницы и сообщите нам об этом.

Поддерживаемые версии API

В таблице показано, какие клиентские библиотеки работают с какими версиями API.

Указанная минимальная версия клиентской библиотеки подходит для основной версии Google Ads API (например, v26). Чтобы узнать, какая версия клиентской библиотеки требуется для минорных выпусков, перейдите по ссылке в журнале изменений.

Java

Журнал изменений

Клиентская библиотека для Java
v26 Min: 48.0.0
Max: -
v25 Min: 44.0.0
Max: -
v24 Min: 43.0.0
Max: -
v23 Min: 42.0.0
Max: -

C#

Журнал изменений

Клиентская библиотека для .NET
v26 Min: 27.5.0
Max: -
v25 Min: 26.1.0
Max: -
v24 Min: 25.3.0
Max: -
v23 Min: 25.1.0
Max: -

PHP

Журнал изменений

Клиентская библиотека для PHP
v26 Min: 35.2.0
Max: -
v25 Min: 33.6.0
Max: -
v24 Min: 33.3.0
Max: -
v23 Min: 32.2.0
Max: -

Python

Журнал изменений

Клиентская библиотека для Python
v26 Min: 34.0.0
Max: -
v25 Min: 31.2.0
Max: -
v24 Min: 30.1.0
Max: -
v23 Min: 29.2.0
Max: -

Ruby

Журнал изменений

Клиентская библиотека для Ruby
v26 Min: 46.0.0
Max: -
v25 Min: 43.0.0
Max: -
v24 Min: 40.0.0
Max: -
v23 Min: 38.0.0
Max: -

Perl

Журнал изменений

Клиентская библиотека для Perl
v26 Min: 36.0.0
Max: -
v25 Min: 33.0.0
Max: -
v24 Min: 32.0.0
Max: -
v23 Min: 31.0.0
Max: -

Конфигурация

Каждая клиентская библиотека Google Ads API предоставляет различные настройки конфигурации и методы загрузки, которые можно использовать для настройки ее поведения.

Ниже приведены стандартные переменные среды, которые можно использовать для настройки клиентских библиотек.

  • Клиентская библиотека
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH – путь к файлу конфигурации. Считывается автоматически при загрузке из файла конфигурации без явного аргумента пути в Java (fromPropertiesFile()), Perl (Client->new()), PHP (fromFile()), Python (load_from_storage(), а также проверяется load_from_env()) и Ruby (GoogleAdsClient.new). В .NET загрузите эту переменную явным образом с помощью config.TryLoadFromEnvironmentFilePath или загрузите файлы конфигурации с помощью LoadFromSettingsJson, LoadFromConfigurationSection или LoadFromConfigurationRoot.
  • OAuth2
    • Режим приложения
      • GOOGLE_ADS_CLIENT_ID: укажите идентификатор клиента OAuth2.
      • GOOGLE_ADS_CLIENT_SECRET: укажите секретный код клиента OAuth2.
      • GOOGLE_ADS_REFRESH_TOKEN: задайте для этого параметра предварительно сгенерированный токен обновления OAuth2, если вы хотите использовать токены OAuth2 повторно. Это необязательная настройка.
    • Режим сервисного аккаунта
      • GOOGLE_ADS_JSON_KEY_FILE_PATH: укажите путь к файлу ключа JSON OAuth2 (в .NET также задайте для GOOGLE_ADS_OAUTH2_MODE значение SERVICE_ACCOUNT, поскольку по умолчанию для OAuth2Mode используется значение APPLICATION; в PHP версий до v32.1.0 или при использовании специальных областей действия также задайте [OAUTH2] scopes в google_ads_php.ini или вызовите withScopes(), поскольку fromEnvironmentVariables() не считывает области действия OAuth2 из переменной среды).
      • GOOGLE_ADS_IMPERSONATED_EMAIL – задайте в качестве значения адрес электронной почты аккаунта, который вы представляете при использовании делегирования доступа на уровне домена Google Workspace. Этот параметр необязательный.
    • Режим Application Default Credentials
      • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS. Задайте значение true, чтобы выполнять аутентификацию с помощью Application Default Credentials (ADC). Поддерживается в Java v41.1.0 и более поздних версиях, Python v28.3.0 и более поздних версиях, а также Ruby v36.1.0 и более поздних версиях (в .NET v24.1.0 и более поздних версиях LoadFromEnvironmentVariables() считывает переменную USE_APPLICATION_DEFAULT_CREDENTIALS без префикса или задает UseApplicationDefaultCredentials = true в GoogleAdsConfig; в PHP OAuth2TokenBuilder автоматически возвращается к ADC, если не заданы явные учетные данные OAuth2; Perl не поддерживает ADC).
  • Google Ads API
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID – идентификатор клиента, авторизованного для использования в запросе, без дефисов (-).
    • GOOGLE_ADS_LINKED_CUSTOMER_ID – этот заголовок требуется только для методов, которые обновляют ресурсы объекта, если разрешение предоставлено через связанные аккаунты в интерфейсе Google Рекламы (ресурс AccountLink в Google Ads API). Укажите идентификатор клиента поставщика данных, который обновляет ресурсы указанного идентификатора клиента. Его нужно указывать без дефисов (-). Подробнее о Связанных аккаунтах можно узнать в Справочном центре.

Переменные среды обычно определяются в файле конфигурации bash, например .bashrc или .bash_profile, который находится в каталоге $HOME. Их также можно определить с помощью командной строки.

Вот основные шаги по определению переменной среды с помощью файла .bashrc в терминале:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
source ~/.bashrc

Переменные среды также можно задать в экземпляре терминала непосредственно из командной строки:

export GOOGLE_ADS_CLIENT_ID=1234567890

Другой вариант – задать переменные среды при вызове команды, которая их использует:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

Извлечение объектов

GoogleAdsService.SearchStream обычно используется для получения объектов, а результаты возвращаются в виде потока строк. Кроме того, вы можете использовать GoogleAdsService.Search для получения объектов через ненадежное подключение к интернету. GoogleAdsService.Search возвращает результаты в виде страниц фиксированного размера по 10 000 строк на страницу.

Клиентские библиотеки автоматически реализуют разбиение на страницы при итерации результатов, чтобы вы могли последовательно скачать и обработать их все сразу.

Java

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#

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

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

def main(client: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

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

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )

Ruby

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

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::V25::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;
}

curl

Примеры кода

Ознакомьтесь с примерами кода для некоторых распространенных функций Google Ads API.