API
TrainingSupportCommunity

userLocation

  • Property Manager name: User Location Data
  • Criteria version: The v2024-10-21 rule format supports the userLocation criteria v1.2.
  • Rule format status: GA, stable
  • Access: Read/Write
  • Allowed in includes: Yes

The client browser's approximate geographic location, determined by looking up the IP address in a database.

OptionTypeDescriptionRequires
fieldenum

Indicates the geographic scope.

{"displayType":"enum","options":["COUNTRY","CONTINENT","REGION"],"tag":"select"}
COUNTRY
Country.
CONTINENT
Continent.
REGION
States or provinces within a country.
match​Operatorenum 
Matches the specified set of values when set to IS_​ONE_​OF, otherwise IS_​NOT_​ONE_​OF reverses the match.
{"displayType":"enum","options":["IS_ONE_OF","IS_NOT_ONE_OF"],"tag":"select"}
IS_​ONE_​OF
Matches any of the specified values.
IS_​NOT_​ONE_​OF
Does not match any of the specified values.
country​Valuesstring array 
ISO 3166-1 country codes, such as US or CN.
field is COUNTRY
{"displayType":"string array","options":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","EU","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GH","GI","GG","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TM","TN","TO","TL","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"tag":"select"}
{"if":{"attribute":"field","op":"eq","value":"COUNTRY"}}
continent​Valuesstring array 
Continent codes.
field is CONTINENT
{"displayType":"string array","options":["AF","AS","EU","NA","OC","OT","SA"],"tag":"select"}
{"if":{"attribute":"field","op":"eq","value":"CONTINENT"}}
AF
Africa.
AS
Asia.
EU
Europe.
NA
North America.
OC
Oceania.
OT
Antarctica.
SA
South America.
region​Valuesstring array 
ISO 3166 country and region codes, for example US:MA for Massachusetts or JP:13 for Tokyo.
field is REGION
{"displayType":"string array","options":["US-AL","US-AK","US-AZ","US-AR","US-CA","US-CO","US-CT","US-DE","US-DC","US-FL","US-GA","US-HI","US-ID","US-IL","US-IN","US-IA","US-KS","US-KY","US-LA","US-ME","US-MD","US-MA","US-MI","US-MN","US-MS","US-MO","US-MT","US-NE","US-NV","US-NH","US-NJ","US-NM","US-NY","US-NC","US-ND","US-OH","US-OK","US-OR","US-PA","US-RI","US-SC","US-SD","US-TN","US-TX","US-UT","US-VT","US-VA","US-WA","US-WV","US-WI","US-WY","CA-AB","CA-BC","CA-MB","CA-NB","CA-NF","CA-NS","CA-NT","CA-NU","CA-ON","CA-PE","CA-QC","CA-SK","CA-YT","AU-ACT","AU-NSW","AU-NT","AU-QLD","AU-SA","AU-TAS","AU-VIC","AU-WA","GB-EN","GB-NI","GB-SC","GB-WA","JP-00","JP-01","JP-02","JP-03","JP-04","JP-05","JP-06","JP-07","JP-08","JP-09","JP-10","JP-11","JP-12","JP-13","JP-14","JP-15","JP-16","JP-17","JP-18","JP-19","JP-20","JP-21","JP-22","JP-23","JP-24","JP-25","JP-26","JP-27","JP-28","JP-29","JP-30","JP-31","JP-32","JP-33","JP-34","JP-35","JP-36","JP-37","JP-38","JP-39","JP-40","JP-41","JP-42","JP-43","JP-44","JP-45","JP-46","JP-47","BR-AC","BR-AL","BR-AM","BR-AP","BR-BA","BR-CE","BR-DF","BR-ES","BR-GO","BR-IS","BR-MA","BR-MG","BR-MS","BR-MT","BR-PA","BR-PB","BR-PE","BR-PI","BR-PR","BR-RJ","BR-RN","BR-RO","BR-RR","BR-RS","BR-SC","BR-SE","BR-SP","BR-TO","DE-BB","DE-BE","DE-BW","DE-BY","DE-HB","DE-HE","DE-HH","DE-MV","DE-NI","DE-NW","DE-RP","DE-SH","DE-SL","DE-SN","DE-ST","DE-TH","FR-ARA","FR-BFC","FR-BRE","FR-CVL","FR-COR","FR-GES","FR-HDF","FR-IDF","FR-NOR","FR-NAQ","FR-OCC","FR-PDL","FR-PAC","CH-AG","CH-AI","CH-AR","CH-BE","CH-BL","CH-BS","CH-FR","CH-GE","CH-GL","CH-GR","CH-JU","CH-LU","CH-NE","CH-NW","CH-OW","CH-SG","CH-SH","CH-SO","CH-SZ","CH-TG","CH-TI","CH-UR","CH-VD","CH-VS","CH-ZG","CH-ZH","CN-AH","CN-BJ","CN-CQ","CN-FJ","CN-GS","CN-GD","CN-GX","CN-GZ","CN-HI","CN-HE","CN-HL","CN-HA","CN-HB","CN-HN","CN-JS","CN-JX","CN-JL","CN-LN","CN-NM","CN-NX","CN-QH","CN-SN","CN-SD","CN-SH","CN-SX","CN-SC","CN-TJ","CN-XJ","CN-XZ","CN-YN","CN-ZJ","IN-AN","IN-AP","IN-AR","IN-AS","IN-BR","IN-CH","IN-CT","IN-DD","IN-DL","IN-DN","IN-GA","IN-GJ","IN-HP","IN-HR","IN-JH","IN-JK","IN-KA","IN-KL","IN-LD","IN-MH","IN-ML","IN-MN","IN-MP","IN-MZ","IN-NL","IN-OR","IN-PB","IN-PY","IN-RJ","IN-SK","IN-TG","IN-TN","IN-TR","IN-UL","IN-UP","IN-WB","SE-K","SE-X","SE-I","SE-N","SE-Z","SE-F","SE-H","SE-W","SE-G","SE-BD","SE-T","SE-E","SE-D","SE-C","SE-S","SE-AC","SE-Y","SE-U","SE-AB","SE-M","SE-O","MX-AGU","MX-BCN","MX-BCS","MX-CAM","MX-CHP","MX-CHH","MX-COA","MX-COL","MX-DIF","MX-DUR","MX-GUA","MX-GRO","MX-HID","MX-JAL","MX-MEX","MX-MIC","MX-MOR","MX-NAY","MX-NLE","MX-OAX","MX-PUE","MX-QUE","MX-ROO","MX-SLP","MX-SIN","MX-SON","MX-TAB","MX-TAM","MX-TLA","MX-VER","MX-YUC","MX-ZAC","UA-CK","UA-CH","UA-CV","UA-CRIMEA","UA-DP","UA-DT","UA-IF","UA-KK","UA-KS","UA-KM","UA-KV","UA-KH","UA-LH","UA-LV","UA-MY","UA-OD","UA-PL","UA-RV","UA-SM","UA-TP","UA-ZK","UA-VI","UA-VO","UA-ZP","UA-ZT","ES-AN","ES-AR","ES-AS","ES-CB","ES-CE","ES-CL","ES-CM","ES-CN","ES-CT","ES-EX","ES-GA","ES-IB","ES-MC","ES-MD","ES-ML","ES-NC","ES-PV","ES-RI","ES-VC","BE-BRU","BE-VLG","BE-WAL","TH-10","TH-11","TH-12","TH-13","TH-14","TH-15","TH-16","TH-17","TH-18","TH-19","TH-20","TH-21","TH-22","TH-23","TH-24","TH-25","TH-26","TH-27","TH-30","TH-31","TH-32","TH-33","TH-34","TH-35","TH-36","TH-37","TH-38","TH-39","TH-40","TH-41","TH-42","TH-43","TH-44","TH-45","TH-46","TH-47","TH-48","TH-49","TH-50","TH-51","TH-52","TH-53","TH-54","TH-55","TH-56","TH-57","TH-58","TH-60","TH-61","TH-62","TH-63","TH-64","TH-65","TH-66","TH-67","TH-70","TH-71","TH-72","TH-73","TH-74","TH-75","TH-76","TH-77","TH-80","TH-81","TH-82","TH-83","TH-84","TH-85","TH-86","TH-90","TH-91","TH-92","TH-93","TH-94","TH-95","TH-96","ID-AC","ID-BA","ID-BB","ID-BE","ID-BT","ID-GO","ID-JA","ID-JB","ID-JI","ID-JK","ID-JT","ID-KB","ID-KI","ID-KR","ID-KS","ID-KT","ID-KU","ID-LA","ID-MA","ID-MU","ID-NB","ID-NT","ID-PA","ID-PB","ID-RI","ID-SA","ID-SB","ID-SG","ID-SN","ID-SR","ID-SS","ID-ST","ID-SU","ID-YO","MY-01","MY-02","MY-03","MY-04","MY-05","MY-06","MY-07","MY-08","MY-09","MY-10","MY-11","MY-12","MY-13","MY-14","MY-15","MY-16","VN-01","VN-02","VN-03","VN-04","VN-05","VN-06","VN-07","VN-09","VN-13","VN-14","VN-18","VN-20","VN-21","VN-22","VN-23","VN-24","VN-25","VN-26","VN-27","VN-28","VN-29","VN-30","VN-31","VN-32","VN-33","VN-34","VN-35","VN-36","VN-37","VN-39","VN-40","VN-41","VN-43","VN-44","VN-45","VN-46","VN-47","VN-49","VN-50","VN-51","VN-52","VN-53","VN-54","VN-55","VN-56","VN-57","VN-58","VN-59","VN-61","VN-63","VN-66","VN-67","VN-68","VN-69","VN-70","VN-71","VN-72","VN-73","VN-CT","VN-DN","VN-HN","VN-HP","VN-SG","PH-00","PH-ABR","PH-AGN","PH-AGS","PH-AKL","PH-ALB","PH-ANT","PH-APA","PH-AUR","PH-BAN","PH-BAS","PH-BEN","PH-BIL","PH-BOH","PH-BTG","PH-BTN","PH-BUK","PH-BUL","PH-CAG","PH-CAM","PH-CAN","PH-CAP","PH-CAS","PH-CAT","PH-CAV","PH-CEB","PH-COM","PH-DAO","PH-DAS","PH-DAV","PH-DIN","PH-DVO","PH-EAS","PH-GUI","PH-IFU","PH-ILI","PH-ILN","PH-ILS","PH-ISA","PH-KAL","PH-LAG","PH-LAN","PH-LAS","PH-LEY","PH-LUN","PH-MAD","PH-MAG","PH-MAS","PH-MDC","PH-MDR","PH-MOU","PH-MSC","PH-MSR","PH-NCO","PH-NEC","PH-NER","PH-NSA","PH-NUE","PH-NUV","PH-PAM","PH-PAN","PH-PLW","PH-QUE","PH-QUI","PH-RIZ","PH-ROM","PH-SAR","PH-SCO","PH-SIG","PH-SLE","PH-SLU","PH-SOR","PH-SUK","PH-SUN","PH-SUR","PH-TAR","PH-TAW","PH-WSA","PH-ZAN","PH-ZAS","PH-ZMB","PH-ZSI"],"tag":"select"}
{"if":{"attribute":"field","op":"eq","value":"REGION"}}
check​Ipsenum 
Specifies which IP addresses determine the user's location.
{"displayType":"enum","options":["BOTH","CONNECTING","HEADERS"],"tag":"select"}
BOTH
Behaves like HEADERS, but also considers the connecting client's IP address.
CONNECTING
Considers the connecting client's IP address.
HEADERS
Considers IP addresses specified in the X-Forwarded-For header, succeeding if any of them match.
use​Only​First​XForwarded​For​Ipboolean 
When connecting via a proxy server as determined by the X-Forwarded-For header, enabling this option matches the end client specified in the header. Disabling it matches the connecting client's IP address.
check​Ips is either: BOTH, HEADERS
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"checkIps","op":"in","value":["BOTH","HEADERS"]}}