この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

ContentVersion

Salesforce CRM Content のドキュメントまたは Salesforce Files の特定のバージョンを表します。Salesforce CRM Content ドキュメントでは、バージョン 17.0 以降でこのオブジェクトを使用できます。Salesforce Files では、バージョン 20.0 以降でこのオブジェクトを使用できます。

24 時間に公開できるバージョンの最大数は 200,000 です。

サポートされているコール

create()describeLayout()describeSObjects()query()retrieve()search()update()upsert()

特別なアクセスルール

  • カスタマーポータルユーザおよびパートナーポータルユーザが、アクセス権を持つライブラリのコンテンツをクエリするには、「ポータルのコンテンツの参照」権限が必要です。
  • カスタマーポータルユーザ、およびパートナーポータルユーザは、Salesforce CRM Content 機能のライセンスを持っている場合にのみ、ドキュメントの公開、バージョン作成、編集を実行できます。
  • コンテンツ機能のライセンスを持つすべてのユーザは、個人ライブラリでバージョンを作成できます。
  • ユーザ (「すべてのデータの参照」権限を持つユーザを含む) は、自分がアクセス権を持つファイルに対してのみクエリを実行できます。次に例を挙げます。
    • ライブラリの権限に関係なく、自分がメンバーであるライブラリと個人ライブラリのすべての Salesforce CRM Content ファイル (API バージョン 17.0 以降)。
    • 自分が所有しているか、プロファイルに投稿したか、参照可能なグループに投稿したか、直接共有しているすべての Salesforce Files (API バージョン 21.0 以降)。
  • すべてのユーザは、自身の個人ライブラリでバージョンを更新できます。
  • ライブラリの権限に関係なく、ライブラリのメンバーであれば、バージョンまたはドキュメントの所有者はドキュメントを更新できます。
  • Salesforce CRM Content ドキュメントを更新するには、ユーザは次のライブラリ権限が有効なライブラリのメンバーである必要があります。
    • 「コンテンツの追加」
    • 「コンテンツの代理追加」
    • 「ライブラリの管理」
  • FileType は、リンクの ContentUrl またはドキュメントの PathOnClient のいずれかで定義されます。
  • API バージョン 34.0 以降では、ファイルが Chatter からであるか Salesforce CRM Content からであるかに関わらず、任意のファイルをライブラリと共有できます。
  • API バージョン 39.0 以降では、ドキュメントへのアクセスを制御可能なカスタム Apex ダウンロードハンドラを作成できます。詳細は、『Apex コード開発者ガイド』を参照してください。

項目

項目 詳細
Checksum
string
プロパティ
Filter、Group、Nillable、Sort
説明
ファイルの MD5 チェックサム。
ContentBodyId
種別
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
アップロードされているファイル Blob とは関係なく、ファイルバージョンを挿入できます。この項目は、クエリと挿入でのみ使用できます。ContentBody レコードのみを参照できます。この項目は、API バージョン 40.0 以降で使用できます。
ContentDocumentId
reference
プロパティ
Create、Filter、Group、Sort
説明
ドキュメントの ID。
ContentLocation
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort
説明
ドキュメントの発生源。有効な値は、次のとおりです。
  • S — ドキュメントは Salesforce 内にあります。表示ラベルは Salesforce です。
  • E — ドキュメントは Salesforce 外にあります。表示ラベルは External です。
  • L — ドキュメントはソーシャルネットワークにあり、ソーシャルカスタマーサービスを使用してアクセスします。表示ラベルは [ソーシャルカスタマーサービス] です。
ContentModifiedById
reference
プロパティ
Filter、Group、Nillable、Sort
説明
ドキュメントを変更したユーザの ID。
ContentModifiedDate
dateTime
プロパティ
Create、Filter、Nillable、Sort
説明

ドキュメントが変更された日付。

ContentModifiedDate は、ドキュメントの名前が変更されたり、新規ドキュメントバージョンがアップロードされたりした場合などに更新されます。ドキュメントの最初のバージョンをアップロードするとき、ContentModifiedDate は現在時刻または過去の任意の時刻に設定できます。

