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

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	ケースコメントがケースに追加されたか変更された場合に、メンバーに通知するときに使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
changePasswordTemplate	string	パスワードがリセットされたことをユーザーに通知するときに使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
chgEmailVerNewTemplate	string	ユーザーのメールアドレスの変更を検証するために使用されるメールテンプレート。このメールは新しいメールアドレスに送信されます。メタデータ API を使用して、このテンプレートを更新することはできません。メモ
chgEmailVerOldTemplate	string	ユーザーのメールアドレスの変更を検証するために使用されるメールテンプレート。このメールは古いメールアドレスに送信されます。メタデータ API を使用して、このテンプレートを更新することはできません。メモ
communityRoles	CommunityRoles	サイトのカスタマーロール、パートナーロールまたは従業員ロールを識別します。API バージョン 41.0 以降で利用できます。
description	string	サイトの説明。
deviceActEmailTemplate	string	デバイスの有効化メールテンプレートの ID。このテンプレートを使用して、コミュニティユーザーのデバイスの有効化メールをカスタマイズします。API バージョン 53.0 以降で利用できます。
disableReputationRecordConversations	boolean	サイトの評価レベルが有効になっている場合、評価レベルにポイントを反映させるときにレコードへの貢献を除外するかどうかを決定します。API バージョン 41.0 以降で利用できます。
emailFooterLogo	string	メールのフッターに表示されるロゴのドキュメント名。API バージョン 41.0 以降で利用できます。
emailFooterText	string	メールのフッターに表示されるテキスト。API バージョン 41.0 以降で利用できます。
emailSenderAddress	string	必須。メールの送信元となるメールアドレス。
emailSenderName	string	必須。メールの送信元となる名前。
enableApexCDNCaching	boolean	@wire コールから Apex メソッドへの公開データをゲストユーザーにキャッシュするかどうかを決定します。この設定は、Salesforce のデジタルエクスペリエンスの CDN を使用しているサイトのみに適用されます。
enableCustomVFErrorPageOverrides	boolean	デフォルト Visualforce エラーページではなく、カスタム Visualforce エラーページを使用するかどうかを決定します。API バージョン 41.0 以降で利用できます。
enableDirectMessages	boolean	サイトユーザーがダイレクトメッセージを送信して、1 人以上のメンバーと非公開の会話を開始できるかどうかを決定します。API バージョン 41.0 以降で利用できます。
enableExperienceBundleBasedSnaOverrideEnabled	boolean	エクスペリエンスの公開時にビルダーベースの SNA ページを使用して既存の SNA ページを上書するか (`true`)、否か (`false`) を決定します。API バージョン 52.0 以降で利用できます。
expFriendlyUrlsAsDefault	boolean	LWR Commerce ストアの商品ページとカテゴリページで URL スラッグをデフォルトで有効にするかどうかを決定します。API バージョン 59.0 以降で利用できます。
enableGuestChatter	boolean	ゲストユーザーがログインせずにサイトの公開 Chatter グループにアクセスできるかどうかを指定します。
enableGuestFileAccess	boolean	ゲストユーザーが公開ページおよびログインページでサイトと共有されているアセットファイルを表示できるかどうかを決定します。エクスペリエンスビルダーのページまたはサイトレベルで公開アクセスが有効になっている場合、このプロパティは自動的に有効になります。API バージョン 41.0 以降で利用できます。
enableGuestMemberVisibility	boolean	認証されていないゲストユーザーが認証済みメンバーを表示できるか (`true`)、否か (`false`) を決定します。API バージョン 47.0 以降で利用できます。
enableImageOptimizationCDN	boolean	Salesforce のデ��タルエクスペリエンスの CDN がサイトで使用されているときに、すべてのデバイスのゲストユーザー向けにキャッシュされた画像を最適化するかどうかを決定します。API バージョン 56.0 以降で利用できます。
enableInvitation	boolean	ユーザーが他のユーザーをサイトに招待できるかどうかを指定します。
enableKnowledgeable	boolean	メンバーが、トピックに関する知識のあるユーザーを表示し、その知識についてユーザーを支持できるかどうかを決定します。API バージョン 30.0 以降で利用できます。
enableMemberVisibility	boolean	サイト単位でユーザー表示を制御します。`true` の場合、選択したサイトで [このサイトの他のメンバーを表示] 設定が有効になります。API バージョン 45.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	サイトがエクスペリエンスビルダーサイトであるか (`true`)、または Salesforce タブと Visualforce サイトであるか (`false`) を指定します。
enableTalkingAboutStats	boolean	ユーザーに、トピックについてディスカッションしているユーザーの数が表示されるかどうかを決定します。ユーザーがトピックの入力を開始すると、トピックについてディスカッションしているユーザーの数が表示され、システムからはトピックの提案が表示されます。API バージョン 41.0 以降で利用できます。
enableTopicAssignmentRules	boolean	これにより、組織はルールを使用してトピックをサイト内の記事に割り当てることができます。これを有効にした後、システム管理者はルールを設定し、トピックを Salesforce ナレッジデータカテゴリに対応付けます。この項目は、API バージョン 40.0 以降で使用できます。
enableTopicSuggestions	boolean	ユーザーが投稿を記述するときのトピックの提案を有効にします。API バージョン 41.0 以降で利用できます。
enableUpDownVote	boolean	質問と回答の「いいね!」をプラス投票とマイナス投票のオプションで置き換えます。API バージョン 41.0 以降で利用できます。
feedChannel	string	すべてのチャネルプログラムレコードまたはグループのやりとりのフィード (投稿、質問、添付ファイルを含む) を表示します。この項目は、API バージョン 28.0 以降で使用できます。
forgotPasswordTemplate	string	必須。ユーザーがパスワードを忘れたときに使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
gatherCustomerSentimentData	boolean	顧客がサイトの記事とケースを確認するとき、Community 360 機能で使用するためのデータを収集します。この項目は、API バージョン 40.0 以降で使用できます。
lockoutTemplate	string	ログインに失敗した回数が多すぎてユーザーが組織からロックアウトされた場合、それらのユーザーと通信するために使用するメールテンプレート。API バージョン 43.0 以降で利用できます。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
logoutUrl	string	メンバーがサイトからログアウトするときのリダイレクト先となる URL を指定します。この項目は、API バージョン 28.0 以降で使用できます。
maxFileSizeKb	int	サイトでメンバーがアップロードできるファイルの最大サイズ (KB) を指定します。API バージョン 36.0 以降で利用できます。3,072 KB から組織の最大ファイルサイズまでの数値を入力します。デフォルトの制限である 2 GB を使用するには、この項目を空にしておきます。
navigationLinkSet	NavigationLinkSet	サイトのナビゲーションメニューを表します。ナビゲーションメニューは、ユーザーがクリックするとサイトの他の部分に移動できる項目で構成されます。この項目は、API バージョン 37.0 から 46.0 で使用できます。API バージョン 47.0 以降では、NavigationMenu を使用してください。
networkAuthApiSettings	NetworkAuthApiSettings	ヘッドレス登録フロー、ヘッドレスのパスワードを忘れた場合のフロー、ヘッドレスパスワードレスログインフロー、およびそれらに関連する API の有効化、アクセス、およびセキュリティを制御する設定。API バージョン 60.0 以降で利用できます。
networkMemberGroups	NetworkMemberGroups	サイトへのアクセス権を持つプロファイルおよび権限セット。これらのプロファイルまたは権限セットを持つユーザーは、サイトのメンバーです。サイトにも関連付けられている権限セットが (顧客グループの) Chatter 顧客に割り当てられている場合、その Chatter 顧客はサイトに追加されません。メモ
networkPageOverrides	NetworkPageOverride	[パスワードの変更]、[パスワードを忘れた場合]、[ホーム]、[ログイン] のそれぞれがどのページ種別を参照するかを制御する、[管理] 領域 ([エクスペリエンス管理] またはエクスペリエンスワークスペース内) の設定。API バージョン 40.0 以降で利用できます。
newSenderAddress	string	EmailSenderAddress の新しい値として入力され、まだ未確認のメールアドレス。ユーザーが送信者メールアドレスの変更を要求し、確認メールに正常に応答すると、NewSenderAddress の値が EmailSenderAddress の値に上書きされます。この値は、メールの送信元メールアドレスになります。
picassoSite	string	Experience Cloud サイトにリンクされている ChatterNetworkPicasso 種別のサイトの名前。
recommendationAudience	RecommendationAudience	新しいメンバーによる利用者を作成します。または、カスタマイズした利用者メンバーのリストを管理しておすすめを整理または対象にするために使用できます。API バージョン 41.0 以降で利用できます。
recommendationDefinition	RecommendationDefinition	エンゲージメントを促進するカスタムおすすめを表します。特定の利用者を対象にしたり、チャネルを使用しておすすめの場所を指定したりします。API バージョン 41.0 以降で利用できます。
reputationLevels	ReputationLevelDefinitions	メンバーが特定のアクションを実行してポイントを獲得したときに、メンバーに割り当てられる評価レベル。
reputationPointsRules	ReputationPointsRules	メンバーが特定の定義済みアクションを実行したときに獲得するポイント。
selfRegMicroBatchSubErrorEmailTemplate	reference	マイクロバッチを使用するセルフ登録要求が失敗した場合にユーザーと通信するために使用するメールテンプレート。API バージョン 54.0 以降で利用できます。
selfRegProfile	string	セルフ登録するユーザーに割り当てられるプロファイル。この値は、サイトで selfRegistration が有効になっている場合にのみ使用されます。API バージョン 29.0 以降で利用できます。
selfRegistration	boolean	サイトでセルフ登録が可能かどうかを指定します。
sendWelcomeEmail	boolean	新しいユーザーがサイトに追加されたときに、お知らせメールを送信するかどうかを指定します。
site	string	必須。Experience Cloud サイトと関連付けられている CustomSite。
SitesArchiveStatus	string	サイトがアーカイブされたかどうかを指定します。選択可能な値は次のとおりです。 NotArchived — サイトはアーカイブされていません。 TemporarilyArchived — サイトはアーカイブされていますが、今後アーカイブ解除される可能性があります。
status	NetworkStatus[]	必須。サイトの状況。選択可能な値は次のとおりです。 `Live` — サイトがオンラインで、メンバーはアクセスできます。 `DownForMaintenance` — サイトは以前に公開されていましたが、オフラインになっています。「エクスペリエンスの作成および設定」権限を持つメンバーは、プロファイルまたはメンバー種別に関係なくオフラインのサイトの設定に引き続きアクセスできます。メンバーはオフラインのサイトにはアクセスできませんが、ユーザーインターフェースのドロップダウンには引き続き [SiteName (Offline) (SiteName (オフライン))] と表示されます。 `UnderConstruction` — サイトはまだ公開されていません。「エクスペリエンスの作成および設定」権限を持つユーザーは、プロファイルがサイトに関連付けられていれば、この状況のサイトにアクセスできます。サイトの公開後は、再びこの状況になることはありません。
tabs	NetworkTabSet	必須。サイトで使用できるタブ。これらのタブは、サイトを作成したユーザーが選択したものです。
urlPathPrefix	string	サイトを他のサイトと区別する、サイトの URL 上のパスの最初の部分。たとえば、サイト URL が `MyDomainName`.my.site.com/partners である場合、partners は urlPathPrefix になります。
verificationTemplate	string	ユーザーが ID を検証する必要がある場合 (パスワードなしでログインしたり新規デバイスからログインしたりする場合など)、ユーザーとのコミュニケーションに使用するメールテンプレート。API バージョン 44.0 以降で利用できます。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。
welcomeTemplate	string	新しいメンバーにお知らせメールを送信するときに使用されるメールテンプレート。 Lightning メールテンプレートは、パッケージ化できません。Classic メールテンプレートを使用することをお勧めします。

