リクルートのAI「Listing API」を使ったレコメンドの作り方

のえる

2019.05.31

ユーザーデータが集まってくると、データ群から「この人にはこの商品がおすすめ」というデータが見えてくると思います。

しかし、そういったレコメンドを作成するには専用のプログラムが必要で実装するのにも大変・・・。

そんな時、リクルート様より無料で提供されている A3RT の Listing API というAPIを使うことで、比較的簡単にレコメンドリストを作成することが可能です。

今回は、そんなレコメンドリストの作り方を記載します。

1 開発環境
2 APIキーを取得する
3 アップロードするCSVファイルを作る
4 アップロードするURLを取得する
5 CSVファイルをアップロードする
6 アップロードのステータスを取得する
7 演算のステータスを取得する
8 演算結果のダウンロードURLを取得する
9 結果ファイルのダウンロード
10 うまくできない場合
11 結果を見てみる
12 さいごに

開発環境

今回の開発環境は下記のとおりです。

PHP	7.1.11
cURL	7.29.0

また、今回のAPIを実行するにあたり curl が必要となります。

APIキーを取得する

まずはAPIキーを取得しましょう。

A3RT の Listing API ページ下にある「API KEY 発行」ボタンからAPIキーを作成しましょう。

この時、利用規約を最下部までスクロールしないと、同意するボタンが押せません。

メールアドレスを入力し、確認後には登録したメールアドレスにAPIキーが送られてきます。

アップロードするCSVファイルを作る

リコメンドリストを作成するため、集計データを作成しましょう。

集計データは「ユーザーID」「商品ID」「タイムスタンプ」の3項目が必要となります。

今回は下記のようなデータを用意しました。

このCSVファイルは、各項目をダブルクォートで囲んでいません。

アップロードするURLを取得する

まずはアップロードするURLを取得するところから始まります。

get_upload_url というエンドポイントにアクセスすると、URLを取得できます。

require_once 'const.php';

$data = [
    'apikey' => "[APIキー]",
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/get_upload_url"."?".http_build_query($data));
// リクエストメソッド
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
// 証明書検証をしない
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
// 結果を文字列で取得
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
// タイムアウト時間を設定
curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック
$errorNo = curl_errno($ch);
$errorMsg = curl_error($ch);
if (CURLE_OK !== $errorNo) {
    echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);
}

curl_close($ch);

// 結果を配列に変換
$response = json_decode($responseJsonStr, true);
print_r($response);

require_once 'const.php';

$data = [

'apikey' => "[APIキー]",

];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/get_upload_url"."?".http_build_query($data));

// リクエストメソッド

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

// 証明書検証をしない

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

// 結果を文字列で取得

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_HEADER, false);

// タイムアウト時間を設定

curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

if (CURLE_OK !== $errorNo) {

echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);

}

curl_close($ch);

// 結果を配列に変換

$response = json_decode($responseJsonStr, true);

print_r($response);

上記プログラムを実行した結果は下記のとおりです。

Array
(
    [status] => 0
    [message] => ok
    [result] => Array
        (
            [url] => https://www.example.com
        )

)

Array

(

[status] => 0

[message] => ok

[result] => Array

(

[url] => https://www.example.com

)

この result -> url にあるURLが、アップロードURLになります。

CSVファイルをアップロードする

続いてデータCSVファイルをアップロードしましょう。

取得したURLに対して、アップロードのプログラムを実行していきます。

$uploadUrl = "[先ほど取得したアップロードURL]";

$mimeType = 'text/plain';
$header = [
    'Content-Type: '.$mimeType,
];

$fileName = 'data.csv';
$filePath = dirname(__FILE__).DIRECTORY_SEPARATOR.$fileName;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $uploadUrl);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_POSTFIELDS, file_get_contents($filePath));

$responseJsonStr = curl_exec($ch);

// エラーチェック
$errorNo = curl_errno($ch);
$errorMsg = curl_error($ch);
if (CURLE_OK !== $errorNo) {
    echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);
}

curl_close($ch);

// 結果を配列に変換
$response = json_decode($responseJsonStr, true);
print_r($response);

$uploadUrl = "[先ほど取得したアップロードURL]";

$mimeType = 'text/plain';

$header = [

'Content-Type: '.$mimeType,

];

$fileName = 'data.csv';

$filePath = dirname(__FILE__).DIRECTORY_SEPARATOR.$fileName;

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $uploadUrl);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_HEADER, false);

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

curl_setopt($ch, CURLOPT_HTTPHEADER, $header);

curl_setopt($ch, CURLOPT_POSTFIELDS, file_get_contents($filePath));