ContentSize
int
プロパティ
Filter、Group、Nillable、Sort
説明
ドキュメントのサイズ (バイト単位)。リンクについては常に 0 です。
ContentUrl
url
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
リンクの URL。リンクに対してのみ設定されます。FileType を決定する項目の 1 つ。API バージョン 41.0 以降の文字数制限は 1,300 文字です。API バージョン 32.0 以前の文字数制限は 255 文字です。
Description
textarea
プロパティ
Create、Filter、Nillable、Sort、Update
説明
コンテンツバージョンの説明。
Division
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
組織のデータの論理セグメントです。たとえば、会社がさまざまな事業単位によって構成されている場合、「北米」、「ヘルスケア」、「コンサルティグ」など、各事業単位のディビジョンを作成することができます。組織でディビジョン権限が有効化されている場合にのみ使用可能です。
ExternalDataSourceId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
ExternalDataSource オブジェクトで参照される外部ドキュメントの ID。
ExternalDocumentInfo1
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
ファイルの URL を外部コンテンツリポジトリに保存します。外部ソースからのインテグレーションによってこの文字列のコンテンツが決まります。参照またはコピーが作成された後、次の操作を行うと外部ファイルの URL が更新されます。
  • ファイル参照を Lightning Experience に再公開する。
  • ドキュメントを開く。
  • reuseReference が true に設定された Chatter REST API でファイル参照を作成する。
ファイルが更新されると、共有リンクが最新バージョンに更新されます。
ExternalDocumentInfo2
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
外部ファイル ID が含まれます。この文字列のコンテンツは Salesforce によって決定され、非公開です。コンテンツは、外部システムに応じて通知なく変更されることがあります。ファイル参照の作成後は、ファイルパスが変更されてもこの項目は更新されません。
FeaturedContentBoost
int
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。ドキュメントを「主要」としてマークします。
FeaturedContentDate
date
プロパティ
Filter、Group、Nillable、Sort
説明
主要ドキュメントに指定された日付。
FileExtension
string
プロパティ
Filter、Group、Nillable、Sort
説明

ドキュメントのファイル拡張子。

この項目は API バージョン 31.0 以降で使用できます。

FileType
string
プロパティ
Filter、Group、Sort
説明
リンクの ContentUrl またはドキュメントの PathOnClient によって指定されたコンテンツの種類。
FirstPublishLocationId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明

バージョンが最初に公開された場所の ID。バージョンが最初にユーザの個人ライブラリまたは [私のファイル] に公開された場合、項目には個人ライブラリまたは [私のファイル] を所有するユーザの ID が入力されます。バージョンが最初に公開ライブラリに公開された場合、項目にはそのライブラリの ID が入力されます。

ContentDocumentLink でサポートされるすべて (レコードやグループなど、ファイルを添付できるものすべて) のレコード ID を受け入れます。

FirstPublishLocationId を設定すると、ファイルを作成して、それを 1 つのトランザクション内の初期レコード/グループと共有できます。また、オプションとして、後で追加のリンクを作成してファイルを他のレコードやグループと共有することもできます。ファイルは、作成されると自動的にレコードにリンクされ、PublishStatus が Pending/Personal から Public に変わります。

この項目は、API を介してバージョンが最初に公開されたときにのみ設定されます。新しいコンテンツバージョンが挿入されたときに、FirstPublishLocationId を別の ID に設定することはできません。

IsAssetEnabled
boolean
プロパティ
Create、Group、Defaulted on create
説明
ContentVersion の挿入時に指定すると、ContentDocument ファイルを自動的に ContentAsset に変換できます。この項目には SOQL クエリを実行できますが、編集できません。この項目は、API バージョン 38.0 以降で使用できます。
IsEncrypted

この情報は、従来の暗号化ではなく Shield プラットフォームの暗号化について書かれています。

メモ

boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
ファイルが Shield プラットフォームの暗号化を使用して暗号化されているか (true)、否か (false) を示します。この項目は、API バージョン 34.0 以降で使用できます。
IsLatest
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
最新バージョンのドキュメントか (true)、否か (false) を示します。
IsMajorVersion
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
ドキュメントがメジャーバージョンの場合は true、ドキュメントがマイナーバージョンの場合は false。メジャーバージョンを置き換えることはできません。
Language
picklist
プロパティ
Create、Filter、Nillable、Restricted picklist、Update
説明
ドキュメントの言語。複数言語のサポートを有効にしていない限り、この項目はユーザの言語にデフォルト設定されています。

