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

retrieve について

Sandbox または本番組織からクラスとトリガーを取得するには、retrieveCode ターゲットを使用します。通常のリリースサイクル中は、新しいクラスとトリガー用の正しいディレクトリ構造を取得するために、deploy の前に retrieveCode を実行します。ただし、次の例では、取得するものがあることを確認するために deploy が最初に使用されます。

既存の組織からクラスとトリガーを取得するには、次の構築ターゲットの例 ant retrieveCode に示すように retrieve ant タスクを使用します。

1<target name="retrieveCode">
2   <!-- Retrieve the contents listed in the file codepkg/package.xml into the codepkg directory -->
3   <sf:retrieve username="${sf.username}" password="${sf.password}" 
4        serverurl="${sf.serverurl}" retrieveTarget="codepkg" unpackaged="codepkg/package.xml"/>
5</target>

ファイル codepkg/package.xml は、取得されるメタデータコンポーネントをリストします。この例では、2 つのクラスと 1 つのトリガーを取得します。取得されたファイルはディレクトリ codepkg に配置され、ディレクトリ内に存在するものがすべて上書きされます。

取得タスクのプロパティは次のとおりです。

項目 説明
username sessionId が指定されていない場合は必須です。ログインに使用する Salesforce ユーザー名。この接続に関連付けられるユーザー名には、「メタデータ API 関数を使用したメタデータを変更」権限が必要です。
password sessionId が指定されていない場合は必須です。このプロジェクトに関連付けられた組織にログインするために使用するパスワード。セキュリティトークンを使用している場合は、パスワードの最後に 25 桁のトークン値を貼り付けます。
sessionId username および password が指定されていない場合は必須です。有効な Salesforce セッションの ID または OAuth アクセストークン。セッションは、ユーザーがユーザー名とパスワードを使用して正常に Salesforce にログインした後に作成されます。新しいセッションを作成するのではなく既存のセッションにログインする場合は、セッション ID を使用します。または、OAuth 認証のためのアクセストークンを使用します。詳細は、Salesforce ヘルプの「OAuth によるアプリケーションの認証」を参照してください。
serverurl 省略可能。Salesforce サーバーの URL (空白の場合、デフォルトは login.salesforce.com)。Sandbox インスタンスに接続するには、この値を test.salesforce.com に変更します。
retrieveTarget 必須。メタデータファイルを取得する先のディレクトリ構造のルート。
packageNames unpackaged が指定されていない場合は必須です。取得するパッケージ名のカンマ区切りのリストです。packageNames または unpackaged のいずれかを指定しますが、両方は指定できません。
apiVersion 省略可能。取得したメタデータファイルに使用するメタデータ API バージョン。デフォルトは、60.0 です。
pollWaitMillis 省略可能。デフォルトは 10000 です。取得要求の結果をポーリングする場合の試行間の待機時間 (ミリ秒単位) です。クライアントは、maxPoll で定義された制限に到達するまで引き続きポーリングします。
maxPoll 省略可能。デフォルトは 200 です。取得要求の結果を得るためにサーバーをポーリングする回数です。連続するポーリング試行間の待機時間は、pollWaitMillis で定義されます。
singlePackage 省略可能。デフォルトは true です。複数のパッケージを取得する場合は、このパラメーターを false に設定します。false に設定すると、パッケージごとに余分の最上位サブディレクトリが、取得された zip ファイルに含まれます。
trace 省略可能。デフォルトは false です。SOAP 要求と応答をコンソールに表示します。このオプションを選ぶと、ログイン時のユーザーのパスワードがプレーンテキストで表示されます。
unpackaged packageNames が指定されていない場合は必須です。取得するコンポーネントを指定するファイルマニフェストのパスと名前です。unpackaged または packageNames のいずれかを指定しますが、両方は指定できません。
unzip 省略可能。デフォルトは true です。true に設定すると、取得されたコンポーネントが展開されます。false に設定すると、取得されたコンポーネントが zip ファイルとして retrieveTarget ディレクトリに保存されます。