firebase-admin.remote-config package

Firebase 원격 구성

Functions

함수 설명
getRemoteConfig(앱) 기본 앱 또는 지정된 앱의 RemoteConfig 서비스를 가져옵니다.getRemoteConfig()는 기본 앱의 RemoteConfig 서비스에 액세스하기 위한 인수 없이 호출하거나 getRemoteConfig(app)로 호출하여 특정 앱과 연결된 RemoteConfig 서비스에 액세스할 수 있습니다.

클래스

클래스 설명
원격 구성 Firebase RemoteConfig 서비스 인터페이스

열거

열거 설명
PercentConditionOperator를 추가했습니다. 비율 조건에 지원되는 연산자를 정의합니다.

인터페이스

인터페이스 설명
AndCondition 모든 항목이 true인 경우 true로 판정되는 조건의 모음을 나타냅니다.
명시적 매개변수 값 명시적 매개변수 값을 나타내는 인터페이스입니다.
GetServerTemplateOptions ServerTemplate을 인스턴스화할 때 사용할 수 있는 선택적 인수를 나타냅니다.
InAppDefaultValue 인앱 기본값을 나타내는 인터페이스입니다.
InitServerTemplateOptions ServerTemplate을 동기적으로 인스턴스화할 때 사용할 수 있는 선택적 인수를 나타냅니다.
ListVersionsOptions 원격 구성 목록 버전 작업 옵션을 나타내는 인터페이스입니다.
ListVersionsResult 원격 구성 템플릿 버전 목록을 나타내는 인터페이스입니다.
MicroPercentRange 타겟팅할 백분위수의 한도를 마이크로퍼센트로 나타냅니다. 값은 [0~100000000] 범위 내에 있어야 합니다.
NamedCondition 데이터 영역의 원격 구성 조건을 나타냅니다. 조건이 특정 사용자 그룹을 타겟팅합니다. 이러한 조건의 목록은 원격 구성 템플릿의 일부입니다.
OneOfCondition 여러 유형 중 하나일 수 있는 조건을 나타냅니다. 처음 정의된 필드만 처리됩니다.
OrCondition true인 경우 true로 판정되는 조건의 모음을 나타냅니다.
PercentCondition 인스턴스 의사 난수 백분위수를 지정된 한도와 비교하는 조건을 나타냅니다.
RemoteConfigCondition 원격 구성 조건을 나타내는 인터페이스입니다. 조건이 특정 사용자 그룹을 타겟팅합니다. 이러한 조건 목록은 원격 구성 템플릿의 일부입니다.
원격 구성 매개변수 원격 구성 매개변수를 나타내는 인터페이스입니다. 매개변수가 적용되려면 최소한 defaultValue 또는 conditionalValues 항목이 있어야 합니다.
RemoteConfigParameterGroup 원격 구성 매개변수 그룹을 나타내는 인터페이스입니다. 매개변수를 그룹화하는 것은 관리 목적으로만 사용되며 클라이언트 측 매개변수 값 가져오기에는 영향을 미치지 않습니다.
RemoteConfigTemplate 원격 구성 클라이언트 템플릿을 나타냅니다.
RemoteConfigUser 원격 구성 사용자를 나타내는 인터페이스입니다.
ServerConfig 서버 템플릿을 평가하여 생성된 구성을 나타냅니다.
ServerTemplate 원격 구성 서버 템플릿의 스테이트풀(Stateful) 추상화를 나타냅니다.
ServerTemplateData 원격 구성 서버 템플릿의 데이터를 나타냅니다.
값 메타데이터 및 유형 안전 getter로 매개변수 값을 래핑합니다.유형 안전 getter는 매개변수 이름 및 유형에 대한 원격 변경에서 애플리케이션 로직을 격리합니다.
버전 원격 구성 템플릿 버전을 나타내는 인터페이스입니다. 버전 설명을 제외한 출력 전용입니다. 원격 구성 템플릿의 특정 버전에 대한 메타데이터가 포함됩니다. 모든 필드는 지정된 원격 구성 템플릿이 게시될 때 설정됩니다. 버전의 설명 필드를 publishTemplate 호출에서 지정할 수 있습니다.

유형 별칭

