Adjustでは、統計目的でのサードパーティとのデータ共有を管理できるようになりました。この機能により、ユーザーデータの扱い方により多くの選択肢が提供されます。ここでは、サーバー間連携(S2S)でサードバーティとのデータ共有を(再)有効化、または無効化する方法を説明します。
エンドポイント
APIエンドポイントのリクエストのアドレスは次のとおりです。
https://s2s.adjust.com/third_party_sharingAPIをリクエストするには、POSTを使用します。エンドポイントパラメーターをURLまたはフォームデータとして送信することもできます。
必須パラメーター
| パラメータ名 | 値 |
|---|---|
| gps_adid、idfa | デバイスIDの文字列。少なくとも1つのデバイスIDが必要です。このAPIは、他のAdjust S2S APIでサポートされているものと同じデバイスIDをサポートします。 |
| s2s | 常に1 |
| app_token | アプリトークン |
| sharing | enable またはdisableにすることで、サードパーティーとの共有を許可または禁止します。 |
| partner_sharing_settings | アップデートされたパートナー設定。 |
| granular_third_party_sharing_options | パートナー向けの詳細なサードパーティ共有オプション。 |
グローバル設定
allパラメーターは、パートナー共有設定を簡素化するための柔軟に使用できるショートカットです。
allが partner name に使用されている場合、設定は全てのパートナーに適用されます。allが activity name (インストールやセッションなど)に使用されている場合、設定は全てのアクティビティタイプに適用されます。- 両方を組み合わせることで、 全てのパートナーに対して全てのアクティビティ を適用または制限することができます。
これを使用することで、広範囲の共有を無効または有効にし、特定のパートナーやアクティビティタイプを選択して再度共有することができます。
パートナー共有設定を更新する
個々のパートナーのサードパーティ共有設定を更新するには、更新された設定をpartner_sharing_settingsパラメーターとして渡す必要があります。サードパーティ共有設定は、URLがエンコードされたオブジェクトとして渡す必要があります。複数のオブジェクトを渡すことで、複数の設定を一度に変更できます。
各パートナー共有設定フォームで以下のキーを渡す必要があります。
| パラメータ名 | 値 |
|---|---|
| partnerName | 共有設定を更新したいパートナーのIDまたは名前。利用可能なパートナーの全リストをダウンロード |
| key | パートナーとの共有を停止または開始するデータ。 |
| value | 指定したデータのパートナー共有を有効化(true)または無効化(false)。 |
keyを使用すると、無効化または再有効化する指標を指定できます。全ての指標の共有を有効化/無効化するには、 allキーを使用します。利用可能な指標のリストは以下をご覧ください。
- ad_revenue
- all
- update
- att_update
- event
- install
- reattribution
- reattribution_reinstall
- reinstall
- rejected_installs
- rejected_reattribution
- sdk_click
- sdk_info
- session
- subscription
- uninstall
指標グループ
パートナーの指標に対してfalse値を設定すると、Adjustはパートナーに対し、その指標と、そのグループ内の全ての子指標の共有を停止します。これらの指標と子指標の関係性は以下の通りです。
-
session
-
install
- rejected_installs
-
reinstall
-
reattribution
-
rejected_reattribution
-
reattribution_reinstall
-
-
sessionの共有を無効にすると、その全ての子指標も無効になります。 -
sessionの共有を無効にし、reattributionを有効にすると、reattributionを除く全ての子指標が無効になります。 -
sessionの共有を無効にし、installを有効にすると、installを除くsessionの全ての子指標が無効になります。installの子指標は有効なままです。 -
sessionの共有を有効にし、installを無効にすると、installを除くsessionの全ての子指標が無効になります。installの子指標は無効なままです。
ユースケース
一般的なユースケースは以下のとおりです。これらの例では、Android SDKとS2S向けのcurlを使用しています。iOSの場合でも、プラットフォーム固有の構文を使用して同じロジックで実装できます。
パートナーA以外の全てのパートナーアクティビティの共有を無効にする
Adjustは、全てのデータをパートナーAのみと共有します。
curl -G \--data-urlencode 's2s=1' \--data-urlencode 'app_token=36wbd8gmlvsw' \--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \--data-urlencode 'partner_sharing_settings={"all":{"all":false},"PartnerA":{"all":true}}' \https://s2s.adjust.com/third_party_sharingセッションアクティビティを除く全ての共有を無効にする
Adjustは、 セッション とその関連イベント(インストールやリアトリビューションなど)を除く、全てのパートナーデータの共有を停止します。
curl -G \--data-urlencode 's2s=1' \--data-urlencode 'app_token=36wbd8gmlvsw' \--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \--data-urlencode 'partner_sharing_settings={"all":{"all":false,"session":true}}' \https://s2s.adjust.com/third_party_sharingセッションアクティビティの共有をパートナーAにのみ許可する
セッション と関連イベント(インストールまたはリアトリビューションなど)を除き、パートナーとのデータ共有は全て無効になります。
curl -G \--data-urlencode 's2s=1' \--data-urlencode 'app_token=36wbd8gmlvsw' \--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \--data-urlencode 'partner_sharing_settings={"all":{"all":false},"PartnerA":{"session":true}}' \https://s2s.adjust.com/third_party_sharingダイナミックコールバックのみ無効にする
これにより、通常のパートナー連携に影響せずに、動的に作成されるコールバックとの共有が無効になります。
curl -G \--data-urlencode 's2s=1' \--data-urlencode 'app_token=36wbd8gmlvsw' \--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \--data-urlencode 'partner_sharing_settings={"dynamic_callbacks":{"all":false}}' \https://s2s.adjust.com/third_party_sharingエラー処理
third_party_sharing endpointは、HTTPレスポンスステータスコードを使用して、各リクエストのステータスを伝達します。以下のステータスコードが返された場合:
200
リクエストの全てが有効であり、適用されています。
{ "status": "OK"}202
パートナーIDが存在しない、共有オプションのフォーマットが適切でないなど、リクエストの一部が無効です。有効な部分が適用され、エンドポイントはリクエストの問題の詳細を返します。
{ "error": "Third party sharing failed (<error_message>)"}400
リクエストのフォーマットが適切でない、必須パラメーターが含まれていない、あるいは有効なデータが含まれていません。
{ "error": "Third party sharing failed (App not found)"}Googleに同意データを提供する(デジタル市場法へのコンプライアンス)
EUのデジタル市場法(DMA)に準拠するため、Google 広告およびGoogle マーケティング プラットフォームは、AdjustからAPIへのアトリビューションリクエストを受信することに明示的な同意を必要とします。
ユーザーが同意の回答を変更した場合、Adjustのサードパーティ共有APIを再有効化/無効化してAdjustと共有することができます。リクエストに以下のパラメータを含めてください。
| キー | 値 | 説明 |
|---|---|---|
| EEA |
| eeaパラメーターは、ユーザーがEEA内にいるかどうか、つまりこのユーザーとコンバージョンにDMAなどの欧州の規制が適用されるかどうかをGoogleに通知します。 パラメーターのタイプはbooleanです。 |
| ad_personalization |
| Google 広告 (Google Ads)が対象。ad_personalizationパラメーターは、アプリのインストール後にユーザーがGoogle 広告でパーソナライズド広告を受け取ることに同意したかどうか、つまりGoogleがユーザーをリターゲティングできるかどうかを示します。 |
| ad_user_data |
| ad_user_dataパラメーターは、ユーザーが計測目的で個人データを共有することに同意したかどうかをGoogleに通知します。この同意は、広告主がGoogle 広告およびGoogle Marketing Platform UIで指定した全てのコアプラットフォームサービス(CPS)に適用されます。 |
| npa |
| Google マーケティング プラットフォーム が対象。npaパラメーターは、アプリのインストール後にユーザーがGoogle マーケティング プラットフォームを介したパーソナライズド広告の表示に同意したかどうか、つまりGoogleがユーザーをリターゲティングできるかどうかを示します。 |
Google 広告と連携している場合はad_personalizationパラメーターを、Google マーケティング プラットフォームと連携している場合はnpaパラメーターを送信する必要があることにご注意ください。
例
curl -X POST \ 'https://s2s.adjust.com/third_party_sharing?s2s=1&sharing=enable&app_token=abc123abc123&gps_adid=10820328-872d-43a2-9786-0ccc748335d9' \ -H 'Content-Type: application/json' \ -d '{ "granular_third_party_sharing_options": { "google_dma": { "ad_personalization": "1", "eea": "1", "ad_user_data": "1", "npa": "0" }