ルール式

埋め込み式

複雑な評価ロジックを処理するために、複数の式ドキュメントを別の式ドキュメントのフィールドに埋め込むことができます。 App Services は深度が最初に、 後の順序 で式を評価します。つまり、式ツリーの最下位から始まり、埋め込まれた式のすべての後に各式を評価することで、ルートレベルのフィールドに戻ります。

{
  "%%args.someNumber": {
     "%and": [
        { "$gt": 0 },
        { "$lte": 42 }
     ]
  }
}

マルチフィールド式

式に複数のフィールドがある場合、その式は 式内のすべてのフィールドが true と評価された場合にのみtrueと評価されます。 つまり、App Services は 1 つの式内の複数のフィールドを "AND" 操作として扱います。

{
  "%%args.url": { "$exists": true },
  "%%args.body.userId": "%%user.id"
}

論理展開

%%true

Type: boolean

Usable In: Any Expression

trueと評価されます。 これを使用して、ネストされた式がtrueに評価される必要があることをアサートします。

%%false

Type: boolean

Usable In: Any Expression

falseと評価されます。 これを使用して、ネストされた式がfalseに評価される必要があることをアサートします。

値の拡張

%%values

Type: object

Usable In: Any Expression

アプリケーションの値 を表します。 オブジェクトの各フィールドは、値名を対応する JSON 値またはシークレットにマッピングします。

例

次の式は、値admin_idsがユーザーのアカウント ID を含むリストである場合、 trueと評価されます。

{
  "%%user.id": { "$in": "%%values.admin_ids" }
}

環境の拡張

%%environment

Type: object

Usable In: Any Expression

現在のアプリ環境を表します。 環境名（ tag ）を読み取って、環境値にアクセスできます。

オブジェクトの各プロパティは、環境値の名前を現在の環境内の値にマッピングします。

{
  "tag": "<Environment Name>"
  "values": {
    "<ValueName>": <Value>
  }
}

例

以下は、現在の環境が"production"で、 "baseUrl"環境値が定義されている場合にtrueと評価されるルール式です。

{
  "%%environment.tag": "production",
  "%%environment.values.baseUrl": { "%exists": true }
}

リクエストの展開

%%request

Type: object

Usable In: Any Expression

受信リクエストを表します。

{
  "httpMethod": "<HTTP Method>",
  "httpReferrer": "<HTTP Referer Header>",
  "httpUserAgent": "<HTTP User Agent>",
  "rawQueryString": "<URL Query String>",
  "remoteIPAddress": "<IP Address>",
  "requestHeaders": {
    "<Header Name>": ["<Header Value>", ...]
  },
  "service": "<Service Name>",
  "action": "<Endpoint Function or Service Action Name>",
  "webhookUrl": "<HTTPS Endpoint Route>"
}

ユーザーの拡張

%%user

Type: object

Usable In: Any Expression

リクエストを開始したユーザーを表します。 ユーザー オブジェクトには、アカウント情報、認証プロバイダからのメタデータ、アプリのカスタム データが含まれています。

{
  "id": "<User Account ID>",
  "type": "<normal | server>",
  "data": {
    "<Field Name>": <Value>,
    ...
  }
  "custom_data": {
    "<Field Name>": <Value>,
    ...
  }
  "identities": [
    {
      "providerType": "<Auth Provider Name>",
      "id": "<Provider User ID"
    }
    ...
  ]
}

%%user.id

Type: string

Usable In: Any Expression

認証されたユーザーの ID。

%%user.type

Type: "normal" | "server"

Usable In: Any Expression

リクエストを開始したユーザーのタイプ。 API キーユーザーでは"server"と評価され、他のすべてのユーザーでは"normal"と評価されます。

%%user.custom_data

Type: object

Usable In: Any Expression

ユーザーのカスタム データ。 具体的な内容は、カスタムユーザーデータ構成によって異なります。

例

"custom_data": {
  "primaryLanguage": "English",
}

%%user.data

Type: object

Usable In: Any Expression

ユーザーのメタデータ。 具体的な内容は、ユーザーに関連付けられた認証プロバイダの ID によって異なります。

例

"data": {
  "name": "Joe Mango",
  "email": "joe.mango@example.com"
}

%%user.identities

Type: object[]

Usable In: Any Expression

ユーザーに関連付けられているすべての認証プロバイダID のリスト。 ID は、認可プロバイダーによってユーザーに付与される一意の識別子と、プロバイダーのタイプで構成されます。

例

