Truy xuất tài nguyên PartnerLink bằng cách gửi SearchPartnerLinksRequest.
Bạn bắt buộc phải điền vào trường parent của yêu cầu. Đặt parent thành tên tài nguyên của một tài khoản cụ thể, theo định dạng:
accountTypes/{account_type}/accounts/{account}
Để linh hoạt trong nhiều trường hợp sử dụng, SearchPartnerLinksResponse chứa tất cả các tài nguyên PartnerLink mà parent trong yêu cầu là một trong hai trường hợp sau:
- Tài khoản được xác định bằng trường
owner_account - Tài khoản được xác định bằng trường
partner_account
Đặt tiêu đề yêu cầu nếu bạn đang truy cập vào tài khoản parent bằng đường liên kết đối tác, tài khoản người quản lý Google Ads mẹ hoặc tài khoản đối tác Display & Video 360 mẹ.
Lọc kết quả để giới hạn phản hồi đối với các tài nguyên có thuộc tính cụ thể.
Phương thức Search trả về các trang kết quả. Để truy xuất tất cả tài nguyên cho một yêu cầu, hãy kiểm tra next_page_token và paginate results (phân trang kết quả).
Đặt tiêu đề của yêu cầu
Phương thức Search hỗ trợ các tiêu đề login-account và linked-account để xác định đường dẫn truy cập của thông tin đăng nhập vào tài khoản parent trong yêu cầu. Hãy tham khảo phần Đích đến và tiêu đề để biết thông tin chi tiết và hướng dẫn về cách đặt tiêu đề cho các trường hợp truy cập khác nhau.
Lọc kết quả
Sử dụng trường filter của yêu cầu để truy xuất các đường liên kết cụ thể của đối tác. Trường filter là một chuỗi xác định tập hợp các điều kiện mà bạn muốn áp dụng, cùng với việc API có nên kết hợp các điều kiện bằng cách sử dụng AND hay OR hay không.
Đọc thêm về các lựa chọn và cú pháp lọc trong AIP-160: Lọc.
Bạn có thể xác định filter bằng account_id của tài khoản sở hữu hoặc tài khoản đối tác:
owning_account.account_id:account_idcủa tài khoản sở hữu.partner_account.account_id:account_idcủa tài khoản đối tác.
Ví dụ: đây là một filter trả về tất cả các mối liên kết với đối tác mà tài khoản sở hữu có mã tài khoản là OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Sau đây là một ví dụ khác về filter. Thao tác này sẽ trả về tất cả các mối liên kết với đối tác mà tài khoản sở hữu có mã tài khoản là OWNING_ACCOUNT_ID hoặc tài khoản đối tác có mã tài khoản là PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
Việc sửa đổi filter để sử dụng AND thay vì OR sẽ giới hạn các tài nguyên được trả về cho những đường liên kết đối tác mà cả tài khoản sở hữu đều có mã tài khoản OWNING_ACCOUNT_ID và tài khoản đối tác đều có mã tài khoản PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Phân trang kết quả
Sử dụng trường page_size để kiểm soát số lượng kết quả được trả về trong một phản hồi duy nhất. Ví dụ: nếu bạn đặt page_size thành 10, thì API sẽ trả về tối đa 10 kết quả cho mỗi phản hồi. Có thể API sẽ trả về ít hơn 10 kết quả nếu có ít hơn 10 kết quả phù hợp với yêu cầu của bạn.
page_size mặc định là 50 và tối đa là 1.000.
Nếu có nhiều kết quả hơn mức có thể chứa trong một phản hồi, thì phản hồi sẽ bao gồm một next_page_token. Để truy xuất trang tiếp theo hoặc tập hợp kết quả, hãy gửi lại yêu cầu tương tự với trường page_token được đặt thành giá trị này. Tất cả các thông số khác phải giống với yêu cầu trước đó.
Nếu trường next_page_token không có trong phản hồi, điều này có nghĩa là không còn kết quả nào khác.