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

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

メモ

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

重要

親種別

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

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

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

バージョン

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

特別なアクセスルール

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

項目

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

OmniTrackingComponentDef

OmniAnalytics のユーザーインタラクションを追跡する OmniTrackingGroup のメンバーである FlexCard または OmniScript を表します。

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

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<OmniTrackingGroup xmlns="http://soap.sforce.com/2006/04/metadata">
3    <developerName>Purchase_Tracking</developerName>
4    <groupType>Internal</groupType>
5    <isActive>true</isActive>
6    <masterLabel>Purchase_Tracking</masterLabel>
7    <omniTrackingComponentDefs>
8        <componentType>Omniscript</componentType>
9        <componentVersion>2</componentVersion>
10        <developerName>Purchase_Funnel</developerName>
11        <masterLabel>Purchase_Funnel</masterLabel>
12    </omniTrackingComponentDefs>
13</OmniTrackingGroup>

前の定義を参照する 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>OmniTrackingGroup</name>
6    </types>
7    <version>60.0</version>
8</Package>

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

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