नतीजों को पेज पर दिखाना

Search Ads 360 Reporting API, Search तरीके से क्वेरी के नतीजों को पेज पर दिखाने की सुविधा देता है. इसके लिए, आपको अपने अनुरोध में page_size की जानकारी देनी होगी. इससे क्वेरी के नतीजे के सेट को कई रिस्पॉन्स में बांटा जाएगा. हर रिस्पॉन्स में page_size ऑब्जेक्ट तक हो सकते हैं. अगर page_size की वैल्यू नहीं दी जाती है, तो यह अपने-आप 10,000 लाइनों के पेज साइज़ पर सेट हो जाता है.

उदाहरण के लिए, इस क्वेरी के साथ:

SELECT
  ad_group.id,
  ad_group_criterion.type,
  ad_group_criterion.criterion_id,
  ad_group_criterion.keyword.text,
  ad_group_criterion.keyword.match_type
FROM ad_group_criterion
WHERE ad_group_criterion.type = KEYWORD

अगर आपके खाते में 50,000 कीवर्ड हैं और page_size को 1,000 पर सेट किया गया है, तो नतीजे के सेट में पहले जवाब में 1,000 SearchAdsRow ऑब्जेक्ट के साथ-साथ next_page_token भी शामिल होगा. अगली एक हज़ार पंक्तियां पाने के लिए, बस एक ही पेज साइज़ के साथ फिर से अनुरोध भेजें. हालांकि, अनुरोध के page_token को जवाब के next_page_token पर अपडेट करें. इसके बाद के अनुरोधों में, page_size की वैल्यू हर बार अलग-अलग हो सकती है.

ध्यान दें: next_page_token, उस रिस्पॉन्स में अपने-आप नहीं भरेगा जिसमें लाइनों का आखिरी बैच शामिल है.

हमारी क्लाइंट लाइब्रेरी, पेजिंग को अपने-आप मैनेज करती हैं. आपको सिर्फ़ जवाब की पंक्तियों को दोहराना होगा. जब मौजूदा पेज की सभी पंक्तियां दिख जाएंगी, तब क्लाइंट लाइब्रेरी आपकी ओर से पंक्तियों का नया पेज अपने-आप फ़ेच करेगी. ऐसा तब तक होगा, जब तक पूरा डेटा सेट वापस नहीं आ जाता. अगर gRPC के बजाय REST का इस्तेमाल किया जा रहा है, तो आपको हर नए पेज के लिए साफ़ तौर पर अनुरोध करना होगा.

Search Ads 360 Reporting API, पूरे डेटा सेट को अंदरूनी तौर पर कैश मेमोरी में सेव करता है. इसलिए, इसके बाद के अनुरोध पहले अनुरोध के मुकाबले तेज़ी से पूरे होते हैं. इस्तेमाल के उदाहरण के आधार पर, page_size को 1 से 10,000 के बीच किसी भी वैल्यू पर सेट किया जा सकता है. आम तौर पर, बेहतर परफ़ॉर्मेंस के लिए, आपको बड़े page_size का इस्तेमाल करना चाहिए. इससे आपके रिस्पॉन्स में राउंड ट्रिप कम हो जाते हैं.

पेज नंबर दिखाने का उदाहरण

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.SearchAds360ServiceClient.SearchPagedResponse;
import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;

/** Get campaign details. */
public class GetCampaigns {
  private static final int PAGE_SIZE = 200;

  private static class GetCampaignsParams extends CodeSampleParams {

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

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

  public static void main(String[] args) {
    GetCampaignsParams params = new GetCampaignsParams();
    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 GetCampaigns().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";
    SearchSearchAds360Request request =
        SearchSearchAds360Request.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .setPageSize(PAGE_SIZE)
            .build();

    // Issues a search request.
    final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
    for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
      System.out.printf(
          "Campaign found with name '%s', ID %d, and status: %s.%n",
          element.getCampaign().getName(),
          element.getCampaign().getId(),
          element.getCampaign().getStatus());
    }
  }
}

GetCampaigns.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 pagination search request."""

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

_DEFAULT_PAGE_SIZE = 10000


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

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

  request = SearchSearchAds360Request()
  request.customer_id = customer_id
  request.query = query
  request.page_size = page_size

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

  for row in results:
    campaign = row.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, _DEFAULT_PAGE_SIZE)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

get_campaigns.py डाउनलोड करें