SalesforceにおけるRenditionとは？詳細や注意点をご紹介

SalesforceにおけるRenditionとは？

Renditionとは、Salesforceでは変換のことを指します。 変換とはファイルのバイナリプレビューのことをいいます。バイナリの形式は、要求で指定された形式により違ってきます。 変換は共有ファイルの場合、アップロード後に非同期にて実行されます。非公開ファイルについては、変換は最初のファイルプレビュー要求で処理されますので、ファイルのアップロード直後に使用することができません。 例）

/connect/files/fileId/rendition

/connect/communities/communityId/files/fileId/rendition

Renditionを使用した変換の詳細

Renditionを使用した、ファイルの変換について説明します。 適用開始のバージョンは36.0です。Chatterは必要ありません。 バージョン24.0～35.0においては、Chatterで必要な「/chatter/files/fileId/rendition」と「/connect/communities/communityId/chatter/files/fileId/rendition」を使います。

パラメータ

要求するパラメータについて説明します。 「page」はInteger型で、特定のページについて変換を指定します。最初のページは0になります。特定のページを指定しない場合は、最初のページの変換が返ってきます。PDFファイルの変換については、ドキュメント全体の変換になり、有効な値は0だけです。単一ページの変換を取得することができません。 「type」はString型で、返される変換の種類について指定します。デフォルト値は「THUMB120BY90」です。有効な値は、「PDF」、「THUMB120BY90」、「THUMB240BY180」、「THUMB720BY480」になります。

SalesforceにおけるRenditionの概要

SalesforceでRenditionを使用すると、ストリーミングされた25 個のアセットファイルの変換を取得することができます。 変換とは、ファイルのバイナリプレビューのことを指します。 「fullyQualifiedName」は、名前空間プレフィックスが存在する場合、「ContentAsset」の API 参照名になります。 例）

/connect/file-assets/fullyQualifiedName/rendition

/connect/communities/communityId/file-assets/fullyQualifiedName/rendition

File Renditionの切り替え

Connect RESTAPIでFile Renditionを切り替えることができます。 Connect RESTAPIはAdobeFlash Renditionの作成を停止し、SVG Renditionに切り替えます。 この変更を行うと、Professionalを除くすべてのエディションに対して、LightningExperienceおよびSalesforceClassicに適用されることになります。 切り替え方法は、Connect RESTAPIファイルプレビューリソースを使うことにより、SVG Renditionを取得することです。

Asset File Renditionの詳細

使用可能なバージョンと要求パラメータについて説明します。 使用可能なバージョンは42.0です。Chatterは必要ありません。 「height」はInteger型で、画像ファイルの高さをピクセル単位で指定します。24ピクセルより大きくて、元の画像サイズよりも小さいサイズを指定しなければなりません。25 個のサイズの組み合わせまで指定できます。高さもしくは幅のみが指定されていれば、元の画像サイズになります。 「versionNumber」はInteger型で、ファイルの既存のバージョン番号が指定されます。指定されていない場合は最新のバージョンになります。 「width」はInteger型で、画像ファイルの幅をピクセル単位で指定します。24ピクセルより大きく、元の画像サイズより小さいサイズを指定しなければなりません。25 個のサイズの組み合わせまで指定できます。高さか幅のみなら、元の画像サイズになります。

ファイルプレビューの取得

ファイルプレビューの取得でも、Renditionを使用できます。 下記例では、ThumbnailのformatTypeを使ってgetFilePreviewをコールすることで、サムネール形式のプレビューとともに、その各URLおよびサムネール変換の数を取得できます。サムネール形式ごとに、使用可能な各変換URLが表示されます。 例）

System.debug(String.format('Preview - URL: \'\'{0}\'\', format: \'\'{1}\'\', nbr of renditions for this format: {2}', new String[]{ filePreview.url, filePreview.format.name(),String.valueOf(filePreview.previewUrls.size())}));

Salesforce Filesについて

Connect REST APIを使うことで、Salesforce Filesを操作することができます。 Salesforce Filesを使うことで、クラウドでファイルのアップロードや保存、検索、フォロー、共有、さらにコラボレーションをすることができます。 そのなかのリソースの一つとして「Rendition」が使用されています。 Renditionを使うことで、ストリーミングされた、25個までのアセットファイルの変換を取得することができます。 例）

/connect/file-assets/fullyQualifiedName​/rendition

Lightning Experienceでの実装

Lightning ExperienceにおけるRenditionについて説明します。 Lightning Experienceを使うようになったことで、今までと構造がClassic時代と変わってしまっています。Attachmentだけを取得したとしても、同じようにサムネールにすることができません。 例）

for (ContentDocument cd : this.getContent(contentDocumentIdList)) {
            for (ContentVersion cv : cd.ContentVersions) {
                String srcUrl = '/sfc/servlet.shepherd/version/renditionDownload?rendition=ORIGINAL_Jpg&versionId=' + cv.Id;
                exAttachmentList.add(srcUrl);
            }
        }

SalesforceでRenditionを活用しよう！

今回はSalesforceの機能の一つである「Rendition」について紹介しました。 SalesforceでRenditionを使うことによって、ファイルの変換に利用できたり、Asset File Renditionでアセットファイルの変換を取得することができます。 これからSalesforceエンジニアに転職したい人、あるいはSalesforceへの転職を考えている人にとって、Renditionの使い方を理解しておくことは大切です。 Renditionがどのようなものか理解し、使い方を知っておくことで、転職活動に活かしましょう。]]>