유형 별칭 설명
DefaultConfig 인앱 매개변수 기본값의 형식을 정의합니다.
EvaluationContext 템플릿 평가 입력 신호를 나타냅니다.
매개변수 값 유형 원격 구성 매개변수 값 데이터 유형을 나타내는 유형입니다. 지정되지 않은 경우 기본값은 STRING입니다.
RemoteConfigParameterValue 원격 구성 매개변수 값을 나타내는 유형입니다. RemoteConfigParameterValue는 ExplicitParameterValue 또는 InAppDefaultValue일 수 있습니다.
ServerTemplateDataType ServerTemplate에 설정할 수 있는 원격 구성 서버 템플릿의 유형을 나타냅니다. ServerTemplateData 객체 또는 템플릿 JSON 문자열일 수 있습니다.
태그 색상 표시를 위해 조건과 연결된 색상입니다.
ValueSource 값의 소스를 나타냅니다.
  • 'static'은 값이 정적 상수로 정의되었음을 나타냅니다.
  • 'default'는 값이 기본 config에 의해 정의되었음을 나타냅니다.
  • 'remote'는 값이 템플릿을 평가하여 생성된 구성에서 정의되었음을 나타냅니다.

getRemoteConfig(앱)

기본 앱 또는 특정 앱의 RemoteConfig 서비스를 가져옵니다.

getRemoteConfig()는 기본 앱의 RemoteConfig 서비스에 액세스하기 위한 인수 없이 호출하거나 getRemoteConfig(app)로 호출하여 특정 앱과 연결된 RemoteConfig 서비스에 액세스할 수 있습니다.

서명:

export declare function getRemoteConfig(app?: App): RemoteConfig;

매개변수

매개변수 유형 설명
앱 앱 RemoteConfig 서비스를 반환할 선택적 앱입니다. 제공하지 않으면 기본 RemoteConfig 서비스가 반환됩니다.

반환:

원격 구성

제공된 앱이 없는 경우 기본 RemoteConfig 서비스 또는 제공된 앱과 연결된 RemoteConfig 서비스입니다.

예 1

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

예 2

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

기본 구성

인앱 매개변수 기본값의 형식을 정의합니다.

서명:

export type DefaultConfig = {
    [key: string]: string | number | boolean;
};

평가 컨텍스트

템플릿 평가 입력 신호를 나타냅니다.

서명:

export type EvaluationContext = {
    randomizationId?: string;
};

ParameterValueType

원격 구성 매개변수 값 데이터 유형을 나타내는 유형입니다. 지정되지 않은 경우 기본값은 STRING입니다.

서명:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

원격 구성 매개변수 값

원격 구성 매개변수 값을 나타내는 유형입니다. RemoteConfigParameterValue은 ExplicitParameterValue 또는 InAppDefaultValue일 수 있습니다.

서명:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

서버 템플릿 데이터 유형

ServerTemplate에 설정할 수 있는 원격 구성 서버 템플릿의 유형을 나타냅니다. ServerTemplateData 객체 또는 템플릿 JSON 문자열일 수 있습니다.

서명:

export type ServerTemplateDataType = ServerTemplateData | string;

태그 색상

표시를 위해 조건과 연결된 색상입니다.

서명:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';

가치 소스

값의 소스를 나타냅니다.

  • 'static'은 값이 정적 상수로 정의되었음을 나타냅니다.
  • 'default'는 값이 기본 config에 의해 정의되었음을 나타냅니다.
  • 'remote'는 값이 템플릿을 평가하여 생성된 구성에서 정의되었음을 나타냅니다.

서명:

export type ValueSource = 'static' | 'default' | 'remote';

PercentConditionOperator(비율 조건 연산자)

비율 조건에 지원되는 연산자를 정의합니다.

서명:

export declare enum PercentConditionOperator

열거 구성원

구성원 값 설명
BETWEEN "BETWEEN" 하한값과 상한값으로 정의되는 간격 내의 목표 백분위수입니다. 하한값은 배타적 (개방) 한도이고 마이크로_비율_범위_상한값은 포괄 (폐쇄)한값입니다. 이 연산자를 사용하는 조건은 microPercentRange를 지정해야 합니다.
GREATER_THAN "GREATER_THAN" 목표 백분위수보다 큰 대상 백분위수입니다. 이 연산자를 사용하는 조건은 microPercent를 지정해야 합니다.
적음_또는_같음 "LESS_OR_EQUAL" 목표 백분위수보다 작거나 같은 목표 백분위수입니다. 이 연산자를 사용하는 조건은 microPercent를 지정해야 합니다.
알 수 없음 "UNKNOWN" 포괄 오류 사례