Отображение отчетов в потоковом режиме с помощью GoogleAdsService

Для получения данных из API Google Ads и данных для отчетов используйте один из следующих методов:

Вот основные отличия этих двух методов:

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

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

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

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

Пример

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

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

Факторы производительности

В большинстве случаев мы рекомендуем SearchStream вместо Search по следующим причинам:

  • Одностраничные отчеты (менее 10 000 строк): Существенных различий в производительности между двумя методами нет.
  • Многостраничные отчеты: SearchStream обычно работает быстрее, поскольку исключается множество сетевых запросов, а чтение или запись из дискового кэша оказывают меньшее влияние.
  • Экономия памяти: При обработке больших отчетов с помощью SearchStream следует перебирать фрагменты потока и обрабатывать строки по мере их поступления, а не буферизовать все строки в памяти одновременно, чтобы избежать ошибок нехватки памяти (OOM).
  • Устойчивость соединения: Поскольку 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.'
            )
      

Руби

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

локон