Read-only class representing a position on the earth (latitude and longitude) and information associated with that location (e.g. country, city, etc). The Commerce Cloud Digital system can provide geolocation information for a Request and this information can be used in customer group segmentation rules.
Note: This class is not related to the store locator API (i.e. the GetNearestStores pipelet) which uses a static set of store locations loaded into the system by the merchant.
This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com.
| Property | Description |
|---|---|
available: Boolean (read-only) | Returns ‘true’ if a valid GeoLocation was found for the IP address (meaning at least Latitude and Longitude were found), false otherwise. |
city: String (read-only) | Get the city name in English associated with this location. |
countryCode: String (read-only) | Get the ISO country code associated with this location. |
countryName: String (read-only) | Get the country name in English that the system associates with this location on the earth. |
latitude: Number (read-only) | Get the latitude coordinate associated with this location which is a number between -90.0 and +90.0. |
longitude: Number (read-only) | Get the longitude coordinate associated with this location which is a number between -180.0 and +180.0. |
metroCode: String (read-only) | Get the metro code associated with this location. |
postalCode: String (read-only) | Get the postal code associated with this location. |
regionCode: String (read-only) | Get the region (e.g. |
regionName: String (read-only) | Get the region (e.g. |
| Constructor | Description |
|---|---|
| Geolocation(String, String, String, String, String, String, String, Number, Number) | Constructor for a Geolocation object |
| Method | Description |
|---|---|
| getCity() | Get the city name in English associated with this location. |
| getCountryCode() | Get the ISO country code associated with this location. |
| getCountryName() | Get the country name in English that the system associates with this location on the earth. |
| getLatitude() | Get the latitude coordinate associated with this location which is a number between -90.0 and +90.0. |
| getLongitude() | Get the longitude coordinate associated with this location which is a number between -180.0 and +180.0. |
| getMetroCode() | Get the metro code associated with this location. |
| getPostalCode() | Get the postal code associated with this location. |
| getRegionCode() | Get the region (e.g. |
| getRegionName() | Get the region (e.g. |
| isAvailable() | Returns ‘true’ if a valid GeoLocation was found for the IP address (meaning at least Latitude and Longitude were found), false otherwise. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns 'true' if a valid GeoLocation was found for the IP address (meaning at least Latitude and Longitude were found), false otherwise.
(read-only)Get the city name in English associated with this location.
(read-only)Get the ISO country code associated with this location.
(read-only)Get the country name in English that the system associates with this location on the earth.
(read-only)Get the latitude coordinate associated with this location which is a number between -90.0 and +90.0.
(read-only)Get the longitude coordinate associated with this location which is a number between -180.0 and +180.0.
(read-only)Get the metro code associated with this location.
(read-only)Get the postal code associated with this location.
(read-only)Get the region (e.g. province or state) code for this location.
(read-only)Get the region (e.g. province in state) name in English that the system associates with this location.
Constructor for a Geolocation object
Parameters:
Get the city name in English associated with this location.
Returns:
Get the ISO country code associated with this location.
Returns:
Get the country name in English that the system associates with this location on the earth.
Returns:
Get the latitude coordinate associated with this location which is a number between -90.0 and +90.0.
Returns:
Get the longitude coordinate associated with this location which is a number between -180.0 and +180.0.
Returns:
Get the metro code associated with this location.
Returns:
Get the postal code associated with this location.
Returns:
Get the region (e.g. province or state) code for this location.
Returns:
Get the region (e.g. province in state) name in English that the system associates with this location.
Returns:
Returns 'true' if a valid GeoLocation was found for the IP address (meaning at least Latitude and Longitude were found), false otherwise.
Returns:
j