Các phần sau đây mô tả cách bắt đầu sử dụng API Báo cáo Search Ads 360.
Thiết lập dự án trên Google Cloud
Để sử dụng API Báo cáo Search Ads 360, bạn cần tạo một dự án cho ứng dụng của mình trên Google Cloud.
Tạo dự án trên Google
Dự án trên Google đóng vai trò là vùng chứa tài nguyên cho các tài nguyên của bạn trên Google Cloud.
Tạo thông tin xác thực OAuth2
API Báo cáo Search Ads 360 sử dụng OAuth 2.0 để xác thực và uỷ quyền. Thông tin xác thực OAuth giúp Google xác định ứng dụng của bạn và cho phép bạn tạo mã thông báo OAuth để quản lý người dùng Search Ads 360.
Bật Search Ads 360 Reporting API
Để sử dụng API này, bạn phải bật API Báo cáo Search Ads 360 cho dự án của mình trong Google API Console.
Bật tính năng thanh toán cho dự án (không bắt buộc)
Bạn sẽ không phải trả phí khi sử dụng Search Ads 360 Reporting API trong Google Cloud. Tuy nhiên, mỗi tài khoản có hạn mức về tổng số dự án miễn phí trên Cloud. Nếu đã đạt đến hạn mức, bạn có thể đăng ký một tài khoản Google mới có hạn mức dự án miễn phí.
Bật màn hình xin phép cho dự án
Tạo, chỉnh sửa hoặc xem(các) URI chuyển hướng
Tải thư viện ứng dụng xuống
Bạn nên sử dụng thư viện ứng dụng Search Ads 360 Reporting API để kết nối với Search Ads 360 Reporting API.
Tải thư viện ứng dụng API Báo cáo Search Ads 360 xuống cho môi trường phát triển của bạn. Làm theo hướng dẫn dành riêng cho ngôn ngữ về cách thiết lập tệp cấu hình thư viện ứng dụng. Trong hầu hết trường hợp, bạn có thể sử dụng lại cấu hình hiện có khi di chuyển sang thư viện ứng dụng API Báo cáo Search Ads 360 mới.
Một thay đổi quan trọng là tiêu đề login-customer-id mới. Hãy xem phần Tiêu đề mã khách hàng đăng nhập để biết thông tin chi tiết về thời điểm bạn cần thêm tiêu đề này vào cấu hình.
Thực hiện cuộc gọi đầu tiên
Sau khi định cấu hình thư viện ứng dụng, bạn có thể thực hiện lệnh gọi đầu tiên.
Nhận chiến dịch
Trong IDE, hãy thực thi mã sau:
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());
}
}
}
Tải GetCampaigns.java xuống
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()
Tải get_campaigns.py xuống
Bảng điều khiển sẽ in danh sách các chiến dịch trong tài khoản của bạn.
Sử dụng REST
Nếu quyết định không sử dụng thư viện ứng dụng, bạn cần hiểu cách sử dụng REST.
Nếu bạn đã sử dụng REST với API Search Ads 360 cũ, thì thông tin xác thực của bạn vẫn sẽ hoạt động với API Báo cáo Search Ads 360 mới. Tìm điểm cuối mới và các thông tin chi tiết khác trong phần tham khảo về REST.
Tìm hiểu thêm
Tìm hiểu thêm về Search Ads 360 Reporting API