ManagedContentDelivery クラス

API バージョン

56.0

ゲストユーザーが使用可能

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentCollectionItems getCollectionItemsForChannel(String channelId, String collectionKeyOrId, String language)

パラメーター

channelId

型: String

チャネルの ID。

collectionKeyOrId

型: String

コレクションのコレクションキーまたは ID。コレクションキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語のデフォルトはチャネルまたはサイトのデフォルト言語に設定されます。チャネルまたはサイトのデフォルト言語が提供されていない場合は、デフォルトで言語はコンテンツ空間のプライマリ言語に設定されます。

戻り値

型: ConnectApi.ManagedContentCollectionItems

API バージョン

56.0

ゲストユーザーが使用可能

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentCollectionItems getCollectionItemsForSite(String siteId, String collectionKeyOrId, String language)

パラメーター

siteId

型: String

Experience Cloud サイトの ID。

collectionKeyOrId

型: String

コレクションのコレクションキーまたは ID。コレクションキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語のデフォルトはチャネルまたはサイトのデフォルト言語に設定されます。チャネルまたはサイトのデフォルト言語が提供されていない場合は、デフォルトで言語はコンテンツ空間のプライマリ言語に設定されます。

戻り値

型: ConnectApi.ManagedContentCollectionItems

API バージョン

54.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentChannelDetail getManagedContentChannel(String channelId)

パラメーター

channelId

型: String

チャネルの ID。

戻り値

型: ConnectApi.ManagedContentChannelDetail

API バージョン

54.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForChannel(String channelId, String contentKeyOrId, Boolean showAbsoluteUrl)

パラメーター

channelId

型: String

チャネルの ID。

contentKeyOrId

型: String

コンテンツのコンテンツキーまたは ID。コンテンツキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

showAbsoluteUrl

型: Boolean

公開チャネルのみの場合、出力クラスで絶対 unauthenticatedUrl を返すかどうかを指定します。デフォルト値は、false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocument

使用方法

このメソッドがコンテンツを返すのは、コンテンツがチャネルのデフォルト言語で公開された場合のみです。チャネルのデフォルト言語で公開されなかったコンテンツを要求すると、ConnectApi.NotFoundException が発生します。別の言語のチャネルのコンテンツを取得するには、getManagedContentForChannel(channelId, contentKeyOrId, language, showAbsoluteUrl) または getManagedContentForChannel(channelId, contentKeyOrId, language, showAbsoluteUrl, referenceDepth, expandReferences, referencesAsList) を使用します。

API バージョン

54.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForChannel(String channelId, String contentKeyOrId, String language, Boolean showAbsoluteUrl)

パラメーター

channelId

型: String

チャネルの ID。

contentKeyOrId

型: String

コンテンツのコンテンツキーまたは ID。コンテンツキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された言語はチャネルに追加する必要があります。そうしないと、ConnectApi.NotFoundException が発生します。要求された翻訳が使用できない場合、言語のデフォルトはチャネルまたはサイトのデフォルト言語に設定されます。チャネルまたはサイトのデフォルト言語が提供されていない場合は、デフォルトで言語はコンテンツ空間のプライマリ言語に設定されます。

showAbsoluteUrl

型: Boolean

公開チャネルのみの場合、出力クラスで絶対 unauthenticatedUrl を返すかどうかを指定します。デフォルト値は、false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocument

API バージョン

54.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForChannel(String channelId, String contentKeyOrId, String language, Boolean showAbsoluteUrl, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList)

パラメーター

channelId

型: String

チャネルの ID。

contentKeyOrId

型: String

コンテンツのコンテンツキーまたは ID。コンテンツキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された言語はチャネルに追加する必要があります。そうしないと、ConnectApi.NotFoundException が発生します。要求された翻訳が使用できない場合、言語のデフォルトはチャネルまたはサイトのデフォルト言語に設定されます。チャネルまたはサイトのデフォルト言語が提供されていない場合は、デフォルトで言語はコンテンツ空間のプライマリ言語に設定されます。

showAbsoluteUrl

