data.md

Data

Learn more about how to get access to user information.

• Introduction
• ON_PERMISSION
• Name
• Location
• Date and Time
• Account Linking

Introduction

User information is mainly used to offer a more personalized experience, but you can't access it right away. First you have to ask for permission.

ON_PERMISSION

After the user has answered your request, they will be redirected to the ON_PERMISSION intent, if available, where you can access and store the data.

ON_PERMISSION() {
  
}

Name

You can get access to the user's given name, family name and display name.

// @language=javascript

// Ask for permission
this.$googleAction.askForName(speech);

// @language=typescript

// Ask for permission
this.$googleAction!.askForName(speech: string);

// @language=javascript

ON_PERMISSION() {
  if (this.$googleAction.isPermissionGranted()) {

    // Check, if you have the necessary permission
    if (this.$googleAction.$user.hasPermission('NAME')) {
      let profile = this.$googleAction.$user.getProfile();
      /* 
        profile.givenName
        profile.familyName
        profile.displayName
      */
    }
  }
}

// @language=typescript

ON_PERMISSION() {
  if (this.$googleAction!.isPermissionGranted()) {

    // Check, if you have the necessary permission
    if (this.$googleAction!.$user.hasPermission('NAME')) {
      let profile = this.$googleAction!.$user.getProfile();
      /* 
        profile.givenName
        profile.familyName
        profile.displayName
      */
    }
  }
}

Location

Get access to the user's location. Depending on the device the request comes from and the permission you have, you can get access to different data.

If it's a phone, you can only access the latitude and longitude with the DEVICE_PRECISE_LOCATION permission.

On a voice-enabled speaker you can access all of the data, depending on the permission you have.

// @language=javascript

this.$googleAction.askForPreciseLocation(speech);

this.$googleAction.askForZipCodeAndCity(speech);

// @language=typescript

this.$googleAction.askForPreciseLocation(speech: string);

this.$googleAction.askForZipCodeAndCity(speech: string);

// @language=javascript

ON_PERMISSION() {
  if (this.$googleAction.isPermissionGranted()) {

    // Check, if you have the necessary permission
    if (this.$googleAction.$user.hasPermission('DEVICE_COARSE_LOCATION')) {
      let device = this.$googleAction.getDevice();
      /*
        device.location.city
        device.location.zipCode
      */
    }
    if (this.$googleAction.$user.hasPermission('DEVICE_PRECISE_LOCATION')) {
      let device = this.$googleAction.getDevice();
      /*
        device.location.coordinates.latitude
        device.location.coordinates.longitude
        device.location.formattedAddress
        device.location.city
        device.location.zipCode
      */
    }
  } else {
    this.tell('Alright, maybe next time');
  }
},

// @language=typescript

ON_PERMISSION() {
  if (this.$googleAction!.isPermissionGranted()) {

    // Check, if you have the necessary permission
    if (this.$googleAction!.$user.hasPermission('DEVICE_COARSE_LOCATION')) {
      let device = this.$googleAction!.getDevice();
      /*
        device.location.city
        device.location.zipCode
      */
    }
    if (this.$googleAction!.$user.hasPermission('DEVICE_PRECISE_LOCATION')) {
      let device = this.$googleAction!.getDevice();
      /*
        device.location.coordinates.latitude
        device.location.coordinates.longitude
        device.location.formattedAddress
        device.location.city
        device.location.zipCode
      */
    }
  } else {
    this.tell('Alright, maybe next time');
  }
},

Official Documentation

Example

Place and Location

You can also prompt the user for their current location using the askForPlace() helper:

// @language=javascript

this.$googleAction.askForPlace('Where would you like to be picked up?', 'To find a place to pick you up');

// @language=typescript

this.$googleAction!.askForPlace('Where would you like to be picked up?', 'To find a place to pick you up');

The user's response will be mapped to the ON_PLACE intent, where you can access the user's input using the getPlace() method:

// @language=javascript

ON_PLACE() {
  const place = this.$googleAction.getPlace();
}

// @language=typescript

ON_PLACE() {
  const place = this.$googleAction!.getPlace();
}

Here's an example for the place object you will receive:

{
  "formattedAddress": "123 Main Street, Springfield, OR 97477-5319, USA",
  "coordinates": {
          "latitude": 44.0461033,
          "longitude": -123.024248
  },
  "name": "123 Main St"
},

Date and Time

You can request the user's date and time using the following helper method:

// @language=javascript

this.$googleAction.askForDateTime({
    requestTimeText: 'What time?',
    requestDateText: 'What day was that?',
    requestDatetimeText: 'When would you like to schedule the appointment?',
});

// @language=typescript

this.$googleAction!.askForDateTime({
    requestTimeText: 'What time?',
    requestDateText: 'What day was that?',
    requestDatetimeText: 'When would you like to schedule the appointment?',
});

The user's response will be mapped to the ON_DATETIME intent, where you can access their response object using this.$googleAction.getDateTime():

// @language=javascript

ON_DATETIME() {
    const dateTime =  this.$googleAction.getDateTime();
}

// @language=typescript

ON_DATETIME() {
    const dateTime =  this.$googleAction!.getDateTime();
}

Here's an example how the DATETIME object you receive would look like:

{
    "date": {
        "month": 5,
        "year": 2019,
        "day": 3
    },
    "time": {
        "hours": 11,
        "minutes": 30
    }
},

Account Linking

You can find the documentation about Account Linking here: App Logic > Data