どのようなときに使うか設定フィールドリクエストの処理方法レスポンスフィールドネットワーク障害の動作例: ID データの取得

HTTP_REQUEST

どのようなときに使うか

関数HTTP_REQUESTが外部サービスを呼び出す必要がある場合に使用します。一般的なユースケースには、解決プロバイダーからの ID データの取得、データ管理プラットフォームからの対象者セグメントの取得、ログ記録エンドポイントへのセッション情報の送信などがあります。

設定フィールド

HTTP_REQUEST 関数には次のフィールドがあります。

ランタイム — 式言語。これをに設定しますJSONATA。
MethodType — HTTP メソッド。サポートされている値は GET および POST です。
URL — リクエストを送信する URL。静的 URL または URL を動的に構築する JSONata 式を使用できます。
ヘッダー — リクエストに含める HTTP ヘッダー。ヘッダー名と値のペアとして指定されます。動的ヘッダー値には{%...%}式構文を使用します。静的な値は文字列として直接指定できます。
本文 — 送信するリクエスト本文。POST リクエストで使用されます。JSONata 式を使用して、本文を動的に構築できます。
RequestTimeoutMilliseconds (必須) — レスポンスを待機する時間。
出力 — HTTP 呼び出しの完了後に生成する値を定義します。各エントリは、responseオブジェクトを参照できる式に出力キー ( などplayer_params.envelope_id) をマッピングします。

これらのフィールドに適用されるサイズ制限と制限については、「」を参照してください制限。

リクエストの処理方法

MediaTailor は、2 つのステップでHTTP_REQUEST関数を処理します。

リクエストを構築する — MediaTailor はUrl、、Headers、および Body式を現在のセッション状態に対して評価します。これらの評価された値は、アウトバウンド HTTP リクエストを形成します。
レスポンスの処理 — HTTP 呼び出しが完了すると、MediaTailor は出力ブロック内の式を評価します。これらの式は、元のセッション状態と呼び出しによって返されるresponseオブジェクトの両方を参照できます。

レスポンスフィールド

HTTP 呼び出しが完了したら、出力式で次のフィールドを参照できます。

フィールド	タイプ	説明
`response.body`	オブジェクトまたは配列	JSON として解析されたレスポンス本文。本文`null`が 20,000 文字を超える場合、または有効な JSON でない場合は、に設定します。
`response.statusCode`	整数	外部サービスによって返される HTTP ステータスコード。ネットワーク障害`null`時にをに設定します。
`response.text`	String	20,000 文字に切り捨てられた文字列としての raw レスポンス本文。ネットワーク障害`"Internal Error"`時にをに設定します。

重要

response.body フィールドはnull、レスポンスが有効な JSON であっても、レスポンスが 20,000 文字を超える場合です。

注記

レスポンスオブジェクトは、 HTTP_REQUEST関数の出力ブロックでのみ使用できます。URL、ヘッダー、または本文フィールドでレスポンスフィールドを参照することはできません。ではSEQUENTIAL_EXECUTOR、各HTTP_REQUEST関数は独自のレスポンスにのみアクセスできます。

値は、データが使用できないnullことを意味します。これは、HTTP 呼び出しが失敗した場合 (ネットワークエラーまたはタイムアウト）、またはレスポンス本文が 20,000 文字を超えているか、有効な JSON でない場合に発生します。

ネットワーク障害の動作

ネットワークエラーまたはタイムアウトが原因で HTTP 呼び出しが失敗response.statusCodeし、 response.body がに設定されnull、 response.textがに設定されている場合"Internal Error"。Output 式は引き続き実行されるため、レスポンスデータを使用するresponse.statusCode前に必ず確認してください。

ヒント

条件式を使用して、障害を適切に処理します。 {%response.statusCode = 200 ? response.body.value : 'default'%}

例: ID データの取得

次の関数は、セッションの開始時に ID 解決 API を呼び出し、その結果をプレイヤーパラメータに保存します。PRE_SESSION_INITIALIZATION ライフサイクルフック用に設計されています。


{
    "FunctionId": "fetchIdentityEnvelope",
    "FunctionType": "HTTP_REQUEST",
    "HttpRequestConfiguration": {
        "Runtime": "JSONATA",
        "MethodType": "GET",
        "Url": "{%'https://identity.example.com/v1/resolve?ip=' & $encodeUrlComponent(session.client_ip)%}",
        "Headers": {
            "Authorization": "{%'Bearer my_api_token'%}",
            "Accept": "application/json"
        },
        "RequestTimeoutMilliseconds": 2000,
        "Output": {
            "player_params.identity_envelope": "{%response.statusCode = 200 ? response.body.envelope : ''%}"
        }
    }
}

同様の例の完全なチュートリアルについては、「」を参照してください関数の例。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CUSTOM_OUTPUT

SEQUENTIAL_EXECUTOR