返されるラベルの言語を指定します。値は、de_DEen_GB など有効なユーザロケール (言語および国) である必要があります。ロケールについての詳細は、CategoryNodeLocalization オブジェクトの Language 項目を参照してください。

NegativeRatingCount
int
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。異なるユーザがドキュメントに反対投票した回数。

最新バージョンの評価カウントは、バージョンに個別のものではありません。バージョン 1 が 10 件の反対投票を受け、バージョン 2 が 2 件の反対投票を受けた場合、バージョン 2 の NegativeRatingCount は 12 となります。ただし、評価カウントは、過去のバージョンに対し影響はありません。バージョン 1 の NegativeRatingCount は 10 となります。

NetworkId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
このファイルが作成されたコミュニティの ID。組織で Salesforce Communities が有効化されている場合、この項目は API バージョン 26.0 以降で使用できます。

NetworkId は、ファイルの作成時にのみ追加できます。既存のファイルの場合、NetworkId の変更や追加はできません。

Origin
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
コンテンツのバージョンのソース。有効な値は、次のとおりです。
  • C — ユーザの個人ライブラリからのコンテンツドキュメント。表示ラベルは Content です。FirstPublishLocationId はユーザの ID である必要があります。FirstPublishLocationId が空白のままである場合は、デフォルトはユーザの ID になります。
  • H — ユーザの [私のファイル] の Salesforce ファイル。表示ラベルは Chatter です。FirstPublishLocationId はユーザの ID である必要があります。FirstPublishLocationId が空白のままである場合は、デフォルトはユーザの ID になります。組織で Chatter が有効である場合は、Origin は H のみに設定できます。
この項目のデフォルトは C です。表示ラベルは Content Origin です。
OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
このドキュメントの所有者の ID。
PathOnClient
string
プロパティ
Create、Filter、Nillable、Sort
説明
ドキュメントの完全パス。FileType を決定する項目の 1 つ。

ドキュメントを [プレビュー] タブに表示するには、パスの拡張子を含む完全パスを指定します。

メモ

PositiveRatingCount
int
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。異なるユーザがドキュメントに賛成投票した回数。

最新バージョンの評価カウントは、バージョンに個別のものではありません。バージョン 1 が 10 件の賛成投票を受け、バージョン 2 が 2 件の賛成投票を受けた場合、バージョン 2 の PositiveRatingCount は 12 となります。ただし、評価カウントは、過去のバージョンに対し影響はありません。バージョン 1 の PositiveRatingCount は 10 となります。

PublishStatus
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
ドキュメントが公開されているかどうか、そしてその公開方法を示します。有効な値は、次のとおりです。
  • P — ドキュメントは公開ライブラリに公開され、他のユーザも参照できます。表示ラベルは Public です。
  • R — ドキュメントは個人ライブラリに公開され、他のユーザは参照できません。表示ラベルは Personal Library です。
  • U — 公開が中断されたため、ドキュメントは公開されません。表示ラベルは Upload Interrupted です。
RatingCount
int
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。賛成の評価数と反対の評価数の合計。
ReasonForChange
string
プロパティ
Create、Filter、Nillable、Sort、Update
説明
ドキュメントが変更された理由。新しいバージョン (修正) ドキュメントを挿入する場合にのみ、この項目を設定できます。
RecordTypeId
reference
プロパティ
Create、Filter、Nillable、Update
説明
バージョンのレコードタイプの ID。
カスタム項目は RecordTypeId で制限されます。管理者が API を使用してカスタム項目を作成する場合、少なくとも 1 つのページレイアウトに追加する必要があります。
  • カスタム項目を「一般情報」レコードタイプに関連付けられたページレイアウトに追加する場合、そのレコードタイプに対応する RecordTypeId は、該当のバージョンのレコードに設定する必要はありません。
  • カスタム項目をカスタムレコードタイプに関連付けられたページレイアウトに追加する場合、そのレコードタイプに対応する RecordTypeId を該当のバージョンのレコードに設定する必要があります。
