Yandex Metricaコネクタの設定ガイド

API情報

このコネクタは、次のベンダーAPIを使用します：

• API名：Yandex API
• APIバージョン：v1.0
• APIエンドポイント：https://api-metrika.yandex.net/cdp/api/v1
• ドキュメント：Yandex API

バッチ制限

このコネクタは、ベンダーへの高容量データ転送をサポートするためにバッチリクエストを使用します。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値が満たされるか、プロファイルが公開されるまでキューに入れられます：

• 最大リクエスト数：100,000
• 最も古いリクエストからの経過時間の最大値：5分
• リクエストの最大サイズ：2 MB

アクション

アクション名	AudienceStream	EventStream
注文イベントを送信する	✗	✓
注文イベントバッチを送信する	✗	✓
連絡先を更新または作成する	✓	✓
連絡先バッチを更新または作成する	✗	✓
ページビューイベントを送信する	✗	✓
ゴールイベントを送信する	✓	✓
ECイベントを送信する	✗	✓
アドバンスドマッチングイベントを送信する	✓	✓

構成

コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法の一般的な手順については、コネクタについてを参照してください。

コネクタを追加した後、次の構成を構成します：

• ベアラートークン：
  • Yandex OAuthサービスを使用して、TealiumがYandexアプリにアクセスするためのベアラートークンを生成します。
  • Yandexアプリでアクセスを許可した後、トークンをコピーできるページにリダイレクトされます。
  • トークンをYandex Metricaコネクタに貼り付けます。
  • トークンの有効期限は1年です。
• カウンターID： 構成のためのカウンターID。

アクション

以下のセクションでは、各アクションに対してサポートされているパラメータをリストします。

注文イベントを送信する

パラメータ

パラメータ	説明
更新タイプ	保存 - 以前に送信されたすべての情報は、新しい情報で完全に置き換えられます。 更新 - 現在読み込んでいる情報のみが更新されます。 追加 - 新しい情報が以前にダウンロードされたデータに追加されます。
ID	必須 注文ID。
クライアント固有ID	必須 注文に関連付けられたCRMの顧客のID。
作成日時	必須 注文がカウンターのタイムゾーンで作成された日時。値は変更できません。 詳細については、日付と時刻の形式を参照してください。
注文ステータス	必須 注文ステータスID。 任意の文字列。 ステータスは変更できます。 詳細については、注文ステータスの比較を参照してください。 デフォルトの可能な値：PAID、IN_PROGRESS、CANCELLED、SPAM。 作成した追加の値も受け入れられます。
更新日時	注文がカウンターのタイムゾーンで更新された日時。 パラメータが渡されない場合、値は自動的に代入されます。 詳細については、日付と時刻の形式を参照してください。
完了日時	注文がカウンターのタイムゾーンで完了した日時。 詳細については、日付と時刻の形式を参照してください。
収益	収入 - 注文の総額。 小数 - 注文の収益を転送します。 この値は、エンドツーエンドアナリティクスレポートで広告チャネルからの収入を表示するために使用されます。 値はRevenueメトリックで表示されます。
コスト	原価。 エンドツーエンドアナリティクスレポートで利益を計算するために、注文の原価を渡すことができます。 利益は次の式で計算されます：Revenue - Cost。
商品ID	必須 オブジェクト内で商品の識別子と数量を渡します。 製品のリストを転送しない場合、セグメントを作成する際に識別子が利用可能になります。 製品リストを作成する場合、これらのリストからのデータがYandex Metricaで利用できます。 例：{"Product A" : 173, "Product B" : 146}。
商品数量	必須 商品の数量。
属性値	カスタマイズされた属性を指定された順序で渡します。

注文イベントバッチを送信する

パラメータ

