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

親種別

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

重要

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

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

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

バージョン

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

特別なアクセスルール

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

項目

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

MarketingAppExtActivity

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

項目名	説明
description	項目の型 string 説明活動の説明 (内部参照用)。UI に表示されます。
endpointUrl	項目の型 string 説明活動種別をサードパーティアプリケーションに接続するために使用できるサンプルエンドポイント。UI に表示されます。
isActive	項目の型 boolean 説明この項目により、Pardot オートメーションで活動種別のデータを使用できるようになります。オートメーションでの表示ラベルは [有効] です。デフォルト値は、`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>

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

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