サーバー間(S2S)イベント

サーバー間(S2S)イベントAPIを使用して、HTTPリクエストでイベントデータをAdjustに送信します。インストール、セッション、リアトリビューションを記録するにはAdjust SDK、カスタムイベントはS2S APIのみを使って送信してください。

S2SイベントをiOS 14以降のアプリに設定している場合、Adjustはconversion valueをS2Sレスポンスとしてサーバーに送信します。その後、お客様のサーバー側でアプリ内のconversion valueを更新する必要があります。この仕組みの詳細については、iOS 14以降でのサーバー間S2Sイベントのサポートを参照してください。

注意:

アトリビューションの場合、AdjustはSDKから送信されたクリックとS2Sクリックを区別しません。アトリビューションウォーターフォールモデルでは、これらは同じものと見なされます。

この記事では、S2Sイベントの記録の設定方法とトラブルシューティングを紹介します。

エンドポイント

S2SイベントAPIは、以下のエンドポイントを使用します:

https://s2s.adjust.com/event

サーバー間(S2S)イベントを送信する

/event エンドポイントは、サーバー間イベントの以下のリクエストを受け入れます:

  • URLパラメーターを含むGET。
  • URLパラメーターを含むPOST。
  • bodyパラメーターを含むPOST。Content-Typeapplication/x-www-form-urlencodedに設定する必要があります。

サーバー間(S2S)セキュリティの設定

S2Sセキュリティを設定してS2Sイベントのセキュリティを保証し、スプーフィングされたリクエストからアプリを保護します。そのためには、受信するリクエストごとに、Adjustダッシュボードで生成されたトークンが付与されている必要があります。トークンが付与されていないリクエスト、または不正なトークンが付与されたリクエストは、Adjustのサーバーによって拒否されます。

設定するには、S2Sセキュリティに関する記事の手順に従ってください。

必要なパラメーター

重要:

サーバー間イベントのパラメーターは大文字と小文字を区別します。

/event エンドポイントには、各リクエストで以下のパラメーターが必要です:

  1. idfa (iOS) や gps_adid (Android) などの広告ID
  2. イベントトークン。
  3. アプリトークン。
  4. リクエストがサーバー間であることをエンドポイントに通知するためのハードコーディングされたs2s=1パラメーター。
パラメーター説明
idfa (iOS) や gps_adid (Android) などの広告ID使用可能なKPIリストをご覧ください。idfa=D2CADB5F-410F-4963-AC0C-2A78534BDF1E

gps_adid=660e1d86-6796-463a-be86-897993136018
event_token管理画面で取得できるAdjustイベントトークンevent_token=f0ob4r
app_token管理画面で取得できるAdjustアプリトークンapp_token=4w565xzmb54d
s2s1に設定されたS2Sパラメーターs2s=1

イベント送信に推奨されるその他のパラメーター

正確なイベントアトリビューションを行うには、イベントに以下のパラメーターを含めてください。

重要:

iOSデバイスの場合は、adid広告IDを使用してください。これにより、IDFAを取得できない場合でもデバイスデータを一致させることができます。

パラメーター説明
adidデバイスに関連付けられたAdjust ID。IDFAの情報がない場合、iOSでLATユーザーを識別するために使用できます。adid=18546f6171f67e29d1cb983322ad1329
ip_addressデバイスのIPアドレス。イベントをサードパーティ(例:Googleと連携)し、コールバックに位置関連情報(例: citypostal_code)を含めます。

ip_addressパラメーターは、IPv4アドレスのみを受け入れます。現在、IPv6はサポートされていません。
ip_address=192.0.0.1
created_at_unix(推奨)

または

created_at
イベントが発生した日時。created_at_unix=1484085154

または

created_at=2017-01-02T15:04:05.000+0000
user_agentデバイスの ユーザーエージェント。URLエンコードされている必要があります。user_agent=Mozilla%2F5.0%20%28iPhone%3B%20CPU%20iPhone%20OS%2016_6%20like%20Mac%20OS%20X%29%20AppleWebKit%2F605.1.15%20%28KHTML%2C%20like%20Gecko%29%20Version%2F16.5%20Mobile%2F15E148%20Safari%2F604.1

