AppResponse

{
  "inputPrompt": {
    object (InputPrompt)
  },
  "possibleIntents": [
    {
      object (ExpectedIntent)
    }
  ],
  "speechBiasingHints": [
    string
  ]
}

object (InputPrompt)

The customized prompt used to ask user for input.

object (ExpectedIntent)

List of intents that can be used to fulfill this input. To have actions on Google just return the raw user input, the app should ask for the actions.intent.TEXT intent.

string

List of phrases the Action wants Google to use for speech biasing. Up to 1000 phrases are allowed.

{
  "initialPrompts": [
    {
      object (SpeechResponse)
    }
  ],
  "richInitialPrompt": {
    object (RichResponse)
  },
  "noInputPrompts": [
    {
      object (SimpleResponse)
    }
  ]
}

object (SpeechResponse)

Initial prompts asking user to provide an input. Only a single initial_prompt is supported.

object (RichResponse)

Prompt payload.

object (SimpleResponse)

Prompt used to ask user when there is no input from user.

{

  // Union field type can be only one of the following:
  "textToSpeech": string,
  "ssml": string
  // End of list of possible types for union field type.
}

string

Plain text of the speech output, e.g., "where do you want to go?"/

string

Structured spoken response to the user in the SSML format, e.g. " Say animal name after the sound. ". Mutually exclusive with textToSpeech.

{
  "items": [
    {
      object (Item)
    }
  ],
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "linkOutSuggestion": {
    object (LinkOutSuggestion)
  }
}

object (Item)

A list of UI elements which compose the response The items must meet the following requirements: 1. The first item must be a SimpleResponse 2. At most two SimpleResponse 3. At most one rich response item (e.g. BasicCard, StructuredResponse, MediaResponse, or HtmlResponse) 4. You cannot use a rich response item if you're using an actions.intent.OPTION intent ie ListSelect or CarouselSelect

object (Suggestion)

A list of suggested replies. These will always appear at the end of the response. If used in a FinalResponse, they will be ignored.

object (LinkOutSuggestion)

An additional suggestion chip that can link out to the associated app or site.

{
  "name": string,

  // Union field item can be only one of the following:
  "simpleResponse": {
    object (SimpleResponse)
  },
  "basicCard": {
    object (BasicCard)
  },
  "structuredResponse": {
    object (StructuredResponse)
  },
  "mediaResponse": {
    object (MediaResponse)
  },
  "carouselBrowse": {
    object (CarouselBrowse)
  },
  "tableCard": {
    object (TableCard)
  },
  "htmlResponse": {
    object (HtmlResponse)
  }
  // End of list of possible types for union field item.
}

string

Optional named identifier of this Item.

object (SimpleResponse)

Voice and text-only response.

object (BasicCard)

A basic card.

object (StructuredResponse)

Structured payload to be processed by Google.

object (MediaResponse)

Response indicating a set of media to be played.

object (CarouselBrowse)

Carousel browse card, use collectionBrowse instead..

object (TableCard)

Table card.

object (HtmlResponse)

Html response used to render on Canvas.

{
  "textToSpeech": string,
  "ssml": string,
  "displayText": string
}

string

Plain text of the speech output, e.g., "where do you want to go?" Mutually exclusive with ssml.

string

Structured spoken response to the user in the SSML format, e.g. <speak> Say animal name after the sound. <audio src = 'https://www.pullstring.com/moo.mps' />, what’s the animal? </speak>. Mutually exclusive with textToSpeech.

string

Optional text to display in the chat bubble. If not given, a display rendering of the textToSpeech or ssml above will be used. Limited to 640 chars.

{
  "title": string,
  "subtitle": string,
  "formattedText": string,
  "image": {
    object (Image)
  },
  "buttons": [
    {
      object (Button)
    }
  ],
  "imageDisplayOptions": enum (ImageDisplayOptions)
}

string

Overall title of the card. Optional.

string

Optional.

string

Body text of the card. Supports a limited set of markdown syntax for formatting. Required, unless image is present.

object (Image)

A hero image for the card. The height is fixed to 192dp. Optional.

object (Button)

Buttons. Currently at most 1 button is supported. Optional.

enum (ImageDisplayOptions)

type of image display option. Optional.

{
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  }
}

string

title of the button. Required.

object (OpenUrlAction)

Action to take when a user taps on the button. Required.

{

  // Union field data can be only one of the following:
  "orderUpdate": {
    object (OrderUpdate)
  },
  "orderUpdateV3": {
    object (OrderUpdate)
  }
  // End of list of possible types for union field data.
}

object (OrderUpdate)

App provides an order update (e.g. Receipt) after receiving the order.

