ads-display-api-documents

コンバージョントラッキング機能

コンバージョンとは

広告をクリックしたユーザーが、何らかの「成果」となる行動をとった数です。これを計測することで、広告がどの程度成果を上げているかなどを確認できます。
詳しくは以下のヘルプをご参照ください。
・コンバージョン測定とは

ディスプレイ広告API での実施方法

ディスプレイ広告APIでは、コンバージョントラッカー情報（コンバージョン測定タグおよび、タグごとのパフォーマンスデータ）の取得および追加・更新を行うために、ConversionTrackerService、を使用します。
本サービスを利用することで、ディスプレイ広告で掲載されている広告からのコンバージョン数（商品の購入や会員登録、資料請求などサイト上で何らかの成約に至った件数）を取得することができ、広告がどの程度成果を上げているかなどを確認できます。
コンバージョンタグは広告管理ツールとAPIで共有しています。

シナリオ

A社は商品B（1万円）を販売しているが、ウェブページでコンバージョンを計測するための、コンバージョントラッカーを作成する。

　　 　　 　　 　 　 　　 　　 　　 　 　 　　 　　 　　 　 　 　　 　　 　　 　 　 　　 　　 　　 　 　 　　 　　 　　 　 　 　　 　　 　　 　

項目	値	項目の説明
category	PURCHASE（購入/販売）	コンバージョントラッカー情報のカテゴリ
conversionTrackerName	（分かりやすい名称を）	コンバージョントラッカーの名称
conversionTrackerType	WEB_CONVERSION	コンバージョンの種別
measurementPeriod	30	コンバージョン計測期間（●日）
status	ENABLED（ウェブページへのアクセスを記録する）	コンバージョントラッカー情報のステータス
userRevenueValue	10000	売上金額が固定のときの、1コンバージョンの売上（●円）※商品Bの値段

1. トラッカー情報の登録

はじめに、ConversionTrackerService:addを使い、コンバージョントラッカー情報を追加します。

リクエストサンプル

{
  "accountId": 111111,
  "operand": [
    {
      "category": "PURCHASE",
      "conversionTrackerName": "Pro_B_CV",
      "conversionTrackerType": "WEB_CONVERSION",
      "measurementPeriod": 30,
      "status": "ENABLED",
      "userRevenueValue": 10000
    }
  ]
}

レスポンスサンプル

{
    "errors": null,
    "rid": "02f056b7b9acec932c5b9d80c1c76a9d",
    "rval": {
        "values": [
            {
                "conversionTracker": {
                    "accountId": 111111,
                    "allConversionValue": null,
                    "allConversions": null,
                    "viewThroughConversions": null,
                    "appConversion": null,
                    "category": "PURCHASE",
                    "conversionTrackerId": 222222,
                    "conversionTrackerName": "Pro_B_CV",
                    "conversionTrackerType": "WEB_CONVERSION",
                    "conversionValue": null,
                    "conversionValueViaAdClick": null,
                    "conversions": null,
                    "conversionsViaAdClick": null,
                    "countingType": "MANY_PER_CLICK",
                    "crossDeviceConversions": null,
                    "excludeFromBidding": "FALSE",
                    "measurementPeriod": 30,
                    "measurementPeriodView": 1,
                    "mostRecentConversionDate": null,
                    "status": "ENABLED",
                    "userRevenueValue": 10000,
                    "webConversion": {
                        "snippet": [
                            {
                                "tag": "<script type=\"text/javascript\" language=\"javascript\">\n  /* <![CDATA[ */\n  var yahoo_ydn_conv_io = \"6asbtt0OLDUxHpzn5ru9\";\n  var yahoo_ydn_conv_label = \"2TU9U6IWZFPTMZVVMI4727707\";\n  var yahoo_ydn_conv_transaction_id = \"\";\n  var yahoo_ydn_conv_value = \"10000\";\n  /* ]]> */\n</script>\n<script type=\"text/javascript\" language=\"javascript\" charset=\"UTF-8\" src=\"https://b90.yahoo.co.jp/conv.js\"></script>",
                                "webConversionSnippetType": "JS"
                            },
                            {
                                "tag": "<img src=\"https://b90.yahoo.co.jp/c?yahoo_ydn_conv_io=6asbtt0OLDUxHpzn5ru9&yahoo_ydn_conv_label=2TU9U6IWZFPTMZVVMI4727707&yahoo_ydn_conv_transaction_id=&yahoo_ydn_conv_value=10000&guid=ON\" width=\"1\" height=\"1\" border=\"0\" />",
                                "webConversionSnippetType": "IMG"
                            }
                        ]
                    }
                },
                "errors": null,
                "operationSucceeded": true,
                "statsPeriodCustomDate": null
            }
        ]
    }
}

2. コンバージョン計測タグの取得

次に、ConversionTrackerService:getを使い、コンバージョン計測タグを取得します。

リクエストサンプル

