Strumieniowanie raportów

Za pomocą interfejsu Search Ads 360 Reporting API możesz pobierać elementy i dane do raportu na 2 sposoby.

Ten przewodnik dotyczy głównie strumieniowania danych z SearchAds360Service. Oto ogólne różnice między tymi metodami pobierania danych:

SearchAds360Service.SearchStream SearchAds360Service.Search
Zalecane w przypadku kodu produkcyjnego Yes Yes
Usługa SearchAds360Service SearchAds360Service
Scenariusz Pobieranie obiektów i raportów Pobieranie obiektów i raportów
Odpowiedź Strumień obiektów SearchAds360Row Strony obiektów SearchAds360Row
Pola odpowiedzi Tylko te określone w zapytaniu Tylko te określone w zapytaniu
Limity dzienne Zobacz Limity i limity interfejsów API. Zobacz Limity i limity interfejsów API.

Chociaż narzędzie Search może wysyłać wiele żądań pobrania całego raportu podzielonego na strony, SearchStream wysyła jedno żądanie i inicjuje trwałe połączenie z Search Ads 360 Reporting API niezależnie od rozmiaru raportu.

W przypadku SearchStream pobieranie pakietów danych rozpoczyna się natychmiast, a cały wynik jest przechowywany w buforcie danych. Kod może rozpocząć odczytywanie danych zbuforowanych bez konieczności czekania na zakończenie całego strumienia.

Dzięki eliminacji czasu przesyłania danych w obie strony wymagane do żądania każdej strony w odpowiedzi Search (zależnie od Twojej aplikacji) SearchStream może zapewniać wyższą skuteczność w przypadku stronicowania, zwłaszcza w przypadku większych raportów.

Przykład

Przeanalizuj np. raport składający się z 100,000 wierszy. W tabeli poniżej przedstawiono różnice księgowe między tymi metodami.

SearchStream Wyszukiwarka
Rozmiar strony Nie dotyczy 10 000 wierszy na stronę
Liczba żądań do interfejsu API 1 żądanie 10 próśb
Liczba odpowiedzi interfejsu API 1 ciągły strumień 10 odpowiedzi

Czynniki skuteczności

Ogólnie zalecamy SearchStream zamiast Search z podanych niżej powodów.

  • Raporty na jednej stronie (poniżej 10 000 wierszy): brak istotnych różnic w skuteczności między tymi metodami.

  • W przypadku raportów obejmujących wiele stron: SearchStream działa zwykle szybciej, ponieważ unika się powtarzania wielokrotnie, a odczyt i zapis z pamięci podręcznej na dysku to mniejsze znaczenie.

Ograniczenia liczby żądań

Limity dzienne w przypadku obu metod są zgodne ze standardowymi limitami interfejsu API. Pojedyncze zapytanie lub raport są liczone jako jedna operacja niezależnie od tego, czy wynik zostanie podzielony na strony czy przesłana strumieniowo.

Przykład strumieniowania

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

Pobierz plik GetCampaignsStream.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()

Pobierz get_campaigns_stream.py