> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ログイン時およびログイン後の Actions 間で、ユーザーまたはアプリケーションのメタデータを受け渡す方法について説明します。

# Actions トランザクションメタデータ

Actions トランザクションメタデータを使用すると、トランザクションの間、[post-login](/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger) Action 内でカスタムメタデータを保存、参照、共有できます。

従来は、各 Action が独立して動作していたため、Action 間で情報を受け渡すのは困難でした。Actions トランザクションメタデータを使うと、次のことが可能になります。

* API レスポンスや中間計算結果などのデータを Action 間で共有する。
* 異なる Action で同じ情報を再取得したり、再計算したりする必要をなくす。

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  開発でトランザクションメタデータを使用する前に、制限事項を確認することをお勧めします。詳しくは、[Actions の制限事項](/docs/ja-jp/customize/actions/limitations) を参照してください。
</Callout>

<div id="how-it-works">
  ## 仕組み
</div>

トランザクションメタデータを保存するためのキーと値のペアを設定するには、[post-login API object](/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object) `api.transaction.setMetadata` を使用します。

保存されたキーと値のペアにアクセスするには、[post-login Event object](/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-event-object) `event.transaction.metadata` を使用します。これにより、同じ Action 内、または 1 回の実行における post-login トリガーの後続の Actions からアクセスできます。

API オブジェクトと Event オブジェクトは、次のパラメーターを受け取ります。

| Value   | Type                          | Description                                      |
| ------- | ----------------------------- | ------------------------------------------------ |
| `Key`   | `String`                      | 設定するメタデータプロパティのキー。                               |
| `Value` | `String`, `Number`, `Boolean` | メタデータプロパティの値。<br />`null` に設定すると、そのプロパティは削除されます。 |

Actions の記述について詳しくは、[Write Your First Action](/docs/ja-jp/customize/actions/write-your-first-action) を参照してください。

<div id="latency">
  ## 遅延
</div>

Actions Transaction Metadata を使用すると、わずかな遅延が追加で発生する可能性があります。遅延の大きさは metadata のペイロードサイズに比例し、Action の中断が発生する場合に影響します。たとえば、<Tooltip tip="" cta="用語集を見る" href="/docs/ja-jp/glossary?term=MFA">MFA</Tooltip> をトリガーする場合、Actions からリダイレクトする場合、または Forms をレンダリングする場合は、ストレージからデータを再読み込みする必要があるため、遅延が問題になる可能性があります。

ただし、この遅延の可能性は、一連の Actions で必要なデータを取得するために冗長な外向き HTTP リクエストを行う場合に比べれば、最小限にとどまるはずです。

<div id="examples">
  ## 例
</div>

<div id="access-metadata-immediately">
  ### メタデータにすぐアクセスする
</div>

トランザクションのメタデータにキーと値のペアを設定し、その値にすぐアクセスできます。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('hello', 'Auth0');

  console.log('Hello ', event.transaction?.metadata?.hello);
  /* "Hello Auth0" を出力 */
};
```

<div id="set-supported-values">
  ### 対応している値を設定する
</div>

`string`、`number`、`boolean` 型の値を設定できます。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('string_value', 'Auth0');
  api.transaction.setMetadata('boolean_value', true);
  api.transaction.setMetadata('number_value', 12);

  console.log('string_value', event.transaction?.metadata?.string_value);
  /* "string_value Auth0" を出力 */
  console.log('boolean_value', event.transaction?.metadata?.boolean_value);
  /* "boolean_value true" を出力 */
  console.log('number_value', event.transaction?.metadata?.number_value);
  /* "number_value 12" を出力 */
};
```

<div id="serialize-values">
  ### 値をシリアライズする
</div>

[制限事項](/docs/ja-jp/customize/actions/limitations#transaction-metadata)の範囲内で、値は`string`としてシリアライズします。

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  `object`型または`array`型の値は設定できませんが、`string`としてシリアライズすることはできます。
</Callout>

```text lines expandable theme={null}
exports.onExecutePostLogin = async (event, api) => {
  const serialized_object_value = JSON.stringify({
    string_value: 'Auth0',
    boolean_value: true,
    number_value: 12
  });

  api.transaction.setMetadata('serialized_object_value', serialized_object_value);

  const serialized_array_value = JSON.stringify([
    'Auth0',
    true,
    12
  ]);
  api.transaction.setMetadata('serialized_array_value', serialized_array_value);

  console.log('serialized_object_value',
    JSON.parse(event.transaction?.metadata?.serialized_object_value)
  );
  /* 出力: "serialized_object_value { string_value: 'Auth0', boolean_value: true, number_value: 12 }" */

  console.log('serialized_array_value',
    JSON.parse(event.transaction?.metadata?.serialized_array_value)
  );
  /* 出力: "serialized_array_value [ 'Auth0', true, 12 ]" */
};
```

<div id="share-values-between-actions">
  ### Actions 間で値を共有する
</div>

同じ実行シーケンス内の Actions 間で、キーと値のペアを共有します。

**Action 1**

`api` オブジェクトの `setMetadata` メソッドを使って、`hello` キーに `Auth0` という値を設定します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('hello', 'Auth0');
};
```

**アクション 2**

`event` オブジェクトの `transaction.metadata` プロパティを使用して設定された値にアクセスし、トランザクションメタデータ内の `hello` キーに対する `Auth0` の値をログに記録します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  console.log('Hello', event.transaction?.metadata?.hello);
  /* "Hello Auth0" を出力 */
};
```

<div id="update-metadata">
  ### メタデータを更新する
</div>

既存のキーに別の値を設定して、メタデータを更新します。

