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

SignupRequest

新しい Trialforce サインアップへの要求を表します。このオブジェクトは、API バージョン 27.0 以降で使用できます。

1 日あたり 20 サインアップに制限されます。これ以上のサインアップを行う必要がある場合は、パートナーコミュニティでケースを登録します。

メモ

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

create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()undelete()

項目

項目名 詳細
AuthCode
string
プロパティ
Create、Filter、Group、Sort
説明
標準 Salesforce API を使用した OAuth アクセストークンと更新トークンと交換できるワンタイム認証コード。これは、指定された接続アプリケーションが X.509 証明書で設定されていない場合に、ConnectedAppCallbackUrl および ConnectedAppConsumerKey と共に使用されます。これは、サインアップ要求が処理されたときにシステムが提供する参照のみの項目です。この項目は API バージョン 29.0 以降で使用できます。
Company
string
プロパティ
Create、Filter、Group、Sort
説明
トライアルサインアップを要求する会社の名前。
ConnectedAppCallbackUrl
string
プロパティ
Create、Filter、Group、Sort
説明
ConnectedAppConsumerKey と共に使用する場合は、サインアップの作成中に自動的に承認される必要のある接続アプリケーションを指定します。この項目は、API バージョン 28.0 以降で使用できます。
ConnectedAppConsumerKey
string
プロパティ
Create、Filter、Group、Sort
説明
ConnectedAppCallbackUrl と共に使用する場合は、サインアップの作成中に自動的に承認される必要のある接続アプリケーションを指定します。この項目は、API バージョン 28.0 以降で使用できます。
Country
string
プロパティ
Create、Filter、Group、Sort
説明
英大文字 2 文字の ISO-3166 国コード。これらのコードの完全なリストは、www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html などのさまざまなサイトに掲載されています。トライアル組織の言語は、この項目の値に基づいて自動的に決定されます。
CreatedOrgId
string
プロパティ
Filter、Group、Nillable、Sort
説明
作成されたトライアル組織の 15 文字の組織 ID。これは、サインアップ要求が処理されたときにシステムが提供する参照のみの項目です。
CreatedOrgInstance
string
プロパティ
Filter、Group、Nillable、Sort
説明
新しいトライアル組織のサーバインスタンス。たとえば、「na8」など。この項目は、API バージョン 29.0 以降で使用できます。
Edition
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
トライアル組織を作成するために使用される Salesforce テンプレート。使用できる値は、[Partner Group]Professional[Partner Professional][Sales Professional][Professional TSO]Enterprise[Partner Enterprise][Service Enterprise][Enterprise TSO]Developer、および [Partner Developer] です。この項目は API バージョン 35.0 以降で使用できます。
ErrorCode
string
プロパティ
Filter、Group、Nillable、Sort
説明
サインアップ要求が失敗した場合のエラーコード。これは参照のみの項目であり、サポート用にシステムによって提供されます。
FirstName
string
プロパティ
Create、Filter、Nillable、Sort
説明
トライアルサインアップの管理ユーザの名。
LastName
string
プロパティ
Create、Filter、Group、Sort
説明
トライアルサインアップの管理ユーザの姓。
PreferredLanguage
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
作成されるトライアル組織の言語。Salesforce ヘルプの「サポート言語」の「完全サポート対象言語」に記載されている言語コードを使用して言語を指定します。たとえば、簡易中国語には zh_CN を使用します。ロケールで設定されている言語は、選択した値で上書きされます。無効な言語を指定すると、組織のデフォルトの言語である英語に設定されます。同様に、トライアルテンプレートに関連付けられた Salesforce エディションでサポートされていない言語を指定すると、トライアル組織のデフォルトの言語である英語に設定されます。この項目は、API バージョン 35.0 以降で使用できます。
ResolvedTemplateId
string
プロパティ
Filter、Group、Nillable、Sort
説明
サインアップ要求時に Salesforce の内部使用目的で入力されます。この項目は、API バージョン 35.0 以降で使用できます。
ShouldConnectToEnvHub
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
true に設定されると、トライアル組織が環境ハブに接続されます。サインアップはハブマスタ組織またはスポーク組織で行う必要があります。この項目は、API バージョン 35.0 以降で使用できます。
SignupEmail
email
プロパティ
Create、Filter、Group、Sort
説明
トライアルサインアップの管理ユーザのメールアドレス。
SignupSource
string
プロパティ
Create、Filter、Group、Nillable、Sort
説明
ユーザが指定した最大 60 文字のトライアルサインアップの説明。この項目は API バージョン 36.0 以降で使用できます。
Status
picklist
プロパティ
Defaulted on create、Filter、Group、Sort、Update
説明
要求の状況。使用できる値は、[新規][処理中][エラー]、または [成功] です。デフォルト値は、[新規] です。
Subdomain
string
プロパティ
Create、Filter、Group、Sort
説明
カスタムの [私のドメイン] を使用する場合の新しいトライアル組織のサブドメイン。最大文字数は、Developer Edition (DE) では 33 文字で、その他のすべてのエディションでは 40 文字です。これは、すべての DE 組織にサフィックスが追加されるためです。
SuppressSignupEmails
boolean
プロパティ
Filter、Group、Nillable、Sort
説明
true に設定されている場合、トライアル組織が作成されるときに、サインアップメールは送信されません。この項目はプロキシサインアップ機能に使用され、API バージョン 29.0 以降で使用できます。
TemplateId
string
プロパティ
Create、Filter、Group、Nillable、Sort
説明
トライアルサインアップの基礎となる Trialforce テンプレートの 15 文字の ID。このテンプレートは、Salesforce によって承認されている必要があります。エディションを指定しない場合、テンプレート ID は必須です。
TrialDays
anyType
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
トライアルサインアップの期間 (日単位)。承認済み Trialforce テンプレートのトライアル日数以下である必要があります。指定されていない場合、この値は Trialforce テンプレートで指定されたデフォルトのトライアル期間に設定されます。
TrialSourceOrgId
string
プロパティ
Filter、Group、Nillable、Sort
説明
Trialforce テンプレートが作成される元となった Trialforce ソース組織の 15 文字の組織 ID。
Username
string
プロパティ
Create、Filter、Group、Sort
説明
トライアルサインアップの管理ユーザのユーザ名。これは、RFC822 に指定されたアドレス規則 (www.w3.org/Protocols/rfc822/#z10) に従う必要があります。

使用方法

次の Java クラスでは REST API を使用して SignupRequest オブジェクトを作成します。Trialforce 管理組織に対して認証を行い、要求を SignupRequest オブジェクトにポスト送信します。

この例で指定が必要な変数を次に示します。
  • SERVER — Trialforce 管理組織 (TMO) のホストサーバ名 (“yourInstance.salesforce.com” など)。
  • USERNAME — TMO の管理ユーザ名。
  • PASSWORD — TMO の管理パスワードとセキュリティトークンを連結したもの。セキュリティトークンを含むメールを受け取るには、Salesforce の個人設定から、[私のセキュリティトークンのリセット] を選択し、[セキュリティトークンのリセット] をクリックします。  
  • CLIENT_ID — Salesforce の [設定] から、[クイック検索] ボックスに「アプリケーション」と入力し、[アプリケーション] を選択し、接続アプリケーションの下にある [新規] をクリックします。必須項目に値を入力し ([コールバック URL] は必須ですが、使用されていないので最初は任意の有効な URL に設定できます)、[選択した OAuth 範囲] セレクタで OAuth 範囲としてフルアクセスを選択し、[保存] をクリックします。次に [コンシューマ鍵] の値をコピーし、この変数に使用します。
  • CLIENT_SECRET — 同じページで [クリックして公開] をクリックします。次に [コンシューマの秘密] の値をコピーし、この変数に使用します。
1public class IsvSignupDriver {
2    private static final String SERVER = server_name:port;
3    private static final String USERNAME = tmo_username;
4    private static final String PASSWORD = tmo_passwordsecurity_token;
5    private static final String CLIENT_ID = consumer_key;
6    private static final String CLIENT_SECRET = consumer_secret;
7
8    private static SignupRequestInfo signupRequest = null;
9    
10    public static String createSignupRequest (SignupRequestInfo sr)
11      throws JSONException, IOException {
12    	  JSONObject createResponse = null;
13    	  signupRequest = sr;
14    	  JSONObject loginResponse = login(SERVER, USERNAME, PASSWORD);
15    	  String instanceUrl = loginResponse.getString("instance_url");
16    	  String accessToken = loginResponse.getString("access_token");
17    	  createResponse = create(instanceUrl, accessToken);
18    	  System.out.println("Created SignupRequest object: " + createResponse + "\n"); 
19    	  return createResponse.toString();
20    }
21
22    /* Authenticates to the TMO using the required credentials */
23
24    private static JSONObject login(String server, String username, String password)
25      throws ClientProtocolException, IOException, JSONException {
26        String authEndPoint = server + "/services/oauth2/token";
27        HttpClient httpclient = new DefaultHttpClient();
28        try {
29            HttpPost post = new HttpPost(authEndPoint);
30
31            List<NameValuePair> params = new ArrayList<NameValuePair>();
32            params.add(new BasicNameValuePair("grant_type", "password"));
33            params.add(new BasicNameValuePair("client_id", CLIENT_ID));
34            params.add(new BasicNameValuePair("client_secret", CLIENT_SECRET));
35            params.add(new BasicNameValuePair("username", username));
36            params.add(new BasicNameValuePair("password", password));
37            post.setEntity(new UrlEncodedFormEntity(params, Consts.UTF_8));
38
39            BasicResponseHandler handler = new BasicResponseHandler();
40            String response = httpclient.execute(post, handler);
41            return new JSONObject(response);
42        } finally {
43            httpclient.getConnectionManager().shutdown();
44        }
45    }
46    /* Posts a request to the SignupRequest object */
47
48    private static JSONObject create(String instanceUrl, String accessToken)
49      throws ClientProtocolException, IOException, JSONException {
50        HttpClient httpClient = new DefaultHttpClient();
51        try {
52            HttpPost post = new HttpPost(instanceUrl +
53              "/services/data/v27.0/sobjects/SignupRequest/");
54                post.setHeader("Authorization", "Bearer " + accessToken);
55                post.setHeader("Content-Type", "application/json");
56            
57                JSONObject requestBody = new JSONObject();
58                requestBody.put("TemplateId", signupRequest.getTemplateID());
59                requestBody.put("SignupEmail", signupRequest.getEmail());
60                requestBody.put("username", signupRequest.getUsername());
61                requestBody.put("Country", "US");
62                requestBody.put("Company", signupRequest.getCompanyName());
63                requestBody.put("lastName", signupRequest.getLastName());        
64
65                StringEntity entity = new StringEntity(requestBody.toString());
66                post.setEntity(entity);
67                BasicResponseHandler handler = new BasicResponseHandler();
68                String response = httpClient.execute(post, handler);
69                return new JSONObject(response);
70        } finally {
71            httpClient.getConnectionManager().shutdown();
72        }
73    }
74}

エラーコード

サインアップが失敗した場合、システムで原因の特定に役立つエラーコードが生成されます。次の表は最も重要なエラーコードの一覧です。

エラーコード 説明
C-1007 ユーザ名が重複しています。
C-1015 新しい組織の [私のドメイン] 設定を構成するときにエラーが発生しました。Salesforce サポートにお問い合わせください。
C-1016 プロキシサインアップの OAuth 接続アプリケーションを設定しているときにエラーが発生しました。接続アプリケーションに有効なコンシューマキー、コールバック URL、および期限が切れていない証明書 (該当する場合) があることを確認してください。
C-1018 サインアップ中に無効なサブドメイン値が指定されました。
C-1019 サブドメインが使用中です。新しいサブドメイン値を選択してください。
C-9999 汎用の「致命的なエラー」です。Salesforce サポートにお問い合わせください。
S-1006 メールアドレスが無効です (メールアドレス形式が不正)。
S-2006 国コードが無効です。
T-0001 テンプレート ID が無効です (形式が 0TTxxxxxxxxxxxx ではない)。
T-0002

テンプレートが見つかりません。テンプレートが存在しないか (削除された可能性がある)、または適切なバージョンが存在しません。

T-0003 Salesforce でテンプレートの使用が承認されていません。