SharingOption
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Restricted picklist、Sort、Update
説明
ファイルの共有が凍結されるかどうかを制御します。ファイルに対する「コラボレータ」アクセス権のあるシステム管理者とファイル所有者のみが、この項目を変更できます。デフォルトは Allowed で、新しい共有が可能であることを意味します。Restricted に設定されているときは新しい共有が阻止されますが、既存の共有には影響ありません。

この項目は、API バージョン 35.0 以降で使用できます。

SharingPrivacy
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Restricted picklist、Sort、Update
説明
ファイルの共有プライバシーを制御します。ファイルに対する「コラボレータ」アクセス権のあるシステム管理者とファイル所有者のみが、この項目を変更できます。デフォルトは [レコードへのアクセス権を持つすべてのユーザが参照可能] です。[レコードで非公開] に設定された場合、ファイルはレコードで非公開になりますが、他のユーザと選択的に共有できます。

この項目は、API バージョン 41.0 以降で使用できます。

TagCsv
textarea
プロパティ
Create、Nillable、Sort、Update
説明
API によってタグをコンテンツのバージョンに適用するために使用するテキスト。
TextPreview
string
プロパティ
Nillable、Filter、Group、Sort
説明
ドキュメントのプレビュー。API バージョン 35.0 以降で利用できます。
Title
string
プロパティ
Create、Filter、Group、Sort、Update
説明

ドキュメントのタイトル。

VersionData
base64
プロパティ
Create、Nillable、Update
説明
符号化されたファイルデータ。この項目はリンクには設定できません。SOAP API を使用してアップロードできるファイルの最大サイズは 50 MB です。ドキュメントが API を使用してアップロードまたはダウンロードされると、base64 に変換され、VersionData に格納されます。この変換により、ドキュメントサイズは約 37% 増加します。アップロードする予定のファイルが 50 MB 未満になるように base64 変換による増加を考慮する必要があります。カスタム Apex ダウンロードハンドラが有効な場合、この項目に API からアクセスしたときにダウンロードが許可されていないと、Salesforce は CONTENT_CUSTOMIZED_DOWNLOAD_EXCEPTION エラーを返します。
VersionNumber
string
プロパティ
Filter、Group、Nillable、Sort
説明
バージョン番号。たとえば、1、2、3 のように、ドキュメントのバージョン番号が増加します。

使用方法

  • このオブジェクトを使用して、Salesforce CRM Content ドキュメントまたは Salesforce ファイルの特定バージョンを作成、クエリ、取得、検索、編集、更新します。ContentDocument オブジェクトを使用して、ライブラリのドキュメント (コンテンツパックを除く) または Salesforce ファイルの最新バージョンを取得、クエリ、更新、削除します。
  • このオブジェクトを使用して、Salesforce ファイルの特定バージョンを作成、クエリ、取得、検索、編集および更新します。ContentDocument オブジェクトを使用して、Salesforce ファイルの最新バージョンを取得、クエリ、更新、削除します。
  • レコードとのみ共有されているファイルをクエリするには、ファイルのコンテンツ ID を指定する必要があります。
  • Salesforce Files にすべての項目を設定できるわけではありません。
  • 最新バージョンで公開されている場合にのみ、バージョンを更新できます。
  • バージョンをアーカイブすることはできません。
  • API バージョン 32.0 以降では、バージョンのレコードタイプを更新できます。
  • API を使用してバージョンを削除することはできません。
  • SOAP API を使用してアップロードできるファイルの最大サイズは 50 MB です。ドキュメントが API を使用してアップロードまたはダウンロードされると、base64 に変換され、VersionData に格納されます。この変換により、ドキュメントサイズは約 37% 増加します。アップロードする予定のファイルが 50 MB 未満になるように base64 変換による増加を考慮する必要があります。
  • API を使用してドキュメントをダウンロードするには、ドキュメントの VersionData をエクスポートする必要があります。これにより、ダウンロード数は増えません。
  • データローダを使用してドキュメントをローカルドライブからアップロードする場合、VersionData および PathOnClient で実際のパスを指定する必要があります。VersionData は場所を示し、形式を抽出します。PathOnClient はアップロードされるドキュメントの種類を示します。
  • ContentVersion オブジェクトに対する SOQL クエリではドキュメントのすべてのバージョンを返します。ContentVersion オブジェクトに対する SOSL 検索ではドキュメントの最新のバージョンを返します。
  • API でバージョンをクエリする場合、Upload InterruptedPublishStatus を指定したバージョンは返されません。
  • 個人ライブラリに公開されたドキュメントは、ドキュメントを公開したユーザのユーザプロファイルで設定されているデフォルト (ユーザプロファイルでデフォルトが設定されていない場合は一般情報) のレコードタイプを想定しています。

    管理者は、デフォルトの (コンテンツバージョンレイアウト) ページレイアウトの名前を変更できます。

    メモ

  • Contact Manager Edition、Group Edition、Professional Edition、Enterprise Edition、Unlimited Edition、および Performance Edition を使用するお客様は、24 時間につき最大で 200,000 件の新しいバージョンを公開できます。Developer Edition とトライアル版のお客様は、24 時間につき最大で 2,500 件の新しいバージョンを公開できます。
  • カスタム入力規則を使用すると、API を使用して個人ライブラリに公開されたドキュメントの更新ができなくなります。

