Method: projects.searchApps

מפרט את כל האפליקציות הזמינות עבור FirebaseProject שצוין.

זוהי שיטת נוחות. בדרך כלל, אינטראקציה עם אפליקציה צריכה להיעשות באמצעות השירות הספציפי לפלטפורמה, אך מקרים מסוימים של שימוש בכלי דורשים סיכום של כל האפליקציות המוכרות (כגון עבור ממשקי בורר אפליקציות).

בקשת HTTP

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

כתובת האתר משתמשת בתחביר GRPC Transcoding .

פרמטרים של נתיב

פרמטרים
parent

string

ה- FirebaseProject האב שעבורו יש לרשום אפליקציות, בפורמט:

projects/ PROJECT_IDENTIFIER

עיין בשדה name FirebaseProject לפרטים על ערכי PROJECT_IDENTIFIER .

פרמטרים של שאילתה

פרמטרים
pageToken

string

אסימון חזר משיחה קודמת ל- projects.searchApps המציין היכן בקבוצת האפליקציות לחדש את הרישום.

pageSize

integer

המספר המרבי של אפליקציות להחזיר בתגובה.

השרת עשוי להחזיר פחות מהערך הזה לפי שיקול דעתו. אם לא צוין ערך (או שצוין ערך גדול מדי), השרת יטיל מגבלה משלו.

ערך זה לא יכול להיות שלילי.

filter

string

מחרוזת שאילתה תואמת לתקן 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 יוחזרו.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף תגובה

אם זה מצליח, גוף התגובה מכיל נתונים עם המבנה הבא:

ייצוג 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

המזהה (UID) הייחודי הגלובלי המוקצה על ידי Google עבור מפתח ה-API של Firebase המשויך לאפליקציה.

שים לב שערך זה הוא ה-UID של מפתח ה-API, לא ה- keyString של מפתח ה-API. ה- keyString הוא הערך שניתן למצוא ב-Artifact של התצורה של האפליקציה ( AndroidApp | IosApp | WebApp ).

אם apiKeyId לא מוגדר בבקשות ליצירת האפליקציה ( AndroidApp | IosApp | WebApp ), Firebase משייך אוטומטית apiKeyId לאפליקציה. המפתח המשויך האוטומטי הזה עשוי להיות מפתח חוקי קיים או, אם לא קיים מפתח חוקי, מפתח חדש יסופק.

state

enum ( State )

פלט בלבד. מצב מחזור החיים של האפליקציה.

AppPlatform

פלטפורמות שאיתן ניתן לשייך אפליקציית Firebase.

תקצירים
PLATFORM_UNSPECIFIED מצב לא ידוע. זה משמש רק להבחין בין ערכים לא מוגדרים.
IOS אפליקציית Firebase משויכת ל-iOS.
ANDROID אפליקציית Firebase משויכת לאנדרואיד.
WEB אפליקציית Firebase משויכת לאינטרנט.