Август 4

https://developers.google.com/ Internal Server Error

Recommended events

bookmark_border

These events let you measure additional features and behavior and generate more useful reports in Google Analytics 4. Because these events require additional context to be meaningful, they are not sent automatically. Use this document to see the required and optional parameters for each event.

Google tag Tag Manager Firebase

add_payment_info

This event signifies a user has submitted their payment information in an ecommerce checkout process.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
couponstringNoSUMMER_FUNThe coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
payment_typestringNoCredit CardThe chosen method of payment.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

add_shipping_info

This event signifies a user has submitted their shipping information in an ecommerce checkout process.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
couponstringNoSUMMER_FUNThe coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
shipping_tierstringNoGroundThe shipping tier (e.g. GroundAirNext-day) selected for delivery of the purchased item.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

add_to_cart

This event signifies that an item was added to a cart for purchase.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

add_to_wishlist

The event signifies that an item was added to a wishlist. Use this event to identify popular gift items in your app.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

begin_checkout

This event signifies that a user has begun a checkout.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
couponstringNoSUMMER_FUNThe coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

earn_virtual_currency

This event measures when a user is awarded virtual currency in a game. Log this along with spend_virtual_currency to better understand your virtual economy.

Parameters

NameTypeRequiredExample valueDescription
virtual_currency_namestringNoGemsThe name of the virtual currency.
valuenumberNo5The value of the virtual currency.

Example

generate_lead

This event measures when a lead has been generated (for example, through a form). Log this to understand the effectiveness of your marketing campaigns and how many customers re-engage with your business after remarketing to the customers.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.

Example

join_group

Log this event when a user joins a group such as a guild, team, or family. Use this event to analyze how popular certain groups or social features are.

Parameters

NameTypeRequiredExample valueDescription
group_idstringNoG_12345The ID of the group.

Example

level_end

This event signifies that a player has reached the end of a level in a game.

Parameters

NameTypeRequiredExample valueDescription
level_namestringNoThe journey begins…The name of the level.
successbooleanNotrueSet to true if the level was completed successfully.

Example

level_start

This event signifies that a player has started a level in a game.

Parameters

NameTypeRequiredExample valueDescription
level_namestringNoThe journey begins…The name of the level.

Example

level_up

This event signifies that a player has leveled up in a game. Use it to gauge the level distribution of your user base and identify levels that are difficult to complete.

Parameters

NameTypeRequiredExample valueDescription
levelnumberNo5The level of the character.
characterstringNoPlayer 1The character that leveled up.

Example

login

Send this event to signify that a user has logged in to your website or app.

Parameters

NameTypeRequiredExample valueDescription
methodstringNoGoogleThe method used to login.

Example

post_score

Send this event when the user posts a score. Use this event to understand how users are performing in your game and correlate high scores with audiences or behaviors.

Parameters

NameTypeRequiredExample valueDescription
scorenumberYes10000The score to post.
levelnumberNo5The level for the score.
characterstringNoPlayer 1The character that achieved the score.

Example

purchase

This event signifies when one or more items is purchased by a user.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
transaction_idstringYesT_12345The unique identifier of a transaction.

The transaction_id parameter helps you avoid getting duplicate events for a purchase.
valuenumberYes*12.21The monetary value of the event.

value is required for meaningful reporting and to populate the purchasers predictive audience.
currency is required if you set value.
couponstringNoSUMMER_FUNThe coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
shippingnumberNo3.33Shipping cost associated with a transaction.
taxnumberNo1.11Tax cost associated with a transaction.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

refund

This event signifies when one or more items is refunded to a user.Note: We recommend that you include item information in your refund event to see item-level refund metrics in Analytics.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
transaction_idstringYesT_12345The unique identifier of a transaction.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
couponstringNoSUMMER_FUNThe coupon name/code associated with the event.

Event-level and item-level coupon parameters are independent.
shippingnumberNo3.33Shipping cost associated with a transaction.
taxnumberNo1.11Tax cost associated with a transaction.
itemsArray<Item>No*The items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

