Method: projects.searchApps

همه برنامه های موجود برای FirebaseProject مشخص شده را فهرست می کند.

این یک روش راحت است. به طور معمول، تعامل با یک برنامه باید با استفاده از سرویس پلتفرم خاص انجام شود، اما برخی موارد استفاده از ابزار به خلاصه ای از همه برنامه های شناخته شده (مانند رابط های انتخابگر برنامه) نیاز دارند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
parent

string

FirebaseProject والد که برای فهرست کردن برنامه‌ها، در قالب:

projects/ PROJECT_IDENTIFIER

برای جزئیات بیشتر در مورد مقادیر PROJECT_IDENTIFIER به قسمت name FirebaseProject مراجعه کنید.

پارامترهای پرس و جو

مولفه های
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 تکی در نظر گرفته می شود که با شناسه فروشگاه App Apple ثبت شده در IosApp پر شده است. اگر برنامه IosApp نباشد، این قسمت خالی است.
  • teamId : این فیلد به عنوان یک فیلد string منحصر به فرد در نظر گرفته می شود که با شناسه تیم Apple ثبت شده در IosApp پر شده است. اگر برنامه IosApp نباشد، این قسمت خالی است.
showDeleted

boolean

کنترل می کند که آیا برنامه های موجود در حالت DELETED باید برگردانده شوند یا خیر.

اگر مشخص نشده باشد، فقط ACTIVE Apps برگردانده خواهند شد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی 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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

FirebaseAppInfo

خلاصه سطح بالا از یک برنامه.

نمایندگی 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 (UID) در سطح جهانی برای کلید Firebase API مرتبط با برنامه.

توجه داشته باشید که این مقدار UID کلید API است، نه keyString کلید API. keyString مقداری است که می‌توان در آرتیفکت پیکربندی برنامه ( AndroidApp | IosApp | WebApp ) یافت.

اگر apiKeyId در درخواست‌های ایجاد برنامه تنظیم نشده باشد ( AndroidApp | IosApp | WebApp )، سپس Firebase به طور خودکار یک apiKeyId را با برنامه مرتبط می‌کند. این کلید مرتبط خودکار ممکن است یک کلید معتبر موجود باشد یا اگر کلید معتبری وجود نداشته باشد، یک کلید جدید ارائه خواهد شد.

state

enum ( State )

فقط خروجی وضعیت چرخه حیات برنامه

AppPlatform

پلتفرم هایی که یک برنامه Firebase را می توان با آنها مرتبط کرد.

Enums
PLATFORM_UNSPECIFIED حالت نامعلوم این فقط برای تشخیص مقادیر تنظیم نشده استفاده می شود.
IOS برنامه Firebase با iOS مرتبط است.
ANDROID برنامه Firebase با اندروید مرتبط است.
WEB برنامه Firebase با وب مرتبط است.