Berichtsstreaming

Es gibt zwei Methoden, um Entitäten und Berichtsdaten mit der Search Ads 360 Reporting API abzurufen.

In diesem Leitfaden geht es hauptsächlich um das Streamen von Daten aus SearchAds360Service. Hier sind die wichtigsten Unterschiede zwischen den beiden Methoden zum Abrufen von Daten:

SearchAds360Service.SearchStream SearchAds360Service.Search
Geeignet für Produktionscode Ja Ja
Dienst SearchAds360Service SearchAds360Service
Szenario Objekte und Berichte abrufen Objekte und Berichte abrufen
Antwort Stream von SearchAds360Row-Objekten Seiten von SearchAds360Row-Objekten
Felder der Antwort Nur die in der Abfrage angegebenen Nur die in der Abfrage angegebenen
Tageslimits Weitere Informationen finden Sie unter API-Limits und ‑Kontingente. Weitere Informationen finden Sie unter API-Limits und ‑Kontingente.

Mit Search können Sie mehrere paginaierte Anfragen senden, um den gesamten Bericht herunterzuladen. Mit SearchStream wird dagegen eine einzelne Anfrage gesendet und unabhängig von der Berichtsgröße eine dauerhafte Verbindung mit der Search Ads 360 Reporting API hergestellt.

Bei SearchStream werden Datenpakete sofort heruntergeladen und das gesamte Ergebnis wird in einem Datenpuffer zwischengespeichert. Ihr Code kann mit dem Lesen der zwischengespeicherten Daten beginnen, ohne auf das Ende des gesamten Streams warten zu müssen.

Da die Netzwerklaufzeit für die Anforderung jeder einzelnen Seite einer Search-Antwort entfällt, kann SearchStream je nach App eine bessere Leistung als die Paginierung bieten, insbesondere bei größeren Berichten.

Beispiel

Angenommen, ein Bericht besteht aus 100,000 Zeilen. In der folgenden Tabelle werden die Unterschiede bei der Abrechnung zwischen den beiden Methoden aufgeschlüsselt.

SearchStream Suchen
Seitengröße Nicht zutreffend 10.000 Zeilen pro Seite
Anzahl der API-Anfragen 1 Anfrage 10 Anfragen
Anzahl der API-Antworten 1 kontinuierlicher Stream 10 Antworten

Leistungsfaktoren

Im Allgemeinen empfehlen wir SearchStream anstelle von Search aus den folgenden Gründen:

  • Für Berichte auf einer Seite (weniger als 10.000 Zeilen): Keine signifikanten Leistungsunterschiede zwischen den beiden Methoden.

  • Bei Berichten mit mehreren Seiten: SearchStream ist in der Regel schneller, da mehrere Rücksprünge vermieden werden und das Lesen/Schreiben aus dem Laufwerkcache weniger ins Gewicht fällt.

Ratenlimits

Die Tageslimits für beide Methoden entsprechen den standardmäßigen API-Limits und ‑Kontingenten. Eine einzelne Abfrage oder ein einzelner Bericht wird als ein Vorgang gezählt, unabhängig davon, ob das Ergebnis gepuffert oder gestreamt wird.

Beispiel für Streaming

JavaPython

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

GetCampaignsStream.java herunterladen 

#!/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()

get_campaigns_stream.py herunterladen