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şkili 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

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

Arayüzler

Arayüz Açıklama
AndCondition Tümü doğruysa doğru olarak değerlendirilen bir koşul koleksiyonunu temsil eder.
AçıkParametreDeğeri Açık bir parametre değerini temsil eden arayüz.
GetServerTemplateOptions ServerTemplate örneği oluşturulurken 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 ServerTemplate'i eşzamanlı olarak örneklendirirken kullanılabilecek isteğe bağlı bağımsız değişkenleri temsil eder.
ListVersionsOptions Remote Config liste sürümleri işlemi için seçenekleri gösteren arayüz.
ListVersionsResult (Liste Sürümleri Sonucu) Remote Config şablon sürümlerinin listesini temsil eden arayüz.
Mikro Yüzde Aralığı Hedeflenecek yüzdelik dilim sınırını mikro yüzde olarak temsil eder. Değer [0 ve 100000000] aralığında olmalıdır
NamedCondition Veri düzlemindeki bir Remote Config koşulunu temsil eder. Koşul belirli bir kullanıcı grubunu hedefler. Bu koşulların listesi Remote Config şablonunun bir parçasını oluşturur.
OneOfCondition Birkaç türden biri olabilecek bir koşulu temsil eder. Yalnızca tanımlanan ilk alan işlenir.
OrCondition Doğru olması durumunda doğru olarak değerlendirilen bir koşul koleksiyonunu temsil eder.
PercentCondition Örnek sözde 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. Koşul belirli bir kullanıcı grubunu hedefler. Bu koşulların listesi bir Remote Config şablonunda yer alır.
RemoteConfigParametresi Remote Config parametresini temsil eden arayüz. Parametrenin bir etkisi olması için en azından bir defaultValue veya conditionalValues girişi olmalıdır.
RemoteConfigParametersGroup Remote Config parametre grubunu temsil eden arayüz. Parametreleri gruplandırma, 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 şablonunun değerlendirilmesiyle oluşturulan yapılandırmayı temsil eder.
ServerTemplate Bir Remote Config sunucu şablonu için durum bilgili bir soyutlamayı temsil eder.
ServerTemplateData Bir Remote Config sunucu şablonundaki verileri temsil eder.
Değer Bir parametre değerini meta veri ve tür güvenli alıcılarla sarmalar.Tür güvenli alıcılar, uygulama mantığını uzaktan değişikliklerden parametre adlarına ve türlerine kadar yalıtır.
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. Tüm alanlar, belirtilen Remote Config şablonu yayınlandığı sırada ayarlanır. Bir sürümün açıklama alanı, publishTemplate çağrılarında belirtilebilir.

Takma Adları Yazın

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.
Parametre DeğeriTürü Remote Config parametre değeri veri türünü temsil eden tür. Belirtilmezse varsayılan olarak STRING ayarlanır.
RemoteConfigParametersValue Remote Config parametre değerini temsil eden tür. RemoteConfigParameterValue, ExplicitParameterValue veya InAppDefaultValue olabilir.
ServerTemplateDataType ServerTemplate üzerinde ayarlanabilen bir Remote Config sunucu şablonunun türünü temsil eder. Bu, bir ServerTemplateData nesnesi veya bir şablon JSON dizesi olabilir.
EtiketRengi Görüntüleme amaçlarıyla ilgili koşullarla ilişkilendirilen renkler.
Değer Kaynağı Bir değerin kaynağını gösterir.
  • "static", değerin statik bir sabitle tanımlandığını gösterir.
  • "default" ise değerin varsayılan yapılandırmaya göre tanımlandığını gösterir.
  • "remote", değerin bir şablonun değerlendirilmesi esnasında oluşturulan yapılandırma tarafından 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şkili 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 Uygulamaya RemoteConfig hizmetinin döndürüleceği isteğe bağlı uygulama. Sağlanmazsa varsayılan RemoteConfig hizmeti döndürülür.

İadeler:

RemoteConfig

Uygulama sağlanmamışsa varsayılan RemoteConfig hizmeti veya sağlanan uygulamayla ilişkili 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);

Varsayılan Yapılandırma

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

İmza:

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

DeğerlendirmeBağlamı

Şablon değerlendirme giriş sinyallerini temsil eder.

İmza:

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

ParametreDeğerTürü

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

İmza:

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

RemoteConfig Parametre Değeri

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

İmza:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

ServerTemplateDataType

ServerTemplate üzerinde ayarlanabilen bir Remote Config sunucu şablonunun 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çlarıyla ilgili 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.

  • "static", değerin statik bir sabitle tanımlandığını gösterir.
  • "default" ise değerin varsayılan yapılandırmaya göre tanımlandığını gösterir.
  • "remote", değerin bir şablonun değerlendirilmesi esnasında oluşturulan yapılandırma tarafından 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

Sıralama Üyeleri

Üye Değer Açıklama
ARASINDA "BETWEEN" Bir alt sınır ve bir ü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 değeri ise kapsayıcı (kapalı) bir sınırdır. Bu operatörü kullanan bir koşul, microPercentRange değerini belirtmelidir.
BÜYÜK_TANE "GREATER_THAN" Hedef yüzdelik dilimler hedef yüzdeden büyük. Bu operatörü kullanan bir koşul, microPercent değerini belirtmelidir.
DAHA AZ_VEYA_EQUAL "LESS_OR_EQUAL" Hedef yüzdelik dilimler, hedef yüzdeden küçük veya hedef yüzdeye eşit. Bu operatörü kullanan bir koşul, microPercent değerini belirtmelidir.
BİLİNMİYOR "UNKNOWN" Tümünü yakalama hatası.