ジオターゲティング [geotargeting] : providing advanced local targeting solutions.

ジオターゲティング [geotargeting] : providing advanced local targeting solutions.

ジオターゲティング:API仕様説明書

ジオターゲティングによる地域判定は、弊社が管理するサーバより提供されるAPIによって提供されます。
下記リクエストにより地域コード判定結果をリターンします。

※ご利用には、アカウントIDとパスワードが必要です。

はじめに

ジオターゲティングの商用利用での導入ご検討の方、若しくは非商用サイト等でのご利用を希望の方に対し、無償で利用できるテストアカウントを用意しております。
1日当り500リクエストを上限として、下記に記述する試験環境にてジオターゲティングAPIをお試し頂けます。

API(試験環境)を呼び出すURL

下記URLでリクエストします。

地域コードををリクエストする場合
http://www1.geotg.jp/sample.geo?ip=[IPアドレス]&id=[アカウントID]&pw=[アカウントパスワード]&format=[フォーマット]
地域コード+ドメインをリクエストする場合
http://www1.geotg.jp/sample2.geo?ip=[IPアドレス]&id=[アカウントID]&pw=[アカウントパスワード]&format=[フォーマット]

試験環境ではアカウントID:sample アカウントパスワード:testを使用

※1日500リクエストまで無料で試用ができます。

API(本番環境)を呼び出すURL

下記URLでリクエストします。

地域コードを返す場合
http://geotg.jp/geo.geo?ip=[IPアドレス]&id=[アカウントID]&pw=[アカウントパスワード]&format=[フォーマット]
地域コード+ドメインを返す場合
http://geotg.jp/geo2.geo?ip=[IPアドレス]&id=[アカウントID]&pw=[アカウントパスワード]&format=[フォーマット]

パラメータの説明

各パラメータは以下のようになっています。

項目説明必須
アカウントIDAPI利用アカウントID必須
アカウントパスワードAPI利用アカウントパスワード必須
IPアドレスデータを返す対象となるIPアドレス必須
フォーマット結果のデータフォーマット形式(xml or JSON) 省略時はJSON
アカウントID/パスワードは、顧客ごとに発行されたものを使用。

レスポンスの説明

APIのレスポンス(戻り値)はJSON形式です。

キー項目
region地域コード
domainドメイン

例(JSON)

{
    "region":"0",
    "domain":"-"
}

例(xml)

<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://geotg.jp/">
<region>0</region>
<domain>-</domain>
</results>
ドメインの場合、対応する値がない場合は "-" が返る。

エラーの説明

エラー(リクエスト失敗)が発生したときのAPIのレスポンスは以下のようになります。

以下のキーと値の組み合わせを持つ連想配列。 error: エラーメッセージ

例(JSON)

{
    "error":"authentication failure"
}

例(xml)

<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://geotg.jp/">
  <error>
    <message>authentication failure</message>
  </error>
</results>

エラーメッセージ一覧

エラーメッセージとその意味は以下のようになります。

エラーメッセージ意味
authentication failureアカウントIDもしくはパスワードが不適切
invalid ip_addressIPアドレスの値が不適切

地域コード一覧

地域コードと都道府県名の対応は以下のようになります。

地域コード都道府県名
0不明
1北海道
2青森
3岩手
4宮城
5秋田
6山形
7福島
8茨城
9栃木
10群馬
11埼玉
12千葉
13東京
14神奈川
15新潟
16富山
17石川
18福井
19山梨
20長野
21岐阜
22静岡
23愛知
24三重
25滋賀
26京都
27大阪
28兵庫
29奈良
30和歌山
31鳥取
32島根
33岡山
34広島
35山口
36徳島
37香川
38愛媛
39高知
40福岡
41佐賀
42長崎
43熊本
44大分
45宮崎
46鹿児島
47沖縄
ご利用に関するお問い合わせ

copyright © 2016 alphablend Inc. all right reserved.