{
  "accountId": 111111,
  "conversionTrackerIds": [
    222222
  ],
  "conversionTrackerTypes": [
    "WEB_CONVERSION"
  ],
  "numberResults": 1,
  "startIndex": 1,
  "statuses": [
    "ENABLED"
  ]
}

レスポンスサンプル

{
    "errors": null,
    "rid": "dd94f200a5b0cf4b8f9e32e72a8507ef",
    "rval": {
        "period": {
            "periodEndDate": {
                "periodDate": "20200807",
                "periodTime": "160000"
            },
            "periodStartDate": {
                "periodDate": "20200807",
                "periodTime": "000000"
            }
        },
        "totalAllConversionValue": "0",
        "totalAllConversions": 0,
        "totalConversionValue": "0",
        "totalConversionValueViaAdClick": "0",
        "totalConversions": 0,
        "totalConversionsViaAdClick": 0,
        "totalCrossDeviceConversions": 0,
        "totalNumEntries": 1,
        "values": [
            {
                "conversionTracker": {
                    "accountId": 111111,
                    "allConversionValue": null,
                    "allConversions": null,
                    "viewThroughConversions": null,
                    "appConversion": null,
                    "category": "PURCHASE",
                    "conversionTrackerId": 222222,
                    "conversionTrackerName": "Pro_B_CV",
                    "conversionTrackerType": "WEB_CONVERSION",
                    "conversionValue": null,
                    "conversionValueViaAdClick": null,
                    "conversions": null,
                    "conversionsViaAdClick": null,
                    "countingType": "MANY_PER_CLICK",
                    "crossDeviceConversions": null,
                    "excludeFromBidding": "FALSE",
                    "measurementPeriod": 30,
                    "measurementPeriodView": 1,
                    "mostRecentConversionDate": null,
                    "status": "ENABLED",
                    "userRevenueValue": 10000,
                    "webConversion": {
                        "snippet": [
                            {
                                "tag": "<script type=\"text/javascript\" language=\"javascript\">\n  /* <![CDATA[ */\n  var yahoo_ydn_conv_io = \"6asbtt0OLDUxHpzn5ru9\";\n  var yahoo_ydn_conv_label = \"2TU9U6IWZFPTMZVVMI4727707\";\n  var yahoo_ydn_conv_transaction_id = \"\";\n  var yahoo_ydn_conv_value = \"10000\";\n  /* ]]> */\n</script>\n<script type=\"text/javascript\" language=\"javascript\" charset=\"UTF-8\" src=\"https://b90.yahoo.co.jp/conv.js\"></script>",
                                "webConversionSnippetType": "JS"
                            },
                            {
                                "tag": "<img src=\"https://b90.yahoo.co.jp/c?yahoo_ydn_conv_io=6asbtt0OLDUxHpzn5ru9&yahoo_ydn_conv_label=2TU9U6IWZFPTMZVVMI4727707&yahoo_ydn_conv_transaction_id=&yahoo_ydn_conv_value=10000&guid=ON\" width=\"1\" height=\"1\" border=\"0\" />",
                                "webConversionSnippetType": "IMG"
                            }
                        ]
                    }
                },
                "errors": null,
                "operationSucceeded": true,
                "statsPeriodCustomDate": null
            }
        ]
    }
}

3. タグをウェブサイトに埋め込み、計測を開始する

上記の、ConversionTrackerService:get、で取得した、snippetのtag（webConversion）を、ウェブサイトに埋め込んで、計測を開始します。

4. コンバージョンの計測結果を取得する

再び、ConversionTrackerService:getを使い、コンバージョンの計測結果を取得します。

リクエストサンプル

{
  "accountId": 111111,
  "conversionTrackerIds": [
    222222
  ],
  "conversionTrackerTypes": [
    "WEB_CONVERSION"
  ],
  "numberResults": 1,
  "startIndex": 1,
  "statuses": [
    "ENABLED"
  ]
}

レスポンスサンプル