**アクション 1**

トランザクションのメタデータのキーと値をそれぞれ `custom_tx_id` と `xyz123` に設定します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('custom_tx_id', 'xyz123');
};
```

**アクション 2**

キーを `custom_tx_id`、値を `xyz123` として記録します。次に、`custom_tx_id` を `abc456` に設定し、トランザクションメタデータ内の `custom_tx_id` の最新の値でもう一度記録します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  console.log('custom_tx_id', event.transaction?.metadata?.custom_tx_id);
  /* "custom_tx_id xyz123" を出力 */

  api.transaction.setMetadata('custom_tx_id', 'abc456');

  console.log('custom_tx_id', event.transaction?.metadata?.custom_tx_id);
  /* "custom_tx_id abc456" を出力 */
};
```

**アクション 3**

`custom_tx_id` の値として `abc456` を記録します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  console.log('custom_tx_id', event.transaction?.metadata?.custom_tx_id);
  /* "custom_tx_id abc456" を出力 */
};
```

<div id="remove-metadata">
  ### メタデータを削除する
</div>

各キーの値を `null` にすることで、トランザクションメタデータの値を削除できます。

**アクション 1**

トランザクションメタデータに `custom_tx_id` を設定します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('custom_tx_id', 'xyz123');
};
```

**アクション 2**

`custom_tx_id` を `null` に設定し、その `null` 値をログに記録します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  console.log('custom_tx_id', event.transaction?.metadata?.custom_tx_id);
  /* "custom_tx_id xyz123" を出力 */

  api.transaction.setMetadata('custom_tx_id', null);

  console.log('custom_tx_id', event.transaction?.metadata?.custom_tx_id);
  /* "custom_tx_id undefined" を出力 */
};
```

**アクション 3**

`custom_tx_id` に `null` 値を記録します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  console.log('custom_tx_id', event.transaction?.metadata?.custom_tx_id);
  /* "custom_tx_id undefined" を出力 */
};
```

<div id="preserve-values-on-redirect-to-external-sites">
  ### 外部サイトへのリダイレクト時に値を保持する
</div>

[リダイレクト](/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions)中も、トランザクションメタデータを保持します。ユーザーが認証フローを再開すると、その値を利用できます。

**Action 1**

トランザクションメタデータに `custom_tx_id` を設定します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('custom_tx_id', 'xyz123');
};
```

**アクション 2**

トランザクションのメタデータに含まれる `custom_tx_id` を持つトークンを送信して、外部サイトにリダイレクトします。次に、トランザクションのメタデータ内の `custom_tx_id` の値と、外部サイトに渡され、別のトークンのペイロードで送り返されてきた値を比較します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  const token = api.redirect.encodeToken({
    secret: event.secrets.REDIRECT_SECRET,
    expiresInSeconds: 60, 
    payload: {
      custom_tx_id: event.transaction?.metadata?.custom_tx_id,
      continue_uri: `https://${event.secrets.TENANT_DOMAIN}/continue`
    },
  });

  api.redirect.sendUserTo(event.secrets.REDIRECT_URL, {
    query: { session_token: token }
  });
};

exports.onContinuePostLogin = async (event, api) => {
  const payload = api.redirect.validateToken({
    secret: event.secrets.REDIRECT_SECRET
  });

  console.log('Does custon_tx_id match?',
    payload?.custom_tx_id === event.transaction?.metadata?.custom_tx_id
  );
  /* 出力: "Does custon_tx_id match? True" */
};
```

<div id="preserve-values-on-forms-rendering">
  ### Forms のレンダリング時に値を保持する
</div>

[Actions を使用して Forms をレンダリングする](/docs/ja-jp/customize/forms/render) と、トランザクションメタデータの値は保持され、ユーザーが認証フローを続行する際にも利用できます。

Actions で Forms を使用する方法について詳しくは、[Actions を使用して Forms をレンダリングする](/docs/ja-jp/customize/forms/render) を参照してください。

**Action 1**

トランザクションメタデータに `custom_tx_id` を設定します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('custom_tx_id', 'xyz123');
};
```

**アクション 2**

フォームをレンダリングします。次に、Actions の実行を続行する際に、保持された `custom_tx_id` をログに出力します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.prompt.render(event.secrets.FORM_ID);
};

exports.onContinuePostLogin = async (event, api) => {
  console.log('custon_tx_id', event.transaction?.metadata?.custom_tx_id);
  /* "custom_tx_id xyz123" を出力 */
};
```

<div id="share-values-with-forms">
  ### Forms と値を共有する
</div>

Actions を使って Forms をレンダリングし、トランザクションのメタデータの値を Form に渡せます。

**Action 1**

トランザクションのメタデータに `custom_tx_id` を設定します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.transaction.setMetadata('custom_tx_id', 'xyz123');
};
```

**アクション 2**

トランザクションメタデータの `custom_tx_id` を `vars` パラメーターとして渡し、Form をレンダリングします。次に、Actions の実行を続行する際に、トランザクションメタデータ内の `custom_tx_id` の値と Form に渡した値を比較します。

```text lines theme={null}
exports.onExecutePostLogin = async (event, api) => {
  api.prompt.render(event.secrets.FORM_ID, {
    vars: {
      custom_tx_id: event.transaction?.metadata?.custom_tx_id
    }
  });
};

exports.onContinuePostLogin = async (event, api) => {
  console.log('Does custon_tx_id match?',
    event.prompt?.vars?.custom_tx_id === event.transaction?.metadata?.custom_tx_id
  );
  /* 出力: "Does custon_tx_id match? True" */
};
```