Type Alias EcommerceItemInfo
affiliation?: string;
coupon?: string;
discount?: number;
index?: number;
item_brand?: string;
item_category?: string;
item_category2?: string;
item_category3?: string;
item_category4?: string;
item_category5?: string;
item_id?: string;
item_list_id?: string;
item_list_name?: string;
item_name?: string;
item_variant?: string;
location_id?: string;
price?: number;
quantity?: number;
} & ({ item_id: string } | { item_name: string })
Type declaration
Optional
affiliation?: stringOptional
coupon?: stringThe coupon name/code associated with the item. Event-level and item-level coupon parameters are independent.
Optional
discount?: numberThe unit monetary discount value associated with the item.
Optional
index?: numberThe index/position of the item in a list.
Optional
item_brand?: stringThe brand of the item.
Optional
item_category?: stringThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
Optional
item_category2?: stringThe second category hierarchy or additional taxonomy for the item.
Optional
item_category3?: stringOptional
item_category4?: stringOptional
item_category5?: stringOptional
item_id?: stringThe ID of the item. *One of item_id or item_name is required.
Optional
item_list_id?: stringThe ID of the list in which the item was presented to the user. If set, event-level item_list_id is ignored. If not set, event-level item_list_id is used, if present.
Optional
item_list_name?: stringThe name of the list in which the item was presented to the user. If set, event-level item_list_name is ignored. If not set, event-level item_list_name is used, if present.
Optional
item_name?: stringThe name of the item. *One of item_id or item_name is required.
Optional
item_variant?: stringThe item variant or unique code or description for additional item details/options.
Optional
location_id?: stringThe physical location associated with the item (e.g. the physical store location). It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. Note:
location id
is only available at the item-scope.Optional
price?: numberThe monetary unit price of the item, in units of the specified currency parameter. If a discount applies to the item, set price to the discounted unit price and specify the unit price discount in the discount parameter.
Optional
quantity?: numberItem quantity. If not set, quantity is set to 1.
- { item_id: string }
- { item_name: string }
A product affiliation to designate a supplying company or brick and mortar store location. Note:
affiliation
is only available at the item-scope.