استرداد روابط الشركاء

استرداد موارد 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 في الاستجابة، يشير ذلك إلى عدم توفّر المزيد من النتائج.