Branding

Experience Cloud サイトに適用されるブランド設定と配色を表します。API バージョン 40.0 以前で使用できます。API バージョン 41.0 以降では NetworkBranding に置き換わります。

項目	項目の型	説明
loginFooterText	string	ログインページのフッターに表示されるテキスト。
loginLogo	string	外部ユーザーに対してログインページに表示されるロゴ。
pageFooter	string	ページのフッターに表示される画像。.html ファイルである必要があります。
pageHeader	string	ページのヘッダーに表示される画像。.html、.gif、.jpg、.png ファイルを使用できます。
primaryColor	string	有効なタブに使用される色。
primaryComplementColor	string	primaryColor で使用されるフォントの色。
quaternaryColor	string	ページの背景色。
quaternaryComplementColor	string	quaternaryColor で使用されるフォントの色。
secondaryColor	string	リストとテーブルの上境界線に使用される色。
tertiaryColor	string	編集ページと詳細ページのセクションヘッダーの背景色。
tertiaryComplementColor	string	tertiaryColor で使用されるフォントの色。
zeronaryColor	string	ヘッダーの背景色。
zeronaryComplementColor	string	zeronaryColor で使用されるフォントの色。

CommunityRoles

Experience Cloud サイトのカスタマーロール、パートナーロールまたは従業員ロールを識別するために使用される表示ラベル。API バージョン 41.0 以降で利用できます。

