ジオロケーションデータの取得

公開APIであるGeoIPManagerサービスを使用して、特定のIPアドレスのGeoIPデータを取得します。

Sitecore.CES.GeoIp.Core.IGeoIpManager.GetGeoIpData(string ipAddress,TimeSpan? timeout = null)

特定のIPアドレスに対してAPIを呼び出すと、次の順序でGeoIPデータの存在がチェックされます。

結果が見つかった場合、それ以上のチェックは行いません。次のセクションでは、さまざまな場所をチェックする方法について詳しく説明します。

<setting name="CES.GeoIp.Caching.GeoIpCacheExpiryTime" value="1:00:00:00"/>
<setting name="CES.GeoIp.Caching.GeoIpCacheSize" value="5MB"/>

次の例は、Sitecore.CES.GeoIp.Core.IGeoIpManagerAPIを使用して特定のIPアドレスの国を解決する方法を示しています。  

using Microsoft.Extensions.DependencyInjection;
using Sitecore.CES.GeoIp.Core;
using Sitecore.CES.GeoIp.Core.Model;
using Sitecore.DependencyInjection;
public string GetCountryByIp(string ipAddress)
{
    try
    {
        var country = string.Empty;

            var geoIpManager = ServiceLocator.ServiceProvider.GetRequiredService<IGeoIpManager>();

            var geoIpFetchedData = geoIpManager.GetGeoIpData(ipAddress);

            if (geoIpFetchedData.Status == GeoIpFetchDataStatus.Fetched && geoIpFetchedData.WhoIsInformation != null)
            {
                country = geoIpFetchedData.WhoIsInformation.Country;
            }    
    }
    catch (Exception)
    {
        // Handle the exceptions
    }
    return country;
}

GetGeoIpDataメソッドには、TimeSpan timeoutというオプションのパラメーターがあります。これは、メソッドがデータの解決を待機する時間を指定します。メソッドが指定された時間内にデータを取得できない場合、プロセスはUnknown Ip Address with Timeout statusを返し、バックグラウンドで続行します。これにより、データの解決に時間がかかりすぎる場合に、メソッドが要求をブロックするのを防ぐことができます。このパラメーターをメソッドに渡さない場合は、CES.GeoIp.LookupRequestTimeoutで指定された値が使用されます。タイムアウトを数秒以下に設定して、データ解決の遅延が発生した場合にページの読み込みに余分な実行時間が追加されないようにすることをお勧めします。

タイムアウトをTimeSpan.Maxに設定すると、メソッドはサービスからの応答を永久に待機します。

APIは、タイプがSitecore.CES.GeoIp.Core.Model.GeoIpFetchedDataのオブジェクトを返します。このオブジェクトには、Sitecore.CES.GeoIp.Core.Model.GeoIpFetchDataStatusの結果のステータスと地理データの結果が含まれます。ステータス値は、次のいずれかです。

このAPIは今後のバージョンで削除される予定ですが、現時点では下位互換性のために存在します。内部的には、GeoIpManagerサービスを呼び出します。