Geotrigger Service: Overview, Location Services, …...Geotrigger Service: Overview, Location Services, and Use Cases Author Esri Subject 2015 Esri Asia Pacific User Conference--Presentation

Geotrigger Service: Overview, Location

Services, and Use CasesKen Leung

Sam Wong

Geotrigger Service

• Cloud-based

• Consumer-grade GPS

• Perfect for iOS and Android apps

Geotrigger Service: Overview, Location Services, and Use Cases

GeoEvent Processor

• On premise server appliance

• Can be installed behind firewalls

• Dedicated industrial-strength GPS

• Life or death? Choose GeoEvent Processor

• Tomorrow: 4:00PM Location: S227


What could your app do

if it knew where it was?



What about

Battery

Drain?


Increases power

near content

Decreases

power use

away from

content


Text

Label

Rough

Mode

Least Battery

Drain

Delayed

Messaging


Text

Label

Fine

Mode

Most Battery

Drain

Fastest

Messaging


Text

Label

Adaptive

Mode

Less

Drain

Fast

Messaging



Use Cases

This bridge will be closed on Saturday for maintenance!


traffic ahead!


New house

for sale!


Historic town hall, founded in 1897 on Capitol St.



Getting Started

Create an account at developers.arcgis.com/en/sign-up/

or log in if you already have an account


http://developers.arcgis.com/en/sign-up/

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


http://developers.arcgis.com/en/applications/

Register for Push Notifications

Apple

• 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

• https://developer.apple.com/notifications/


https://developer.apple.com/notifications/

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/


https://developer.android.com/google/gcm/

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


SDKApp Project


Geotrigger SDK for iOS

• Get the SDK from Github or CocoaPods• pod ‘GeotriggerSDK’

• Ensure your app has ‘Location Updates’ and

‘Background Fetch’ background modes enabled

• Call one of the setupWithClientId: methods


Geotrigger SDK for Android

• Get the Sample App and SDK from GitHub:• github.com/esri/geotrigger-sdk-android

• 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


http://github.com/esri/geotrigger-sdk-android

Test your triggers!

• Create test triggers

• Walk around outside to test push notifications

• 100m radius minimum


Geotrigger API

• Manage devices, triggers, and

tags

• Access trigger history

• Build custom statistics


Submitting Your App to iTunes

• Location should be used to enhance

• Explain why you are using location in app

description

• Be prepared for app rejection, so submit at

least 2-3 weeks before you plan to launch


Geotrigger Service API

Authentication

• The Geotrigger API uses OAuth2

• Requests to the Geotrigger API require an access token

• To get an access token make a request with the client_id and client_secret to the

“oauth2/token” endpoint of ArcGIS Online

• Devices register with ArcGIS Online using only the client_id, and are given a refresh

token in addition to the access token.


Triggers

• Define what happens when someone enters or leaves 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


Tags

• Used to associate triggers with devices

• Device must share a tag with a trigger to fire the trigger

• Example: Trigger labeled with ‘restaurant’ tag, user subscribes to ‘restaurant’

coupons.


Geotrigger Editor

Editor Overview

• A visual interface for managing triggers

• List all triggers and filter by tag or trigger ID

• Create triggers by drawing trigger boundaries as circles and polygons

• Define and update trigger rules


Geotrigger API Routes

• /trigger/list

• /trigger/create

• /trigger/update

• /trigger/delete


Geotrigger Editor: List View


/trigger/list


{"triggerIds": [...],"tags": [...],"geo": {...},

}

• List all triggers associated with an application

• All parameters are optional, used for filtering results:

Geotrigger Editor: Create/Update View

• Geotrigger Service: Overview, Location Services, and Use Cases

Tags


Condition


Action


Advanced Properties


POST /trigger/create

{"condition": {"direction": "enter","geo": {

"latitude": 45.5165,"longitude": -122.6764,"distance": 240

}},"action": {"callbackUrl": "http://example.com/trigger",

},"setTags": ["office", "red", “blue”],

}


Advanced Trigger Properties

• Trigger ID

- Custom IDs can be specified on create, but cannot be updated.

• Rate Limit

- 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.


Demo

Geotrigger Editor

Geotrigger Faker

Faker Overview

• A web application for sending location updates and testing triggers

• Create a fake device or spoof an existing device

• Draw a point and radius to send location updates and fire triggers from the comfort

of your workspace


Geotrigger Faker: Sending Location Updates


POST /location/update

{"locations": [{

"latitude": 45.5194753769039,"longitude": -122.67609357921172,"accuracy": 55,"timestamp": "2014-03-11T17:07:24.727Z"

}],"previous": {"latitude": 45.51976103506265,"longitude": -122.67519235698273,"accuracy": 67,"timestamp": "2014-03-11T17:07:27.313Z"

}}


Callback Payload

• JSON data that is sent to a callback URL when a trigger is fired

• Enable the callbackURL parameter within the trigger action.

• Can be used to create a customized app experience


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


POST /device/notify

// request{

"tags": ["red"], "text": “Welcome Red Team!", "data": {"foo": “bar"}

}

// response{"devices": [

{"3XgGh30aTlEKlK91": "queued"},{"8907123u9yasdjkn": “queued"}]

}


Demo

Geotrigger Faker

Use Case Demo

Demo

Global Triggers

Self-Guided Tour

Demo

Labeled Triggers

Personalized Offers

Demo

Labeled Devices

Workforce Management

Demo

Combination Use Cases

Geo Coupon

Open Source

• Geotrigger Editor & Geotrigger Faker are open source

- github.com/esri/geotrigger-editor

- github.com/esri/geotrigger-faker

• Client Libraries in various languages:

- github.com/esri/geotrigger-js

- github.com/esri/geotrigger-ruby

- github.com/esri/geotrigger-go

- github.com/esri/geotrigger-python

http://github.com/esri/geotrigger-editor

http://github.com/esri/geotrigger-faker

http://github.com/esri/geotrigger-js

http://github.com/esri/geotrigger-ruby

http://github.com/esri/geotrigger-go

http://github.com/esri/geotrigger-python

Share your moment #EsriAPUC

Geotrigger Service: Overview, Location Services, …...Geotrigger Service: Overview, Location Services, and Use Cases Author Esri Subject 2015 Esri Asia Pacific User Conference--Presentation

Documents