パラメータ	説明
更新タイプ	保存 - 以前に送信されたすべての情報は、新しい情報で完全に置き換えられます。 更新 - 現在読み込んでいる情報のみが更新されます。 追加 - 新しい情報が以前にダウンロードされたデータに追加されます。
ID	必須 注文ID。
クライアント固有ID	必須 注文に関連付けられたCRMの顧客のID。
作成日時	必須 注文がカウンターのタイムゾーンで作成された日時。値は変更できません。 詳細については、日付と時刻の形式を参照してください。 例：2023-04-21 10:00:00。
注文ステータス	必須 注文ステータスID。 任意の文字列。 ステータスは変更できます。 ステータスをidフィールドでマッチングする場合に値を指定します。 デフォルトの可能な値：PAID、IN_PROGRESS、CANCELLED、SPAM。 ユーザーは追加の値を作成できるため、他の値も受け入れる必要があります。
更新日時	注文がカウンターのタイムゾーンで更新された日時。 パラメータが渡されない場合、値は自動的に代入されます。 詳細については、日付と時刻の形式を参照してください。
完了日時	注文がカウンターのタイムゾーンで完了した日時。 詳細については、日付と時刻の形式を参照してください。
収益	収入 - 注文の総額。 小数 - 注文の収益を転送します。 この値は、エンドツーエンドアナリティクスレポートで広告チャネルからの収入を表示するために使用されます。 値はRevenueメトリックで表示されます。
コスト	原価。 エンドツーエンドアナリティクスレポートで利益を計算するために、注文の原価を渡すことができます。 利益は次の式で計算されます：Revenue - Cost。
商品ID	必須 オブジェクト内で商品の識別子と数量を渡します。 製品のリストを転送しない場合、セグメントを作成する際に識別子が利用可能になります。 製品リストを作成する場合、これらのリストからのデータがYandex Metricaで利用できます。 例：{"Product A" : 173, "Product B" : 146}。
商品数量	必須 商品の数量。
属性値	カスタマイズされた属性を指定された順序で渡します。

連絡先を更新または作成する

パラメータ

パラメータ	説明
更新タイプ	保存 - 以前に送信されたすべての情報は、新しい情報で完全に置き換えられます。 更新 - 現在読み込んでいる情報のみが更新されます。 追加 - 新しい情報が以前にダウンロードされたデータに追加されます。
固有ID	必須 カスタムクライアントID。customer_idまたはtealium_visitor_idのいずれかです。
クライアントID	Yandex MetrikaクライアントID（_ym_uid）。
名前	顧客の名前。 姓、名、およびミドルネームを提供する場合、行はJohn Sのように短縮されます。ここでSは姓の切り捨てられた部分です。
作成日時	連絡先がカウンターのタイムゾーンで作成された日時。 値は変更できません。 詳細については、日付と時刻の形式を参照してください。
更新日時	連絡先がカウンターのタイムゾーンで更新された日時。 パラメータが渡されない場合、値は自動的に代入されます。 詳細については、日付と時刻の形式を参照してください。
クライアントID	クライアントIDのリスト。
メールアドレス	顧客のメールアドレスのリスト。
電話番号	顧客の電話番号のリスト。
メールアドレスMD5	顧客のメールアドレスのリスト。MD5形式でハッシュ化されます。 ハッシュ化する前にメールアドレスを正規化します。テキストを小文字に変換し、先頭/末尾のスペースとカンマを削除します。 Googleドメインのアドレスの場合、ユーザー名のドットを削除します。たとえば、name.example@gmail.comをnameexample@gmail.comに変換します。 Yandexドメインのアドレスの場合、ユーザー名のドットをダッシュに置き換えます。たとえば、name.example@yandex.ruをname-example@yandex.ruに変換します。 複数のYandexドメイン（@ya.ruや@yandex.comなど）のアドレスの場合、これらを@yandex.ruに標準化します。たとえば、example@@ya.ruをexample@yandex.ruに変更します。 メールアドレスに+記号が含まれる場合（name+commercial@example.comなど）、+の前の名前のみを保持します：name@example.com。
電話番号MD5	顧客の電話番号のリスト。MD5形式でハッシュ化されます。 国コードを含む電話番号を入力します。+記号とスペースを除きます。 ハッシュ化する前に電話番号を正規化します。 テキストを小文字に変換します。 先頭/末尾のスペースとカンマを削除します。 数字のみを使用します。 例：70123456789。
属性値	カスタマイズされた属性を指定された順序で渡します。

