Transactions API will be deprecated on May 3, 2023, ahead of the Conversational Actions sunset on June 13, 2023. For more information, see Conversational Actions sunset
.
OrderOptions
Stay organized with collections
Save and categorize content based on your preferences.
Options associated with an order.
UserInfoOptions
Options regarding user info.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eOrderOptions allows specifying if a delivery address is required and provides options for requesting user information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003erequestDeliveryAddress\u003c/code\u003e is a boolean indicating whether the order requires a delivery address.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003euserInfoOptions\u003c/code\u003e enables the app to request specific user information, such as name, email, or phone number, which will be displayed for confirmation in the ProposedOrderCard.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003euserInfoProperties\u003c/code\u003e is a list of user info properties that the app can request, including options like given name, family name, email, and phone number.\u003c/p\u003e\n"]]],["The document defines order options using JSON. It allows specifying whether a delivery address is required (`requestDeliveryAddress`), represented by a boolean. It also defines `userInfoOptions`, an object enabling apps to request user information. `userInfoOptions` uses `userInfoProperties`, an array of enumerated user info properties, for the specific details to be requested. If set, these fields appear in the ProposedOrderCard for user confirmation. The provided data structure and its types are detailed in associated tables.\n"],null,["# OrderOptions\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [UserInfoOptions](#UserInfoOptions)\n - [JSON representation](#UserInfoOptions.SCHEMA_REPRESENTATION)\n\nOptions associated with an order.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"requestDeliveryAddress\": boolean, \"userInfoOptions\": { object (/assistant/transactions/reference/physical/rest/v3/OrderOptions#UserInfoOptions) } } ``` |\n\n| Fields ||\n|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestDeliveryAddress` | `boolean` If true, delivery address is required for the associated order. |\n| `userInfoOptions` | `object (`[UserInfoOptions](/assistant/transactions/reference/physical/rest/v3/OrderOptions#UserInfoOptions)`)` The app can request user info by setting this field. If set, the corresponding field will show up in ProposedOrderCard for user's confirmation. |\n\nUserInfoOptions\n---------------\n\nOptions regarding user info.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"userInfoProperties\": [ enum (/assistant/transactions/reference/physical/rest/v3/UserInfoProperty) ] } ``` |\n\n| Fields ||\n|------------------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `userInfoProperties[]` | `enum (`[UserInfoProperty](/assistant/transactions/reference/physical/rest/v3/UserInfoProperty)`)` List of user info properties. |"]]
