Yandex Metrica Connector Setup Guide | Server-Side Connectors

API Information

This connector uses the following vendor API:

API Name: Yandex API
API Version: v1.0
API Endpoint: https://api-metrika.yandex.net/cdp/api/v1
Documentation: Yandex API

Batch Limits

This connector uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

Max number of requests: 100,000
Max time since oldest request: 5 minutes
Max size of requests: 2 MB

Actions

Action name	AudienceStream	EventStream
Send Order Event	✗	✓
Send Order Event Batch	✗	✓
Upsert Contact	✓	✓
Upsert Contact Batch	✗	✓
Send Page View Event	✗	✓
Send Goal Event	✓	✓
Send Ecommerce Event	✗	✓
Send Advanced Matching Event	✓	✓

Configuration

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.

After adding the connector, configure the following settings:

Bearer Token:
- Generate a bearer token by granting Tealium access to the Yandex app using the Yandex OAuth service.
- After granting access in the Yandex app, you will be redirected to a page where you can copy the token.
- Paste the token into the Yandex Metrica connector.
- The token is valid for one year.
Counter ID: The Counter ID for the configuration.

Actions

The following section lists the supported parameters for each action.

Send Order Event

Parameters

Parameter	Description
Update Type	Save - All previously transmitted information is completely replaced with new information. Update - Only the information you are currently loading is updated. Append - New information is added to the previously downloaded data.
ID	Required Order ID.
Client Unique ID	Required ID of the customer in CRM associated with the order.
Create Date Time	Required The date and time the order was created in the counter’s time zone. The value cannot be changed. For more information, see the Date and time format.
Order Status	Required Order status ID. Arbitrary string. The status can be changed. For more information, see Comparison of order statuses. Default possible values: PAID, IN_PROGRESS, CANCELLED, SPAM. Additional values you create are accepted.
Update Date Time	The date and time the order was updated in the counter’s time zone. If the parameter is not passed, the value is substituted automatically. For more information, see the Date and time format.
Finish Date Time	The date and time the order was completed in the counter’s time zone. For more information, see the Date and time format.
Revenue	Income - The total cost of the order. Decimal - Transfer the proceeds from the order. This value will be used in End-to-End Analytics reports to show the income from advertising channels. The value will be shown in the Revenue metric.
Cost	Cost price. You can pass the cost of orders to take profit into account in End-to-End Analytics reports. Profit will be calculated using the formula: `Revenue - Cost`.
Product IDs	Required Pass product identifiers and their quantity in the object. Identifiers will be available when creating a segment in Metrica if you do not transfer lists of products. If you create lists of products, then data from these lists will be available in Yandex Metrica. For example, `{"Product A" : 173, "Product B" : 146}`.
Product Quantities	Required Product quantities.
Attribute Values	Attributes to be customized and passed in the specified order.

Send Order Event Batch

Parameters

Parameter	Description
Update Type	Save - All previously transmitted information is completely replaced with new information. Update - Only the information you are currently loading is updated. Append - New information is added to the previously downloaded data.
ID	Required Order ID.
Client Unique ID	Required ID of the customer in CRM associated with the order.
Create Date Time	Required The date and time the order was created in the counter’s time zone. The value cannot be changed. For more information, see the Date and time format. For example, `2023-04-21 10:00:00`.
Order Status	Required Order status ID. Arbitrary string. The status can be changed. Specify the value you passed when matching statuses in the id field. Default possible values: PAID, IN_PROGRESS, CANCELLED, SPAM. The user can create additional values, therefore other values must be accepted.
Update Date Time	The date and time the order was updated in the counter’s time zone. If the parameter is not passed, the value is substituted automatically. For more information, see the Date and time format.
Finish Date Time	The date and time the order was completed in the counter’s time zone. For more information, see the Date and time format.
Revenue	Income - The total cost of the order. Decimal - Transfer the proceeds from the order. This value will be used in End-to-End Analytics reports to show the income from advertising channels. The value will be shown in the Revenue metric.
Cost	Cost price. You can pass the cost of orders to take profit into account in End-to-End Analytics reports. Profit will be calculated using the formula: `Revenue - Cost`.
Product IDs	Required Pass product identifiers and their quantity in the object. Identifiers will be available when creating a segment in Metrica if you do not transfer lists of products. If you create lists of products, then data from these lists will be available in Yandex Metrica. For example, `{"Product A" : 173, "Product B" : 146}`.
Product Quantities	Required Product quantities.
Attribute Values	Attributes to be customized and passed in the specified order.

