SOAP API 開発者ガイド
jパッケージバージョン設定
API クライアントが管理パッケージのコンポーネントを参照する場合、インテグレーションで参照するインストールする各パッケージのバージョンを指定できます。これにより、後続バージョンのパッケージをインストールしても、API クライアントは継続して、特定で、既知の動作によって機能することができます。PackageVersionHeader SOAP ヘッダーを使用して、必要に応じてさまざまなコールにそれぞれのパッケージバージョンを設定できます。
パッケージバージョンは、パッケージでアップロードされる一連のコンポーネントを特定する番号です。バージョン番号の形式は majorNumber.minorNumber.patchNumber (例: 2.1.3) です。メジャー番号とマイナー番号は、毎回のメジャーリリース時に指定した値に増えます。patchNumber は、パッチリリースにのみ生成および更新されます。公開者は、パッケージバージョンを使用して後続のパッケージバージョンをリリースすることにより、管理パッケージのコンポーネントを適切にアップグレードできます。そのパッケージを使用する既存の顧客のインテグレーションに影響を与えることもありません。
パッケージバージョンが API コールで指定されていない場合、API コールのデフォルトのパッケージバージョンによって代替システム設定が指定されます。多くの API クライアントにはパッケージのバージョン情報がないため、デフォルトの設定がこれらのクライアントの既存の動作を保持します。
Enterprise API コールおよび Partner API コールにデフォルトのパッケージバージョンを指定できます。Enterprise WSDL は、Salesforce 組織のみとのインテグレーションを構築する顧客を対象とします。非常に強い型付けで、int や string など特定のデータ型のオブジェクトや項目を指定して呼び出します。Partner WSDL は、カスタムオブジェクトやカスタム項目に関係なく、複数の Salesforce 組織にわたって機能するインテグレーションを構築する顧客、パートナー、および ISV を対象とします。あまり強い型付けでなく、特定のデータ型に依存せずに項目名と値の名前-値ペアで呼び出します。
Enterprise WSDL では、既存のクライアントの処理を維持するために、特定のパッケージバージョンと関連付ける必要があります。Enterprise WSDL または Partner WSDL のいずれかを使用してクライアントアプリケーションから API コールのパッケージバージョンのバインド設定を行うことができます。Enterprise WSDL に基づき、クライアントアプリケーションから発行される API コールのパッケージバージョン情報は、次のうち、最初に一致する設定によって決定されます。
- PackageVersionHeader SOAP ヘッダー。
- serverName/services/Soap/c/api_version/ID の形式で URL が指定されている SOAP エンドポイント。api_version は、44.0 など API のバージョンを示し、ID は、Enterprise WSDL の生成時にパッケージバージョンの選択内容を符号化したものです。
- Enterprise パッケージバージョンのデフォルト設定です。
Partner WSDL より柔軟で、複数の組織とのインテグレーションに使用されます。デフォルトのパートナーパッケージバージョンを設定時、パッケージバージョンに [指定なし] オプションを選択すると、最新バージョンのインストールパッケージによって、処理が定義されます。つまり、パッケージがアップグレードし、その変更がすぐにインテグレーションに影響を与える場合、Apex トリガなどパッケージコンポーネントの処理が異なる場合があります。パッケージバージョンの後続のインストールによって、既存のインテグレーションに影響のないよう、登録ユーザは、クライアントアプリケーションから、すべての Partner API コールのインストールパッケージの特定バージョンを選択する必要があります。
Partner API コールのパッケージバージョン情報は、次のうち、最初に一致する設定によって決定されます。
- PackageVersionHeader SOAP ヘッダー。
- Visualforce ページのパッケージバージョン設定を使用する Visualforce ページからの API コール。
- パートナーパッケージバージョンのデフォルト設定。
API コールのデフォルトパッケージバージョンを設定する手順は、次のとおりです。
- [設定] から、[クイック検索] ボックスに「API」と入力し、[API] を選択します。
- [Enterprise パッケージバージョンの設定] または [パートナーパッケージバージョンの設定] をクリックします。これらのリンクは、組織に管理パッケージを少なくとも 1 つインストールしている場合にのみ使用できます。
- インストールした管理パッケージの [パッケージバージョン] を選択します。選択するパッケージバージョンがわからない場合、デフォルトの選択内容に従います。
- [保存] をクリックします。