メタデータ API 開発者ガイド
jNetwork
コミュニティを表します。コミュニティとは、従業員、顧客、パートナーをつなぐブランド空間です。ビジネスニーズに合わせてコミュニティをカスタマイズしながら作成することができ、その後もコミュニティ間をシームレスに移行できます。SalesforceCommunities には Network コンポーネントを使用します。Chatter アンサーおよび アイデアを含むゾーンを作成する場合は、Community (Zone) コンポーネントを使用します。
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
Network コンポーネントは、対応するパッケージディレクトリの networks ディレクトリに保存されます。ファイル名はコミュニティ名に一致し、拡張子は .network です。
バージョン
このオブジェクトは、API バージョン 28.0 以降で使用できます。
項目
| 項目 | データ型 | 説明 | |
|---|---|---|---|
| allowedExtensions | string | コミュニティで許可されるファイルの種類を指定します。このファイルの種類のホワイトリストにより、コミュニティメンバーがアップロードできるファイルを制御でき、スパム送信者が不適切なファイルでコミュニティを汚染することを防止できます。API バージョン 36.0 以降で使用できます。 | |
| allowInternalUserLogin | boolean | 内部ユーザがコミュニティログインページで内部ログイン情報を使用してログインできるかどうかを決定します。API バージョン 40.0 以降で使用できます。 | |
| allowMembersToFlag | boolean | コミュニティのユーザが投稿またはコメントを不適切としてフラグ付けできるかどうかを決定します。フラグが付けられた項目は、レビューのためにコミュニティモデレータに送信されます。API バージョン 29.0 以降で利用できます。 | |
| branding | Branding | コミュニティで使用する配色、ヘッダー、フッター。API バージョン 41.0 以降では使用できなくなりました。NetworkBranding 型に置き換えられました。 | |
| caseCommentEmailTemplate | string | ケースコメントがケースに追加されたか変更された場合に、コミュニティメンバーに通知するときに使用されるメールテンプレート。 | |
| changePasswordTemplate | string | パスワードがリセットされたことをユーザに通知するときに使用されるメールテンプレート。 | |
| communityRoles | CommunityRoles | コミュニティのカスタマーロール、パートナーロールまたは従業員ロールを識別します。API バージョン 41.0 以降で使用できます。 | |
| description | string | コミュニティの説明。 | |
| disableReputationRecordConversations | boolean | コミュニティで評価レベルが有効になっている場合、評価レベルに対してポイントをカウントするときにレコードへの貢献を除外するかどうかを決定します。API バージョン 41.0 以降で使用できます。 | |
| emailFooterLogo | string | コミュニティメールのフッターに表示されるロゴのドキュメント名。API バージョン 41.0 以降で使用できます。 | |
| emailFooterText | string | コミュニティメールのフッターに表示されるテキスト。API バージョン 41.0 以降で使用できます。 | |
| emailSenderAddress | string | コミュニティメールの送信元となるメールアドレス。 | |
| emailSenderName | string | コミュニティメールの送信元となる名前。 | |
| enableCustomVFErrorPageOverrides | boolean | デフォルト Visualforce エラーページではなく、カスタム Visualforce エラーページを使用するかどうかを決定します。API バージョン 41.0 以降で使用できます。 | |
| enableDirectMessages | boolean | コミュニティユーザがダイレクトメッセージを送信して、1 人以上のメンバーと非公開の会話を開始できるかどうかを決定します。API バージョン 41.0 以降で使用できます。 | |
| enableGuestChatter | boolean | ゲストユーザがログインせずにコミュニティの公開 Chatter グループにアクセスできるかどうかを指定します。 | |
| enableGuestFileAccess | boolean | ゲストユーザが公開ページおよびログインページでコミュニティと共有されているアセットファイルを表示できるかどうかを決定します。コミュニティビルダーのページまたはコミュニティレベルで公開アクセスが有効になっている場合、このプロパティは自動的に有効になります。API バージョン 41.0 以降で使用できます。 | |
| enableInvitation | boolean | ユーザが他のユーザをコミュニティに招待できるかどうかを指定します。 | |
| enableKnowledgeable | boolean | コミュニティメンバーが、トピックに関する知識のあるユーザを表示し、その知識についてユーザを支持できるかどうかを決定します。API バージョン 30.0 以降で使用できます。 | |
| enableNicknameDisplay | boolean | コミュニティのほとんどの場所に、ユーザの氏名ではなくニックネームを表示するかどうかを示します。デフォルトで false に設定されます。API バージョン 32.0 以降で使用できます。 | |
| enablePrivateMessages | boolean | コミュニティメンバーが非公開メッセージを送受信できるかどうかを決定します。API バージョン 30.0 以降で使用できます。 | |
| enableReputation | boolean | コミュニティのメンバーに対する評価が計算および表示されるかどうかを決定します。API バージョン 31.0 以降で使用できます。 有効な場合、reputationLevels と reputationPointsRules が使用されます。データファイルに reputationLevels と reputationPointsRules のどちらも定義されていない場合、デフォルト値が使用されます。 |
|
| enableShowAllNetworkSettings | boolean | コミュニティの設定方法に基づいてデフォルトで非表示になっている設定を表示します。API バージョン 41.0 以降で使用できます。 | |
| enableSiteAsContainer | boolean | コミュニティで Visualforce タブの代わりに Site.com ページを使用するかどうかを決定します。 | |
| enableTalkingAboutStats | boolean | コミュニティユーザに、トピックについてディスカッションしているユーザの数が表示されるかどうかを決定します。ユーザがトピックの入力を開始すると、トピックについてディスカッションしているユーザの数が表示され、システムからはトピックの提案が表示されます。API バージョン 41.0 以降で使用できます。 | |
| enableTopicAssignmentRules | boolean | これにより、組織はルールを使用してトピックをコミュニティ内の記事に割り当てることができます。これを有効にした後、システム管理者はコミュニティでルールを設定し、トピックを Salesforce ナレッジデータカテゴリに対応付けます。この項目は、API バージョン 40.0 以降で使用できます。 | |
| enableTopicSuggestions | boolean | ユーザが投稿を記述するときのトピックの提案を有効にします。 API バージョン 41.0 以降で使用できます。 | |
| enableUpDownVote | boolean | 質問と回答の「いいね!」をプラス投票とマイナス投票のオプションで置き換えます。API バージョン 41.0 以降で使用できます。 | |
| forgotPasswordTemplate | string | ユーザがパスワードを忘れたときに使用されるメールテンプレート。 | |
| gatherCustomerSentimentData | boolean | 顧客がコミュニティの記事とケースを確認するとき、Community 360 機能で使用するためのデータを収集します。この項目は、API バージョン 40.0 以降で使用できます。 | |
| lockoutTemplate | string | ログインに失敗した回数が多すぎてユーザが組織からロックアウトされた場合、それらのユーザと通信するために使用するメールテンプレート。API バージョン 43.0 以降で使用できます。 | |
| maxFileSizeKb | int | コミュニティでメンバーがアップロードできるファイルの最大サイズ (KB) を指定します。API バージョン 36.0 以降で使用できます。3,072 KB から組織の最大ファイルサイズまでの数値を入力します。デフォルトの制限である 2 GB を使用するには、この項目を空にしておきます。 | |
| navigationLinkSet | NavigationLinkSet | この項目は、API バージョン 37.0 以降で使用できます。 | |
| networkMemberGroups | NetworkMemberGroups | コミュニティへのアクセス権を持つプロファイルおよび権限セット。これらのプロファイルまたは権限セットを持つユーザは、コミュニティのメンバーです。 | |
| networkPageOverrides | NetworkPageOverride | [パスワードの変更]、[パスワードを忘れた場合]、[ホーム]、[ログイン] のそれぞれがどのページ種別を参照するかを制御する、[管理] 領域 ([コミュニティ管理] または [コミュニティワークスペース] 内) の設定。API バージョン 40.0 以降で使用できます。 | |
| newSenderAddress | string | EmailSenderAddressの新しい値として入力され、まだ未確認のメールアドレス。ユーザが送信元メールアドレスの変更を要求し、確認メールに正常に応答すると、NewSenderAddress の値で EmailSenderAddress の値が上書きされます。これが、コミュニティメールの送信元メールアドレスになります。 | |
| picassoSite | string | コミュニティにリンクしている Site.com サイトの名前。 | |
| recommendationAudience | RecommendationAudience | 新しいコミュニティメンバーによる利用者を作成します。または、カスタマイズした利用者メンバーのリストを管理しておすすめを整理または対象にするために使用できます。API バージョン 41.0 以降で使用できます。 | |
| recommendationDefinition | RecommendationDefinition | コミュニティのエンゲージメントを促進するカスタムおすすめを表します。特定の利用者を対象にしたり、チャネルを使用しておすすめの場所を指定したりします。API バージョン 41.0 以降で使用できます。 | |
| reputationLevels | ReputationLevelDefinitions | メンバーが特定のアクションを実行してポイントを獲得したときに、メンバーに割り当てられる評価レベル。 | |
| reputationPointsRules | ReputationPointsRules | メンバーが特定の定義済みアクションを実行したときに獲得するポイント。 | |
| selfRegProfile | string | セルフ登録するユーザに割り当てられるプロファイル。この値は、コミュニティで selfRegistration が有効になっている場合にのみ使用されます。API バージョン 29.0 以降で利用できます。 | |
| selfRegistration | boolean | コミュニティでセルフ登録が可能かどうかを指定します。 | |
| sendWelcomeEmail | boolean | 新しいユーザがコミュニティに追加されたときに、お知らせメールを送信するかどうかを指定します。 | |
| site | string | コミュニティに関連付けられている CustomSite。 | |
| status | NetworkStatus[] | コミュニティの状況。選択可能な値は次のとおりです。
|
|
| tabs | NetworkTabSet | コミュニティで使用できるタブ。これらのタブは、コミュニティを作成したユーザが選択したものです。 | |
| urlPathPrefix | string | サイトを他のサイトと区別する、サイトの URL 上のパスの最初の部分。たとえば、サイト URL が mycompany.force.com/partners である場合、partners は urlPathPrefix になります。 | |
| welcomeTemplate | string | 新しいコミュニティメンバーにお知らせメールを送信するときに使用されるメールテンプレート。 |
Branding
コミュニティに適用されるブランド設定と配色を表します。API バージョン 40.0 以前で使用できます。API バージョン 41.0 以降では NetworkBranding に置き換わります。
CommunityRoles
コミュニティのカスタマーロール、パートナーロールまたは従業員ロールを識別するために使用される表示ラベル。API バージョン 41.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| customerUserRole | string | コミュニティのカスタマーユーザロールの表示ラベル。 |
| employeeUserRole | string | コミュニティの従業員ユーザロールの表示ラベル。 |
| partnerUserRole | string | コミュニティのパートナーユーザロールの表示ラベル。 |
NetworkMemberGroup
コミュニティに割り当てられたプロファイルおよび権限セットを表します。いずれかのプロファイルまたは権限セットを持つユーザは、(顧客グループの) Chatter 顧客でない限り、コミュニティのメンバーです。
| 項目 | データ型 | 説明 |
|---|---|---|
| permissionSet | string | コミュニティに割り当てられた権限セット。 |
| profile | string | コミュニティの一部であるプロファイル。 |
NetworkPageOverride
[パスワードの変更]、[パスワードを忘れた場合]、[ホーム]、[ログイン] の各ページがどのページ種別を参照するかを制御する、[管理] 領域 ([コミュニティ管理] または [コミュニティワークスペース] 内) の設定を表します。
RecommendationAudience
新しいコミュニティメンバーによる利用者を作成します。または、カスタマイズした利用者メンバーのリストを管理しておすすめを整理または対象にするために使用できます。API バージョン 41.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| recommendationAudienceDetails | RecommendationAudienceDetail | おすすめの利用者の詳細。 |
RecommendationAudienceDetail
おすすめの利用者の詳細。API バージョン 41.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| audienceCriteriaType | AudienceCriteriaType (string 型の列挙) | おすすめ利用者種別の条件。値は次のとおりです。
|
| audienceCriteriaValue | string | 新規メンバー条件では、ユーザがコミュニティメンバーになった時点からの最大日数。カスタムリスト条件では Null です。 |
| setupName | string | おすすめ利用者の名前。 |
RecommendationDefinition
コミュニティのエンゲージメントを促進するカスタムおすすめのリストを表します。API バージョン 41.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| recommendationDefinitionDetails | RecommendationDefinitionDetail[] | カスタムおすすめとその詳細のリスト。 |
RecommendationDefinitionDetail
カスタムおすすめの詳細。API バージョン 41.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| actionUrl | string | ユーザがおすすめに対してアクションを実行できるようにするボタンの URL。 |
| description | string | ユーザが実行できるアクションを提案するおすすめの説明。 |
| linkText | string | ボタンのテキスト表示ラベル。 |
| scheduledRecommendations | ScheduledRecommendation | スケジュール済みおすすめのリスト。 |
| setupName | string | [設定] に表示されるおすすめの名前。 |
| title | string | おすすめのタイトル。 |
ReputationLevelDefinitions
コミュニティ内で特定の定義されたアクションを実行することでメンバーが達成できる評価レベルを表します。
| 項目 | データ型 | 説明 |
|---|---|---|
| level | ReputationLevel[] | 評価レベルを表します。 |
ReputationLevel
評価レベルの名前と下限値を表します。上限値はアプリケーションによって計算されます。
| 項目 | データ型 | 説明 |
|---|---|---|
| branding | ReputationBranding[] | 評価レベルに関連付けられたブランド設定を表します。具体的には、評価レベルのカスタム画像です。 この項目は省略可能です。指定されていない場合は、デフォルトの評価レベル画像が使用されます。API バージョン 32.0 以降で使用できます。 |
| label | string | 評価レベルの名前。 この項目は省略可能です。指定されていない場合、10 個のデフォルトのいずれかが使用されます。
|
| lowerThreshold | double | 必須。この評価レベルの範囲の下限値。たとえば、この評価レベルがポイント 1 ～ 50 の場合、1 が lowerThreshold です。 |
ReputationPointsRules
コミュニティのポイントシステムのポイントルールを表します。
| 項目 | データ型 | 説明 |
|---|---|---|
| pointsRule | ReputationPointsRule[] | 行動とそれに関連付けられたポイントを表します。 |
ReputationPointsRule
ポイントルールの行動と関連付けられたポイント値を表します。アクションを実行したユーザは、関連付けられたポイントを獲得します。
| 項目 | データ型 | 説明 |
|---|---|---|
| eventType | string | 必須。ポイントを獲得するためにメンバーが実行する必要がある行動の種別。次の値を使用できます。
|
| points | int | 必須。行動を実行してメンバーが取得するポイント数。行動ごとのデフォルトのポイント数は次のとおりです。
|
ScheduledRecommendation
スケジュール済みおすすめのリストを表します。API バージョン 41.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| scheduledRecommendationDetails | ScheduledRecommendationDetail[] | スケジュール済みおすすめのリスト。 |
ScheduledRecommendationDetail
スケジュール済みおすすめの詳細。API バージョン 41.0 以降で使用できます。
| 項目 | データ型 | 説明 |
|---|---|---|
| channel | RecommendationChannel (string 型の列挙) | おすすめをグループ化して、おすすめをコミュニティのどこに表示するのかを決定する手段。有効な値は、次のとおりです。
|
| enabled | boolean | スケジュールが有効になっているかどうかを示します。true の場合、おすすめが有効になり、コミュニティに表示されます。 false の場合、Salesforce モバイル Web でのフィードのおすすめは削除されませんが、新しいおすすめは表示されなくなります。コミュニティでは、無効にしたおすすめは表示されません。 |
| rank | int | 表示順序を決定するチャネル内のおすすめのランク。 スケジュール済みおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みおすすめの rank が 1 つずつ下がります。指定された rank がリストのサイズよりも大きい場合は、スケジュール済みおすすめがリストの末尾に配置されます。 rank が指定されていない場合は、スケジュール済みおすすめがリストの末尾に配置されます。 |
| recommendationAudience | string | このスケジュール済みおすすめの利用者の名前。 |
NetworkTabSet
| 項目 | データ型 | 説明 |
|---|---|---|
| customTab | string | コミュニティの一部であるカスタムタブ。 |
| defaultTab | string | コミュニティの [ホーム] タブ。メンバーがログインすると、このタブが最初のページとして表示されます。 |
| standardTab | string | コミュニティの一部である標準タブ。 |
宣言的なメタデータの定義のサンプル
次に、ネットワークの XML 定義のサンプルを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Network xmlns="http://soap.sforce.com/2006/04/metadata">
3 <allowMembersToFlag>true</allowMembersToFlag>
4 <changePasswordTemplate>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate>
5 <description>Metadata Community</description>
6 <emailSenderAddress>admin@networkMetadata.com</emailSenderAddress>
7 <emailSenderName>Admin User</emailSenderName>
8 <enableInvitation>false</enableInvitation>
9 <enableKnowledgeable>true</enableKnowledgeable>
10 <enableNicknameDisplay>false</enableNicknameDisplay>
11 <enablePrivateMessages>true</enablePrivateMessages>
12 <enableReputation>true</enableReputation>
13 <enableUpDownVote>true</enableUpDownVote>
14 <forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>
15 <networkMemberGroups>
16 <permissionSet>Admin</permissionSet>
17 <permissionSet>Standard</permissionSet>
18 <permissionSet>ReadOnly</permissionSet>
19 <profile>Admin</profile>
20 <profile>Standard</profile>
21 <profile>ReadOnly</profile>
22 </networkMemberGroups>
23 <recommendationDefinition>
24 <recommendationDefinitionDetails>
25 <actionUrl>https://www.apple.com/iphone</actionUrl>
26 <description>New iPhone 7 with Better specs and high performance</description>
27 <linkText>iPhone 7</linkText>
28 <scheduledRecommendations>
29 <scheduledRecommendationDetails>
30 <channel>DefaultChannel</channel>
31 <enabled>false</enabled>
32 <rank>1</rank>
33 <recommendationAudience>New Member Audience</recommendationAudience>
34 </scheduledRecommendationDetails>
35 </scheduledRecommendations>
36 <setupName>Apple iPhone</setupName>
37 <title>iPhone7</title>
38 </recommendationDefinitionDetails>
39 <recommendationDefinitionDetails>
40 <actionUrl>https://www.bose.com/qc35</actionUrl>
41 <description>New Amazing Noise cancellation Headphones</description>
42 <linkText>Bose QC35</linkText>
43 <scheduledRecommendations>
44 <scheduledRecommendationDetails>
45 <channel>DefaultChannel</channel>
46 <enabled>true</enabled>
47 <rank>2</rank>
48 <recommendationAudience>Custom Audience</recommendationAudience>
49 </scheduledRecommendationDetails>
50 </scheduledRecommendations>
51 <setupName>Bose Headphones</setupName>
52 <title>Bose QC35</title>
53 </recommendationDefinitionDetails>
54 </recommendationDefinition>
55 <reputationLevels>
56 <level>
57 <branding>
58 <smallImage>communities_shared _document_folder/replevel_beginner.png</smallImage>
59 </branding>
60 <label>Beginner</label>
61 <lowerThreshold>0</lowerThreshold>
62 </level>
63 <level>
64 <branding>
65 <smallImage>communities_shared _document_folder/replevel_apprentice.png</smallImage>
66 </branding>
67 <label>Apprentice</label>
68 <lowerThreshold>51</lowerThreshold>
69 </level>
70 <level>
71 <branding>
72 <smallImage>communities_shared _document_folder/replevel_gettingthere.png</smallImage>
73 </branding>
74 <label>Getting There</label>
75 <lowerThreshold>101</lowerThreshold>
76 </level>
77 <level>
78 <branding>
79 <smallImage>communities_shared _document_folder/replevel_skilled.png</smallImage>
80 </branding>
81 <label>Skilled</label>
82 <lowerThreshold>151</lowerThreshold>
83 </level>
84 <level>
85 <branding>
86 <smallImage>communities_shared _document_folder/replevel_expert.png</smallImage>
87 </branding>
88 <label>Expert</label>
89 <lowerThreshold>201</lowerThreshold>
90 </level>
91 <level>
92 <branding>
93 <smallImage>communities_shared _document_folder/replevel_mentor.png</smallImage>
94 </branding>
95 <label>Mentor</label>
96 <lowerThreshold>251</lowerThreshold>
97 </level>
98 <level>
99 <branding>
100 <smallImage>communities_shared _document_folder/replevel_guru.png</smallImage>
101 </branding>
102 <label>Guru</label>
103 <lowerThreshold>301</lowerThreshold>
104 </level>
105 </reputationLevels>
106 <reputationPointsRules>
107 <pointsRule>
108 <eventType>FeedItemWriteAPost</eventType>
109 <points>5</points>
110 </pointsRule>
111 <pointsRule>
112 <eventType>FeedItemWriteAComment</eventType>
113 <points>3</points>
114 </pointsRule>
115 <pointsRule>
116 <eventType>FeedItemReceiveAComment</eventType>
117 <points>10</points>
118 </pointsRule>
119 <pointsRule>
120 <eventType>FeedItemLikeSomething</eventType>
121 <points>3</points>
122 </pointsRule>
123 <pointsRule>
124 <eventType>FeedItemReceiveALike</eventType>
125 <points>5</points>
126 </pointsRule>
127 <pointsRule>
128 <eventType>FeedItemMentionSomeone</eventType>
129 <points>5</points>
130 </pointsRule>
131 <pointsRule>
132 <eventType>FeedItemSomeoneMentionsYou</eventType>
133 <points>10</points>
134 </pointsRule>
135 <pointsRule>
136 <eventType>FeedItemShareAPost</eventType>
137 <points>5</points>
138 </pointsRule>
139 <pointsRule>
140 <eventType>FeedItemSomeoneSharesYourPost</eventType>
141 <points>10</points>
142 </pointsRule>
143 </reputationPointsRules>
144 <selfRegistration>false</selfRegistration>
145 <sendWelcomeEmail>true</sendWelcomeEmail>
146 <site>Network_11</site>
147 <status>UnderConstruction</status>
148 <tabs>
149 <defaultTab>Chatter</defaultTab>
150 <standardTab>Chatter</standardTab>
151 <standardTab>Account</standardTab>
152 <standardTab>Campaign</standardTab>
153 <standardTab>Case</standardTab>
154 <standardTab>Console</standardTab>
155 <standardTab>Contact</standardTab>
156 <standardTab>Contract</standardTab>
157 <standardTab>Dashboard</standardTab>
158 <standardTab>JigsawSearch</standardTab>
159 <standardTab>File</standardTab>
160 <standardTab>CollaborationGroup</standardTab>
161 <standardTab>home</standardTab>
162 <standardTab>Idea</standardTab>
163 <standardTab>Lead</standardTab>
164 <standardTab>Opportunity</standardTab>
165 <standardTab>Product2</standardTab>
166 <standardTab>UserProfile</standardTab>
167 <standardTab>report</standardTab>
168 <standardTab>Solution</standardTab>
169 </tabs>
170 <urlPathPrefix>network1</urlPathPrefix>
171 <welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>
172</Network>