با ارسال SearchPartnerLinksRequest، PartnerLink منبع را بازیابی کنید.
فیلد parent درخواست الزامی است. parent را روی نام منبع حساب خاصی تنظیم کنید، بااستفاده از این قالب:
accountTypes/{account_type}/accounts/{account}
برای انعطاف‌پذیری در موارد استفاده مختلف، SearchPartnerLinksResponse
شامل همه منابع PartnerLink است که parent در درخواست
یا این است:
- حساب شناسایی‌شده توسط فیلد
owner_account - حساب شناسایی‌شده توسط فیلد
partner_account
اگر بااستفاده از پیوند شریک، حساب مدیر Google Ads ولی، یا حساب شریک «تبلیغات تصویری و ویدیویی ۳۶۰» ولی به حساب parent دسترسی پیدا می‌کنید، سرصفحه‌های درخواست را تنظیم کنید.
برای محدود کردن پاسخ به منابع دارای ویژگی‌های خاص، نتایج را فیلتر کنید.
روش Search صفحه‌های نتایج را برمی‌گرداند. برای بازیابی همه منابع برای یک درخواست، next_page_token را بررسی کنید و نتایج را صفحه‌بندی کنید.
تنظیم سرایندهای درخواست
روش Search از سرایند login-account برای تعریف مسیر دسترسی اطلاعات اعتباری شما به حساب parent در درخواست پشتیبانی می‌کند. سرصفحه linked-account برای روش‌های PartnerLinkService
پشتیبانی نمی‌شود.
برای جزئیات و دستورالعمل‌های مربوط به نحوه تنظیم سرایندها برای سناریوهای دسترسی مختلف، به مقصدها و سرایندها مراجعه کنید.
فیلتر کردن نتایج
از فیلد filter درخواست برای بازیابی پیوندهای شریک خاص استفاده کنید. فیلد
filter رشته‌ای است که مجموعه شرایطی را که می‌خواهید اعمال کنید تعریف می‌کند،
به‌همراه اینکه آیا میانای برنامه‌سازی کاربردی باید شرایط را بااستفاده از AND یا OR ترکیب کند یا نه.
درباره گزینه‌های فیلتر کردن و دستورگان در
AIP-160: Filtering (فیلتر کردن) بیشتر بخوانید.
می‌توانید 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 کمتر از ۱۰ نتیجه برگرداند.
مقدار پیش‌فرض page_size برابر با ۵۰ و حداکثر مقدار برابر با ۱۰۰۰ است.
اگر تعداد نتایج بیشتر از تعداد قابل‌نمایش در یک پاسخ باشد، پاسخ شامل next_page_token خواهد بود. برای بازیابی صفحه بعدی یا مجموعه نتایج،
همین درخواست را دوباره با فیلد page_token تنظیم‌شده روی این مقدار ارسال کنید. همه پارامترهای دیگر باید با درخواست قبلی یکسان باشند.
اگر فیلد next_page_token در پاسخ وجود نداشته باشد، این نشان می‌دهد که نتیجه دیگری وجود ندارد.