Esri s Geotrigger Service. Overview, Use Cases Getting Started with the SDK & API

Transcription

1 Esri s Geotrigger Service Overview, Use Cases Getting Started with the SDK & API

2 Overview

3 GeoEvent Processor On premise server appliance Can be installed behind firewalls Dedicated industrial-strength GPS Life or death? Choose GeoEvent Processor

4 Geotrigger Service Cloud-based Consumer-grade GPS Perfect for ios and Android apps

5 What could your app do if it knew where it was?

6 What is a Geotrigger?

7 What about Battery Drain?

8 Increases power near content Decreases power use away from content

9 Delayed Messaging Text Rough Label Mode Least Battery Drain

10 Fastest Messaging Text Fine Label Mode Most Battery Drain

11 Fast Messaging Text Adaptive Label Mode Minimal Drain

12

13 Use Cases

14 20% off sale!

15 traffic ahead!

16 Home / Business Automation When you get home, your lights turn on! When you leave, your lights turn off!

17 Realtime Games pdx.esri.com

18 Use Cases Civic apps for tourists Realtime arrival notifications Nearby events

19 Getting Started

20 Create an account at developers.arcgis.com/en/sign-up/ or log in if you already have an account

21 Create an application developers.arcgis.com/en/applications/

22 Register for Push Notifications ios Go to your Apple Developer account to get a Push Certificate (ios) Make sure the push cert has been set on your app and that your app is registered to handle push notifications Screenshot ios Push Notification

23 Register for Push Notifications Android Get a GCM key (Google) Make sure the GCM key is in the push notification settings for your app and that you have set your GCM sender ID when you initialize the Geotrigger Service. developer.android.com/google/gcm/

24 Test your Push Notifications!

25 SDKs for ios and Android Wraps native location services on each platform Provides a set of tracking profiles for low, medium, and high power consumption Push Notification Handling

26 App Project SDK

27 Geotrigger SDK for ios Get the SDK from Github or CocoaPods pod GeotriggerSDK Make sure your app has Location Updates and Background Fetch background modes enabled Call one of the setupwithclientid: methods

28 Geotrigger SDK for Android Get the Sample App and SDK from GitHub: github.com/esri/geotrigger sdk android Make sure to change the package name in the sample app or add the required permissions to your existing AndroidManifest.xml Use the GeotriggerHelper to start the Geotrigger Service

29 Test your triggers! Create test triggers with the Geotrigger Editor Walk around outside to test that push notifications are working 100m radius recommended for Adaptive mode

30 Geotrigger API Manage devices, triggers, and tags Access trigger history Build custom statistics

31 Submitting Your App to itunes Location should not be the only part of your app Include location information as part of app description Be prepared for app rejection, so submit at least 2-3 weeks before you plan to launch

32 What s Next? Battery improvements Bug fixes Template app to get you up and running right out of the box

33 Geotrigger Service API

34 API Overview Triggers Tags Location Update Callback Payload Custom Notifications

35 Authentication The Geotrigger API uses OAuth2 All requests to the Geotrigger API are made with an access token To get an access token for your application, make a request with the client_id and client_secret to the oauth2/token endpoint of ArcGIS Online

36 Triggers Triggers define the logic you want to happen when users enter or leave a place Triggers have a location that can be a circle or a polygon (EsriJSON or GeoJSON) Date and time ranges can restrict when triggers are active Triggers can have a limit to the number of times they can be fired

37 Tags Used to group and associate triggers and devices Device will only fire a trigger if both share a tag Ex. Trigger labeled with restaurant tag, user subscribes to restaurant coupons.

38 Geotrigger Editor

39 Editor Overview A visual interface for listing, creating, editing, and deleting triggers with the Geotrigger API List all triggers and filter by tag or trigger ID Draw trigger boundaries as circles and polygons Define and update trigger rules

40 Geotrigger API Routes /trigger/list List all triggers associated with an application /trigger/create Create a new trigger with parameters specified in JSON POST /trigger/update Update one or more triggers by ID /trigger/delete Delete a trigger by ID

41 Geotrigger Editor: List View

42 /trigger/list List all triggers associated with an application All parameters are optional, used for filtering results: { } "triggerids": [...], "tags": [...], "geo": {...}, These parameters are also used to be able to update multiple triggers at once

