स्ट्रीमिंग की रिपोर्ट करें

Search Ads 360 Reporting API की मदद से इकाइयों और रिपोर्टिंग डेटा को वापस पाने के दो तरीके हैं.

इस गाइड में मुख्य रूप से, SearchAds360Service से स्ट्रीम किए जा रहे डेटा पर फ़ोकस किया गया है. डेटा वापस पाने के दो तरीकों के बीच के अंतर के बारे में यहां बताया गया है:

SearchAds360Service.SearchStream SearchAds360Service.Search
प्रोडक्शन कोड के लिए सही है हां हां
सेवा SearchAds360Service SearchAds360Service
स्थिति ऑब्जेक्ट और रिपोर्ट फ़ेच करना ऑब्जेक्ट और रिपोर्ट फ़ेच की जा रही हैं
जवाब SearchAds360Row ऑब्जेक्ट की स्ट्रीम SearchAds360Row ऑब्जेक्ट के पेज
जवाब के फ़ील्ड सिर्फ़ वे जो क्वेरी में बताए गए हैं सिर्फ़ वे जो क्वेरी में बताए गए हैं
रोज़ाना इस्तेमाल की सीमाएं एपीआई की सीमाएं और कोटा देखें. एपीआई की सीमाएं और कोटा देखें.

Search, पूरी रिपोर्ट डाउनलोड करने के लिए पेज के हिसाब से कई अनुरोध भेज सकता है. वहीं, SearchStream एक ही अनुरोध भेजता है और रिपोर्ट के साइज़ के बावजूद, Search Ads 360 Reporting API के साथ लगातार कनेक्शन बनाता है.

SearchStream के लिए, डेटा बफ़र में कैश मेमोरी में सेव किए गए पूरे नतीजे के साथ, डेटा पैकेट तुरंत डाउनलोड होने लगते हैं. आपका कोड, पूरी स्ट्रीम के खत्म होने का इंतज़ार किए बिना, बफ़र किए गए डेटा को पढ़ना शुरू कर सकता है.

Search के जवाब के हर पेज का अनुरोध करने के लिए, नेटवर्क के दौरे में लगने वाले समय को खत्म करके, SearchStream आपके ऐप्लिकेशन के हिसाब से, पेजिंग के मुकाबले बेहतर परफ़ॉर्मेंस दे सकता है. खास तौर पर, बड़ी रिपोर्ट के लिए.

उदाहरण

उदाहरण के लिए, 100,000 लाइनों वाली रिपोर्ट लें. यहां दी गई टेबल में, दोनों तरीकों के बीच के अंतर को अलग-अलग बताया गया है.

SearchStream खोजें
पेज आकार इस पर रेटिंग लागू नहीं होती हर पेज में 10,000 लाइनें
एपीआई अनुरोधों की संख्या 1 अनुरोध 10 अनुरोध
एपीआई के जवाबों की संख्या लगातार चलने वाली एक स्ट्रीम 10 जवाब

परफ़ॉर्मेंस से जुड़े फ़ैक्टर

आम तौर पर, हम Search के बजाय SearchStream का सुझाव देते हैं. इसकी ये वजहें हैं.

  • एक पेज की रिपोर्ट (10,000 पंक्तियों में) के लिए: इन दोनों तरीकों की परफ़ॉर्मेंस में कोई खास अंतर नहीं है.

  • एक से ज़्यादा पेजों वाली रिपोर्ट के लिए: आम तौर पर, SearchStream तेज़ी से काम करता है, क्योंकि एक से ज़्यादा रीडायरेक्ट से बचा जा सकता है. साथ ही, डिस्क कैश मेमोरी से रीडिंग/राइटिंग की प्रोसेस कम होती है.

दर की सीमाएं

दोनों तरीकों के लिए रोज़ाना की सीमाएं, स्टैंडर्ड एपीआई की सीमाओं और कोटा के हिसाब से होती हैं. एक क्वेरी या रिपोर्ट को एक कार्रवाई के तौर पर गिना जाता है, भले ही नतीजा पेज किया गया हो या स्ट्रीम किया गया हो.

स्ट्रीमिंग का उदाहरण

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

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

get_campaigns_stream.py डाउनलोड करना