イベントのタイムスタンプ

イベントのタイムスタンプは、 created_at_unix パラメーターまたはcreated_atパラメーターを使用して指定できます。

  • created_at_unix:イベントが送信された時点のUNIXタイムスタンプ。例:1484085154
  • created_atISO 8601形式でURLエンコードされたタイムスタンプ。例:2023-01-02T15%3A04%3A05.000%2B0000
重要:

リクエストでタイムスタンプを送信しない場合、Adjustはイベントを受信した時間をイベント日として使用します。

以下の点を確認してください:

  • イベントは、リクエストのタイムスタンプに沿って、発生順にデバイスとイベントトークンごとに送信する必要があります。Adjustが受信したイベントのタイムスタンプが、記載されたデバイスとイベントに対して以前に受信したものよりも前のイベントを受信した場合、そのイベントは拒否されます。
  • 全てのイベントは58日以内に送信される必要があります。58日以上前のタイムスタンプを持つイベントは拒否されます。

カスタムデータを共有する

コールバックとパートナーパラメーターを使用して、カスタムイベントデータをAdjustに送信します。コールバックパラメーターはローデータエクスポートで利用でき、パートナーパラメーターはネットワークパートナーと共有されます。

リクエストにパラメーターを追加するには、以下のパラメーターを使用します:

  • callback_params文字列​ のキーと値のペアを含む、URLエンコードされたJSONオブジェクト。
  • partner_params文字列​ のキーと値のペアを含む、URLエンコードされたJSONオブジェクト。
重要:

カスタムデータオブジェクト内でオブジェクトをネストしないでください。

エンコードされていない例
エンコードされた例
{"f0o":"bar","bar":"baz"}

ローデータエクスポートでコールバックパラメーターを受信するには、S2Sコールのcallback_paramsパラメーターにデータを追加します。

curl --location https://s2s.adjust.com/event?s2s=1&event_token=f0ob4r&app_token=4w565xzmb54d&idfa=8A3CB124-5A79-4334-8802-F75FEC099C58&callback_params=%7B%22f0o%22%3A%22bar%22%2C%20%22bar%22%3A%22baz%22%7D

イベント情報をネットワークパートナーに送信するには、S2Sコールのpartner_paramsパラメーターにデータを追加します。

curl --location https://s2s.adjust.com/event?s2s=1&event_token=f0ob4r&app_token=4w565xzmb54d&idfa=8A3CB124-5A79-4334-8802-F75FEC099C58&partner_params=%7B%22f0o%22%3A%22bar%22%2C%20%22bar%22%3A%22baz%22%7D

収益イベントの記録

S2S収益イベントを記録するには、イベント送信に以下の収益パラメーターを追加します:

パラメーター説明
revenue

完全な通貨単位での収益イベントの値
(149.99 = $149.99)。Adjustのサーバーは
このパラメーターの最低値を0.001としています。

currencyイベントに関連付けられた 通貨コード
environmentデータの送信先環境
( environment=sandboxまたは
environment=production)。
デフォルトは productionです。

リクエストの例

URLパラメーターを使用したGET
URLパラメーターを使用したPOST
本文を含むPOST
curl --location 'https://s2s.adjust.com/event?s2s=1&event_token=f0ob4r&app_token=4w565xzmb54d&idfa=D2CADB5F-410F-4963-AC0C-2A78534BDF1E&created_at=2017-01-02T15%3A04%3A05Z%2B0200&callback_params=%7B%22f0o%22%3A%22bar%22%2C%20%22bar%22%3A%22baz%22%7D&partner_params=%7B%22f0o%22%3A%22bar%22%2C%20%22bar%22%3A%22baz%22%7D&currency=EUR&revenue=123.4&environment=sandbox'