項目	項目の型	説明
customerUserRole	string	カスタマーユーザーロールの表示ラベル。
employeeUserRole	string	従業員ユーザーロールの表示ラベル。
partnerUserRole	string	パートナーユーザーロールの表示ラベル。

NavigationLinkSet

Experience Cloud サイトのナビゲーションメニューを表します。ナビゲーションメニューは、ユーザーがクリックするとサイトの他の部分に移動できる項目で構成されます。API バージョン 37.0 ～ 46.0 で使用可能です。API バージョン 47.0 では、代わりに NavigationMenu を使用します。

項目	項目の型	説明
navigationMenuItem	NavigationMenuItem[]	NavigationLinkSet のメニュー項目のリスト。このオブジェクトを使用して、サイトのナビゲーションメニューのメニュー項目を作成、削除、または更新します。

NavigationMenuItem

NavigationLinkSet サブタイプ (API バージョン 37.0 ～ 46.0)、または NavigationMenu 型 (API バージョン 47.0 以降) での単一のメニュー項目を表します。このサブタイプを使用して、サイトのナビゲーションメニューのメニュー項目を作成、削除、または更新します。

項目	項目の型	説明
defaultListViewId	string	type 項目の値が `SalesforceObject` の場合、値はオブジェクトのデフォルトのリストビューの ID です。
label	string	必須。ナビゲーションメニューのこの項目に表示されるテキスト。
menuItemBranding	NavigationMenuItemBranding	ナビゲーションメニュー項目のブランド。API バージョン 47.0 以降で利用できます。
position	int	必須。ナビゲーションメニュー内のメニュー項目の位置。
publiclyAvailable	boolean	`true` に設定すると、ゲストユーザーにアクセス権が付与されます。
subMenu	NavigationSubMenu	子メニュー項目のリスト。この項目は API 39.0 以降で使用できます。
target	string	type が `ExternalLink`、`InternalLink`、`SalesforceObject` のいずれかである場合は必須です。type が `ExternalLink` または `InternalLink` の場合、提供先はリンクが参照する URL です。`ExternalLink` の場合、エントリは `https://salesforce.com` のようになります。`InternalLink` の場合、`/contactsupport` のような相対 URL を使用します。type が `MenuLabel` または `NavigationalTopic` の場合、target は使用されません。
targetPreference	string	対象項目の設定を含む選択リストが基盤となります。有効な値は、次のとおりです。 `None` `OpenInExternalTab` — Used for external links to determine whether to open in an external tab.
type	string	必須。ナビゲーションメニュー項目の種別。有効な値は、次のとおりです。 `SalesforceObject` — 使用可能なオブジェクトは、取引先、ケース、取引先責任者、カスタムオブジェクト。 `ExternalLink` — サイト外の URL へのリンク。(例: `https://salesforce.com`)。 `InternalLink` — サイト内の相対 URL へのリンク。(例: `/contactsupport`)。 `MenuLabel` — ナビゲーションメニューの親ヘッダー。メニューの表示ラベルの下に項目をネストする方法については、「NavigationSubMenu」を参照してください。この値は API 39.0 以降で使用できます。 `NavigationalTopic` — サイトのナビゲーショントピックへのリンクを示すドロップダウンリスト。 `MenuLabel` の下の種別が `MenuLabel` または `NavigationalTopic` のその他の項目はネストできません。

