بازیابی لینک‌های همکار

با ارسال یک SearchPartnerLinksRequest منابع PartnerLink را بازیابی کنید.

فیلد parent درخواست الزامی است. parent را با استفاده از فرمت زیر، روی نام منبع یک حساب کاربری خاص تنظیم کنید:

accountTypes/{account_type}/accounts/{account}

برای انعطاف‌پذیری در موارد استفاده مختلف، SearchPartnerLinksResponse شامل تمام منابع PartnerLink است که در آن‌ها parent در درخواست یکی از موارد زیر است:

• حساب کاربری شناسایی شده توسط فیلد owner_account
• حساب کاربری شناسایی شده توسط فیلد partner_account

اگر با استفاده از لینک شریک، حساب کاربری مدیر تبلیغات گوگل parent یا حساب کاربری شریک Display & Video 360 والد به حساب کاربری والد دسترسی پیدا می‌کنید، هدرهای درخواست را تنظیم کنید .

نتایج را فیلتر کنید تا پاسخ به منابعی با ویژگی‌های خاص محدود شود.

متد Search صفحات نتایج را برمی‌گرداند. برای بازیابی تمام منابع برای یک درخواست، next_page_token و paginate results را بررسی کنید.

تنظیم هدرهای درخواست

متد Search از هدرهای login-account و linked-account برای تعریف مسیر دسترسی اعتبارنامه‌های شما به حساب parent در درخواست پشتیبانی می‌کند. برای جزئیات و دستورالعمل‌های مربوط به نحوه تنظیم هدرها برای سناریوهای مختلف دسترسی، به Destinations و headers مراجعه کنید.

فیلتر کردن نتایج

از فیلد 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

تغییر آن 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 حداکثر ۱۰ نتیجه را برای هر پاسخ برمی‌گرداند. اگر کمتر از ۱۰ نتیجه مطابق با درخواست شما وجود داشته باشد، ممکن است API کمتر از ۱۰ نتیجه برگرداند.

page_size به طور پیش‌فرض ۵۰ و حداکثر ۱۰۰۰ است.

اگر تعداد نتایج بیشتر از آن باشد که در یک پاسخ جا شود، پاسخ شامل یک next_page_token خواهد بود. برای بازیابی صفحه بعدی یا مجموعه نتایج، همان درخواست را دوباره با فیلد page_token که روی این مقدار تنظیم شده است، ارسال کنید. سایر پارامترها باید مشابه درخواست قبلی باشند.

اگر فیلد next_page_token در پاسخ گنجانده نشده باشد، نشان می‌دهد که هیچ نتیجه‌ی دیگری وجود ندارد.