ตรวจสอบการแมปจาก Search Ads 360 API เวอร์ชันเก่าไปยัง Search Ads 360 Reporting API เวอร์ชันใหม่
เปิดใช้ Search Ads Reporting 360 API ในโปรเจ็กต์ Google Cloud
- เปิดคลัง API ในคอนโซล Google API เลือกโปรเจ็กต์หรือสร้างโปรเจ็กต์ใหม่เมื่อได้รับข้อความแจ้ง ไลบรารี API จะแสดงรายการ API ทั้งหมดที่ใช้ได้ โดยจัดกลุ่มตามตระกูลผลิตภัณฑ์และความนิยม
- ใช้การค้นหาเพื่อค้นหา Search Ads 360 Reporting API หากไม่เห็นในรายการ
- เลือก Search Ads 360 Reporting API แล้วคลิกเปิดใช้
เลือกคลังลูกค้า
ทำการโทรครั้งแรก
ใช้ไลบรารีของไคลเอ็นต์
เราขอแนะนําให้ใช้คลังไลบรารีไคลเอ็นต์ Search Ads 360 Reporting API เพื่อเชื่อมต่อกับ Search Ads 360 Reporting API
ดาวน์โหลดไลบรารีของไคลเอ็นต์ Search Ads 360 Reporting API สําหรับสภาพแวดล้อมการพัฒนา ทำตามวิธีการเฉพาะภาษาในวิธีตั้งค่าไฟล์การกําหนดค่าไลบรารีไคลเอ็นต์ ในกรณีส่วนใหญ่ คุณสามารถนำการกำหนดค่าที่มีอยู่มาใช้ซ้ำได้เมื่อย้ายข้อมูลไปยังคลังลูกค้าที่เชื่อมโยงกับ Search Ads 360 Reporting API เวอร์ชันใหม่
การเปลี่ยนแปลงที่สําคัญอย่างหนึ่งคือส่วนหัว login-customer-id
ใหม่ ดูรายละเอียดเกี่ยวกับกรณีที่คุณต้องเพิ่มส่วนหัวนี้ลงในการกำหนดค่าได้ที่ส่วนหัวรหัสลูกค้าสำหรับการเข้าสู่ระบบ
ตัวอย่างการกําหนดค่า Java
ตัวอย่างนี้แสดงวิธีอัปเดตไฟล์ searchads360.properties
สำหรับไลบรารีไคลเอ็นต์ Java โดยแทนที่ doubleclicksearch
ด้วย searchads360
สำหรับพร็อพเพอร์ตี้การตรวจสอบสิทธิ์
api.doubleclicksearch.clientId -> api.searchads360.clientId
api.doubleclicksearch.clientSecret -> api.searchads360.clientSecret
api.doubleclicksearch.refreshToken -> api.searchads360.refreshToken
โทรออกครั้งแรก
เมื่ออัปเดตไฟล์การกําหนดค่าแล้ว คุณจะโทรครั้งแรกได้
รับแคมเปญ
ใน IDE ให้เรียกใช้โค้ดต่อไปนี้
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
คอนโซลควรแสดงรายการแคมเปญในบัญชี
ใช้ REST
หากตัดสินใจว่าจะไม่ใช้ไลบรารีไคลเอ็นต์ คุณจะต้องเข้าใจวิธีใช้ REST
หากคุณใช้ REST กับ Search Ads 360 API เวอร์ชันเก่า ข้อมูลเข้าสู่ระบบจะยังคงใช้งานได้กับ Search Ads 360 Reporting API เวอร์ชันใหม่ ค้นหาปลายทางใหม่และรายละเอียดอื่นๆ ได้ในส่วนข้อมูลอ้างอิง REST
ดูข้อมูลเพิ่มเติม
ดูข้อมูลเพิ่มเติมเกี่ยวกับ Search Ads 360 Reporting API