يمكنك استرداد موارد PartnerLink عن طريق إرسال SearchPartnerLinksRequest.
يجب ملء حقل parent في الطلب. اضبط parent على اسم المورد الخاص بحساب معيّن، باستخدام التنسيق التالي:
accountTypes/{account_type}/accounts/{account}
لضمان المرونة في مختلف حالات الاستخدام، يحتوي SearchPartnerLinksResponse على جميع موارد PartnerLink التي يكون فيها parent في الطلب إما:
- الحساب الذي يحدّده الحقل
owner_account - الحساب الذي يحدّده الحقل
partner_account
اضبط عناوين الطلبات إذا كنت ستصل إلى حساب parent باستخدام رابط شريك أو حساب مدير رئيسي على "إعلانات Google" أو حساب شريك رئيسي على "مساحة العرض والفيديو 360".
فلترة النتائج لحصر الرد على المراجع التي تتضمّن سمات معيّنة
تعرض الطريقة Search صفحات من النتائج. لاسترداد جميع الموارد الخاصة بطلب، تحقَّق من next_page_token وتقسيم النتائج إلى صفحات.
ضبط عناوين الطلبات
تتيح طريقة Search استخدام العنوانَين login-account وlinked-account
لتحديد مسار الوصول إلى بيانات الاعتماد الخاصة بك في حساب parent
ضمن الطلب. راجِع الوجهات والعناوين للحصول على التفاصيل والتعليمات حول كيفية ضبط العناوين لسيناريوهات الوصول المختلفة.
فلترة النتائج
استخدِم الحقل filter في الطلب لاسترداد روابط شركاء معيّنة. الحقل filter هو سلسلة تحدّد مجموعة الشروط التي تريد تطبيقها، بالإضافة إلى ما إذا كان يجب أن تجمع واجهة برمجة التطبيقات بين الشروط باستخدام 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، ستعرض واجهة برمجة التطبيقات 10 نتائج كحدّ أقصى لكل ردّ. من المحتمل أن تعرض واجهة برمجة التطبيقات أقل من 10 نتائج إذا كان عدد النتائج التي تتطابق مع طلبك أقل من 10.
القيمة التلقائية page_size هي 50 والحد الأقصى هو 1000.
إذا كان هناك نتائج أكثر مما يمكن أن تتسع له رد واحد، سيتضمّن الرد next_page_token. لاسترداد الصفحة التالية أو مجموعة النتائج التالية، أرسِل الطلب نفسه مرة أخرى مع ضبط الحقل page_token على هذه القيمة. يجب أن تكون جميع المَعلمات الأخرى مماثلة للطلب السابق.
إذا لم يتم تضمين الحقل next_page_token في الاستجابة، يشير ذلك إلى عدم توفّر المزيد من النتائج.