geoLocation
    • PDF

    geoLocation

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    IPアドレスを指定して、地理的位置情報を検索します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/geoLocation

    リクエストヘッダ

    GeoLocation APIで共通して使用されるヘッダの詳細は、GeoLocationのリクエストヘッダをご参照ください。

    リクエストクエリパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    ipStringRequired地域情報を知りたいユーザー IPアドレス
    extStringOptional追加情報を含むかどうか
    • t | f (デフォルト)
      • t: 含む
      • f: 含まない
    encStringOptionalレスポンス結果のエンコード方式
    • utf8(デフォルト) | euckr
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location --request GET 'https://geolocation.apigw.ntruss.com/geolocation/v2/geoLocation
    ?ip=**.**.**.**
    &ext=t
    &enc=utf8
    &responseFormatType=json'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}'
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    requestIdStringRequiredAPIリクエスト ID
    returnCodeStringRequired正常なコードは0、それ以外はエラーコード
    countryStringRequiredIPアドレスに当てはまる国コード
    • ISO 3166標準に準拠
    • EU(ヨーロッパ)、AP(アジア、オーストラリア)、A1(Anonymous Proxy)、A2(Satellite Provider)、O1(Other Country)を含む
    codeStringRequired韓国行政安全部で定義した行政区域コード
    r1StringRequired都、広域市、州
    r2StringRequired市、郡、区
    r3StringOptional洞、面、邑
    latNumberOptional緯度
    longNumberOptional経度
    netStringOptional通信キャリア名

    レスポンスステータスコード

    レスポンスステータスコードの説明は次の通りです。NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    HTTPステータスコードコードメッセージ説明
    400131000No Entryリクエストした IPアドレスの地域情報が見つからない
    • 解決方法: 他の IPアドレスを利用して照会
    400131001Invalid IPグローバル IPアドレスではないか、無効な IPアドレス形式
    400131002Internal Server ErrorGeoLocationサーバエラー
    • 解決方法: しばらくしてから再試行するか、問題が続く場合はサポートに問い合わせる
    400131003Quota Limit Reachedユーザーが設定した API呼び出し限度超過
    • 解決方法: NAVERクラウドプラットフォームコンソールの Services > Application Services > GeoLocation > Quota Settingメニューで Quotaを増やして限度を変更
    400131004Subscription RequiredGeoLocationサービスの申し込みが必要
    • 解決方法: NAVERクラウドプラットフォームコンソールの Services > Application Services > GeoLocation > Subscriptionメニューで申し込む

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    • 韓国内、ext=fresponseFormatType=xmlの場合
    <?xml version="1.0" encoding="utf-8"?>
    <getLocationResponse>
        <returnCode>0</returnCode>
        <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
        <geoLocation>
            <country>KR</country>
            <code>41135*****</code>
            <r1>京畿道</r1>
            <r2>城南市盆唐区</r2>
        </geoLocation>
    </getLocationResponse>
    
    • 韓国内、ext=fresponseFormatType=jsonの場合
    {
        "returnCode": 0,
        "requestId": "c4e52003-****-****-****-66c93acfd0d2",
        "geoLocation": {
            "country": "KR",
            "code": "41135*****",
            "r1": "京畿道",
            "r2": "城南市盆唐区",
        }
    }
    
    • 海外、ext=fresponseFormatType=xmlの場合
    <?xml version="1.0" encoding="utf-8"?>
    <getLocationResponse>
        <returnCode>0</returnCode>
        <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
        <geoLocation>
            <country>US</country>
            <code></code>
            <r1>California</r1>
            <r2>San Francisco</r2>
        </geoLocation>
    </getLocationResponse>
    
    • 海外、ext=fresponseFormatType=jsonの場合
    {
        "returnCode": 0,
        "requestId": "c4e52003-****-****-****-66c93acfd0d2",
        "geoLocation": {
            "country": "US",
            "code": "",
            "r1": "California",
            "r2": "San Francisco",
        }
    }
    
    • 韓国内、ext=tresponseFormatType=xmlの場合
    <?xml version="1.0" encoding="utf-8"?>
    <getLocationResponse>
        <returnCode>0</returnCode>
        <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
        <geoLocation>
            <country>KR</country>
            <code>41135*****</code>
            <r1>京畿道</r1>
            <r2>城南市盆唐区</r2>
            <r3>亭子洞</r3>
            <lat>**.268***</lat>
            <long>**.030***</long>
            <net>Korea Telecom</net>
        </geoLocation>
    </getLocationResponse>
    
    • 韓国内、ext=tresponseFormatType=jsonの場合
    {
        "returnCode": 0,
        "requestId": "c4e52003-****-****-****-66c93acfd0d2",
        "geoLocation": {
            "country": "KR",
            "code": "41135*****",
            "r1": "京畿道",
            "r2": "城南市盆唐区",
            "r3": "亭子洞",
            "lat": **.268***,
            "long": **.030***,
            "net": "Korea Telecom"
        }
    }
    
    • 海外、ext=tresponseFormatType=xmlの場合
    <?xml version="1.0" encoding="utf-8"?>
    <getLocationResponse>
        <returnCode>0</returnCode>
        <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>    
        <geoLocation>
            <country>US</country>
            <code></code>
            <r1>California</r1>
            <r2>San Francisco</r2>
            <r3></r3>
            <lat>**.769***</lat>
            <long>-***.393***</long>
            <net>Fastly</net>
        </geoLocation>
    </getLocationResponse>
    
    • 海外、ext=tresponseFormatType=xmlの場合
    {
        "returnCode": 0,
        "requestId": "c4e52003-****-****-****-66c93acfd0d2",
        "geoLocation": {
            "country": "US",
            "code": "",
            "r1": "California",
            "r2": "San Francisco",
            "r3": "",
            "lat": **.769***,
            "long": -***.393***,
            "net": "Fastly"
        }
    }
    

    GeoLocationのサンプルファイルをダウンロードして、GeoLocation APIをテストしたり、例として活用することができます。


    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.