NavigationSubMenu

子メニュー項目のリスト。NavigationSubMenu に項目を設定できるのは、MenuLabel 種別の NavigationMenuItem 項目のみです。API 39.0 以降で使用できます。

項目	項目の型	説明
navigationMenuItem	NavigationMenuItem[]	NavigationSubMenu のメニュー項目のリスト。navigationMenuItem を使用して、親ヘッダーの子項目を作成、削除、または更新します。

NetworkAuthApiSettings

ヘッドレス登録フロー、ヘッドレスのパスワードを忘れた場合のフロー、ヘッドレスパスワードレスログインフロー、およびそれらに関連する API の有効化、アクセス、およびセキュリティを制御する設定を表します。API バージョン 60.0 以降で利用できます。

項目	項目の型	Details
doesForgotPasswordRequireAuth	boolean	パスワードのリセットの要求で、パスワードを忘れた場合のヘッドレス API へのアクセスに認証が必要かどうかを決定します。`true` の場合、/services/auth/headless/forgot_password エンドポイントへの最初の POST 要求で、内部インテグレーションユーザーに発行されたアクセストークンが必要です。アクセストークンには `forgot_password` 範囲を含める必要があります。
doesPwdlessLoginRequireAuth	boolean	ユーザー情報を Salesforce に送信する際に、ヘッドレスパスワードレスログイン API にアクセスするための認証が必要かどうかを決定します。`true` の場合、/services/auth/headless/init/passwordless/login エンドポイントへの最初の POST 要求で、内部インテグレーションユーザーに発行されたアクセストークンが必要です。アクセストークンには `pwdless_login_api` 範囲を含める必要があります。
doesRegistrationRequireAuth	boolean	ユーザー登録情報を Salesforce に送信する際に、ヘッドレス登録 API にアクセスするための認証が必要かどうかを決定します。`true` の場合、/services/auth/headless/init/registration エンドポイントへの最初の POST 要求で、内部インテグレーションユーザーに発行されたアクセストークンが必要です。アクセストークンには `user_registration_api` 範囲が含まれている必要があります。
emailTmplsAllowlist	NetworkEmailTmplAllowlist[]	ヘッドレス登録フロー、パスワードなしのヘッドレスログインフロー、ヘッドレスのパスワードを忘れた場合のメールテンプレート許可リスト。許可リストは、これらのフロー中にエンドユーザーに送信される検証メールに使用できるメールテンプレートを定義します。
isForgotPwdAllowed	boolean	ヘッドレスのパスワードを忘れた場合のフローが有効になっているかどうかを判定します。
isForgotPwdEmailTemplateAllowlistingEnabled	boolean	ヘッドレスのパスワードを忘れた場合のフローでメールテンプレートの許可リストが有効になっているかどうかを判定します。`true` の場合、パスワードを忘れた場合のヘッドレス API に対する初期要求の `emailtemplate` パラメーターは、許可リストに登録したメールテンプレートしか含めることができなくなります。
isHeadlessUserRegistrationAllowed	boolean	ヘッドレス登録フローが有効になっているかどうかを判定します。
IsPwdlessLoginAllowed	boolean	ヘッドレスパスワードレスログインフローが有効であるか (`true`)、否か (`false`) を決定します。
isRecaptchaRequiredForgotPwd	boolean	パスワードのリセットの要求で、パスワードを忘れた場合のヘッドレス API へのアクセスに reCAPTCHA トークンが必要かどうかを決定します。`true` の場合、/services/auth/headless/forgot_password エンドポイントへの最初の POST 要求で、reCAPTCHA トークンが必要です。
isRecaptchaRequiredPwdlessLogin	boolean	ユーザー情報を Salesforce に送信する際に、ヘッドレスパスワードレスログイン API にアクセスするための reCAPTCHA トークンが必要かどうかを決定します。`true` の場合、/services/auth/headless/init/passwordless/login エンドポイントへの最初の POST 要求で、reCAPTCHA トークンが必要です。
isRecaptchaRequiredRgstr	boolean	ユーザー登録情報を Salesforce に送信する際に、ヘッドレス登録 API にアクセスするための reCAPTCHA トークンが必要かどうかを決定します。`true` の場合、/services/auth/headless/init/registration エンドポイントへの最初の POST 要求で、reCAPTCHA トークンが必要です。
isUniversalClientRgstrAllowed	boolean	ユニバーサル登録 API を介したセルフ登録とパスワードなしのログインが有効かどうかを判定します。
maxPasswordResetAttempts	int	ユーザーが新しいワンタイムパスワード (OTP) を要求するまで、ヘッドレスのパスワードを忘れた場合のフローで許可するパスワードリセット試行回数の最大値です。
recaptchaScoreThreshold	double	ヘッドレス ID API へのアクセス要求を受け入れる最低の reCAPTCHA スコア。この値は、0.5 ～ 1 の間にする必要があります。スコアが 0.5 に近い場合はボットである可能性が高く、スコアが 1 に近い場合は有効なユーザーである可能性が高くなります。 doesForgotPasswordRequireAuth または doesRegistrationRequireAuth の項目が `true` に設定されている場合、スコアしきい値を設定する必要があります。reCAPTCHA の設定は、ヘッドレス登録フローとヘッドレスのパスワードを忘れた場合のフローの両方に適用されます。 Google は、reCAPTCHA v3 の実装に対してのみ、reCAPTCHA スコアを発行しています。reCAPTCHA v2 を実装している場合、この項目は適用されません。
recaptchaSecretKey	string	API キーペアの reCAPTCHA 秘密鍵。reCAPTCHA を設定する場合は、Google から API キーペアを入手します。秘密鍵によりアプリケーションは Google と安全に通信できます。doesForgotPasswordRequireAuth または doesRegistrationRequireAuth が `true` に設定されている場合、秘密鍵を入力する必要があります。reCAPTCHA の設定は、reCAPTCHA が有効になっているすべてのヘッドレス ID フローに適用されます。
registrationExecutionUser	string	ヘッドレス登録 Apex ハンドラーを実行するユーザー。
registrationHandler	string	ヘッドレス登録 Apex ハンドラー。
registrationUserDefaultProfile	string	新規ユーザーの登録時に割り当てられるデフォルトプロファイル。

