コンバージョンAPI | Developer Center

English

リファレンス

このページでは、コンバージョンAPIのリファレンスとリクエストサンプルを記載します。

リファレンス

サーバー https://conversion-api.yahooapis.jp/v1

リクエストヘッダ

項目名 型 必須 デフォルト値 説明
X-TagAccessToken - 〇 - 広告管理ツールの計測タグ管理画面から取得したアクセストークンです。
Content-Type - 〇 - 送信データの形式です。
application/json
※固定値

リクエストボディ

パラメータ名 型 必須 デフォルト値  説明 
tag_id string 〇 - 広告管理ツールの計測タグ管理画面から取得したタグIDです。
channel_id long △ - LINEのチャネルIDです
line_uid入力時のみ設定必須です。
data - array 〇 - イベントデータを格納します。
配列上限は1000件です。
event event_type string 〇 - イベント種別です。
event_snippet_id string △ - スニペットIDです。
コンバージョン設定の「フィルター条件」で「イベントスニペット」を選択した場合は設定必須です。
event_time long 〇 - コンバージョンの発生日時です。
リクエスト日時の90日前〜現在時刻までの日時を10桁のUNIX時間で入力してください。
リクエスト日時が現在時刻に近い場合はAPI側で補正される場合があります。
action_source string 〇 - コンバージョンソースです。
「web」のみ指定可能です。
test_flag Bool false テストかどうかを表すフラグです。
true ：テストとして計測対象から除外します。
false ：計測対象とします。
transaction_id string - コンバージョン計測の重複判定をするためのユニークなIDです。
任意の文字列を64文字以内で入力します。
入力可能な文字は以下のとおりです。
-_.!~*'();/?:@&=+$,%#

重複排除については、「コンバージョンの重複排除について」を参照してください。
user hashed_phone_number string △ - SHA-256でハッシュ化された電話番号です。
国際番号の形式、かつ半角英数小文字で入力します。
例：日本の電話番号「090-0123-4567」の場合、「+819001234567」に変換し、その後SHA-256でハッシュ化してください。
userのパラメータはいずれか1つ入力必須です。
hashed_email string △ - SHA-256でハッシュ化されたメールアドレスです。半角英数小文字で入力します。
小文字に変換してからハッシュ化してください。
userのパラメータはいずれか1つ入力必須です。
ly_su string △ - サイトユーザーID（ウェブサイトのドメイン内でユニークな識別情報）です。
Cookie「_ly_su」の値となります。
userのパラメータはいずれか1つ入力必須です。
ly_c string △ - クリックID（広告をクリックしたユーザーの識別情報）です。
CookieまたはウェブサイトのURLのクエリーパラメータ「_ly_c」の値となります。
URLパラメータはtimestamp情報を持たないため、以下のようにtimestampを付与してください。
<timestamp>.<clickid>
userのパラメータはいずれか1つ入力必須です。
ly_r string △ - ウェブサイトのドメイン上でイベント計測の精度を補完するIDです。
Cookie「_ly_r」の値となります。
userのパラメータはいずれか1つ入力必須です。
ifa string △ - 広告識別子です。IDFA、もしくはAAIDのいずれかを入力します。IDFAは大文字、AAIDは小文字で入力してください。
userのパラメータはいずれか1つ入力必須です。
line_uid string △ - イベントを発生させたユーザーを識別するLINE ユーザーのIDです。
userのパラメータはいずれか1つ入力必須です。
web url string - イベントが発生した時のブラウザーのURLです。
入力可能な文字は以下のとおりです。
^http(s)?://.+
referrer_url string - イベントが発生した時のブラウザーのリファラーです。
user_agent string - イベントを発生させたエンドユーザーが使用しているブラウザーのユーザーエージェントです。
ip string - イベントを発生させたエンドユーザーのIPアドレスです。
このフィールドはIPv4、およびIPv6アドレスを指定可能です。 IPv4はdotted decimal notation、 IPv6はRFC 4291のフォーマットに従って指定してください。
custom currency string △ - 通貨単位です。
「JPY」のみ指定可能です。
value入力時は必須です。
label string - オーディエンスリスト作成時の絞り込み条件として設定するカスタムラベルです。入力可能な文字等については「オーディエンスリストの条件にカスタムラベルを設定する」を参照してください。
value float(64) - イベントの価値です。
以下の範囲内の半角数字で入力します。
0<=n<10000000000
items - array - アイテム情報を格納します。
配列上限は10件です。
event_typeが「page_view」の時は指定できません。 
item_id string △ - 商品IDです。
半角英数字で入力します。
「price」「quantity」を入力する場合、item_idまたはcategory_idのいずれか入力必須です。
category_id string △ - 商品種別IDです。
半角英数字で入力します。
「price」「quantity」を入力する場合、item_idまたはcategory_idのいずれか入力必須です。
price float(64) - 商品価格です。
以下の範囲内の半角数字の整数で入力します。
0<=n<10000000000
item_idがない場合は入力できません。
quantity number - 商品数です。
以下の範囲内で半角数字の整数で入力します。
0<=n<2147483647
小数点を含む値は入力できません。また、item_idがない場合入力できません。