$responseJsonStr = curl_exec($ch);

// エラーチェック

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

if (CURLE_OK !== $errorNo) {

echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);

}

curl_close($ch);

// 結果を配列に変換

$response = json_decode($responseJsonStr, true);

print_r($response);

ここのポイントは「curl の ––upload-file を CURLOPT_POSTFIELDS で指定していること」です。

この方法、実は検索してもほとんどヒットしないので、とてもマイナーではありますが実用性があるのではないでしょうか？

アップロードのステータスを取得する

アップロードが成功したら、次に演算処理開始しましょう。

アップロードしただけでは演算されない、というところがポイントです。

$data = [
    'apikey' => "[APIキー]",
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/start_w2v"."?".http_build_query($data));
// リクエストメソッド
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
// 証明書検証をしない
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
// 結果を文字列で取得
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
// タイムアウト時間を設定
curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック
$errorNo = curl_errno($ch);
$errorMsg = curl_error($ch);
if (CURLE_OK !== $errorNo) {
    echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);
}

curl_close($ch);

// 結果を配列に変換
$response = json_decode($responseJsonStr, true);
print_r($response);

$data = [

'apikey' => "[APIキー]",

];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/start_w2v"."?".http_build_query($data));

// リクエストメソッド

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

// 証明書検証をしない

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

// 結果を文字列で取得

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_HEADER, false);

// タイムアウト時間を設定

curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

if (CURLE_OK !== $errorNo) {

echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);

}

curl_close($ch);

// 結果を配列に変換

$response = json_decode($responseJsonStr, true);

print_r($response);

演算のステータスを取得する

演算開始をしたら、ステータスで状態を確認しましょう。

ここでエラーが出た場合は、最初からやり直しです。

$data = [
    'apikey' => "[APIキー]",
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/status_w2v"."?".http_build_query($data));
// リクエストメソッド
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
// 証明書検証をしない
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
// 結果を文字列で取得
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
// タイムアウト時間を設定
curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック
$errorNo = curl_errno($ch);
$errorMsg = curl_error($ch);
if (CURLE_OK !== $errorNo) {
    echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);
}

curl_close($ch);

// 結果を配列に変換
$response = json_decode($responseJsonStr, true);
print_r($response);

$data = [

'apikey' => "[APIキー]",

];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/status_w2v"."?".http_build_query($data));

// リクエストメソッド

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

// 証明書検証をしない

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

// 結果を文字列で取得

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_HEADER, false);

// タイムアウト時間を設定

curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

if (CURLE_OK !== $errorNo) {

echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);

}

curl_close($ch);

// 結果を配列に変換

$response = json_decode($responseJsonStr, true);

print_r($response);

この時、下記のようなレスポンスが返ってきたら演算が終了した、ということです。

これ以外は処理中、もしくはエラーとなります。

Array
(
    [status] => 0
    [message] => SHUTDOWN instance
)

Array

(

[status] => 0

[message] => SHUTDOWN instance

)

演算結果のダウンロードURLを取得する

演算が終了したあとは、結果をダウンロードするURLを取得します。

ちょっと面倒かもしれませんがあと少しです、頑張りましょう。

$data = [
    'apikey' => "[APIキー]",
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/get_download_url"."?".http_build_query($data));
// リクエストメソッド
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
// 証明書検証をしない
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
// 結果を文字列で取得
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
// タイムアウト時間を設定
curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック
$errorNo = curl_errno($ch);
$errorMsg = curl_error($ch);
if (CURLE_OK !== $errorNo) {
    echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);
}

curl_close($ch);

// 結果を配列に変換
$response = json_decode($responseJsonStr, true);
print_r($response);

$data = [

'apikey' => "[APIキー]",

];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.a3rt.recruit-tech.co.jp/listing/v1/get_download_url"."?".http_build_query($data));

// リクエストメソッド

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

// 証明書検証をしない

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

// 結果を文字列で取得

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

curl_setopt($ch, CURLOPT_HEADER, false);

// タイムアウト時間を設定

curl_setopt($ch, CURLOPT_TIMEOUT, 60);

$responseJsonStr = curl_exec($ch);

// エラーチェック

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

if (CURLE_OK !== $errorNo) {

echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);

}

curl_close($ch);

// 結果を配列に変換

$response = json_decode($responseJsonStr, true);

print_r($response);

上記プログラムを実行した結果は下記のとおりです。

Array
(
    [status] => 0
    [message] => ok
    [result] => Array
        (
            [url] => https://www.example.com
        )

)

Array