連絡先バッチを更新または作成する

パラメータ

パラメータ	説明
更新タイプ	保存 - 以前に送信されたすべての情報は、新しい情報で完全に置き換えられます。 更新 - 現在読み込んでいる情報のみが更新されます。 追加 - 新しい情報が以前にダウンロードされたデータに追加されます。
固有ID	必須 カスタムクライアントID。customer_idまたはtealium_visitor_idのいずれかです。
クライアントID	必須 Yandex MetrikaクライアントID（_ym_uid）。
名前	顧客の名前。 姓、名、およびミドルネームを提供する場合、行はJohn Sのように短縮されます。ここでSは姓の切り捨てられた部分です。
作成日時	連絡先がカウンターのタイムゾーンで作成された日時。 値は変更できません。 詳細については、日付と時刻の形式を参照してください。
更新日時	連絡先がカウンターのタイムゾーンで更新された日時。 パラメータが渡されない場合、値は自動的に代入されます。 詳細については、日付と時刻の形式を参照してください。
クライアントID	クライアントIDのリスト。
メールアドレス	顧客のメールアドレスのリスト。
電話番号	顧客の電話番号のリスト。
メールアドレスMD5	顧客のメールアドレスのリスト。MD5形式でハッシュ化されます。 メールアドレスをハッシュ化する前に正規化します。 テキストを小文字に変換します。 先頭/末尾のスペースとカンマを削除します。 Googleドメインのアドレスの場合、ユーザー名のドットを削除します。たとえば、name.example@gmail.comをnameexample@gmail.comに変換します。 Yandexドメインのアドレスの場合、ユーザー名のドットをダッシュに置き換えます。たとえば、name.example@yandex.ruをname-example@yandex.ruに変換します。 複数のYandexドメイン（@ya.ruや@yandex.comなど）のアドレスの場合、これらを@yandex.ruに標準化します。たとえば、example@@ya.ruをexample@yandex.ruに変更します。 メールアドレスに+記号が含まれる場合（name+commercial@example.comなど）、+の前の名前のみを保持します：name@example.com。
電話番号MD5	顧客の電話番号のリスト。MD5形式でハッシュ化されます。 国コードを含む電話番号を入力します。+記号とスペースを除きます。 ハッシュ化する前に電話番号を正規化します。 テキストを小文字に変換します。 先頭/末尾のスペースとカンマを削除します。 数字のみを使用します。 例：70123456789。
属性値	カスタマイズされた属性を指定された順序で渡します。

ページビューイベントを送信する

パラメータ

パラメータ	説明
ページURL	現在のURL
YandexクライアントID	必須 Yandex MetricaクライアントID（_ym_uid）。
ページリファラー	リファラーURL。空の場合、デフォルトのURLはhttps://tealium.comです。
サイト情報	カスタムオブジェクト。
カスタムクエリパラメータ	追加のカスタムクエリパラメータ。

新しいセッションを作成する

パラメータ

パラメータ	説明
ページURL	現在のURL
YandexクライアントID	必須 Yandex MetricaクライアントID（_ym_uid）。
ページリファラー	リファラーURL。空の場合、デフォルトのURLはhttps://tealium.comです。
サイト情報	カスタムオブジェクト。
カスタムクエリパラメータ	追加のカスタムクエリパラメータ。

ゴールイベントを送信する

パラメータ

