どのようにお手伝いできますか?

パートナー向けData Locker

  • 更新

概要:パートナー向けData Lockerは、アプリのデータを、パートナー(アドネットワークや代理店)が所有するAWS、GCS、BigQueryのストレージに配信します。

6133DataLockerForPartners.png

パートナー向けData Locker

パートナー向けData Lockerは、アプリのデータをクラウドストレージに配信します。広告主が権限を設定することで、AppsFlyerから対象のパートナーに、指定したデータを共有できるようになります。 

Data Lockerの機能

機能 説明
保存先の選択肢(クラウド)

以下のサービスでパートナー自身が所有するストレージ(バケット):

  • AWS 
  • GCS
  • Yandex
  • BigQuery

保存先の詳細

複数アプリへの対応

パートナーと連携しているアプリのデータに対応しています。データを受け取るには、広告主からレポートごとに権限を付与してもらう必要があります。 

データ形式の選択肢
  • クラウドストレージのバケットの場合:
    • CSV
    • Parquet
    • Adobe
  • データウェアハウス
更新頻度

更新頻度はレポートの種類によって異なります。

  • 毎時:継続的に生成されるデータ
  • 日次:一部のレポートは1日単位で作成され、翌日に利用可能になります。

パートナーが利用できるレポート

利用できるレポートと、取得に必要な権限は、パートナーの種類によって異なります。ただし、Data Lockerの仕組み、保存先の選択肢、必要な設定は、パートナーの種類にかかわらず共通です。パートナーの種類に応じて、以下の記事を参照してください。 

データの保存構成

概要

データは、選択した保存先に書き込まれます。保存先はいつでも切り替えられます。変更は数時間以内に反映されます。 

クラウドストレージのバケット内では、レポートの種類、日付、時刻に応じた階層構造のフォルダにデータが保存されます。以下の図は、この構造の例です。

DLFolderOVerview.png

各レポートのデータは、そのレポートの時間別フォルダ(hフォルダ)に保存されます。

  • 時間別フォルダの数は、レポートの配信頻度が毎時か日次かによって異なります。
  • データはParquetまたはCSV形式で提供され、圧縮方式はSnappy、GZIP、非圧縮のいずれかです。
  • データファイルは、複数の列(フィールド)で構成されています。
  • 列の構成は、レポートの種類ごとに定義されています。 

フォルダ構成

フォルダ 説明 
data-locker-hourly

DLHourly.png

  • バケットの最上位フォルダは、ストレージサービスによって異なります。
  • data-locker-hourlyフォルダには、レポートのトピックごとのフォルダが含まれます。 

バケットの所有者とクラウドサービスに応じたフォルダ構成の例:

  • パートナー所有のAWSバケット:<af-datalocker-your bucket prefix>/<generated-home-folder><subscription-id>
  • パートナー所有のGCSバケット:<your bucket name>/<generated-home-folder>/<subscription-id>
t(トピック) レポートの内容に応じた種類を表します。 
dt(日付)

対象データの日付です。通常は、イベントが発生した日を表します。 

h(時刻)

hフォルダは、AppsFlyerがデータを受信した時間帯に対応しています。たとえば、14:00~15:00(UTC)に受信したインストールイベントは、h=14のファイルに配信されます。注意:データがAppsFlyerに届いてから、対応するhフォルダがData Lockerに配信されるまでには、約6時間の遅延があります。たとえば、h=14フォルダは、その6時間後の23:00(UTC)に配信されます。 

フォルダの特徴:

  • hフォルダは、0~23の番号が付いた24個のフォルダで構成されます。例:h=0、h=1など。 
  • これに加えて、前日分のイベントが日付をまたいで到着した場合(翌日の00:00~02:00 UTCに到着した場合)は、lateフォルダに保存されます。たとえば、月曜日の08:00にアプリがインストールされ、そのイベントが火曜日の01:00に届いた場合、月曜日のlateフォルダに記録されます。 
  • 02:00以降に到着したデータは、実際に到着した日時のフォルダに記録されます。 
  • データを取り込む際は、lateフォルダのデータも必ず使用してください。このデータは、ほかのフォルダには含まれていません。 
  • _temporaryフォルダ:hフォルダ内に、一時フォルダが生成される場合があります。一時フォルダとそのサブフォルダは、処理の対象から除外してください。例:/t=impressions/dt=2021-04-11/h=18/_temporary。
全アプリをまとめたデータ

すべてのアプリのデータが、共通のデータファイルにまとめて提供されます。取り込み時は、各行のapp_idフィールドでアプリを識別してください。

