firebase-admin.remote-config package

Firebase Remote Config.

İşlevler

İşlev Açıklama
getRemoteConfig(uygulama) Varsayılan uygulama veya belirli bir uygulama için RemoteConfig hizmetini alır.getRemoteConfig(), varsayılan uygulamanın RemoteConfig hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş RemoteConfig hizmetine erişmek için getRemoteConfig(app) olarak çağrılabilir.

Sınıflar

Sınıf Açıklama
RemoteConfig Firebase RemoteConfig hizmeti arayüzü.

Numaralandırmalar

Numaralandırma Açıklama
PercentConditionOperator Yüzde koşulları için desteklenen operatörleri tanımlar.

Arayüzler

Arayüz Açıklama
AndCondition Tüm koşulların doğru olması durumunda "doğru" olarak değerlendirilen bir dizi koşulu temsil eder.
NetParametersValue Açık bir parametre değerini temsil eden arayüz.
GetServerTemplateOptions ServerTemplate örneğini oluştururken kullanılabilecek isteğe bağlı bağımsız değişkenleri temsil eder.
InAppDefaultValue Uygulama içi varsayılan değeri temsil eden arayüz.
InitServerTemplateOptions Eşzamanlı ServerTemplate bir örnek oluştururken kullanılabilecek isteğe bağlı bağımsız değişkenleri temsil eder.
ListVersionsOptions Remote Config liste sürümleri işleminin seçeneklerini gösteren arayüz.
ListVersionsResult Remote Config şablon sürümlerinin listesini temsil eden arayüz.
Mikro Yüzde Aralığı Mikro yüzde cinsinden, hedeflenecek yüzdelik dilim sınırını temsil eder. Değer [0 ile 10.000.000] aralığında olmalıdır
NamedCondition (Adlandırılmış Koşul) Veri düzleminde bir Remote Config koşulunu temsil eder. Bir koşul, belirli bir kullanıcı grubunu hedefler. Bu koşulların listesi, bir Remote Config şablonunun parçasını içerir.
OneOfCondition Birkaç türden biri olabilecek bir koşulu temsil eder. Yalnızca tanımlanan ilk alan işlenir.
OrCondition Herhangi bir doğruysa "doğru" olarak değerlendirilen bir dizi koşulu temsil eder.
PercentKoşul Örneğin gerçek olmayan rastgele yüzdelik dilimini belirli bir sınırla karşılaştıran bir koşulu temsil eder.
RemoteConfigCondition Remote Config koşulunu temsil eden arayüz. Bir koşul, belirli bir kullanıcı grubunu hedefler. Bu koşulların listesi, Remote Config şablonunun bir bölümünü oluşturur.
RemoteConfigParameters Remote Config parametresini temsil eden arayüz. Parametrenin etkili olabilmesi için en azından bir defaultValue veya conditionalValues girişi bulunmalıdır.
RemoteConfigParametersGroup Remote Config parametre grubunu temsil eden arayüz. Gruplandırma parametreleri yalnızca yönetim amaçlıdır ve parametre değerlerinin istemci tarafında getirilmesini etkilemez.
RemoteConfigTemplate Remote Config istemci şablonunu temsil eder.
RemoteConfigUser Remote Config kullanıcısını temsil eden arayüz.
ServerConfig Bir sunucu şablonu değerlendirilerek oluşturulan yapılandırmayı temsil eder.
ServerTemplate Remote Config sunucu şablonu için durum bilgili bir soyutlamayı temsil eder.
ServerTemplateData Verileri bir Remote Config sunucu şablonundaki temsil eder.
Değer Bir parametre değerini meta veriler ve tür için güvenli alıcılarla sarmalar.Tür güvenli alıcılar, uygulama mantığını, uzaktan yapılan değişikliklerden parametre adlarına ve türlerine kadar izole eder.
Sürüm Remote Config şablon sürümünü temsil eden arayüz. Sürüm açıklaması hariç yalnızca çıkış. Remote Config şablonunun belirli bir sürümüyle ilgili meta verileri içerir. Belirtilen Remote Config şablonu yayınlandığında tüm alanlar ayarlanır. Bir sürümün açıklama alanı, publishTemplate çağrılarında belirtilebilir.

Tür Takma Adları

