Method: projects.searchApps

يسرد جميع التطبيقات المتاحة لمشروع FirebaseProject المحدد.

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

طلب HTTP

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

يستخدم عنوان URL بناء جملة gRPC Transcoding .

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

حدود
parent

string

FirebaseProject الأصل الذي سيتم إدراج التطبيقات له، بالتنسيق:

projects/ PROJECT_IDENTIFIER

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

معلمات الاستعلام

حدود
pageToken

string

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

pageSize

integer

الحد الأقصى لعدد التطبيقات التي يمكن عرضها في الاستجابة.

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

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

filter

string

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

استخدم أيًا من الحقول التالية في الاستعلام:

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

  • 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 فقط.

هيئة الطلب

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

هيئة الاستجابة

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

تمثيل جيسون
{
  "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

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

FirebaseAppInfo

ملخص رفيع المستوى للتطبيق.

تمثيل جيسون
{
  "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

المعرف الفريد عالميًا (UID) المخصص من Google لمفتاح Firebase API المرتبط بالتطبيق.

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

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

state

enum ( State )

الإخراج فقط. حالة دورة حياة التطبيق.

منصة التطبيق

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

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