Globals

Abstract types

ActionPaymentTransactionConfig

Object

Transaction config for transactions not involving a Google provided payment instrument.

Properties

Name Description

deliveryAddressRequired

boolean

True if delivery address is required for the transaction.

type

boolean

One of Transactions.PaymentType.

displayName

string

The name of the instrument displayed on receipt. For example, for card payment, could be "VISA-1234".

Button

Object

Basic Card Button. Shown below basic cards. Open a URL when selected.

Properties

Name Description

title

string

Text shown on the button.

openUrlAction

Object

Action to take when selected.

CancellationInfo

Object

Order cancellation info.

Property

Name Description

reason

string

Reason for the cancellation.

Context

Object

API.AI Context.

Properties

Name Description

name

string

Full name of the context.

parameters

Object

Parameters carried within this context. See here.

lifespan

number

Remaining number of intents

DateTime

Object

User provided date/time info.

Properties

Name Description

date

Object

time

Object

DeliveryAddress

Object

Delivery address returned when calling getDeliveryAddress().

Properties

Name Description

userDecision.

string

Either Transactions.ConfirmationDecision.ACCEPTED or Transactions.ConfirmationDecision.REJECTED.

postalAddress

Object

phoneNumber

string

notes

string

DeviceLocation

Object

User's permissioned device location.

Properties

Name Description

coordinates

Object

{latitude, longitude}. Requested with SupportedPermissions.DEVICE_PRECISE_LOCATION.

address

string

Full, formatted street address. Requested with SupportedPermissions.DEVICE_PRECISE_LOCATION.

zipCode

string

Zip code. Requested with SupportedPermissions.DEVICE_COARSE_LOCATION.

city

string

Device city. Requested with SupportedPermissions.DEVICE_COARSE_LOCATION.

FulfillmentInfo

Object

Order fulfillment info.

Properties

Name Description

deliveryTime

Object

UTC timestamp of the fulfillment update.

GooglePaymentTransactionConfig

Object

Transaction config for transactions involving a Google provided payment instrument.

Properties

Name Description

deliveryAddressRequired

boolean

True if delivery address is required for the transaction.

tokenizationParameters

Object

Tokenization parameters provided by payment gateway.

cardNetworks

Array of string

List of accepted card networks. Must be any number of Transactions.CardNetwork.

prepaidCardDisallowed

boolean

True if prepaid cards are not allowed for transaction.

Image

Object

Image type shown on visual elements.

Properties

Name Description

url

string

Image source URL.

accessibilityText

string

Text to replace for image for accessibility.

width

number

Width of the image.

height

number

Height of the image.

LinkOutSuggestion

Object

Link Out Suggestion. Used in rich response as a suggestion chip which, when selected, links out to external URL.

Properties

Name Description

title

string

Text shown on the suggestion chip.

url

string

String URL to open.

OptionInfo

Object

Option info. Provides unique identifier for a given OptionItem.

Properties

Name Description

key

string

Unique string ID for this option.

synonyms

Array of string

Synonyms that can be used by the user to indicate this option if they do not use the key.

OptionItem

Object

Option item. Used in actions.intent.OPTION intent.

Properties

Name Description

optionInfo

OptionInfo

Option item identifier information.

title

string

Name of the item.

description

string

Optional text describing the item.

image

Image

Square image to show for this item.

Price

Object

Price type.

Properties

Name Description

type

string

One of Transaction.PriceType.

amount

Object

ReceiptInfo

Object

Order receipt info.

Property

Name Description

confirmedActionOrderId

string

Action provided order ID. Used when the order has been received by the integrator.

RejectionInfo

Object

Order rejection info.

Properties

Name Description

type

string

One of Transaction.RejectionType.

reason

string

Reason for the order rejection.

ReturnInfo

Object

Order return info.

Property

Name Description

reason

string

Reason for the return.

SimpleResponse

Object

Simple Response type.

Properties

Name Description

speech

string

Speech to be spoken to user. SSML allowed.

displayText

string

Optional text to be shown to user

Suggestion

Object

Suggestions to show with response.

Property

Name Description

title

string

Text of the suggestion.

TransactionDecision

Object

Decision and order information returned when calling getTransactionDecision().

Properties

Name Description

userDecision

string

One of Transactions.ConfirmationDecision.

checkResult

Object

order

Object

deliveryAddress

DeliveryAddress

The delivery address if user requested. Will appear if userDecision is Transactions.DELIVERY_ADDRESS_UPDATED.

TransitInfo

Object

Order transit info.

Properties

Name Description

updatedTime

Object

UTC timestamp of the transit update.

User

Object

User object.

Properties

Name Description

userId

string

Random string ID for Google user.

userName

UserName

User name information. Null if not requested with askForPermission(SupportedPermissions.NAME).

accessToken

string

Unique Oauth2 token. Only available with account linking.

UserName

Object

User's permissioned name info.

Properties

Name Description

displayName

string

User's display name.

givenName

string

User's given name.

familyName

string

User's family name.