remove_from_cart

This event signifies that an item was removed from a cart.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

Log this event to indicate when the user has performed a search. You can use this event to identify what users are searching for on your website or app. For example, you could send this event when a user views a search results page after performing a search.

Parameters

NameTypeRequiredExample valueDescription
search_termstringYest-shirtsThe term that was searched for.

Example

select_content

This event signifies that a user has selected some content of a certain type. This event can help you identify popular content and categories of content on your website or app.

Parameters

NameTypeRequiredExample valueDescription
content_typestringNoproductThe type of selected content.
content_idstringNoC_12345An identifier for the content that was selected.

Example

select_item

This event signifies an item was selected from a list.

Parameters

NameTypeRequiredExample valueDescription
item_list_idstringNorelated_productsThe ID of the list in which the item was presented to the user.

Ignored if set at the item-level.
item_list_namestringNoRelated productsThe name of the list in which the item was presented to the user.

Ignored if set at the item-level.
itemsArray<Item>Yes*The items for the event.

* The items array is expected to have a single element, representing the selected item. If multiple elements are provided, only the first element in items will be used.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

select_promotion

This event signifies a promotion was selected from a list.

Parameters

NameTypeRequiredExample valueDescription
creative_namestringNosummer_banner2The name of the promotional creative.

Ignored if set at the item-level.
creative_slotstringNofeatured_app_1The name of the promotional creative slot associated with the event.

Ignored if set at the item-level.
promotion_idstringNoP_12345The ID of the promotion associated with the event.

Ignored if set at the item-level.
promotion_namestringNoSummer SaleThe name of the promotion associated with the event.

Ignored if set at the item-level.
itemsArray<Item>NoThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
creative_namestringNosummer_banner2The name of the promotional creative.

If set, event-level creative_name is ignored.
If not set, event-level creative_name is used, if present.
creative_slotstringNofeatured_app_1The name of the promotional creative slot associated with the item.

If set, event-level creative_slot is ignored.
If not set, event-level creative_slot is used, if present.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
promotion_idstringNoP_12345The ID of the promotion associated with the item.

If set, event-level promotion_id is ignored.
If not set, event-level promotion_id is used, if present.
promotion_namestringNoSummer SaleThe name of the promotion associated with the item.

If set, event-level promotion_name is ignored.
If not set, event-level promotion_name is used, if present.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

share

Use this event when a user has shared content.

Parameters

NameTypeRequiredExample valueDescription
methodstringNoTwitterThe method in which the content is shared.
content_typestringNoimageThe type of shared content.
item_idstringNoC_12345The ID of the shared content.

Example

sign_up

This event indicates that a user has signed up for an account. Use this event to understand the different behaviors of logged in and logged out users.

Parameters

NameTypeRequiredExample valueDescription
methodstringNoGoogleThe method used for sign up.

Example

spend_virtual_currency

This event measures the sale of virtual goods in your app and helps you identify which virtual goods are the most popular.

Parameters

NameTypeRequiredExample valueDescription
valuenumberYes5The value of the virtual currency.
virtual_currency_namestringYesGemsThe name of the virtual currency.
item_namestringNoStarter BoostThe name of the item the virtual currency is being used for.

Example

tutorial_begin

This event signifies the start of the on-boarding process. Use this in a funnel with tutorial_complete to understand how many users complete the tutorial.

Parameters

There are no parameters for this event.

Example

tutorial_complete

This event signifies the user’s completion of your on-boarding process. Use this in a funnel with tutorial_begin to understand how many users complete the tutorial.

Parameters

No parameters are suggested for this event.

Example

unlock_achievement

Log this event when the user has unlocked an achievement. This event can help you understand how users are experiencing your game.

Parameters

NameTypeRequiredExample valueDescription
achievement_idstringYesA_12345The id of the achievement that was unlocked.

Example

view_cart