Upsert Contact

Parameters

Parameter	Description
Update Type	Save - All previously transmitted information is completely replaced with new information. Update - Only the information you are currently loading is updated. Append - New information is added to the previously downloaded data.
Unique ID	Required Custom client ID. It can be a `customer_id` or the `tealium_visitor_id`.
Client ID	Yandex Metrika Client ID (`_ym_uid`).
Name	Client name. If you provide the last name, first name, and patronymic, the line will be condensed into the format John S, where S is the truncated last name.
Create Date Time	The date and time the contact was created in the counter’s time zone. The value cannot be changed. For more information, see the Date and time format.
Update Date Time	The date and time the contact was updated in the counter’s time zone. If the parameter is not passed, the value is substituted automatically. For more information, see the Date and time format.
Client IDs	List of client IDs.
Emails	List of client email addresses.
Phones	List of client phone numbers.
Emails MD5	List of client email addresses, hashed in MD5 format. Normalize email addresses before hashing by converting text to lowercase and removing leading/trailing spaces and commas. For Google domain addresses, remove dots in the username. For example, convert `name.example@gmail.com` to `nameexample@gmail.com`. For Yandex domain addresses, replace dots in the username with dashes. For example, convert `name.example@yandex.ru` to `name-example@yandex.ru`. For addresses on multiple Yandex domains such `@ya.ru` or `@yandex.com`, standardize them to `@yandex.ru`. For example, change `example@@ya.ru` to `example@yandex.ru`. If the email address contains a `+` sign such as `name+commercial@example.com`, retain only the name before `+`: `name@example.com`.
Phones MD5	List of customer phone numbers, hashed in MD5 format. Enter the number with the country code excluding the `+` sign. Normalize phone numbers before hashing. Convert text to lowercase. Remove leading/trailing spaces and commas. Use only digits. For example, `70123456789`.
Attribute Values	Attributes to be customized and passed in the specified order.

Upsert Contact Batch

Parameters

Parameter	Description
Update Type	Save - All previously transmitted information is completely replaced with new information. Update - Only the information you are currently loading is updated. Append - New information is added to the previously downloaded data.
Unique ID	Required Custom client ID. It can be a `customer_id` or the `tealium_visitor_id`.
Client ID	Required Yandex Metrika Client ID (`_ym_uid`).
Name	Client name. If you provide the last name, first name, and patronymic, the line will be condensed into the format John S, where S is the truncated last name.
Create Date Time	The date and time the contact was created in the counter’s time zone. The value cannot be changed. For more information, see the Date and time format.
Update Date Time	The date and time the contact was updated in the counter’s time zone. If the parameter is not passed, the value is substituted automatically. For more information, see the Date and time format.
Client IDs	List of client IDs.
Emails	List of client email addresses.
Phones	List of client phone numbers.
Emails MD5	List of client email addresses, hashed in MD5 format. Normalize email addresses before hashing. Convert text to lowercase. Remove leading/trailing spaces and commas. For Google domain addresses, remove dots in the username. For example, convert `name.example@gmail.com` to `nameexample@gmail.com`. For Yandex domain addresses, replace dots in the username with dashes. For example, convert `name.example@yandex.ru` to `name-example@yandex.ru`. For addresses on multiple Yandex domains such `@ya.ru` or `@yandex.com`, standardize them to `@yandex.ru`. For example, change `example@@ya.ru` to `example@yandex.ru`. If the email address contains a `+` sign such as `name+commercial@example.com`, retain only the name before `+`: `name@example.com`.
Phones MD5	List of customer phone numbers, hashed in MD5 format. Enter the number with the country code excluding the `+` sign. Normalize phone numbers before hashing. Convert text to lowercase. Remove leading/trailing spaces and commas. Use only digits. For example, `70123456789`.
Attribute Values	Attributes to be customized and passed in the specified order.

