Method: projects.searchApps

Mencantumkan semua Aplikasi yang tersedia untuk FirebaseProject yang ditentukan.

Ini adalah metode yang nyaman. Biasanya, interaksi dengan Aplikasi harus dilakukan menggunakan layanan khusus platform, namun beberapa kasus penggunaan alat memerlukan ringkasan semua Aplikasi yang diketahui (seperti untuk antarmuka pemilih Aplikasi).

permintaan HTTP

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

URL menggunakan sintaks Transcoding gRPC .

Parameter jalur

Parameter
parent

string

FirebaseProject induk yang akan mencantumkan Aplikasi, dalam format:

projects/ PROJECT_IDENTIFIER

Lihat kolom FirebaseProject name untuk mengetahui detail tentang nilai PROJECT_IDENTIFIER .

Parameter kueri

Parameter
pageToken

string

Token dikembalikan dari panggilan sebelumnya ke projects.searchApps yang menunjukkan di mana dalam kumpulan Aplikasi untuk melanjutkan daftar.

pageSize

integer

Jumlah maksimum Aplikasi yang akan ditampilkan sebagai respons.

Server dapat mengembalikan lebih sedikit dari nilai ini sesuai kebijakannya. Jika tidak ada nilai yang ditentukan (atau nilai yang ditentukan terlalu besar), maka server akan menerapkan batasannya sendiri.

Nilai ini tidak boleh negatif.

filter

string

String kueri yang kompatibel dengan standar AIP-160 Google .

Gunakan salah satu bidang berikut dalam kueri:

Kueri ini juga mendukung bidang "virtual" berikut. Ini adalah bidang yang sebenarnya bukan bagian dari objek sumber daya yang dikembalikan, namun dapat ditanyakan seolah-olah bidang tersebut sudah diisi sebelumnya dengan nilai tertentu.

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

boolean

Mengontrol apakah Aplikasi dalam status DELETED harus dikembalikan.

Jika tidak ditentukan, hanya Aplikasi ACTIVE yang akan dikembalikan.

Permintaan tubuh

Badan permintaan harus kosong.

Badan respons

Jika berhasil, isi respons berisi data dengan struktur berikut:

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

object ( FirebaseAppInfo )

Satu halaman hasil dari panggilan ke projects.searchApps .

nextPageToken

string

Jika daftar hasil terlalu besar untuk ditampung dalam satu respons, maka token akan dikembalikan.

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

Token halaman berumur pendek dan tidak boleh disimpan.

Lingkup 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 informasi lebih lanjut, lihat Ikhtisar Otentikasi .

FirebaseAppInfo

Ringkasan tingkat tinggi dari suatu Aplikasi.

Representasi JSON
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Bidang
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 Firebase yang ditetapkan pengguna.

platform

enum ( AppPlatform )

Platform Aplikasi Firebase.

appId

string

Hanya keluaran. Kekal. Pengenal unik global yang ditetapkan oleh Firebase untuk WebApp .

Pengidentifikasi ini harus diperlakukan sebagai token buram, karena format data tidak ditentukan.

namespace

string

Hanya keluaran. Kekal. Pengidentifikasi khusus platform dari Aplikasi.

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

String ini berasal dari pengenal asli untuk setiap platform: packageName untuk AndroidApp , bundleId untuk IosApp , dan webId untuk WebApp . Isinya harus dianggap buram, karena format pengenal asli dapat berubah seiring berkembangnya platform. String ini hanya unik dalam FirebaseProject dan Aplikasi terkaitnya.

apiKeyId

string

Pengenal (UID) unik global yang ditetapkan Google untuk kunci API Firebase 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 disetel dalam permintaan pembuatan Aplikasi ( AndroidApp | IosApp | WebApp ), maka Firebase secara otomatis mengaitkan apiKeyId dengan Aplikasi. Kunci yang dikaitkan secara otomatis ini mungkin merupakan kunci valid yang sudah ada atau, jika tidak ada kunci valid, kunci baru akan disediakan.

state

enum ( State )

Hanya keluaran. Status siklus hidup Aplikasi.

Platform Aplikasi

Platform yang dapat dikaitkan dengan Aplikasi Firebase.

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