パラメータ	説明
オープンセッションコールをトリガーする	Yandex Metricaは、ゴールイベントを送信するアクションをトリガーする前にオープンセッションコールが必要です。
サイトドメイン	必須 サイトのドメイン。
ゴールID	必須 ゴール番号。
YandexクライアントID	必須 Yandex MetricaクライアントID（_ym_uid）
ページリファラー	リファラーURL。空の場合、デフォルトのURLはhttps://tealium.comです。
サイト情報	カスタムオブジェクト。
カスタムクエリパラメータ	追加のカスタムクエリパラメータ。

ECイベントを送信する

パラメータ

パラメータ	説明
オープンセッションコールをトリガーする	Yandex Metricaは、ECイベントを送信するアクションをトリガーする前にオープンセッションコールが必要です。
ページURL	リファラーURL。空の場合、デフォルトのURLはhttps://tealium.comです。
YandexクライアントID	必須 Yandex MetricaクライアントID（_ym_uid）。
アクションタイプ	フィールド名で、商品のセットで実行されるアクションを識別します。 可能な値： Detail：アイテムの詳細を表示します（製品カード）。 Add：アイテムをカートに追加します。 Remove：アイテムをカートから削除します。 Purchase：アイテムを購入します。 アイテムの削除に関する情報がYandex Metricaに送信された場合、レポートにはアイテムの負数が表示される場合があります（合計は、追加されたアイテムの総数から削除されたアイテムの数を引いて計算されます）。アイテムの価格が送信された場合、レポートには負の値も表示される場合があります。
通貨コード	3文字のISO 4217通貨コード。 異なる通貨が渡された場合、通貨と金額の代わりにnull値が送信されます。
ID	購入した商品のID。
クーポン	購入全体に関連するプロモーションコード。
ゴールID	ゴール番号。 ECイベントを送信する アクションがゴールである場合に指定します。 ゴールはJavaScriptイベントタイプとして構成する必要があります。 ゴール番号を確認するには、Yandex MetricaダッシュボードでGoalsタブを選択し、Settingsを選択します。
収益	受け取った収益。 省略した場合、収益は自動的に計算され、購入に関連するすべてのアイテムの価格の合計となります。
ID	アイテムID。 例えば、SKUです。 NameまたはIDのいずれかを指定する必要があります。
名前	商品の名前。 例えば、Tシャツです。 NameまたはIDのいずれかを指定する必要があります。
ブランド	アイテムに関連するブランドまたは商標。 例えば、Yandexです。
カテゴリ	アイテムが属するカテゴリ。 カテゴリの階層は最大5つのネストレベルをサポートしています。レベルを区切るために/記号を使用します。 例えば、Clothing/Men’s、clothing/T-shirtsです。
クーポン	アイテムに関連するプロモーションコード。 例えば、PARTNER_SITE_15です。
位置	リスト内のアイテムの位置。 例えば、2です。
価格	製品単位の価格。
数量	製品単位の数量。
バリアント	アイテムのバリエーション。 例えば、Redです。
カスタムクエリパラメータ	追加のカスタムクエリパラメータ。

アドバンスドマッチングイベントを送信する

パラメータ

パラメータ	説明
オープンセッションコールをトリガーする	Yandex Metricaは、アドバンスドマッチングイベントを送信するアクションをトリガーする前にオープンセッションコールが必要です。
ページURL	リファラーURL。空の場合、デフォルトのURLはhttps://tealium.comです。
YandexクライアントID	必須。Yandex MetricaクライアントID（_ym_uid）。
MD5ハッシュ化	MD5ハッシュ化されている場合は選択します。
メールアドレス	ユーザーのメールアドレス。
電話番号	+記号とスペースを除いた国コードを含む電話番号を入力します。例：70123456789。
名前	ユーザーの名前。
姓	ユーザーの姓。
住所	住所。
市区町村	市区町村。
都道府県	都道府県。
郵便番号	任意の整数を受け付けます。
国	任意の文字列を受け付けます。
カスタムクエリパラメータ	追加のカスタムクエリパラメータ。