PAGE TOP

クリック測定

クリックURLの登録・削除・データダウンロードを行います。
登録がおこなわれた場合は識別IDが返り、その識別IDを元に削除・ダウンロードを行います。
エラーが発生した場合には内容に応じて以下の値が返ります。

  • -1: パラメータ不正
  • -2: 登録上限
  •  0: 登録処理に失敗

HTTP(S)

クリックURLの作成


URI /clickurl/detail/create
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
forwardurl 転送先URL
任意 format,f レスポンス形式を指定する。「xml」または「json」
レスポンスサンプル
【XMLの場合】
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<clickurl>
    <clickurlID>1</clickurlID>
</clickurl>
    
【JSONの場合】
{"clickurlID":1}
サンプルコード
http_clickurl_detail_create.php
<?php

require_once 'HTTP/Request.php';

$url = 'https://api.bme.jp/rest/1.0/authenticate/login';

$request =& new HTTP_Request();
$request->setURL($url);

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('username', 'ログインID');
$request->addPostData('password', 'ログインパスワード');
$request->addPostData('api_key', '認証用トークン');

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    $xml = simplexml_load_string($request->getResponseBody());
}


$url = 'https://api.bme.jp/rest/1.0/clickurl/detail/create';

$request->reset($url);

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('access_token', $xml->access_token);
$request->addPostData('forwardurl', 'http://www.blayn.co.jp/');

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    echo $request->getResponseBody();
}

?> 

クリックURLの削除


URI /clickurl/list/delete
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
clickurlIDs 識別IDリスト
任意 format,f レスポンス形式を指定する。「xml」または「json」
レスポンスサンプル
【XMLの場合】
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<clickurl>
    <success>1,2</success>
    <failure>3,4</failure>
</clickurl>
    
【JSONの場合】
{"failure":"3,4","success":"1,2"}
サンプルコード
http_clickurl_list_delete.php
<?php

require_once 'HTTP/Request.php';

$url = 'https://api.bme.jp/rest/1.0/authenticate/login';

$request =& new HTTP_Request();
$request->setURL($url);

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('username', 'ログインID');
$request->addPostData('password', 'ログインパスワード');
$request->addPostData('api_key', '認証用トークン');

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    $xml = simplexml_load_string($request->getResponseBody());
}


$url = 'https://api.bme.jp/rest/1.0/clickurl/list/delete';

$request =& new HTTP_Request($url, array('useBrackets' => false));

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('access_token', $xml->access_token);
$request->addPostData('clickurlIDs', array('1'));

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    echo $request->getResponseBody();
}

?> 

クリックURLの結果取得


URI /clicklog/list/export
HTTP Method(s) GET
パラメータ
必須 access_token API利用許可トークン
任意 format,f レスポンス形式を指定する。「xml」または「json」
clickurlID 識別IDリスト
レスポンスサンプル
*CSVファイルが返されます。
サンプルコード
http_clicklog_list_export.php
<?php

require_once 'HTTP/Request.php';

$url = 'http://api.bme.jp/rest/1.0/authenticate/login';

$request =& new HTTP_Request();
$request->setURL($url);

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('username', 'ログインID');
$request->addPostData('password', 'ログインパスワード');
$request->addPostData('api_key', '認証用トークン');

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    $xml = simplexml_load_string($request->getResponseBody());
}


$url = "https://api.bme.jp/rest/1.0/clicklog/list/export?access_token={$xml->access_token}&clickurlID=1";

$request =& new HTTP_Request($url, array('useBrackets' => false));

$request->setMethod(HTTP_REQUEST_METHOD_GET);

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    $buf = $request->getResponseBody();
    header('Content-Disposition: attachment; filename="clicklog_list_export.csv"');
    header('Content-Type: application/octet-stream');
    header('Content-Transfer-Encoding: binary');
    header('Content-Length: '.strlen($buf));
    print $buf;
}

?>