{
    "errors": null,
    "rid": "dd94f200a5b0cf4b8f9e32e72a8507ef",
    "rval": {
        "period": {
            "periodEndDate": {
                "periodDate": "20200807",
                "periodTime": "160000"
            },
            "periodStartDate": {
                "periodDate": "20200807",
                "periodTime": "000000"
            }
        },
        "totalAllConversionValue": "10000000",
        "totalAllConversions": 1000,
        "totalConversionValue": "100000000",
        "totalConversionValueViaAdClick": "100",
        "totalConversions": 10000,
        "totalConversionsViaAdClick": 50,
        "totalCrossDeviceConversions": 30,
        "totalNumEntries": 1,
        "values": [
            {
                "conversionTracker": {
                    "accountId": 111111,
                    "allConversionValue": 10000000,
                    "allConversions": 1000,
                    "viewThroughConversions": null,
                    "appConversion": null,
                    "category": "PURCHASE",
                    "conversionTrackerId": 222222,
                    "conversionTrackerName": "Pro_B_CV",
                    "conversionTrackerType": "WEB_CONVERSION",
                    "conversionValue": 100000000,
                    "conversionValueViaAdClick": 100,
                    "conversions": 10000,
                    "conversionsViaAdClick": 50,
                    "countingType": "MANY_PER_CLICK",
                    "crossDeviceConversions": 30,
                    "excludeFromBidding": "FALSE",
                    "measurementPeriod": 30,
                    "measurementPeriodView": 1,
                    "mostRecentConversionDate": null,
                    "status": "ENABLED",
                    "userRevenueValue": 10000,
                    "webConversion": {
                        "snippet": [
                            {
                                "tag": "<script type=\"text/javascript\" language=\"javascript\">\n  /* <![CDATA[ */\n  var yahoo_ydn_conv_io = \"6asbtt0OLDUxHpzn5ru9\";\n  var yahoo_ydn_conv_label = \"2TU9U6IWZFPTMZVVMI4727707\";\n  var yahoo_ydn_conv_transaction_id = \"\";\n  var yahoo_ydn_conv_value = \"10000\";\n  /* ]]> */\n</script>\n<script type=\"text/javascript\" language=\"javascript\" charset=\"UTF-8\" src=\"https://b90.yahoo.co.jp/conv.js\"></script>",
                                "webConversionSnippetType": "JS"
                            },
                            {
                                "tag": "<img src=\"https://b90.yahoo.co.jp/c?yahoo_ydn_conv_io=6asbtt0OLDUxHpzn5ru9&yahoo_ydn_conv_label=2TU9U6IWZFPTMZVVMI4727707&yahoo_ydn_conv_transaction_id=&yahoo_ydn_conv_value=10000&guid=ON\" width=\"1\" height=\"1\" border=\"0\" />",
                                "webConversionSnippetType": "IMG"
                            }
                        ]
                    }
                },
                "errors": null,
                "operationSucceeded": true,
                "statsPeriodCustomDate": null
            }
        ]
    }
}

5. トラッカー情報の更新

コンバージョントラッカーの情報を更新したい場合は、ConversionTrackerService:setを使います。
以下では、コンバージョントラッカー情報のカテゴリを、PURCHASE（販売）からPAGE_VIEW（主要なページの閲覧）に更新しています。

リクエストサンプル

{
  "accountId": 111111,
  "operand": [
    {
      "category": "PAGE_VIEW",
      "conversionTrackerId": 222222,
      "conversionTrackerType": "WEB_CONVERSION"
    }
  ]
}

レスポンスサンプル

{
    "errors": null,
    "rid": "b6b0c4891ee01526a4a43e110a8fe441",
    "rval": {
        "values": [
            {
                "conversionTracker": {
                    "accountId": 111111,
                    "allConversionValue": 10000000,
                    "allConversions": 1000,
                    "viewThroughConversions": null,
                    "appConversion": null,
                    "category": "PAGE_VIEW",
                    "conversionTrackerId": 222222,
                    "conversionTrackerName": "Pro_B_CV",
                    "conversionTrackerType": "WEB_CONVERSION",
                    "conversionValue": 100000000,
                    "conversionValueViaAdClick": 100,
                    "conversions": 10000,
                    "conversionsViaAdClick": 50,
                    "countingType": "MANY_PER_CLICK",
                    "crossDeviceConversions": 30,
                    "excludeFromBidding": "FALSE",
                    "measurementPeriod": 30,
                    "measurementPeriodView": 1,
                    "mostRecentConversionDate": null,
                    "status": "ENABLED",
                    "userRevenueValue": 10000,
                    "webConversion": {
                        "snippet": [
                            {
                                "tag": "<script type=\"text/javascript\" language=\"javascript\">\n  /* <![CDATA[ */\n  var yahoo_ydn_conv_io = \"6asbtt0OLDUxHpzn5ru9\";\n  var yahoo_ydn_conv_label = \"2TU9U6IWZFPTMZVVMI4727707\";\n  var yahoo_ydn_conv_transaction_id = \"\";\n  var yahoo_ydn_conv_value = \"10000\";\n  /* ]]> */\n</script>\n<script type=\"text/javascript\" language=\"javascript\" charset=\"UTF-8\" src=\"https://b90.yahoo.co.jp/conv.js\"></script>",
                                "webConversionSnippetType": "JS"
                            },
                            {
                                "tag": "<img src=\"https://b90.yahoo.co.jp/c?yahoo_ydn_conv_io=6asbtt0OLDUxHpzn5ru9&yahoo_ydn_conv_label=2TU9U6IWZFPTMZVVMI4727707&yahoo_ydn_conv_transaction_id=&yahoo_ydn_conv_value=10000&guid=ON\" width=\"1\" height=\"1\" border=\"0\" />",
                                "webConversionSnippetType": "IMG"
                            }
                        ]
                    }
                },
                "errors": null,
                "operationSucceeded": true,
                "statsPeriodCustomDate": null
            }
        ]
    }
}

This site is open source. Improve this page.