Flux de rapport

Il existe deux méthodes pour récupérer des entités et des données de rapport avec l'API Search Ads 360 Reporting.

Ce guide se concentre principalement sur les flux de données à partir de SearchAds360Service. Voici les principales distinctions entre les deux méthodes de récupération des données:

SearchAds360Service.SearchStream SearchAds360Service.Search
Convient au code de production Yes Yes
Service SearchAds360Service SearchAds360Service
Scénario Récupérer des objets et des rapports Récupérer des objets et des rapports
Réponse Flux d'objets SearchAds360Row Pages d'objets SearchAds360Row
Champs de la réponse Uniquement ceux spécifiés dans la requête Uniquement ceux spécifiés dans la requête
Limites quotidiennes Consultez Limites et quotas d'API. Consultez Limites et quotas d'API.

Bien que Search puisse envoyer plusieurs requêtes paginées pour télécharger l'intégralité du rapport, SearchStream envoie une seule demande et initie une connexion persistante à l'API Search Ads 360 Reporting, quelle que soit la taille du rapport.

Pour SearchStream, les paquets de données commencent à être téléchargés immédiatement avec l'intégralité du résultat mis en cache dans un tampon de données. Le code peut commencer à lire les données en mémoire tampon sans avoir à attendre la fin de l'intégralité du flux.

En éliminant le temps réseau aller-retour nécessaire pour demander chaque page d'une réponse Search, en fonction de votre application, SearchStream peut offrir de meilleures performances par rapport à la pagination, en particulier pour les rapports volumineux.

Exemple

Prenons l'exemple d'un rapport comportant 100,000 lignes. Le tableau suivant détaille les différences comptables entre les deux méthodes.

SearchStream Rechercher
Format de page Non applicable 10 000 lignes par page
Nombre de requêtes API 1 requête 10 requêtes
Nombre de réponses de l'API 1 flux continu 10 réponses

Facteurs de performances

Nous recommandons généralement d'utiliser SearchStream plutôt que Search pour les raisons suivantes.

  • Pour les rapports sur une seule page (moins de 10 000 lignes): aucune différence de performances significative entre les deux méthodes.

  • Pour les rapports sur plusieurs pages, SearchStream est généralement plus rapide, car plusieurs allers-retours sont évités et la lecture/écriture à partir du cache du disque est moins importante.

Limites de débit

Les limites quotidiennes pour les deux méthodes respectent les limites et quotas d'API standards. Une seule requête ou un seul rapport est comptabilisé comme une opération, quel que soit le résultat paginé ou diffusé.

Exemple de 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());
      }
    }
  }
}

Télécharger GetCampaignStream.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()

Télécharger le fichier get_campaigns_stream.py