Send Page View Event

Parameters

Parameter	Description
Page Url	Current URL
Yandex Client ID	Required Yandex Metrica Client ID (`_ym_uid`).
Page Ref	Referral URL. If empty, the default URL is `https://tealium.com`.
Site Info	Custom object.
Custom Query Parameters	Additional custom query parameters.

Create a new session

Parameters

Parameter	Description
Page Url	Current URL
Yandex Client ID	Required Yandex Metrica Client ID (`_ym_uid`).
Page Ref	Referral URL. If empty, the default URL is `https://tealium.com`.
Site Info	Custom object.
Custom Query Parameters	Additional custom query parameters.

Send Goal Event

Parameters

Parameter	Description
Trigger Open Session Call	Yandex Metrica requires an open session call before triggering the Send Goal Event action.
Site Domain	Required The site domain.
Goal ID	Required The goal number.
Yandex Client ID	Required Yandex Metrica Client ID (`_ym_uid`)
Page Ref	Referral URL. If empty, the default URL is `https://tealium.com`.
Site Info	Custom object.
Custom Query Parameters	Additional custom query parameters.

Send Ecommerce Event

Parameters

Parameter	Description
Trigger Open Session Call	Yandex Metrica requires an open session call before triggering the Send Ecommerce Event action.
Page Url	Referral URL. If empty, the default URL is `https://tealium.com`.
Yandex Client ID	Required Yandex Metrica Client ID (`_ym_uid`).
Action Type	The field name, which replaces `actionType`, serves as the identifier for an action performed with a set of products. Possible values: Detail: View the full item description (product card). Add: Add an item to the basket. Remove: Remove an item from the basket. Purchase: Purchase an item. If information about removing the item was transmitted to Yandex Metrica, the report might show a negative number of items (the total is calculated by subtracting the number of deleted items from the total number of added items). If the price of the item was transmitted, it might also have a negative value in the report.
Currency Code	Three-letter ISO 4217 currency code. If a different currency is passed, null values will be sent instead of currencies and amounts.
ID	ID of the product purchased.
Coupon	A promo code associated with the entire purchase.
Goal ID	The goal number. Specified if the Send Ecommerce Event action was the goal. The goal must be set as a JavaScript event type. To see the goal number, go to the Goals tab and select Settings in the Yandex Metrica dashboard.
Revenue	The revenue received. If omitted, it is calculated automatically as the sum of the prices of all the items associated with the purchase.
ID	Item ID. For example, the SKU. You must specify either Name or ID.
Name	Name of the product. For example, T-shirt. You must specify either Name or ID.
Brand	The brand or trademark associated with the item. For example, Yandex.
Category	The category the item belongs to. The hierarchy of categories supports up to 5 nesting levels. Use the `/` symbol to separate levels. For example, Clothing/Men’s, clothing/T-shirts.
Coupon	A promo code associated with the item. For example, `PARTNER_SITE_15.`
Position	Position of the item in the list. For example, `2`.
Price	Price of a product unit.
Quantity	Quantity of product units.
Variant	A variation of the item. For example, Red.
Custom Query Parameters	Additional custom query parameters.

Send Advanced Matching Event

Parameters

Parameter	Description
Trigger Open Session Call	Yandex Metrica requires an open session call before triggering the Send Advanced Matching Event action.
Page Url	Referral URL. If empty, the default URL is `https://tealium.com`.
Yandex Client ID	Required. Yandex Metrica Client ID (`_ym_uid`).
MD5 Hashed	Select is value is MD5 hashed.
Email	User’s email address.
Phone Number	Enter the phone number including the country code, without the `+` symbol and spaces. For example, `70123456789`.
First Name	User’s first name.
Last Name	User’s last name.
Street	Street.
City	City.
Region	Region.
Postal Code	Accepts any integer.
Country	Accepts any string.
Custom Query Parameters	Additional custom query parameters.