メタデータ API 開発者ガイド
jCampaignInfluenceModel
カスタマイズ可能なキャンペーンインフルエンスで使用するキャンペーンインフルエンスモデルを表します。
メタデータ API でカスタマイズ可能なキャンペーンインフルエンスは設定できませんが、キャンペーンインフルエンスモデルの追加はできます。
ファイルのサフィックスおよびディレクトリの場所
CampaignInfluenceModel の値は、対応するパッケージディレクトリの campaignInfluenceModels ディレクトリに保存されます。ファイル名はモデル名に一致し、拡張子は .campaignInfluenceModel です。
バージョン
CampaignInfluenceModel コンポーネントは、API バージョン 38.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | モデルが有効かどうかを示します。有効なモデルは、キャンペーンインフルエンスレコードを生成できます。モデルを無効にすると、そのキャンペーンインフルエンスレコードが削除されます。カスタムモデルは常に有効になり、この項目は無視されます。この項目は API バージョン 40.0 以降で使用できます。 |
| isDefaultModel | boolean | モデルがデフォルトモデルかどうかを示します。デフォルトモデルに関連付けられたキャンペーンインフルエンスレコードのみがキャンペーンおよび商談に表示されます。一度にデフォルトモデルにできるのは 1 つだけです。モデルをデフォルトモデルにするには有効である必要があります。 カスタムモデルを有効化または無効化しても、キャンペーンインフルエンスレコードは自動的に生成または削除されません。 |
| isModelLocked | boolean | モデルがロックされているかどうかを示します。ロックされたモデルのキャンペーンインフルエンスレコードは、API でのみ操作できます。 |
| modelDescription | string | インフルエンスモデルの説明。 |
| name | string | モデルの一意の名前。 |
| recordPreference | picklist | この項目の値は、キャンペーンインフルエンスレコードをいつ作成するかを決定します。
この項目は API バージョン 41.0 以降で使用できます。 |
宣言的なメタデータの定義のサンプル
デフォルトの Salesforce キャンペーンインフルエンス属性モデルを表す CampaignInfluenceModel コンポーネントの例を次に示します。別のモデルを作成してデフォルトモデルとして設定する場合、isDefaultModel のデフォルト値の true を変更することができます。isModelLocked 値が true の場合、このモデルのキャンペーンインフルエンスレコードを UI に表示できますが、そのレコードを作成、更新、または削除できません。
1<?xml version="1.0" encoding="UTF-8"?>
2<CampaignInfluenceModel xmlns="http://soap.sforce.com/2006/04/metadata">
3 <isDefaultModel>true</isDefaultModel>
4 <isModelLocked>true</isModelLocked>
5 <active>true</active>
6 <recordPreference>AllRecords</recordPreference>
7 <modelDescription>Primary Campaign gets 100% of the revenue share</modelDescription>
8 <name>Salesforce Model</name>
9</CampaignInfluenceModel>「Last Touch」というインフルエンスモデル (デフォルトモデルにはならない) を作成する CampaignInfluenceModel コンポーネントの例��次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CampaignInfluenceModel xmlns="http://soap.sforce.com/2006/04/metadata">
3 <isDefaultModel>false</isDefaultModel>
4 <isModelLocked>true</isModelLocked>
5 <active>true</active>
6 <recordPreference>RecordsWithAttribution</recordPreference>
7 <modelDescription>This model gives 100% influence attribution to the last campaign that touched the contact.</modelDescription>
8 <name>Last Touch</name>
9</CampaignInfluenceModel>