型: Boolean

公開チャネルのみの場合、出力クラスで絶対 unauthenticatedUrl を返すかどうかを指定します。デフォルト値は、false です。

referenceDepth

型: Integer

参照の深度を指定する 0 ～ 3 の整数。0 を指定すると、ConnectApi.ManagedContentDeliveryDocument 出力クラスの references プロパティが null になります。指定されていない場合、デフォルト値は 0 です。

expandReferences

型: Boolean

出力クラスに参照の詳細を含めるか (true)、参照の概要を含めるか (false) を指定します。指定されていない場合、デフォルト値は false です。

referencesAsList

型: Boolean

参照を ConnectApi.ManagedContentDeliveryDocument 出力クラスの referencesList プロパティのリストとして返すか (true)、否かを指定します。false を指定すると、参照は references プロパティのキーと値のペアとして返されます。指定されていない場合、デフォルト値は false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocument

API バージョン

54.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForSite(String siteId, String contentKeyOrId, Boolean showAbsoluteUrl)

パラメーター

siteId

型: String

Experience Cloud サイトの ID。

contentKeyOrId

型: String

コンテンツのコンテンツキーまたは ID。コンテンツキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

showAbsoluteUrl

型: Boolean

公開チャネルのみの場合、出力クラスで絶対 unauthenticatedUrl を返すかどうかを指定します。デフォルト値は、false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocument

API バージョン

54.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForSite(String siteId, String contentKeyOrId, String language, Boolean showAbsoluteUrl)

パラメーター

siteId

型: String

Experience Cloud サイトの ID。

contentKeyOrId

型: String

コンテンツのコンテンツキーまたは ID。コンテンツキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語のデフォルトはチャネルまたはサイトのデフォルト言語に設定されます。チャネルまたはサイトのデフォルト言語が提供されていない場合は、デフォルトで言語はコンテンツ空間のプライマリ言語に設定されます。

showAbsoluteUrl

型: Boolean

公開チャネルのみの場合、出力クラスで絶対 unauthenticatedUrl を返すかどうかを指定します。デフォルト値は、false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocument

API バージョン

54.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocument getManagedContentForSite(String siteId, String contentKeyOrId, String language, Boolean showAbsoluteUrl, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList)

パラメーター

siteId

型: String

Experience Cloud サイトの ID。

contentKeyOrId

型: String

コンテンツのコンテンツキーまたは ID。コンテンツキーは、MCA4CCV5QS2BAB5H7YRCRPTCWGZQ のような一意の識別子です。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語のデフォルトはチャネルまたはサイトのデフォルト言語に設定されます。チャネルまたはサイトのデフォルト言語が提供されていない場合は、デフォルトで言語はコンテンツ空間のプライマリ言語に設定されます。

showAbsoluteUrl

型: Boolean

公開チャネルのみの場合、出力クラスで絶対 unauthenticatedUrl を返すかどうかを指定します。デフォルト値は、false です。

referenceDepth

型: Integer

参照の深度を指定する 0 ～ 3 の整数。0 を指定すると、ConnectApi.ManagedContentDeliveryDocument 出力クラスの references プロパティが null になります。指定されていない場合、デフォルト値は 0 です。

expandReferences

型: Boolean

出力クラスに参照の詳細を含めるか (true)、参照の概要を含めるか (false) を指定します。指定されていない場合、デフォルト値は false です。

referencesAsList

型: Boolean

参照を ConnectApi.ManagedContentDeliveryDocument 出力クラスの referencesList プロパティのリストとして返すか (true)、否かを指定します。false を指定すると、参照は references プロパティのキーと値のペアとして返されます。指定されていない場合、デフォルト値は false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocument

API バージョン

58.0

ゲストユーザーが使用可能

58.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForChannel(String channelId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize, Boolean showAbsoluteUrl)

パラメーター

channelId

型: String

チャネルの ID。

managedContentIds

型: List<String>

管理コンテンツ ID のカンマ区切りリスト��管理コンテンツ ID は、最大 100 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentKeys

型: List<String>

