A list presents users with a vertical list of multiple items and allows them
to select one by touch or voice input. When a user selects an item from the
list, Assistant generates a user query (chat bubble) containing the title of
the list item.
Lists are good for when it's important to disambiguate options, or when the
user needs to choose between options that need to be scanned in their
entirety. For example, which "Peter" do you need to speak to, Peter Jons or
Peter Hans?
Lists must contain a minimum of 2 and a maximum of 30 list items. The number
of elements initially displayed depends on the user's device, and common
starting number is 10 items.
example
constASSISTANT_LOGO_IMAGE = newImage({url:'https://developers.google.com/assistant/assistant_96.png',alt:'Google Assistant logo'});app.handle('List', conv=> {conv.add('This is a list.');// Override type based on slot 'prompt_option'conv.session.typeOverrides = [{name:'prompt_option',mode:'TYPE_REPLACE',synonym: {entries: [ {name:'ITEM_1',synonyms: ['Item 1', 'First item'],display: {title:'Item #1',description:'Description of Item #1',image:ASSISTANT_LOGO_IMAGE, } }, {name:'ITEM_2',synonyms: ['Item 2', 'Second item'],display: {title:'Item #2',description:'Description of Item #2',image:ASSISTANT_LOGO_IMAGE, } }, {name:'ITEM_3',synonyms: ['Item 3', 'Third item'],display: {title:'Item #3',description:'Description of Item #3',image:ASSISTANT_LOGO_IMAGE, } }, {name:'ITEM_4',synonyms: ['Item 4', 'Fourth item'],display: {title:'Item #4',description:'Description of Item #4',image:ASSISTANT_LOGO_IMAGE, } }, ] } }];// Define prompt content using keysconv.add(newList({title:'List title',subtitle:'List subtitle',items: [ {key:'ITEM_1' }, {key:'ITEM_2' }, {key:'ITEM_3' }, {key:'ITEM_4' } ], }));});
A list presents users with a vertical list of multiple items and allows them to select one by touch or voice input. When a user selects an item from the list, Assistant generates a user query (chat bubble) containing the title of the list item.
Lists are good for when it's important to disambiguate options, or when the user needs to choose between options that need to be scanned in their entirety. For example, which "Peter" do you need to speak to, Peter Jons or Peter Hans?
Lists must contain a minimum of 2 and a maximum of 30 list items. The number of elements initially displayed depends on the user's device, and common starting number is 10 items.
Developer Documentation