API 版ご利用マニュアル
目次
1. マニュアルの目的 ... 1 【概要】...1 【情報内容】 ... 1 2. どこどこ JP API 版 システム概略図 ... 2 3. どこどこ JP API 版のご利用お申込み方法 ... 3 4. どこどこ JP API 版の使い方 ... 6 4-1 設置方法 ... 6 4-2 データの取得（都道府県）... 6 4-3 データの取得(市区町村) ... 7 4-4 データの取得（国） ... 8 4-5 データの取得(都道府県指定) ... 9 4-6 コンテンツ切り替え ... 10 4-7 組み合わせ ... 11 4-8 アクセス数の取得 ... 12 4-9IP 検索機能 （有料のお客様のみ） ... 14 5. よくあるご質問 ... 15 Ｑ.どこどこＪＰサーバの応答速度はどのぐらいでしょうか？ ... 15 Ｑ.リダイレクトをさせると、クローキングとみなされませんか？ ... 15 Ｑ.フレーム内に表示させるコンテンツに制限はありますか？ ... 15 Ｑ.全ての都道府県に対しての設定が必須でしょうか？関東・東海だけに指定したいのですが。... 15 Ｑ.ＳＥＯ的に不利にはなりませんか？順位が下がるとか･･･。 ... 15 Ｑ.都道府県コード 00 の不明の場合、どのように対処をしたら良いのですか？ ... 151.
1.
1.
1. マニュアルの
マニュアルの
マニュアルの
マニュアルの目的
目的
目的
目的
【
【【
【概要
概要
概要
概要】
】】
】
どこどこ JP は、WEB サイトに訪れたユーザーの IP アドレスを元に都道府県判定を行い、適切な都道府県のコン テンツを表示させる WEB エリアターゲティングサービスです。 この文書は、どこどこ JP API 版のご利用方法について説明いたします。この文書を担当の方にご一読いただき、 本システムの特徴・注意点をご留意いただいた上での御利用をお願い致します。 どこどこ JP IFRAME 版をご利用の方は、別途どこどこ JP IFRAME 版をご参照ください。【
【【
【情報内容
情報内容
情報内容
情報内容】
】】
】
どこどこ JP には、コンテンツ内の特定箇所を IFRAME で切り分ける『IFRAME 版』と API の値を用いる『API 版』 の２種類があります。このマニュアルでは、API 版について説明いたします。
なお、本マニュアルはサービスにお申し込みをいただいたお客様を対象に作成されています。
お申込み方法は、弊社 WEB サイト（http://www.arearesearch.co.jp/web/docodoco/index.html）をご参照いただけ ますようお願い申し上げます。
2.
2.
2.
2. どこどこ
どこどこ
どこどこ
どこどこ JP API
JP API
JP API
JP API 版
版
版
版 システム
システム
システム
システム概略図
概略図
概略図
概略図
どこどこ JP API 版は、アクセスユーザの IP アドレスから判定されたエリア情報（市区町村単位まで位置認識が可 能）を javascript 形式で返します。返されるスクリプトには、コンテンツを切り替えるための簡単な関数も含んでおりま すので、簡単にエリアマッチングを行うことが可能です。 IFRAME 版とは違い、エリア情報がデータとして返されるのでスクリプト内で自由に使うことができます。工夫次第で はアクセス解析の他、様々な API とマッシュアップすることも可能です。 コンテンツはお客様が現在ご利用いただいております WEB サーバで、これまで通りの運用管理が可能です。 ■javascript 提供される javascript は、登録いただいたお客様に自動的にメールでご案内させていただいております。 詳しくは、6 ページ 「どこどこ JP」API 版のご利用お申込み方法 ... 6
①
アクセスユーザ②IP アドレス
③
どこどこサーバ④エリア情報などをスクリプトで返します。
⑤
お客様 WEB サーバ 取得した情報をもとに表示コンテンツを 変えることが可能です⑥
ブラウザに表示3.
3.
3.
3. どこどこ
どこどこ
どこどこ JP API
どこどこ
JP API
JP API
JP API 版
版
版
版のご
のご
のご
のご利用
利用お
利用
利用
お
お
お申込
申込
申込み
申込
み
み
み方法
方法
方法
方法
どこどこ JP API 版のご利用お申込みは http://api.docodoco.jp/regist.cgi から行うことが可能です。登録するには メールアドレスとどこどこ JP API 版を利用する URL を登録します。 お申込み作業の全体の流れとしては、以下のようになります。
1. 仮登録
2. 登録確認メールの受信
3.本登録
仮登録を行います。仮登録された時のメールアドレスに本登録用の URL を記載したメールを送信いたしますので、 その URL に訪問して初めてどこどこ JP API を利用することが出来るようになります。 ※ 法 人 で の ご 利 用 の 場 合 は 「 ど こ ど こ JP 利 用 申 込 み 書 」 を ダ ウ ン ロ ー ド し 、 必 要 事 項 を 記 入 の 上 、 web-support@arearesearch.co.jp まで送付下さい。 【Step2】 メールアドレスと利用する URL を入力します 【Step1】 法人様でのご利用の場合は、 こちらの資料をダウンロードし、 必要事項を記入し web-support@arearesearch.co.jp まで必ずご送付ください。 【Step3】 利用規約に同意ください 【Step4】 入力後、「確認する」をクリック して下さい 【Step1】 【Step2】 【Step3】 【Step4】上記の確認ボタンをクリックし、不備がある場合は該当箇所が表示されますので該当箇所を修正し再度確認ボタ ンをクリック下さい。入力項目に不備が無かった場合に、仮登録内容の確認画面が表示されますので登録事項を確 認し、新規登録をクリックしてください。 「新規登録」をクリックすると仮登録が完了となります。仮登録の際に入力されたメールアドレスに下記の内容のメ ールが送信されますので、メールを受信し内容を再度確認し、メール本文に書かれている本登録用の URL にアクセス下さい。 【Step5】 登録事項を確認後、 「新規登録」をクリック してください （登録されたメールアドレス） 様 この度はどこどこ JP をご利用頂き、まことにありがとうございます。 あなたのメールアドレスがどこどこ JP において ユーザ登録用メールアドレスとして使用されました。 もしユーザ登録に覚えがない場合はこのメールを破棄してください。 使用するサイトは下記で問題ないようでしたら、 承認に行ってください。 使用するサイト：（登録された URL） ユーザ登録を完了するには下記の URL にアクセスして登録の承認を行っ てください。 http://api.docodoco.jp/regist.cgi?mode=confirm&key1=yyyyyyyyyyyyyyyy y&key2=xxxxxxx 【Step6】 本登録用の URL です。 確認後こちらにアクセスく ださい。 【Step5】 【Step6】
（登録されたメールアドレス）様 この度はどこどこ JP をご利用頂き、まことにありがとうございます。 あなたはどこどこ JP のユーザとして、認められました。 登録したサイトにおいて、どこどこ JP を利用できます。 下記のタグをあなたのサイトに追加してください。 使用できるサイト：（登録された URL）
<script type= "text/javascript"
src="http://api.docodoco.jp/v2/docodoco?key=ZZZZZZZZZZZZZZZZZZZZZZZZZZ" charset="utf-8" > </script> それでは Good luck!! 本登録が完了すると下記の画面が表示され、どこどこ JP API 版を利用するためのタグが表示されますので、そち らを登録したサイトに貼り付けましょう。下記画面が表示されると同時に、登録完了のメールが登録されたメールアド レスに送信されます。 上記のタグをサイトに追加すると、どこどこ JP API 版が使用できるようになります。 【Step7】 【Step7】 こちらがどこどこ JP API 版利用をするためのタグになります。
4.
4.
4.
4. どこどこ
どこどこ
どこどこ
どこどこ JP API
JP API
JP API
JP API 版
版
版
版の
の使
の
の
使
使
使い
い
い
い方
方
方
方
4
44
4-
--
-1
1
1
1 設置方法
設置方法
設置方法
設置方法
登録の際に送られてきたメールに記述されているタグを、サイトのコンテンツの中に埋め込みます。 埋め込む場所 は、基本的に HTML 内のどこでも構いませんが、head タグ内に記述することをお勧めいたします。 <html> <head> ・<script type="text/javascript" src="http://api.docodoco.jp/v2/docodoco?key=○○" charset="utf-8"> </script> ・ </html>
4
44
4-
-2
--
2
2
2 データの
データの
データの取得
データの
取得（
取得
取得
（（
（都道府県
都道府県
都道府県
都道府県）
））
）
読み込んだら SURFPOINT オブジェクトに IP 情報が入っていますので、クライアントの都道府県情報はそれぞ れ以下サンプルの要領で取得する事が出来ます。 クライアントの都道府県情報はそれぞれ SURFPOINT.getPrefCode()で都道府県コード取得 SURFPOINT.getPrefAName()で都道府県名ローマ字表記取得 SURFPOINT.getPrefJName()で都道府県名日本語表記取得 SURFPOINT.getPrefLat()で都道府県緯度取得 SURFPOINT.getPrefLng()で都道府県経度取得 SURFPOINT.getPrefCF()で都道府県コードのＣＦ値取得 ※変数 SURFPOINT はグローバル変数として定義されます。 ■ ■ ■ ■使用例使用例使用例 使用例 下記の例ではボタンのオンクリックイベントで、 id 属性を result と指定した DIV タグのコンテンツを切り替えます。<input type="button" value="都道府県名ローマ字"
onClick="document.getElementById('resultresultresultresult').innerHTML = SURFPOINT.getPrefAName();"> <div id="result" style="padding:10px;background-color:black;color:white;width:100%;">
ここに表示されます </div> ▼ ▼ ▼ ▼実際実際実際の実際のの表示の表示表示 表示 クリックすると
4
44
4-
--
-3
3
3
3 データの
データの
データの取得
データの
取得
取得
取得((((市区町村
市区町村
市区町村
市区町村))))
読み込んだら SURFPOINT オブジェクトに IP 情報が入っていますので、クライアントの市区町村情報はそれぞれ以 下都道府県の場合と同様にサンプルの要領で取得する事が出来ます。 SURFPOINT.getCityCode()で市区町村コード記取得 SURFPOINT.getCityAName()で市区町村名ローマ字表記取得 SURFPOINT.getCityJName()で市区町村名日本語表記取得 SURFPOINT.getCityLat()で市区町村緯度取得 SURFPOINT.getCityLng()で市区町村取得 SURFPOINT.getCityCF()で市区町村コードのＣＦ値取得 ※変数 SURFPOINT はグローバル変数として定義されます。 ■ ■ ■ ■使用例使用例使用例 使用例 下記の例ではボタンのオンクリックイベントで、 id 属性を result と指定した DIV タグのコンテンツを切り替えます<input type="button" value="市区町村名ローマ字"
onClick="document.getElementById('resultresultresultresult').innerHTML = SURFPOINT.getCityAName();"> <div id="result" style="padding:10px;background-color:black;color:white;width:100%;">
ここに表示されます </div> ▼ ▼ ▼ ▼実際実際実際の実際のの表示の表示表示 表示 クリックすると
4
44
4-
-4
--
4
4
4 データの
データの
データの取得
データの
取得（
取得
取得
（（
（国
国
国
国）
））
）
読み込んだら SURFPOINT オブジェクトに IP 情報が入っていますので、クライアントの国情報はそれぞれ以下都道 府県の場合と同様にサンプルの要領で取得する事が出来ます。 SURFPOINT.getCountryCode()で国コード取得 SURFPOINT.getCountryAName()で国名英語表記取得 SURFPOINT.getCountryJName()で国名日本語表記取得 ※変数 SURFPOINT はグローバル変数として定義されます。 ■ ■ ■ ■使用例使用例使用例 使用例 下記の例ではボタンのオンクリックイベントで、 id 属性を result と指定した DIV タグのコンテンツを切り替えます<input type="button" value="国名英語"
onClick="document.getElementById('resultresultresultresult').innerHTML = SURFPOINT.getCountryAName();"> <div id="result" style="padding:10px;background-color:black;color:white;width:100%;">
ここに表示されます </div> ▼ ▼ ▼ ▼実際実際実際の実際のの表示の表示表示 表示 クリックすると
4
44
4-
--
-5
5
5
5 データの
データの
データの取得
データの
取得
取得
取得((((都道府県指定
都道府県指定
都道府県指定
都道府県指定))))
都道府県を指定して、データを取得することも可能です。 SURFPOINT.getPrefLocation(" SURFPOINT.getPrefLocation(" SURFPOINT.getPrefLocation(" SURFPOINT.getPrefLocation("都道府県都道府県都道府県コード都道府県コードコード表記コード表記表記表記", '", 'コールバック", '", 'コールバックコールバック関数名コールバック関数名関数名関数名')')')')で取得します。 このメソッドを実行すると、どこどこ JP のサーバにリクエストを出し指定された都道府県の情報を取得します。その 際には SURFPOINT オブジェクトのデータは全て上書きされます。 SURFPOINT オブジェクトは上書きされた後にコールバック関数名で指定した関数の引数として渡されます。 ■ ■ ■ ■使用例使用例使用例 使用例 下記の例では、ボタンのオンクリックイベントで、 id 属性を result と指定した DIV タグのコンテンツを静岡県の情報 に切り替えます。display 関数をコールバック関数として指定しています。 <script language="JavaScript"> <!-- function display(data) {document.getElementById('resultresultresultresult').innerHTML = "都道府県ローマ字: " + data.getPrefAName()+ data.getPrefAName()+ data.getPrefAName()+ data.getPrefAName() + "<br>都道府県日本語: " + data.getPrefJName()data.getPrefJName()data.getPrefJName()data.getPrefJName();
} // -->
<input type="button" value="静岡県指定で取得" onClick="SURFPOINT.getPrefLocation(‘22’, 'display');"> </form>
<div id="result" style="padding:10px;background-color:black;color:white;width:100%;"> ここに表示されます </div> ▼ ▼ ▼ ▼実際実際実際の実際のの表示の表示表示 表示 クリックすると
4
44
4-
--
-6
6
6
6 コンテンツ
コンテンツ
コンテンツ切
コンテンツ
切り
切
切
り
り
り替
替
替え
替
え
え
え
SURFPOINT.getContents("DIV SURFPOINT.getContents("DIV SURFPOINT.getContents("DIVSURFPOINT.getContents("DIV タグのタグの ID","タグのタグのID","ID","ID","取得取得取得したいコンテンツの取得したいコンテンツの相対したいコンテンツのしたいコンテンツの相対相対パス相対パスパスパス")")")")で指定した ID の DIV タグの内容を 切り替えることが出来ます。この関数を実行するとサーバにアクセスを試みます。取得したいコンテンツは同サーバ 内のみ可能です(javascript の制限)。 SURFPOINT.getContents('result','data/' + SURFPOINT.getPrefAName() + '.html')のように指定すると都道府県ごと にコンテンツの切り替えができます。 上記のように指定すると、どこどこ JP API 版を設置した場所から見て「data/shizuoka.html」などが取得されます。 取りに行く html の文字コードが UTF-8 でないと文字化けします。(javascript で処理するためです) この この この この関数関数関数を関数ををロードをロードロード時ロード時時に時ににに実行実行すると実行実行するとするとすると、、、、コンテンツのエリアマッチングがコンテンツのエリアマッチングが実現可能コンテンツのエリアマッチングがコンテンツのエリアマッチングが実現可能実現可能実現可能ですですです。です。。 。 ■ ■ ■ ■使用例使用例使用例 使用例 下 記 の 例 で は 、ボタ ン の オ ン ク リ ック イベン ト で 、 id 属 性 を result と 指 定し た DIV タ グの コン テ ン ツ を、 data/shizuoka.html(サーバから取得) などの値と切り替えます。 ※ ロード時に行うとアクセスユーザの都道府県に応じてコンテンツを切り替えることが出来ます。
<input type="button" value="コンテンツ切り替え"
onClick="SURFPOINT.getContents('result','data/' + SURFPOINT.getPrefAName() + '.html');"> </form>
<div id="result" style="padding:10px;background-color:black;color:white;width:100%;"> ここに表示されます </div> ▼ ▼ ▼ ▼実際実際実際実際のののの表示表示表示表示 クリックすると
4
44
4-
-7
--
77
7 組
組
組み
組
み合
み
み
合
合わせ
合
わせ
わせ
わせ
データ取得(都道府県指定)とコンテンツ切り替えを組み合わせると、都道府県を指定してコンテンツを取得できます。 SURFPOINT.getPrefLocation()コールバック関数内で、SURFPOINT.getContents()を呼び出します。 ■ ■ ■ ■使用例使用例使用例 使用例 下 記 の 例 で は 、ボタ ン の オ ン ク リ ック イベン ト で 、 id 属 性 を result と 指 定し た DIV タ グの コン テ ン ツ を、 data/shizuoka.html(サーバから取得) などの値と切り替えます。<input type="button" value="静岡県に切り替え" onClick="SURFPOINT.getPrefLocation('22’, 'display3');"> function display3(data)
{
SURFPOINT.getContents('result','data/' + ('result','data/' + ('result','data/' + ('result','data/' + SURFPOINT.getPrefAName() + '.html');+ '.html');+ '.html');+ '.html'); }
<div id="result" style="padding:10px;background-color:black;color:white;width:100%;"> ここに表示されます </div> ▼ ▼ ▼ ▼実際実際実際の実際のの表示の表示表示 表示 クリックすると
4
44
4-
-8
--
8
8
8 アクセス
アクセス
アクセス数
アクセス
数の
数
数
の
の
の取得
取得
取得
取得
どこどこ JP のタグを貼っていただいたページのアクセス数を取得することが出来ます。返されるデータは XML また は JSON で取得することが可能ですので、Perl、PHP などの他のプログラムから、間単に利用することができます。リ クエスト例は以下になります。 http://api.docodoco.jp/count?data=DailyAccess&key1=XXXXXXXXX&key2=YYYYYY で 取 得 し ま す 。 XXXXXX と YYYYYY の部分は任意の文字列が入ります。data パラメータの部分で取得するデータを指定します。 data パラメータ データ名 DailyAccess 日別アクセス(過去 11 日) MonthlyAccess 月別アクセス(過去 11 ヶ月) HourlyAccess 時間帯別アクセス(過去 11 日) PrefRanking 都道府県別ランキング(過去 11 日) CountryRanking 国別ランキング(過去 11 日)返される XML のフォーマットは以下のようになります。 <?xml version="1.0" encoding="UTF-8" ?> <docodoco> <CountryRanking> <Description>国別国別国別国別ランキングランキングランキングランキング</Description> <Config> <rank>pvpvpv</rank> pv <name>国名国名国名</name> 国名 <pv>PVPVPVPV</pv> <uu>UUUUUUUU</uu> </Config> <Rows> <Row> <name>日本日本日本</name> 日本 <pv>152,688152,688152,688</pv> 152,688 <uu>27,07327,07327,07327,073</uu> </Row> <Row> </CountryRanking> </docodoco> <?xml version="1.0" encoding="UTF-8" ?> <docodoco> <MonthlyAccess> <Description>月別月別月別月別アクセスアクセスアクセスアクセス数数数数</Description> <Config> <pv>PVPVPV</pv> PV <uu>UUUUUUUU</uu> <date>日付日付日付日付</date> </Config> <Rows> <Row> <date>2008200820082008----05050505</date> <pv>87,55787,55787,55787,557</pv> <uu>16,84916,84916,849</uu> 16,849 </Row> <Row> <date>2008200820082008----06060606</date> <pv>650,663650,663650,663650,663</pv> <uu>120,402120,402120,402</uu> 120,402 </Row> <Row> <date>2008200820082008----07070707</date> <pv>738,948738,948738,948738,948</pv> <uu>139,899139,899139,899</uu> 139,899 </Row> <Row> <date>2008200820082008----08080808</date> 例 例例 例：：：：月別月別月別月別アクセスアクセスアクセスアクセス 例：例例例：：：国別国別国別国別ランキングランキングランキングランキング <?xml version="1.0" encoding="UTF-8" ?> <docodoco> <(data パラメータで指定した文字列)> <Description>(返されるデータの説明)</Description> <Config> <pv>PV</pv> <uu>UU</uu> <date>日付</date> </Config> <Rows> <Row> <date>(YYYY-MM-DD)</date> <pv>(上記日付の PV 数)</pv> <uu>(上記日付の UU 数)</uu> </Row> ・ Row が続けて出力されます。 </Rows> </( data パラメータで指定した文字列) > </docodoco> Config 要素の子要素と Row 要素の子要素が同名の ものがある場合、Config 要素の子要素の内容がカラ ム名になります。 この場合は、date のカラム名が「日付」、pv のカラム 名が「PV」、uu のカラム名が「uu」となります。 基本 基本基本 基本フォーマットフォーマットフォーマット フォーマット
4
44
4-
--
-9 IP
9 IP
9 IP
9 IP 検索機能
検索機能
検索機能
検索機能 （
（（
（有料
有料のお
有料
有料
のお
のお
のお客様
客様
客様
客様のみ
のみ
のみ
のみ）
））
）
IP を指定しての検索は、javascript ではなく、REST 形式の簡単な API になります。返されるデータは XML または JSON で取得することが可能ですので、Perl、PHP などの他のプログラムから、間単に利用することができます。また、 文字コードを指定（charset=eucjp, sjis, jis, utf8）することもできます。
http://api.docodoco.jp/v2/search?ipadr=218.219.62.130&format=xml&charset=sjis&key1=XXXXXXXXX&key2=YYYY
YYで取得します。リクエスト例は以下になります。
例では、218.219.62.130 の検索結果を XML 形式、SHIFT-JIS で返すように指定しています。返される値は以下のよ うになります。
リクエストする URL の format=xml を format=json に変更すると JSON 形式で値が返されます。その場合は以下の ような値になります。 <?xml version="1.0" encoding="shift_jis" ?> <docodoco> <IP>218.219.62.130</IP> <PrefCode>22</PrefCode> <PrefAName>shizuoka</PrefAName> <PrefJName>静岡</PrefJName> <PrefLatitude>34.97682</PrefLatitude> <PrefLongtude>138.38315</PrefLongtude> <PrefCF>76</PrefCF> <CityCode>22100</CityCode> <CityAName>shizuoka-shi</CityAName> <CityJName>静岡市</CityJName> <CityLatitude>34.97521</CityLatitude> <CityLongtude>138.38333</CityLongtude> <CityCF>40</CityCF> <CountryCode>JP</CountryCode> <CountryAName>japan</CountryAName> <CountryJName>日本</CountryJName> </docodoco> { "IP":"218.219.62.130", "CountryCode":"JP", "CountryAName":"japan", "CountryJName":"日本", "PrefCode":"22", "PrefAName":"shizuoka", "PrefJName":"静岡", "PrefLatitude":"34.97682", "PrefLongtude":"138.38315", "PrefCF":"76", "CityCode":"22100", "CityAName":"shizuoka-shi", "CityJName":"静岡市", "CityLatitude":"34.97520", "CityLongtude":"138.38333", "CityCF":"40" } <?xml version="1.0" encoding="shift_jis" ?> <docodoco>
<IP> (IP アドレス) </IP>
<PrefCode>(都道府県コード)</PrefCode> <PrefAName> (都道府県ローマ字) </PrefAName> <PrefJName> (都道府県日本語) </PrefJName> <PrefLatitude> (都道府県緯度) </PrefLatitude> <PrefLongtude> (都道府県経度) </PrefLongtude> <PrefCF> (都道府県コード CF 値) </PrefCF> <CityCode> (市区町村コード) </CityCode> <CityAName> (市区町村ローマ字) </CityAName> <CityJName> (市区町村日本語) </CityJName> <CityLatitude> (市区町村緯度) </CityLatitude> <CityLongtude> (市区町村経度) </CityLongtude> <CityCF> (市区町村コード CF 値) </CityCF> <CountryCode> (国コード) </CountryCode> <CountryAName> (国名英語) </CountryAName> <CountryJName> (国名日本語) </CountryJName> </docodoco> { "IP" : (IP アドレス), "CountryCode" : (国コード), "CountryAName" : (国名英語), "CountryJName" : (国名日本語), "PrefCode" : (都道府県コード), "PrefAName" : (都道府県ローマ字), "PrefJName" : (都道府県日本語), "PrefLatitude" : (都道府県経度), "PrefLongtude" : (都道府県経度), "PrefCF" : (都道府県コード CF 値), "CityCode" : (市区町村コード), "CityAName" :(市区町村ローマ字), "CityJName" : (市区町村日本語), "CityLongtude" : (市区町村経度), "CityLatitude" : (市区町村緯度), "CityCF" : (市区町村コード CF 値) } 結果 結果結果 結果サンプルサンプルサンプル サンプル フォーマットフォーマットフォーマットフォーマット フォーマット フォーマット フォーマット フォーマット 結果 結果結果 結果サンプルサンプルサンプル サンプル
