Skip to content

Latest commit

 

History

History
130 lines (98 loc) · 4.32 KB

data.md

File metadata and controls

130 lines (98 loc) · 4.32 KB

Platform Specific Features > Google Assistant > Data

Learn more about how to get access to user information.

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 availabe, where you can access and store the data.

'ON_PERMISSION': function() {
  
}

Name

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

// Ask for permission
this.googleAction().askForName(speech);
'ON_PERMISSION': function() {
  if (this.googleAction().isPermissionGranted()) {
    let user = this.googleAction().getRequest().getUser();

    // Check, if you have the necessary permission
    if (user.permissions.indexOf('NAME') > -1) {
      /* 
        user.profile.givenName
        user.profile.familyName
        user.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.

this.googleAction().askForPreciseLocation(speech);

this.googleAction().askForZipCodeAndCity(speech);
'ON_PERMISSION': function() {
  if (this.googleAction().isPermissionGranted()) {
    let user = this.googleAction().getRequest().getUser();

    if (user.permissions.indexOf('DEVICE_COARSE_LOCATION') > -1) {
      let device = this.googleAction().getRequest().getDevice();
      /*
        device.location.city
        device.location.zipCode
      */
    }
    if (user.permissions.indexOf('DEVICE_PRECISE_LOCATION') > -1) {
      let device = this.googleAction().getRequest().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

Account Linking

The account linking card is used to prompt the user to connect their Google account to an account on your service.

this.showAccountLinkingCard();

The user will be routed to the ON_SIGN_IN intent after they answered the account linking request.

'ON_SIGN_IN': function() {
  if (this.googleAction().getSignInStatus() === 'CANCELLED') {
    this.tell('Please sign in.');
  } else if (this.googleAction().getSignInStatus() === 'OK') {
    this.tell('You are signed in now.');
  } else if (this.googleAction().getSignInStatus() === 'ERROR') {
    this.tell('There was an error');
  }
},

To check, if the user has already signed in, you can use the getSignInStatus() method. It will either return OK, CANCELLED or ERROR.

this.googleAction().getSignInStatus();

Official Documentation

Example