NetworkEmailTmplAllowlist

ヘッドレス登録フロー、パスワードなしのヘッドレスログインフロー、ヘッドレスのパスワードを忘れた場合にエンドユーザーに送信されるワンタイムパスワード (OTP) メールテンプレートの許可リストを表します。API バージョン 60.0 以降で利用できます。

項目	項目の型	説明
emailTemplate	string	必須。登録、パスワードなしのログイン、パスワードを忘れた場合のヘッドレス承認フロー中にユーザーに送信できるメールテンプレート。複数のテンプレートをリストできます。アプリケーションがヘッドレス登録 API またはパスワードなしのヘッドレスログイン API に最初の要求を送信するとき、`emailtemplate` パラメーターには許可リストからメールテンプレート ID のみを含めることができます。ヘッドレスのパスワードを忘れた場合の API についても同様に動作しますが、それは NetworkAuthApiSettings メタデータ型の isForgotPwdEmailTemplateAllowlistingEnabled 項目が `true` の場合のみです。

NetworkMemberGroup

Experience Cloud サイトに割り当てられたプロファイルおよび権限セットを表します。いずれかのプロファイルまたは権限セットを持つユーザーは、(顧客グループの) Chatter 顧客でない限り、サイトのメンバーです。

項目	項目の型	説明
permissionSet	string	サイトに割り当てられた権限セット。サイトにも関連付けられている権限セットが (顧客グループの) Chatter 顧客に割り当てられている場合、その Chatter 顧客はサイトに追加されません。メモ
profile	string	サイトの一部であるプロファイル。

NetworkPageOverride

[パスワードの変更]、[パスワードを忘れた場合]、[ホーム]、[ログイン] の各ページがどのページ種別を参照するかを制御する、[管理] 領域 ([エクスペリエンス管理] またはエクスペリエンスワークスペース内) の設定を表します。

割り当てられた Visualforce ページの上書きは、対応する CustomSite メタデータ項目を使用して指定され、リリースされます。

メモ

項目	項目の型	説明
changePasswordPageOverrideSetting	NetworkPageOverrideSetting (string 型の列挙)	必須。[パスワードの変更] ページの設定が適用されるページ種別を指定します。有効な値は、次のとおりです。 `Configurable` — 設定可能なセルフ登録ページ `Designer` — エクスペリエンスビルダーのページ `Standard` — デフォルトページ `VisualForce` — Visualforce ページ
forgotPasswordPageOverrideSetting	NetworkPageOverrideSetting (string 型の列挙)	必須。[パスワードを忘れた場合] ページの設定が適用されるページ種別を指定します。有効な値は、次のとおりです。 `Configurable` — 設定可能なセルフ登録ページ `Designer` — エクスペリエンスビルダーのページ `Standard` — デフォルトページ `VisualForce` — Visualforce ページ
homePageOverrideSetting	NetworkPageOverrideSetting (string 型の列挙)	必須。エクスペリエンスホームページの設定が適用されるページ種別を指定します。有効な値は、次のとおりです。 `Configurable` — 設定可能なセルフ登録ページ `Designer` — エクスペリエンスビルダーのページ `Standard` — デフォルトページ `VisualForce` — Visualforce ページ
loginPageOverrideSetting	NetworkPageOverrideSetting (string 型の列挙)	必須。[ログイン] ページの設定が適用されるページ種別を指定します。有効な値は、次のとおりです。 `Configurable` — 設定可能なセルフ登録ペ��ジ `Designer` — エクスペリエンスビルダーのページ `Standard` — デフォルトページ `VisualForce` — Visualforce ページホームおよびログインページ用にエクスペリエンスビルダーページを設定するには、サイトが公開されていることを確認してください。管理者設定のドロップダウンメニューから非公開ページがデフォルトページとして表示されます。メモ
selfRegProfilePageOverrideSetting	NetworkPageOverrideSetting (string 型の列挙)	必須。[セルフ登録] ページの設定が適用されるページ種別を指定します。有効な値は、次のとおりです。 `Configurable` — 設定可能なセルフ登録ページ `Designer` — エクスペリエンスビルダーのページ `Standard` — デフォルトページ `VisualForce` — Visualforce ページ

