Intelligent Assistant
Chat with our virtual assistant to get answers promptly.
Operation Type |
Field |
Description |
|---|---|---|
Add event |
Event name |
|
Parameters for addition or modification |
|
|
Parameters to be deleted |
|
|
Modify event |
New event name |
|
Parameters for addition or modification |
|
|
Parameters to be deleted |
|
|
Block event |
- |
Specified events will be blocked and not sent to HUAWEI Analytics. Adding and modification events in other tags are not affected. |
By default, this platform collects the anonymous application identifier (AAID) of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
An AAID uniquely identifies a device that installs an app. A unique AAID is allocated to each app on the same device so that statistics can be collected and analyzed for different apps (for example, statistics on the number of active users). In addition, personal data from different apps is isolated to protect user data privacy and security.
Field |
Description |
|---|---|
Association ID |
Unique ID generated when the promoted app is associated with the analytics tool. You can obtain the ID by clicking the eye icon in the app tool association list in Petal Ads. The value cannot be empty and can contain a maximum of 1000 characters. |
Conversion type |
Conversion event type. The value is of the enumerated type and only one option can be selected. The options include Activation, Order placement, Subscription, and Favorites. |
Custom parameter |
Custom parameters in key-value pair format. The key and value of a custom parameter cannot exceed 1000 characters. Up to 100 key-value pairs are allowed. |
By default, this platform collects the Open Advertising ID (OAID) and Google Advertising ID (GAID) of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
The GAID is also a non-permanent device identifier used for personalized advertising. With GAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can disable the personalized advertising service on their devices. After the service is disabled, DTM will report a GAID containing only 0 to Petal Ads.
Fields in the following table are available only for Android apps.
Type |
Field |
Description |
|---|---|---|
Mandatory |
Protocol version |
Version of the used protocol. Currently, the value is 1. This value changes only when non-backward compatible changes are made. The field value is automatically allocated by the DTM SDK. |
Google Analytics setting |
This parameter enables multiple tags to reuse the same Google Analytics setting. You can also select the check box below this parameter to overwrite the original Google Analytics setting with the custom one. |
|
Tracking ID |
|
|
Client ID |
AAID, which identifies a device. The field value is automatically allocated by the DTM SDK. |
|
Tracking type |
|
|
Enable enhanced e-commerce |
If you select this option, e-commerce data configured to report to HUAWEI Analytics will be reported to Google Analytics as additional parameters. |
|
Optional |
Fields |
|
Custom dimensions |
Custom data attributes. The key is the numeric index, which must be a positive integer. Up to 200 dimensions are allowed for a Google Analytics 360 account and 20 for a non-Google Analytics 360 account. |
|
Custom indicators |
Custom data to be measured. The key is the numeric index, which must be a positive integer. The value must be a number. Up to 200 indicators are allowed for a Google Analytics 360 account and 20 for a non-Google Analytics 360 account. |
|
Content group |
Web page content group, which is in key-value pair format. The key must be a positive integer. Up to 5 content groups are allowed. The value is words separated by slashes (/), for example, a/b/c and HUAWEI/phone. Up to 100 words are allowed. |
|
Enable Google Advertising ID |
Select this parameter if you want to integrate the following functions from Google: app installation conversion, audience feature report, audience interest report, and Google Analytics remarketing. |
|
Screen view |
Screen name |
|
Event |
Event type |
|
Event operation |
|
|
Event label |
|
|
Event value |
|
|
Social interaction |
Social network |
Social network, for example, Facebook and Weibo.
|
Social action |
|
|
Social action target |
|
|
Timing |
Timing type |
|
Timing variable |
|
|
Timing duration |
|
|
Timing label |
|
|
Exception |
Exception description |
|
Fatal |
Indicates whether the exception is fatal. The value is of the Boolean type. You can select or deselect this field. |
|
Transaction |
Transaction ID |
ID of a transaction. The length cannot exceed 1000 characters. This field cannot be empty. |
Associated merchant |
Store or associated merchant where the transaction is initiated. The length cannot exceed 1000 characters. |
|
Total revenue |
Total revenue or amount of a transaction (for example, 11.99). The revenue or amount includes the freight, tax, and other relevant incomes. |
|
Total freight |
Total freight of a transaction (for example, 5). |
|
Total tax |
Total tax amount of a transaction (for example, 1.29). |
|
Currency unit |
Currency code of a transaction, which complies with ISO-4217, for example, CNY for China's yuan. |
|
Product |
Transaction ID |
ID of a transaction. The length cannot exceed 1000 characters. This field cannot be empty. |
Product |
Product name. The length cannot exceed 1000 characters. This field cannot be empty. |
|
Price |
Product unit price, for example, 11.99. The value must be a number. |
|
Quantity |
Product quantity. The length cannot exceed 1000 characters. |
|
Code |
SKU or product code, for example, I-PC-BIG. The length cannot exceed 1000 characters. |
|
Category |
Product category. The length cannot exceed 1000 characters. |
|
Currency unit |
Currency code of a transaction, which complies with ISO-4217, for example, CNY for China's yuan. |
|
Custom parameter |
Fields |
|
Custom dimensions |
The key is in cd+Numeric index format, for example, cd1, cd2, and cd200. The numeric index must be an integer ranging from 1 to 200. Up to 20 dimensions are allowed for a non-Google Analytics 360 account. The length cannot exceed 1000 characters. |
|
Custom indicators |
The key is in cm+Numeric index format, for example, cm1, cm2, and cm200. The numeric index must be an integer ranging from 1 to 200. Up to 20 indicators are allowed for a non-Google Analytics 360 account. The value must be a number. |
By default, this platform collects the anonymous application identifier (AAID) of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
An AAID uniquely identifies a device that installs an app. A unique AAID is allocated to each app on the same device so that statistics can be collected and analyzed for different apps (for example, statistics on the number of active users). In addition, personal data from different apps is isolated to protect user data privacy and security.
Field |
Description |
|---|---|
Event name |
|
Parameters for addition |
|
Field |
Description |
|---|---|
Developer token |
|
Association ID |
|
App event type |
App event name that you set. You can select only one option. |
Event name |
This field is mandatory when App event type is set to custom, and cannot be set to an event name that already exists in the app event type list. |
GCLID |
This field is displayed only when App event type is set to session_start, and the length cannot exceed 1000 characters. |
Event value |
If you select Enable next to this field, the data type is Float for Value, and the value of Currency cannot be empty and can contain up to 1000 characters. |
Event data |
If you select Enable next to this field, the value of Key or Value cannot be empty and can contain up to 1000 characters. |
Product name |
|
Product version |
|
Device IP address |
|
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Field |
Description |
|---|---|
App ID |
|
Developer key |
|
AppsFlyer device ID |
|
Event name |
|
Event currency |
The length cannot exceed 1000 characters. |
Event parameters |
If an event parameter is added, both Key and Value are mandatory. The length of the key or value cannot exceed 1000 characters. |
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Field |
Description |
|---|---|
App token |
|
Event token |
|
Revenue amount |
|
Custom parameter |
If a custom parameter is added, the length of the key or value cannot exceed 1000 characters. |
Add partner parameter |
If a partner parameter is added, the length of the key or value cannot exceed 1000 characters. |
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Operation Type |
Field |
Description |
|---|---|---|
Installation |
Kochava app ID |
|
User agent |
The length cannot exceed 1000 characters. |
|
App version |
The length cannot exceed 1000 characters. |
|
Event |
Kochava app ID |
|
Event name |
|
|
Event time |
You can select or deselect the check box of this field. |
|
User agent |
The length cannot exceed 1000 characters. |
|
App version |
The length cannot exceed 1000 characters. |
|
Device version |
The length cannot exceed 1000 characters. |
|
Event parameters |
If an event parameter is added, the length of the key or value cannot exceed 1000 characters. |
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Field |
Description |
|---|---|
Advertiser ID |
Advertising customer ID. |
Group code string |
|
Activity code string |
|
Statistical method |
Select an option. |
Session ID |
This field is displayed only when Statistical method is set to Each session. The value cannot be empty and the length cannot exceed 1000 characters. |
Custom variable |
If a custom variable is added:
|
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Field |
Description |
|---|---|
Advertising ID |
Advertising customer ID. |
Group code string |
|
Activity code string |
|
Revenue amount |
|
Order ID |
|
Statistical method |
Select an option. |
Quantity |
This field is displayed only when Statistical method is set to Sold products. The value cannot be empty and the length cannot exceed 1000 characters. |
Custom variable |
If a custom variable is added:
|
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Field |
Description |
|---|---|
API key |
|
App package name |
|
Report type |
Select an option. |
Event name |
If Event type is set to Event report, the event name cannot be empty and can contain up to 1000 characters. |
Revenue event |
If you select Enable next to this field, the data type is Float for Revenue, and the value of Currency cannot be empty and can contain up to 1000 characters. |
Custom parameter |
If a custom parameter is added, the value of Key or Value cannot be empty and can contain up to 1000 characters. |
App name |
If Event type is set to Session report, the app name cannot be empty and can contain up to 1000 characters. |
Type |
Field |
Description |
|---|---|---|
Basic parameters |
App key |
|
Event name |
Select an option. |
|
Custom event name |
If Event name is set to CUSTOM, the custom event name cannot be empty. Branch recommends that the custom event name contain up to 40 characters including letters, digits, hyphens (-), spaces, and underscores (_) only and do not begin with a hyphen. |
|
User parameters |
os_version |
The value can be an integer ranging from 0 to 99,999,999. |
developer_identity |
The length cannot exceed 1000 characters. |
|
country |
The length cannot exceed 32 characters. |
|
language |
Select an option. |
|
app_version |
The length cannot exceed 1000 characters. |
|
brand |
The length cannot exceed 1000 characters. |
|
model |
The length cannot exceed 1000 characters. |
|
screen_size |
|
|
Event parameters |
search_query |
The length cannot exceed 1000 characters. |
transaction_id |
The length cannot exceed 1000 characters. |
|
currency |
Select an option. |
|
revenue |
|
|
shipping |
|
|
tax |
|
|
coupon |
The length cannot exceed 1000 characters. |
|
affiliation |
The length cannot exceed 1000 characters. |
|
description |
The length cannot exceed 1000 characters. |
|
Product parameters |
content_schema |
Select an option. |
og_title |
The length cannot exceed 1000 characters. |
|
og_description |
The length cannot exceed 1000 characters. |
|
og_image_url |
The length cannot exceed 1000 characters. |
|
canonical_identifier |
The length cannot exceed 1000 characters. |
|
publicly_indexable |
The value must be a Branch custom variable whose data type is Boolean. |
|
locally_indexable |
The value must be a Branch custom variable whose data type is Boolean. |
|
price |
|
|
quantity |
|
|
sku |
The length cannot exceed 1000 characters. |
|
product_name |
The length cannot exceed 1000 characters. |
|
product_brand |
The length cannot exceed 1000 characters. |
|
product_category |
Select an option. |
|
product_variant |
The length cannot exceed 1000 characters. |
|
rating_average |
|
|
rating_count |
|
|
rating_max |
|
|
creation_timestamp |
|
|
exp_date |
|
|
keywords |
The value must be a Branch custom variable whose data type is Array. |
|
address_street |
The length cannot exceed 1000 characters. |
|
address_city |
The length cannot exceed 1000 characters. |
|
address_region |
The length cannot exceed 1000 characters. |
|
address_country |
The length cannot exceed 32 characters. |
|
address_postal_code |
The length cannot exceed 1000 characters. |
|
latitude |
|
|
longitude |
|
|
image_captions |
The value must be a Branch custom variable whose data type is Array. |
|
condition |
Select an option. |
|
Custom parameter |
The length of the key or value cannot exceed 1000 characters. |
|
Custom parameter |
Custom parameter |
The length of the key or value cannot exceed 1000 characters. |
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Field |
Description |
|---|---|
App ID |
|
Report type |
Select an option. |
Event name |
Select an event name if Report type is set to App event. |
Custom parameter |
The length of the key or value cannot exceed 1000 characters. |
Ad type |
The length cannot exceed 1000 characters. |
Description |
The length cannot exceed 1000 characters. |
Success |
The value is 0 (failure) or 1 (success). |
Content type |
The length cannot exceed 1000 characters. |
Content ID |
The length cannot exceed 1000 characters. |
Currency |
The length cannot exceed 1000 characters. |
Registration method |
The length cannot exceed 1000 characters. |
Product quantity |
The value can be an integer ranging from 0 to 9,999,999,999,999,999. |
Payment information available |
The value is 0 (unavailable) or 1 (available). |
Level |
The length cannot exceed 1000 characters. |
Max score |
The value can be an integer ranging from 0 to 9,999,999,999,999,999. |
Search string |
The length cannot exceed 1000 characters. |
Order ID |
The length cannot exceed 1000 characters. |
By default, this platform collects the OAID of the user device. To report events to this platform, you need to notify users of the collection in the privacy statement and obtain consent from the users.
The OAID is a non-permanent device identifier used for personalized advertising. With OAIDs, you will be able to provide personalized ads for users while protecting their personal data privacy. Users can turn on the Disable personalized ads switch on their devices. After the switch is turned on, the OAID will be replaced with a string containing only 0.
Field |
Description |
|---|---|
Class path |
Full path of the class implementing the com.huawei.hms.dtm.ICustomTag API.
|
Add |
If a parameter is added, the length of the key or value cannot exceed 1000 characters. |
Field |
Description |
|---|---|
URL |
|
Reporting method |
Event reporting method. The options are as follows:
|
Request header |
If a request header is added, the length of the key or value cannot exceed 1000 characters. |
Merge original event parameters with specified parameters |
Indicates whether to merge the Bundle parameter of the onEvent method with parameters specified under Parameter. By default, this parameter is deselected. |
Parameter |
If a parameter is added, the length of the key or value cannot exceed 1000 characters. |