Retrieve Data That Salesforce Maps Hosts

The GetHostedData() Apex method retrieves geographical IDs for properties and displays them in Salesforce Maps. We accomplish this retrieval in two requests while using the same method. The first request returns geographical IDs for properties that Salesforce Maps hosts for a specified area and filter criteria. The second request takes these geographical IDs and display parameters, such as legend and popup information, and displays them in Salesforce Maps.

Signature

1Map<String, Object> maps.API.GetHostedData(String parameters)

Where,

maps is the namespace that's available after you install Salesforce Maps.
API is the class that contains the global methods exposed to developers.
GetHostedData() is the method.

Sample Code to Retrieve Geographical IDs

The first example request using the GetHostedData() method returns geographical IDs for women-owned businesses that Salesforce Maps hosts. Those businesses produce revenue between $100,000 and $1,000,000 in a specified area.

If you invoke methods within a flow, process builder, or trigger, do one of the following to avoid uncommitted work errors:

Call the methods through a future method
Call the methods as queueable

Warning

Input Format of the Parameters

1{
2  "mapinfo": { // Boundary area.
3    "offset": integer, // Pagination when the number of results is large.
4    "limit": integer, // Maximum number of geographical IDs to return in response.
5    "celng": decimal, // Longitude coordinate to search closest records.
6    "celat": decimal, // Latitude coordinate to search closest records.
7    "swlng": decimal, // South-Western longitude coordinate for map boundary.
8    "swlat": decimal, // South-Western latitude coordinate for map boundary.
9    "nelng": decimal, // North-Eastern longitude coordinate for map boundary.
10    "nelat": decimal  // North-Eastern latitude coordinate for map boundary.
11  },
12  "data": {
13    "filters": [{}], // Filters to limit the results.
14    "defaultMarkerColor": "String:String", // Hex color : Type of marker to be returned
15    "level_id": "String", // Sub-section of the data specified by file_id.
16    "file_id": "String" // Data being queried, for example, business, property, political boundaries, etc.
17  }
18}

Example

1// Create the boundary area.
2Map<String,Decimal> mapInfo = new Map<String,Decimal>{
3    'nelat' => 49.92293,
4    'nelng' => -55.72265,
5    'swlat' => 29.49698,
6    'swlng' => -140.00976,
7    'celat' => 40.48038,
8    'celng' => -97.86621,
9    'limit' => 6,
10    'offset' => 0            
11};
12
13// Create the filters.
14Map<String,Object> femaleOwned = new Map<String,Object>{
15    'topic_id' => 'female_owned',
16    'operator' => 'equals',
17    'values' => new List<String>{'Yes'}
18};
19Map<String,Object> locationSalesTotal = new Map<String,Object>{
20    'topic_id' => 'location_sales_total',
21    'operator' => 'range',
22    'min' => '100000',
23    'max' => '1000000'
24};
25    
26List<Map<String,Object>> filters = new List<Map<String,Object>>();
27filters.add(femaleOwned);
28filters.add(locationSalesTotal);
29
30// Add the filters and additional 'data' parameters.
31Map<String,Object> dataMap = new Map<String,Object>{
32    'filters' => filters,
33    'defaultMarkerColor' => '93c47d:Circle',
34    'level_id' => '42', 
35    'file_id' => 'business'
36};   
37 
38// Build the request.
39Map<String,Object> request = new Map<String,Object>();
40request.put('data', dataMap);
41request.put('mapinfo', mapInfo);
42String requestString = JSON.serialize(request);
43
44// Call the GetHostedData() method with the boundary area and filter criteria.
45Map<String, Object> response = maps.API.GetHostedData(requestString);
46
47// Log the resulting locations. 
48System.debug(JSON.serialize(response));

Sample Response of Geographical IDs

Although the return value is an Apex Map<String, Object> object, this JSON response illustrates the essential data you receive in the resulting map.

1{
2   "endPoint":"https://internal.na.sfmapsapi.com/data/markers/2",
3   "limitInfo":{
4      "QueryRows":"12 / 50000",
5      "Queries":"8 / 100",
6      "HeapSize":"70683 / 6000000",
7      "CPUTime":"171 / 10000"
8   },
9   "request":"{\"mapinfo\":{\"offset\":0,\"limit\":6,\"celng\":-97.86621,\"celat\":40.48038,\"swlng\":-140.00976,\"swlat\":29.49698,\"nelng\":-55.72265,\"nelat\":49.92293},\"data\":{\"filters\":[{\"values\":[\"Yes\"],\"operator\":\"equals\",\"topic_id\":\"female_owned\"},{\"max\":\"1000000\",\"min\":\"100000\",\"operator\":\"range\",\"topic_id\":\"location_sales_total\"}],\"defaultMarkerColor\":\"93c47d:Circle\",\"level_id\":\"42\",\"file_id\":\"business\"}}",
10   "params":{
11      "data":{
12         "file_id":"business",
13         "level_id":"42",
14         "defaultMarkerColor":"93c47d:Circle",
15         "filters":[
16            {
17               "topic_id":"female_owned",
18               "operator":"equals",
19               "values":[
20                  "Yes"
21               ]
22            },
23            {
24               "topic_id":"location_sales_total",
25               "operator":"range",
26               "min":"100000",
27               "max":"1000000"
28            }
29         ]
30      },
31      "mapinfo":{
32         "nelat":49.92293,
33         "nelng":-55.72265,
34         "swlat":29.49698,
35         "swlng":-140.00976,
36         "celat":40.48038,
37         "celng":-97.86621,
38         "limit":6,
39         "offset":0
40      }
41   },
42   "success":true,
43   "data":{ // List of geographical IDs.
44      "ids":[
45         "11140017125231",
46         "11140017127280",
47         "11140017102994",
48         "11140017127285",
49         "11132553548894",
50         "11140017127286"
51      ]
52   }
53}

Sample Code to Display Geographical IDs

The second request using the GetHostedData() method takes the geographical IDs and display parameters, such as legend and popup information, and displays them in Salesforce Maps.