ดึงข้อมูลทรัพยากร 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 ในการตอบกลับ แสดงว่าไม่มีผลลัพธ์อีกแล้ว