Report Streaming

Esistono due metodi per recuperare entità e dati dei report con l'API Search Ads 360 Reporting.

Questa guida è incentrata principalmente sull'inserimento di flussi di dati da SearchAds360Service. Ecco le distinzioni generali per i due metodi di recupero dei dati:

SearchAds360Service.SearchStream SearchAds360Service.Search
Adatto per codice di produzione Yes Yes
Servizio SearchAds360Service SearchAds360Service
Scenario Recupero di oggetti e report Recupero di oggetti e report
Risposta Stream di SearchAds360Row oggetti Pagine di oggetti SearchAds360Row
Campi della risposta Solo quelli specificati nella query Solo quelli specificati nella query
Limiti giornalieri Consulta Limiti e quote delle API. Consulta Limiti e quote delle API.

Sebbene Search possa inviare più richieste impaginate per scaricare l'intero report, SearchStream invia una singola richiesta e avvia una connessione permanente con l'API Search Ads 360 Reporting indipendentemente dalle dimensioni del report.

Per SearchStream, il download dei pacchetti di dati inizia immediatamente con l'intero risultato memorizzato nella cache in un buffer dati. Il tuo codice può iniziare a leggere i dati nel buffer senza dover aspettare il completamento dell'intero flusso.

Eliminando il tempo di rete di andata e ritorno necessario per richiedere ogni singola pagina di una risposta Search, a seconda della tua app, SearchStream può offrire prestazioni migliori rispetto al paging, in particolare per i report di maggiori dimensioni.

Esempio

Ad esempio, crea un report composto da 100,000 righe. La seguente tabella suddivide le differenze contabili tra i due metodi.

SearchStream Cerca
Dimensioni pagina Non applicabile 10.000 righe per pagina
Numero di richieste API 1 richiesta 10 richieste
Numero di risposte dell'API 1 stream continuo 10 risposte

Fattori di rendimento

In generale, consigliamo di acquistare SearchStream rispetto a Search per i seguenti motivi.

  • Per i report a pagina singola (meno di 10.000 righe): non esistono differenze significative in termini di prestazioni tra i due metodi.

  • Per report con più pagine: SearchStream è in genere più veloce perché si evitano i round trip multipli e la lettura/scrittura dalla cache del disco è un fattore meno importante.

Limiti di frequenza

I limiti giornalieri per entrambi i metodi rispettano i limiti e le quote dell'API standard. Una singola query o un singolo report vengono conteggiati come un'unica operazione, indipendentemente dal fatto che il risultato sia impaginato o trasmesso.

Esempio di streaming

Java

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package sample;

import com.beust.jcommander.Parameter;
import com.google.ads.searchads360.v0.lib.SearchAds360Client;
import com.google.ads.searchads360.v0.services.SearchAds360Row;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
import com.google.ads.searchads360.v0.services.SearchSearchAds360StreamRequest;
import com.google.ads.searchads360.v0.services.SearchSearchAds360StreamResponse;
import com.google.api.gax.rpc.ServerStream;

/** Get campaign details using SearchStream. */
public class GetCampaignsStream {
  private static class GetCampaignsStreamParams extends CodeSampleParams {

    @Parameter(names = "--customerId", required = true)
    private String customerId;

    @Parameter(names = "--loginCustomerId")
    private String loginCustomerId;
  }

  public static void main(String[] args) {
    GetCampaignsStreamParams params = new GetCampaignsStreamParams();
    if (!params.parseArguments(args)) {
      // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
      // here (10 digits, no dashes). If neither are set, customerId will be used as
      // loginCustomerId.
      // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
    }
    final String loginCustomerId = params.loginCustomerId;
    final String customerId = params.customerId;

    try {
      // Creates a SearchAds360Client with the specified loginCustomerId. If there's
      // no loginCustomerId, customerId will be used instead.
      final SearchAds360Client searchAds360Client =
          SearchAds360Client.newBuilder()
              .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
              .fromPropertiesFile()
              .build();
      // Creates the Search Ads 360 Service client.
      SearchAds360ServiceClient client = searchAds360Client.create();
      new GetCampaignsStream().runExample(client, customerId);
    } catch (Exception exception) {
      System.err.printf("Failed with exception: %s%n", exception);
      exception.printStackTrace();
      System.exit(1);
    }
  }

  private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
    // Creates a query that retrieves all campaigns under the customerId.
    String query = "SELECT campaign.name, campaign.id, campaign.status FROM campaign";
    SearchSearchAds360StreamRequest request =
        SearchSearchAds360StreamRequest.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .build();

    // Issues a search stream request.
    ServerStream<SearchSearchAds360StreamResponse> stream =
        searchAds360ServiceClient.searchStreamCallable().call(request);

    for (SearchSearchAds360StreamResponse response : stream) {
      for (SearchAds360Row element : response.getResultsList()) {
        System.out.printf(
            "Campaign found with name '%s', ID %d, and status: %s.%n",
            element.getCampaign().getName(),
            element.getCampaign().getId(),
            element.getCampaign().getStatus());
      }
    }
  }
}

Scarica GetCampagneStream.java

Python

#!/usr/bin/env python
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Retrieves campaigns for a customer using a stream request."""

import argparse
import traceback
from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360StreamRequest
from util_searchads360 import SearchAds360Client


def main(client, customer_id) -> None:
  search_ads_360_service = client.get_service()

  query = """
      SELECT
        campaign.name,
        campaign.id,
        campaign.status
      FROM campaign"""

  request = SearchSearchAds360StreamRequest()
  request.customer_id = customer_id
  request.query = query

  # Issues a search stream request.
  results = search_ads_360_service.search_stream(request=request)

  for response in results:
    for result in response.results:
      campaign = result.campaign
      print(
          f'campaign "{campaign.name}" has id {campaign.id} and status {campaign.status.name}'
      )


if __name__ == "__main__":
  # SearchAds360Client will read the search-ads-360.yaml configuration file in
  # the home directory if none is specified.
  search_ads_360_client = SearchAds360Client.load_from_file()

  parser = argparse.ArgumentParser(
      description=("Retrieves campaigns for a customer."))
  # Arguments to provide to run the example.
  parser.add_argument(
      "-c",
      "--customer_id",
      type=str,
      required=True,
      help="The Search Ads 360 customer ID (10 digits, no dashes).",
  )

  parser.add_argument(
      "-l",
      "--login_customer_id",
      type=str,
      required=False,
      help="The Search Ads 360 login customer ID (10 digits, no dashes).",
  )

  args = parser.parse_args()

  search_ads_360_client.set_ids(args.customer_id, args.login_customer_id)

  try:
    main(search_ads_360_client, args.customer_id)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

Scarica get_campaigns_stream.py