Fanplayr Docs

日本語

English
Español
Italiano

日本語

English
Español
Italiano

Appearance

カスタムAPI ​

はじめに ​

Fanplayr 360へのデータ取り込みのためのプラットフォームを_まだ_サポートしていない場合があるため、当社はシステムと直接連携してデータを追加できる強力なAPIを提供しています。

カスタムAPIを使用して、サーバーまたはモバイルアプリからデータを送信できます。選択肢は無限大です。

JavaScript APIは、内部的に全く同じ呼び出しを使用しています。

メッセージの送信 ​

Fanplayr 360にデータを送信するには、まずカスタム統合を作成して、WRITE_KEY と ENDPOINT を取得する必要があります。

APIの呼び出しは、以下の詳細を含むHTTPSリクエストを行うのと同じくらい簡単です。

  • URL:https://<ENDPOINT>/v1/collect
  • メソッド:POST
  • ヘッダー
    • content-type: application/json
    • x-api-key: <WRITE_KEY>
  • ボディ：メッセージの配列を含むJSON文字列

リクエスト例 ​

WARNING

APIは約250KBまでのメッセージしか処理できないため、1回の呼び出しで20個以内のメッセージをAPIに送信してください。

メッセージ構造 ​

Fanplayr 360に送信する各メッセージには、基本的なデータセットが含まれている必要があります。

基本メッセージ ​

  • messageId - 送信するすべてのメッセージには、一意の識別子を含める必要があります。UUID、nanoID、またはulidの使用をお勧めします。
  • writeKey - x-api-keyで送信されるWRITE_KEYも、ここに指定する必要があります。
  • timestamp - イベントが発生した時刻をISO-8601形式およびUTCタイムゾーン（例: "2023-01-23T15:34:48Z"）で指定します。
  • type - メッセージのタイプ。
  • userId - このユーザーの一意の識別子。異なるセッションで同じuserIdが指定された場合、メッセージは同じユーザーからのものとして扱われます。これは、identifyコールを使用したIDの管理とは別です。
  • sessionId - セッションの一意の識別子。詳細については、セッションの処理を参照してください。
  • pageId - 現在のページ/画面表示の一意の識別子。これはイベントを関連付けるために使用されます。詳細については、ページビューの追跡を参照してください。

基本的なメッセージ構造には、送信されるtypeに応じて、context、properties、identities、およびoperationsが含まれる場合と含まれない場合があります。

  • context - 任意のメッセージタイプで使用できます。
  • properties - trackまたはpageタイプでのみ使用してください。
  • identities - identifyタイプでのみ使用してください。
  • operations - userDataOpsおよびconsentタイプでのみ使用してください。

コンテキスト ​

コンテキストは、ユーザーが現在いるページや画面に関する情報、位置情報のためのIPアドレス、ブラウザやデバイスの種類を追跡するためのuserAgentを追跡するために使用されます。

  • page
    • url - ウェブサイトで追跡している場合、ページのURL。
    • referrer - ウェブサイトで追跡している場合、参照元のページのURL。
    • type - ページを表す文字列。任意の値を使用できますが、一部の値は機能を追加します。詳細については、JavaScript API / ページの追跡を参照してください。モバイルアプリの「画面」を表すためにも使用できます。
    • title - ウェブサイトまたはアプリ画面のページタイトル。
  • ipAddress - ユーザーのデバイスのIPアドレス、またはこのメッセージが送信されたサーバー/デバイスのIPアドレス。これは、$countryなどの追加属性を生成するために使用されます。
  • userAgent - ブラウザからのユーザーエージェント文字列、または携帯電話などのデバイスタイプのために定義されたもの。これは、$deviceなどの追加属性を生成するために使用されます。

プロパティ ​

プロパティは、イベントとともに追跡したい任意のキー/値のペア、またはセマンティックオブジェクトです。これは、trackまたはpageタイプのメッセージでのみ使用してください。

INFO

プロパティのkeyは任意の文字列値にできます。値の先頭に「$」を付けないことを強くお勧めします。これは生成される属性を上書きする可能性があるためです。また、「myKeyName」のようなキャメルケースのキーを使用し、非ASCII文字を避けるのが良い習慣です。そうしないと、データをエクスポートする一部のシステムで問題が発生する可能性があります。

INFO

string、number、boolean型で送信できますが、Fanplayr 360ではすべてのデータが文字列として保存されます。

ID ​

IDは、システムがユーザーとセッションを識別およびマージする方法を知らせるキー/値のペアです。これは、メッセージタイプidentifyにのみ提供されるべきです。

オペレーション ​

操作は、userDataOpsおよびconsentタイプのメッセージでのみ使用してください。サポートされるプロパティはそれぞれ異なります。

userDataOps ​

次のステップ ​

引き続き、各メッセージタイプの使用方法と例についてご確認ください。

Copyright © 2011-present Fanplayr Inc