{{page.title}}

{{page.description}}

概要

Brightcove Beaconが購入が完了したことをプロバイダーに通知できるように、ビデオコンテンツや商品のプロバイダーがエンドポイントを設定する必要があります。Brightcove Beaconアプリを通じてアプリ内購入が行われると、アプリはAppleAppStoreのようなプラットフォームストアの一つと通信し、購入を完了する。定義されたエンドポイントは、このトランザクションの通知を受信します。

購入から通知までの流れを示す例を見てみましょう。架空の会社、AcmeSymphonyはエンドポイントを実装しました。iOSでBrightcove Beaconアプリを使っている視聴者が購入する。次に、ハイレベルワークフローを示します。

この文書の残りの部分では、技術的な実装について説明し、エンドポイントの実装に関する詳細を説明します。

通知の実装方法

プロセスの概要図を次に示します。

アプリ購入時の概要ビーコン

図の明確化の詳細:

通知の使用上のガイドライン

次に、通知の使用上のガイドラインを示します。

APIエンドポイントの仕様

Beaconシステムでサブスクリプションを正常に処理した後、Beaconは特定の顧客に固有の設定済みAPIエンドポイントにSNSトピックメッセージを配信します。

外部エンドポイントの要件は次のとおりです。

エラーから回復するために、ユーザに対してすべての購入を再送信できます(非アクティブな通知をフィルタリング)。ストアの外部APIエンドポイントは、すべてのメッセージが以前に消費された場合でも、すべてのメッセージを再処理する責任があります。

JSONペイロードの仕様

外部ストアエンドポイントに送信されるJSONペイロードには、次のフィールドを含めることができます。

名前 タイプ 必須 使用可能な値
notification_type 文字列 常に 新着更新するキャンセル一時停止所有履歴書
  • 新着- 新しいサブスクリプションのために発行された
  • 更新する- 既存のサブスクリプションを更新するために使用 (サブスクリプションを延長)
  • キャンセル- 既存の購入をキャンセルする
  • 所有- 未払いのためサブスクリプションが保留されました
  • 一時停止- サブスクリプションがユーザーによって一時停止されました
  • 履歴書- サブスクリプションの保留または一時停止から継続への移行
  • external_user_id 文字列 常に これは、ビーコンと外部ストアがユーザを識別するために一般的に使用するIDです。
    transaction_id 文字列 常に トランザクションの一意の識別子。解約が完了したら、このIDを利用して加入または個別購入を解約しなければならない。サブスクリプションが更新、再開、一時停止、または保留になると、このIDを使用して影響を受ける特定のサブスクリプションを検索します。
    開始日 整数 キャンセル通知を除き、はい 購入が有効になり、ユーザーの資格が開始されるべき日付
    終了日 整数 通知タイプに必要:新規、更新、キャンセル、および再開 購入が無効になり、ユーザーに対する資格が終了する日付です。キャンセル依頼につきましては、終了日ユーザーがいつコンテンツにアクセスできなくなるかを定義します。
    オリジナルストア 文字列 常に アップルストアグーグルプレイアマゾンストアロクストアエバージェントビーコンストア 購入した元の店舗
    スクー 文字列 常に 購入したアイテムを識別します。これは、ソースストアで使用されるIDです。
    package_name 文字列 常に Brightcove BeaconのSVODまたはTVODパッケージの名前
    notification_date 整数 常に ビーコンから外部ストアシステムにイベントをディスパッチするタイムスタンプ
    cancancelation_date 整数 通知タイプがキャンセルの場合に必要です。 キャンセル要求に使用され、ユーザ/ストアがサブスクリプションをキャンセルしたときのタイムスタンプを指定します。
    trial_end_date 整数 オプション(新規登録にのみ適用) 存在するということは、裁判があるということです。新しいサブスクリプションの場合、トライアルの終了日が同じである可能性があります終了日(ストアがトライアル用の通知を 1 つ送信し、実際のサブスクリプションの開始時に 2 つ目の通知を送信するユース ケース)。