h=2フォルダ内のデータファイルの例

UnifiedByApp.png

  • データを取り込む際は、以下を確認してください。
    • _SUCCESSフラグが設定されてから、データの処理を開始してください。
    • 拡張子が.gzのファイルをすべて取り込んでください。
完了フラグ

対象のhフォルダへの書き込みが最後のデータファイルまで完了すると、完了フラグが設定されます。 

  • _SUCCESSフラグの存在を確認するまでは、フォルダ内のデータを読み込まないでください。

  • フォルダにデータが書き込まれない場合でも、_SUCCESSフラグは設定されます。つまり、空のフォルダにも設定されます。

圧縮

ファイルはgz形式で圧縮されます。展開後のファイルには、以下の特徴があります。

  • 拡張子は付きません。
  • 各ファイルのヘッダー行には、列名(フィールド名)が含まれます。 
列の順序

レポート内のフィールドの順序は常に一定です。新しいフィールドは、既存のフィールドの右側に追加されます。 

列(フィールド)の定義は、レポートごとに決まっています。詳細は、該当するレポートの記事を参照してください。 

フィールドの値に関する注意事項

空欄のフィールド:フィールドによっては、値がnullになっているか、空欄になっている場合があります。これは、そのレポートでは出力するデータがないことを意味します。通常、nullは、対象のレポートやアプリの種類では、そのフィールドに値が入らないことを示します。空文字列「""」は、そのフィールドは適用対象であるものの、入力するデータが見つからなかったことを示します。 

タイムゾーンと通貨:

Data Lockerで提供されるデータには、アプリごとのタイムゾーンと通貨の設定は適用されません。以下の設定が適用されます。 

  • タイムゾーン:日付と時刻はUTCです。
  • 通貨:event_revenue_usdフィールドの値は米ドルです。

カンマを含む値:`"iPhone6,1"`のように、値全体がダブルクォーテーション(`"`)で囲まれます。

データファイル

データファイルの構成は、データの分割方法によって異なります。

内容 詳細
完了フラグ

対象のhフォルダへの書き込みが最後のデータファイルまで完了すると、完了フラグが設定されます。 

  • _SUCCESSフラグの存在を確認するまでは、フォルダ内のデータを読み込まないでください。

  • 対象のフォルダに書き込むデータがなく、フォルダが空の場合でも、_SUCCESSフラグは設定されます。 

  • 注意:アプリごとにデータを分割する設定では、フラグは各アプリのフォルダではなく、hフォルダに設定されます。前のセクションの図を参照してください。 
ファイルの種類
  • データはParquetまたはCSV形式で提供され、圧縮方式はSnappy、GZIP、非圧縮のいずれかです。
  • 展開後のデータファイルは、設定に応じてParquetまたはCSV形式になります。
列の順序(CSVファイル) 

CSVファイルでは、レポート内のフィールドの順序は常に一定です。新しいフィールドは、既存のフィールドの右側に追加されます。 

列の構成については、以下の点も確認してください。 

  • ユーザージャーニーレポートの列構成は共通です。そのため、異なる種類のレポートでも、同様の手順でデータを取り込めます。レポートに含めるフィールドは選択できます。 各フィールドの意味は、ローデータのフィールド定義を参照してください。 
  • 利用可能なレポートの一覧で「FF」と記載されているレポートは、この共通の列構成には従いません。 
フィールドの値に関する注意事項

空欄のフィールド:フィールドによっては、値がnullになっているか、空欄になっている場合があります。これは、そのレポートでは出力するデータがないことを意味します。通常、nullは、対象のレポートやアプリの種類では、そのフィールドに値が入らないことを示します。空文字列「""」は、そのフィールドは適用対象であるものの、入力するデータが見つからなかったことを示します。 

データの共有に制限がある媒体の場合、制限対象のフィールドの値はnullになります。 

基本的には、nullも空欄も、利用できるデータがない状態として扱ってください。 

タイムゾーンと通貨

アプリごとのタイムゾーンと通貨の設定は、Data Lockerに書き込まれるデータには影響しません。以下の設定が適用されます。 

  • タイムゾーン:日付と時刻はUTCです。
  • 通貨:event_revenue_usdフィールドの値は米ドルです。

カンマを含む値:`"iPhone6,1"`のように、値全体がダブルクォーテーション(`"`)で囲まれます。

