AppRequest

{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}

string

token representing the user's identity. This is a Json web token including encoded profile. The definition is at https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo.

object (UserProfile)

Information about the end user. Some fields are only available if the user has given permission to provide this information to the Action.

string

An OAuth2 token that identifies the user in your system. Only available if the user links their account.

enum (Permission)

Contains permissions granted by user to this Action.

string

Primary locale setting of the user making the request. Follows IETF BCP-47 language code http://www.rfc-editor.org/rfc/bcp/bcp47.txt However, the script subtag is not included.

string (Timestamp format)

The timestamp of the last interaction with this user. This field will be omitted if the user has not interacted with the agent before.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

string

An opaque token supplied by the application that is persisted across conversations for a particular user. The maximum size of the string is 10k characters.

object (PackageEntitlement)

List of user entitlements for every package name listed in the Action package, if any.

enum (UserVerificationStatus)

Indicates the verification status of the user.

{
  "displayName": string,
  "givenName": string,
  "familyName": string
}

string

The user's full name as specified in their Google account. Requires the NAME permission.

string

The user's first name as specified in their Google account. Requires the NAME permission.

string

The user's last name as specified in their Google account. Note that this field could be empty. Requires the NAME permission.

{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}

string

Should match the package name in action package

object (Entitlement)

List of entitlements for a given app

{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}

string

Product sku. Package name for paid app, suffix of Finsky docid for in-app purchase and in-app subscription. Match getSku() in Play InApp Billing API.

enum (SkuType)

object (SignedData)

Only present for in-app purchase and in-app subs.

{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}

object (Struct format)

Match INAPP_PURCHASE_DATA from getPurchases() method. Contains all inapp purchase data in JSON format See details in table 6 of https://developer.android.com/google/play/billing/billing_reference.html.

string

Matches IN_APP_DATA_SIGNATURE from getPurchases() method in Play InApp Billing API.

{
  "location": {
    object (Location)
  }
}

object (Location)

Represents actual device location such as latitude, longitude, and formatted address. Requires the DEVICE_COARSE_LOCATION or DEVICE_PRECISE_LOCATION permission.

{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}

object (Capability)

A list of capabilities the surface supports at the time of the request e.g. actions.capability.AUDIO_OUTPUT

{
  "name": string
}

string

The name of the capability, e.g. actions.capability.AUDIO_OUTPUT

{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}

string

Unique ID for the multi-turn conversation. It's assigned for the first turn. After that it remains the same for subsequent conversation turns until the conversation is terminated.

enum (ConversationType)

type indicates the state of the conversation in its lifecycle.

string

Opaque token specified by the Action in the last conversation turn. It can be used by an Action to track the conversation or to store conversation related data.

{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}

object (RawInput)

Raw input transcription from each turn of conversation. Multiple conversation turns may be required for actions on Google to provide some types of input to the Action.

string

Indicates the user's intent. For the first conversation turn, the intent will refer to the triggering intent for the Action. For subsequent conversation turns, the intent will be a common actions on Google intent (starts with 'actions.'). For example, if the expected input is actions.intent.OPTION, then the the intent specified here will either be actions.intent.OPTION if the Google Assistant was able to satisfy that intent, or actions.intent.TEXT if the user provided other information. See https://developers.google.com/assistant/df-asdk/reference/intents.

object (Argument)

A list of provided argument values for the input requested by the Action.

{
  "inputType": enum (InputType),

  // Union field input can be only one of the following:
  "query": string,
  "url": string
  // End of list of possible types for union field input.
}

enum (InputType)

Indicates how the user provided this input: a typed response, a voice response, unspecified, etc.

string

Typed or spoken input from the end user.

string

The triggering URL.