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

Наши клиентские библиотеки предоставляют высокоуровневые представления и базовые строительные блоки функциональности API Google Рекламы, что упрощает быструю разработку приложений. Мы рекомендуем начать с одного, если вы новичок в API.

Клиентская библиотека	Источник	Распределение	Примеры кода
Ява	Google-реклама-Java	Мавен , tar.gz	Посмотреть на GitHub
.СЕТЬ	Google-Реклама-DotNet	nuget , tar.gz, zip	Посмотреть на GitHub
PHP	Google-реклама-php	tar.gz	Посмотреть на GitHub
Питон	Google-реклама-Python	tar.gz, zip	Посмотреть на GitHub
Руби	Google-реклама-Ruby	драгоценный камень, tar.gz, zip	Посмотреть на GitHub
Перл	Google-Реклама-Perl	tar.gz, zip	Посмотреть на GitHub

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

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

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

• NodeJS: https://www.npmjs.com/package/google-ads-api .

• Зайдите: https://github.com/shenzhencenter/google-ads-pb.

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

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

Ява

API Google Рекламы	Клиентская библиотека для Java
v18	Min: 34.0.0 Max: -
v17	Min: 32.0.0 Max: -
v16	Min: 30.0.0 Max: -

С#

API Google Рекламы	Клиентская библиотека для .NET
v18	Min: 21.1.0 Max: -
v17	Min: 20.1.0 Max: -
v16	Min: 18.1.0 Max: -

PHP

API Google Рекламы	Клиентская библиотека для PHP
v18	Min: 25.0.0 Max: -
v17	Min: 23.1.0 Max: -
v16	Min: 22.1.0 Max: -

Питон

API Google Рекламы	Клиентская библиотека для Python
v18	Min: 25.1.0 Max: -
v17	Min: 24.1.0 Max: -
v16	Min: 23.1.0 Max: -

Руби

API Google Рекламы	Клиентская библиотека для Ruby
v18	Min: 31.0.0 Max: -
v17	Min: 29.0.0 Max: -
v16	Min: 27.0.0 Max: -

Перл

API Google Рекламы	Клиентская библиотека для Perl
v18	Min: 25.0.1 Max: -
v17	Min: 23.0.0 Max: -
v16	Min: 21.0.0 Max: -

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

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

Ниже приведены переменные среды, которые являются общими для всех клиентских библиотек и которые можно загрузить для установки параметров конфигурации:

• Клиентская библиотека
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH : путь к файлу конфигурации.
• ОАут2
  • Режим приложения
    • GOOGLE_ADS_CLIENT_ID : установите для этого значения идентификатор клиента OAuth2.
    • GOOGLE_ADS_CLIENT_SECRET : установите это значение для секрета вашего клиента OAuth2.
    • GOOGLE_ADS_REFRESH_TOKEN : задайте для этого значения предварительно созданный токен обновления OAuth2, если вы хотите повторно использовать токены OAuth2. Этот параметр является необязательным.
  • Режим учетной записи службы
    • GOOGLE_ADS_JSON_KEY_FILE_PATH : задайте для этого значения путь к файлу конфигурации JSON OAuth2.
    • GOOGLE_ADS_IMPERSONATED_EMAIL : установите в этом значении адрес электронной почты учетной записи, которую вы выдаете за себя.
• API Google Рекламы
  • GOOGLE_ADS_DEVELOPER_TOKEN : укажите свой токен разработчика.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID : это идентификатор авторизованного клиента, который будет использоваться в запросе, без дефисов ( - ).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID : этот заголовок необходим только для методов, которые обновляют ресурсы объекта при наличии разрешения через связанные аккаунты в пользовательском интерфейсе Google Рекламы (ресурс AccountLink в API Google Рекламы). Установите для этого значения идентификатор клиента поставщика данных, который обновляет ресурсы с указанным идентификатором клиента. Его следует указывать без дефисов ( - ). Чтобы узнать больше о связанных аккаунтах, посетите Справочный центр .

Примечание. Более подробную информацию о том, как их использовать, а также любые дополнительные переменные среды, специфичные для клиентской библиотеки, см. в руководствах по настройке, посвященных каждой клиентской библиотеке: Java , .NET , PHP , Python , Ruby , Perl .

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

Примечание. В этих инструкциях предполагается, что вы используете Bash. Если вы используете другую оболочку, обратитесь к документации по эквивалентным командам.

Вот несколько основных шагов по определению переменной среды с помощью файла .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.
src ~/.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 строк на страницу.

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

Ява

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
      

С#

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

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
      

Питон

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
      

Руби

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
      

Перл

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
      

Примеры кода

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