コンテンツキーのカンマ区切り��スト。コンテンツキーは、最大 50 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentTypeFQN

型: String

管理コンテンツ種別の完全修飾名。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語はデフォルトで、設定済みの代替言語、またはチャネルのデフォルト言語に設定されます。代替言語のコンテンツおよびチャネルのデフォルト言語のコンテンツが用意されていない場合は、エラーが返されます。

publishStartDate

型: String

ISO 8601 形式の公開開始日。

publishEndDate

型: String

ISO 8601 形式の公開終了日。

includeContentBody

型: Boolean

コンテンツ本文を返すか (true)、コンテンツ概要を返すか (false) を指定します。指定されていない場合、デフォルト値は false です。

referenceDepth

型: Integer

参照の深度を指定する 0 ～ 3 の整数。0 を指定すると、ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの references プロパティが null になります。指定されていない場合、デフォルト値は 0 です。

expandReferences

型: Boolean

出力クラスに参照の詳細を含めるか (true)、参照の概要を含めるか (false) を指定します。指定されていない場合、デフォルト値は false です。

referencesAsList

型: Boolean

参照を ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの referencesList プロパティのリストとして返すか (true)、否かを指定します。false を指定すると、参照は references プロパティのキーと値のペアとして返されます。指定されていない場合、デフォルト値は false です。

pageParam

型: Integer

返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。null を渡すと、デフォルトサイズの 25 に設定されます。expandReferences または includeContentBody に true を指定した場合、指定できる最大ページサイズは 25 です。

showAbsoluteUrl

型: Boolean

出力クラスで絶対 URL を表示するか (true)、否か (false) を示します。デフォルト値は false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocumentCollection

API バージョン

58.0

ゲストユーザーが使用可能

58.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForSite(String siteId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize, Boolean showAbsoluteUrl)

パラメーター

siteId

型: String

Experience Cloud サイトの ID。

managedContentIds

型: List<String>

管理コンテンツ ID のカンマ区切りリスト。管理コンテンツ ID は、最大 100 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentKeys

型: List<String>

コンテンツキーのカンマ区切りリスト。コンテンツキーは、最大 50 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentTypeFQN

型: String

管理コンテンツ種別の完全修飾名。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語はデフォルトで、設定済みの代替言語、またはチャネルのデフォルト言語に設定されます。代替言語のコンテンツおよびチャネルのデフォルト言語のコンテンツが用意されていない場合は、エラーが返されます。

publishStartDate

型: String

ISO 8601 形式の公開開始日。

publishEndDate

型: String

ISO 8601 形式の公開終了日。

includeContentBody

型: Boolean

コンテンツ本文を返すか (true)、コンテンツ概要を返すか (false) を指定します。指定されていない場合、デフォルト値は false です。

referenceDepth

型: Integer

参照の深度を指定する 0 ～ 3 の整数。0 を指定すると、ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの references プロパティが null になります。指定されていない場合、デフォルト値は 0 です。

expandReferences

型: Boolean

出力クラスに参照の詳細を含めるか (true)、参照の概要を含めるか (false) を指定します。指定されていない場合、デフォルト値は false です。

referencesAsList

型: Boolean

参照を ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの referencesList プロパティのリストとして返すか (true)、否かを指定します。false を指定すると、参照は references プロパティのキーと値のペアとして返されます。指定されていない場合、デフォルト値は false です。

pageParam

型: Integer

返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。null を渡すと、デフォルトサイズの 25 に設定されます。expandReferences または includeContentBody に true を指定した場合、指定できる最大ページサイズは 25 です。

showAbsoluteUrl

型: Boolean

出力クラスで絶対 URL を表示するか (true)、否か (false) を示します。デフォルト値は false です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocumentCollection

API バージョン

ゲストユーザーが使用可能

55.0 ～ 57.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForChannel(String channelId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize)

パラメーター

channelId

型: String

チャネルの ID。

managedContentIds

型: List<String>

管理コンテンツ ID のカンマ区切りリスト。管理コンテンツ ID は、最大 100 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentKeys

型: List<String>

