Method: projects.searchApps

Liệt kê mọi ứng dụng có sẵn cho FirebaseProject đã chỉ định.

Đây là một phương thức thuận tiện. Thông thường, bạn phải tương tác với Ứng dụng thông qua dịch vụ dành riêng cho nền tảng. Tuy nhiên, một số trường hợp sử dụng công cụ yêu cầu bản tóm tắt tất cả Ứng dụng đã biết (chẳng hạn như đối với giao diện Bộ chọn ứng dụng).

yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
parent

string

FirebaseProject mẹ cần liệt kê Ứng dụng, ở định dạng:

projects/PROJECT_IDENTIFIER

Tham khảo trường FirebaseProject name để biết thông tin chi tiết về các giá trị PROJECT_IDENTIFIER.

Tham số truy vấn

Thông số
pageToken

string

Mã thông báo được trả về từ lệnh gọi trước đó tới projects.searchApps cho biết vị trí cần tiếp tục liệt kê trong tập hợp các Ứng dụng.

pageSize

integer

Số lượng ứng dụng tối đa cần trả về trong phản hồi.

Máy chủ có thể trả về ít hơn giá trị này theo quyết định riêng của mình. Nếu bạn không chỉ định giá trị nào (hoặc chỉ định giá trị quá lớn), thì máy chủ sẽ áp dụng giới hạn riêng.

Giá trị này không được là số âm.

filter

string

Chuỗi truy vấn tương thích với tiêu chuẩn AIP-160 của Google.

Sử dụng bất kỳ trường nào sau đây trong truy vấn:

Truy vấn này cũng hỗ trợ lệnh "ảo" sau mới. Đây là những trường không thực sự là một phần của đối tượng tài nguyên được trả về, nhưng có thể truy vấn được như thể chúng được điền sẵn các giá trị cụ thể.

  • sha1_hash hoặc sha1Hashes: Trường này được coi là trường string lặp lại, được điền sẵn danh sách tất cả vân tay số cho chứng chỉ SHA-1 đã đăng ký với AndroidApp. Danh sách này sẽ trống nếu Ứng dụng không phải là AndroidApp.
  • sha256_hash hoặc sha256Hashes: Trường này được coi là trường string lặp lại, được điền sẵn danh sách tất cả vân tay số cho chứng chỉ SHA-256 đã đăng ký với AndroidApp. Danh sách này sẽ trống nếu Ứng dụng không phải là AndroidApp.
  • appStoreId: Trường này được coi là một trường string số ít, được điền sẵn Mã App Store của Apple đã đăng ký với IosApp. Trường này sẽ trống nếu Ứng dụng không phải là IosApp.
  • teamId: Trường này được coi là một trường string số ít, được điền bằng mã nhóm của Apple đã đăng ký với IosApp. Trường này sẽ trống nếu Ứng dụng không phải là IosApp.
showDeleted

boolean

Kiểm soát việc có trả về Ứng dụng ở trạng thái DELETED hay không.

Nếu không được chỉ định, hệ thống sẽ chỉ trả về Ứng dụng ACTIVE.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Trường
apps[]

object (FirebaseAppInfo)

Một trang kết quả từ cuộc gọi đến projects.searchApps.

nextPageToken

string

Nếu danh sách kết quả quá lớn nên không thể chứa hết trong một phản hồi, thì hệ thống sẽ trả về một mã thông báo.

Bạn có thể dùng mã thông báo này trong các lệnh gọi tiếp theo tới projects.searchApps để tìm nhóm Ứng dụng tiếp theo.

Mã thông báo trang chỉ tồn tại trong thời gian ngắn và không nên duy trì.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về việc xác thực.

Thông tin ứng dụng Firebase

Tóm tắt cấp cao về một Ứng dụng.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Trường
name

string

Tên tài nguyên của Ứng dụng Firebase, ở định dạng:

projects/PROJECT_ID/iosApps/APP_ID

hoặc

projects/PROJECT_ID/androidApps/APP_ID

hoặc

projects/PROJECT_ID/webApps/APP_ID

displayName

string

Tên hiển thị do người dùng chỉ định của Ứng dụng Firebase.

platform

enum (AppPlatform)

Nền tảng của Ứng dụng Firebase.

appId

string

Chỉ có đầu ra. Bất biến. Giá trị nhận dạng duy nhất trên toàn cầu, do Firebase chỉ định cho WebApp.

Giá trị nhận dạng này phải được xem là mã thông báo mờ vì định dạng dữ liệu không được chỉ định.

namespace

string

Chỉ có đầu ra. Bất biến. Giá trị nhận dạng theo nền tảng của Ứng dụng.

Lưu ý: Đối với hầu hết các trường hợp sử dụng, hãy sử dụng appId. Đây là giá trị nhận dạng chuẩn duy nhất trên toàn hệ thống để tham chiếu đến một Ứng dụng.

Chuỗi này được lấy từ giá trị nhận dạng gốc cho từng nền tảng: packageName cho AndroidApp, bundleId cho IosAppwebId cho WebApp. Nội dung của tài liệu này phải được coi là không rõ ràng vì định dạng giá trị nhận dạng gốc có thể thay đổi khi các nền tảng phát triển. Chuỗi này chỉ là duy nhất trong FirebaseProject và các Ứng dụng liên kết với chuỗi này.

apiKeyId

string

Giá trị nhận dạng duy nhất trên toàn cầu, do Google chỉ định (UID) cho khoá API Firebase được liên kết với Ứng dụng.

Xin lưu ý rằng giá trị này là UID của khoá API, không phải keyString của khoá API. keyString là giá trị có thể tìm thấy trong cấu phần phần mềm cấu hình của Ứng dụng (AndroidApp | IosApp | WebApp).

Nếu bạn không đặt apiKeyId trong yêu cầu tạo Ứng dụng (AndroidApp | IosApp | WebApp), thì Firebase sẽ tự động liên kết apiKeyId với Ứng dụng. Khoá tự động liên kết này có thể là khoá hợp lệ hiện có hoặc nếu không có khoá hợp lệ, thì một khoá mới sẽ được cấp phép.

state

enum (State)

Chỉ có đầu ra. Trạng thái vòng đời của Ứng dụng.

Nền tảng ứng dụng

Nền tảng có thể liên kết với ứng dụng Firebase.

Enum
PLATFORM_UNSPECIFIED Trạng thái không xác định. Giá trị này chỉ dùng để phân biệt các giá trị chưa đặt.
IOS Ứng dụng Firebase được liên kết với iOS.
ANDROID Ứng dụng Firebase được liên kết với Android.
WEB Ứng dụng Firebase được liên kết với web.