Remote Config REST API リファレンス

このページには、Remote Config REST API のリファレンス情報が記載されています。この API を設定して使用する方法の詳細については、Remote Config REST API をご覧ください。

条件を作成するために使用される要素

Remote Config API は、Firebase コンソールで Remote Config サービスを設定する際に条件の作成に使用される要素と同じ要素をサポートしています。

要素 説明
&&

条件に複数の要素を使用するときに、要素の論理「積」を示すために使用する要素。REST 構文内で && なしで要素が使用されている場合、その要素は条件として扱われます。

注: アンパサンドの前後にスペースが必要です(例: element1 && element2)。

app.version アプリのバージョン番号の値に基づいて、TRUE または FALSE と評価されます。
app.id アプリの Firebase App ID に基づく要素。
app.audiences ユーザーが Firebase 向け Google アナリティクスのユーザーリストに含まれるかどうかに基づいて、TRUE または FALSE と評価される要素。
device.language 端末にインストールされた言語に基づく要素。言語は、es-ES、pt-BR、en-US などの IETF 言語タグを使用して表されます。想定された言語コードと国が一致する場合に TRUE と評価されます。
device.country 端末が存在する地域や国に基づく要素。ISO 3166-1 alpha-2 規格(US、UK など)を使用します。国が想定された国コードと一致する場合に TRUE と評価されます。
device.os 端末のオペレーティング システム(iOS または Android)に基づく要素。端末の OS が想定されたタイプである場合に TRUE と評価されます。
app.userProperty Firebase 向け Google アナリティクスのユーザー プロパティの数値または文字列の値に基づいて、TRUE または FALSE と評価される要素。
percent ランダムに割り当てられた小数パーセンタイル(0.000001% 程度のサンプルサイズ)にユーザーが含まれる場合に TRUE と評価されます。

単一要素条件には 3 つのフィールドがあります。

  1. 任意に定義される name(最大 100 文字)。
  2. 上記の要素で構成される、TRUE または FALSE と評価される条件式。
  3. (省略可)tagColor。可能な値は「BLUE」、「BROWN」、「CYAN」、「DEEP_ORANGE」、「GREEN」、「INDIGO」、「LIME」、「ORANGE」、「PINK」、「PURPLE」、または「TEAL」です。色の指定では大文字と小文字が区別されません。色の指定は、Firebase コンソールに表示される条件にのみ適用されます。

サポートされている演算子

要素 サポートされている演算子 説明
app.audiences .inAtLeastOne([...]) 実際のユーザー層が、リスト内の少なくとも 1 つのユーザー層名と一致する場合に、TRUE を返します。
次に例を示します。


app.audiences.inAtLeastOne(['Audience 1', 'Audience 2'])

app.audiences .notInAtLeastOne([...]) 実際のユーザー層が、リスト内の少なくとも 1 つのユーザー層名と一致しない場合に、TRUE を返します。
app.audiences .inAll([...]) 実際のユーザー層が、リスト内のすべてのユーザー層名のメンバーである場合に、TRUE を返します。
app.audiences .notInAll([...]) 実際のユーザー層が、リスト内のユーザー層のメンバーでない場合に、TRUE を返します。
app.userProperty <<===>=> 実際のユーザー プロパティが演算子と一致するように指定された値と数値的に合致した場合に TRUE を返します。
app.userProperty .contains(...) 実際のユーザー プロパティが、指定された値を含んでいる場合に、TRUE を返します。
app.userProperty .notContains(...) 実際のユーザー プロパティが、指定された値を含んでいない場合に TRUE を返します。
app.userProperty == 実際のユーザー プロパティが、指定された値と正確に一致する(大文字と小文字を区別)場合に TRUE を返します。
app.userProperty .matches(...) ユーザー プロパティが、指定された実際の値の部分文字列または全体文字列と一致する場合に TRUE を返します。文字列の全体と一致させるには、正規表現の前に「^」、末尾に「$」を付けます。RE2 構文を使用します。
app.id == 指定された値がアプリ ID と一致する場合に TRUE を返します。
app.version .contains(...) 実際のアプリのバージョンに対象値が含まれている場合に、TRUE を返します(例: 「abc」に「a」と「bc」が含まれる)。
app.version .notContains(...) 実際のアプリのバージョンに対象値が含まれていない場合に、TRUE を返します。
app.version == 実際のアプリのバージョンが対象値と完全に一致する場合に、TRUE を返します。
app.version .matches(...) 対象の正規表現が、実際の値の部分または全体と一致する場合に、TRUE を返します。文字列すべてと一致させるには、正規表現の前に「^」、末尾に「$」を付けます。RE2 構文を使用します。
device.country in [...] (端末の現在の IP アドレスにより特定された)端末の国が、リストで指定された要素と一致する場合に TRUE を返します。使用例: device.country in ['gb', 'us']
device.language in [...] アプリの言語がリスト内の言語と一致する場合に、TRUE を返します。使用例: device.language in ['en-UK', 'en-US']
device.os ==!= 端末のオペレーティング システムが、演算子に従ってフィールド値との比較に適合する場合に、TRUE を返します。
percent <=> percent フィールドの値が、ランダムに割り当てられた演算子と一致する値と合致する場合に、TRUE を返します。
app.predictions .inAtLeastOne([...]) 指定された対象の予測リスク プロファイル ID の少なくとも 1 つが予測される場合に、TRUE を返します。使用例: app.predictions.inAtLeastOne(['pred1', 'pred2'])。'pred1' と 'pred2' のいずれか(または両方)が予測される場合に TRUE を返します。
app.predictions .inAll([...]) 指定されたすべての対象予測リスク プロファイル ID が予測される場合に、TRUE を返します。使用例: app.predictions.inAll['pred1', 'pred2'])。'pred1' と 'pred2' の両方が予測される場合に TRUE を返します。

空の文字列と値のないパラメータ

Remote Config ウェブ コンソールでパラメータ値を作成または編集する場合、パラメータ値を文字列値(空文字列)に設定したり、No value に設定したりできます。後者の場合、Remote Config テンプレートの値の代わりにアプリ内デフォルト値が使用されるようになります。

Remote Config API を使用してプロジェクトの Remote Config テンプレートを JSON 形式で取得する場合、No value は次のように表されます。

"myCondition" : {
  "useInAppDefault" : true
},

同様に、(空文字列)は次のように表されます。

"myCondition" : {
  "value" : ""
},

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。