RecommendationAudience

新しい Experience Cloud サイトメンバーによる利用者を作成します。または、カスタマイズした利用者メンバーのリストを管理しておすすめを整理または対象にするために使用できます。API バージョン 41.0 以降で利用できます。

項目	項目の型	説明
recommendationAudienceDetails	RecommendationAudienceDetail	おすすめの利用者の詳細。

RecommendationAudienceDetail

おすすめの利用者の詳細。API バージョン 41.0 以降で利用できます。

項目	項目の型	説明
audienceCriteriaType	AudienceCriteriaType (string 型の列挙)	おすすめ利用者種別の条件。値は次のとおりです。 `CustomList` `MaxDaysInCommunity`
audienceCriteriaValue	string	新規メンバー条件では、ユーザーがメンバーになった時点からの最大日数。カスタムリスト条件では Null です。
setupName	string	おすすめ利用者の名前。

RecommendationDefinition

Experience Cloud サイトのエンゲージメントを促進するカスタムおすすめのリストを表します。API バージョン 41.0 以降で利用できます。

項目	項目の型	説明
recommendationDefinitionDetails	RecommendationDefinitionDetail[]	カスタムおすすめとその詳細のリスト。

RecommendationDefinitionDetail

カスタムおすすめの詳細。API バージョン 41.0 以降で利用できます。

項目	項目の型	説明
actionUrl	string	ユーザーがおすすめに対してアクションを実行できるようにするボタンの URL。
description	string	ユーザーが実行できるアクションを提案するおすすめの説明。
linkText	string	ボタンのテキスト表示ラベル。
scheduledRecommendations	ScheduledRecommendation	スケジュール済みおすすめのリスト。
setupName	string	[設定] に表示されるおすすめの名前。
title	string	おすすめのタイトル。

ReputationBranding

評価レベルのブランド設定。

項目	項目の型	説明
smallImage	string	評価レベルに関連付けられたカスタム画像。拡張子が .jpeg、.png、または .gif のファイルを使用します。画像はドキュメントとして保存されます。指定されていない場合は、デフォルトの評価レベル画像が使用されます。API バージョン 32.0 以降で利用できます。

ReputationLevelDefinitions

Experience Cloud サイト内で特定の定義されたアクションを実行することでメンバーが達成できる評価レベルを表します。

項目	項目の型	説明
level	ReputationLevel[]	評価レベルを表します。

ReputationLevel

評価レベルの名前と下限値を表します。アプリケーションが上限値を計算します。

項目	項目の型	説明
branding	ReputationBranding[]	評価レベルに関連付けられたブランド設定を表します。具体的には、評価レベルのカスタム画像です。この項目は省略可能です。指定されていない場合は、デフォルトの評価レベル画像が使用されます。API バージョン 32.0 以降で利用できます。
label	string	評価レベルの名前。この項目は省略可能です。指定されていない場合、10 個のデフォルトのいずれかが使用されます。レベル 1 レベル 2 レベル 3 レベル 4 レベル 5 レベル 6 レベル 7 レベル 8 レベル 9 レベル 10
lowerThreshold	double	必須。この評価レベルの範囲の下限値。たとえば、この評価レベルがポイント 1 ～ 50 の場合、1 が lowerThreshold です。

項目

項目の型

説明

branding

ReputationBranding[]

評価レベルに関連付けられたブランド設定を表します。具体的には、評価レベルのカスタム画像です。

この項目は省略可能です。指定されていない場合は、デフォルトの評価レベル画像が使用されます。API バージョン 32.0 以降で利用できます。

label

string

評価レベルの名前。

この項目は省略可能です。指定されていない場合、10 個のデフォルトのいずれかが使用されます。

レベル 1
レベル 2
レベル 3
レベル 4
レベル 5
レベル 6
レベル 7
レベル 8
レベル 9
レベル 10

lowerThreshold

double

必須。この評価レベルの範囲の下限値。たとえば、この評価レベルがポイント 1 ～ 50 の場合、1 が lowerThreshold です。

ReputationPointsRules

Experience Cloud サイトのポイントシステムのポイントルールを表します。

項目	項目の型	説明
pointsRule	ReputationPointsRule[]	行動とそれに関連付けられたポイントを表します。

ReputationPointsRule

ポイントルールの行動と関連付けられたポイント値を表します。アクションを実行したユーザーは、関連付けられたポイントを獲得します。

