Потоковая передача отчетов с помощью GoogleAdsService

Чтобы получить объекты и данные отчетов Google Ads API, используйте один из следующих методов:

Вот основные различия между этими двумя методами:

GoogleAdsService.SearchStream GoogleAdsService.Search
Подходит для рабочего кода Да Да
Сервис GoogleAdsService GoogleAdsService
Сценарий Получение объектов и отчетов Получение объектов и отчетов
Ответ Поток объектов GoogleAdsRow Страницы объектов GoogleAdsRow
Поля ответа Только те, которые указаны в запросе. Только указанные в запросе
Дневные ограничения Дневные ограничения на основе уровней доступа Дневные ограничения в зависимости от уровня доступа

Search отправляет несколько запросов с разбивкой на страницы, чтобы скачать отчет целиком, а SearchStream отправляет один запрос и устанавливает постоянное gRPC-подключение к Google Ads API независимо от размера отчета.

Для SearchStream пакеты данных начинают скачиваться сразу же партиями по SearchGoogleAdsStreamResponse объектов. Ваш код может перебирать входящие пакеты по мере их поступления, не дожидаясь завершения всего потока.

Поскольку при использовании Search не требуется время на отправку запроса и получение ответа для каждой отдельной страницы, этот метод работает быстрее, чем разбиение на страницы, особенно при создании больших отчетов.SearchStream

Пример

В этом примере рассматривается отчет, состоящий из 100,000 строк. В таблице ниже приведены различия между запросами и ответами для этих двух методов.

SearchStream Поиск
Размер страницы Неприменимо 10 000 строк на странице;
Количество запросов к API 1 запрос 10 запросов
Количество ответов API 1 непрерывный поток 10 ответов

Факторы эффективности

В большинстве случаев мы рекомендуем использовать атрибут "цена со скидкой" SearchStream, а не "цена" Search. Вот почему:

  • Одностраничные отчеты (менее 10 000 строк). Значительных различий в производительности между двумя методами нет.
  • Многостраничные отчеты. SearchStream обычно работает быстрее, поскольку позволяет избежать нескольких сетевых запросов туда и обратно и уменьшает влияние чтения и записи из кеша диска.
  • Эффективное использование памяти. При обработке больших отчетов с помощью SearchStream перебирайте фрагменты потока и обрабатывайте строки по мере их поступления, а не буферизируйте все строки в памяти одновременно, чтобы избежать ошибок, связанных с нехваткой памяти.
  • Надежность подключения. Поскольку SearchStream требует постоянного подключения, длительные трансляции могут прерываться из-за проблем с сетью или тайм-аутов. Настройте подходящие тайм-ауты RPC и реализуйте логику повторных попыток для временных ошибок потока.

Ограничение частоты запросов

Ежедневные лимиты на операции для обоих методов соответствуют стандартным лимитам и уровням доступа вашего облачного проекта Google Cloud. Один логический запрос отчета считается одной операцией в рамках дневной квоты независимо от того, передается ли результат с помощью SearchStream или извлекается из нескольких кешированных страниц с помощью Search с page_token. Однако каждый запрос на получение страниц Search по-прежнему учитывается как отдельный вызов RPC в рамках краткосрочных ограничений на частоту.

Пример кода

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

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