ContentVersion レコードへのタグの適用

Enterprise API または Partner API を使用して、タグを ContentVersion レコードに適用できます。

タグを ContentVersion レコードに適用するには、TagCsv 項目で値を設定します。たとえば、この項目を one,two,three に設定すると、そのバージョンに 3 つのタグが作成され、関連付けられます。

  • TagCsv 項目の最大長は、2,000 文字です。
  • 各タグの最大長は、100 文字です。
  • タグがバージョンに適用されると、コンテンツには自動的にインデックスが付けられ、タグが検索可能になります。
  • 個人ライブラリに公開されている TagCsv にタグを適用することはできません。
  • ContentDocument オブジェクトを使用してタグを適用できません。
  • タグ名は変更や削除はできません。ドキュメントからタグを除外することはできますが、タグは削除されません。
  • タグでは、大文字と小文字は区別されません。大文字と小文字を変えたとしても、2 つのタグに同じ名前を付けることはできません。元のタグの大文字と小文字が常に使用されます。

ContentVersion レコードからタグを削除するには、標準の API 更新を実行し、削除する TagCsv 項目から値を削除します。たとえば、元の TagCsvone,two,three である場合、TagCsvone,three を指定して API 更新を実行すると、two が削除されます。ContentVersion からすべてのタグを削除するには、項目を null に設定して、標準の API 更新を実行します。

ContentVersion レコードを作成し、API を使用して修正する場合、別の ContentVersion レコードを挿入しますが、元のものと同じ ContentDocument レコードと関連付けます。これにより、タギングに次のような影響を与えます。
  • TagCsv 項目で修正を追加し、値を設定しない場合、以前のバージョンに適用されたすべてのタグが自動的に新しいバージョンに適用されます。
  • 修正を加えて新しい TagCsv 項目を指定する場合、タグは移行せず、指定したタグが代わりに適用されます。

ContentVersion レコードに SOQL クエリを実行して、TagCsv 項目を選択すると、そのレコードに関連付けられたすべてのタグが返されます。文字列のタグは、異なる順序で挿入された場合でも、アルファベット順に並びます。TagCsv 項目は、SOQL クエリの条件の一部として使用することはできません。組織内のすべてのタグにクエリを実行できるわけではありません。

ライブラリのタギングルール:

  • API によるタギングでは、ドキュメントが公開されているライブラリのタギング制限が適用されます。たとえば、ライブラリが制限タギングモードで、タグ one,three のみを使用できる場合、one,two,threeTagCsv のバージョンは保存できません。
  • ライブラリがガイド付きタギングモードの場合、タグを ContentVersion に適用できます。ライブラリではガイド付きタグの値をクエリすることはできませんが、ライブラリのタギングモデルをクエリすることは可能です。