項目	項目の型	説明
eventType	string	必須。ポイントを獲得するためにメンバーが実行する必要がある行動の種別。次の値を使用できます。 `FeedItemWriteAPost` `FeedItemWriteAComment` `FeedItemReceiveAComment` `FeedItemLikeSomething` `FeedItemReceiveALike` `FeedItemMentionSomeone` `FeedItemSomeoneMentionsYou` `FeedItemShareAPost` `FeedItemSomeoneSharesYourPost` `FeedItemPostAQuestion` `FeedItemAnswerAQuestion` `FeedItemReceiveAnAnswer` `FeedItemMarkAnswerAsBest` `FeedItemYourAnswerMarkedBest` `FeedItemEndorseSomeoneForKnowledgeOnATopic` `FeedItemEndorsedForKnowledgeOnATopic`
points	int	必須。行動を実行してメンバーが取得するポイント数。行動ごとのデフォルトのポイント数は次のとおりです。 FeedItemWriteAPost +1 FeedItemWriteAComment: +1 FeedItemReceiveAComment: +5 FeedItemLikeSomething: +1 FeedItemReceiveALike: +5 FeedItemMentionSomeone: +1 FeedItemSomeoneMentionsYou: +5 FeedItemShareAPost: +1 FeedItemSomeoneSharesYourPost: +5 FeedItemPostAQuestion: +1 FeedItemAnswerAQuestion: +5 FeedItemReceiveAnAnswer: +5 FeedItemMarkAnswerAsBest: +5 FeedItemYourAnswerMarkedBest: +20 FeedItemEndorseSomeoneForKnowledgeOnATopic: +5 FeedItemEndorsedForKnowledgeOnATopic: +20

ScheduledRecommendation

スケジュール済みおすすめのリストを表します。API バージョン 41.0 以降で利用できます。

項目	項目の型	説明
scheduledRecommendationDetails	ScheduledRecommendationDetail[]	スケジュール済みおすすめのリスト。

ScheduledRecommendationDetail

スケジュール済みおすすめの詳細。API バージョン 41.0 以降で利用できます。

項目	項目の型	説明
channel	RecommendationChannel (string 型の列挙)	おすすめをグループ化して、おすすめをサイトのどこに表示するのかを決定する手段。有効な値は、次のとおりです。 `DefaultChannel` — デフォルトのおすすめチャネル。デフォルトチャネルのおすすめは定義済みの場所 (Salesforce モバイル Web のフィードや、カスタマーサービス (Napili) テンプレートを使用する [ホーム] ページおよび [質問の詳細] ページなど) に表示されます。 `CustomChannel1` — カスタムのおすすめチャネル。エクスペリエンスビルダーで、ページに [おすすめのカルーセル] コンポーネントを追加しておすすめを表示する場所を選択します。 `CustomChannel2` — カスタムのおすすめチャネル。 `CustomChannel3` — カスタムのおすすめチャネル。 `CustomChannel4` — カスタムのおすすめチャネル。 `CustomChannel5` — カスタムのおすすめチャネル。
enabled	boolean	スケジュールが有効になっているかどうかを示します。`true` の場合、おすすめが有効になり、サイトに表示されます。 `false` の場合、Salesforce モバイル Web でのフィードのおすすめは削除されませんが、新しいおすすめは表示されなくなります。サイトでは、無効にしたおすすめは表示されません。
rank	int	表示順序を決定するチャネル内のおすすめのランク。スケジュール済みおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みおすすめの rank が 1 つずつ下がります。指定された rank がリストのサイズよりも大きい場合は、スケジュール済みおすすめがリストの末尾に配置されます。 rank が指定されていない場合は、スケジュール済みおすすめがリストの末尾に配置されます。
recommendationAudience	string	このスケジュール済みおすすめの利用者の名前。

NetworkTabSet

項目	項目の型	説明
customTab	string	サイトの一部であるカスタムタブ。
defaultTab	string	サイトの [ホーム] タブ。メンバーがログインすると、このタブが最初のページとして表示されます。
standardTab	string	サイトの一部である標準タブ。

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

次に、ネットワークの XML 定義のサンプルを示します。

