デジタル プラットフォーム API - 販売者 CMP 分析レポート

販売者 CMP (同意管理プラットフォーム) 分析レポートは、エンドポイントへの販売者広告リクエストに関する IAB 透明性 & 同意フレームワーク (IAB TCF) 文字列の数、有効性、内容に関する分析情報を提供します。 このレポートにより、販売者は次のような質問に答えることができます。

• TCF V1 および V2 の仕様に従ってエンコードされた TCF 文字列を含む広告要求はいくつですか?
• 適切にエンコードされていないため、無効または形式が正しくない TCF 文字列を含む広告要求はいくつありましたか?
• CMP (同意管理プラットフォーム) は、アクセス許可情報を正しく渡していますか?

概要

このレポートは、法律や規制の遵守を証明または反証するものではありません。 このレポートの "GDPR 適用" という文言は、TCF ロジックが適用されたことを意味します。 弊社はIAB TCFをサポートしており、このレポートにより、TCFを使用する出品者はTCFシグナルが正しく通信されていることを確認できます。

レポートを取得する手順については、「 Report Service 」または次の 例 を参照してください。

すべての広告リクエストをIAB TCF標準とポリシーに従って処理することを希望する販売者は、IAB OpenRTB仕様に従って'gdpr=1'を渡すことで、TCFロジックの適用を強制できます。GDPR パラメーターを省略しても、要求に IAB OpenRTB 仕様に従った TCF 文字列が含まれている場合、オークションにも TCF ロジックが適用されます。

特定のパブリッシャーに関する文字列の数が多い場合、文字列の形式が正しくない場合は、通常、パブリッシャーの CMP が TCF 仕様に従って文字列を作成もエンコードもしていないため、ベンダーが読み取れないことを意味します。 判読できない文字列はベンダーに明確なシグナルを提供できないため、どのベンダーにとっても許可されていないものとして扱われ、避ける必要があります。

IAB TCF について詳しくは、以下のリソースを参照してください。

• IAB Europe の TCF ポリシー
• IAB Europe の TCF ガバナンス
• IAB Techlab TCF v1 および v2 技術仕様 & 実装ガイド
• IAB Techlab TCF RTB 仕様

時間枠

JSON 要求の report_interval フィールドは、次のいずれかに設定できます。

• カスタム
• last_7_days
• month_to_date
• last_30_days

データ保持期間

このレポートのデータ保持期間は 30 日です。

Dimensions

指標

例

JSON レポート要求の作成

JSON ファイルには、取得する列 (ディメンションとメトリック) とreport_intervalだけでなく、"cmp_analytics"のreport_typeを含める必要があります。 また、特定のディメンションでフィルター処理したり、粒度 (month、 day) を定義したり、データを返す "format" (csv、 excel、 html) を指定したりすることもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 レポート サービス」を参照してください。

$ cat cmp_analytics

{"report":
    {
        "report_type":"cmp_analytics",
        "columns":[
            "day",
            "seller_member_id",
            "call_type",
            "url",
            "ad_requests_gdpr_country",
            "ad_requests_gdpr_applied_valid_consent_string",
            "ad_requests_gdpr_applied_blank_consent_string",
            "ad_requests_gdpr_applied_valid_consent_string_tcf_version_2",
            "pct_ad_requests_gdpr_country_gdpr_applied",
            "pct_ad_requests_gdpr_applied_valid_consent_string",
            "pct_ad_requests_gdpr_applied_blank_consent_string",
            "pct_ad_requests_gdpr_applied_valid_consent_string_tcf_version_2",
        ],
        "report_interval":"last_7_days",
        "format":"csv"
    }
}

POST レポート サービスへの要求

POST レポート ID を取得するための JSON 要求。

$ curl -b cookies -X post -d @cmp_analytics "https://api.appnexus.com/report?seller_member_id=123"

{
   "response":{
      "status":"OK",
      "report_id":"09b6979a6a4c3805bdac8921378d3622"
   }
}

GET レポート サービスからのレポートの状態

レポート ID を使用して GET 呼び出しを行い、レポートの状態を取得します。 execution_statusが"ready"されるまで、このGET呼び出しを続けます。 次に、次の手順で説明するように、 レポート ダウンロード サービスを使用して、レポート データをファイルに保存します。

$ curl -b cookies 'https://api.appnexus.com/report?id=09b6979a6a4c3805bdac8921378d3622'

{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2016-12-11 19:15:48",
         "json_request": "{\"report\":{\"report_type\":\"cmp_analytics\",
             \"columns\":[\"day\",\"seller_member_id\",
             \"call_type\",\"url\",\"ad_requests_gdpr_country\",\"ad_requests_gdpr_applied_valid_consent_string\",\"ad_requests_gdpr_applied_blank_consent_string\",
             \"ad_requests_gdpr_applied_valid_consent_string_tcf_version_2\",\"pct_ad_requests_gdpr_country_gdpr_applied\",
             \"pct_ad_requests_gdpr_applied_valid_consent_string\",\"pct_ad_requests_gdpr_applied_blank_consent_string\",
             \"pct_ad_requests_gdpr_applied_valid_consent_string_tcf_version_2\"],
             \"report_interval\":\"last_7_days\",\"format\":\"csv\",\"filters\":[{\"seller_member_id\":\"123\"}]}}",
             "url":"report-download?id=b97897a7864dd8f34e7457226c7af592"
      },
      "execution_status":"ready"
   }
}

GET レポート ダウンロード サービスからのレポート データ

レポート データをファイルにダウンロードするには、レポート ID を使用して別の GET 呼び出しを行います。今回は レポート ダウンロード サービスに対して呼び出します。 サービス ID とレポート ID は、前回のGET呼び出しへの応答の url フィールドにあります。 保存するファイルを特定する際は、初期 POSTで指定したファイル形式の拡張子を使用してください。

$ curl -b cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/cmp_analytics.csv