イベント種別

コンバージョンAPIで計測できるイベント種別は以下のとおりです。

説明 イベント種別
ページビュー page_view
商品一覧表示 view_listing
商品詳細表示 view_product
商品カートを閲覧 view_cart
商品カートに追加 add_cart
検索 search
購入手続き開始 check_out
購入 purchase
リード獲得 generate_lead
ログイン login
予約完了 reservation
登録完了 sign_up
お支払い明細を発行 payment_info
お気に入りに追加 add_wishlist

リクエストサンプル

$ curl \
-H "X-TagAccessToken: kiZ84ZoJyA4xz5hvcGiqOTZfVeZQa2p92uz-687" \
-H "Content-Type: application/json" \
-X POST \
-d '{
    "tag_id": "12345678-abcd-4bcd-1234-123456789012",
    "channel_id": "1234567890",
    "data": [
      {
        "event": {
          "event_type": "page_view",
          "event_snippet_id": "12345678-abcd-4bcd-1234-123456789012",
          "event_time": 1700000000,
          "action_source": "web",
          "test_flag": false,
          "transaction_id": "123"
        },
        "user": {
          "hashed_phone_number": "4e6a6c5c6f8a086ce4babac3247364cc93a8a995a1968105d9b408f7e6b72e51",
          "hashed_email": "31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66",
          "ly_su": "1700000000.12345678-abcd-4bcd-1234-123456789012",
          "ly_c": "1700000000.12345678-abcd-4bcd-1234-123456789012",
          "ly_r": "1700000000.FF",
          "ifa": "ABCDEF00-ABCD-4DEF-1234-1234567890AB",
          "line_uid": "Ua1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p"
        },
        "web": {
          "url": "https://www.yahoo.co.jp/?yj_r=FF&_ly_c=92aafe74-eae4-4130-975c-842a6f82df40&_ly_r=FF",
          "referrer_url": "https://www.yahoo.co.jp",
          "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/500.00 (KHTML, like Gecko) Chrome/50.0.0000.000 Safari/500.0",
          "ip": "203.0.113.10"
        },
        "custom": {
          "currency": "JPY",
          "label": "label",
          "value": 1000,
          "items": [
            {
              "item_id": "1234567890",
              "category_id": "1234567890",
              "price": 10,
              "quantity": 3
            }
          ]
        }
      }
    ]
  }' \
https://conversion-api.yahooapis.jp/v1/

レスポンス

結果 コード 説明
成功 202 リクエストは成功しています。
なお、リクエストが成功しても、不正な値や重複判定となった場合はコンバージョンの計測対象外になります。
失敗 400 リクエストが不正な場合に発生します。特にリクエストボディがJSONとして解釈できない場合や入力値が不正な場合が考えられます。
403 認証キーが不正な場合やPOST 以外のメソッドでリクエストした場合に発生します。
404 リクエストパスが不正な場合に発生します。
415 Content-Type の指定が不正な場合に発生します。
429 秒間リクエスト数がリクエスト上限を超えた場合に発生します。
500 内部エラーが起きた場合に発生します。再度操作を実行してください。
503 APIがメンテナンス中などの理由により利用できない状態です。

Developer Center

関連サイト