価格コム　WEBサービス　API マニュアル

バージョン：1.0
1.旅行記検索ＡＰＩ
a.リクエストURL
http://api.4travel.jp/Ver1/SearchAlbum.php?パラメータ名=パラメータ値・・・
b.リクエストパラメータ
パラメータ名 説明
format 出力フォーマットを指定
・xml（xmlフォーマットで出力）
・php（シリアライズして出力）
・json（jsonフォーマットで出力）
・jsonp（jsonpフォーマットで出力）
※指定のない場合xmlを適用
keyword 旅行記を検索するキーワードを指定
※URLエンコードが必要
inputcharset
エイリアス: ic 		入力する文字コードを選択
・sjis
・euc
・utf8
※指定のない場合は自動判定
outputcharset
エイリアス: oc 		出力する文字コードを選択
・sjis
・euc
・utf8
※指定のない場合は、inputcharsetに指定した文字コードを適用
さらにinputcharsetに指定のない場合はUTF-8を適用
areatype 以下のタイプから選択
・city（海外：都市）
・spot（海外：観光地）
・state（海外：州、省、区、地方）
・country（海外：国名）
・kuchoson（国内：区町村）
・shigun（国内：市郡）
・todofuken（国内：都道府県）
※指定のない場合、すべてのエリアから検索
※areatypeとareakey、いずれかのみの指定はできません。
areakey areatypeの指定に応じて、エリアキー名を指定（マスタ参照）
※マスタを参照してください。
※指定のない場合、すべてのエリアから検索
※areatypeとareakey、いずれかのみの指定はできません。
zip 旅検索エリアの郵便番号を指定
※areatypeおよびareakeyの指定がある場合は無効です。
purpose 旅行のテーマを指定（マスタ参照）
・areatypeがcity、spot、state、countryの場合、海外テーマから選択して指定
・areatypeがkuchoson、shigun、todofukenの場合、国内テーマから選択して指定
※マスタを参照してください。
※指定のない場合、すべてのテーマから検索
order 結果の並び順を指定
・update：旅行記更新日付の新しい順
・travel_date：旅行開始日の新しい順
※指定のない場合、updateを適用
max 最大取得件数を指定
※指定のない場合、10を適用
※最大50件まで表示
callback
format=jsonp時のみ		 コールバック関数名を指定
※指定のない場合callbackを適用
c.リターンパラメータ
ヒットした旅行記の情報をXML形式で返します。
パラメータ名 説明 データ型
numofresult リターンする旅行記の数
0件の場合は”0”を返す。 		Integer
albumtitle 旅行記のタイトル String
albumurl 旅行記ページのURL String
traveler トラベラー名 String
travelerurl トラベラーページのURL String
picture 表紙写真URL String
theme テーマ String
themeurl テーマトップページのURL String
area 旅行記のエリア名 String
areaurl エリアトップページのURL String
description 旅行記の内容 String
fromdate 旅行開始時期 String
todate 旅行終了時期 String
numofpict 写真数 Integer
pictlink 旅行記の写真ページへのリンクURL String
picturl 旅行記の写真のURL String
pictcomment 写真のコメント String
d.サンプル
リクエスト(format：xmlの場合)
http://api.4travel.jp/Ver1/SearchAlbum.php?format=xml&ic=euc&oc=utf8& areatype=COUNTRY&areakey=maldives&keyword=%A5%EA%A5%BE%A1%BC%A5%C8& max=1&order=travel_date
※keywordに指定した文字列は、文字コードEUC-JPの「リゾート」をURLエンコードしたものです。
結果
結果（ヒットした旅行記がなかった場合）
リクエスト(format：phpの場合)
http://api.4travel.jp/Ver1/SearchAlbum.php?format=php&ic=euc&oc=utf8&areatype=COUNTRY& areakey=maldives&keyword=%A5%EA%A5%BE%A1%BC%A5%C8&max=1&order=travel_date
※keywordに指定した文字列は、文字コードEUC-JPの「リゾート」をURLエンコードしたものです。
結果
リクエスト(format：jsonの場合)
http://api.4travel.jp/Ver1/SearchAlbum.php?format=json&ic=euc&areatype=COUNTRY& areakey=maldives&keyword=%A5%EA%A5%BE%A1%BC%A5%C8&max=1&order=travel_date
※keywordに指定した文字列は、文字コードEUC-JPの「リゾート」をURLエンコードしたものです。
結果
リクエスト(format：jsonpの場合)
http://api.4travel.jp/Ver1/SearchAlbum.php?format=jsonp&callback=callback&ic=euc&areatype=COUNTRY& areakey=maldives&keyword=%A5%EA%A5%BE%A1%BC%A5%C8&max=1&order=travel_date
※keywordに指定した文字列は、文字コードEUC-JPの「リゾート」をURLエンコードしたものです。
結果
e.エラー
エラーコード 内容
invalid_format 出力フォーマットの値が不正です。
invalid_inputcharset 入力文字コードの値が不正です。
invalid_outputcharset 出力文字コードの値が不正です。
invalid_max 最大取得件数の値が不正です。
invalid_areatype_areakey エリアタイプとエリアキーの値または組み合わせが不正です。
invalid_purpose テーマの値が不正です。
invalid_zip 郵便番号の値が不正です。
出力フォーマットがPHPの場合、アンシリアライズすると上記メッセージになります。 XML、JSON、JSONPの場合のエラー判定は以下を参照してください。
invalid_formatの場合

<?xml version="1.0" encoding="UTF-8" ?>
<results>
<title>旅行記</title>
<error>
<message>invalid_format</message>
</error>
</results>

invalid_inputcharsetの場合

XML

<?xml version="1.0" encoding="UTF-8" ?>
<results>
<title>旅行記</title>
<error>
<message>invalid_inputcharset</message>
</error>
</results>


JSON

{"item":{"error":"invalid_inputcharset"}}


JSONP

callback({"error":"invalid_inputcharset"})

invalid_outputcharsetの場合

XML

<?xml version="1.0" encoding="UTF-8" ?>
<results>
<title>旅行記</title>
<error>
<message>invalid_outputcharset</message>
</error>
</results>


JSON

{"item":{"error":"invalid_outputcharset"}}


JSONP

callback({"error":"invalid_outputcharset"})

invalid_maxの場合

XML

<?xml version="1.0" encoding="UTF-8" ?>
<results>
<title>旅行記</title>
<error>
<message>invalid_max</message>
</error>
</results>


JSON

{"item":{"error":"invalid_max"}}


JSONP

callback({"error":"invalid_max"})

invalid_areatype_areakeyの場合

XML

<?xml version="1.0" encoding="UTF-8" ?>
<results>
<title>旅行記</title>
<error>
<message>invalid_areatype_areakey</message>
</error>
</results>


JSON

{"item":{"error":"invalid_areatype_areakey"}}


JSONP

callback({"error":"invalid_areatype_areakey"})

invalid_purposeの場合

XML

<?xml version="1.0" encoding="UTF-8" ?>
<results>
<title>旅行記</title>
<error>
<message>invalid_purpose</message>
</error>
</results>


JSON

{"item":{"error":"invalid_purpose"}}


JSONP

callback({"error":"invalid_purpose"})

invalid_zipの場合

XML

<?xml version="1.0" encoding="UTF-8" ?>
<results>
<title>旅行記</title>
<error>
<message>invalid_zip</message>
</error>
</results>


JSON

{"item":{"error":"invalid_zip"}}


JSONP

callback({"error":"invalid_zip"})