Method: projects.searchApps

지정된 FirebaseProject 에 사용 가능한 모든 앱을 나열합니다.

이는 편리한 방법입니다. 일반적으로 앱과의 상호 작용은 플랫폼별 서비스를 사용하여 수행되어야 하지만 일부 도구 사용 사례에는 알려진 모든 앱(예: 앱 선택기 인터페이스)에 대한 요약이 필요합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
parent

string

앱을 나열할 상위 FirebaseProject . 형식은 다음과 같습니다.

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER 값에 대한 자세한 내용은 FirebaseProject name 필드를 참조하세요.

쿼리 매개변수

매개변수
pageToken

string

projects.searchApps 에 대한 이전 호출에서 반환된 토큰은 앱 집합에서 목록을 다시 시작할 위치를 나타냅니다.

pageSize

integer

응답으로 반환할 최대 앱 수입니다.

서버는 재량에 따라 이 값보다 적은 값을 반환할 수 있습니다. 값이 지정되지 않은 경우(또는 너무 큰 값이 지정된 경우) 서버는 자체 제한을 적용합니다.

이 값은 음수일 수 없습니다.

filter

string

Google의 AIP-160 표준 과 호환되는 쿼리 문자열입니다.

쿼리에서 다음 필드 중 하나를 사용하십시오.

이 쿼리는 다음 "가상" 필드도 지원합니다. 이는 실제로 반환된 리소스 개체의 일부가 아니지만 특정 값으로 미리 채워진 것처럼 쿼리할 수 있는 필드입니다.

  • sha1_hash 또는 sha1Hashes : 이 필드는 반복되는 string 필드로 간주되며 AndroidApp 에 등록된 모든 SHA-1 인증서 지문 목록으로 채워집니다. 앱이 AndroidApp 가 아닌 경우 이 목록은 비어 있습니다.
  • sha256_hash 또는 sha256Hashes : 이 필드는 반복되는 string 필드로 간주되며 AndroidApp 에 등록된 모든 SHA-256 인증서 지문 목록으로 채워집니다. 앱이 AndroidApp 가 아닌 경우 이 목록은 비어 있습니다.
  • appStoreId : 이 필드는 IosApp 에 등록된 Apple App Store ID로 채워지는 단일 string 필드로 간주됩니다. 앱이 IosApp 이 아닌 경우 이 필드는 비어 있습니다.
  • teamId : 이 필드는 IosApp 에 등록된 Apple 팀 ID로 채워지는 단일 string 필드로 간주됩니다. 앱이 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

자세한 내용은 인증 개요를 참조하세요.

Firebase앱정보

앱에 대한 높은 수준의 요약입니다.

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

출력만 가능합니다. 불변. WebApp 에 대해 전역적으로 고유한 Firebase 할당 식별자입니다.

데이터 형식이 지정되지 않았으므로 이 식별자는 불투명 토큰으로 처리되어야 합니다.

namespace

string

출력만 가능합니다. 불변. 앱의 플랫폼별 식별자입니다.

참고: 대부분의 사용 사례에서는 앱을 참조하기 위한 표준적이고 전역적으로 고유한 식별자인 appId 사용합니다.

이 문자열은 각 플랫폼의 기본 식별자( AndroidApp 의 경우 packageName , IosApp 의 경우 bundleId , WebApp 의 경우 webId 에서 파생됩니다. 플랫폼이 발전함에 따라 기본 식별자 형식이 변경될 수 있으므로 콘텐츠는 불투명하게 처리되어야 합니다. 이 문자열은 FirebaseProject 및 관련 앱 내에서만 고유합니다.

apiKeyId

string

앱과 연결된 Firebase API 키에 대해 전역적으로 고유한 Google 할당 식별자(UID)입니다.

이 값은 API 키의 keyString 이 아니라 API 키의 UID라는 점에 유의하세요. keyString 앱의 구성 아티팩트( AndroidApp | IosApp | WebApp )에서 찾을 수 있는 값입니다.

앱 생성 요청( AndroidApp | IosApp | WebApp )에 apiKeyId 설정되지 않은 경우 Firebase는 자동으로 apiKeyId 앱과 연결합니다. 이 자동 연결된 키는 기존의 유효한 키일 수 있으며, 유효한 키가 없으면 새 키가 프로비저닝됩니다.

state

enum ( State )

출력만 가능합니다. 앱의 수명주기 상태입니다.

앱플랫폼

Firebase 앱을 연결할 수 있는 플랫폼입니다.

열거형
PLATFORM_UNSPECIFIED 알 수 없는 상태입니다. 이는 설정되지 않은 값을 구별하는 데에만 사용됩니다.
IOS Firebase 앱은 iOS와 연결되어 있습니다.
ANDROID Firebase 앱은 Android와 연결되어 있습니다.
WEB Firebase 앱은 웹과 연결되어 있습니다.