Gimbal

Automatically send messages based on Gimbal location data.

Gimbal sends their location data to Airship via our Gimbal Adapters. An Airship Gimbal Adapter is a drop-in class for iOS, Android, and Amazon that integrates Gimbal Places events with Airship. The Gimbal data can then be used with the Location and Location Attributes triggers with AutomationA set of conditions that your audience must meet before they receive a message. and JourneysA series of messages that is initiated by a single automation trigger. Airship sends messages in the series based on your timing settings, and you can also set conditions that determine the continuation of the series. .

Gimbal Integration Requirements

Airship

  1. SDK version 6.0 or later: Download the latest stable SDK from appropriate Platform page.
  2. Account Entitlement: Account-level permissions apply, based on your pricing package. Contact Airship Sales with any questions related to pricing and entitlements for location and automation services.

Gimbal

  1. Gimbal Account: Register on gimbal.com.
  2. Gimbal SDK-enabled app: See Gimbal’s iOS and Android Developer Guides.
    • Minimum iOS requirement: v2.8.1 as of Feb 25, 2015.
    • Minimum Android requirement: v2.8.1 as of Feb 25, 2015.

Contact your Gimbal Account Manager with any questions.

Add Gimbal Adapters

Follow the installation instructions:

Configure Gimbal Integration

Gimbal is the system of record for their location data, and all updates to places data are managed by Gimbal. In these steps you will enter your Gimbal Server API Key into your Airship settings, then import your locations.

  1. Go to manager.gimbal.com/organizations.

  2. Copy the Server API Key for the Organization you want to use with Airship.

  3. In Airship, go to Settings » APIs & Integrations » Partner Integrations.

  4. Paste your Gimbal Server API Key in the provided field, then click Save.

  5. Click Sync Now.

    This imports your Gimbal Places as Airship locations so they can be used as location triggers.
     Note

    After the initial import is complete, your locations will automatically sync every 24 hours. The date, time, and time zone of the latest import is listed in the Gimbal section in Settings » APIs & Integrations » Partner Integrations. You can also manually sync your locations at any time by clicking Sync Now.

Now you can use Gimbal data with the Location and Location Attributes triggers.

Manage Gimbal Integration

If you have already configured Gimbal, you have two options in Settings » APIs & Integrations » Partner Integrations:

  • Sync location data from Gimbal: Click Sync Now.
  • Delete your current Gimbal Server API key: Click remove this API Key, then check the box to confirm and click Yes, remove.

Use the Location trigger

The Location trigger initiates an automation or journey based on an audience member’s device location. You can select a maximum of 20 locations per automation or journey.

In the Setup step in an automation or Trigger step in a journey:

  1. Select the Location trigger.

  2. Click Select a Location.

  3. Enter a search term. Results, if any, display on the map and are listed on the Results tab. There are two types of locations available for selection: geofences and beacons.

    Click a result for a detailed view of a location. If selecting a geofence, the map will zoom to the selected location. Click and drag, and use the **+/-** zoom controls to change the displayed area.
  4. On the Results tab, check the box next to the locations you want to use as the trigger.

  5. Review the Selections tab, then click Save and continue.

  6. (Optional) Click Select a Location to add more locations.

  7. Choose whether to trigger your automation or journey when the user enters or exits a location.

Use the Location Attributes trigger

The Location Attributes trigger initiates an automation or journey based on key/value pair metadata associated with a particular location. You can add a maximum of 50 location attributes per automation or journey.

In the Setup step in an automation or Trigger step in a journey:

  1. Select the Location Attributes trigger.

  2. Enter a key/value pair for the location you want to use as the message trigger.

  3. (Optional) Click   to add an alternative location attribute.

  4. (Optional) Click Add Another to add more location attributes.

  5. Select ALL/ANY to determine how to evaluate multiple location attributes and alternatives within each location attribute.

    • ALL = all criteria must be met (boolean AND)
    • ANY = any criteria must be met (boolean OR)
     Note

    By default, the automation or journey is triggered if the audience meets ALL the location attributes. For example, if you selected ALL, with attributes half_off and has_cafe, you’d only reach users who enter or exit locations that meet both conditions. If you select ANY, you’d reach all users who enter a location running a half-off campaign as well as all users who enter a location that has a cafe.

  6. Choose whether to trigger your automation or journey when the user enters or exits a location.

Gimbal Key Terms

Location
A location is a logical place defined by a set of beacons and/or geofences. Locations are the logical entities that are signalled by devices and may be used to trigger automations and journeys.
Attributes
Attributes are key/value pair metadata associated with a particular location, e.g., chain:BobsBurgers, has_blender:yes. Attributes must be defined and assigned to a particular location in the Gimbal system and synced with an Airship account.
Beacon
A beacon represents a physical device used for proximity detection. Beacons may represent hardware implementing the iBeacon standard for use with iOS, or proprietary beacons (such as Gimbal beacons) for use with Android. Beacons may or may not have geolocation data associated with them.
Geofence
A geofence represents a fixed location representable by one or more points in the WGS coordinate system. Geofences can consist of a single point and a radius expressed in meters, defining a circular region, or a series of points defining a polygon.
Place
The Gimbal system refers to your app’s locations as Places. A Place is either a single geofence, one or more beacons, or one or more beacons and a geofence.