با ارسال SearchPartnerLinksRequest، منابع PartnerLink را بازیابی کنید.
فیلد parent درخواست الزامی است. parent را روی نام منبع حساب خاصی تنظیم کنید، بااستفاده از قالب:
accountTypes/{account_type}/accounts/{account}
برای انعطاف‌پذیری در موارد استفاده مختلف، SearchPartnerLinksResponse
شامل همه منابع PartnerLink است که در آن parent در درخواست
یکی از موارد زیر است:
- حساب شناسایی‌شده با فیلد
owner_account - حساب شناسایی‌شده با فیلد
partner_account
اگر بااستفاده از پیوند شریک، حساب مدیر Google Ads اصلی، یا حساب شریک Display & Video 360 اصلی به حساب parent دسترسی پیدا می‌کنید، سرایندهای درخواست را تنظیم کنید.
نتایج را فیلتر کنید تا پاسخ را به منابعی با ویژگی‌های خاص محدود کنید.
روش Search صفحه‌های نتایج را برمی‌گرداند. برای بازیابی همه منابع برای یک
درخواست، next_page_token را بررسی کنید و نتایج را صفحه‌بندی کنید.
تنظیم سرصفحه‌های درخواست
روش Search از سرصفحه login-account پشتیبانی می‌کند تا مسیر دسترسی اطلاعات اعتباری شما به حساب parent را در درخواست تعریف کند. از سرایند linked-account برای روش‌های PartnerLinkService پشتیبانی نمی‌شود.
برای جزئیات و دستورالعمل‌های مربوط به نحوه تنظیم سرایندها برای سناریوهای دسترسی مختلف، به مقصدها و سرایندها مراجعه کنید.
فیلتر کردن نتایج
از فیلد filter درخواست برای بازیابی پیوندهای شریک خاص استفاده کنید. فیلد
filter رشته‌ای است که مجموعه شرایطی را که می‌خواهید اعمال شود،
به‌همراه اینکه آیا API باید شرایط را بااستفاده از 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
Modifying that filter to use AND instead of OR limits the returned
resources to the partner links where both the owning account has account ID
OWNING_ACCOUNT_ID and the partner account has 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 حداکثر ۱۰ نتیجه در هر پاسخ برمی‌گرداند. اگر تعداد نتایج منطبق با درخواست شما کمتر از ۱۰ باشد، ممکن است API کمتر از ۱۰ نتیجه برگرداند.
page_size پیش‌فرض ۵۰ و حداکثر ۱۰۰۰ است.
اگر تعداد نتایج بیشتر از آن باشد که در یک پاسخ جا شود، پاسخ حاوی next_page_token خواهد بود. برای بازیابی صفحه بعدی یا مجموعه نتایج،
همان درخواست را دوباره با فیلد page_token تنظیم‌شده روی این مقدار ارسال کنید. همه پارامترهای دیگر باید با درخواست قبلی یکسان باشد.
اگر فیلد next_page_token در پاسخ گنجانده نشده باشد، نشان‌دهنده این است که نتیجه دیگری وجود ندارد.