配信情報取得 API、フォーマット情報取得 API

概要

インフォメーションの配信情報とフォーマットきの取得を行います。一度登録されたものは、削除しない限りいつでも取得できます。

URL

配信情報取得 API

https://${POPINFO_HOST}/mapi/3.0/info/{id}/

フォーマット情報取得 API

https://${POPINFO_HOST}/mapi/3.0/draft/{id}/

メソッド

GET/POST

結果タイプ

1つしか返さない

リクエストパラメータ

無し

レスポンス

キー名	タイプ	表示条件	説明
id	整数	-	配信またはフォーマットのID
type	文字列	-	次のうちいずれかの文字列 instant ... 即時送信 scheduled ... 予約送信 location ... 位置連動型送信 wifi ... wifi連動型送信 bluetooth ... bluetooth連動型送信 continual ... 継続配信
content_type	文字列	-	text/plain ... テキスト配信 text/html ... HTML配信
platform	配列	-	配信対象のプラットフォーム iphone, androidのいずれか、もしくは両方
popup	文字列	-	ポップアップフリーワード。入稿時、popup_itemsでポップアップフリーワードを設定した際は、bodyキーの値が返される。 delivery_typeを3にした場合、空文字が返される。
title	文字列	-	件名。delivery_typeを2にした場合、空文字が返される。
content	文字列	-	本文。delivery_typeを2にした場合、空文字が返される。
delivery_type	整数	-	1 ... プッシュ通知/お知らせ表示利用 2 ... プッシュ通知のみ利用 3 ... お知らせ通知のみ利用
url	文字列	-	リンク先URL
icon	文字列	-	アイコン画像ファイルの絶対URL
category	文字列	-	カテゴリー
sendrate_android	整数	-	(deprecated) -1が入る
sendrate_iphone	整数	-	(deprecated) -1が入る
canceled	bool値	-	配信がキャンセルされたか否か
action	文字列	-	(deprecated) "default"が入る
send_time	文字列	typeがscheduled、もしくは配信情報取得APIでのtypeがinstant	送信日時 (日本時間) ※ yyyy-mm-dd HH:MM:SS フォーマット
period	配列	typeが location, wifi, bluetooth, continualの場合	配信期間次の値を持つオブジェクトの配列 start ... 開始日時、JST(文字列) end ... 終了日時、JST(文字列)
wifissid	配列	typeがwifi	配信Wi-Fi SSID情報次の値を持つオブジェクトの配列 essid .. Wi-FiスポットのESSID(文字列) bssid .. Wi-FiスポットのBSSID(文字列) rssi .. 電波強度(整数)
bluetooth	配列	typeがbluetooth	bluetooth端末情報次の値を持つオブジェクトの配列 type .. iBeacon uuid .. uuid major .. メジャー番号 minor .. マイナー番号 rssi .. 電波強度(デシベル)
status	文字列	配信情報取得API	finished ... 配信完了 canceled ... 配信キャンセル delivering ... 配信中
info_status	文字列	配信情報取得API	typeとstatusから生成される文字列次のルールに従って返される文字列 (予約
sent	object	配信情報取得API	配信人数 iphone, android, totalを持つオブジェクト iphone, android のうち配信対象のプラットフォームに含まれないものは、キー自体が返されません。また、個別集計が未対応の場合または仕様上人数を把握できない場合は、-1 が返されます
open	object	配信情報取得API	開封数オブジェクトの形式は sent と同じ
view	object	配信情報取得API	閲覧数オブジェクトの形式は sent と同じ
click	object	配信情報取得API	サイト閲覧数オブジェクトの形式は sent と同じ

deprecatedの項目について

deprecatedの項目については、次のAPIのバージョンアップにて廃止が予定されている項目です。

レスポンスのサンプル

{
    "status": "OK",
    "result":
    {
        "status": "delivering",
        "delivery_type": 1,
        "popup": "popup文言",
        "canceled": false,
        "period": [
        {
            "start": "2018-04-19 18:29:52",
            "end": "2018-04-23 05:48:52"
        },
        {
            "start": "2018-04-19 18:29:52",
            "end": "2018-04-23 05:48:52"
        }],
        "sendrate_android": -1,
        "content_type": "text/plain",
        "sendrate_iphone": -1,
        "open":
        {
            "android": 0,
            "total": 0,
            "iphone": 0
        },
        "id": 85226880,
        "icon": "https://static.popinfo.jp/img/icon/popinfo_test_account/hogehoge.img",
        "category": "",
        "title": "タイトル",
        "url": "http://google.com",
        "click":
        {
            "android": 0,
            "total": 0,
            "iphone": 0
        },
        "content": "本文",
        "platform": [
            "android"
        ],
        "info_status": "GPS配信中",
        "location": [
        {
            "lat": 35.661,
            "radius": 1000,
            "lon": 139.743
        }],
        "action": "default",
        "type": "location",
        "sent":
        {
            "android": 0,
            "total": 0,
            "iphone": 0
        },
        "view":
        {
            "android": 0,
            "total": 0,
            "iphone": 0
        }
    }
}

参照可能データ期間について

本APIで参照が保証できる配信情報は、登録日から1年以内の配信となります。 1年を経過した配信に対する本APIのレスポンスは、保証されません。 1年以上経過した配信を参照したい場合は、サポートまでお問い合わせください。