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
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	✓	✓

構成

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

コネクタを追加した後、以下の構成を行います：

• Bearer Token：
  • TealiumがYandexアプリにアクセスできるように許可を与えることで、bearerトークンを生成します。Yandex OAuthサービスを使用します。
  • Yandexアプリでアクセスを許可した後、トークンをコピーできるページにリダイレクトされます。
  • トークンをYandex Metricaコネクタに貼り付けます。
  • トークンは1年間有効です。
• Counter ID： 構成のためのカウンターID。

アクション

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

Send Order Event

パラメータ

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

Send Order Event Batch

パラメータ

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

Upsert Contact

パラメータ

パラメータ	説明
更新タイプ	保存 - 以前に送信された情報はすべて新しい情報で完全に置き換えられます。 更新 - 現在ロードしている情報のみが更新されます。 追加 - 新しい情報が以前にダウンロードしたデータに追加されます。
ユニーク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に変換します。 @ya.ruや@yandex.comなどの複数のYandexドメインのアドレスは、@yandex.ruに統一します。例えば、example@@ya.ruをexample@yandex.ruに変更します。 メールアドレスに+記号が含まれている場合、例えばname+commercial@example.comの場合、+の前の名前のみを保持します：name@example.com。
電話番号 MD5	顧客の電話番号のリスト、MD5形式でハッシュ化。 +記号を除いた国コード付きの番号を入力します。 ハッシュ化する前に電話番号を正規化します。 テキストを小文字に変換します。 先頭/末尾のスペースとカンマを削除します。 数字のみを使用します。 例えば、70123456789。
属性値	指定した順序でカスタマイズされ、渡される属性。

Upsert Contact Batch

パラメータ

パラメータ	説明
更新タイプ	保存 - 以前に送信された情報はすべて新しい情報で完全に置き換えられます。 更新 - 現在ロードしている情報のみが更新されます。 追加 - 新しい情報が以前にダウンロードしたデータに追加されます。
ユニーク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に変換します。 @ya.ruや@yandex.comなどの複数のYandexドメインのアドレスは、@yandex.ruに統一します。例えば、example@@ya.ruをexample@yandex.ruに変更します。 メールアドレスに+記号が含まれている場合、例えばname+commercial@example.comの場合、+の前の名前のみを保持します：name@example.com。
電話番号 MD5	顧客の電話番号のリスト、MD5形式でハッシュ化。 +記号を除いた国コード付きの番号を入力します。 ハッシュ化する前に電話番号を正規化します。 テキストを小文字に変換します。 先頭/末尾のスペースとカンマを削除します。 数字のみを使用します。 例えば、70123456789。
属性値	指定した順序でカスタマイズされ、渡される属性。

Send Page View Event

パラメータ

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

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

パラメータ

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

Send Goal Event

パラメータ

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

Eコマースイベントを送信

パラメータ

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

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

パラメータ

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