Skip to content

Commit 0243048

Browse files
authored
docs(analytics): correct logSelectItem documentation (#5253)
1 parent b7421c1 commit 0243048

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

packages/analytics/lib/index.d.ts

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1204,7 +1204,7 @@ export namespace FirebaseAnalyticsTypes {
12041204
* can help you identify popular content and categories of content in your app.
12051205
*
12061206
* Logged event name: `select_content`
1207-
*ana
1207+
*
12081208
* #### Example
12091209
*
12101210
* ```js
@@ -1218,19 +1218,24 @@ export namespace FirebaseAnalyticsTypes {
12181218
*/
12191219
logSelectContent(params: SelectContentEventParameters): Promise<void>;
12201220
/**
1221-
* Select Content event. This general purpose event signifies that a user has selected some
1222-
* content of a certain type in an app. The content can be any object in your app. This event
1223-
* can help you identify popular content and categories of content in your app.
1221+
* Select Item event. This event signifies that an item was selected by a user from a list.
1222+
* Use the appropriate parameters to contextualize the event.
1223+
* Use this event to discover the most popular items selected.
1224+
*
1225+
* Logged event name: `select_item`
12241226
*
1225-
* Logged event name: `select_content`
1226-
*ana
12271227
* #### Example
12281228
*
12291229
* ```js
12301230
* await firebase.analytics().logSelectItem({
12311231
* item_list_id: '54690834',
1232-
* item_list_name: 'purple baseball cap',
1233-
* content_type: 'cap',
1232+
* item_list_name: 't-shirts',
1233+
* items: [{
1234+
* item_brand: 'cool-shirt-brand',
1235+
* item_id: '23456',
1236+
* item_name: 'orange t-shirt',
1237+
* item_category: 'round necked t-shirts',
1238+
* }]
12341239
* });
12351240
* ```
12361241
*

0 commit comments

Comments
 (0)