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

カスタム Big Object の定義とリリース

メタデータ API を使用するか [設定] で、カスタム Big Object を定義できます。Big Object を定義してリリースしたら、[設定] で Big Object を表示したり、項目を追加したりできます。Big Object をリリースした後、インデックスを編集または削除することはできません。インデックスを変更するには、新しい Big Object で最初からやり直します。このトピックでは、メタデータ API を使用して Big Object を定義およびリリースする方法について説明します。[設定] を使用するには、Salesforce ヘルプを参照してください。

使用可能なインターフェース: Salesforce Classic および Lightning Experience の両方

使用可能なエディション: Enterprise Edition、Performance Edition、Unlimited Edition、および Developer Edition (最大 100 万件のレコード)

追加のレコード容量と非同期 SOQL クエリはアドオンライセンスとして使用できます。

カスタム Big Object の定義

メタデータ API でカスタム Big Object を定義します。これを行うには、その定義、項目、インデックスが含まれる XML ファイルを作成します。

object ファイル — オブジェクトごとにファイルを作成し、カスタム Big Object とその項目およびインデックスを定義します。
permissionset/profile ファイル — permissionSet または profile ファイルを作成し、各項目の権限を指定します。これらのファイルは必須ではありませんが、アクセス権をユーザに付与する場合に必要になります。デフォルトでは、カスタム Big Object へのアクセスは制限されています。
package ファイル — メタデータパッケージのファイルを作成し、コンテンツを指定します。

カスタム Big Object では「CustomObject」メタデータ型を使用しますが、Big Object に固有のパラメータや該当しないパラメータがあります。Big Object に適用される特定のメタデータパラメータの概要については、このドキュメントを参照してください。

メモ

カスタム Big Object の命名規則

オブジェクト名は、組織の標準オブジェクト、カスタムオブジェクト、外部オブジェクト、Big Object 全体で一意である必要があります。API では、カスタム Big Object の名前に 2 つのアンダースコアと、そのすぐ後に続く小文字の「b」のサフィックスが含まれます。たとえば、「HistoricalInventoryLevels」という名前の Big Object は、組織の WSDL では HistoricalInventoryLevels__b と表示されます。オブジェクトの表示ラベルは、組織のオブジェクト (標準オブジェクト、カスタムオブジェクト、外部オブジェクト、Big Object) 全体で一意にすることをお勧めします。

CustomObject メタデータ

項目名	データ型	説明
`deploymentStatus`	DeploymentStatus (string 型の列挙)	カスタム Big Object のリリース状況 (すべての Big Object で `Deployed`)
`fields`	CustomField[]	オブジェクト内の項目の定義
`fullName`	string	項目の一意の API 参照名
`indexes`	Index[]	インデックスの定義
`label`	string	UI に表示されるオブジェクトの名前
`pluralLabel`	string	UI に表示される項目の複数形の名前

CustomField メタデータ

項目名	データ型	説明
`fullName`	string	項目の一意の API 参照名。
`label`	string	UI に表示される項目名。
`length`	int	項目の文字数 (Text と LongTextArea 項目のみ)。1 つのインデックス内のすべてのテキスト項目の文字数の合計が 50 を超えることはできません。この値を増やすには、Salesforce カスタマーサポートにお問い合わせください。
`pluralLabel`	string	UI に表示される項目の複数形の名前。
`precision`	int	数値の桁数。たとえば、数値 256.99 の精度は 5 です (数値項目のみ)。
`referenceTo`	string	参照項目の関連オブジェクト種別 (参照項目のみ)。
`relationshipName`	string	UI に表示されるリレーションの名前 (参照項目のみ)。
`required`	boolean	項目が必須かどうかを指定します。インデックスに含まれる項目はすべて必須としてマークする必要があります。
`scale`	int	数値の小数点の右側の桁数。たとえば、数値 256.99 のス��ールは 2 です (数値項目のみ)。
`type`	FieldType	データ型。DateTime、Lookup、Number、Text、LongTextArea がサポートされています。

ユニーク性は、カスタム項目ではサポートされていません。

メモ

Index メタデータ

カスタム Big Object 内に定義されたインデックスを表します。カスタム Big Object の複合主キー (インデックス) を定義するには、このメタデータ型を使用します。

項目名	データ型	説明
fields	IndexField[]	インデックスの項目の定義。

IndexField メタデータ

インデックスを構成する項目、順序、並び替え方向を定義します。項目を定義する順序によって、インデックスにリストされる項目の順序が決まります。

1 つのインデックス内のすべてのテキスト項目の文字数の合計が 50 を超えることはできません。この値を増やすには、Salesforce カスタマーサポートにお問い合わせください。

メモ

項目名	データ型	説明
name	string	必須。インデックスに含まれる項目の API 参照名。この値は、fields セクションの項目の `fullName` の値と一致していて、必須としてマークされている必要があります。
sortDirection	string	必須。インデックスの項目の並び替え方向。有効な値は、`ASC` (昇順) と `DESC` (降順) です。

リリース用のメタデータファイルの作成

次の XML の抜粋では、パッケージとしてリリースできるメタデータファイルを��成しています。各 Customer Interaction オブジェクトは、オンラインビデオゲームの 1 つのセッションの顧客データを表しています。Account__c、Game_Platform__c、Play_Date__c 項目でインデックスが定義され、参照項目によって Customer Interaction オブジェクトが Account オブジェクトに関連付けられています。

Customer_Interaction__b.object
package.xml
Customer_Interaction_BigObject.permissionset

メタデータパッケージとしてのカスタム Big Object のリリース

メタデータ API を使用して、カスタム Big Object をリリースします。ワークベンチや Ant 移行ツールなどのさまざまなツールを使用してリリースできます。パッケージを構築してカスタム Big Object をリリースする場合、object ファイルが「objects」というフォルダにあり、permissionset ファイルが「permissionsets」というフォルダにあることを確認します。package.xml は、パッケージ内のフォルダではなく、ルートディレクトリにある必要があります。

checkOnly リリースオプションを使用して、テストリリースを実行できます。ワークベンチで、[Deploy (リリース)] 画面の [Check Only (チェックのみ)] オプションを選択します。

メモ

ワークベンチのチェックボックス

[設定] でのカスタム Big Object の表示

リリースしたカスタム Big Object を表示するには、組織にログインして、[設定] から [クイック検索] ボックスに 「Big Object」 と入力し、[Big Object] を選択します。

Big Object のリスト

Big Object の名前をクリックすると、その項目とリレーションが表示されます。

Big Object の詳細ビュー

Salesforce および Lightning プラットフォームのオブジェクトリファレンス