Method: projects.searchApps

Mencantumkan semua Aplikasi yang tersedia untuk FirebaseProject yang ditentukan.

Ini adalah metode praktis. Biasanya, interaksi dengan Aplikasi harus dilakukan menggunakan layanan platform tertentu, tetapi beberapa kasus penggunaan fitur memerlukan ringkasan semua Aplikasi yang dikenal (seperti untuk antarmuka pemilih Aplikasi).

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

FirebaseProject induk untuk mencantumkan Aplikasi, dalam format:

projects/PROJECT_IDENTIFIER

Lihat kolom FirebaseProject name untuk mengetahui detail tentang nilai PROJECT_IDENTIFIER.

Parameter kueri

Parameter
pageToken

string

Token yang ditampilkan dari panggilan sebelumnya ke projects.searchApps yang menunjukkan lokasi di kumpulan Aplikasi untuk melanjutkan listingan.
pageSize

integer

Jumlah maksimum Aplikasi untuk ditampilkan dalam respons.

Server dapat menampilkan lebih sedikit dari ini atas pertimbangannya sendiri. Jika tidak ada nilai yang ditentukan (atau nilai yang ditentukan terlalu besar), server akan menerapkan batasnya sendiri.

Nilai ini tidak boleh negatif.
filter

string

String kueri yang kompatibel dengan standar AIP-160 Google.

Gunakan salah satu kolom berikut dalam kueri:

Kueri ini juga mendukung jenis "virtual" berikut kolom. Kolom ini sebenarnya bukan bagian dari objek resource yang ditampilkan, tetapi dapat dikueri seolah-olah telah diisi otomatis dengan nilai tertentu.

  • sha1_hash atau sha1Hashes: Kolom ini dianggap sebagai kolom string yang berulang, yang berisi daftar semua sidik jari sertifikat SHA-1 yang terdaftar dengan AndroidApp. Daftar ini kosong jika Aplikasi bukan AndroidApp.
  • sha256_hash atau sha256Hashes: Kolom ini dianggap sebagai kolom string yang berulang, yang berisi daftar semua sidik jari sertifikat SHA-256 yang terdaftar dengan AndroidApp. Daftar ini kosong jika Aplikasi bukan AndroidApp.
  • appStoreId: Kolom ini dianggap sebagai kolom string tunggal yang diisi dengan ID Apple App Store yang terdaftar dengan IosApp. Kolom ini kosong jika Aplikasi bukan IosApp.
  • teamId: Kolom ini dianggap sebagai kolom string tunggal yang diisi dengan ID tim Apple yang terdaftar dengan IosApp. Kolom ini kosong jika Aplikasi bukan IosApp.
showDeleted

boolean

Mengontrol apakah Aplikasi dalam status DELETED harus ditampilkan.

Jika tidak ditentukan, hanya ACTIVE Aplikasi yang akan ditampilkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Kolom
apps[]

object (FirebaseAppInfo)

Satu halaman hasil dari panggilan ke projects.searchApps.
nextPageToken

string

Jika daftar hasil terlalu besar untuk dimasukkan dalam satu respons, token akan ditampilkan.

Token ini dapat digunakan dalam panggilan berikutnya ke projects.searchApps untuk menemukan grup Aplikasi berikutnya.

Token halaman berumur pendek dan tidak boleh dipertahankan.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

FirebaseAppInfo

Ringkasan tingkat tinggi dari Aplikasi.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Kolom
name

string

Nama resource Aplikasi Firebase, dalam format:

projects/PROJECT_ID/iosApps/APP_ID

atau

projects/PROJECT_ID/androidApps/APP_ID

atau

projects/PROJECT_ID/webApps/APP_ID
displayName

string

Nama tampilan aplikasi yang ditetapkan oleh pengguna.
platform

enum (AppPlatform)

Platform Aplikasi Firebase.
appId

string

Hanya output. Tidak dapat diubah. ID unik global yang ditetapkan Firebase untuk WebApp.

ID ini harus diperlakukan sebagai token buram karena format data tidak ditentukan.
namespace

string

Hanya output. Tidak dapat diubah. ID khusus platform untuk Aplikasi.

Catatan: Untuk sebagian besar kasus penggunaan, gunakan appId, yang merupakan ID unik global yang kanonis untuk mereferensikan Aplikasi.

String ini berasal dari ID native untuk setiap platform: packageName untuk AndroidApp, bundleId untuk IosApp, dan webId untuk WebApp. Kontennya harus diperlakukan sebagai buram, karena format ID native dapat berubah saat platform berkembang. String ini hanya unik dalam FirebaseProject dan Aplikasi yang terkait.
apiKeyId

string

ID (UID) unik global yang ditetapkan Google untuk kunci Firebase API yang terkait dengan Aplikasi.

Perlu diketahui bahwa nilai ini adalah UID kunci API, bukan keyString kunci API. keyString adalah nilai yang dapat ditemukan di artefak konfigurasi Aplikasi (AndroidApp | IosApp | WebApp).

Jika apiKeyId tidak ditetapkan dalam permintaan untuk membuat Aplikasi (AndroidApp | IosApp | WebApp), Firebase akan otomatis mengaitkan apiKeyId dengan Aplikasi. Kunci yang terkait otomatis ini mungkin merupakan kunci valid yang sudah ada atau, jika tidak ada kunci yang valid, kunci baru akan disediakan.
state

enum (State)

Hanya output. Status siklus proses Aplikasi.

AppPlatform

Platform dengan Aplikasi Firebase dapat dikaitkan.

Enum
PLATFORM_UNSPECIFIED Status tidak diketahui. Ini hanya digunakan untuk membedakan nilai yang tidak disetel.
IOS Aplikasi Firebase terkait dengan iOS.
ANDROID Aplikasi Firebase terkait dengan Android.
WEB Aplikasi Firebase terkait dengan web.