object (OrderUpdate)

App provides an order update in API v3 format after receiving the order.

{
  "googleOrderId": string,
  "actionOrderId": string,
  "orderState": {
    object (OrderState)
  },
  "orderManagementActions": [
    {
      object (Action)
    }
  ],
  "receipt": {
    object (Receipt)
  },
  "updateTime": string,
  "totalPrice": {
    object (Price)
  },
  "lineItemUpdates": {
    string: {
      object(LineItemUpdate)
    },
    ...
  },
  "userNotification": {
    object (UserNotification)
  },
  "infoExtension": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field info can be only one of the following:
  "rejectionInfo": {
    object (RejectionInfo)
  },
  "cancellationInfo": {
    object (CancellationInfo)
  },
  "inTransitInfo": {
    object (InTransitInfo)
  },
  "fulfillmentInfo": {
    object (FulfillmentInfo)
  },
  "returnInfo": {
    object (ReturnInfo)
  }
  // End of list of possible types for union field info.
}

string

Id of the order is the Google-issued id.

string

Required. The canonical order id referencing this order. If integrators don't generate the canonical order id in their system, they can simply copy over googleOrderId included in order.

object (OrderState)

The new state of the order.

object (Action)

Updated applicable management actions for the order, e.g. manage, modify, contact support.

object (Receipt)

Receipt for order.

string (Timestamp format)

When the order was updated from the app's perspective.

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

object (Price)

New total price of the order

map (key: string, value: object (LineItemUpdate))

Map of line item-level changes, keyed by item id. Optional.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (UserNotification)

If specified, displays a notification to the user with the specified title and text. Specifying a notification is a suggestion to notify and is not guaranteed to result in a notification.

object

Extra data based on a custom order state or in addition to info of a standard state.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

object (RejectionInfo)

Information about rejection state.

object (CancellationInfo)

Information about cancellation state.

object (InTransitInfo)

Information about in transit state.

object (FulfillmentInfo)

Information about fulfillment state.

object (ReturnInfo)

Information about returned state.

{
  "type": enum (ActionType),
  "button": {
    object (Button)
  }
}

enum (ActionType)

type of action.

object (Button)

Button label and link.

{
  "confirmedActionOrderId": string,
  "userVisibleOrderId": string
}

string

Confirmed order id when order has been received by the integrator. This is the canonical order id used in integrator's system referencing the order and may subsequently be used to identify the order as actionOrderId.

Note that this field is deprecated. Please pass the field through OrderUpdate.action_order_id instead.

string

Optional. The user facing id referencing to current order, which will show up in the receipt card if present. This should be the id that usually appears on a printed receipt or receipt sent to user's email. User should be able to use this id referencing her order for customer service provided by integrators. Note that this field must be populated if integrator does generate user facing id for an order with a printed receipt / email receipt.

{
  "type": enum (ReasonType),
  "reason": string
}

enum (ReasonType)

Rejection type.

string

Reason for the error.

{
  "reason": string
}

string

Reason for cancellation.

{
  "updatedTime": string
}

string (Timestamp format)

Last updated time for in transit.

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

{
  "deliveryTime": string
}

string (Timestamp format)

When the order will be fulfilled.

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

{
  "reason": string
}

string

Reason for return.

{
  "title": string,
  "text": string
}

string

The title for the user notification.

string

The contents of the notification.

{
  "mediaType": enum (MediaType),
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}

enum (MediaType)

type of the media within this response.

object (MediaObject)

The list of media objects.

{
  "name": string,
  "description": string,
  "contentUrl": string,

  // Union field image can be only one of the following:
  "largeImage": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}

string

name of this media object.

string

description of this media object.

string

The url pointing to the media content.

object (Image)

A large image, such as the cover of the album, etc.

object (Image)

A small image icon displayed on the right from the title. It's resized to 36x36 dp.

{
  "items": [
    {
      object (Item)
    }
  ],
  "imageDisplayOptions": enum (ImageDisplayOptions)
}

object (Item)

Min: 2. Max: 10.

enum (ImageDisplayOptions)

type of image display option. Optional.

{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  }
}

string

title of the carousel item. Required.

string

description of the carousel item. Optional.

string

Footer text for the carousel item, displayed below the description. Single line of text, truncated with an ellipsis. Optional.

object (Image)

Hero image for the carousel item. Optional.

object (OpenUrlAction)

URL of the document associated with the carousel item. The document can contain HTML content or, if "urlTypeHint" is set to AMP_CONTENT, AMP content. Required.

