The new Search Ads 360 Reporting API is now available. Join the searchads-api-announcements Google group to stay up to date on upcoming enhancements and releases.

Paging through results

The Search Ads 360 Reporting API supports pagination of query results through the Search method by specifying page_size in your request. This will break up the result set of the query into multiple responses that each contains up to page_size objects. If page_size is not specified, it is automatically set to the maximum page size of 10,000 rows.

For example, with the following query:

  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

If your account contains 50,000 keywords and page_size is set to 1,000 , the result set will contain 1,000 SearchAdsRow objects in the first response, along with a next_page_token . To retrieve the next one thousand rows, simply send the request again with the same page size, but update the request's page_token to the response's next_page_token . The value of page_size in the subsequent requests can be different each time.

Our client libraries handle paging automatically. You only have to iterate through the rows of the response. When all the rows in the current page have been returned, the client library will fetch a new page of rows automatically on your behalf until the entire data set has been retrieved. If using REST instead of gRPC, you must explicitly make a request for each new page.

Search Ads 360 Reporting API internally caches the entire data set, so subsequent requests are faster than the first request. Depending on your use case, you can set page_size to any value between 1 and 10,000. In general, for faster overall performance, you should use a larger page_size due to fewer round trips in your responses.

Pagination example

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

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

Download get_campaigns.py

Paging through results Stay organized with collections Save and categorize content based on your preferences.

Pagination example

Java

Python

Paging through results