<?xml version="1.0" encoding="UTF-8"?>
<Network xmlns="http://soap.sforce.com/2006/04/metadata">
    <allowMembersToFlag>true</allowMembersToFlag>
    <changePasswordTemplate>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate>
    <description>Metadata Community</description>
    <emailSenderAddress>admin@networkMetadata.com</emailSenderAddress>
    <emailSenderName>Admin User</emailSenderName>
    <enableInvitation>false</enableInvitation>
    <enableKnowledgeable>true</enableKnowledgeable>
    <enableNicknameDisplay>false</enableNicknameDisplay>
    <enablePrivateMessages>true</enablePrivateMessages>
    <enableReputation>true</enableReputation>
    <enableUpDownVote>true</enableUpDownVote>
    <forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>
    <networkMemberGroups>
        <permissionSet>Admin</permissionSet>
        <permissionSet>Standard</permissionSet>
        <permissionSet>ReadOnly</permissionSet>
        <profile>Admin</profile>
        <profile>Standard</profile>
        <profile>ReadOnly</profile>
    </networkMemberGroups>
    <recommendationDefinition>
        <recommendationDefinitionDetails>
            <actionUrl>https://www.apple.com/iphone</actionUrl>
            <description>Better specs and high performance for iPhones</description>
            <linkText>iPhone 7</linkText>
            <scheduledRecommendations>
                <scheduledRecommendationDetails>
                    <channel>DefaultChannel</channel>
                    <enabled>false</enabled>
                    <rank>1</rank>
                    <recommendationAudience>New Member Audience</recommendationAudience>
                </scheduledRecommendationDetails>
            </scheduledRecommendations>
            <setupName>Apple iPhone</setupName>
            <title>iPhone7</title>
        </recommendationDefinitionDetails>
        <recommendationDefinitionDetails>
            <actionUrl>https://www.bose.com/qc35</actionUrl>
            <description>New Amazing Noise cancellation Headphones</description>
            <linkText>Bose QC35</linkText>
            <scheduledRecommendations>
                <scheduledRecommendationDetails>
                    <channel>DefaultChannel</channel>
                    <enabled>true</enabled>
                    <rank>2</rank>
                    <recommendationAudience>Custom Audience</recommendationAudience>
                </scheduledRecommendationDetails>
            </scheduledRecommendations>
            <setupName>Bose Headphones</setupName>
            <title>Bose QC35</title>
        </recommendationDefinitionDetails>
    </recommendationDefinition>
    <reputationLevels>
        <level>
            <branding> 
                <smallImage>communities_shared _document_folder/replevel_beginner.png</smallImage>
            </branding>
            <label>Beginner</label>
            <lowerThreshold>0</lowerThreshold>
        </level>
        <level>
            <branding> 
                <smallImage>communities_shared _document_folder/replevel_apprentice.png</smallImage>
            </branding>
            <label>Apprentice</label>
            <lowerThreshold>51</lowerThreshold>
        </level>
        <level>
            <branding> 
                <smallImage>communities_shared _document_folder/replevel_gettingthere.png</smallImage>
            </branding>
            <label>Getting There</label>
            <lowerThreshold>101</lowerThreshold>
        </level>
        <level>
            <branding> 
                <smallImage>communities_shared _document_folder/replevel_skilled.png</smallImage>
            </branding>
            <label>Skilled</label>
            <lowerThreshold>151</lowerThreshold>
        </level>
        <level>
            <branding> 
                <smallImage>communities_shared _document_folder/replevel_expert.png</smallImage>
            </branding>
            <label>Expert</label>
            <lowerThreshold>201</lowerThreshold>
        </level>
        <level>
            <branding> 
                <smallImage>communities_shared _document_folder/replevel_mentor.png</smallImage>
            </branding>
            <label>Mentor</label>
            <lowerThreshold>251</lowerThreshold>
        </level>
        <level>
            <branding> 
                <smallImage>communities_shared _document_folder/replevel_guru.png</smallImage>
            </branding>
            <label>Guru</label>
            <lowerThreshold>301</lowerThreshold>
        </level>
    </reputationLevels>
    <reputationPointsRules>
        <pointsRule>
            <eventType>FeedItemWriteAPost</eventType>
            <points>5</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemWriteAComment</eventType>
            <points>3</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemReceiveAComment</eventType>
            <points>10</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemLikeSomething</eventType>
            <points>3</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemReceiveALike</eventType>
            <points>5</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemMentionSomeone</eventType>
            <points>5</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemSomeoneMentionsYou</eventType>
            <points>10</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemShareAPost</eventType>
            <points>5</points>
        </pointsRule>
        <pointsRule>
            <eventType>FeedItemSomeoneSharesYourPost</eventType>
            <points>10</points>
        </pointsRule>
    </reputationPointsRules>
    <selfRegistration>false</selfRegistration>
    <sendWelcomeEmail>true</sendWelcomeEmail>
    <site>Network_11</site>
    <status>UnderConstruction</status>
    <tabs>
        <defaultTab>Chatter</defaultTab>
        <standardTab>Chatter</standardTab>
        <standardTab>Account</standardTab>
        <standardTab>Campaign</standardTab>
        <standardTab>Case</standardTab>
        <standardTab>Console</standardTab>
        <standardTab>Contact</standardTab>
        <standardTab>Contract</standardTab>
        <standardTab>Dashboard</standardTab>
        <standardTab>JigsawSearch</standardTab>
        <standardTab>File</standardTab>
        <standardTab>CollaborationGroup</standardTab>
        <standardTab>home</standardTab>
        <standardTab>Idea</standardTab>
        <standardTab>Lead</standardTab>
        <standardTab>Opportunity</standardTab>
        <standardTab>Product2</standardTab>
        <standardTab>UserProfile</standardTab>
        <standardTab>report</standardTab>
        <standardTab>Solution</standardTab>
    </tabs>
    <urlPathPrefix>network1</urlPathPrefix>
    <welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>
</Network>

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

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

Login

Products

Experiences

Agentforce

CRM Products

Industries

Small Business

Data

Salesforce Platform

Customer Success

Partner Apps & Experts

Discover the #1 AI CRM

Discover the #1 AI CRM

Automotive

Communications

Engineering, Construction & Real Estate

Consumer Goods

Education

Energy & Utilities

Financial Services

Healthcare & Life Sciences

Manufacturing

Media

Nonprofit

Professional Services

Public Sector

Retail

Technology

Travel, Transportation & Hospitality

Explore Salesforce for industries.

Explore Salesforce for industries.

Customer Stories

Salesforce on Salesforce Stories

Trailblazer Stories

Explore success stories.

Explore success stories.

Learning on Trailhead

Events

Resources

Blogs

Become a Trailblazer.

Become a Trailblazer.

Help & Documentation

Communities

Services & Plans

Account Management

Questions? We can help.

Questions? We can help.

About Salesforce

Our Values

Our Impact

Careers

Newsroom

Legal

More Salesforce Brands

Hear our story.

Hear our story.

Events

Original Series

My List

Explore Salesforce+.

Explore Salesforce+.

Login

Products

Experiences

Contact Us

By phone

Online

Products

Experiences

Developer Centers

Salesforce Platform

Industries

Resources

Developer Tools

Build Skills

Extend Salesforce

Stay Up To Date

Community

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