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

ตามที่ได้กล่าวไว้ในคู่มือโครงสร้าง 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 คุณจึงใช้การดำเนินการเดียวเพื่อแก้ไขออบเจ็กต์หลายรายการไม่ได้ ตัวอย่างเช่น หากต้องการสร้างแคมเปญหนึ่งและนำอีกแคมเปญหนึ่งออก ให้เพิ่มอินสแตนซ์ของ CampaignOperation 2 อินสแตนซ์ในคำขอ โดยรายการหนึ่งมีชุด create และอีกแคมเปญหนึ่งมีชุด remove

การปฏิบัติการแบบกลุ่ม

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

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

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

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

เปลี่ยนแปลงข้อผิดพลาด

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

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

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

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