geoLocation
    • PDF

    geoLocation

    • PDF

    Article Summary

    リクエスト

    API URL

    GET https://geolocation.apigw.ntruss.com/geolocation/v2/geoLocation
    

    リクエストのヘッダー

    ヘッダー名説明
    x-ncp-apigw-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表現し、API Gatewayサーバとの時間差が5分以上の場合は有効でないリクエストとみなす。
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyNAVERクラウドプラットフォームのポータルから発行したAccess Key IDの値
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2Access Key IDの値とSecret Keyで暗号化した署名
    x-ncp-apigw-signature-v2:{API Gateway Signature}

    リクエストパラメータ

    パラメータ名必須タイプ制約事項説明
    ipYStringIPv4アドレス - ウィキペディア地域情報が知りたいユーザのIP
    encNStringutf8(デフォルト値)またはeuckrレスポンス結果のエンコーディングタイプ
    extNStringtまたはf(デフォルト値)追加情報の有無
    t:あり
    f:なし
    responseFormatTypeNStringxml(デフォルト値)またはjsonレスポンス結果のフォーマットタイプ

    レスポンス

    項目タイプ説明
    requestIdStringAPIリクエストのID
    returnCodeString正常Codeは0、その他はエラーコード
    contryString国家コードとしてhttps://ja.wikipedia.org/wiki/ISO_3166
    の他にEU(欧州)、AP(アジア、豪州)、A1(Anonymous Proxy)、A2(Satellite provider)、O1(Other Country)を含む
    codeString韓国の場合は行政自治部で定める行政区域のコードを表示する
    r1String道、広域市、州
    r2String市、郡、区
    r3String洞、面、邑
    latNumber緯度
    longNumber軽度
    netString通信会社名

    例示

    レスポンス

    • 国内、ext=f, xml
    <getLocationResponse>
         <requestId>c4e52003-7879-4216-8eb5-66c93acfd0d2</requestId>
         <returnCode>0</returnCode>
         <geoLocation>
           <country>KR</country>
           <code>4113558000</code>
           <r1>경기도</r1>
           <r2>성남시 분당구</r2>
         </geoLocation>
    </getLocationResponse>
    
    • 国内、ext=f, json
    {
    	"returnCode": 0,
    	"requestId": "c4e52003-7879-4216-8eb5-66c93acfd0d2",
    	"geoLocation": {
    		"country": "KR",
    		"code": "4113558000",
    		"r1": "경기도",
    		"r2": "성남시 분당구"
    	}
    }
    
    • 海外、ext=f, xml
    <getLocationResponse>
         <requestId>c4e52003-7879-4216-8eb5-66c93acfd0d2</requestId>
         <returnCode>0</returnCode>
         <geoLocation>
           <country>US</country>
           <code/>
           <r1>California</r1>
           <r2>San Francisco</r2>
         </geoLocation>
    </getLocationResponse>
    
    • 海外、ext=f, json
    {
    	"returnCode": 0,
    	"requestId": "c4e52003-7879-4216-8eb5-66c93acfd0d2",
    	"geoLocation": {
    		"country": "US",
    		"code": "",
    		"r1": "California",
    		"r2": "San Francisco"
    	}
    }
    
    • 国内、ext=t, xml
    <getLocationResponse>
         <requestId>c4e52003-7879-4216-8eb5-66c93acfd0d2</requestId>
         <returnCode>0</returnCode>
         <geoLocation>
           <country>KR</country>
           <code>4113558000</code>
           <r1>경기도</r1>
           <r2>성남시 분당구</r2>
           <r3>서현1동</r3>
           <lat>37.3829030</lat>
           <long>127.126290</long>
           <net>Korea Net</net>
         </geoLocation>
    </getLocationResponse>
    
    • 国内、ext=t, json
    {
    	"returnCode": 0,
    	"requestId": "c4e52003-7879-4216-8eb5-66c93acfd0d2",
    	"geoLocation": {
    		"country": "KR",
    		"code": "4113558000",
    		"r1": "경기도",
    		"r2": "성남시 분당구",
            "r3": "서현1동",
            "lat": 37.3829030,
            "long": 127.126290,
            "net": "Korea Net"
    	}
    }
    
    • 海外、ext=t, xml
    <getLocationResponse>
         <requestId>c4e52003-7879-4216-8eb5-66c93acfd0d2</requestId>
         <returnCode>0</returnCode>
         <geoLocation>
           <country>US</country>
           <code/>
           <r1>California</r1>
           <r2>San Francisco</r2>
           <r3></r3>
           <lat>37.769700</lat>
           <long>-122.393300</long>
           <net>Fastly</net>
         </geoLocation>
    </getLocationResponse>
    
    • 海外、ext=t, json
    {
    	"returnCode": 0,
    	"requestId": "c4e52003-7879-4216-8eb5-66c93acfd0d2",
    	"geoLocation": {
    		"country": "US",
    		"code": "",
    		"r1": "California",
    		"r2": "San Francisco",
            "r3": "",
            "lat": 37.769700,
            "long": -122.393300,
            "net": "Fastly"
    	}
    }
    

    エラーコード

    エラーコードレスポンスメッセージ説明
    131000No Entry地域情報が見つからない場合に発生します。他のIPを使って照会してください。
    131001Invalid IPパブリックIPでない場合やIPアドレスのフォーマットが間違った場合に発生します。正常なIPアドレスのフォーマットはIPv4 - ウィキペディアをご参照ください。
    131002Internal Server ErrorGeoLocationサーバのエラーにより発生します。一時的でない場合はお客様サポート > お問い合わせにお問い合わせください。
    131003Quota Limit Reached設定したQuotaの上限までのAPIが使用されました。NAVERクラウドプラットフォームのコンソール> AI·NAVER API > GeoLocation > Quota SettingメニューからQuotaを変更することができます。
    131004Subscription RequiredNAVERクラウドプラットフォームのコンソール > AI·NAVER API > GeoLocation > Subscriptionのメニューから利用申込をしてからご利用ください。

    この他のコード値についてはNAVER Cloud Platform 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.