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

親種別

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

重要

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

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

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

バージョン

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

特別なアクセスルール

組織でマーケティングアプリケーションの拡張機能に最初にアクセスする Salesforce システム管理者または指定されたマーケティング管理者は「公開リストビューの管理」ユーザー権限を持っている必要があります。その後この機能を使用するユーザーにはこの権限は必要ありません。

項目

項目名	説明
description	項目の型 string 説明拡張機能の説明 (内部参照用)。UI に表示されます。
isActive	項目の型 boolean 説明この項目により、マーケティングアプリケーション拡張機能のデータを Account Engagement オートメーションで使用できるようになります。オートメーションでの表示ラベルは [有効] です。デフォルト値は、`false` です。UI に表示されます。
isProtected	項目の型 boolean
marketingAppExtActions	項目の型 MarketingAppExtAction[] 説明この項目は、関連付けられた外部アクションの関連リストです。
marketingAppExtActivities	項目の型 MarketingAppExtActivity[] 説明この項目は、関連付けられた外部プロスペクト活動の関連リストです。
masterLabel	項目の型 string 説明必須。MarketingAppExtension の表示ラベル。UI では、この項目は [拡張名] です。

MarketingAppExtActivity

サードパーティアプリケーション内で発生したプロスペクト活動であり、Account Engagement オートメーションで使用できる活動種別を表します。

項目名	説明
description	項目の型 string 説明活動の説明 (内部参照用)。UI に表示されます。
endpointUrl	項目の型 string 説明活動種別をサードパーティアプリケーションに接続するために使用できるサンプルエンドポイント。UI に表示されます。
isActive	項目の型 boolean 説明この項目により、Account Engagement オートメーションで活動種別のデータを使用できるようになります。オートメーションでの表示ラベルは [有効] です。デフォルト値は、`false` です。UI に表示されます。
isProtected	項目の型 boolean
marketingAppExtension	項目の型 string 説明必須。活動に関連付けられたマーケティングアプリケーション拡張機能。
masterLabel	型 string 説明必須。MarketingAppExtActivity の表示ラベル。UI では、この項目は [活動名] です。

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

この例では、MarketingAppExtension コンポーネントに関連するすべての活動種別を取得します。

1<?xml version="1.0" encoding="UTF-8"?>
2<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>VidLand extension for US region</description>
4    <isActive>true</isActive>
5    <marketingAppExtActivities>
6        <fullName>user_attended</fullName>
7        <description>User attended activity capture for VidLand</description>
8        <isActive>true</isActive>
9        <marketingAppExtension>VidLand_US</marketingAppExtension>
10        <masterLabel>user attended</masterLabel>
11    </marketingAppExtActivities>
12    <marketingAppExtActivities>
13        <fullName>user_registered</fullName>
14        <description>User registered activity capture for VidLand</description>
15        <isActive>true</isActive>
16        <marketingAppExtension>VidLand_US</marketingAppExtension>
17        <masterLabel>user registered</masterLabel>
18    </marketingAppExtActivities>
19    <masterLabel>VidLand_US</masterLabel>
20</MarketingAppExtension>

この例の package.xml は、以前の定義を参照します。

1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3~ Copyright 2021 Salesforce, Inc.
4~ All Rights Reserved
5~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8<types>
9<members>VidLand_US</members>
10<name>MarketingAppExtension</name>
11</types>
12</Package>

この例では、関連する MarketingAppExtension コンポーネントから、特定の活動種別を取得します。

1<?xml version="1.0" encoding="UTF-8"?>
2<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>VidLand extension for US region</description>
4    <isActive>true</isActive>
5    <marketingAppExtActivities>
6        <fullName>user_attended</fullName>
7        <description>User attended activity capture for VidLand</description>
8        <isActive>true</isActive>
9        <marketingAppExtension>VidLand_US</marketingAppExtension>
10        <masterLabel>user attended</masterLabel>
11    </marketingAppExtActivities>
12    <masterLabel>VidLand_US</masterLabel>
13</MarketingAppExtension>

この例の package.xml は、以前の定義を参照します。

1<<?xml version="1.0" encoding="UTF-8"?>
2<!--
3~ Copyright 2021 salesforce.com, inc.
4~ All Rights Reserved
5~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8<types>
9<members>VidLand_US.user_attended</members>
10<name>MarketingAppExtActivity</name>
11</types>
12<types>
13<members>VidLand_US</members>
14<name>MarketingAppExtension</name>
15</types>
16</Package>

MarketingAppExtAction

サードパーティアプリケーションで実行され、Engagement Studio プログラムで使用できるアクションであるアクション種別を表します。

項目名	説明
actionName	項目の型 string 説明内部で使用するアクションの名前。UI に表示されます。
actionParams	項目の型 string 説明呼び出し可能アクションのパラメーター。UI に表示されます。
actionSchema	項目の型 string 説明呼び出し可能アクションの JSON スキーマ。UI に表示されます。
actionSelector	型 string 説明呼び出し可能アクションのセレクター。UI に表示されます。
apiName	項目の型 string 説明この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は自動的に生成されますが、API を使用してレコードを作成する場合は独自の値を指定できます。UI に表示されます。
Description	項目の型 string 説明アクションの説明 (内部参照用)。UI に表示されます。
isActive	項目の型 boolean 説明この項目により、アクション種別のデータが Engagement Studio で使用可能になります。オートメーションでの表示ラベルは [有効] です。デフォルト値は、`false` です。UI に表示されます。
isProtected	項目の型 boolean
marketingAppExtension	項目の型 string 説明必須。アクションに関連付けられたマーケティングアプリケーション拡張機能。

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

この例では、MarketingAppExtension コンポーネントに関連する特定のアクションを取得します。

1<?xml version="1.0" encoding="UTF-8"?>
2<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>VidLand_US</fullName>
4    <description>VidLand extension for US region</description>
5    <isActive>true</isActive>
6    <marketingAppExtActions>
7        <marketingAppExtension>VidLand_US</marketingAppExtension>
8        <apiName>register_user</apiName>
9        <isActive>true</isActive>
10        <description>Register User for VidLand</description>>
11        <actionSelector>VidLand_Register_User</actionSelector>
12        <actionSchema>
13			
14   				{
15	"properties": {
16	  "UserId": {
17		"type": "string",
18		"title": ""
19	  },
20	  "WebinarId": {
21		"type": "string",
22		"value": "webinarIdXYZ"
23	  }
24	},
25	"view": {
26	  "components": [{
27		"definition": "lightning/control",
28		"scope": "#/properties/UserId"
29	  }]
30	},
31	"required": [
32	  "UserId",
33	  "WebinarId",
34	  "From",
35	  "Body"
36	]
37  }
38			
39        </actionSchema>
40        <actionParams>
41        
42   				{
43	"isStandard": false,
44    "type": "apex"
45  }
46			
47        </actionParams>
48        <actionName>Register User</actionName>
49    </marketingAppExtActions>
50    <masterLabel>VidLand US</masterLabel>
51</MarketingAppExtension>

この例の package.xml は、以前の定義を参照します。

1<<?xml version="1.0" encoding="UTF-8"?>
2<!--
3~ Copyright 2021 salesforce.com, inc.
4~ All Rights Reserved
5~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8<types>
9<members>VidLand_US</members>
10<name>MarketingAppExtension</name>
11</types>
12</Package>

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

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