ตัวรับบริการและประเภท

การดึงข้อมูลอ้างอิงไปยังคลาส Proto ต่างๆ ทั้งหมดที่จำเป็นต่อการใช้ API ใน Python อาจมีรายละเอียดมากและกำหนดให้คุณต้องมีความเข้าใจโดยสัญชาตญาณเกี่ยวกับ API หรือสลับบริบทบ่อยๆ เพื่ออ้างอิง Proto หรือเอกสารประกอบ

วิธีการ get_service และ get_type ของไคลเอ็นต์

เมธอด Getter ทั้ง 2 รายการนี้ช่วยให้คุณดึงข้อมูลออบเจ็กต์บริการหรือออบเจ็กต์ประเภทใดก็ได้ใน API ใช้เมธอด get_service เพื่อเรียกข้อมูลไคลเอ็นต์บริการ get_type จะใช้กับออบเจ็กต์อื่นๆ คลาสไคลเอ็นต์บริการได้รับการกำหนดไว้ในโค้ดภายใต้ เส้นทางเวอร์ชัน google/ads/googleads/v*/services/ และประเภททั้งหมดได้รับการกำหนดไว้ภายใต้ หมวดหมู่วัตถุต่างๆ google/ads/googleads/v*/common|enums|errors|resources|services/types/ ระบบจะสร้างโค้ดทั้งหมดที่อยู่ใต้ไดเรกทอรีเวอร์ชัน ดังนั้นแนวทางปฏิบัติแนะนำคือการใช้วิธีการเหล่านี้แทนการนำเข้าออบเจ็กต์โดยตรง ในกรณีที่โครงสร้างของฐานของโค้ดมีการเปลี่ยนแปลง

ตัวอย่างต่อไปนี้แสดงวิธีใช้เมธอด get_service เพื่อเรียกอินสแตนซ์ของไคลเอ็นต์ GoogleAdsService (หรือ GoogleAdsServiceAsyncClient แบบไม่พร้อมกันใน google-ads v28.4.0 และ ในภายหลังโดยการส่ง is_async=True):

from google.ads.googleads.client import GoogleAdsClient

# "load_from_storage" loads your API credentials from disk so they
# can be used for service initialization. Providing the optional `version`
# parameter means that the v25 version of GoogleAdsService will
# be returned.
client = GoogleAdsClient.load_from_storage(version="v25")
googleads_service = client.get_service("GoogleAdsService")

# Supported in google-ads v28.4.0 and later: retrieve an async service client.
googleads_async_service = client.get_service("GoogleAdsService", is_async=True)

ตัวอย่างต่อไปนี้แสดงวิธีใช้เมธอด get_type เพื่อดึงข้อมูลอินสแตนซ์ Campaign

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage(version="v25")
campaign = client.get_type("Campaign")

Enum

แม้ว่าคุณจะใช้เมธอด get_type เพื่อดึงข้อมูล Enum ได้ แต่ละอินสแตนซ์ GoogleAdsClient ก็มีแอตทริบิวต์ enums ที่โหลด Enum แบบไดนามิกโดยใช้กลไกเดียวกันกับเมธอด get_type อินเทอร์เฟซนี้จะ เรียบง่ายและอ่านง่ายกว่าการใช้ get_type

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage(version="v25")

campaign = client.get_type("Campaign")
campaign.status = client.enums.CampaignStatusEnum.PAUSED

ฟิลด์ออบเจ็กต์ Proto ที่เป็น Enum จะแสดงใน Python ด้วยประเภท enum ในตัว ซึ่งหมายความว่าคุณสามารถอ่านค่าของสมาชิก ได้โดยตรง การทำงานกับอินสแตนซ์ campaign จากตัวอย่างก่อนหน้าใน Python REPL:

>>> print(campaign.status)
CampaignStatus.PAUSED
>>> type(campaign.status)
<enum 'CampaignStatus'>
>>> print(campaign.status.value)
3

บางครั้งการทราบชื่อฟิลด์ที่สอดคล้องกับค่า Enum ก็มีประโยชน์ คุณเข้าถึงข้อมูลนี้ได้โดยใช้แอตทริบิวต์ name

>>> print(campaign.status.name)
'PAUSED'
>>> type(campaign.status.name)
<class 'str'>

การโต้ตอบกับ Enum จะแตกต่างกันไปขึ้นอยู่กับว่าคุณตั้งค่า use_proto_plus เป็น true หรือ false ดูรายละเอียดเกี่ยวกับอินเทอร์เฟซทั้ง 2 รายการได้ที่เอกสารประกอบเกี่ยวกับข้อความ Protobuf

การกำหนดเวอร์ชัน

เราจะดูแล API หลายเวอร์ชันพร้อมกัน แม้ว่า v25 จะเป็นเวอร์ชันล่าสุด แต่เวอร์ชันก่อนหน้าจะยัง เข้าถึงได้จนกว่าจะหยุดให้บริการ ไลบรารีมีคลาสข้อความ Proto แยกต่างหาก ซึ่งสอดคล้องกับ API แต่ละเวอร์ชันที่ใช้งานอยู่ หากต้องการเข้าถึงคลาสข้อความ สำหรับเวอร์ชันที่เฉพาะเจาะจง ให้ระบุพารามิเตอร์คีย์เวิร์ด version เมื่อเริ่มต้น ไคลเอ็นต์เพื่อให้ไคลเอ็นต์แสดงผลอินสแตนซ์จากเวอร์ชันที่ระบุเสมอ

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage(version="v25")
# The Campaign instance will be from the v25 version of the API.
campaign = client.get_type("Campaign")

หากไม่ได้ระบุ version เมื่อเริ่มต้นไคลเอ็นต์ คุณจะระบุเวอร์ชันต่อการเรียกได้เมื่อเรียกเมธอด get_service และ get_type (โปรดทราบว่าหากตั้งค่า version เมื่อเริ่มต้น GoogleAdsClient ระบบจะลบล้าง อาร์กิวเมนต์ version ที่ส่งไปยัง get_service หรือ get_type)

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage()
# This loads the v25 version of the GoogleAdsService.
googleads_service = client.get_service(
    "GoogleAdsService", version="v25"
)

# This loads a specific supported API version (such as v23) of a Campaign.
campaign = client.get_type("Campaign", version="v23")

หากไม่ได้ระบุversionพารามิเตอร์คีย์เวิร์ด ไลบรารีจะมีค่าเริ่มต้นเป็น เวอร์ชัน API สูงสุดที่แพ็กเกจ google-ads ที่ติดตั้งรองรับ ("v25" ในรุ่นล่าสุด) โปรดทราบว่าการเผยแพร่ API เวอร์ชันย่อย (เช่น v25.1) จะเข้าถึงได้โดยใช้สตริงเวอร์ชันหลัก (version="v25") คุณดูรายการเวอร์ชันล่าสุดและเวอร์ชันอื่นๆ ที่พร้อมใช้งานซึ่งอัปเดตแล้วได้ในส่วนการนำทางด้านซ้ายของเอกสารประกอบข้อมูลอ้างอิง API