همه برنامه های موجود برای FirebaseProject
مشخص شده را فهرست می کند.
این یک روش راحت است. به طور معمول، تعامل با یک برنامه باید با استفاده از سرویس پلتفرم خاص انجام شود، اما برخی موارد استفاده از ابزار به خلاصه ای از همه برنامه های شناخته شده (مانند رابط های انتخابگر برنامه) نیاز دارند.
درخواست HTTP
GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}:searchApps
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
parent | برای جزئیات بیشتر در مورد مقادیر PROJECT_IDENTIFIER به قسمت |
پارامترهای پرس و جو
مولفه های | |
---|---|
pageToken | رمز از تماس قبلی به |
pageSize | حداکثر تعداد برنامههایی که باید در پاسخ بازگردانده شوند. سرور ممکن است به صلاحدید خود کمتر از این مقدار را برگرداند. اگر مقداری مشخص نشده باشد (یا مقدار بسیار بزرگی مشخص شده باشد)، سرور محدودیت خود را اعمال می کند. این مقدار نمی تواند منفی باشد. |
filter | یک رشته جستجو سازگار با استاندارد AIP-160 Google. از هر یک از فیلدهای زیر در پرس و جو استفاده کنید: این پرس و جو از فیلدهای "مجازی" زیر نیز پشتیبانی می کند. اینها فیلدهایی هستند که در واقع بخشی از شی منبع برگشتی نیستند، اما می توان آنها را جویا شد که انگار با مقادیر خاصی از قبل پر شده اند.
|
showDeleted | کنترل می کند که آیا برنامه های موجود در حالت اگر مشخص نشده باشد، فقط |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"apps": [
{
object ( |
زمینه های | |
---|---|
apps[] | یک صفحه از نتایج تماس با |
nextPageToken | اگر لیست نتایج بیش از حد بزرگ باشد که در یک پاسخ قرار نگیرد، یک نشانه برگردانده می شود. این نشانه میتواند در تماسهای بعدی به توکن های صفحه کوتاه مدت هستند و نباید ادامه پیدا کنند. |
محدوده مجوز
به یکی از حوزه های 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
خلاصه سطح بالا از یک برنامه.
نمایندگی JSON |
---|
{ "name": string, "displayName": string, "platform": enum ( |
زمینه های | |
---|---|
name | نام منبع برنامه Firebase، در قالب: یا یا |
displayName | نام نمایشی اختصاص داده شده توسط کاربر برای برنامه Firebase. |
platform | پلت فرم برنامه Firebase. |
appId | فقط خروجی تغییرناپذیر. شناسه اختصاصی Firebase در سطح جهانی برای این شناسه باید به عنوان یک نشانه غیر شفاف در نظر گرفته شود، زیرا قالب داده مشخص نشده است. |
namespace | فقط خروجی تغییرناپذیر. شناسه پلتفرم خاص برنامه. توجه: برای بیشتر موارد استفاده، از این رشته از یک شناسه بومی برای هر پلتفرم مشتق شده است: |
apiKeyId | شناسه اختصاص داده شده توسط Google (UID) در سطح جهانی برای کلید Firebase API مرتبط با برنامه. توجه داشته باشید که این مقدار UID کلید API است، نه اگر |
state | فقط خروجی وضعیت چرخه حیات برنامه |
AppPlatform
پلتفرم هایی که یک برنامه Firebase را می توان با آنها مرتبط کرد.
Enums | |
---|---|
PLATFORM_UNSPECIFIED | حالت نامعلوم این فقط برای تشخیص مقادیر تنظیم نشده استفاده می شود. |
IOS | برنامه Firebase با iOS مرتبط است. |
ANDROID | برنامه Firebase با اندروید مرتبط است. |
WEB | برنامه Firebase با وب مرتبط است. |