"identities": [
  {
    "id": "5bce299457c70db9bd73b8-aajddbkuvomsvcrjjfoxs",
    "providerType": "local-userpass"
  }
]

MongoDB ドキュメントの拡張

%%this

Type: any

Usable In: MongoDB Atlas Data Sources

データベース操作の最後に存在する特定のフィールドの値。

%%prev

Type: any

Usable In: MongoDB Atlas Data Sources

書込み操作によって変更される前の特定のフィールドの値。

%%root

Type: object

Usable In: MongoDB Atlas Data Sources

データベース操作の最後に存在する完全なドキュメント。

%%prevRoot

Type: object

Usable In: MongoDB Atlas Data Sources

書込み操作によって変更される前の完全なドキュメント。

{
  "%or": [
    { "%%prevRoot": { "%exists": %%true } },
    { "%%root.status": "new" }
  ]
}

サービスの拡張

%%args

Type: object

Usable In: Third-Party Services [Deprecated]

サービス アクションに引数として渡される値を含むドキュメント。 各引数には、パラメーター名でアクセスできます。

例

以下は、送信元の電話番号（ from引数）が特定の値と一致する場合にtrueと評価されるTwilio のサービスルールです。

{
  "%%args.from": "+15558675309"
}

%%partition

Type: string | number | BSON.ObjectId

Usable In: Partion-based Sync

（パーティションベースの同期のみ） 現在評価されているパーティションのパーティションキー値。

Convert EJSON Values

次の演算子を使用すると、EJSON と JSON 表現の間で値を変換できます。

%stringToOid

12 バイトまたは 24 バイトの string を EJSON objectIdオブジェクトに変換します。

例

{
  "_id": {
    "%stringToOid": "%%user.id"
  }
}

%oidToString

EJSON objectIdオブジェクトを string に変換します。

例

{
  "string_id": {
    "%oidToString": "%%root._id"
  }
}

%stringToUuid

36 バイトの string を EJSON UUIDオブジェクトに変換します。

例

{
  "_id": {
    "%stringToUuid": "%%user.id"
  }
}

%uuidToString

EJSON UUIDオブジェクトを string に変換します。

例

{
  "string_id": {
    "%uuidToString": "%%root._id"
  }
}

関数の呼び出し

次の演算子を使用すると、Atlas App Services アプリケーションで関数を呼び出すことができます。

%function

指定された名前と引数を持つ関数を呼び出します。 関数が返す値を評価します。

例

{
  "%%true": {
    "%function": {
      "name": "isEven",
      "arguments": [42]
    }
  }
}

有無を確認

次の演算子を使用すると、値がオブジェクトまたは配列に存在するかどうかを判断できます。

$exists

割り当てられているフィールドに値があるかどうかを確認します。 結果を表すブール値として評価されます。

例

{
  "url": { "$exists": true }
}

$in

指定された値の配列をチェックして、その配列にこの演算子が割り当てられているフィールドの値が含まれているかどうかを確認します。 結果を表すブール値として評価されます。

例

{
  "url": {
    "$in": [
      "https://www.example.com",
      "https://www.mongodb.com"
    ]
  }
}

$nin

指定された値の配列をチェックして、その配列にこの演算子が割り当てられているフィールドの値が含まれていないかどうかを確認します。 結果を表すブール値として評価されます。

例

{
  "url": {
    "$nin": [
      "https://www.example.com",
      "https://www.mongodb.com"
    ]
  }
}

Compare Values

次の演算子を使用すると、展開された値を含む値を比較できます。

$eq

割り当てられているフィールドが指定された値と等しいかどうかを確認します。 結果を表すブール値として評価されます。

例

{ "score": { "$eq": 42 } }

$ne

割り当てられているフィールドが指定された値と等しくないかどうかを確認します。 結果を表すブール値として評価されます。

例

{ "numPosts": { "$ne": 0 } }

$gt

割り当てられているフィールドが指定された値を超えるかどうかを確認します。 結果を表すブール値として評価されます。

例

{ "score": { "$gt": 0 } }

$gte

割り当てられているフィールドが指定した値以上であるかどうかを確認します。 結果を表すブール値として評価されます。

例

{ "score": { "$gte": 0 } }

$lt

割り当てられているフィールドが指定された値未満であるかどうかを確認します。 結果を表すブール値として評価されます。

例

{ "score": { "$lt": 0 } }

$lte

割り当てられているフィールドが指定された値以下であるかどうかを確認します。 結果を表すブール値として評価されます。

例

{ "score": { "$lte": 0 } }