(

[status] => 0

[message] => ok

[result] => Array

(

[url] => https://www.example.com

)

この result -> url にあるURLが、ダウンロードURLになります。

結果ファイルのダウンロード

最後に結果ファイルをダウンロードしましょう。

これもcurlでダウンロードできます。

$downloadUrl = "[取得したダウンロードURL]";

$outputFileName = "outputList.csv";
$fp = fopen($outputFileName, "w");

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $downloadUrl);
curl_setopt($ch, CURLOPT_FILE, $fp);
curl_setopt($ch, CURLOPT_HEADER, false);

curl_exec($ch);

// エラーチェック
$errorNo = curl_errno($ch);
$errorMsg = curl_error($ch);
if (CURLE_OK !== $errorNo) {
    echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);
}

curl_close($ch);
fclose($fp);

echo 'OK';

$downloadUrl = "[取得したダウンロードURL]";

$outputFileName = "outputList.csv";

$fp = fopen($outputFileName, "w");

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $downloadUrl);

curl_setopt($ch, CURLOPT_FILE, $fp);

curl_setopt($ch, CURLOPT_HEADER, false);

curl_exec($ch);

// エラーチェック

$errorNo = curl_errno($ch);

$errorMsg = curl_error($ch);

if (CURLE_OK !== $errorNo) {

echo sprintf("[CurlErrorCode: %s] %s", $errorNo, $errorMsg);

}

curl_close($ch);

fclose($fp);

echo 'OK';

画面に OK という文字が出ればダウンロード成功です。

うまくできない場合

うまくいかない場合、ファイルフォーマットなどを確認してみましょう。

今回アップロードしたcsvファイルは、最後に空行がありません。

また、APIの仕様に基づき同一APIを60秒以内に投げた場合、エラーが返るというものがあります。

その他、細かい仕様もありますので、一度公式APIをよく読みましょう。

結果を見てみる

では、ダウンロードできたファイルの中身を見てみましょう。

それぞれ「item_id: スコア値, item_id: スコア値 …」という感じになっています。

このスコア値が高いほど、item_idを買う可能性が高いよ、ということです。

このAPIの良いところは「ユーザーIDと商品ID（という名の一意のもの）と購入（実行）日時があれば、相関リストを作成できる」というところだと思います。

かなり実用的なAPIではないでしょうか？

さいごに

今回は Listing API に注目してみましたが、需要があれば他のAPIの使い方も解説してみたいと思います。

おすすめ記事

POPULAR

のえる

Full-stack Developer

記事一覧

NearbyでiOSとAndroidで相互通信をする方法

AIに美味しそうなお肉を判断してもらう

のえる

Full-stack Developer

お休みはゲーム三昧。目指すは生涯自由人。ツナ缶大好き。

記事一覧

リクルートのAI「Listing API」を使ったレコメンドの作り方

開発環境

APIキーを取得する

アップロードするCSVファイルを作る

アップロードするURLを取得する

CSVファイルをアップロードする

アップロードのステータスを取得する

演算のステータスを取得する

演算結果のダウンロードURLを取得する

結果ファイルのダウンロード

うまくできない場合

結果を見てみる

さいごに

Git初心者必見！最低限これは覚えておこう

イラストレーターで座標に変な小数点が入ったときに消す方法

WebブラウザからWindowsアプリケーションを開く[追記あり]

node.js のアプリを永続化(デーモン化)させる

iPadアプリがフルスクリーンにならない

WindowsのDockerでMySQLが起動しない

リクルートのAI「Listing API」を使ったレコメンドの作り方

開発環境

APIキーを取得する

アップロードするCSVファイルを作る

アップロードするURLを取得する

CSVファイルをアップロードする

アップロードのステータスを取得する

演算のステータスを取得する

演算結果のダウンロードURLを取得する

結果ファイルのダウンロード

うまくできない場合

結果を見てみる

さいごに

AIに美味しそうなお肉を判断してもらう

Dialogflowでテキストからワードを取得する(プログラム編)

クラスタリングのk-meansで画像の分類に挑戦

Git初心者必見！最低限これは覚えておこう

イラストレーターで座標に変な小数点が入ったときに消す方法

WebブラウザからWindowsアプリケーションを開く[追記あり]

PHPで日付をフォーマットするならCarbonを使おう

Git初心者必見！最低限これは覚えておこう

イラストレーターで座標に変な小数点が入ったときに消す方法

WebブラウザからWindowsアプリケーションを開く[追記あり]

node.js のアプリを永続化(デーモン化)させる

iPadアプリがフルスクリーンにならない

WindowsのDockerでMySQLが起動しない