ดึงข้อมูลลิงก์พาร์ทเนอร์

เรียกข้อมูลทรัพยากร 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 และ linked-account เพื่อกำหนดเส้นทางการเข้าถึงข้อมูลเข้าสู่ระบบไปยังบัญชี parent ใน คำขอ โปรดดูรายละเอียดและวิธีการตั้งค่าส่วนหัวสำหรับสถานการณ์การเข้าถึงต่างๆ ในปลายทางและส่วนหัว

ผลลัพธ์การกรอง

ใช้ฟิลด์ 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ในคำตอบ แสดงว่าไม่มีผลการค้นหาเพิ่มเติม