Search Ads 360 Reporting API는 요청에 page_size를 지정하여 Search 메서드를 통해 쿼리 결과의 페이지 나누기를 지원합니다. 이렇게 하면 쿼리의 결과 집합이 최대 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로 설정된 경우 결과 집합에는 첫 번째 응답에 next_page_token와 함께 1,000개의 SearchAdsRow 객체가 포함됩니다. 다음 1,000개의 행을 가져오려면 동일한 페이지 크기로 요청을 다시 전송하되 요청의 page_token를 응답의 next_page_token로 업데이트하면 됩니다. 후속 요청의 page_size 값은 매번 다를 수 있습니다.
Google의 클라이언트 라이브러리는 페이징을 자동으로 처리합니다. 응답의 행만 반복하면 됩니다. 현재 페이지의 모든 행이 반환되면 클라이언트 라이브러리는 전체 데이터 세트가 검색될 때까지 개발자를 대신하여 새 행 페이지를 자동으로 가져옵니다. gRPC 대신 REST를 사용하는 경우 새 페이지마다 명시적으로 요청해야 합니다.
Search Ads 360 Reporting API는 내부적으로 전체 데이터 세트를 캐시하므로 후속 요청이 첫 번째 요청보다 빠릅니다. 사용 사례에 따라 page_size를 1~10,000 사이의 값으로 설정할 수 있습니다. 일반적으로 전반적인 성능을 높이려면 응답의 왕복 횟수가 적으므로 더 큰 page_size를 사용해야 합니다.
페이지로 나누기 예시
// 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());
}
}
}
#!/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()