Takma Ad yazın Açıklama
DefaultConfig Uygulama içi varsayılan parametre değerlerinin biçimini tanımlar.
DeğerlendirmeBağlamı Şablon değerlendirme giriş sinyallerini temsil eder.
ParametersValueType Remote Config parametre değeri veri türünü temsil eden tür. Belirtilmezse varsayılan olarak STRING değerine ayarlanır.
RemoteConfigParametersValue Remote Config parametre değerini temsil eden tür. Bir RemoteConfigParameterValue, ExplicitParameterValue veya InAppDefaultValue olabilir.
ServerTemplateDataType ServerTemplate üzerinde ayarlanabilecek bir Remote Config sunucu şablonu türünü temsil eder. Bu, bir ServerTemplateData nesnesi veya bir şablon JSON dizesi olabilir.
TagRenk Görüntüleme amaçlı koşullarla ilişkilendirilen renkler.
ValueSource Bir değerin kaynağını gösterir.
  • "statik" değerin statik bir sabit sayıyla tanımlandığını gösterir.
  • "varsayılan" değerin varsayılan yapılandırma tarafından tanımlandığını gösterir.
  • "uzaktan" değerin, bir şablon değerlendirilerek oluşturulan yapılandırmayla tanımlandığını gösterir.

getRemoteConfig(uygulama)

Varsayılan uygulama veya belirli bir uygulama için RemoteConfig hizmetini alır.

getRemoteConfig(), varsayılan uygulamanın RemoteConfig hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkilendirilmiş RemoteConfig hizmetine erişmek için getRemoteConfig(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre Tür Açıklama
uygulama Uygulama RemoteConfig hizmetinin iade edileceği isteğe bağlı uygulama. Sağlanmazsa varsayılan RemoteConfig hizmeti döndürülür.

Şunu döndürür:

RemoteConfig

Uygulama sağlanmamışsa varsayılan RemoteConfig hizmeti veya sağlanan uygulamayla ilişkilendirilmiş RemoteConfig hizmeti.

1. örnek

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

2. örnek

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

DefaultConfig

Uygulama içi varsayılan parametre değerlerinin biçimini tanımlar.

İmza:

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

Değerlendirme Bağlamı

Şablon değerlendirme giriş sinyallerini temsil eder.

İmza:

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

ParametreDeğeriTürü

Remote Config parametre değeri veri türünü temsil eden tür. Belirtilmezse varsayılan olarak STRING değerine ayarlanır.

İmza:

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

RemoteConfigParametre Değeri

Remote Config parametre değerini temsil eden tür. Bir RemoteConfigParameterValue, ExplicitParameterValue veya InAppDefaultValue olabilir.

İmza:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

ServerTemplateDataType

ServerTemplate üzerinde ayarlanabilecek bir Remote Config sunucu şablonu türünü temsil eder. Bu, bir ServerTemplateData nesnesi veya bir şablon JSON dizesi olabilir.

İmza:

export type ServerTemplateDataType = ServerTemplateData | string;

EtiketRengi

Görüntüleme amaçlı koşullarla ilişkilendirilen renkler.

İmza:

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

DeğerKaynağı

Bir değerin kaynağını gösterir.

  • "statik" değerin statik bir sabit sayıyla tanımlandığını gösterir.
  • "varsayılan" değerin varsayılan yapılandırma tarafından tanımlandığını gösterir.
  • "uzaktan" değerin, bir şablon değerlendirilerek oluşturulan yapılandırmayla tanımlandığını gösterir.

İmza:

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

PercentConditionOperator

Yüzde koşulları için desteklenen operatörleri tanımlar.

İmza:

export declare enum PercentConditionOperator

Numaralandırma Üyeleri

Üye Değer Açıklama
ARASINDA "BETWEEN" Alt sınır ve üst sınırla tanımlanan aralık içindeki hedef yüzdelik dilimler. Alt sınır özel (açık) bir sınır, micro_percent_range_upper_bound ise kapsayıcı (kapalı) bir sınırdır. Bu operatörü kullanan bir koşul, microPercentRange değerini belirtmelidir.
BÜYÜK_TTAN "GREATER_THAN" Hedef yüzdeden daha büyük olan hedef yüzdelik dilimler. Bu operatörü kullanan bir koşul, microPercent değerini belirtmelidir.
DAHA AZ "LESS_OR_EQUAL" Hedef yüzdeden küçük veya hedef yüzdeye eşit hedef yüzdelik dilimler. Bu operatörü kullanan bir koşul, microPercent değerini belirtmelidir.
BİLİNMİYOR "UNKNOWN" Tümünü yakalama hata durumu.