メタデータ API 開発者ガイド
jPackage
retrieve() コールの一部として取得するメタデータコンポーネントを指定するか、コンポーネントのパッケージを定義します。
| 名前 | 型 | 説明 |
|---|---|---|
| apiAccessLevel | APIAccessLevel (string 型の列挙) | パッケージコンポーネントは、ダイナミック Apex および API 経由でインストールされている組織にある標準オブジェクトやカスタムオブジェクトにアクセスできます。パッケージをインストールするシステム管理者は、セキュリティの向上のために、インストール後のこうしたアクセスを制限できます。有効な値は、次のとおりです。
詳細は、Salesforce ヘルプの「パッケージの API アクセスおよびダイナミック Apex アクセス」を参照してください。 |
| description | string | パッケージの簡単な説明。 |
| fullName | string | API アクセスの一意の識別子として使用されるパッケージ名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。 |
| namespacePrefix | string | パッケージが作成された開発組織の名前空間。 |
| objectPermissions | ProfileObjectPermissions[] | パッケージにアクセスできるオブジェクトと使用可能なアクセス権の種類 (作成、参照、更新、削除) を示します。 |
| packageType | string | 将来の使用のために予約されています。 |
| postInstallClass | string | パッケージをインストールまたはアップグレードした後に実行するアクションを指定する Apex クラスの名前。Apex クラスはパッケージのメンバーである必要があり、Apex InstallHandler インターフェースを実装しなければなりません。パッチアップグレードでは、この項目のクラス名を変更できませんが、Apex クラスのコンテンツは変更できます。メジャーアップグレードではクラス名を変更できます。 この項目は、API バージョン 24.0 以降で使用できます。 |
| setupWeblink | string | パッケージのインストールの説明に使用する Web リンク。 |
| types | PackageTypeMembers[] | 取得するコンポーネントの種類。 |
| uninstallClass | string | パッケージをアンインストールした後に実行するアクションを指定する Apex クラスの名前。Apex クラスはパッケージのメンバーである必要があり、Apex UninstallHandler インターフェースを実装しなければなりません。パッチアップグレードでは、この項目のクラス名を変更できませんが、Apex クラスのコンテンツは変更できます。メジャーアップグレードではクラス名を変更できます。 この項目は、API バージョン 25.0 以降で使用できます。 |
| version | string | 必須。コンポーネントの種類のバージョン。 |
PackageTypeMembers
パッケージで取得されるコンポーネントの名前と種類を指定するために使用します。
| 名前 | 型 | 説明 |
|---|---|---|
| members | string |
<name> 要素で指定されている全種類のメタデータコンポーネントを取得する、1 つ以上の名前を指定したコンポーネント、またはワイルドカード文字 (*)。標準オブジェクトを取得するには、そのオブジェクトを名前で指定します。たとえば、<members>Account</members> では標準の Account オブジェクトを取得します。 |
| name | string |
取得するメタデータコンポーネントの種類。たとえば、<name>CustomObject</name> では <members> 要素で指定されている 1 つ以上のカスタムオブジェクトを取得します。 |
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。