メタデータを使用したカスタム列の作成

メタデータを使用して補足情報を保存および送信できます。メタデータは、オブジェクトまたは取引に関連付けられたキーと値のペアで構成されます。メタデータを使用すると、カスタム情報を Stripe データに添付できるため、コア取引データとともに関連する詳細を保存および取得できます。

メタデータを使用して Stripe レポートから特定の情報を絞り込んで取得し、的を絞ったレポートを簡単に作成して正確なデータを抽出できます。

詳しくは、メタデータをご覧ください。

メタデータの使用

メタデータは、さまざまな方法で Stripe 実装の一部として使用できます。考えられるユースケースには、次のようなものがあります。

• 内部 ID を保存して Stripe オブジェクトを独自のシステム内のオブジェクトと照合する
• Stripe が提供する財務データを自社のシステムと照合する
• Stripe オブジェクトにコンテキスト (支払いなど) を追加してトラブルシューティングを支援する
• Sigma での Stripe データのカスタムレポートと高度なクエリ

これらのユースケースについては、サンプル API コールを参照してください。

財務諸表でメタデータを選択する

1. 関連するレポートに移動します。これは、残高、入金の照合、または アクティビティなどです。
2. ダウンロードをクリックします。
3. すべての列 を選択します。
4. メタデータが添付されたオブジェクトがある場合は、対応する [メタデータ] セクションに表示されます。

メタデータを使用できる場所

メタデータは、特に次のようなさまざまなオブジェクトのレポート作成に使用できます。Charge、Refund、Invoice、Payment、PaymentIntent、Transfer、Product、Customer、Subscription、InvoiceItem、Price、TaxTransaction、CreditNote、Contract、および ContractItem。

メタデータの欠落に関するトラブルシューティング

メタデータ量が、ダウンロードで表示できるメタデータキーの上限数である 100 を超えると、メタデータが欠落する可能性があります。エクスポートに含まれるメタデータ列には、対応するオブジェクトに定義された関連性の高い 100 個のキーが含まれています。

特定のキーの使用を中止し、その後新しいキーを導入した場合、新しいキーはエクスポートに組み込まれません。これは、古いキーのすべてのインスタンスをさかのぼって、支払いやその他のオブジェクトから削除した場合でも同様です。メタデータ列は、エクスポートプロセス中に動的に生成されません。代わりに、新しいキーが追加されると、最大制限の 100 キーまで確立されます。

オブジェクトの 100 キーの制限に達しているにもかかわらず、オブジェクトで現在すべてのキーが使用されていない場合は、Stripe サポートまでお問い合わせください。オブジェクトから未使用のキーを削除するようにリクエストして、必要なフィールドを含むレポートのダウンロードを有効にします。

ベストプラクティス

推奨する方法をいくつかご紹介します。

• メタデータ戦略を事前に計画して、100 キーの制限に達しないようにします
• メタデータキーに一貫性のある命名規則を使用する
• 未使用のメタデータキーを定期的に確認してクリーンアップする
• 整理しやすくするために、さまざまなタイプのメタデータにプレフィックス (“customer_”、“order_” など) を使用することを検討してください