OmniExtTrackingDef | メタデータ API 開発者ガイド

このメタデータ型は、OmniStudio for Vlocity ではなく、OmniStudio Standard の一部です。

メモ

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

OmniExtTrackingDef コンポーネントのサフィックスは .OmniExtTrackingDef で、OmniExtTrackingDefs フォルダーに保存されます。

バージョン

OmniExtTrackingDef コンポーネントは、API バージョン 60.0 以降で使用できます。

特別なアクセスルール

OmniAnalytics を使用するには、OmniStudio ライセンスを取得し、設定で OmniAnalytics を有効にする必要があります。

項目

項目名	説明
description	項目の型 string 説明 OmniExtTrackingDef の説明。
developerName	項目の型 string 説明必須。 API での OmniExtTrackingDef の一意の名前。この名前は、アンダースコアと英数字のみを含み、組織内で一意の名前にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。最大 80 文字です。大規模データセットを作成する場合、必ず各レコードの一意の DeveloperName を指定してください。DeveloperName が指定されていないと、Salesforce で各レコードの DeveloperName を生成している間にパフォーマンスが低下する可能性があります。メモ「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザーのみがこの項目の表示、グループ化、並べ替え、絞り込みを行えます。メモ
isActive	項目の型 boolean 説明必須。 OmniExtTrackingDef が有効かどうかを指定します。
masterLabel	項目の型 string 説明必須。 OmniExtTrackingDef の一意のマスター表示ラベル。この内部ラベルは翻訳されません。
omniExtTrackingDefKey	項目の型 string 説明すべての組織にわたって OmniExtTrackingDef レコードを一意に識別するために Salesforce が内部的に生成する UUID。
omniExtTrackingEventDefs	項目の型 OmniExtTrackingEventDef[] 説明この OmniExtTrackingDef に関連する OmniExtTrackingEventDef オブジェクト。
trackingFrameworkInformation	項目の型 string 説明必須。 API コールや入力パラメーター名など、外部サービスに関する情報を含む JSON データ。
trackingServiceProvider	項目の型 ExternalTrackingVendor (string 型の列挙) 説明必須。ユーザーインタラクションデータの送信先となるサードパーティのアナリティクスシステム。値は次のとおりです。 `Google` `Mixpanel`

OmniExtTrackingEventDef

Google アナリティクスのようなサードパーティのアナリティクスシステムが受け付ける、FlexCard や OmniScript のユーザーインタラクションデータの形式を表します。

項目名	説明
componentType	項目の型 OmniAnalyticsComponentType (string 型の列挙) 説明必須。ユーザーインタラクションが追跡されるコンポーネントのタイプ。値は次のとおりです。 `Flexcard` `Omniscript`
description	項目の型 string 説明 OmniExtTrackingEventDef の説明。
developerName	項目の型 string 説明必須。 API での OmniExtTrackingEventDef の一意の名前。この名前は、アンダースコアと英数字のみを含み、組織内で一意の名前にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。最大 80 文字です。大規模データセットを作成する場合、必ず各レコードの一意の DeveloperName を指定してください。DeveloperName が指定されていないと、Salesforce で各レコードの DeveloperName を生成している間にパフォーマンスが低下する可能性があります。メモ「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザーのみがこの項目の表示、グループ化、並べ替え、絞り込みを行えます。メモ
inclusionRule	項目の型 string 説明必須。イベントをサードパーティのアナリティクスシステムに送信するかどうかを判定する真偽条件。
masterLabel	項目の型 string 説明必須。 OmniExtTrackingEventDef の一意のマスター表示ラベル。この内部ラベルは翻訳されません。
omniExtTrackingDef	項目の型 string 説明関連する OmniExtTrackingDef オブジェクトの ID。
omniExtTrackingEventDefKey	項目の型 string 説明すべての組織にわたって OmniExtTrackingEventDef レコードを一意に識別するために Salesforce が内部的に生成する UUID。
payloadTemplate	項目の型 string 説明必須。ランタイムデータ用のプレース��ルダーを持つペイロードテンプレート構造。これは実行時に使用され、外部のアナリティクスサービスに送信される実際のペイロードを生成します。

宣言的なメタデータの定義のサンプル

OmniExtTrackingDef コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<OmniExtTrackingDef xmlns="http://soap.sforce.com/2006/04/metadata">
3    <developerName>Purchase_Tracking_Google</developerName>
4    <isActive>true</isActive>
5    <masterLabel>Purchase_Tracking_Google</masterLabel>
6    <trackingFrameworkInformation>{ "id": "GTM-XXXXXXX" }</trackingFrameworkInformation>
7    <trackingServiceProvider>Google</trackingServiceProvider>
8    <omniExtTrackingEventDefs>
9        <componentType>Omniscript</componentType>
10        <developerName>Purchase_Funnel_Google</developerName>
11        <inclusionRule></inclusionRule>
12        <masterLabel>Purchase_Funnel_Google</masterLabel>
13        <payloadTemplate>
14{
15  "event": "promotionClick",
16  "ecommerce": {
17    "promoClick": {
18      "promotions": [
19        {
20          "name": "%BusinessEvent%"
21        }
22      ]
23    }
24  }
25}
26        </payloadTemplate>
27    </omniExtTrackingEventDefs>
28</OmniExtTrackingDef>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>OmniExtTrackingDef</name>
6    </types>
7    <version>60.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。