このドキュメントはSCENE APIを利用する方向けのドキュメントです。
保護されたリソースにアクセスする場合に利用します。
アクセストークンはユーザー設定画面上に表示されています。
AuthorizationヘッダーにBearer {ACCESS_TOKEN}を指定する。(推奨)
Content-Typeヘッダーにapplication/x-www-form-urlencodedを指定して、データとしてaccess_token={ACCESS_TOKEN}を指定する。
access_token={ACCESS_TOKEN}を指定する。
| Status code | Response body | Reason |
|---|---|---|
| 400 | {"error":"invalid_request"} | アクセストークンが無効です。正しいアクセストークンを指定てしください。 |
| 401 | {"error":"invalid_token"} | 保護されたリソースにアクセスしようとしましたが、アクセストークンがセットされていません。 |
タイムスタンプを表現する場合はISO 8601のフォーマットを適用してください。
例:2016-01-23T12:34:50
アクセストークンに関するAPIです。
curl -u {EMAIL} https://scene.lokaplatform.com/api/v1/auth
| Property | Type | Description |
|---|---|---|
| access_token | String | アクセストークンです。 |
アクセストークンを更新します。
第三者に漏えいしたなどの理由がない限り、アクセストークンを更新する必要はありません。
curl -X PATCH -u {EMAIL} https://scene.lokaplatform.com/api/v1/auth
| Property | Type | Description |
|---|---|---|
| status | String | アクセストークンの状態です。 |
| access_token | String | 更新後のアクセストークンです。 |
レポートを取得します。正しくリクエストしている場合、レスポンスはCSVとなります。
curl -H "Authorization: Bearer {ACCESS_TOKEN}" "https://scene.lokaplatform.com/api/v1/reports"
| Key | Type | Description | Default |
|---|---|---|---|
| start_at end_at |
String | レポートの集計期間です。ISO 8601形式で記載してください。 | 先月の一日から末日 |
| interval | String | レポートを集計する期間です。hour, day, month(毎時、日次、月次)を選択できます。 | day |
| campaign unit delivery material |
String | IDかユニークIDを指定すると、集計を絞り込むことができます。 | - |
| axis_type | String | 集計する関連軸を指定します。関連軸については後述するAxisを参照してください。 | - |
| headings | Comma Separated String | 列の見出しを指定します。後述するHeadingsを参照してください。カンマ区切りで指定することによって複数列指定可能です。 | name |
| report_ids | Comma Separated String | 出力する指標値を指定します。後述するReport IDsを参照してください。カンマ区切りで指定することによって複数列指定可能です。 | 全指標値 |
| order_by | String | 並べ替えする列を指定します。これはheadingsあるいはreport_idsで指定した値の単一値を指定します。 | 出力される形式により異なる |
| order | String | 並び順を指定します。asc, desc(昇順、降順)を選択できます。 | 並べ替える列が数値なら降順、それ以外の場合は昇順 |
| charset | String | レポートの文字エンコードを指定します。UTF-8とSJISをサポートしています。 | SJIS |
| Axis type | Description |
|---|---|
| campaign | プロジェクトごとに集計します。 |
| unit | クリエイティブごとに集計します。 |
| delivery | 配信設定ごとに集計します。 |
| material | 素材ごとに集計します。 |
| region | 地域ごとに集計します。 |
| device | デバイスごとに集計します。 |
| os | オペレーションシステムごとに集計します。 |
| browser | ブラウザごとに集計します。 |
| current_url | 掲載元URLごとに集計します。 |
| referer_url | 参照元URLごとに集計します。 |
current_urlとreferer_urlはユーザーの権限によって参照できない場合があります。
| Headings | Description |
|---|---|
| name | 名前を表示します。 |
| id | IDを表示します。 |
| uid | ランダムに生成されたユニークなIDを表示します。これはクリエイティブのシェアや配信タグなどで利用されています |
| ID | Description |
|---|---|
| impression | インプレッション |
| click | クリック |
| click_rate | クリック率 |
| viewable_click_rate | ビューアブルクリック率 |
| viewable | ビューアブル |
| viewable_rate | ビューアブル率 |
| inview | インビュー |
| inview_rate | インビュー率 |
| inview_time | インビュー時間 |
| inview_avg_time | 平均インビュー時間 |
| inview_n | インビュー(N秒) |
| rollover | ロールオーバー |
| rollover_time | ロールオーバー時間 |
| play | 再生 |
| play_uniq | 視聴者 |
| play_rate | 再生率 |
| play_time | 再生時間 |
| play_avg_time | 平均再生時間 |
| play25 | 再生25%完了 |
| play50 | 再生50%完了 |
| play75 | 再生75%完了 |
| playend | 再生完了 |
| play25_rate | 再生25%完了率 |
| play50_rate | 再生50%完了率 |
| play75_rate | 再生75%完了率 |
| playend_rate | 再生完了率 |
| play15sec | 15秒再生 |
| play30sec | 30秒再生 |
| play_n | 再生(N秒) |
| preview_play | プレビュー |
| preview_play_rate | プレビュー率 |
| preview_play25 | プレビュー25%完了 |
| preview_play50 | プレビュー50%完了 |
| preview_play75 | プレビュー75%完了 |
| preview_playend | プレビュー完了 |
| preview_play25_rate | プレビュー25%完了率 |
| preview_play50_rate | プレビュー50%完了率 |
| preview_play75_rate | プレビュー75%完了率 |
| preview_playend_rate | プレビュー完了率 |
| pause | 一時停止 |
| replay | リプレイ |
| mute_on | ミュートON |
| mute_off | ミュートOFF |
| fullscreen | フルスクリーン |
| fullscreen_rate | フルスクリーン率 |
| fullscreen_time | フルスクリーン時間 |
| fullscreen_avg_time | 平均フルスクリーン時間 |
| share_through | シェアスルー |
| share_through_rate | シェアスルー率 |
| total_conversion | コンバージョン総数 |
| impression_cv | インプレッション（CV） |
| click_cv | クリック（CV） |
| viewable_cv | ビューアブル（CV） |
| play_cv | 再生（CV） |
| preview_cv | プレビュー（CV） |
このAPIの使用例を示します。これらは一例であり、権限によって結果が取得できないことがあります。
2016-12-01から2016-12-31まで、プロジェクト44の日別レポートを取得します。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&campaign=44"
2016-12-01から2016-12-31まで、ユニット424の日別レポートを取得します。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&unit=424"
2016-12-01から2016-12-31まで、配信ID OHg2u_3dTenl6CYe の日別レポートを取得します。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&delivery=OHg2u_3dTenl6CYe"
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&interval=day&material=TEAcYYrI1nCxZO4M"
2016-12-01から2016-12-31まで、プロジェクト44 の素材別レポートを取得します。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&campaign=44&axis_type=material"
2016-12-01から2016-12-31まで、素材ID TEAcYYrI1nCxZO4M のブラウザ別レポートを取得します。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?start_at=2016-12-01&end_at=2016-12-31&material=TEAcYYrI1nCxZO4M&axis_type=browser"
先月分のクリエイティブ別レポートのID,名前,再生数,再生率,インプレション列のみを取得します。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?axis_type=unit&headings=id,name&report_ids=play,play_rate,impression"
先月分のプロジェクト別レポートを再生数の昇順で並べ替えて取得します。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://scene.lokaplatform.com/api/v1/reports?axis_type=unit&order_by=play&order=asc"