43 { } /trigger/list response "triggers": [ { "triggerid": "portland_city_greeting", "condition": {... }, "action": {... }, "tags": [... ], } ], "boundingbox": { "xmin": , "ymin": , "xmax": , "ymax": , "spatialreference": {"wkid": 4326} }

44 Trigger Components Condition Geometry (polygon or circle) Direction (enter or leave) Action Notification, Callback URL or change Tracking Profile Tag Group content by category

45 Geotrigger Editor: Create/Update View

46 Geotrigger Editor: Create View Tags

47 Geotrigger Editor: Create View Condition

48 Geotrigger Editor: Create View Action

49 Geotrigger Editor: Create View Advanced Properties

50 POST /trigger/create { } "condition": { "direction": "enter", "geo": { "latitude": , "longitude": , "distance": 240 } }, "action": { "callbackurl": " }, "settags": ["office", "red", blue ], "token": "..."

51 Advanced Trigger Properties Custom Trigger ID Unique identifier for the trigger. Can be specified on create, but cannot be updated. Rate Limit Minimum number of seconds between executions, per device. Default 30. Set to 0 for no minimum. Times Maximum number of executions, per device. Default 0 for no maximum. Properties Arbitrary properties saved with the trigger.

52 Advanced Trigger Properties There are more options not yet covered by the editor that you can access programmatically: boundingbox geoformat fromtimestamp & totimestamp (part of condition)

53 POST /trigger/update { } "triggerids": [... ], "condition": {... }, "action": {... }, // to manage tags, you can use addtags, removetags, or settags "addtags": [... ], "token": "..." Update multiple triggers by passing more than one ID in the triggerids array, selecting by tag, or by geography

54 Managing Tags Manage tags using addtags, removetags, and settags addtags: array of tags to add to the set of current tags removetags: array of tags to remove from set of current tags settags: array of tags to replace the current set of tags Applies to triggers & devices. SDK usually used to manage device tags

55 Geotrigger Faker

56 Faker Overview A web application for sending location updates and testing triggers Create a fake device or spoof an existing device by using a refresh token Draw a point and radius to send location updates and fire triggers from the comfort of your workspace

57 Geotrigger Faker: Sending Location Updates

58 POST /location/update { } "locations": [ { "latitude": , "longitude": , "accuracy": 55, "timestamp": " T17:07:24.727Z" } ], "previous": { "latitude": , "longitude": , "accuracy": 67, "timestamp": " T17:07:27.313Z" }

59 Callback Payload JSON data that is sent to a callback URL when a trigger is fired Enabled by specifying the callbackurl parameter within the trigger action. Can be used to create a customized app experience

60 { } "triggeredat": { "iso8601": " T21:23: :00", "unix": }, "trigger": { "triggerid": "Barista", "condition": {... }, "action": {... }, "times": 0, "ratelimit": 0, "tags": [...] }, "device": { "deviceid": wkzsnenycw5saint", "tags": [...] }, "location": { "latitude": , "longitude": , "accuracy": 17, "trackingprofile": "adaptive", "timestamp": " T21:23: :00" } Callback Payload

61 Custom Notifications API provides a way to send a notification to a device Can be used with callback payload to send customized push notifications Target devices by ID, geography or tag

62 POST /device/notify // request { "tags": ["red"], "text": "Hello!", "data": {"foo": bar"} } // response {"devices": [ {"3XgGh30aTlEKlK91": "queued"}, {" u9yasdjkn": "queued"} ]}

63 Full Documentation Detailed documentation online on the developers site:

64 Open Source Geotrigger Editor & Geotrigger Faker are open source github.com/esri/geotrigger-editor github.com/esri/geotrigger-faker github.com/esri/geotrigger-js github.com/esri/geotrigger-ruby github.com/esri/geotrigger-go github.com/esri/geotrigger-python

65 Test Outside Create Triggers Take device out in real world Take laptop too! Use Geotrigger Editor & Geotrigger Faker to dynamically modify shape & size of triggers and to test location updates Err on the side of larger triggers

66 Developer Friendly The Geotrigger Service has been created to be easy for ios and Android developers to drop into their existing apps, or to build new apps around Expand to other systems where locations are known by using location/update Keep eye out for Esri-built solution apps for most common workflows

67