Marketo MA (プレビュー)
Marketo Marketing Automation。 この API は、キャンペーン、プログラム、潜在顧客、リスト (静的およびスマート) などの Marketo オブジェクトと、ファイルやフォルダーなどのファイルシステム資産へのアクセスを提供します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Standard | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Standard | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Standard | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Marketo 開発者関係 |
| URL | http://developers.marketo.com |
| developerfeedback@marketo.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Microsoft Inc. |
| Web サイト | https://www.marketo.com/ |
| プライバシー ポリシー | https://documents.marketo.com/legal/privacy/ |
| サービス条件 | https://go.microsoft.com/fwlink/?linkid=2237005 |
| カテゴリ | マーケティング;売上と CRM |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| MunchkinID | 文字列 | Marketo MunchkinID (管理者ページを参照) | 正しい |
| クライアントID | 文字列 | クライアントID | 正しい |
| クライアント シークレット | securestring | クライアント シークレット | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| Describe Program Member |
API を介した対話に使用できるすべてのフィールドの一覧を含む、ターゲット インスタンス内のプログラム メンバー オブジェクトに関するメタデータを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| Describe Program Member |
API を介した対話に使用できるすべてのフィールドの一覧を含む、ターゲット インスタンス内のプログラム メンバー オブジェクトに関するメタデータを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| Enqueue エクスポート プログラム メンバー ジョブ |
エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに配置され、コンピューティング リソースが使用可能になったときにジョブが開始されます。 エクスポート ジョブは、"作成済み" 状態である必要があります。 |
| Id でキャンペーンを取得する |
ID でキャンペーンのレコードを返します。必要なアクセス許可: Read-Only キャンペーン、Read-Write キャンペーン |
| Id でスマート リストを取得する |
スマート リスト レコードを ID で取得します。必要なアクセス許可: Read-Asset または Read-Write アセット |
| ID でファイルを取得する |
指定した ID のファイル レコードを返します。必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| ID でフォルダーを取得する |
指定した ID のフォルダー レコードを返します。必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| Id でプログラムを取得する |
指定された ID のプログラム レコードを取得します。必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| Id でリストを取得する |
リスト レコードを ID で返します。必要なアクセス許可: Read-Only 潜在顧客、潜在顧客 Read-Write |
| Id で潜在顧客を取得する |
Marketo ID を使用して 1 つの潜在顧客レコードを取得します。必要なアクセス許可: Read-Only リード、Read-Write リード |
| ID で静的リストを取得する |
静的リスト レコードを ID で取得します。必要なアクセス許可: Read-Asset または Read-Write アセット |
| Marketo にリードをプッシュする |
リードをアップサートし、Marketo アクティビティにプッシュ リードを生成します。 必要なアクセス許可: 潜在顧客 Read-Write |
| アイデンティティ |
Marketo からアクセス トークンを取得します。 このエンドポイントへの呼び出しは、API 呼び出しの制限にはカウントされません。 |
| アイデンティティ |
Marketo からアクセス トークンを取得します。 このエンドポイントへの呼び出しは、API 呼び出しの制限にはカウントされません。 |
| エクスポート プログラム メンバー ジョブの作成 |
"filter" パラメーターを使用して定義された検索条件のエクスポート ジョブを作成します。 要求は、一括エクスポート プログラム メンバー エンドポイントへの後続の呼び出しでパラメーターとして渡される "exportId" を返します。 |
| エクスポート リード ジョブを作成する |
"filter" パラメーターを使用して定義された検索条件のエクスポート ジョブを作成します。 要求は、リードの一括エクスポート エンドポイントへの後続の呼び出しでパラメーターとして渡される "exportId" を返します。 エンキュー エクスポート リード ジョブ エンドポイントを使用して、処理のためにエクスポート ジョブをキューに入れます。 エクスポート ジョブの状態の取得エンドポイントを使用して、エクスポート ジョブの状態を取得します。 必要なアクセス許可: 潜在顧客 Read-Only |
| キャンペーンを取得する |
キャンペーン レコードの一覧を返します。 必要なアクセス許可: Read-Only キャンペーン、Read-Write キャンペーン |
| スケジュール キャンペーン |
特定の時刻に実行するバッチ キャンペーンをリモートでスケジュールします。 キャンペーンの親プログラムに対してローカルのトークンをオーバーライドして、コンテンツをカスタマイズできます。 以下で説明する "cloneToProgramName" パラメーターを使用する場合、このエンドポイントは 1 日あたり 20 回の呼び出しに制限されます。 必要なアクセス許可: キャンペーンの実行 |
| スマート リストの削除 |
指定されたスマート リストを削除します。 必要なアクセス許可: Read-Write アセット |
| スマート リストの複製 |
指定されたスマート リストを複製します。 必要なアクセス許可: Read-Write アセット |
| スマート リストを取得する |
ユーザーが作成したスマート リスト レコードの一覧を取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット |
| タグでプログラムを取得する |
指定されたタグの種類とタグ値に一致するプログラムの一覧を取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| ファイルの作成 |
含まれているペイロードから新しいファイルを作成します。 必要なアクセス許可: Read-Write アセット |
| ファイルの内容を更新する |
ファイルの現在のコンテンツを含まれるペイロードに置き換えます。 必要なアクセス許可: Read-Write アセット |
| ファイルの取得 |
指定したフォルダーからファイルを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| フィルターの種類別に潜在顧客を取得する |
特定のフィールドの値のリストに基づいて、最大 300 件の潜在顧客のリストを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| フォルダー メタデータの更新 |
特定のフォルダーのメタデータを更新します。 必要なアクセス許可: Read-Write アセット |
| フォルダーの作成 |
新しいフォルダーを作成します。 必要なアクセス許可: Read-Write アセット |
| フォルダーの内容を取得する |
特定のフォルダーの内容のレコードを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| フォルダーの削除 |
指定したフォルダーを削除します。 フォルダーにコンテンツがある場合、削除は失敗します。 必要なアクセス許可: Read-Write アセット |
| フォルダーの取得 |
特定のルート フォルダー内から子フォルダーを取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| プログラム ID でスマート リストを取得する |
スマート リスト レコードを電子メール プログラム ID で取得します。必要なアクセス許可: Read-Asset または Read-Write アセット |
| プログラム ID で潜在顧客を取得する |
指定されたプログラムのメンバーである潜在顧客の一覧を取得します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| プログラム タグの削除 |
不要なプログラム タグを削除します。 必要なアクセス許可: Read-Write アセット |
| プログラム タグの更新 |
プログラム タグを更新します。 必要なアクセス許可: Read-Write アセット |
| プログラム メタデータの更新 |
ターゲット プログラムのメタデータを更新します。 必要なアクセス許可: Read-Write アセット |
| プログラム メンバー ジョブのエクスポートを取り消す |
エクスポート ジョブを取り消します。 必要なアクセス許可: 潜在顧客 Read-Only |
| プログラム メンバー ジョブのエクスポートを取得する |
過去 7 日間に作成されたエクスポート ジョブの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Only |
| プログラム メンバー データの同期 |
ターゲット プログラム内の潜在顧客のリストのプログラム メンバー データを変更します。 この API を使用してデータを変更できるのは、プログラムの既存のメンバーだけです。 必要なアクセス許可: 潜在顧客 Read-Write |
| プログラム メンバー ファイルのエクスポートを取得する |
エクスポート ジョブのファイルコンテンツを返します。 エクスポート ジョブは"完了" 状態である必要があります。 エクスポート ジョブの状態を取得するには、Get Export Program Member Job Status エンドポイントを使用します。 必要なアクセス許可: 潜在顧客 Read-Only |
| プログラム メンバーのインポート |
データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要なアクセス許可: 潜在顧客 Read-Write |
| プログラム メンバーのインポートに関する警告を取得する |
インポート バッチ ジョブの警告の一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write |
| プログラム メンバーのエクスポート ジョブの状態を取得する |
エクスポート ジョブの状態を返します。 ジョブの状態は、完了または失敗の状態に達してから 30 日間使用できます。 必要なアクセス許可: 潜在顧客 Read-Only |
| プログラム メンバーの削除 |
コピー先インスタンスからメンバーの一覧を削除します。 必要なアクセス許可: 潜在顧客 Read-Write |
| プログラム メンバーを取得する |
特定のフィールドの値のリストで、最大 300 人のプログラム メンバーのリストを返します。 ユーザー設定フィールドである filterType を指定する場合、ユーザー設定フィールドの dataType は "string" または "integer" である必要があります。 "leadId" 以外の filterType を指定すると、要求によって最大 100,000 個のプログラム メンバー レコードを処理できます。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| プログラムの作成 |
新しいプログラムを作成します。 必要なアクセス許可: Read-Write アセット |
| プログラムの削除 |
ターゲット プログラムを削除します。 プログラムの外部で使用されている資産がプログラムに含まれていない場合があります。 必要なアクセス許可: Read-Write アセット |
| プログラムの取得 |
ターゲット インスタンスからアクセス可能なプログラムの一覧を取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| プログラムの承認 |
ターゲット プログラムを承認します。 未承認の電子メール プログラムでのみ有効です。 必要なアクセス許可: Read-Write アセット |
| プログラムの複製 |
ターゲット プログラムを複製します。 必要なアクセス許可: Read-Write アセット |
| プログラムメンバーのインポートエラーを取得する |
インポート バッチ ジョブのエラーの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write |
| プログラムメンバーのインポートステータスを取得する |
インポート バッチ ジョブの状態を返します。 必要なアクセス許可: 潜在顧客 Read-Write |
| リスト ID で潜在顧客を取得する |
指定された静的リストのメンバーである個人レコードを取得します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| リスト ID で潜在顧客を取得する |
指定された静的リストのメンバーである個人レコードを取得します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| リストから削除 |
ターゲットの静的リストから特定の人物レコードのセットを削除します。 必要なアクセス許可: 潜在顧客 Read-Write |
| リストに追加 |
特定の人物レコードのセットをターゲットの静的リストに追加します。 要求ごとに 300 個のリード ID の制限があります。 必要なアクセス許可: 潜在顧客 Read-Write |
| リストのメンバー |
リードが特定の静的リストのメンバーであるかどうかを確認します。 必要なアクセス許可: 潜在顧客 Read-Write |
| リストの取得 |
指定されたフィルター パラメーターに基づいて静的リスト レコードのセットを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| リード ジョブのエクスポートをエンキューする |
エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに配置され、コンピューティング リソースが使用可能になったときにジョブが開始されます。 エクスポート ジョブは、"作成済み" 状態である必要があります。 エクスポート ジョブの状態の取得エンドポイントを使用して、エクスポート ジョブの状態を取得します。 必要なアクセス許可: 潜在顧客 Read-Only |
| リード ジョブのエクスポートを取り消す |
エクスポート ジョブを取り消します。 必要なアクセス許可: 潜在顧客 Read-Only |
| リード ジョブのエクスポートを取得する |
過去 7 日間に作成されたエクスポート ジョブの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Only |
| リード ジョブの状態のエクスポートを取得する |
エクスポート ジョブの状態を返します。 ジョブの状態は、完了または失敗の状態に達してから 30 日間使用できます。 必要なアクセス許可: 潜在顧客 Read-Only |
| リード ファイルのエクスポートを取得する |
エクスポート ジョブのファイルコンテンツを返します。 エクスポート ジョブは"完了" 状態である必要があります。 エクスポート ジョブの状態の取得エンドポイントを使用して、エクスポート ジョブの状態を取得します。 必要なアクセス許可: 潜在顧客 Read-Only |
| リード フィールドの更新 |
ターゲット インスタンスの潜在顧客フィールドのメタデータを更新します。 更新ルール については、こちらをご覧ください。 必要なアクセス許可: Read-Write スキーマ標準フィールド、Read-Write スキーマ ユーザー設定フィールド |
| リードのインポートに関する警告を取得する |
インポート バッチ ジョブの警告の一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write |
| リードのインポートエラーを取得する |
インポート バッチ ジョブのエラーの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write |
| リードのインポート状態を取得する |
インポート バッチ ジョブの状態を返します。 必要なアクセス許可: 潜在顧客 Read-Write |
| 同期プログラムのメンバーの状態 |
ターゲット プログラムの潜在顧客のリストのプログラム メンバーの状態を変更します。 メンバーがプログラムの一部でない場合は、メンバーがプログラムに追加されます。 必要なアクセス許可: 潜在顧客 Read-Write |
| 名前でスマート リストを取得する |
スマート リスト レコードを名前で取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット |
| 名前でファイルを取得する |
指定された名前のファイル レコードを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| 名前でフォルダーを取得する |
指定された名前のフォルダー レコードを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| 名前でプログラム メンバー フィールドを取得する |
1 つのプログラム メンバー フィールドのメタデータを取得します。 必要なアクセス許可: Read-Write スキーマ標準フィールド、Read-Write スキーマ ユーザー設定フィールド |
| 名前でプログラムを取得する |
指定された名前のプログラム レコードを取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット |
| 名前で潜在顧客フィールドを取得する |
単一リード フィールドのメタデータを取得します。 必要なアクセス許可: Read-Write スキーマ標準フィールド、Read-Write スキーマ ユーザー設定フィールド |
| 名前で静的リストを取得する |
静的リスト レコードを名前で取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット |
| 未承認プログラム |
ターゲット プログラムを承認しません。 承認された電子メール プログラムでのみ有効です。 必要なアクセス許可: Read-Write アセット |
| 潜在顧客のインポート |
データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要なアクセス許可: 潜在顧客 Read-Write |
| 潜在顧客の削除 |
宛先インスタンスから潜在顧客の一覧を削除します。 必要なアクセス許可: 潜在顧客 Read-Write |
| 潜在顧客の同期 |
リードの一覧をターゲット インスタンスに同期します。 必要なアクセス許可: 潜在顧客 Read-Write |
| 潜在顧客の説明 |
API を介した対話に使用できるすべてのフィールドの一覧を含む、ターゲット インスタンス内の潜在顧客オブジェクトに関するメタデータを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| 潜在顧客の説明 2 |
ターゲット インスタンス内の潜在顧客オブジェクトの検索可能なフィールドの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write |
| 要求キャンペーン |
一連のリードをトリガー キャンペーンに渡して、キャンペーンのフローを実行します。 指定されたキャンペーンには、キャンペーンが要求済みである Web サービス API トリガーがあり、アクティブである必要があります。 キャンペーンの親プログラムに対してローカルのトークンをオーバーライドして、コンテンツをカスタマイズできます。 呼び出しごとに最大 100 の潜在顧客が許可されます。 必要なアクセス許可: キャンペーンの実行 |
| 静的リスト メタデータの更新 |
静的リスト 資産のメタデータを更新します。 必要なアクセス許可: Read-Write アセット |
| 静的リストの作成 |
新しい静的リストを作成します。 必要なアクセス許可: Read-Write アセット |
| 静的リストの削除 |
指定された静的リストを削除します。 必要なアクセス許可: Read-Write アセット |
| 静的リストを取得する |
静的リスト レコードの一覧を取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット |
Describe Program Member
API を介した対話に使用できるすべてのフィールドの一覧を含む、ターゲット インスタンス内のプログラム メンバー オブジェクトに関するメタデータを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
注: このエンドポイントは重ね付けされています。 代わりに Describe Program Member エンドポイントを使用してください。
戻り値
Describe Program Member
API を介した対話に使用できるすべてのフィールドの一覧を含む、ターゲット インスタンス内のプログラム メンバー オブジェクトに関するメタデータを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
戻り値
Enqueue エクスポート プログラム メンバー ジョブ
エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに配置され、コンピューティング リソースが使用可能になったときにジョブが開始されます。 エクスポート ジョブは、"作成済み" 状態である必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
戻り値
Id でキャンペーンを取得する
ID でキャンペーンのレコードを返します。必要なアクセス許可: Read-Only キャンペーン、Read-Write キャンペーン
注: このエンドポイントは重ね付けされています。 代わりに 、Id エンドポイントでスマート キャンペーンを取得 するを使用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
campaignId
|
campaignId | True | integer |
campaignId |
戻り値
- Body
- ResponseOfCampaign
Id でスマート リストを取得する
スマート リスト レコードを ID で取得します。必要なアクセス許可: Read-Asset または Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得するスマート リストの ID
|
id | True | integer |
取得するスマート リストの ID |
|
スマート リスト ルールを設定するには、true を設定します。 既定の false
|
includeRules | boolean |
スマート リスト ルールを設定するには、true を設定します。 既定の false |
戻り値
ID でファイルを取得する
指定した ID のファイル レコードを返します。必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイルの ID
|
id | True | integer |
データベース内のファイルの ID |
戻り値
ID でフォルダーを取得する
指定した ID のフォルダー レコードを返します。必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得するフォルダーの ID
|
id | True | integer |
取得するフォルダーの ID |
|
フォルダーの種類 (プログラムまたはフォルダー)
|
type | True | string |
フォルダーの種類。 'Folder' または 'Program' |
戻り値
Id でプログラムを取得する
指定された ID のプログラム レコードを取得します。必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
戻り値
Id でリストを取得する
リスト レコードを ID で返します。必要なアクセス許可: Read-Only 潜在顧客、潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコードを取得する静的リストの ID
|
listId | True | integer |
レコードを取得する静的リストの ID |
戻り値
- Body
- ResponseOfStaticList
Id で潜在顧客を取得する
Marketo ID を使用して 1 つの潜在顧客レコードを取得します。必要なアクセス許可: Read-Only リード、Read-Write リード
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Marketo リード ID
|
leadId | True | integer |
Marketo リード ID |
|
フィールド名のコンマ区切りリスト。
|
fields | array |
フィールド名のコンマ区切りリスト。 省略すると、email、updatedAt、createdAt、lastName、firstName、id の既定のフィールドが返されます。 |
戻り値
- Body
- ResponseOfLead
ID で静的リストを取得する
静的リスト レコードを ID で取得します。必要なアクセス許可: Read-Asset または Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得する静的リストの ID
|
id | True | integer |
取得する静的リストの ID |
戻り値
Marketo にリードをプッシュする
リードをアップサートし、Marketo アクティビティにプッシュ リードを生成します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | integer |
潜在顧客レコードの一意の整数 ID |
|
|
コード
|
code | True | string |
理由の整数コード |
|
メッセージ
|
message | True | string |
操作の状態の理由を説明するメッセージ |
|
状態
|
status | string |
レコードに対して実行された操作の状態 |
|
|
lookupField
|
lookupField | string | ||
|
partitionName
|
partitionName | string | ||
|
programName
|
programName | string | ||
|
programStatus
|
programStatus | string | ||
|
理由
|
reason | string | ||
|
ソース
|
source | string |
戻り値
アイデンティティ
Marketo からアクセス トークンを取得します。 このエンドポイントへの呼び出しは、API 呼び出しの制限にはカウントされません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Marketo REST API の clientID
|
client_id | True | string |
[Admin > Integration] > Launchpoint メニューのクライアント ID。 |
|
Marketo REST API のクライアント シークレット
|
client_secret | True | string |
[管理] > [統合] の [Launchpoint] メニュー > クライアント シークレット。 |
|
許可の種類。 ケース クライアントの資格情報
|
grant_type | True | string |
許可の種類。 |
戻り値
- Body
- ResponseOfIdentity
アイデンティティ
Marketo からアクセス トークンを取得します。 このエンドポイントへの呼び出しは、API 呼び出しの制限にはカウントされません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Marketo REST API の clientID
|
client_id | True | string |
[Admin > Integration] > Launchpoint メニューのクライアント ID。 |
|
Marketo REST API のクライアント シークレット
|
client_secret | True | string |
[管理] > [統合] の [Launchpoint] メニュー > クライアント シークレット。 |
|
許可の種類。 ケース クライアントの資格情報
|
grant_type | True | string |
許可の種類。 |
戻り値
- Body
- ResponseOfIdentity
エクスポート プログラム メンバー ジョブの作成
"filter" パラメーターを使用して定義された検索条件のエクスポート ジョブを作成します。 要求は、一括エクスポート プログラム メンバー エンドポイントへの後続の呼び出しでパラメーターとして渡される "exportId" を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string |
ヘッダー フィールドの REST API 名 |
|
value
|
value | True | string |
ヘッダー フィールドの値 |
|
fields
|
fields | True | array of string |
ファイルに含めるフィールドのコンマ区切りリスト |
|
programId
|
programId | True | integer |
メンバーを取得するプログラムの ID。 "programIds" フィルターと組み合わせて使用することはできません |
|
programIds
|
programIds | True | array of integer |
メンバーを取得するプログラム ID の配列。 "programId" フィルターと組み合わせて使用することはできません |
|
isExhausted
|
isExhausted | boolean |
コンテンツを使い果たしたユーザーのプログラム メンバーシップ レコードをフィルター処理する |
|
|
nurtureCadence
|
nurtureCadence | string |
特定の育成周期のプログラム メンバーシップ レコードをフィルター処理する |
|
|
statusNames
|
statusNames | array of string |
プログラム メンバーの状態名の配列。 既定またはユーザー定義のどちらでもかまいません。 複数の状態名が一緒に ORed です。 |
|
|
endAt
|
endAt | string |
日付範囲フィルターの終了日 (ISO 8601 形式) |
|
|
startAt
|
startAt | string |
日付範囲フィルターの開始 (ISO-8601 形式) |
|
|
format
|
format | string |
作成するファイル形式 ("CSV"、"TSV"、"SSV")。 既定値は "CSV" です |
戻り値
エクスポート リード ジョブを作成する
"filter" パラメーターを使用して定義された検索条件のエクスポート ジョブを作成します。 要求は、リードの一括エクスポート エンドポイントへの後続の呼び出しでパラメーターとして渡される "exportId" を返します。 エンキュー エクスポート リード ジョブ エンドポイントを使用して、処理のためにエクスポート ジョブをキューに入れます。 エクスポート ジョブの状態の取得エンドポイントを使用して、エクスポート ジョブの状態を取得します。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string |
ヘッダー フィールドの REST API 名 |
|
value
|
value | True | string |
ヘッダー フィールドの値 |
|
fields
|
fields | True | array of string |
ファイルに含めるフィールドのコンマ区切りリスト |
|
endAt
|
endAt | string |
日付範囲フィルターの終了日 (ISO 8601 形式) |
|
|
startAt
|
startAt | string |
日付範囲フィルターの開始 (ISO-8601 形式) |
|
|
smartListId
|
smartListId | True | integer |
リードを取得するスマート リストの ID |
|
smartListName
|
smartListName | True | string |
リードを取得するスマート リストの名前 |
|
staticListId
|
staticListId | True | integer |
リードを取得する静的リストの ID |
|
staticListName
|
staticListName | True | string |
リードを取得する静的リストの名前 |
|
format
|
format | string |
作成するファイル形式 ("CSV"、"TSV"、"SSV")。 既定値は "CSV" です |
戻り値
キャンペーンを取得する
キャンペーン レコードの一覧を返します。 必要なアクセス許可: Read-Only キャンペーン、Read-Write キャンペーン
注: このエンドポイントは重ね付けされています。 代わりに [スマート キャンペーンの取得]エンドポイントを 使用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコードを返すキャンペーン ID のコンマ区切りリスト
|
id | array |
レコードを返すキャンペーン ID のコンマ区切りリスト |
|
|
フィルター処理する名前のコンマ区切りの一覧
|
name | array |
フィルター処理する名前のコンマ区切りの一覧 |
|
|
フィルター処理するプログラム名のコンマ区切りの一覧。
|
programName | array |
フィルター処理するプログラム名のコンマ区切りの一覧。 設定されている場合は、指定されたプログラムの子であるキャンペーンのみにフィルター処理されます。 |
|
|
フィルター処理するワークスペース名のコンマ区切りの一覧。
|
workspaceName | array |
フィルター処理するワークスペース名のコンマ区切りの一覧。 設定すると、特定のワークスペース内のキャンペーンのみが返されます。 |
|
|
返されるレコードの最大数。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるレコードの最大数。 最大値と既定値は 300 です。 |
|
|
このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
|
|
要求されたトリガーとソースが Web サービス API の場合
|
isTriggerable | boolean |
キャンペーンが要求されたトリガーを持ち、ソースが Web サービス API であるアクティブなキャンペーンを返す場合は true に設定します |
戻り値
- Body
- ResponseOfCampaign
スケジュール キャンペーン
特定の時刻に実行するバッチ キャンペーンをリモートでスケジュールします。 キャンペーンの親プログラムに対してローカルのトークンをオーバーライドして、コンテンツをカスタマイズできます。 以下で説明する "cloneToProgramName" パラメーターを使用する場合、このエンドポイントは 1 日あたり 20 回の呼び出しに制限されます。 必要なアクセス許可: キャンペーンの実行
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スケジュールするバッチ キャンペーンの ID。
|
campaignId | True | integer |
スケジュールするバッチ キャンペーンの ID。 |
|
cloneToProgramName
|
cloneToProgramName | string |
結果のプログラムの名前。 この属性を設定すると、キャンペーン、親プログラム、およびそのすべての資産が、結果として得られる新しい名前で作成されます。 親プログラムが複製され、新しく作成されたキャンペーンがスケジュールされます。 結果のプログラムは、親の下に作成されます。 スニペット、プッシュ通知、アプリ内メッセージ、静的リスト、レポート、ソーシャル資産を含むプログラムは、この方法で複製されない可能性があります |
|
|
runAt
|
runAt | date-time |
キャンペーンを実行する日時。 未設定の場合、キャンペーンは通話が行われた 5 分後に実行されます |
|
|
名前
|
name | True | string |
トークンの名前。 "{{my.name}} " という形式にする必要があります。 |
|
value
|
value | True | string |
トークンの値 |
戻り値
- Body
- ResponseOfCampaign
スマート リストの削除
指定されたスマート リストを削除します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
削除するスマート リストの ID
|
id | True | integer |
削除するスマート リストの ID |
戻り値
- Body
- ResponseOfIdResponse
スマート リストの複製
指定されたスマート リストを複製します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
複製するスマート リストの ID
|
id | True | integer |
複製するスマート リストの ID |
|
名前
|
name | True | string |
複製されたスマート リストの名前 |
|
id
|
id | True | integer |
フォルダーの ID |
|
型
|
type | True | string |
フォルダーの種類 |
|
説明
|
description | string |
複製されたスマート リストの説明 |
戻り値
スマート リストを取得する
ユーザーが作成したスマート リスト レコードの一覧を取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
親フォルダーの JSON 表現
|
folder | string |
親フォルダーの JSON 表記。メンバー 'id' と 'type' ('Folder' または 'Program' である可能性があります) |
|
|
ページングの整数オフセット
|
offset | integer |
ページングの整数オフセット |
|
|
返されるスマート リストの最大数。 最大 200、既定値は 20。
|
maxReturn | integer |
返されるスマート リストの最大数。 最大 200、既定値は 20。 |
|
|
この日付より前のスマート リストを除外します。 Datetime フィールドの種類の説明を参照してください。
|
earliestUpdatedAt | string |
この日付より前のスマート リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールドの種類の説明を参照してください。 |
|
|
この日付より後のスマート リストを除外します。 Datetime フィールドの種類の説明を参照してください。
|
latestUpdatedAt | string |
この日付より後のスマート リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールドの種類の説明を参照してください。 |
戻り値
タグでプログラムを取得する
指定されたタグの種類とタグ値に一致するプログラムの一覧を取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム タグの種類
|
tagType | True | string |
プログラム タグの種類 |
|
タグの値
|
tagValue | True | string |
タグの値 |
|
返されるチャネルの最大数。 最大 200、既定値は 20
|
maxReturn | integer |
返されるチャネルの最大数。 最大 200、既定値は 20 |
|
|
ページングの整数オフセット
|
offset | integer |
ページングの整数オフセット |
戻り値
ファイルの作成
含まれているペイロードから新しいファイルを作成します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
説明
|
description | string |
資産の説明 |
|
|
ファイル
|
file | True | string |
マルチパート ファイル。 ファイルの内容。 |
|
id
|
id | True | integer |
フォルダーの ID |
|
型
|
type | True | string |
フォルダーの種類 |
|
insertOnly
|
insertOnly | boolean |
同じ名前の既存のファイルが既にある場合、呼び出しが失敗するかどうか |
|
|
名前
|
name | True | string |
ファイルの名前 |
戻り値
ファイルの内容を更新する
ファイルの現在のコンテンツを含まれるペイロードに置き換えます。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイルの ID
|
id | True | integer |
データベース内のファイルの ID |
|
ファイル
|
file | True | string |
マルチパート ファイル。 ファイルの内容。 |
|
id
|
id | True | integer |
ファイルの ID |
戻り値
ファイルの取得
指定したフォルダーからファイルを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | integer |
フォルダーの ID |
|
型
|
type | True | string |
フォルダーの種類 |
|
マックスリターン
|
maxReturn | integer |
返されるチャネルの最大数。 最大 200、既定値は 20 |
|
|
オフセット
|
offset | integer |
ページングの整数オフセット |
|
|
ファイルを配置するフォルダー
|
folder | string |
親フォルダーの JSON 表記。メンバー 'id' と 'type' ('Folder' または 'Program' である可能性があります) |
戻り値
フィルターの種類別に潜在顧客を取得する
特定のフィールドの値のリストに基づいて、最大 300 件の潜在顧客のリストを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィルター処理する潜在顧客フィールド。
|
filterType | True | string |
フィルター処理する潜在顧客フィールド。 任意のユーザー設定フィールド (文字列、電子メール、または整数型のみ) と、Cookie、email、facebookId、id、leadPartitionId、linkedInId、sfdcAccountId、sfdcContactId、sfdcLeadId、sfdcLeadOwnerId、sfdcOpptyId、twitterId のいずれかのフィールドがサポートされます。 |
|
指定したフィールドでフィルター処理する値のコンマ区切りのリスト。
|
filterValues | True | array |
指定したフィールドでフィルター処理する値のコンマ区切りのリスト。 |
|
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト
|
fields | array |
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
- Body
- ResponseOfLead
フォルダー メタデータの更新
特定のフォルダーのメタデータを更新します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
更新するフォルダーの ID
|
id | True | integer |
更新するフォルダーの ID |
|
説明
|
description | string |
資産の説明 |
|
|
isArchive
|
isArchive | boolean |
フォルダーがアーカイブされているかどうか。 この値を切り替えることで、フォルダーのアーカイブ状態が変更されます |
|
|
名前
|
name | string |
フォルダーの名前 |
|
|
型
|
type | True | string |
フォルダーの種類。 'Folder' または 'Program' |
戻り値
フォルダーの作成
新しいフォルダーを作成します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
説明
|
description | string |
資産の説明 |
|
|
名前
|
name | True | string |
フォルダーの名前 |
|
id
|
id | True | integer |
フォルダーの ID |
|
型
|
type | True | string |
フォルダーの種類 |
戻り値
フォルダーの内容を取得する
特定のフォルダーの内容のレコードを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得するフォルダーの ID
|
id | True | integer |
取得するフォルダーの ID |
|
返されるチャネルの最大数。 最大 200、既定値は 20
|
maxReturn | integer |
返されるチャネルの最大数。 最大 200、既定値は 20 |
|
|
ページングの整数オフセット
|
offset | integer |
ページングの整数オフセット |
|
|
フォルダーの種類。 'Folder' または 'Program'。 既定値は 'Folder' です
|
type | True | string |
フォルダーの種類。 'Folder' または 'Program'。 既定値は 'Folder' です |
戻り値
フォルダーの削除
指定したフォルダーを削除します。 フォルダーにコンテンツがある場合、削除は失敗します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
削除するフォルダーの ID
|
id | True | integer |
削除するフォルダーの ID |
|
フォルダーの種類
|
type | True | string |
型 |
戻り値
- Body
- ResponseOfIdResponse
フォルダーの取得
特定のルート フォルダー内から子フォルダーを取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
親フォルダー参照
|
root | string |
親フォルダー参照 |
|
|
スキャンするフォルダーの最大深度、既定値 2
|
maxDepth | integer |
スキャンするフォルダーの最大深度、既定値 2 |
|
|
返されるフォルダーの最大数。 既定の 20、最大 200
|
maxReturn | integer |
返されるフォルダーの最大数。 既定の 20、最大 200 |
|
|
ページングの整数オフセット。 既定値 0
|
offset | integer |
ページングの整数オフセット。 既定値 0 |
|
|
ワークスペースの名前
|
workSpace | string |
ワークスペースの名前 |
戻り値
プログラム ID でスマート リストを取得する
スマート リスト レコードを電子メール プログラム ID で取得します。必要なアクセス許可: Read-Asset または Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得するスマート リストを含む電子メール プログラムの ID
|
programId | True | integer |
取得するスマート リストを含む電子メール プログラムの ID |
|
スマート リスト ルールを設定するには、true を設定します。 既定の false
|
includeRules | boolean |
スマート リスト ルールを設定するには、true を設定します。 既定の false |
戻り値
プログラム ID で潜在顧客を取得する
指定されたプログラムのメンバーである潜在顧客の一覧を取得します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得元のプログラムの ID
|
programId | True | integer |
取得元のプログラムの ID |
|
各レコードに対して返されるフィールドのコンマ区切りのリスト
|
fields | array |
各レコードに対して返されるフィールドのコンマ区切りのリスト |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
- Body
- ResponseOfLead
プログラム タグの削除
不要なプログラム タグを削除します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
|
プログラム タグの種類
|
tagType | True | string |
プログラム タグの種類 |
戻り値
- Body
- ResponseOfIdResponse
プログラム タグの更新
プログラム タグを更新します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
|
プログラム タグの種類
|
tagType | True | string |
プログラム タグの種類 |
|
プログラム タグの値
|
tagValue | True | string |
プログラム タグの値 |
戻り値
- Body
- ResponseOfIdResponse
プログラム メタデータの更新
ターゲット プログラムのメタデータを更新します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
|
費用
|
cost | True | integer |
コストの金額 |
|
手記
|
note | string |
コストに関する注意事項 |
|
|
startDate
|
startDate | True | date-time |
期間コストの開始日 |
|
costsDestructiveUpdate
|
costsDestructiveUpdate | boolean |
既存のコストを破棄し、指定したコストに置き換えるには true を設定します |
|
|
説明
|
description | string |
プログラムの更新された説明 |
|
|
終了日
|
endDate | string |
プログラムの終了日。 イベント、電子メール、ウェビナーの種類のプログラムに適用 |
|
|
名前
|
name | string |
プログラムの名前 |
|
|
startDate
|
startDate | string |
プログラムの開始日。 イベント、電子メール、ウェビナーの種類のプログラムに適用 |
|
|
tagType
|
tagType | string |
プログラム タグの種類 |
|
|
タグ値
|
tagValue | string |
タグの値 |
戻り値
プログラム メンバー ジョブのエクスポートを取り消す
エクスポート ジョブを取り消します。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エクスポート バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
戻り値
プログラム メンバー ジョブのエクスポートを取得する
過去 7 日間に作成されたエクスポート ジョブの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィルター処理する状態のコンマ区切りの一覧。
|
status | array |
フィルター処理する状態のコンマ区切りの一覧。 |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
結果セットがバッチ サイズより大きい場合、このエンドポイントによって返されます。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
プログラム メンバー データの同期
ターゲット プログラム内の潜在顧客のリストのプログラム メンバー データを変更します。 この API を使用してデータを変更できるのは、プログラムの既存のメンバーだけです。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ターゲット プログラムの ID。
|
programId | True | integer |
ターゲット プログラムの ID。 |
|
leadId
|
leadId | True | integer |
潜在顧客レコードの一意の整数 ID |
|
{fieldApiName}
|
{fieldApiName} | True | string |
更新するフィールドの API 名。 Describe Program Member エンドポイントの説明に従って更新可能である必要があります。 |
|
{fieldApiName2}
|
{fieldApiName2} | string |
更新する別のフィールドの API 名 (など)。 Describe Program Member エンドポイントの説明に従って更新可能である必要があります。 |
戻り値
プログラム メンバー ファイルのエクスポートを取得する
エクスポート ジョブのファイルコンテンツを返します。 エクスポート ジョブは"完了" 状態である必要があります。 エクスポート ジョブの状態を取得するには、Get Export Program Member Job Status エンドポイントを使用します。 必要なアクセス許可: 潜在顧客 Read-Only
ファイル形式は、Create Export Program Member Job エンドポイントを呼び出すことによって指定されます。 既定のファイル形式 ("CSV") の例を次に示します。firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エクスポート バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
|
抽出されたデータの部分的な取得をサポートするため。
|
Range | string |
抽出されたデータの部分的な取得をサポートするために、"bytes" 型の HTTP ヘッダー "Range" を指定できます。 詳細については、RFC 2616 の「範囲取得要求」を参照してください。 ヘッダーが設定されていない場合は、内容全体が返されます。 |
戻り値
- response
- object
プログラム メンバーのインポート
データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メンバーを追加するプログラムの ID。
|
programId | True | string |
メンバーを追加するプログラムの ID。 |
|
追加されるメンバーのプログラム メンバーの状態。
|
programMemberStatus | True | string |
追加されるメンバーのプログラム メンバーの状態。 |
|
ファイル形式をインポートします。
|
format | True | string |
ファイル形式をインポートします。 |
|
インポートするデータ レコードを含むファイル。
|
file | True | file |
インポートするデータ レコードを含むファイル。 |
戻り値
プログラム メンバーのインポートに関する警告を取得する
インポート バッチ ジョブの警告の一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
インポート バッチ ジョブの ID。
|
batchId | True | integer |
インポート バッチ ジョブの ID。 |
戻り値
- response
- object
プログラム メンバーのエクスポート ジョブの状態を取得する
エクスポート ジョブの状態を返します。 ジョブの状態は、完了または失敗の状態に達してから 30 日間使用できます。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エクスポート バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
戻り値
プログラム メンバーの削除
コピー先インスタンスからメンバーの一覧を削除します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ターゲット プログラムの ID。
|
programId | True | integer |
ターゲット プログラムの ID。 |
|
leadId
|
leadId | True | integer |
潜在顧客レコードの一意の整数 ID |
戻り値
プログラム メンバーを取得する
特定のフィールドの値のリストで、最大 300 人のプログラム メンバーのリストを返します。 ユーザー設定フィールドである filterType を指定する場合、ユーザー設定フィールドの dataType は "string" または "integer" である必要があります。 "leadId" 以外の filterType を指定すると、要求によって最大 100,000 個のプログラム メンバー レコードを処理できます。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ターゲット プログラムの ID。
|
programId | True | integer |
ターゲット プログラムの ID。 |
|
フィルター処理するプログラム メンバー フィールド。
|
filterType | True | string |
フィルター処理するプログラム メンバー フィールド。 任意のユーザー設定フィールド (文字列または整数型のみ)、"updatedAt"、または検索可能なフィールド。 検索可能なフィールドは、 Describe Program Member エンドポイントを使用して取得できます。 |
|
指定したフィールドでフィルター処理する値のコンマ区切りのリスト。
|
filterValues | True | array |
指定したフィールドでフィルター処理する値のコンマ区切りのリスト。 |
|
filterType=updatedAt を使用する場合、日付範囲フィルターの開始
|
startAt | string |
filterType=updatedAt を使用する場合、日付範囲フィルターの開始 (ISO 8601 形式) |
|
|
filterType=updatedAt を使用する場合、日付範囲フィルターの終了
|
endAt | string |
filterType=updatedAt を使用する場合、日付範囲フィルターの終了 (ISO 8601 形式) |
|
|
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト。
|
fields | array |
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト。 |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
結果セットがバッチ サイズより大きい場合、トークンが返されます。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
プログラムの作成
新しいプログラムを作成します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チャネル
|
channel | True | string |
プログラムのチャネル |
|
費用
|
cost | True | integer |
コストの金額 |
|
手記
|
note | string |
コストに関する注意事項 |
|
|
startDate
|
startDate | True | date-time |
期間コストの開始日 |
|
説明
|
description | string | ||
|
id
|
id | True | integer |
フォルダーの ID |
|
型
|
type | True | string |
フォルダーの種類 |
|
名前
|
name | True | string |
プログラムの名前 |
|
tagType
|
tagType | string |
プログラム タグの種類 |
|
|
タグ値
|
tagValue | string |
タグの値 |
|
|
型
|
type | True | string |
プログラムの種類 |
戻り値
プログラムの削除
ターゲット プログラムを削除します。 プログラムの外部で使用されている資産がプログラムに含まれていない場合があります。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
戻り値
- Body
- ResponseOfIdResponse
プログラムの取得
ターゲット インスタンスからアクセス可能なプログラムの一覧を取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
返されるチャネルの最大数。 最大 200、既定値は 20
|
maxReturn | integer |
返されるチャネルの最大数。 最大 200、既定値は 20 |
|
|
ページングの整数オフセット
|
offset | integer |
ページングの整数オフセット |
|
|
省略可能なフィルター。 filterValues が必要
|
filterType | string |
省略可能なフィルター。 filterValues が必要 |
|
|
この日付より前のプログラムを除外します。 Datetime フィールドの種類の説明を参照してください。
|
earliestUpdatedAt | string |
この日付より前のプログラムを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールドの種類の説明を参照してください。 |
|
|
この日付より後のプログラムを除外します。 Datetime フィールドの種類の説明を参照してください。
|
latestUpdatedAt | string |
この日付より後のプログラムを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールドの種類の説明を参照してください。 |
戻り値
プログラムの承認
ターゲット プログラムを承認します。 未承認の電子メール プログラムでのみ有効です。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
戻り値
- Body
- ResponseOfIdResponse
プログラムの複製
ターゲット プログラムを複製します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
|
説明
|
description | string | ||
|
id
|
id | True | integer |
フォルダーの ID |
|
型
|
type | True | string |
フォルダーの種類 |
|
名前
|
name | True | string |
プログラムの名前。 最大 255 文字 |
戻り値
プログラムメンバーのインポートエラーを取得する
インポート バッチ ジョブのエラーの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
インポート バッチ ジョブの ID。
|
batchId | True | integer |
インポート バッチ ジョブの ID。 |
戻り値
- response
- object
プログラムメンバーのインポートステータスを取得する
インポート バッチ ジョブの状態を返します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
インポート バッチ ジョブの ID。
|
batchId | True | integer |
インポート バッチ ジョブの ID。 |
戻り値
リスト ID で潜在顧客を取得する
指定された静的リストのメンバーである個人レコードを取得します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコードを取得する静的リストの ID
|
listId | True | integer |
レコードを取得する静的リストの ID |
|
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト。
|
fields | array |
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト。 unset が電子メール、updatedAt、createdAt、lastName、firstName、id を返す場合 |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
- Body
- ResponseOfLead
リスト ID で潜在顧客を取得する
指定された静的リストのメンバーである個人レコードを取得します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコードを取得する静的リストの ID
|
listId | True | integer |
レコードを取得する静的リストの ID |
|
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト。
|
fields | array |
レコードごとに返される潜在顧客フィールドのコンマ区切りのリスト。 unset が電子メール、updatedAt、createdAt、lastName、firstName、id を返す場合 |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
リストから削除
ターゲットの静的リストから特定の人物レコードのセットを削除します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リードを削除する静的リストの ID
|
listId | True | integer |
リードを削除する静的リストの ID |
|
id
|
id | True | integer |
潜在顧客レコードの一意の整数 ID |
|
id
|
id | True | array |
id |
戻り値
リストに追加
特定の人物レコードのセットをターゲットの静的リストに追加します。 要求ごとに 300 個のリード ID の制限があります。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ターゲット リストの ID
|
listId | True | integer |
ターゲット リストの ID |
|
id
|
id | True | integer |
潜在顧客レコードの一意の整数 ID |
|
リストに追加する潜在顧客 ID のコンマ区切りリスト
|
id | array |
リストに追加する潜在顧客 ID のコンマ区切りリスト |
戻り値
リストのメンバー
リードが特定の静的リストのメンバーであるかどうかを確認します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チェック対象の静的リストの ID
|
listId | True | integer |
チェック対象の静的リストの ID |
|
id
|
id | True | integer |
潜在顧客レコードの一意の整数 ID |
|
チェックする潜在顧客 ID のコンマ区切りリスト
|
id | array |
チェックする潜在顧客 ID のコンマ区切りリスト |
戻り値
リストの取得
指定されたフィルター パラメーターに基づいて静的リスト レコードのセットを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
返される静的リスト ID のコンマ区切りリスト
|
id | array |
返される静的リスト ID のコンマ区切りリスト |
|
|
返される静的リスト名のコンマ区切りリスト
|
name | array |
返される静的リスト名のコンマ区切りリスト |
|
|
プログラム名のコンマ区切りリスト。
|
programName | array |
プログラム名のコンマ区切りリスト。 if set は、指定されたプログラムの子であるすべての静的リストを返します |
|
|
ワークスペース名のコンマ区切りの一覧。
|
workspaceName | array |
ワークスペース名のコンマ区切りの一覧。 if set は、指定されたワークスペースの子であるすべての静的リストを返します |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
- Body
- ResponseOfStaticList
リード ジョブのエクスポートをエンキューする
エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに配置され、コンピューティング リソースが使用可能になったときにジョブが開始されます。 エクスポート ジョブは、"作成済み" 状態である必要があります。 エクスポート ジョブの状態の取得エンドポイントを使用して、エクスポート ジョブの状態を取得します。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エクスポート バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
戻り値
リード ジョブのエクスポートを取り消す
エクスポート ジョブを取り消します。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エクスポート バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
戻り値
リード ジョブのエクスポートを取得する
過去 7 日間に作成されたエクスポート ジョブの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィルター処理する状態のコンマ区切りの一覧。
|
status | array |
フィルター処理する状態のコンマ区切りの一覧。 |
|
|
返されるバッチ サイズ。 最大値と既定値は 300 です。
|
batchSize | integer |
返されるバッチ サイズ。 最大値と既定値は 300 です。 |
|
|
次のページ トークン
|
nextPageToken | string |
結果セットがバッチ サイズより大きく、このパラメーターを介して後続の呼び出しで渡すことができる場合は、このエンドポイントによってトークンが返されます。 詳細については、「ページング トークン」を参照してください。 |
戻り値
リード ジョブの状態のエクスポートを取得する
エクスポート ジョブの状態を返します。 ジョブの状態は、完了または失敗の状態に達してから 30 日間使用できます。 必要なアクセス許可: 潜在顧客 Read-Only
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エクスポート バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
戻り値
リード ファイルのエクスポートを取得する
エクスポート ジョブのファイルコンテンツを返します。 エクスポート ジョブは"完了" 状態である必要があります。 エクスポート ジョブの状態の取得エンドポイントを使用して、エクスポート ジョブの状態を取得します。 必要なアクセス許可: 潜在顧客 Read-Only
ファイル形式は、Create Export Lead Job エンドポイントを呼び出すことによって指定されます。 既定のファイル形式 ("CSV") の例を次に示します。firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エクスポート バッチ ジョブの ID。
|
exportId | True | string |
エクスポート バッチ ジョブの ID。 |
|
抽出されたデータの部分的な取得をサポートするには
|
Range | string |
抽出されたデータの部分的な取得をサポートするために、"bytes" 型の HTTP ヘッダー "Range" を指定できます。 詳細については、RFC 2616 の「範囲取得要求」を参照してください。 ヘッダーが設定されていない場合は、内容全体が返されます。 |
戻り値
- response
- object
リード フィールドの更新
ターゲット インスタンスの潜在顧客フィールドのメタデータを更新します。 更新ルール については、こちらをご覧ください。 必要なアクセス許可: Read-Write スキーマ標準フィールド、Read-Write スキーマ ユーザー設定フィールド
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リード フィールドの API 名
|
fieldApiName | True | string |
リード フィールドの API 名 |
|
ディスプレイ名
|
displayName | string |
フィールドの UI 表示名 |
|
|
説明
|
description | string |
フィールドの説明 |
|
|
isHidden
|
isHidden | boolean |
true に設定すると、フィールドは非表示になります。 既定値は false です。 |
|
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
true に設定すると、フィールドは電子メールで HTML としてエンコードされます。 デフォルトはtrueです |
|
|
isSensitive
|
isSensitive | boolean |
true に設定すると、フィールドは機密としてマークされます。 既定値は false です。 |
戻り値
リードのインポートに関する警告を取得する
インポート バッチ ジョブの警告の一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
インポート バッチ ジョブの ID。
|
batchId | True | integer |
インポート バッチ ジョブの ID。 |
戻り値
- response
- object
リードのインポートエラーを取得する
インポート バッチ ジョブのエラーの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
インポート バッチ ジョブの ID。
|
batchId | True | integer |
インポート バッチ ジョブの ID。 |
戻り値
- response
- object
リードのインポート状態を取得する
インポート バッチ ジョブの状態を返します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
インポート バッチ ジョブの ID。
|
batchId | True | integer |
インポート バッチ ジョブの ID。 |
戻り値
同期プログラムのメンバーの状態
ターゲット プログラムの潜在顧客のリストのプログラム メンバーの状態を変更します。 メンバーがプログラムの一部でない場合は、メンバーがプログラムに追加されます。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ターゲット プログラムの ID。
|
programId | True | integer |
ターゲット プログラムの ID。 |
|
statusName
|
statusName | True | string |
プログラム メンバーの状態 |
|
leadId
|
leadId | True | integer |
潜在顧客レコードの一意の整数 ID |
戻り値
名前でスマート リストを取得する
スマート リスト レコードを名前で取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得するスマート リストの名前
|
name | True | string |
取得するスマート リストの名前 |
戻り値
名前でファイルを取得する
指定された名前のファイル レコードを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイルの名前
|
name | True | string |
ファイルの名前 |
戻り値
名前でフォルダーを取得する
指定された名前のフォルダー レコードを返します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダーの名前
|
name | True | string |
フォルダーの名前。 プログラムには適用されません |
|
フォルダーの種類 (プログラムまたはフォルダー)
|
type | string |
フォルダーの種類。 'Folder' または 'Program' |
|
|
親フォルダー参照
|
root | string |
親フォルダー参照 |
|
|
ワークスペースの名前
|
workSpace | string |
ワークスペースの名前 |
戻り値
名前でプログラム メンバー フィールドを取得する
1 つのプログラム メンバー フィールドのメタデータを取得します。 必要なアクセス許可: Read-Write スキーマ標準フィールド、Read-Write スキーマ ユーザー設定フィールド
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム メンバー フィールドの API 名
|
fieldApiName | True | string |
プログラム メンバー フィールドの API 名 |
戻り値
- Body
- ResponseOfLeadField
名前でプログラムを取得する
指定された名前のプログラム レコードを取得します。 必要なアクセス許可: Read-Only アセット、Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラムの名前
|
name | True | string |
プログラムの名前 |
|
true を設定してプログラム タグを設定する
|
includeTags | boolean |
true を設定してプログラム タグを設定する |
|
|
true を設定してプログラムのコストを設定する
|
includeCosts | boolean |
true を設定してプログラムのコストを設定する |
戻り値
名前で潜在顧客フィールドを取得する
単一リード フィールドのメタデータを取得します。 必要なアクセス許可: Read-Write スキーマ標準フィールド、Read-Write スキーマ ユーザー設定フィールド
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リード フィールドの API 名
|
fieldApiName | True | string |
リード フィールドの API 名 |
戻り値
- Body
- ResponseOfLeadField
名前で静的リストを取得する
静的リスト レコードを名前で取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
取得する静的リストの名前
|
name | True | string |
取得する静的リストの名前 |
戻り値
未承認プログラム
ターゲット プログラムを承認しません。 承認された電子メール プログラムでのみ有効です。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム ID
|
id | True | integer |
id |
戻り値
- Body
- ResponseOfIdResponse
潜在顧客のインポート
データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル形式をインポートします。
|
format | True | string |
ファイル形式をインポートします。 |
|
重複除去に使用するフィールド。 ユーザー設定フィールド (文字列、電子メール、整数)
|
lookupField | string |
重複除去に使用するフィールド。 カスタム フィールド (文字列、電子メール、整数)、および次のフィールドの種類がサポートされています:id、cookie、email、twitterId、facebookId、linkedInId、sfdcAccountId、sfdcContactId、sfdcLeadId、sfdcLeadOwnerId、sfdcOpptyId。 既定値は電子メールです。 |
|
|
インポート先のリード パーティションの名前。
|
partitionName | string |
インポート先のリード パーティションの名前。 |
|
|
インポートする静的リストの ID。
|
listId | integer |
インポートする静的リストの ID。 |
|
|
インポートするデータ レコードを含むファイル。
|
file | True | file |
インポートするデータ レコードを含むファイル。 |
戻り値
潜在顧客の削除
宛先インスタンスから潜在顧客の一覧を削除します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | True | integer |
潜在顧客レコードの一意の整数 ID |
|
要求本文が空の場合は、パラメーターを指定できます。
|
id | array |
要求本文が空の場合は、パラメーターを指定できます。 複数のリード ID を指定できます。 例: id=1,2,3,2342 |
戻り値
- Body
- ResponseOfLead
潜在顧客の同期
リードの一覧をターゲット インスタンスに同期します。 必要なアクセス許可: 潜在顧客 Read-Write
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクション
|
action | string |
実行する同期操作の種類。 既定値は、設定されていない場合は createOrUpdate です |
|
|
asyncProcessing
|
asyncProcessing | boolean |
true に設定すると、呼び出しはすぐに返されます |
|
|
id
|
id | integer |
潜在顧客レコードの一意の整数 ID |
|
|
acquiredBy
|
acquiredBy | boolean |
リードが親プログラムによって取得されたかどうか |
|
|
isExhausted
|
isExhausted | boolean |
リードがストリームで現在使い果たされているかどうか (該当する場合) |
|
|
membershipDate
|
membershipDate | True | string |
リードがプログラムのメンバーになった日付 |
|
nurtureCadence
|
nurtureCadence | string |
親ストリームの周期 (該当する場合) |
|
|
progressionStatus
|
progressionStatus | True | string |
親プログラムのリードのプログラムステータス |
|
reachedSuccess
|
reachedSuccess | boolean |
親プログラムでリードが成功状態にあるかどうか |
|
|
ストリーミング
|
stream | string |
親プログラムがエンゲージメント プログラムの場合、リードがメンバーになっているストリーム |
|
|
コード
|
code | True | string |
理由の整数コード |
|
メッセージ
|
message | True | string |
操作の状態の理由を説明するメッセージ |
|
状態
|
status | string |
レコードに対して実行された操作の状態 |
|
|
lookupField
|
lookupField | string |
重複除去するフィールド。 フィールドは、入力の各潜在顧客レコードに存在する必要があります。 設定を解除した場合は既定で電子メールに設定されます |
|
|
partitionName
|
partitionName | string |
操作するパーティションの名前 (該当する場合)。 パーティションが有効になっているインスタンスと対話するときは、可能な限り設定する必要があります。 |
戻り値
- Body
- ResponseOfLead
潜在顧客の説明
API を介した対話に使用できるすべてのフィールドの一覧を含む、ターゲット インスタンス内の潜在顧客オブジェクトに関するメタデータを返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
注: このエンドポイントは重ね付けされています。 代わりに Describe Lead2 エンドポイントを使用してください。
戻り値
潜在顧客の説明 2
ターゲット インスタンス内の潜在顧客オブジェクトの検索可能なフィールドの一覧を返します。 必要なアクセス許可: 潜在顧客 Read-Only、潜在顧客 Read-Write
戻り値
要求キャンペーン
一連のリードをトリガー キャンペーンに渡して、キャンペーンのフローを実行します。 指定されたキャンペーンには、キャンペーンが要求済みである Web サービス API トリガーがあり、アクティブである必要があります。 キャンペーンの親プログラムに対してローカルのトークンをオーバーライドして、コンテンツをカスタマイズできます。 呼び出しごとに最大 100 の潜在顧客が許可されます。 必要なアクセス許可: キャンペーンの実行
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トリガーするキャンペーンの ID
|
campaignId | True | integer |
トリガーするキャンペーンの ID |
|
id
|
id | True | integer |
潜在顧客レコードの一意の整数 ID |
|
名前
|
name | True | string |
トークンの名前。 "{{my.name}} " という形式にする必要があります。 |
|
value
|
value | True | string |
トークンの値 |
戻り値
- Body
- ResponseOfCampaign
静的リスト メタデータの更新
静的リスト 資産のメタデータを更新します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
更新する静的リストの ID
|
id | True | integer |
更新する静的リストの ID |
|
説明
|
description | string |
静的リストの説明 |
|
|
名前
|
name | string |
静的リストの名前 |
戻り値
静的リストの作成
新しい静的リストを作成します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
説明
|
description | string |
静的リストの説明 |
|
|
名前
|
name | True | string |
静的リストの名前 |
|
id
|
id | True | integer |
フォルダーの ID |
|
型
|
type | True | string |
フォルダーの種類 |
戻り値
静的リストの削除
指定された静的リストを削除します。 必要なアクセス許可: Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
削除する静的リストの ID
|
id | True | integer |
削除する静的リストの ID |
戻り値
- Body
- ResponseOfIdResponse
静的リストを取得する
静的リスト レコードの一覧を取得します。 必要なアクセス許可: Read-Asset または Read-Write アセット
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
親フォルダーの JSON 表現
|
folder | string |
親フォルダーの JSON 表記。メンバー 'id' と 'type' ('Folder' または 'Program' である可能性があります) |
|
|
ページングの整数オフセット
|
offset | integer |
ページングの整数オフセット |
|
|
返される静的リストの最大数。 最大 200、既定値は 20。
|
maxReturn | integer |
返される静的リストの最大数。 最大 200、既定値は 20。 |
|
|
この日付より前の静的リストを除外します。 Datetime フィールドの種類の説明を参照してください。
|
earliestUpdatedAt | string |
この日付より前の静的リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールドの種類の説明を参照してください。 |
|
|
この日付より後の静的リストを除外します。 Datetime フィールドの種類の説明を参照してください。
|
latestUpdatedAt | string |
この日付より後の静的リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールドの種類の説明を参照してください。 |
戻り値
定義
ResponseOfIdentity
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
access_token
|
access_token | string |
ターゲット インスタンスで認証するために後続の呼び出しで渡すトークン |
|
スコープ
|
scope | string |
認証に使用されたカスタム サービスの所有 API 専用ユーザー |
|
expires_in
|
expires_in | integer |
現在のトークンの残りの有効期間 (秒単位) |
|
token_type
|
token_type | string |
OAuth 認証方法 |
ResponseOfStaticList
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of StaticList |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
リード
潜在顧客レコード。 常に ID が含まれますが、ターゲット インスタンスで使用できるフィールドに応じて、他のフィールドの数を指定できます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
潜在顧客レコードの一意の整数 ID |
|
メンバーシップ
|
membership | ProgramMembership | |
|
理由
|
reason | Reason | |
|
状態
|
status | string |
レコードに対して実行された操作の状態 |
LeadField
潜在顧客フィールド レコード
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ディスプレイ名
|
displayName | string |
フィールドの UI 表示名 |
|
名前
|
name | string |
フィールドの API 名 |
|
説明
|
description | string |
フィールドの説明 |
|
データタイプ
|
dataType | string |
フィールドのデータ型 |
|
length
|
length | integer |
フィールドの最大長。 テキスト、文字列、およびテキスト領域にのみ適用されます。 |
|
isHidden
|
isHidden | boolean |
true に設定すると、フィールドは非表示になります。 |
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
true に設定すると、フィールドは電子メールで HTML としてエンコードされます |
|
isSensitive
|
isSensitive | boolean |
true に設定すると、フィールドは機密としてマークされます |
|
isCustom
|
isCustom | boolean |
true に設定すると、フィールドはユーザー設定になります。 |
|
isApiCreated
|
isApiCreated | boolean |
true に設定すると、REST API を使用してフィールドが作成されました |
LeadFieldStatus
潜在顧客フィールドの更新状態
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
フィールドの API 名 |
|
状態
|
status | string |
レコードに対して実行された操作の状態 |
ListOperationOutputData
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
潜在顧客レコードの一意の整数 ID |
|
理由
|
reasons | array of Reason |
操作が成功しなかった理由の一覧。 理由は API 応答にのみ存在し、送信しないでください |
|
状態
|
status | string |
レコードに対して実行された操作の状態 |
LeadAttribute
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データタイプ
|
dataType | string |
フィールドのデータ型 |
|
ディスプレイ名
|
displayName | string |
フィールドの UI 表示名 |
|
id
|
id | integer |
フィールドの一意の整数 ID |
|
length
|
length | integer |
フィールドの最大長。 テキスト、文字列、およびテキスト領域にのみ適用されます。 |
|
rest
|
rest | LeadMapAttribute | |
|
石鹸
|
soap | LeadMapAttribute |
LeadAttribute2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
"API Lead" |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
検索可能なフィールドの一覧 |
|
fields
|
fields | array of LeadAttribute2Fields |
検索可能なフィールドの説明 |
LeadAttribute2SearchableFields
検索可能なフィールドの一覧
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
string |
検索可能フィールド |
LeadAttribute2Fields
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
フィールドの REST API 名 |
|
ディスプレイ名
|
displayName | string |
フィールドの表示名 (フレンドリ名) |
|
データタイプ
|
dataType | string |
フィールドのデータ型 |
|
length
|
length | integer |
フィールドの長さ |
|
updateable
|
updateable | boolean |
フィールドを更新可能 |
|
crmManaged
|
crmManaged | boolean |
フィールドは CRM によって管理されます |
LeadAttribute2Fields2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
フィールドの REST API 名 |
|
ディスプレイ名
|
displayName | string |
フィールドの表示名 (フレンドリ名) |
|
データタイプ
|
dataType | string |
フィールドのデータ型 |
|
length
|
length | integer |
フィールドの長さ |
|
updateable
|
updateable | boolean |
フィールドを更新可能 |
|
crmManaged
|
crmManaged | boolean |
フィールドは CRM によって管理されます |
ProgramMemberAttribute
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
"API プログラム メンバー" |
|
fields
|
fields | array of LeadAttribute2Fields |
検索可能なフィールドの説明 |
ProgramMemberAttribute2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
"API プログラム メンバー" |
|
説明
|
description | string |
"API プログラム メンバー マップ" |
|
createdAt
|
createdAt | string |
作成時の Datetime |
|
updatedAt
|
updatedAt | string |
Datetime updated |
|
dedupeFields
|
dedupeFields | array of string |
dedupe フィールドの一覧 |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
検索可能なフィールドの一覧 |
|
fields
|
fields | array of LeadAttribute2Fields2 |
検索可能なフィールドの説明 |
ResponseOfImportLeadResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ImportLeadResponse |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ImportProgramMemberResponse
インポート状態情報を含む応答
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
batchId
|
batchId | integer |
インポート ジョブの一意の整数 ID |
|
importId
|
importId | string |
インポート ジョブの一意の整数 ID |
|
状態
|
status | string |
インポート ジョブの状態 |
ResponseOfImportProgramMemberResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ImportProgramMemberResponse |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfCampaign
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of Campaign |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfListOperationOutputData
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ListOperationOutputData |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
キャンペーン
Marketoスマートキャンペーンの記録
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
活動中
|
active | boolean |
キャンペーンがアクティブかどうか。 トリガー キャンペーンにのみ適用されます |
|
createdAt
|
createdAt | string |
キャンペーンが作成された日時 |
|
説明
|
description | string |
スマート キャンペーンの説明 |
|
id
|
id | integer |
スマート キャンペーンの一意の整数 ID |
|
名前
|
name | string |
スマート キャンペーンの名前 |
|
programId
|
programId | integer |
親プログラムの ID (該当する場合) |
|
programName
|
programName | string |
親プログラムの名前 (該当する場合) |
|
型
|
type | string |
スマート キャンペーンの種類 |
|
updatedAt
|
updatedAt | string |
キャンペーンが最後に更新された日時 |
|
ワークスペース名
|
workspaceName | string |
親ワークスペースの名前 (該当する場合) |
ResponseOfLead
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of Lead |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfLeadByListId
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of Lead |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfLeadField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of LeadField |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfUpdateLeadField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of LeadFieldStatus |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfPushLeadToMarketo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of Lead |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfLeadAttribute
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of LeadAttribute |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfLeadAttribute2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of LeadAttribute2 |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfProgramMemberAttributes
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ProgramMemberAttribute |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfProgramMemberAttributes2
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ProgramMemberAttribute2 |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
Warnung
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | integer |
警告の整数コード |
|
メッセージ
|
message | string |
警告を説明するメッセージ |
ResponseOfExportResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ExportResponse |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfExportResponseWithToken
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ExportResponse |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfProgramMember
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ProgramMember |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ProgramMember
プログラム メンバー レコード。 常にリード ID が含まれますが、ターゲット インスタンスで使用できるフィールドに応じて、他のフィールドの数を指定できます。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
seq
|
seq | integer |
応答するレコードのシーケンスを示す整数。 この値は、要求入力に含まれるレコードの順序に関連付けられます。 Seq は応答の一部に過ぎず、送信しないでください。 |
|
leadId
|
leadId | integer |
潜在顧客レコードの一意の整数 ID |
|
reachedSuccess
|
reachedSuccess | boolean |
プログラム メンバーがプログラムの成功基準に達したかどうかを示すブール値 |
|
programId
|
programId | integer |
プログラムの一意の整数 ID |
|
acquiredBy
|
acquiredBy | boolean |
プログラム メンバーがプログラムによって取得されたかどうかを示すブール値 |
|
membershipDate
|
membershipDate | string |
リードがプログラムのメンバーになった日付 |
ResponseOfProgramMemberStatus
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ProgramMemberStatusResponse |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfProgramMemberData
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ProgramMemberStatusResponse |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ResponseOfProgramMemberDelete
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error |
要求が失敗した場合に発生したエラーの配列 |
|
moreResult
|
moreResult | boolean |
後続のページに結果が多いかどうかを示すブール値 |
|
nextPageToken
|
nextPageToken | string |
結果セットが許可されたバッチ サイズを超えた場合に指定されたページング トークン |
|
requestId
|
requestId | string |
行われた要求の ID |
|
結果
|
result | array of ProgramMemberDeleteResponse |
操作内の個々のレコードの結果の配列が空の場合があります |
|
成功
|
success | boolean |
要求が成功したかどうか |
|
警告
|
warnings | array of Warning |
操作に対して指定された警告の配列 |
ImportLeadResponse
インポート状態情報を含む応答
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
batchId
|
batchId | integer |
インポート バッチの一意の整数 ID |
|
importId
|
importId | string | |
|
メッセージ
|
message | string | |
|
numOfLeadsProcessed
|
numOfLeadsProcessed | integer |
これまでに処理された行の数 |
|
numOfRowsFailed
|
numOfRowsFailed | integer |
これまでに失敗した行の数 |
|
numOfRowsWithWarning
|
numOfRowsWithWarning | integer |
これまでに警告が表示された行の数 |
|
状態
|
status | string |
バッチの状態 |
ProgramMembership
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
acquiredBy
|
acquiredBy | boolean |
リードが親プログラムによって取得されたかどうか |
|
isExhausted
|
isExhausted | boolean |
リードがストリームで現在使い果たされているかどうか (該当する場合) |
|
membershipDate
|
membershipDate | string |
リードがプログラムのメンバーになった日付 |
|
nurtureCadence
|
nurtureCadence | string |
親ストリームの周期 (該当する場合) |
|
progressionStatus
|
progressionStatus | string |
親プログラムのリードのプログラムステータス |
|
reachedSuccess
|
reachedSuccess | boolean |
親プログラムでリードが成功状態にあるかどうか |
|
ストリーミング
|
stream | string |
親プログラムがエンゲージメント プログラムの場合、リードがメンバーになっているストリーム |
ExportResponse
エクスポート ジョブの状態情報を含む応答
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
エクスポート要求が作成された日付 |
|
errorMsg
|
errorMsg | string |
"Failed" 状態の場合のエラー メッセージ |
|
exportId
|
exportId | string |
エクスポート ジョブの一意の ID |
|
ファイルサイズ
|
fileSize | integer |
エクスポートされたファイルのサイズ (バイト単位)。 状態が "Completed" の場合にのみ値が設定され、それ以外の場合は null になります。 |
|
fileChecksum
|
fileChecksum | string |
エクスポートされたファイルの SHA-256 ハッシュ。 状態が "Completed" の場合にのみ値が設定され、それ以外の場合は null になります。 |
|
finishedAt
|
finishedAt | date-time |
エクスポート ジョブの終了時刻。 状態が "Completed" または "Failed" の場合にのみ値が設定されます。それ以外の場合は null |
|
format
|
format | string |
要求で指定されたファイルの形式 ("CSV"、"TSV"、"SSV") |
|
numberOfRecords
|
numberOfRecords | integer |
エクスポート ファイル内のレコードの数。 状態が "Completed" の場合にのみ値が設定され、それ以外の場合は null になります。 |
|
queuedAt
|
queuedAt | date-time |
エクスポート ジョブのキュー時間。 これは、"Queued" 状態に達すると、その null の前に値を持つことになります |
|
startedAt
|
startedAt | date-time |
エクスポート ジョブの開始時刻。 これは、"処理中" の状態に達すると、その null の前に値を持つことになります |
|
状態
|
status | string |
エクスポート ジョブの状態 ("Created"、"Queued"、"Processing"、"Canceled"、"Completed"、"Failed") |
理由
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | string |
理由の整数コード |
|
メッセージ
|
message | string |
操作の状態の理由を説明するメッセージ |
LeadMapAttribute
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
属性の名前 |
|
読み取り専用
|
readOnly | boolean |
属性が読み取り専用かどうか |
エラー
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コード
|
code | string |
エラーのエラー コード。 エラー コードの完全な一覧 については、こちらを参照してください |
|
メッセージ
|
message | string |
エラーの原因を説明するメッセージ |
ProgramMemberStatusResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | string |
レコードに対して実行された操作の状態 |
|
理由
|
reasons | array of Reason |
操作が成功しなかった理由の一覧。 理由は API 応答にのみ存在し、送信しないでください |
|
leadId
|
leadId | integer |
プログラム メンバーに関連付けられているリードの ID |
|
seq
|
seq | integer |
応答するレコードのシーケンスを示す整数。 この値は、要求入力に含まれるレコードの順序に関連付けられます。 Seq は応答の一部に過ぎず、送信しないでください。 |
ProgramMemberDeleteResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | string |
レコードに対して実行された操作の状態 |
|
理由
|
reasons | array of Reason |
操作が成功しなかった理由の一覧。 理由は API 応答にのみ存在し、送信しないでください |
|
leadId
|
leadId | integer |
プログラム メンバーに関連付けられているリードの ID |
|
seq
|
seq | integer |
応答するレコードのシーケンスを示す整数。 この値は、要求入力に含まれるレコードの順序に関連付けられます。 Seq は応答の一部に過ぎず、送信しないでください。 |
StaticList
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
createdAt
|
createdAt | string |
リストが作成された日時 |
|
説明
|
description | string |
静的リストの説明 |
|
id
|
id | integer |
静的リストの一意の整数 ID |
|
名前
|
name | string |
静的リストの名前 |
|
programName
|
programName | string |
プログラムの名前 |
|
updatedAt
|
updatedAt | string |
リストが最後に更新された日時 |
|
ワークスペース名
|
workspaceName | string |
親ワークスペースの名前 (該当する場合) |
BrowseAllPrograms
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
チャネル
|
channel | string |
プログラムのチャネル |
|
createdAt
|
createdAt | date-time |
資産が作成された日時 |
|
説明
|
description | string |
資産の説明 |
|
フォルダ
|
folder | Folder |
フォルダーの JSON 表現 |
|
id
|
id | integer |
資産の ID |
|
名前
|
name | string |
資産の名前 |
|
sfdcId
|
sfdcId | string |
SFDC キャンペーンにリンクされている場合のプログラムの SFDC ID |
|
sfdcName
|
sfdcName | string |
該当する場合は、リンクされた SFDC キャンペーンの名前 |
|
状態
|
status | string |
プログラムの状態。 電子メールとエンゲージメント プログラムの種類でのみ有効です。 |
|
型
|
type | string |
プログラムの種類 |
|
updatedAt
|
updatedAt | date-time |
資産が最後に更新された日時 |
|
URL
|
url | string |
Marketo UI の資産の URL |
|
ワークスペース
|
workspace | string |
ワークスペースの名前 |
FolderContentResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
型
|
type | string |
FileFolder
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
名前
|
name | string | |
|
型
|
type | string |
ResponseOfProgramResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of ProgramResponse | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
ResponseOfSmartListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of SmartListResponse | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
ResponseOfSmartListResponseWithRules
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of SmartListResponseWithRules | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
SmartListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
スマート リストの ID |
|
名前
|
name | string |
スマート リストの名前 |
|
説明
|
description | string |
スマート リストの説明 |
|
createdAt
|
createdAt | date-time |
スマート リストが作成された日時 |
|
updatedAt
|
updatedAt | date-time |
スマート リストが最後に更新された日時 |
|
URL
|
url | string |
Marketo UI のスマート リストの URL |
|
フォルダ
|
folder | Folder |
フォルダーの JSON 表現 |
|
ワークスペース
|
workspace | string |
ワークスペースの名前 |
SmartListResponseWithRules
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
スマート リストの ID |
|
名前
|
name | string |
スマート リストの名前 |
|
説明
|
description | string |
スマート リストの説明 |
|
createdAt
|
createdAt | date-time |
スマート リストが作成された日時 |
|
updatedAt
|
updatedAt | date-time |
スマート リストが最後に更新された日時 |
|
URL
|
url | string |
Marketo UI のスマート リストの URL |
|
フォルダ
|
folder | Folder |
フォルダーの JSON 表現 |
|
ワークスペース
|
workspace | string |
ワークスペースの名前 |
|
ルール
|
rules | SmartListRules |
スマート リスト ルールの JSON 表記 |
ResponseOfStaticListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of StaticListResponse | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
StaticListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
静的リストの ID |
|
名前
|
name | string |
静的リストの名前 |
|
説明
|
description | string |
静的リストの説明 |
|
createdAt
|
createdAt | date-time |
静的リストが作成された日時 |
|
updatedAt
|
updatedAt | date-time |
静的リストが最後に更新された日時 |
|
URL
|
url | string |
Marketo UI の静的リストの URL |
|
フォルダ
|
folder | Folder |
フォルダーの JSON 表現 |
|
ワークスペース
|
workspace | string |
ワークスペースの名前 |
|
computedUrl
|
computedUrl | string |
ProgramResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
チャネル
|
channel | string |
プログラムのチャネル |
|
costs
|
costs | array of Costs |
関連する期間コストの一覧 |
|
createdAt
|
createdAt | date-time |
資産が作成された日時 |
|
説明
|
description | string |
資産の説明 |
|
終了日
|
endDate | date-time |
プログラムの終了日。 イベント、電子メール、ウェビナーの種類のプログラムに適用 |
|
フォルダ
|
folder | ProgramFolder | |
|
id
|
id | integer |
資産の ID |
|
名前
|
name | string |
資産の名前 |
|
sfdcId
|
sfdcId | string |
SFDC キャンペーンにリンクされている場合のプログラムの SFDC ID |
|
sfdcName
|
sfdcName | string |
該当する場合は、リンクされた SFDC キャンペーンの名前 |
|
startDate
|
startDate | date-time |
プログラムの開始日。 イベント、電子メール、ウェビナーの種類のプログラムに適用 |
|
状態
|
status | string |
プログラムの状態。 電子メールとエンゲージメント プログラムの種類でのみ有効です。 |
|
tags
|
tags | array of Tags |
関連するプログラム タグの一覧 |
|
型
|
type | string |
プログラムの種類 |
|
updatedAt
|
updatedAt | date-time |
資産が最後に更新された日時 |
|
URL
|
url | string |
Marketo UI の資産の URL |
|
ワークスペース
|
workspace | string |
ワークスペースの名前 |
|
marketingProgramProgressionId
|
marketingProgramProgressionId | integer | |
|
headStart
|
headStart | boolean |
プログラムに対して 'Head Start' 関数が有効になっているかどうか |
FileResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
ファイルが作成された日時 |
|
説明
|
description | string |
ファイルの説明 |
|
フォルダ
|
folder | FileFolder | |
|
id
|
id | integer |
ファイルの ID |
|
mimeType（マイムタイプ）
|
mimeType | string |
ファイルの MIME の種類 |
|
名前
|
name | string |
ファイルの名前 |
|
size
|
size | integer |
ファイルのサイズ (バイト単位) |
|
updatedAt
|
updatedAt | date-time |
ファイルが最後に更新された日時 |
|
URL
|
url | string |
ファイルのパブリックにアクセス可能な URL |
ResponseOfFileResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of FileResponse | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
FolderResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
accessZoneId
|
accessZoneId | integer | |
|
createdAt
|
createdAt | date-time |
フォルダーが作成された日時 |
|
説明
|
description | string |
フォルダーの説明 |
|
folderId
|
folderId | Folder |
フォルダーの JSON 表現 |
|
folderType
|
folderType | string |
フォルダーの種類 |
|
id
|
id | integer |
フォルダーの ID |
|
isArchive
|
isArchive | boolean |
フォルダーのアーカイブ状態 |
|
isSystem
|
isSystem | boolean |
フォルダーがシステム管理されているかどうか |
|
名前
|
name | string |
フォルダーの名前。 プログラムには適用されません |
|
親
|
parent | Folder |
フォルダーの JSON 表現 |
|
パス
|
path | string |
フォルダーのパス |
|
updatedAt
|
updatedAt | date-time |
フォルダーが最後に更新された日時 |
|
URL
|
url | string |
フォルダーの URL |
|
ワークスペース
|
workspace | string |
ワークスペースの名前 |
ResponseOfIdResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of IdResponse | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
タグ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
tagType
|
tagType | string |
タグの名前 |
|
タグ値
|
tagValue | string |
タグの値 |
ResponseOfBrowseAllPrograms
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of BrowseAllPrograms | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
ResponseOfFolderResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of FolderResponse | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
ResponseOfFolderContentResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
結果
|
result | array of FolderContentResponse | |
|
成功
|
success | boolean | |
|
警告
|
warnings | array of string |
IdResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
資産の ID |
コスト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
費用
|
cost | integer |
コストの金額 |
|
手記
|
note | string |
コストに関する注意事項 |
|
startDate
|
startDate | date-time |
期間コストの開始日 |
ProgramFolder
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
型
|
type | string |
プログラム フォルダーの種類 |
|
value
|
value | integer |
プログラム フォルダーの ID |
|
folderName
|
folderName | string |
プログラム フォルダーの名前 |
フォルダー
フォルダーの JSON 表現
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
フォルダーの ID |
|
型
|
type | string |
フォルダーの種類 |
SmartListRules
スマート リスト ルールの JSON 表記
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
filterMatchType
|
filterMatchType | string |
スマート リスト フィルターの一致の種類 (ルール ロジック) |
|
トリガー
|
triggers | array of string |
スマート リスト トリガーの一覧 |
|
filters
|
filters | array of SmartListFilters |
スマート リスト フィルターの一覧 |
SmartListFilters
スマート リスト フィルターの JSON 表現
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer |
フィルターの ID |
|
名前
|
name | string |
フィルターの名前 |
|
ruleTypeId
|
ruleTypeId | integer |
ルールの種類の ID |
|
ruleType
|
ruleType | string |
ルールの種類の名前 |
|
オペレータ
|
operator | string |
演算子の名前 |
|
conditions
|
conditions | array of SmartListConditions |
スマート リスト条件の一覧 |
SmartListConditions
スマート リスト条件の JSON 表現
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
activityAttributeId
|
activityAttributeId | integer |
アクティビティ属性の ID |
|
activityAttributeName
|
activityAttributeName | string |
アクティビティ属性の名前 |
|
オペレータ
|
operator | string |
演算子の値 |
|
values
|
values | array of string |
値の一覧 |
|
プライマリー
|
isPrimary | boolean |
条件がプライマリかどうか (スマート リストの最初の条件) |
オブジェクト
これは型 'object' です。