يمكنك استرداد موارد 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 لتحديد مسار الوصول إلى بيانات الاعتماد في حساب parent في الطلب. لا يتيح عنوان linked-account استخدام طرق PartnerLinkService.
راجِع المقاصد والعناوين للاطّلاع على التفاصيل والتعليمات حول كيفية ضبط العناوين لسيناريوهات الوصول المختلفة.
فلترة النتائج
استخدِم الحقل 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 في الردّ، يشير ذلك إلى عدم توفّر أي نتائج أخرى.