ดึงข้อมูลทรัพสร PartnerLink โดยส่ง SearchPartnerLinksRequest
คุณต้องระบุช่อง parent ของคำขอ โดยตั้งค่า parent เป็นชื่อทรัพยากรของบัญชีที่เฉพาะเจาะจงโดยใช้รูปแบบต่อไปนี้
accountTypes/{account_type}/accounts/{account}
เพื่อให้มีความยืดหยุ่นในการใช้งานที่หลากหลาย SearchPartnerLinksResponse
จะมีทรัพยากร PartnerLink ทั้งหมดที่ parent ในคำขอเป็น
อย่างใดอย่างหนึ่งต่อไปนี้
- บัญชีที่ระบุโดยช่อง
owner_account - บัญชีที่ระบุโดยช่อง
partner_account
ตั้งค่าส่วนหัวของคำขอ หากคุณเข้าถึงบัญชี parent โดยใช้
ลิงก์พาร์ทเนอร์ บัญชีดูแลจัดการ Google Ads ระดับบน หรือบัญชีพาร์ทเนอร์ Display & Video 360 ระดับบน
กรองผลลัพธ์ เพื่อจำกัดการตอบกลับให้แสดงเฉพาะทรัพยากรที่มี แอตทริบิวต์ที่เฉพาะเจาะจง
เมธอด Search จะแสดงผลลัพธ์เป็นหน้าๆ หากต้องการดึงข้อมูลทรัพยากรทั้งหมดสำหรับคำขอ ให้ตรวจสอบ next_page_token และ แบ่งหน้าผลลัพธ์
ตั้งค่าส่วนหัวของคำขอ
เมธอด Search รองรับส่วนหัว login-account เพื่อกำหนดเส้นทางการเข้าถึงข้อมูลเข้าสู่ระบบของคุณไปยังบัญชี parent ในคำขอ ระบบไม่รองรับส่วนหัว linked-account สำหรับเมธอด PartnerLinkService
โปรดดูรายละเอียด และวิธีการตั้งค่าส่วนหัวสำหรับสถานการณ์การเข้าถึงต่างๆ ได้ที่ ปลายทางและส่วนหัว
กรองผลลัพธ์
ใช้ช่อง filter ของคำขอเพื่อดึงข้อมูลลิงก์พาร์ทเนอร์ที่เฉพาะเจาะจง ช่อง filter เป็นสตริงที่กำหนดชุดเงื่อนไขที่คุณต้องการใช้ รวมถึงระบุว่า API ควรผสานรวมเงื่อนไขโดยใช้ AND หรือ OR
อ่านเพิ่มเติมเกี่ยวกับตัวเลือกและไวยากรณ์การกรองได้ที่
AIP-160: การกรอง
คุณสามารถกำหนด filter โดยใช้ account_id ของบัญชีที่เป็นเจ้าของหรือบัญชีพาร์ทเนอร์ก็ได้ ดังนี้
owning_account.account_id:account_idของบัญชีที่เป็นเจ้าของpartner_account.account_id:account_idของบัญชีพาร์ทเนอร์
ตัวอย่างเช่น นี่คือ filter ที่แสดงผลลิงก์พาร์ทเนอร์ทั้งหมดที่บัญชีที่เป็นเจ้าของมีรหัสบัญชี OWNING_ACCOUNT_ID
owning_account.account_id = OWNING_ACCOUNT_ID
และนี่คืออีกตัวอย่างของ filter ซึ่งจะแสดงผลลิงก์พาร์ทเนอร์ทั้งหมดที่บัญชีที่เป็นเจ้าของมีรหัสบัญชี OWNING_ACCOUNT_ID หรือบัญชีพาร์ทเนอร์มีรหัสบัญชี PARTNER_ACCOUNT_ID
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
การแก้ไข filter ดังกล่าวให้ใช้ AND แทน OR จะจำกัดทรัพยากรที่แสดงผลให้เป็นลิงก์พาร์ทเนอร์ที่ ทั้ง บัญชีที่เป็นเจ้าของมีรหัสบัญชี OWNING_ACCOUNT_ID และ บัญชีพาร์ทเนอร์มีรหัสบัญชี PARTNER_ACCOUNT_ID
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
แบ่งหน้าผลลัพธ์
ใช้ช่อง page_size เพื่อควบคุมจำนวนผลลัพธ์ที่แสดงในคำตอบเดียว เช่น หากคุณตั้งค่า page_size เป็น 10 API จะแสดงผลลัพธ์ อย่างมาก 10 รายการต่อคำตอบ API อาจแสดงผลลัพธ์น้อยกว่า 10 รายการหากมีผลลัพธ์ที่ตรงกับคำขอน้อยกว่า 10 รายการ
page_size เริ่มต้นคือ 50 และสูงสุดคือ 1,000
หากมีผลลัพธ์มากกว่าที่จะแสดงในคำตอบเดียว คำตอบนั้นจะมี next_page_token หากต้องการดึงข้อมูลหน้าถัดไปหรือชุดผลลัพธ์ถัดไป ให้ส่งคำขอเดิมอีกครั้งโดยตั้งค่าช่อง page_token เป็นค่านี้ พารามิเตอร์อื่นๆ ทั้งหมดต้องเหมือนกับคำขอก่อนหน้า
หากช่อง next_page_token ไม่รวมอยู่ในคำตอบ แสดงว่าไม่มีผลลัพธ์เพิ่มเติม