コンテンツキーのカンマ区切りリスト。コンテンツキーは、最大 50 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentTypeFQN

型: String

管理コンテンツ種別の完全修飾名。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語はデフォルトで、設定済みの代替言語、またはチャネルのデフォルト言語に設定されます。代替言語のコンテンツおよびチャネルのデフォルト言語のコンテンツが用意されていない場合は、エラーが返されます。

publishStartDate

型: String

ISO 8601 形式の公開開始日。

publishEndDate

型: String

ISO 8601 形式の公開終了日。

includeContentBody

型: Boolean

コンテンツ本文を返すか (true)、コンテンツ概要を返すか (false) を指定します。指定されていない場合、デフォルト値は false です。

referenceDepth

型: Integer

参照の深度を指定する 0 ～ 3 の整数。0 を指定すると、ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの references プロパティが null になります。指定されていない場合、デフォルト値は 0 です。

expandReferences

型: Boolean

出力クラスに参照の詳細を含めるか (true)、参照の概要を含めるか (false) を指定します。指定されていない場合、デフォルト値は false です。

referencesAsList

型: Boolean

参照を ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの referencesList プロパティのリストとして返すか (true)、否かを指定します。false を指定すると、参照は references プロパティのキーと値のペアとして返されます。指定されていない場合、デフォルト値は false です。

pageParam

型: Integer

返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。null を渡すと、デフォルトサイズの 25 に設定されます。expandReferences または includeContentBody に true を指定した場合、指定できる最大ページサイズは 25 です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocumentCollection

API バージョン

ゲストユーザーが使用可能

55.0 ～ 57.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedContentDeliveryDocumentCollection getManagedContentsForSite(String siteId, List<String> managedContentIds, List<String> contentKeys, String contentTypeFQN, String language, String publishStartDate, String publishEndDate, Boolean includeContentBody, Integer referenceDepth, Boolean expandReferences, Boolean referencesAsList, Integer pageParam, Integer pageSize)

パラメーター

siteId

型: String

Experience Cloud サイトの ID。

managedContentIds

型: List<String>

管理コンテンツ ID のカンマ区切りリスト。管理コンテンツ ID は、最大 100 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentKeys

型: List<String>

コンテンツキーのカンマ区切りリスト。コンテンツキーは、最大 50 個指定できます。管理コンテンツ ID またはコンテンツキーのいずれかを指定してください。

contentTypeFQN

型: String

管理コンテンツ種別の完全修飾名。

language

型: String

en_US などの管理コンテンツの言語ロケール。要求された翻訳が使用できない場合、言語はデフォルトで、設定済みの代替言語、またはチャネルのデフォルト言語に設定されます。代替言語のコンテンツおよびチャネルのデフォルト言語のコンテンツが用意されていない場合は、エラーが返されます。

publishStartDate

型: String

ISO 8601 形式の公開開始日。

publishEndDate

型: String

ISO 8601 形式の公開終了日。

includeContentBody

型: Boolean

コンテンツ本文を返すか (true)、コンテンツ概要を返すか (false) を指定します。指定されていない場合、デフォルト値は false です。

referenceDepth

型: Integer

参照の深度を指定する 0 ～ 3 の整数。0 を指定すると、ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの references プロパティが null になります。指定されていない場合、デフォルト値は 0 です。

expandReferences

型: Boolean

出力クラスに参照の詳細を含めるか (true)、参照の概要を含めるか (false) を指定します。指定されていない場合、デフォルト値は false です。

referencesAsList

型: Boolean

参照を ConnectApi.ManagedContentDeliveryDocumentCollection 出力クラスの referencesList プロパティのリストとして返すか (true)、否かを指定します。false を指定すると、参照は references プロパティのキーと値のペアとして返されます。指定されていない場合、デフォルト値は false です。

pageParam

型: Integer

返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。null を渡すと、デフォルトサイズの 25 に設定されます。expandReferences または includeContentBody に true を指定した場合、指定できる最大ページサイズは 25 です。

戻り値

型: ConnectApi.ManagedContentDeliveryDocumentCollection