نگاشت‌های API قدیمی Search Ads 360 به API جدید Search Ads 360 Reporting را مرور کنید:
Search Ads Reporting 360 API را در پروژه Google Cloud خود فعال کنید.
- کتابخانه API را در کنسول API Google باز کنید . اگر از شما خواسته شد، پروژه خود را انتخاب کنید یا یک پروژه جدید ایجاد کنید. کتابخانه API همه API های موجود را فهرست می کند که بر اساس خانواده محصول و محبوبیت گروه بندی شده اند.
- اگر Search Ads 360 Reporting API در لیست قابل مشاهده نیست، از جستجو برای یافتن Search Ads 360 Reporting استفاده کنید.
- Search Ads 360 Reporting API را انتخاب کرده و روی Enable کلیک کنید.
کتابخانه مشتری خود را انتخاب کنید.
اولین تماس خود را انجام دهید.
از کتابخانه های مشتری استفاده کنید
استفاده از کتابخانه سرویس گیرنده Search Ads 360 Reporting API روش توصیه شده برای اتصال به Search Ads 360 Reporting API است.
کتابخانه سرویس گیرنده Search Ads 360 Reporting API را برای محیط توسعه خود دانلود کنید. دستورالعمل های خاص زبان را در مورد نحوه تنظیم فایل پیکربندی کتابخانه مشتری خود دنبال کنید. در بیشتر موارد، هنگام مهاجرت به کتابخانه سرویس گیرنده Search Ads 360 Reporting API جدید، می توانید از پیکربندی موجود خود مجددا استفاده کنید.
یکی از تغییرات مهم، سربرگ جدید login-customer-id است. برای جزئیات در مورد اینکه چه زمانی باید این را به پیکربندی خود اضافه کنید ، سربرگ شناسه مشتری ورود به سیستم را ببینید.
نمونه پیکربندی جاوا
این مثال به شما نشان می دهد که چگونه فایل searchads360.properties خود را برای کتابخانه سرویس گیرنده جاوا با جایگزینی doubleclicksearch با searchads360 برای ویژگی های احراز هویت خود به روز کنید.
api.doubleclicksearch.clientId -> api.searchads360.clientId
api.doubleclicksearch.clientSecret -> api.searchads360.clientSecret
api.doubleclicksearch.refreshToken -> api.searchads360.refreshToken
اولین تماس خود را انجام دهید
پس از به‌روزرسانی فایل پیکربندی ، می‌توانید اولین تماس خود را برقرار کنید.
کمپین ها را دریافت کنید
در IDE خود کد زیر را اجرا کنید:
جاوا
// 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 را دانلود کنیدپایتون
#!/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 را دانلود کنیدکنسول باید فهرستی از کمپین های موجود در حساب شما را چاپ کند.
از REST استفاده کنید
اگر تصمیم دارید از کتابخانه مشتری استفاده نکنید، باید نحوه استفاده از REST را بدانید.
اگر از REST با Search Ads 360 API قدیمی استفاده کرده‌اید، اعتبار شما همچنان با Search Ads 360 Reporting API جدید کار می‌کند. نقطه پایانی جدید و سایر جزئیات را در بخش مرجع REST بیابید.
بیشتر بدانید
درباره Search Ads 360 Reporting API بیشتر بیاموزید.