Digital Platform API - Seller CMP Analytics レポート

Seller CMP (Consent Management Platform) Analytics Report は、エンドポイントへの販売者広告要求に関する IAB Transparency & Consent Framework (IAB TCF) 文字列の数、有効性、および内容に関する分析情報を提供します。 このレポートを使用すると、販売者は次のような質問に回答できます。

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

概要

このレポートは、法令の遵守を証明または証明するものではありません。 このレポートの言語 "GDPR が適用されました" は、適用された TCF ロジックを意味します。 IAB TCF をサポートしており、このレポートにより、TCF を使用する販売者は TCF 信号が正しく通信されていることを確認できます。

レポートを取得する手順については、 レポート サービス または以下の 例 を参照してください。

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

特定の発行元に対して多数の存在するが形式が正しくない文字列は、通常、発行元の CMP が TCF 仕様に従って文字列を作成またはエンコードしていないため、ベンダーが読み取ることができないことを意味します。 読み取り不可能な文字列は、ベンダーに明確なシグナルを提供しないため、ベンダーに対するアクセス許可として扱われず、回避する必要があります。

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

• IAB ヨーロッパの TCF ポリシー
• IAB ヨーロッパの TCF ガバナンス
• IAB Techlab TCF v1 および v2 Technical Spec & 実装ガイド
• IAB Techlab TCF RTB 仕様

時間枠

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

• カスタム
• last_7_days
• month_to_date
• last_30_days

データ保持期間

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

Dimensions

指標

例

JSON レポート要求を作成する

JSON ファイルには、 report_type"cmp_analytics"と、取得する列 (ディメンションとメトリック) report_interval が含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (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"
    }
}

POSTReport Service への要求

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

$ 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 は、前GETのurl呼び出しに対する応答のフィールドにあります。 保存するファイルを特定するときは、最初 POSTに で指定したファイル形式のファイル拡張子を使用してください。

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