{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columnProperties": [
    {
      object (ColumnProperties)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "buttons": [
    {
      object (Button)
    }
  ]
}

string

Overall title of the table. Optional but must be set if subtitle is set.

string

Subtitle for the table. Optional.

object (Image)

Image associated with the table. Optional.

object (ColumnProperties)

Headers and alignment of columns.

object (Row)

Row data of the table. The first 3 rows are guaranteed to be shown but others might be cut on certain surfaces. Please test with the simulator to see which rows will be shown for a given surface. On surfaces that support the WEB_BROWSER capability, you can point the user to a web page with more data.

object (Button)

Buttons. Currently at most 1 button is supported. Optional.

{
  "header": string,
  "horizontalAlignment": enum (HorizontalAlignment)
}

string

Header text for the column.

enum (HorizontalAlignment)

Horizontal alignment of content w.r.t column. If unspecified, content will be aligned to the leading edge.

{
  "cells": [
    {
      object (Cell)
    }
  ],
  "dividerAfter": boolean
}

object (Cell)

Cells in this row. The first 3 cells are guaranteed to be shown but others might be cut on certain surfaces. Please test with the simulator to see which cells will be shown for a given surface.

boolean

Indicates whether there should be a divider after each row.

{
  "text": string
}

string

Text content of the cell.

{
  "updatedState": value,
  "suppressMic": boolean,
  "url": string
}

value (Value format)

Communicate the following JSON object to the app.

boolean

Provide an option so that mic won't be opened after this immersive response.

string

The url of the application.

{
  "title": string
}

string

The text shown the in the suggestion chip. When tapped, this text will be posted back to the conversation verbatim as if the user had typed it. Each title must be unique among the set of suggestion chips. Max 25 chars Required

{
  "destinationName": string,
  "url": string,
  "openUrlAction": {
    object (OpenUrlAction)
  }
}

string

The name of the app or site this chip is linking to. The chip will be rendered with the title "Open ". Max 20 chars. Required.

string

Deprecated. Use OpenUrlAction instead.

object (OpenUrlAction)

The URL of the App or Site to open when the user taps the suggestion chip. Ownership of this App/URL must be validated in the actions on Google developer console, or the suggestion will not be shown to the user. Open URL Action supports http, https and intent URLs. For Intent URLs refer to: https://developer.chrome.com/multidevice/android/intents

{
  "intent": string,
  "inputValueData": {
    "@type": string,
    field1: ...,
    ...
  },
  "parameterName": string
}

string

The built-in intent name, e.g. actions.intent.TEXT, or intents defined in the action package. If the intent specified is not a built-in intent, it is only used for speech biasing and the input provided by the Google Assistant will be the actions.intent.TEXT intent.

object

Additional configuration data required by a built-in intent. Possible values for the built-in intents: actions.intent.OPTION -> google.actions.v2.OptionValueSpec, actions.intent.CONFIRMATION -> google.actions.v2.ConfirmationValueSpec, actions.intent.TRANSACTION_REQUIREMENTS_CHECK -> google.actions.v2.TransactionRequirementsCheckSpec, actions.intent.DELIVERY_ADDRESS -> google.actions.v2.DeliveryAddressValueSpec, actions.intent.TRANSACTION_DECISION -> google.actions.v2.TransactionDecisionValueSpec, actions.intent.PLACE -> google.actions.v2.PlaceValueSpec, actions.intent.Link -> google.actions.v2.LinkValueSpec

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

string

Optionally, a parameter of the intent that is being requested. Only valid for requested intents. Used for speech biasing.

{

  // Union field response can be only one of the following:
  "speechResponse": {
    object (SpeechResponse)
  },
  "richResponse": {
    object (RichResponse)
  }
  // End of list of possible types for union field response.
}

object (SpeechResponse)

Spoken response when user is not required to provide an input.

object (RichResponse)

Rich response when user is not required to provide an input.

{
  "target": {
    object (Target)
  },

  // Union field content can be only one of the following:
  "orderUpdate": {
    object (OrderUpdate)
  },
  "userNotification": {
    object (UserNotification)
  }
  // End of list of possible types for union field content.
}

object (Target)

The specified target for the push request.

object (OrderUpdate)

An order update updating orders placed through transaction APIs.

object (UserNotification)

If specified, displays a notification to the user with specified title and text.

{
  "title": string,
  "text": string
}

string

The title for the notification.

string

The content of the notification.

{
  "userId": string,
  "intent": string,
  "argument": {
    object (Argument)
  },
  "locale": string
}

string

The user to target.

string

The intent to target.

object (Argument)

The argument to target for an intent. For V1, only one Argument is supported.

string

The locale to target. Follows IETF BCP-47 language code. Can be used by a multi-lingual app to target a user on a specified localized app. If not specified, it will default to en-US.