Method: projects.searchApps

يسرد جميع التطبيقات المتاحة لنطاق FirebaseProject المحدَّد.

هذه طريقة ملائمة. يجب عادةً أن يتم التفاعل مع التطبيق باستخدام الخدمة الخاصة بالنظام الأساسي، إلا أنّ بعض حالات استخدام الأدوات تتطلّب ملخصًا لجميع التطبيقات المعروفة (مثل واجهات "أداة اختيار التطبيقات").

طلب HTTP

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}:searchApps

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
parent

string

رقم FirebaseProject الرئيسي المطلوب إدراج التطبيقات له بالتنسيق:

projects/PROJECT_IDENTIFIER

راجِع الحقل FirebaseProject name للحصول على تفاصيل حول قيم PROJECT_IDENTIFIER.

معامِلات طلب البحث

المَعلمات
pageToken

string

تم عرض رمز مميّز من مكالمة سابقة إلى projects.searchApps يشير إلى مكان استئناف عرض البيانات في مجموعة التطبيقات.
pageSize

integer

الحد الأقصى لعدد التطبيقات المطلوب عرضها في الرد.

قد يعرض الخادم عددًا أقل من هذه القيمة وفقًا لتقديره الخاص. إذا لم يتم تحديد أي قيمة (أو تم تحديد قيمة أكبر مما يجب)، سيفرض الخادم حده الخاص.

لا يمكن أن تكون هذه القيمة سالبة.
filter

string

سلسلة طلب بحث متوافقة مع معيار AIP-160 في Google.

يمكنك استخدام أي من الحقول التالية في طلب بحث:

يدعم هذا الاستعلام أيضًا "الافتراضي" التالي الحقول. وهذه الحقول ليست في الواقع جزءًا من كائن المورد المعروض، ولكن يمكن الاستعلام عنها كما لو تمت تعبئتها مسبقًا بقيم معيّنة.

  • sha1_hash أو sha1Hashes: يُعتبر هذا الحقل حقل string مكرّر، وتتم تعبئته بقائمة بجميع الملفات المرجعية لشهادات SHA-1 المسجّلة في AndroidApp. تكون هذه القائمة فارغة إذا لم يكن التطبيق AndroidApp.
  • sha256_hash أو sha256Hashes: يُعتبر هذا الحقل حقل string مكرّر، وتتم تعبئته بقائمة بجميع الملفات المرجعية لشهادات SHA-256 المسجّلة في AndroidApp. تكون هذه القائمة فارغة إذا لم يكن التطبيق AndroidApp.
  • appStoreId: يُعتبر هذا الحقل حقل string فرديًا، وتتم تعبئته برقم تعريف Apple App Store المسجَّل باستخدام IosApp. يكون هذا الحقل فارغًا إذا لم يكن التطبيق IosApp.
  • teamId: يُعتبر هذا الحقل حقل string فرديًا، وتتم تعبئته برقم تعريف فريق Apple المسجّل باستخدام IosApp. يكون هذا الحقل فارغًا إذا لم يكن التطبيق IosApp.
showDeleted

boolean

تتحكّم هذه السياسة في ما إذا كان يجب عرض التطبيقات في الحالة DELETED.

وفي حال عدم تحديده، سيتم عرض ACTIVE تطبيق فقط.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
الحقول
apps[]

object (FirebaseAppInfo)

صفحة واحدة من النتائج من مكالمة إلى projects.searchApps.
nextPageToken

string

إذا كانت قائمة النتائج كبيرة جدًا بحيث لا تتناسب مع استجابة واحدة، فسيتم عرض رمز مميز.

يمكن استخدام هذا الرمز في استدعاءات لاحقة إلى projects.searchApps للعثور على المجموعة التالية من التطبيقات.

تكون الرموز المميّزة للصفحة قصيرة الأجل ويجب عدم الاحتفاظ بها.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة حول المصادقة.

معلومات AppInfo

يشير ذلك المصطلح إلى ملخّص عام لأحد التطبيقات.

تمثيل JSON 
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
الحقول
name

string

اسم مورد تطبيق Firebase بالتنسيق:

projects/PROJECT_ID/iosApps/APP_ID

أو

projects/PROJECT_ID/androidApps/APP_ID

أو

projects/PROJECT_ID/webApps/APP_ID
displayName

string

الاسم المعروض الذي خصّصه المستخدم لتطبيق Firebase
platform

enum (AppPlatform)

النظام الأساسي لتطبيق Firebase
appId

string

النتائج فقط. غير قابل للتغيير. المعرّف الفريد العالمي الذي يعيّنه Firebase لـ WebApp

يجب التعامل مع هذا المعرّف كرمز مميّز مبهم، لأنّ تنسيق البيانات غير محدّد.
namespace

string

النتائج فقط. غير قابل للتغيير. تمثّل هذه السمة معرِّف التطبيق الخاص بالنظام الأساسي.

ملاحظة: في معظم حالات الاستخدام، يمكنك استخدام appId، وهو المعرّف الأساسي والفريد عالميًا للإشارة إلى أحد التطبيقات.

هذه السلسلة مشتقة من معرّف أصلي لكل نظام أساسي: packageName للسمة AndroidApp، وbundleId للسمة IosApp، وwebId لـ WebApp. ويجب التعامل مع محتواه على أنّه مبهم، لأنّ تنسيق المعرّف الأصلي قد يتغيّر مع تطوّر الأنظمة الأساسية. هذه السلسلة فريدة فقط داخل FirebaseProject والتطبيقات المرتبطة به.
apiKeyId

string

المعرّف الفريد العالمي الذي تحدّده Google لمفتاح واجهة برمجة تطبيقات Firebase المرتبط بالتطبيق

هذه القيمة هي المعرّف الفريد لمفتاح واجهة برمجة التطبيقات، وليست keyString لمفتاح واجهة برمجة التطبيقات. القيمة keyString هي القيمة التي يمكن العثور عليها في عناصر إعدادات التطبيق (AndroidApp | IosApp | WebApp).

إذا لم يتم ضبط السياسة apiKeyId في طلبات إنشاء التطبيق (AndroidApp | IosApp | WebApp)، يربط Firebase تلقائيًا السمة apiKeyId بالتطبيق. قد يكون هذا المفتاح المرتبط تلقائيًا مفتاحًا صالحًا حاليًا. وفي حال عدم توفُّر مفتاح صالح، ستتم توفير مفتاح جديد.
state

enum (State)

النتائج فقط. حالة دورة حياة التطبيق

منصة AppPlatform

الأنظمة الأساسية التي يمكن ربط تطبيق Firebase بها

تعدادات
PLATFORM_UNSPECIFIED حالة غير معروفة. تُستخدم هذه الطريقة فقط للتفريق بين القيم التي لم يتم ضبطها.
IOS تطبيق Firebase مرتبط بنظام التشغيل iOS.
ANDROID تطبيق Firebase مرتبط بنظام Android.
WEB تطبيق Firebase مرتبط بالويب.