การเปลี่ยนและตรวจสอบออบเจ็กต์

ดังที่ได้กล่าวไว้ในคู่มือโครงสร้าง API ทรัพยากรระดับบนสุดแต่ละรายการใน Google Ads API มีบริการเฉพาะประเภททรัพยากรที่เกี่ยวข้องซึ่งรองรับการดำเนินการต่อไปนี้

  • การแก้ไขอินสแตนซ์ของทรัพยากร
  • การดึงข้อมูลอินสแตนซ์เดียวของทรัพยากรเพื่อตรวจสอบ

คู่มือนี้จะใช้ CampaignService เพื่อสาธิตการแก้ไขและตรวจสอบออบเจ็กต์ Campaign แต่แนวคิดเดียวกันนี้ใช้ได้กับบริการอื่นๆ ทั้งหมดที่เจาะจงประเภททรัพยากร

การเปลี่ยนวัตถุ

บริการเฉพาะประเภททรัพยากรแต่ละรายการจะมีเมธอด mutate ที่ยอมรับคำขอเปลี่ยน คำขอนี้ประกอบด้วยข้อมูลต่อไปนี้

  • customerId
  • ชุดการดำเนินการ
  • การตั้งค่าประเภทเนื้อหาของคำตอบซึ่งกำหนดว่าควรแสดงทรัพยากรที่เปลี่ยนแปลงได้หรือแค่ชื่อทรัพยากรหลังจากการดัดแปลง

เช่น เมธอด MutateCampaigns ของ CampaignService ยอมรับ MutateCampaignsRequest ประกอบด้วย

  • customerId
  • คอลเล็กชัน CampaignOperation วัตถุ
  • ช่อง response_content_type ที่ระบุประเภทคำตอบที่ต้องการ

การดำเนินการ

ออบเจ็กต์การดำเนินการ เช่น CampaignOperation ช่วยให้คุณระบุการดำเนินการที่ต้องการทำกับทรัพยากรรายการเดียวได้โดยการตั้งค่าช่อง operation ช่องนี้เป็นช่องที่มีค่าได้เพียงค่าเดียว ซึ่งประกอบด้วยแอตทริบิวต์ต่อไปนี้ที่มีประเภทเป็นประเภททรัพยากร

create
สร้างอินสแตนซ์ใหม่ของทรัพยากร
update
อัปเดตทรัพยากรให้ตรงกับแอตทริบิวต์ของทรัพยากร update เมื่อตั้งค่าช่องนี้แล้ว คุณต้องตั้งค่า update_mask ของการดำเนินการด้วย ซึ่งจะบอก Google Ads API ว่าต้องแก้ไขแอตทริบิวต์ใดในระหว่างการดำเนินการอัปเดต ไลบรารีของไคลเอ็นต์แต่ละรายการมียูทิลิตีหรือเมธอดตัวช่วยที่จะสร้าง update_mask ให้คุณ ดังที่แสดงในไลบรารีของไคลเอ็นต์
remove
นําทรัพยากรออก

เนื่องจากฟิลด์ operation เป็นฟิลด์ oneof คุณจึงใช้การดำเนินการเดียวเพื่อแก้ไขออบเจ็กต์หลายรายการไม่ได้ เช่น หากต้องการสร้างแคมเปญ 1 แคมเปญและนําแคมเปญอื่นออก ให้เพิ่ม CampaignOperation 2 อินสแตนซ์ในคําขอ โดย 1 รายการมีการตั้งค่า create และอีกรายการมีการตั้งค่า remove

การดำเนินการแบบเป็นกลุ่ม

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

ตัวอย่างเช่น หากต้องการสร้างแคมเปญ 10 รายการ คุณควรส่ง MutateCampaignsRequest รายการเดียวซึ่งมีออบเจ็กต์ CampaignOperation 10 รายการ

เปลี่ยนรูปแบบคำตอบ

ข้อมูลที่แสดงในการตอบกลับจะขึ้นอยู่กับสิ่งที่ส่งใน response_content_type ของคำขอเปลี่ยน เช่น หากระบุ MUTABLE_RESOURCE ไว้ response จะมีเฉพาะฟิลด์ที่เปลี่ยนแปลงได้ในแคมเปญ จากนั้นคุณจะทําการเปลี่ยนแปลงต่อในออบเจ็กต์ทรัพยากรนั้นโดยไม่ต้องสร้างใหม่

ข้อผิดพลาดในการเปลี่ยน

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

การตรวจสอบออบเจ็กต์ด้วย get (เลิกใช้งานแล้ว)

นอกเหนือจากการเปลี่ยนออบเจ็กต์แล้ว บริการเฉพาะประเภททรัพยากรแต่ละประเภทยังมีเมธอด get สำหรับการดึงข้อมูลแอตทริบิวต์ทั้งหมดของทรัพยากรรายการเดียวด้วย เมธอดนี้ยอมรับคําขอ GET ที่แอตทริบิวต์เดียวคือ resource_name

เมธอด get เป็นฟังก์ชันที่ Google Ads API มอบให้เพื่อดึงข้อมูลแอตทริบิวต์ทั้งหมดของออบเจ็กต์เดียว แม้ว่าจะเป็นเครื่องมือที่ยอดเยี่ยมสําหรับการเรียนรู้ API หรือการตรวจสอบออบเจ็กต์แต่ละรายการเพื่อวัตถุประสงค์ในการแก้ไขข้อบกพร่องหรือการศึกษา แต่แอปของคุณไม่ควรใช้เมธอด get เพื่อดึงข้อมูลออบเจ็กต์สําหรับการประมวลผลหรือการรายงาน แต่ให้ใช้ GoogleAdsService แทน เนื่องจากช่วยให้คุณดึงข้อมูลเฉพาะแอตทริบิวต์ของออบเจ็กต์ รองรับการดึงข้อมูลเมตริกประสิทธิภาพ และอนุญาตให้สตรีมผ่านชุดผลลัพธ์ขนาดใหญ่ได้ หากแอปส่งคำขอ GET จำนวนมาก คุณอาจพบขีดจำกัดอัตรา