ステップ 2: Pardot API を使用して要求を発行する

API へのほとんどの要求では、標準化された形式が使用されます。すべての要求では、HTTP GET または POST を使用する必要があります。SSL の使用により GET 要求は安全ですが、注意を要するか長いパラメータ値が POST メッセージ本文に含まれている場合は、POST の使用をお勧めします。次のコンポーネントを使用して、要求を発行する必要があります。

1POST: https://pi.pardot.com/api/object/version/3/do/operator/identifier_field/identifier
2
3message body: api_key=your_api_key&user_key=your_user_key&parameters_for_request
4
5
6
7GET: https://pi.pardot.com/api/object/version/3/do/operator/identifier_field/identifier
8
9?api_key=your_api_key&user_key=your_user_key&parameters_for_request

format と parameters_for_request を除き、すべてのパラメータは必須です。

パラメータの順序は任意です。パラメータは従来の HTML パラメータ構文を使用して渡され、'?' はパラメータ文字列の開始を示し (GET 要求の場合のみ)、'&' はパラメータ間の区切り文字として使用されます。API から返されるデータは、UTF-8 文字コードを使用する JSON または XML 1.0 で書式設定されます。応答に含まれる一部の文字は HTML エンティティとして符号化されることがあり、その場合はクライアント側で復号化が必要です。また、API 要求で指定されるすべてのパラメータは、URL 符号化してから送信する必要があります。

API では通常、現在のバージョンの対象オブジェクトデータを含む XML または JSON が返されます。ただし、要求に失敗すると、エラーコードとメッセージを含む簡単な応答が返されます。

オブジェクトのクエリ

特に明記されていない限り、検索条件は任意の組み合わせか順序、またはその両方で使用できます。output=mobile が指定されていないと、各クエリ要求から 200 件の結果が返されます。この制限は、モバイルデバイス用に書式設定された応答には適用されません。GET 要求には URL 文字制限があるため、カンマ区切りの ID など、パラメータ値が長くなる場合は POST 要求の使用をお勧めします。オブジェクトをクエリする場合は、結果セット間の移動、残りの結果の取得、および並び替えを行うパラメータを含めることができます。

API 応答形式の変更

Pardot API では、XML または JSON 応答で異なる詳細レベルを返す出力形式をいくつかサポートしています。出力形式を定義するには、output 要求パラメータを指定します。次のような出力形式がサポートされています。

• full — Pardot オブジェクトでサポートされるすべてのデータと、関連するすべてのオブジェクトを返します。
• simple — Pardot オブジェクトのデータでサポートされるすべてのデータを返します。
• mobile — オブジェクトデータの短縮バージョンを返します。この出力形式は、モバイルアプリケーションに適しています。

出力要求パラメータが定義されていない場合、出力形式はデフォルトの full に設定されます

XML 応答形式のサンプル

次の例に、opportunity の XML 応答形式を示します。

output=full の場合:

1<rsp stat="ok" version="1.0">
2
3    <opportunity>   
4
5        ...
6
7        <campaign>
8
9            ...
10
11        </campaign>
12
13        <prospects>
14
15            <prospect>
16
17                ...
18
19            </prospect>
20
21        </prospects>
22
23        <opportunity_activities>
24
25            <visitor_activity>
26
27                ...
28
29            </visitor_activity>
30
31        </opportunity_activities>
32
33    </opportunity>
34
35</rsp>

output=simple の場合:

1<rsp stat="ok" version="1.0">
2
3    <opportunity>   
4
5        ...
6
7        <campaign>
8
9            ...
10
11        </campaign>
12
13        <prospects>
14
15            <prospect>
16
17                ...
18
19            </prospect>
20
21        </prospects>
22
23    </opportunity>
24
25</rsp>

output=mobile の場合:

1<rsp stat="ok" version="1.0">
2
3    <opportunity>   
4
5        ...
6
7    </opportunity>
8
9</rsp>