保存先の選択肢

  • データは、AWS、GCS、BigQueryのうち、選択した保存先に書き込まれます。
  • 保存先はいつでも変更できます。
  • 保存先を変更すると、以下のように処理されます。
    • 1時間以内に、新しい保存先へのデータの書き込みが開始されます。
    • 変更前の保存先にも、7日間の移行期間中は引き続きデータが書き込まれます。移行期間の終了日時は、管理画面に表示されます。移行期間中に、データの取り込み処理を更新してください。 
    • バケットの変更:保存先を変更すると、7日間の移行期間中は両方の保存先にデータが送信されるため、その間にデータの取り込み処理を調整できます。 
  パートナー所有のストレージ(GCS、AWS、BigQuery)
バケット名
  • GCS:制限なし
  • AWS:パートナー自身で設定します。接頭辞としてaf-が必要です。

例:af-datalocker-your-bucket-name

ストレージの所有者 パートナー 
ストレージのプラットフォーム AWS, GCS, Yandex, BigQuery
パートナーがデータにアクセスするための認証情報 AppsFlyerでは、この認証情報を把握していません。ストレージサービスから提供された認証情報を使用してください。
データの保存期間 パートナー自身で管理します。
セキュリティ

ストレージはパートナー自身で管理します。 

  • AWS:AppsFlyerには、バケットに対するGetObject、ListBucket、DeleteObject、PutObjectの権限が必要です。バケットはAppsFlyer専用にしてください。ほかの用途には使用しないでください。
  • GCS

セキュリティ担当者への注意事項

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

  • バケットまたは保存先は、AppsFlyer専用にしてください。 AppsFlyer以外から、バケットにデータが書き込まれないようにしてください。
  • AppsFlyerがデータを書き込んでから25時間が経過した後は、バケット内のデータを削除できます。
  • 保存先に書き込まれるデータは、AppsFlyerのサーバーにあるデータのコピーです。 AppsFlyerのサーバーでは、当社の保存ポリシーに従ってデータが引き続き保持されます。 
  • 技術的な理由により、データを削除してから書き込み直す必要が生じる場合があります。そのため、削除権限と一覧取得権限が必要です。一覧取得権限も削除権限も、パートナーにとってセキュリティ上のリスクとなるものではありません。一覧取得については、バケットに書き込みを行うのがAppsFlyerだけであるためです。削除については、データを再生成できるためです。 

複数の接続先を使用する場合

Data Lockerでは、データの一部またはすべてを、接続設定で指定した複数の保存先に送信できます。たとえば、アプリAのデータをAWSに、アプリBのデータをGCSに送信できます。

各接続には、保存先を含むData Lockerの設定一式が含まれます。それぞれの接続設定は独立しています。

接続を管理する際は、以下の点を確認してください。

  • Data Lockerの設定では、接続はタブで表示されます。接続ごとに専用の設定タブがあり、そのタブから接続を管理できます。デフォルトのタブ名は「Data Locker」です。
  • 新しい接続を作成するには、以下の手順を実行します。
    1. [接続を追加]をクリックします。
    2. 接続名を入力し、ストレージの種類を選択します。
    3. [保存]をクリックします。
      保存すると、デフォルトの「Data Locker」タブの横に、新しい接続が表示されます。各タブのアイコンは、ストレージの種類を表します。
  • 接続の詳細表示、複製、削除を行うには、[⋮(オプション)]をクリックします。

設定手順

Data Lockerの設定

以下の手順でData Lockerを設定します。設定の変更は3時間以内に反映されます。 

事前準備:

以下のうち、使用する保存先の設定を1つ以上完了してください。

  • AWSバケット
  • GCSバケット
  • [Beta機能]Yandexバケット
  • BigQueryデータウェアハウス

AppsFlyerAdmin_us-en.png Data Lockerを設定するには、以下の手順を実行します。

  1. AppsFlyerのパートナー管理画面にログインします。
  2. 次の場所に移動します。
    • 広告主:AppsFlyerのサイドバーで、[エクスポート] > [Data Locker]を開きます。
    • マーケティングパートナー:アカウントメニュー > [Data Locker]をクリックします。
  3. Data Lockerの設定手順のステップ3~16を実行します。

補足情報

仕様と制限事項

項目 説明 
アプリごとのタイムゾーン 対象外
アプリごとの通貨  非対応
サイズの制限 対象外
更新頻度 データは、本記事で説明している各レポートの更新頻度に従って更新されます。
過去のデータ

非対応

チームメンバーのアクセス チームメンバーはData Lockerを設定できません。 

トラブルシューティング

トラブルシューティングガイドを参照してください。