This event signifies that a user viewed their cart.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

view_item

This event signifies that some content was shown to the user. Use this event to discover the most popular items viewed.

Parameters

NameTypeRequiredExample valueDescription
currencystringYes*USDCurrency of the items associated with the event, in 3-letter ISO 4217 format.

* If you set value then currency is required for revenue metrics to be computed accurately.
valuenumberYes*7.77The monetary value of the event.

value is typically required for meaningful reporting. If you mark the event as a conversion then it’s recommended you set value.
currency is required if you set value.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

view_item_list

Log this event when the user has been presented with a list of items of a certain category.

Parameters

NameTypeRequiredExample valueDescription
item_list_idstringNorelated_productsThe ID of the list in which the item was presented to the user.

Ignored if set at the item-level.
item_list_namestringNoRelated productsThe name of the list in which the item was presented to the user.

Ignored if set at the item-level.
itemsArray<Item>YesThe items for the event.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.

Example

view_promotion

This event signifies a promotion was viewed from a list.

Parameters

NameTypeRequiredExample valueDescription
creative_namestringNosummer_banner2The name of the promotional creative.

Ignored if set at the item-level.
creative_slotstringNofeatured_app_1The name of the promotional creative slot associated with the event.

Ignored if set at the item-level.
promotion_idstringNoP_12345The ID of the promotion associated with the event.

Ignored if set at the item-level.
promotion_namestringNoSummer SaleThe name of the promotion associated with the event.

Ignored if set at the item-level.
itemsArray<Item>Yes*The items for the event.

* The items array is expected to have a single element, representing the item associated with the promotion. If multiple elements are provided, only the first element in items will be used.

Item parameters

NameTypeRequiredExample valueDescription
item_idstringYes*SKU_12345The ID of the item.*One of item_id or item_name is required.
item_namestringYes*Stan and Friends TeeThe name of the item.*One of item_id or item_name is required.
affiliationstringNoGoogle StoreA product affiliation to designate a supplying company or brick and mortar store location.
Note: `affiliation` is only available at the item-scope.
couponstringNoSUMMER_FUNThe coupon name/code associated with the item.

Event-level and item-level coupon parameters are independent.
creative_namestringNosummer_banner2The name of the promotional creative.

If set, event-level creative_name is ignored.
If not set, event-level creative_name is used, if present.
creative_slotstringNofeatured_app_1The name of the promotional creative slot associated with the item.

If set, event-level creative_slot is ignored.
If not set, event-level creative_slot is used, if present.
discountnumberNo2.22The monetary discount value associated with the item.
indexnumberNo5The index/position of the item in a list.
item_brandstringNoGoogleThe brand of the item.
item_categorystringNoApparelThe category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category.
item_category2stringNoAdultThe second category hierarchy or additional taxonomy for the item.
item_category3stringNoShirtsThe third category hierarchy or additional taxonomy for the item.
item_category4stringNoCrewThe fourth category hierarchy or additional taxonomy for the item.
item_category5stringNoShort sleeveThe fifth category hierarchy or additional taxonomy for the item.
item_list_idstringNorelated_productsThe 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.
item_list_namestringNoRelated productsThe 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.
item_variantstringNogreenThe item variant or unique code or description for additional item details/options.
location_idstringNoChIJIQBpAG2ahYAR_6128GcTUEo (the Google Place ID for San Francisco)The 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.
pricenumberNo9.99The monetary price of the item, in units of the specified currency parameter.
promotion_idstringNoP_12345The ID of the promotion associated with the item.

If set, event-level promotion_id is ignored.
If not set, event-level promotion_id is used, if present.
promotion_namestringNoSummer SaleThe name of the promotion associated with the item.

If set, event-level promotion_name is ignored.
If not set, event-level promotion_name is used, if present.
quantitynumberNo1Item quantity.

If not set, quantity is set to 1.


Copyright 2018. All rights reserved.

Опубликовано 04.08.2023 admin в категории "Без рубрики

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *