Marketo MA (プレビュー)

  • リファレンス

Marketo マーケティング自動化。 この API は、キャンペーン、プログラム、リード、リスト (静的およびスマート) などの Marketo オブジェクトや、ファイルやフォルダーなどのファイルシステム資産へのアクセスを提供します。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate Standard 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps Standard 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Marketo 開発者関係
[URL] http://developers.marketo.com
メール developerfeedback@marketo.com
Connector Metadata
発行者 Microsoft Inc.
Web サイト https://www.marketo.com/
プライバシー ポリシー https://documents.marketo.com/legal/privacy/
サービス条件 https://go.microsoft.com/fwlink/?linkid=2237005
カテゴリー マーケティング、営業、CRM

接続を作成する

コネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ Description Required
MunchkinID string Marketo MunchkinID (管理者ページを参照) True
Client ID string Client ID True
Client Secret securestring Client Secret True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

ID

Marketo から アクセス トークン を取得します。 この エンドポイント への呼び出しは、API 呼び出し制限にはカウントされません。
ID

Marketo から アクセス トークン を取得します。 この エンドポイント への呼び出しは、API 呼び出し制限にはカウントされません。
ID でキャンペーンを取得

キャンペーンのレコードを ID で返します。必要な権限: 読み取り専用キャンペーン、読み取り/書き込みキャンペーン

注: この エンドポイント は置き換えられました。 代わりに ID によるスマート キャンペーンの取得 エンドポイント を使用してください。
ID でファイルを取得

指定された ID のファイル レコードを返します。必要な権限: 読み取り専用アセット、読み取り/書き込みアセット
ID でプログラムを取得する

指定された ID のプログラム レコードを返します。必要な権限: 読み取り専用アセット、読み取り/書き込みアセット
ID でリードを取得する

Marketo ID を介して単一のリードレコードを取得します。必要な権限: 読み取り専用リード、読み取り/書き込みリード
ID によるスマート リストの取得

ID によってスマート リスト レコードを取得します。必要な権限: アセットの読み取りまたはアセットの読み取り/書き込み
ID によるリストの取得

リストのレコードを ID で返します。 必要な権限: 読み取り専用リード、読み取り/書き込みリード
ID による静的リストの取得

ID によって静的リスト レコードを取得します。必要な権限: アセットの読み取りまたはアセットの読み取り/書き込み
ID を指定してフォルダーを取得

指定された ID のフォルダ レコードを返します。必要な権限: 読み取り専用アセット、読み取り/書き込みアセット
Metadata を更新する

対象プログラムのメタデータを更新します。 必要な権限: 読み取り/書き込みアセット
インポート プログラム メンバーの取得の失敗

インポート バッチ ジョブの失敗のリストを返します。 必要な権限: 読み取り/書き込みリード
インポート プログラム メンバーの失敗の取得

インポート バッチ ジョブの状態を返します。 必要な権限: 読み取り/書き込みリード
インポート プログラム メンバーの警告の取得

インポート バッチ ジョブの警告のリストを返します。 必要な権限: 読み取り/書き込みリード
エクスポート プログラム メンバー ジョブのエンキュー

エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに入れられ、コンピューティング リソースが利用可能になったときにジョブが開始されます。 エクスポート ジョブは「作成済み」状態である必要があります。
エクスポート プログラム メンバー ジョブのキャンセル

エクスポート ジョブをキャンセルします。 必要な権限: 読み取りのみリード
エクスポート プログラム メンバー ジョブのステータスの取得

エクスポート ジョブのステータスを返します。 ジョブのステータスは、完了または失敗ステータスに達してから 30 日間使用できます。 必要な権限: 読み取りのみリード
エクスポート プログラム メンバー ジョブの作成

「filter」パラメータで定義された検索条件のエクスポート ジョブを作成します。 リクエストは「exportId」を返します。これは、後続の一括エクスポート プログラム メンバー エンドポイントへの呼び出しでパラメータとして渡されます。
エクスポート プログラム メンバー ジョブの取得

過去 7 日間に作成されたエクスポート ジョブのリストを返します。 必要な権限: 読み取りのみリード
エクスポート プログラム メンバー ファイルの取得

エクスポート ジョブのファイルの内容を返します。 エクスポート ジョブは「完了済み」状態である必要があります。 Get Export Program Member Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード

ファイル形式は、エクスポート Program Member 作成ジョブ エンドポイント を呼び出すことで指定されます。 以下は既定のファイル形式 ("CSV") の例です。

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com
エクスポート リード ジョブ ステータスの取得

エクスポート ジョブのステータスを返します。 ジョブのステータスは、完了または失敗ステータスに達してから 30 日間使用できます。 必要な権限: 読み取りのみリード
キャンペーンのリクエスト

一連のリードをトリガー キャンペーンに渡し、キャンペーンのフローを実行します。 指定されたキャンペーンには「Campaign is Requested: Web Service API」トリガーがあり、アクティブである必要があります。 キャンペーンの親プログラムにローカルな私のトークンは、コンテンツをカスタマイズするために実行のためにオーバーライドできます。 コールごとに最大 100 件のリードが許可されます。 必要な権限: キャンペーンの実行
キャンペーンをスケジュールする

バッチ キャンペーンを特定の時間に実行するようにリモートでスケジュールします。 キャンペーンの親プログラムにローカルな私のトークンは、コンテンツをカスタマイズするために実行のためにオーバーライドできます。 以下で説明する「cloneToProgramName」パラメーターを使用する場合、この エンドポイント の呼び出しは 1 日あたり 20 件に制限されます。 必要な権限: キャンペーンの実行
キャンペーンを取得する

キャンペーン レコードの一覧を返します。 必要な権限: 読み取りのみキャンペーン/書き込みキャンペーン

注: この エンドポイント は置き換えられました。 代わりに スマート キャンペーンの取得 エンドポイント を使用してください。
クローン プログラム

対象プログラムをクローンします。 必要な権限: 読み取り/書き込みアセット
スマート リストの削除

指定されたスマート リストの削除を作成します。 必要な権限: 読み取り/書き込みアセット
スマート リストを取得

ユーザーが作成したスマート リスト レコードのリストを取得します。 必要な権限: リード アセットまたはリードライト アセット
スマートリストのクローン

指定されたスマート リストのクローンを作成します。 必要な権限: 読み取り/書き込みアセット
タグごとにプログラムを取得する

指定されたタグ タイプとタグ値に一致するプログラムのリストを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット
ファイル コンテンツ更新

ファイルの現在のコンテンツを、含まれているペイロードで置き換えます。 必要な権限: 読み取り/書き込みアセット
ファイルを作成する

含まれているペイロードから新しいファイルを作成します。 必要な権限: 読み取り/書き込みアセット
ファイルを取得する

指定されたフォルダーからファイルを返します。 必要な権限: 読み取りのみアセット/書き込みアセット
フィルター タイプごとにリードを取得

特定のフィールドの値のリストに基づいて、最大 300 件のリードのリストを返します。 必要な権限: 読み取りのみリード/書き込みリード
フォルダのメタデータを更新する

指定されたフォルダーのメタデータを更新します。 必要な権限: 読み取り/書き込みアセット
フォルダー コンテンツの取得

指定されたフォルダーの内容のレコードを返します。 必要な権限: 読み取りのみアセット/書き込みアセット
フォルダーの作成

新しいフォルダーを作成します。 必要な権限: 読み取り/書き込みアセット
フォルダーの削除

指定したフォルダーを削除します。 フォルダーにコンテンツがある場合、削除は失敗します。 必要な権限: 読み取り/書き込みアセット
フォルダーを取得する

指定されたルート フォルダー内から子フォルダーを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット
フォルダーを名前で取得

指定された名前のフォルダー レコードを返します。 必要な権限: 読み取りのみアセット/書き込みアセット
プログラム ID でリードを取得

指定されたプログラムのメンバーであるリードのリストを取得します。 必要な権限: 読み取りのみリード/書き込みリード
プログラム ID によるスマート リストの取得

メール プログラムによってスマート リスト レコードを取得します。必要な権限: アセットの読み取りまたはアセットの読み取り/書き込み
プログラム タグの更新

プログラム タグの更新。 必要な権限: 読み取り/書き込みアセット
プログラム タグを削除する

不要なプログラム タグを削除します。 必要な権限: 読み取り/書き込みアセット
プログラム メンバー ステータスの同期

ターゲット プログラム内のリードのリストのプログラム メンバー ステータスを変更します。 メンバーがプログラムに参加していない場合、メンバーはプログラムに追加されます。 必要な権限: 読み取り/書き込みリード
プログラム メンバー フィールドを名前で取得

単一のプログラム メンバーのメタデータを取得します。 必要な権限: 読み取り/書き込みスキーマ標準フィールド、読み取り/書き込みスキーマ カスタム フィールド
プログラム メンバーのインポート

データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要な権限: 読み取り/書き込みリード
プログラム メンバーの削除

宛先インスタンスからメンバーのリストを削除します。 必要な権限: 読み取り/書き込みリード
プログラム メンバーの取得

特定のフィールドの値のリストに基づいて、最大 300 件のプログラム メンバーを返します。 カスタム フィールドである filterType を指定する場合、カスタム フィールドの dataType は「string」または「integer」のいずれかである必要があります。 「leadId」以外の filterType を指定した場合、リクエストで最大 100,000 のプログラム メンバー レコードを処理できます。 必要な権限: 読み取りのみリード/書き込みリード
プログラムの取得

ターゲット インスタンスからアクセス可能なプログラムのリストを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット
プログラムの承認

対象プログラムを承認します。 未承認の電子メール プログラムにのみ有効です。 必要な権限: 読み取り/書き込みアセット
プログラムの非承認

対象プログラムを非承認します。 承認の電子メール プログラムにのみ有効です。 必要な権限: 読み取り/書き込みアセット
プログラムを作成する

新しいプログラムを作成します。 必要な権限: 読み取り/書き込みアセット
プログラムメンバーについて説明する

API を介して対話できるすべてのフィールドのリストを含む、ターゲット インスタンスのプログラム メンバー オブジェクトに関するメタデータを返します。 必要な権限: 読み取りのみリード/書き込みリード

注: この エンドポイント は置き換えられました。 代わりに プログラム メンバーの説明 エンドポイント を使用してください。
プログラムメンバーについて説明する

API を介して対話できるすべてのフィールドのリストを含む、ターゲット インスタンスのプログラム メンバー オブジェクトに関するメタデータを返します。 必要な権限: 読み取りのみリード/書き込みリード
プログラムメンバーデータの同期

ターゲット プログラム内のリードのリストのプログラム メンバー データを変更します。 この API を使用してデータを変更できるのは、プログラムの既存のメンバーのみです。 必要な権限: 読み取り/書き込みリード
プロジェクトを削除する

対象プログラムを削除します。 プログラムには、プログラム外で使用されるアセットを含めることはできません。 必要な権限: 読み取り/書き込みアセット
メンバー リスト

リードが指定された静的リストのメンバーであるかどうかを確認します。 必要な権限: 読み取り/書き込みリード
リスト ID でリードを取得

指定された静的リストのメンバーである個人レコードを取得します。 必要な権限: 読み取りのみリード/書き込みリード
リスト ID でリードを取得

指定された静的リストのメンバーである個人レコードを取得します。 必要な権限: 読み取りのみリード/書き込みリード
リストから削除

対象の静的リストから指定されたターゲット レコードのセットを削除します。 必要な権限: 読み取り/書き込みリード
リストに追加

指定された個人レコードのセットをターゲットの静的リストに追加します。 リクエストあたりのリード ID の制限は 300 です。 必要な権限: 読み取り/書き込みリード
リストの取得

与えられたフィルター パラメータに基づいた静的リスト レコードのセットを返します。 必要な権限: 読み取りのみリード/書き込みリード
リード ジョブのエクスポートの取得

過去 7 日間に作成されたエクスポート ジョブのリストを返します。 必要な権限: 読み取りのみリード
リード ファイルを取得する

エクスポート ジョブのファイルの内容を返します。 エクスポート ジョブは「完了済み」状態である必要があります。 Get Export Lead Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード

ファイル形式は、エクスポート リードの作成ジョブ エンドポイント を呼び出すことで指定されます。 以下は既定のファイル形式 ("CSV") の例です。

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com
リード フィールドを名前で取得

単一のリードフィールドのメタデータを取得します。 必要な権限: 読み取り/書き込みスキーマ標準フィールド、読み取り/書き込みスキーマ カスタム フィールド
リードのインポート

データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要な権限: 読み取り/書き込みリード
リードのインポート失敗の取得

インポート バッチ ジョブの失敗のリストを返します。 必要な権限: 読み取り/書き込みリード
リードのインポート状態の取得

インポート バッチ ジョブの状態を返します。 必要な権限: 読み取り/書き込みリード
リードのインポート警告の取得

インポート バッチ ジョブの警告のリストを返します。 必要な権限: 読み取り/書き込みリード
リードの同期

リードのリストをターゲット インスタンスに同期します。 必要な権限: 読み取り/書き込みリード
リードの説明

API を介して対話できるすべてのフィールドのリストを含む、ターゲット インスタンスのリード オブジェクトに関するメタデータを返します。 必要な権限: 読み取りのみリード/書き込みリード

注: この エンドポイント は置き換えられました。 代わりに Describe Lead2 エンドポイント を使用してください。
リードの説明2

ターゲット インスタンスのリード オブジェクトの検索可能なフィールドのリストを返します。 必要な権限: 読み取りのみリード/書き込みリード
リードを Marketo にプッシュする

リードを更新挿入し、Marketo にリードをプッシュ アクティビティを生成します。 必要な権限: 読み取り/書き込みリード
リードを削除する

宛先インスタンスからリードのリストを削除します。 必要な権限: 読み取り/書き込みリード
リードジョブのエクスポートのエンキュー

エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに入れられ、コンピューティング リソースが利用可能になったときにジョブが開始されます。 エクスポート ジョブは「作成済み」状態である必要があります。 Get Export Lead Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード
リードジョブのエクスポートの作成

「filter」パラメータで定義された検索条件のエクスポート ジョブを作成します。 リクエストは「exportId」を返します。これは、後続の一括エクスポート リード エンドポイントへの呼び出しでパラメータとして渡されます。 Enqueue Export Lead Job エンドポイント を使用して、エクスポート ジョブを処理のためにキューに入れます。 Get Export Lead Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード
リードジョブのエクスポートをキャンセル

エクスポート ジョブをキャンセルします。 必要な権限: 読み取りのみリード
名前でファイルを取得する

指定された名前のファイル レコードを返します。 必要な権限: 読み取りのみアセット/書き込みアセット
名前でプログラムを取得する

指定された名前の番組レコードを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット
名前によるスマート リストの取得

スマート リスト レコードを名前で取得します。 必要な権限: リード アセットまたはリードライト アセット
名前による静的リストの取得

静的リスト レコードを名前で取得します。 必要な権限: リード アセットまたはリードライト アセット
更新されたリード フィールドのデータ

ターゲット インスタンスのリード フィールドのメタデータを更新します。 更新ルールは こちら を参照してください。 必要な権限: 読み取り/書き込みスキーマ標準フィールド、読み取り/書き込みスキーマ カスタム フィールド
静的リストの作成

新しい静的リストを作成します。 必要な権限: 読み取り/書き込みアセット
静的リストの削除

指定された静的リストの削除を作成します。 必要な権限: 読み取り/書き込みアセット
静的リストの取得

静的リスト レコードのリストを取得します。 必要な権限: リード アセットまたはリードライト アセット
静的リストメタデータ更新

静的リストアセットのメタデータを更新します。 必要な権限: 読み取り/書き込みアセット

ID

操作 ID:
identityUsingGET

Marketo から アクセス トークン を取得します。 この エンドポイント への呼び出しは、API 呼び出し制限にはカウントされません。

パラメーター

名前 キー 必須 型 説明
Marketo REST API の clientID
client_id True string

管理者からのクライアント ID > 統合 > 起動ポイントメニュー。
Marketo REST API のクライアント シークレット
 client_secret True string

管理者からのクライアント シークレット > 統合 > 起動ポイントメニュー。
許可の種類。 ケース クライアントの認証情報
 grant_type True string

付与タイプです。

戻り値

Body
ResponseOfIdentity

ID

操作 ID:
identityUsingPOST

Marketo から アクセス トークン を取得します。 この エンドポイント への呼び出しは、API 呼び出し制限にはカウントされません。

パラメーター

名前 キー 必須 型 説明
Marketo REST API の clientID
client_id True string

管理者からのクライアント ID > 統合 > 起動ポイントメニュー。
Marketo REST API のクライアント シークレット
 client_secret True string

管理者からのクライアント シークレット > 統合 > 起動ポイントメニュー。
許可の種類。 ケース クライアントの認証情報
 grant_type True string

付与タイプです。

戻り値

Body
ResponseOfIdentity

ID でキャンペーンを取得

操作 ID:
getCampaignByIdUsingGET

キャンペーンのレコードを ID で返します。必要な権限: 読み取り専用キャンペーン、読み取り/書き込みキャンペーン

注: この エンドポイント は置き換えられました。 代わりに ID によるスマート キャンペーンの取得 エンドポイント を使用してください。

パラメーター

名前 キー 必須 型 説明
campaignId
 campaignId True integer

campaignId

戻り値

Body
ResponseOfCampaign

ID でファイルを取得

操作 ID:
getFileByIdUsingGET

指定された ID のファイル レコードを返します。必要な権限: 読み取り専用アセット、読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
ファイルの ID
 id True integer

データベース内のファイルの ID

戻り値

Body
ResponseOfFileResponse

ID でプログラムを取得する

操作 ID:
getProgramByIdUsingGET

指定された ID のプログラム レコードを返します。必要な権限: 読み取り専用アセット、読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id

戻り値

Body
ResponseOfProgramResponse

ID でリードを取得する

操作 ID:
getLeadByIdUsingGET

Marketo ID を介して単一のリードレコードを取得します。必要な権限: 読み取り専用リード、読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
Marketo リード ID
 leadId True integer

Marketo リード ID
フィールド名のカンマ区切りリスト
 fields array

フィールド名のカンマ区切りリスト 省略した場合、次の既定のフィールドが返されます: email、updatedAt、createdAt、lastName、firstName、id。

戻り値

Body
ResponseOfLead

ID によるスマート リストの取得

操作 ID:
getSmartListByIdUsingGET

ID によってスマート リスト レコードを取得します。必要な権限: アセットの読み取りまたはアセットの読み取り/書き込み

パラメーター

名前 キー 必須 型 説明
取得するスマートリストの ID
 id True integer

取得するスマートリストの ID
true に設定すると、スマート リスト ルールが設定されます。 既定の False
 includeRules boolean

true に設定すると、スマート リスト ルールが設定されます。 既定の False

戻り値

Body
ResponseOfSmartListResponseWithRules

ID によるリストの取得

操作 ID:
getListByIdUsingGET

リストのレコードを ID で返します。 必要な権限: 読み取り専用リード、読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
レコードを取得する静的リストの ID
 listId True integer

レコードを取得する静的リストの ID

戻り値

Body
ResponseOfStaticList

ID による静的リストの取得

操作 ID:
getStaticListByIdUsingGET

ID によって静的リスト レコードを取得します。必要な権限: アセットの読み取りまたはアセットの読み取り/書き込み

パラメーター

名前 キー 必須 型 説明
取得する静的リストの ID
 id True integer

取得する静的リストの ID

戻り値

Body
ResponseOfStaticListResponse

ID を指定してフォルダーを取得

操作 ID:
getFolderByIdUsingGET

指定された ID のフォルダ レコードを返します。必要な権限: 読み取り専用アセット、読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
取得するフォルダーの ID
 id True integer

取得するフォルダーの ID
次のページ トークン (プログラムまたはフォルダー)
 type True string

フォルダーの種類です。 「フォルダー」または「プログラム」

戻り値

Body
ResponseOfFolderResponse

Metadata を更新する

操作 ID:
updateProgramUsingPOST

対象プログラムのメタデータを更新します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id
コスト
 cost True integer

コストの金額
note
 note string

コストのメモ
startDate
 startDate True date-time

期間費用の開始日
costsDestructiveUpdate
 costsDestructiveUpdate boolean

true に設定すると、既存のコストが破棄され、指定されたコストに置き換えられます
description
 description string

プログラムの説明を更新
endDate
 endDate string

プログラムの終了日です。 イベント、メール、ウェビナータイプのプログラムに適用可能
名称
 name string

プログラムの名前
startDate
 startDate string

プログラムの開始日です。 イベント、メール、ウェビナータイプのプログラムに適用可能
tagType
 tagType string

プログラム タグの種類
tagValue
 tagValue string

タグの値

戻り値

Body
ResponseOfProgramResponse

インポート プログラム メンバーの取得の失敗

操作 ID:
getImportProgramMemberFailuresUsingGET

インポート バッチ ジョブの失敗のリストを返します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
インポート バッチの ID です。
 batchId True integer

インポート バッチの ID です。

戻り値

返答
object

インポート プログラム メンバーの失敗の取得

操作 ID:
getImportProgramMemberStatusUsingGET

インポート バッチ ジョブの状態を返します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
インポート バッチの ID です。
 batchId True integer

インポート バッチの ID です。

戻り値

Body
ResponseOfImportProgramMemberResponse

インポート プログラム メンバーの警告の取得

操作 ID:
getImportProgramMemberWarningsUsingGET

インポート バッチ ジョブの警告のリストを返します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
インポート バッチの ID です。
 batchId True integer

インポート バッチの ID です。

戻り値

返答
object

エクスポート プログラム メンバー ジョブのエンキュー

操作 ID:
enqueueExportProgramMembersUsingPOST

エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに入れられ、コンピューティング リソースが利用可能になったときにジョブが開始されます。 エクスポート ジョブは「作成済み」状態である必要があります。

パラメーター

名前 キー 必須 型 説明
バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。

戻り値

Body
ResponseOfExportResponse

エクスポート プログラム メンバー ジョブのキャンセル

操作 ID:
cancelExportProgramMembersUsingPOST

エクスポート ジョブをキャンセルします。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
エクスポート バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。

戻り値

Body
ResponseOfExportResponse

エクスポート プログラム メンバー ジョブのステータスの取得

操作 ID:
getExportProgramMembersStatusUsingGET

エクスポート ジョブのステータスを返します。 ジョブのステータスは、完了または失敗ステータスに達してから 30 日間使用できます。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
エクスポート バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。

戻り値

Body
ResponseOfExportResponse

エクスポート プログラム メンバー ジョブの作成

操作 ID:
createExportProgramMembersUsingPOST

「filter」パラメータで定義された検索条件のエクスポート ジョブを作成します。 リクエストは「exportId」を返します。これは、後続の一括エクスポート プログラム メンバー エンドポイントへの呼び出しでパラメータとして渡されます。

パラメーター

名前 キー 必須 型 説明
名称
 name True string

REST API ヘッダーフィールドの名前
価値
 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

プログラム メンバーのステータス名の配列。 既定またはユーザー定義、あるいはその両方にすることができます。 複数のステータス名は論理和で結合されます。
endAt
 endAt string

日付範囲の終了フィルター (ISO 8601 形式)
startAt
 startAt string

日付範囲の開始フィルター (ISO-8601 形式)
format
 format string

ファイルをファイル形式 ("CSV", "TSV", "SSV") です。 既定値は "CSV" です

戻り値

Body
ResponseOfExportResponse

エクスポート プログラム メンバー ジョブの取得

操作 ID:
getExportProgramMembersUsingGET

過去 7 日間に作成されたエクスポート ジョブのリストを返します。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
フィルタリングする状態のカンマ区切りリストです。
 status array

フィルタリングする状態のカンマ区切りリストです。
返されるバッチ サイズです。 最大値および既定値は 300 です。
 batchSize integer

返されるバッチ サイズです。 最大値および既定値は 300 です。
結果セットがバッチ サイズより大きい場合、この エンドポイント によって返されます。
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfExportResponseWithToken

エクスポート プログラム メンバー ファイルの取得

操作 ID:
getExportProgramMembersFileUsingGET

エクスポート ジョブのファイルの内容を返します。 エクスポート ジョブは「完了済み」状態である必要があります。 Get Export Program Member Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード

ファイル形式は、エクスポート Program Member 作成ジョブ エンドポイント を呼び出すことで指定されます。 以下は既定のファイル形式 ("CSV") の例です。

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

パラメーター

名前 キー 必須 型 説明
エクスポート バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。
抽出されたデータの部分的な取得をサポートする方法です。
 Range string

抽出されたデータの部分的な取得をサポートするには、タイプ「バイト」の HTTP ヘッダー「Range」を指定できます。 詳細は RFC2616 「範囲検索のリクエスト」を参照してください。 ヘッダーが設定されていない場合は、コンテンツ全体が返されます。

戻り値

返答
object

エクスポート リード ジョブ ステータスの取得

操作 ID:
getExportLeadsStatusUsingGET

エクスポート ジョブのステータスを返します。 ジョブのステータスは、完了または失敗ステータスに達してから 30 日間使用できます。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
エクスポート バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。

戻り値

Body
ResponseOfExportResponse

キャンペーンのリクエスト

操作 ID:
triggerCampaignUsingPOST

一連のリードをトリガー キャンペーンに渡し、キャンペーンのフローを実行します。 指定されたキャンペーンには「Campaign is Requested: Web Service API」トリガーがあり、アクティブである必要があります。 キャンペーンの親プログラムにローカルな私のトークンは、コンテンツをカスタマイズするために実行のためにオーバーライドできます。 コールごとに最大 100 件のリードが許可されます。 必要な権限: キャンペーンの実行

パラメーター

名前 キー 必須 型 説明
トリガーするキャンペーンの ID
 campaignId True integer

トリガーするキャンペーンの ID
id
 id True integer

リード レコードの一意の整数 ID
名称
 name True string

トークンの名前です。 「{{my.name}}」の形式にする必要があります
価値
 value True string

トークンの値

戻り値

Body
ResponseOfCampaign

キャンペーンをスケジュールする

操作 ID:
scheduleCampaignUsingPOST

バッチ キャンペーンを特定の時間に実行するようにリモートでスケジュールします。 キャンペーンの親プログラムにローカルな私のトークンは、コンテンツをカスタマイズするために実行のためにオーバーライドできます。 以下で説明する「cloneToProgramName」パラメーターを使用する場合、この エンドポイント の呼び出しは 1 日あたり 20 件に制限されます。 必要な権限: キャンペーンの実行

パラメーター

名前 キー 必須 型 説明
スケジュールするバッチ キャンペーンの ID です。
 campaignId True integer

スケジュールするバッチ キャンペーンの ID です。
cloneToProgramName
 cloneToProgramName string

結果のプログラム名です。 この属性を設定すると、キャンペーン、親プログラム、およびそのすべてのアセットが新しい名前で作成されます。 親プログラムが複製され、新しく作成されたキャンペーンがスケジュールされます。 結果として得られるプログラムは親の下に作成されます。 スニペット、プッシュ通知、アプリ内メッセージ、静的リスト、レポート、ソーシャル アセットを含むプログラムは、この方法では複製できない場合があります
runAt
 runAt date-time

キャンペーンを実行する日時です。 設定されていない場合、キャンペーンは通話の 5 分後に実行されます
名称
 name True string

トークンの名前です。 「{{my.name}}」の形式にする必要があります
価値
 value True string

トークンの値

戻り値

Body
ResponseOfCampaign

キャンペーンを取得する

操作 ID:
getCampaignsUsingGET

キャンペーン レコードの一覧を返します。 必要な権限: 読み取りのみキャンペーン/書き込みキャンペーン

注: この エンドポイント は置き換えられました。 代わりに スマート キャンペーンの取得 エンドポイント を使用してください。

パラメーター

名前 キー 必須 型 説明
レコードを返すキャンペーン ID のカンマ区切りのリスト
 id array

レコードを返すキャンペーン ID のカンマ区切りのリスト
フィルタリングする名前のカンマ区切りリスト
 name array

フィルタリングする名前のカンマ区切りリスト
フィルタリングするプログラム名のカンマ区切りリストです。
 programName array

フィルタリングするプログラム名のカンマ区切りリストです。 設定すると、指定されたプログラムの子であるキャンペーンのみにフィルタリングされます。
フィルタリングするプワークスペース名のカンマ区切りリストです。
 workspaceName array

フィルタリングするプワークスペース名のカンマ区切りリストです。 設定すると、指定されたワークスペース内のキャンペーンのみが返されます。
返す最大レコード数。 最大値および既定値は 300 です。
 batchSize integer

返す最大レコード数。 最大値および既定値は 300 です。
このエンドポイント によってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。
if が Requested トリガーであり、ソースが Web サービス API である場合
 isTriggerable boolean

true に設定すると、「キャンペーンがリクエストされました」トリガーがあり、ソースが Web サービス API であるアクティブなキャンペーンが返されます

戻り値

Body
ResponseOfCampaign

クローン プログラム

操作 ID:
cloneProgramUsingPOST

対象プログラムをクローンします。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id
description
 description string
id
 id True integer

フォルダーの ID
タイプ
 type True string

フォルダーの種類
名称
 name True string

プログラムの名前です。 最大 255 文字

戻り値

Body
ResponseOfProgramResponse

スマート リストの削除

操作 ID:
deleteSmartListByIdUsingPOST

指定されたスマート リストの削除を作成します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
削除するスマートリストの ID
 id True integer

削除するスマートリストの ID

戻り値

Body
ResponseOfIdResponse

スマート リストを取得

操作 ID:
getSmartListsUsingGET

ユーザーが作成したスマート リスト レコードのリストを取得します。 必要な権限: リード アセットまたはリードライト アセット

パラメーター

名前 キー 必須 型 説明
親フォルダーの JSON 表現
 folder string

メンバー「id」と「type」 (「Folder」または「Program」) を含む、親フォルダーの JSON 表現
ページング用の整数オフセット
 offset integer

ページング用の整数オフセット
返すスマート リストの最大数です。 最大 200、既定 20 です。
 maxReturn integer

返すスマート リストの最大数です。 最大 200、既定 20 です。
この日付より前のスマート リストを除外します。 Datetime フィールド タイプの説明を参照してください。
 earliestUpdatedAt string

この日付より前のスマート リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールド タイプの説明を参照してください。
この日付より後のスマート リストを除外します。 Datetime フィールド タイプの説明を参照してください。
 latestUpdatedAt string

この日付より後のスマート リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールド タイプの説明を参照してください。

戻り値

Body
ResponseOfSmartListResponse

スマートリストのクローン

操作 ID:
cloneSmartListUsingPOST

指定されたスマート リストのクローンを作成します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
クローンするスマート リストの ID
 id True integer

クローンするスマート リストの ID
名称
 name True string

クローンされたスマート リストの名前
id
 id True integer

フォルダーの ID
タイプ
 type True string

フォルダーの種類
description
 description string

クローンされたスマートリストの説明

戻り値

Body
ResponseOfSmartListResponse

タグごとにプログラムを取得する

操作 ID:
getProgramListByTagUsingGET

指定されたタグ タイプとタグ値に一致するプログラムのリストを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム タグの種類
 tagType True string

プログラム タグの種類
タグの値
 tagValue True string

タグの値
返す最大チャネル数 最大 200、既定 20
 maxReturn integer

返す最大チャネル数 最大 200、既定 20
ページング用の整数オフセット
 offset integer

ページング用の整数オフセット

戻り値

Body
ResponseOfProgramResponse

ファイル コンテンツ更新

操作 ID:
updateContentUsingPOST

ファイルの現在のコンテンツを、含まれているペイロードで置き換えます。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
ファイルの ID
 id True integer

データベース内のファイルの ID
file
 file True string

マルチパート ファイル。 ファイルのコンテンツ。
id
 id True integer

ファイルの ID

戻り値

Body
ResponseOfFileResponse

ファイルを作成する

操作 ID:
createFileUsingPOST

含まれているペイロードから新しいファイルを作成します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
description
 description string

アセットの説明です
file
 file True string

マルチパート ファイル。 ファイルのコンテンツ。
id
 id True integer

フォルダーの ID
タイプ
 type True string

フォルダーの種類
insertOnly
 insertOnly boolean

同じ名前の既存のファイルが存在する場合に呼び出しが失敗するかどうか
名称
 name True string

ファイルの名前

戻り値

Body
ResponseOfFileResponse

ファイルを取得する

操作 ID:
getFilesUsingGET

指定されたフォルダーからファイルを返します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
id
 id True integer

フォルダーの ID
タイプ
 type True string

フォルダーの種類
maxReturn
 maxReturn integer

返す最大チャネル数 最大 200、既定 20
offset
 offset integer

ページング用の整数オフセット
ファイルを置くフォルダー
 folder string

メンバー「id」と「type」 (「Folder」または「Program」) を含む、親フォルダーの JSON 表現

戻り値

Body
ResponseOfFileResponse

フィルター タイプごとにリードを取得

操作 ID:
getLeadsByFilterUsingGET

特定のフィールドの値のリストに基づいて、最大 300 件のリードのリストを返します。 必要な権限: 読み取りのみリード/書き込みリード

パラメーター

名前 キー 必須 型 説明
フィルターを適用するリード フィールドです。
 filterType True string

フィルターを適用するリード フィールドです。 任意のカスタム フィールド (文字列、電子メール、または整数タイプのみ)、および次のフィールドのいずれかがサポートされます: cookie、email、facebookId、id、leadPartitionId、linkedInId、sfdcAccountId、sfdcContactId、sfdcLeadId、sfdcLeadOwnerId、sfdcOpptyId、twitterId。

フィールドの包括的なリストは、Describe Lead2 エンドポイント から取得できます。
指定したフィールドでフィルタリングする値のカンマ区切りリスト。
 filterValues True array

指定したフィールドでフィルタリングする値のカンマ区切りリスト。
各レコードに対して返されるリード フィールドのカンマ区切りのリスト
 fields array

各レコードに対して返されるリード フィールドのカンマ区切りのリスト
返されるバッチ サイズです。 最大値および既定値は 300 です。
 batchSize integer

返されるバッチ サイズです。 最大値および既定値は 300 です。
このエンドポイント によってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfLead

フォルダのメタデータを更新する

操作 ID:
updateFolderUsingPOST

指定されたフォルダーのメタデータを更新します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
更新するフォルダーの ID
 id True integer

更新するフォルダーの ID
description
 description string

アセットの説明です
isArchive
 isArchive boolean

フォルダがアーカイブされるかどうかを表わします。 この値を切り替えると、フォルダーのアーカイブ ステータスが変更されます
名称
 name string

フォルダーの名前
タイプ
 type True string

フォルダーの種類です。 「フォルダー」または「プログラム」

戻り値

Body
ResponseOfFolderResponse

フォルダー コンテンツの取得

操作 ID:
getFolderContentUsingGET

指定されたフォルダーの内容のレコードを返します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
取得するフォルダーの ID
 id True integer

取得するフォルダーの ID
返す最大チャネル数 最大 200、既定 20
 maxReturn integer

返す最大チャネル数 最大 200、既定 20
ページング用の整数オフセット
 offset integer

ページング用の整数オフセット
フォルダーの種類です。 「フォルダー」または「プログラム」。 既定値は Folder です
 type True string

フォルダーの種類です。 「フォルダー」または「プログラム」。 既定値は Folder です

戻り値

Body
ResponseOfFolderContentResponse

フォルダーの作成

操作 ID:
createFolderUsingPOST

新しいフォルダーを作成します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
description
 description string

アセットの説明です
名称
 name True string

フォルダーの名前
id
 id True integer

フォルダーの ID
タイプ
 type True string

フォルダーの種類

戻り値

Body
ResponseOfFolderResponse

フォルダーの削除

操作 ID:
deleteFolderUsingPOST

指定したフォルダーを削除します。 フォルダーにコンテンツがある場合、削除は失敗します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
削除するフォルダーの ID
 id True integer

削除するフォルダーの ID
フォルダーの種類
 type True string

タイプ

戻り値

Body
ResponseOfIdResponse

フォルダーを取得する

操作 ID:
getFolderUsingGET

指定されたルート フォルダー内から子フォルダーを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
親フォルダーの参照
 root string

親フォルダーの参照
走査するフォルダーの最大の深さ、既定は 2
 maxDepth integer

走査するフォルダーの最大の深さ、既定は 2
返すフォルダーの最大数です。 既定値は 20。最大値は 200 です
 maxReturn integer

返すフォルダーの最大数です。 既定値は 20。最大値は 200 です
ページング用の整数オフセットです。 既定は 0
 offset integer

ページング用の整数オフセットです。 既定は 0
ワークスペースの名前
 workSpace string

ワークスペースの名前

戻り値

Body
ResponseOfFolderResponse

フォルダーを名前で取得

操作 ID:
getFolderByNameUsingGET

指定された名前のフォルダー レコードを返します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
フォルダーの名前
 name True string

フォルダーの名前。 プログラムに適用できません
次のページ トークン (プログラムまたはフォルダー)
 type string

フォルダーの種類です。 「フォルダー」または「プログラム」
親フォルダーの参照
 root string

親フォルダーの参照
ワークスペースの名前
 workSpace string

ワークスペースの名前

戻り値

Body
ResponseOfFolderResponse

プログラム ID でリードを取得

操作 ID:
getLeadsByProgramIdUsingGET

指定されたプログラムのメンバーであるリードのリストを取得します。 必要な権限: 読み取りのみリード/書き込みリード

パラメーター

名前 キー 必須 型 説明
取得するプログラムの ID
 programId True integer

取得するプログラムの ID
各レコードに対して返されるリード フィールドのカンマ区切りのリスト
 fields array

各レコードに対して返されるリード フィールドのカンマ区切りのリスト
返されるバッチ サイズです。 最大値および既定値は 300 です。
 batchSize integer

返されるバッチ サイズです。 最大値および既定値は 300 です。
このエンドポイント によってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfLead

プログラム ID によるスマート リストの取得

操作 ID:
getSmartListByProgramIdUsingGET

メール プログラムによってスマート リスト レコードを取得します。必要な権限: アセットの読み取りまたはアセットの読み取り/書き込み

パラメーター

名前 キー 必須 型 説明
取得するスマート リストを含む電子メール プログラムの ID
 programId True integer

取得するスマート リストを含む電子メール プログラムの ID
true に設定すると、スマート リスト ルールが設定されます。 既定の False
 includeRules boolean

true に設定すると、スマート リスト ルールが設定されます。 既定の False

戻り値

Body
ResponseOfSmartListResponseWithRules

プログラム タグの更新

操作 ID:
updateProgramTagUsingPOST

プログラム タグの更新。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id
プログラム タグの種類
 tagType True string

プログラム タグの種類
プログラム タグの値
 tagValue True string

プログラム タグの値

戻り値

Body
ResponseOfIdResponse

プログラム タグを削除する

操作 ID:
deleteProgramTagUsingPOST

不要なプログラム タグを削除します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id
プログラム タグの種類
 tagType True string

プログラム タグの種類

戻り値

Body
ResponseOfIdResponse

プログラム メンバー ステータスの同期

操作 ID:
syncProgramMemberStatusUsingPOST

ターゲット プログラム内のリードのリストのプログラム メンバー ステータスを変更します。 メンバーがプログラムに参加していない場合、メンバーはプログラムに追加されます。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
ターゲット プログラムの ID です。
 programId True integer

ターゲット プログラムの ID です。
statusName
 statusName True string

プログラム メンバー ステータス
leadId
 leadId True integer

リード レコードの一意の整数 ID

戻り値

Body
ResponseOfProgramMemberStatus

プログラム メンバー フィールドを名前で取得

操作 ID:
getProgramMemberFieldByNameUsingGET

単一のプログラム メンバーのメタデータを取得します。 必要な権限: 読み取り/書き込みスキーマ標準フィールド、読み取り/書き込みスキーマ カスタム フィールド

パラメーター

名前 キー 必須 型 説明
プログラム メンバー フィールドの API 名
 fieldApiName True string

プログラム メンバー フィールドの API 名

戻り値

Body
ResponseOfLeadField

プログラム メンバーのインポート

操作 ID:
importProgramMemberUsingPOST

データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
メンバーを追加するプログラムの ID です。
 programId True string

メンバーを追加するプログラムの ID です。
追加中のメンバーのプログラム メンバー ステータスです。
 programMemberStatus True string

追加中のメンバーのプログラム メンバー ステータスです。
インポート ファイル形式です。
 format True string

インポート ファイル形式です。
インポートするデータ レコードを含むファイル。
 file True file

インポートするデータ レコードを含むファイル。

戻り値

Body
ResponseOfImportProgramMemberResponse

プログラム メンバーの削除

操作 ID:
deleteProgramMemberUsingPOST

宛先インスタンスからメンバーのリストを削除します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
ターゲット プログラムの ID です。
 programId True integer

ターゲット プログラムの ID です。
leadId
 leadId True integer

リード レコードの一意の整数 ID

戻り値

Body
ResponseOfProgramMemberDelete

プログラム メンバーの取得

操作 ID:
getProgramMembersUsingGET

特定のフィールドの値のリストに基づいて、最大 300 件のプログラム メンバーを返します。 カスタム フィールドである filterType を指定する場合、カスタム フィールドの dataType は「string」または「integer」のいずれかである必要があります。 「leadId」以外の filterType を指定した場合、リクエストで最大 100,000 のプログラム メンバー レコードを処理できます。 必要な権限: 読み取りのみリード/書き込みリード

パラメーター

名前 キー 必須 型 説明
ターゲット プログラムの ID です。
 programId True integer

ターゲット プログラムの ID です。
フィルタリングするプログラム メンバー フィールド。
 filterType True string

フィルタリングするプログラム メンバー フィールドです。 任意のカスタム フィールド (文字列または整数型のみ)、「updatedAt」、または任意の検索可能なフィールド。 検索可能なフィールドは、プログラム メンバーの説明 エンドポイント から取得できます。
指定したフィールドでフィルタリングする値のカンマ区切りリスト。
 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

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfProgramMember

プログラムの取得

操作 ID:
browseProgramsUsingGET

ターゲット インスタンスからアクセス可能なプログラムのリストを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
返す最大チャネル数 最大 200、既定 20
 maxReturn integer

返す最大チャネル数 最大 200、既定 20
ページング用の整数オフセット
 offset integer

ページング用の整数オフセット
オプションのフィルターです。 filterValues が必要です
 filterType string

オプションのフィルターです。 filterValues が必要です
この日付より前のプログラムを除外します。 Datetime フィールド タイプの説明を参照してください。
 earliestUpdatedAt string

この日付より前のプログラムを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールド タイプの説明を参照してください。
この日付より後のプログラムを除外します。 Datetime フィールド タイプの説明を参照してください。
 latestUpdatedAt string

この日付より後のプログラムを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールド タイプの説明を参照してください。

戻り値

Body
ResponseOfBrowseAllPrograms

プログラムの承認

操作 ID:
approveProgramUsingPOST

対象プログラムを承認します。 未承認の電子メール プログラムにのみ有効です。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id

戻り値

Body
ResponseOfIdResponse

プログラムの非承認

操作 ID:
unapproveProgramUsingPOST

対象プログラムを非承認します。 承認の電子メール プログラムにのみ有効です。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id

戻り値

Body
ResponseOfIdResponse

プログラムを作成する

操作 ID:
createProgramUsingPOST

新しいプログラムを作成します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
channel
 channel True string

プログラムのチャネル
コスト
 cost True integer

コストの金額
note
 note string

コストのメモ
startDate
 startDate True date-time

期間費用の開始日
description
 description string
id
 id True integer

フォルダーの ID
タイプ
 type True string

フォルダーの種類
名称
 name True string

プログラムの名前
tagType
 tagType string

プログラム タグの種類
tagValue
 tagValue string

タグの値
タイプ
 type True string

プログラムの種類

戻り値

Body
ResponseOfProgramResponse

プログラムメンバーについて説明する

操作 ID:
describeProgramMemberUsingGET

API を介して対話できるすべてのフィールドのリストを含む、ターゲット インスタンスのプログラム メンバー オブジェクトに関するメタデータを返します。 必要な権限: 読み取りのみリード/書き込みリード

注: この エンドポイント は置き換えられました。 代わりに プログラム メンバーの説明 エンドポイント を使用してください。

戻り値

Body
ResponseOfProgramMemberAttributes

プログラムメンバーについて説明する

操作 ID:
describeProgramMemberUsingGET2

API を介して対話できるすべてのフィールドのリストを含む、ターゲット インスタンスのプログラム メンバー オブジェクトに関するメタデータを返します。 必要な権限: 読み取りのみリード/書き込みリード

戻り値

Body
ResponseOfProgramMemberAttributes2

プログラムメンバーデータの同期

操作 ID:
syncProgramMemberDataUsingPOST

ターゲット プログラム内のリードのリストのプログラム メンバー データを変更します。 この API を使用してデータを変更できるのは、プログラムの既存のメンバーのみです。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
ターゲット プログラムの ID です。
 programId True integer

ターゲット プログラムの ID です。
leadId
 leadId True integer

リード レコードの一意の整数 ID
{fieldApiName}
 {fieldApiName} True string

更新するフィールドの API 名です。 プログラム メンバーの説明 エンドポイントで説明されているように更新可能である必要があります。
{fieldApiName2}
 {fieldApiName2} string

更新する別のフィールドの API 名など。 プログラム メンバーの説明 エンドポイントで説明されているように更新可能である必要があります。

戻り値

Body
ResponseOfProgramMemberData

プロジェクトを削除する

操作 ID:
deleteProgramUsingPOST

対象プログラムを削除します。 プログラムには、プログラム外で使用されるアセットを含めることはできません。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラム ID
 id True integer

id

戻り値

Body
ResponseOfIdResponse

メンバー リスト

操作 ID:
areLeadsMemberOfListUsingGET

リードが指定された静的リストのメンバーであるかどうかを確認します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
照合する静的リストの ID
 listId True integer

照合する静的リストの ID
id
 id True integer

リード レコードの一意の整数 ID
チェックするリード ID のカンマ区切りリスト
 id array

チェックするリード ID のカンマ区切りリスト

戻り値

Body
ResponseOfListOperationOutputData

リスト ID でリードを取得

操作 ID:
getLeadsByListIdUsingGET_1

指定された静的リストのメンバーである個人レコードを取得します。 必要な権限: 読み取りのみリード/書き込みリード

パラメーター

名前 キー 必須 型 説明
レコードを取得する静的リストの ID
 listId True integer

レコードを取得する静的リストの ID
各レコードに対して返されるリード フィールドのカンマ区切りのリストです。
 fields array

各レコードに対して返されるリード フィールドのカンマ区切りのリストです。 設定されていない場合は、電子メール、updatedAt、createdAt、lastName、firstName、id が返されます
返されるバッチ サイズです。 最大値および既定値は 300 です。
 batchSize integer

返されるバッチ サイズです。 最大値および既定値は 300 です。
このエンドポイント によってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfLead

リスト ID でリードを取得

操作 ID:
getLeadsByListIdUsingGET

指定された静的リストのメンバーである個人レコードを取得します。 必要な権限: 読み取りのみリード/書き込みリード

パラメーター

名前 キー 必須 型 説明
レコードを取得する静的リストの ID
 listId True integer

レコードを取得する静的リストの ID
各レコードに対して返されるリード フィールドのカンマ区切りのリストです。
 fields array

各レコードに対して返されるリード フィールドのカンマ区切りのリストです。 設定されていない場合は、電子メール、updatedAt、createdAt、lastName、firstName、id が返されます
返されるバッチ サイズです。 最大値および既定値は 300 です。
 batchSize integer

返されるバッチ サイズです。 最大値および既定値は 300 です。
このエンドポイント によってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfLeadByListId

リストから削除

操作 ID:
removeLeadsFromListUsingDELETE

対象の静的リストから指定されたターゲット レコードのセットを削除します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
リードを削除する静的リストの ID
 listId True integer

リードを削除する静的リストの ID
id
 id True integer

リード レコードの一意の整数 ID
id
 id True array

id

戻り値

Body
ResponseOfListOperationOutputData

リストに追加

操作 ID:
addLeadsToListUsingPOST

指定された個人レコードのセットをターゲットの静的リストに追加します。 リクエストあたりのリード ID の制限は 300 です。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
ターゲット リストの ID
 listId True integer

ターゲット リストの ID
id
 id True integer

リード レコードの一意の整数 ID
リストに追加するリード ID のカンマ区切りリスト
 id array

リストに追加するリード ID のカンマ区切りリスト

戻り値

Body
ResponseOfListOperationOutputData

リストの取得

操作 ID:
getListsUsingGET

与えられたフィルター パラメータに基づいた静的リスト レコードのセットを返します。 必要な権限: 読み取りのみリード/書き込みリード

パラメーター

名前 キー 必須 型 説明
返す静的リスト ID のカンマ区切りリスト
 id array

返す静的リスト ID のカンマ区切りリスト
返す静的リスト名のカンマ区切りリスト
 name array

返す静的リスト名のカンマ区切りリスト
プログラム名のカンマ区切りリスト。
 programName array

プログラム名のカンマ区切りリスト。 設定すると、指定されたプログラムの子であるすべての静的リストが返されます
ワークスペース名のカンマ区切りリスト。
 workspaceName array

ワークスペース名のカンマ区切りリスト。 設定すると、指定されたワークスペースの子であるすべての静的リストが返されます
返されるバッチ サイズです。 最大値および既定値は 300 です。
 batchSize integer

返されるバッチ サイズです。 最大値および既定値は 300 です。
このエンドポイント によってトークンが返されます。 詳細については、「ページング トークン」を参照してください。
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfStaticList

リード ジョブのエクスポートの取得

操作 ID:
getExportLeadsUsingGET

過去 7 日間に作成されたエクスポート ジョブのリストを返します。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
フィルタリングする状態のカンマ区切りリストです。
 status array

フィルタリングする状態のカンマ区切りリストです。
返されるバッチ サイズです。 最大値および既定値は 300 です。
 batchSize integer

返されるバッチ サイズです。 最大値および既定値は 300 です。
次のページ トークン
 nextPageToken string

結果セットがバッチ サイズより大きい場合、この エンドポイント によってトークンが返され、このパラメーターを介して後続の呼び出しに渡すことができます。 詳細については、「ページング トークン」を参照してください。

戻り値

Body
ResponseOfExportResponseWithToken

リード ファイルを取得する

操作 ID:
getExportLeadsFileUsingGET

エクスポート ジョブのファイルの内容を返します。 エクスポート ジョブは「完了済み」状態である必要があります。 Get Export Lead Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード

ファイル形式は、エクスポート リードの作成ジョブ エンドポイント を呼び出すことで指定されます。 以下は既定のファイル形式 ("CSV") の例です。

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

パラメーター

名前 キー 必須 型 説明
エクスポート バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。
抽出されたデータの部分的な取得をサポートする方法
 Range string

抽出されたデータの部分的な取得をサポートするには、タイプ「バイト」の HTTP ヘッダー「Range」を指定できます。 詳細は RFC2616 「範囲検索のリクエスト」を参照してください。 ヘッダーが設定されていない場合は、コンテンツ全体が返されます。

戻り値

返答
object

リード フィールドを名前で取得

操作 ID:
getLeadFieldByNameUsingGET

単一のリードフィールドのメタデータを取得します。 必要な権限: 読み取り/書き込みスキーマ標準フィールド、読み取り/書き込みスキーマ カスタム フィールド

パラメーター

名前 キー 必須 型 説明
リード フィールドの API 名
 fieldApiName True string

リード フィールドの API 名

戻り値

Body
ResponseOfLeadField

リードのインポート

操作 ID:
importLeadUsingPOST

データ レコードを含むファイルをターゲット インスタンスにインポートします。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
インポート ファイル形式です。
 format True string

インポート ファイル形式です。
重複排除に使用するフィールド。 カスタムフィールド (文字列、電子メール、整数)
 lookupField string

重複排除に使用するフィールド。 カスタム フィールド (文字列、電子メール、または整数タイプのみ)、および次のフィールド タイプのいずれかがサポートされます: id、cookie、email、twitterId、facebookId、linkedInId、sfdcAccountId、sfdcContactId、sfdcLeadId、sfdcLeadOwnerId。 既定はメールです。
注: ID は更新のみの操作に使用できます。
インポート先のリード パーティションの名前です。
 partitionName string

インポート先のリード パーティションの名前です。
インポートする静的リストの ID です。
 listId integer

インポートする静的リストの ID です。
インポートするデータ レコードを含むファイル。
 file True file

インポートするデータ レコードを含むファイル。

戻り値

Body
ResponseOfImportLeadResponse

リードのインポート失敗の取得

操作 ID:
getImportLeadFailuresUsingGET

インポート バッチ ジョブの失敗のリストを返します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
インポート バッチの ID です。
 batchId True integer

インポート バッチの ID です。

戻り値

返答
object

リードのインポート状態の取得

操作 ID:
getImportLeadStatusUsingGET

インポート バッチ ジョブの状態を返します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
インポート バッチの ID です。
 batchId True integer

インポート バッチの ID です。

戻り値

Body
ResponseOfImportLeadResponse

リードのインポート警告の取得

操作 ID:
getImportLeadWarningsUsingGET

インポート バッチ ジョブの警告のリストを返します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
インポート バッチの ID です。
 batchId True integer

インポート バッチの ID です。

戻り値

返答
object

リードの同期

操作 ID:
syncLeadUsingPOST

リードのリストをターゲット インスタンスに同期します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
action
 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
 stream string

親プログラムがエンゲージメント プログラムの場合、リードがメンバーであるストリーム
code
 code True string

理由の整数コード
message
 message True string

操作ステータスの理由を説明するメッセージ
ステータス
 status string

レコードに対して行われた操作のステータス
lookupField
 lookupField string

重複排除するフィールド。 このフィールドは、入力の各リード レコードに存在する必要があります。 設定されていない場合、既定は email です
partitionName
 partitionName string

該当する場合、操作対象のパーティションの名前。 パーティションが有効になっているインスタンスと対話するときは、可能な限り設定する必要があります。

戻り値

Body
ResponseOfLead

リードの説明

操作 ID:
describeUsingGET_2

API を介して対話できるすべてのフィールドのリストを含む、ターゲット インスタンスのリード オブジェクトに関するメタデータを返します。 必要な権限: 読み取りのみリード/書き込みリード

注: この エンドポイント は置き換えられました。 代わりに Describe Lead2 エンドポイント を使用してください。

戻り値

Body
ResponseOfLeadAttribute

リードの説明2

操作 ID:
describeUsingGET_6

ターゲット インスタンスのリード オブジェクトの検索可能なフィールドのリストを返します。 必要な権限: 読み取りのみリード/書き込みリード

戻り値

Body
ResponseOfLeadAttribute2

リードを Marketo にプッシュする

操作 ID:
pushToMarketoUsingPOST

リードを更新挿入し、Marketo にリードをプッシュ アクティビティを生成します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
id
 id integer

リード レコードの一意の整数 ID
code
 code True string

理由の整数コード
message
 message True string

操作ステータスの理由を説明するメッセージ
ステータス
 status string

レコードに対して行われた操作のステータス
lookupField
 lookupField string
partitionName
 partitionName string
programName
 programName string
programStatus
 programStatus string
reason
 reason string
source
 source string

戻り値

Body
ResponseOfPushLeadToMarketo

リードを削除する

操作 ID:
deleteLeadsUsingPOST

宛先インスタンスからリードのリストを削除します。 必要な権限: 読み取り/書き込みリード

パラメーター

名前 キー 必須 型 説明
id
 id True integer

リード レコードの一意の整数 ID
パラメータはリクエストボディが空の場合に指定できます。
 id array

パラメータはリクエストボディが空の場合に指定できます。 複数のリード ID を指定できます。 例: id=1,2,3,2342

戻り値

Body
ResponseOfLead

リードジョブのエクスポートのエンキュー

操作 ID:
enqueueExportLeadsUsingPOST

エクスポート ジョブをエンキューします。 これにより、エクスポート ジョブがキューに入れられ、コンピューティング リソースが利用可能になったときにジョブが開始されます。 エクスポート ジョブは「作成済み」状態である必要があります。 Get Export Lead Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
エクスポート バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。

戻り値

Body
ResponseOfExportResponse

リードジョブのエクスポートの作成

操作 ID:
createExportLeadsUsingPOST

「filter」パラメータで定義された検索条件のエクスポート ジョブを作成します。 リクエストは「exportId」を返します。これは、後続の一括エクスポート リード エンドポイントへの呼び出しでパラメータとして渡されます。 Enqueue Export Lead Job エンドポイント を使用して、エクスポート ジョブを処理のためにキューに入れます。 Get Export Lead Job Status エンドポイント を使用して、エクスポート ジョブのステータスを取得します。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
名称
 name True string

REST API ヘッダーフィールドの名前
価値
 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" です

戻り値

Body
ResponseOfExportResponse

リードジョブのエクスポートをキャンセル

操作 ID:
cancelExportLeadsUsingPOST

エクスポート ジョブをキャンセルします。 必要な権限: 読み取りのみリード

パラメーター

名前 キー 必須 型 説明
エクスポート バッチ ジョブの ID です。
 exportId True string

エクスポート バッチ ジョブの ID です。

戻り値

Body
ResponseOfExportResponse

名前でファイルを取得する

操作 ID:
getFileByNameUsingGET

指定された名前のファイル レコードを返します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
ファイルの名前
 name True string

ファイルの名前

戻り値

Body
ResponseOfFileResponse

名前でプログラムを取得する

操作 ID:
getProgramByNameUsingGET

指定された名前の番組レコードを取得します。 必要な権限: 読み取りのみアセット/書き込みアセット

パラメーター

名前 キー 必須 型 説明
プログラムの名前
 name True string

プログラムの名前
プログラムタグを設定するには true を設定します
 includeTags boolean

プログラムタグを設定するには true を設定します
プログラムのコストを設定するには true を設定します
 includeCosts boolean

プログラムのコストを設定するには true を設定します

戻り値

Body
ResponseOfProgramResponse

名前によるスマート リストの取得

操作 ID:
getSmartListByNameUsingGET

スマート リスト レコードを名前で取得します。 必要な権限: リード アセットまたはリードライト アセット

パラメーター

名前 キー 必須 型 説明
取得するスマート リストの名前
 name True string

取得するスマート リストの名前

戻り値

Body
ResponseOfSmartListResponse

名前による静的リストの取得

操作 ID:
getStaticListByNameUsingGET

静的リスト レコードを名前で取得します。 必要な権限: リード アセットまたはリードライト アセット

パラメーター

名前 キー 必須 型 説明
取得する静的リストの名前
 name True string

取得する静的リストの名前

戻り値

Body
ResponseOfStaticListResponse

更新されたリード フィールドのデータ

操作 ID:
updateLeadFieldUsingPOST

ターゲット インスタンスのリード フィールドのメタデータを更新します。 更新ルールは こちら を参照してください。 必要な権限: 読み取り/書き込みスキーマ標準フィールド、読み取り/書き込みスキーマ カスタム フィールド

パラメーター

名前 キー 必須 型 説明
リード フィールドの API 名
 fieldApiName True string

リード フィールドの API 名
displayName
 displayName string

フィールドの UI 表示名
description
 description string

フィールドの説明
isHidden
 isHidden boolean

true に設定すると、フィールドは非表示になる。 既定値は False です
isHtmlEncodingInEmail
 isHtmlEncodingInEmail boolean

true に設定すると、フィールドは電子メールで HTML としてエンコードされます。 既定値は True です
isSensitive
 isSensitive boolean

true に設定すると、フィールドはセンシティブとしてマークされます。 既定値は False です

戻り値

Body
ResponseOfUpdateLeadField

静的リストの作成

操作 ID:
createStaticListUsingPOST

新しい静的リストを作成します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
description
 description string

静的リストの説明
名称
 name True string

静的リストの名前
id
 id True integer

フォルダーの ID
タイプ
 type True string

フォルダーの種類

戻り値

Body
ResponseOfStaticListResponse

静的リストの削除

操作 ID:
deleteStaticListByIdUsingPOST

指定された静的リストの削除を作成します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
削除する静的リストの ID
 id True integer

削除する静的リストの ID

戻り値

Body
ResponseOfIdResponse

静的リストの取得

操作 ID:
getStaticListsUsingGET

静的リスト レコードのリストを取得します。 必要な権限: リード アセットまたはリードライト アセット

パラメーター

名前 キー 必須 型 説明
親フォルダーの JSON 表現
 folder string

メンバー「id」と「type」 (「Folder」または「Program」) を含む、親フォルダーの JSON 表現
ページング用の整数オフセット
 offset integer

ページング用の整数オフセット
返す静的リストの最大数です。 最大 200、既定 20 です。
 maxReturn integer

返す静的リストの最大数です。 最大 200、既定 20 です。
この日付より前の静的リストを除外します。 Datetime フィールド タイプの説明を参照してください。
 earliestUpdatedAt string

この日付より前の静的リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールド タイプの説明を参照してください。
この日付より後の静的リストを除外します。 Datetime フィールド タイプの説明を参照してください。
 latestUpdatedAt string

この日付より後の静的リストを除外します。 有効な ISO-8601 文字列である必要があります。 Datetime フィールド タイプの説明を参照してください。

戻り値

Body
ResponseOfStaticListResponse

静的リストメタデータ更新

操作 ID:
updateStaticListUsingPOST

静的リストアセットのメタデータを更新します。 必要な権限: 読み取り/書き込みアセット

パラメーター

名前 キー 必須 型 説明
更新する静的リストの ID
 id True integer

更新する静的リストの ID
description
 description string

静的リストの説明
名称
 name string

静的リストの名前

戻り値

Body
ResponseOfStaticListResponse

定義

ResponseOfIdentity

名前 パス 型 説明
access_token
 access_token string

ターゲット インスタンスで認証するために後続の呼び出しで渡すトークン
scope
 scope string

認証に使用されたカスタム サービスの所有 API 専用ユーザー
expires_in
 expires_in integer

現在のトークンの残りの有効期間 (秒単位)
token_type
 token_type string

OAuth の認証方法を選択します

ResponseOfStaticList

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of StaticList

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

​​リード

リード レコードです。 常に ID が含まれますが、ターゲット インスタンスで使用可能なフィールドに応じて、他のフィールドを任意の数含むことができます。

名前 パス 型 説明
id
 id integer

リード レコードの一意の整数 ID
メンバーシップ
 membership ProgramMembership
reason
 reason Reason
ステータス
 status string

レコードに対して行われた操作のステータス

LeadField

リード フィールドのレコード

名前 パス 型 説明
displayName
 displayName string

フィールドの UI 表示名
名称
 name string

フィールドの API 名
description
 description string

フィールドの説明
dataType
 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
 reasons array of Reason

操作が成功しなかった理由のリストです。 理由は API 応答にのみ存在するため、送信しないでください
ステータス
 status string

レコードに対して行われた操作のステータス

LeadAttribute

名前 パス 型 説明
dataType
 dataType string

フィールドのデータタイプ
displayName
 displayName string

フィールドの UI 表示名
id
 id integer

フィールドのユニークな整数 ID
length
 length integer

フィールドの最大長。 テキスト、文字列、テキスト領域にのみ適用されます。
rest
 rest LeadMapAttribute
soap
 soap LeadMapAttribute

LeadAttribute2

名前 パス 型 説明
名称
 name string

"API リード"
searchableFields
 searchableFields array of LeadAttribute2SearchableFields

検索可能なフィールド
fields
 fields array of LeadAttribute2Fields

検索可能なフィールドの説明

LeadAttribute2SearchableFields

検索可能なフィールド

名前 パス 型 説明
アイテム
 string

検索可能なフィールド

LeadAttribute2Fields

名前 パス 型 説明
名称
 name string

フィールドの REST API 名
displayName
 displayName string

フィールドの表示名 (フレンドリ名)
dataType
 dataType string

フィールドのデータ型
length
 length integer

フィールド長
updateable
 updateable boolean

フィールドは更新可能ですか
crmManaged
 crmManaged boolean

フィールドは CRM で管理されているか

LeadAttribute2Fields2

名前 パス 型 説明
名称
 name string

フィールドの REST API 名
displayName
 displayName string

フィールドの表示名 (フレンドリ名)
dataType
 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
 description string

「API プログラム メンバー マップ」
createdAt
 createdAt string

作成日時
updatedAt
 updatedAt string

更新日時
dedupeFields
 dedupeFields array of string

重複排除フィールド一覧
searchableFields
 searchableFields array of LeadAttribute2SearchableFields

検索可能なフィールド
fields
 fields array of LeadAttribute2Fields2

検索可能なフィールドの説明

ResponseOfImportLeadResponse

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ImportLeadResponse

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ImportProgramMemberResponse

インポートステータス情報を含む応答

名前 パス 型 説明
batchId
 batchId integer

インポート ジョブを表す一意の整数 id です
importId
 importId string

インポート ジョブを表す一意の整数 id です
ステータス
 status string

インポートジョブの状態です

ResponseOfImportProgramMemberResponse

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
requestId
 requestId string

リクエストの ID
result
 result array of ImportProgramMemberResponse

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfCampaign

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of Campaign

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfListOperationOutputData

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ListOperationOutputData

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

Campaign

Marketo スマート キャンペーンの記録

名前 パス 型 説明
active
 active boolean

キャンペーンがアクティブかどうかを示します。 トリガー キャンペーンにのみ適用可能
createdAt
 createdAt string

キャンペーンが作成された日付
description
 description string

スマート キャンペーンの内容
id
 id integer

スマート キャンペーンのユニークな整数 ID
名称
 name string

スマート キャンペーン名
programId
 programId integer

親プログラムの ID (該当する場合)
programName
 programName string

親プログラムの名前 (該当する場合)
タイプ
 type string

スマート キャンペーンの種類
updatedAt
 updatedAt string

キャンペーンが最後に更新された日時
workspaceName
 workspaceName string

親ワークスペースの名前 (該当する場合)

ResponseOfLead

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of Lead

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfLeadByListId

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of Lead

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfLeadField

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of LeadField

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfUpdateLeadField

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of LeadFieldStatus

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfPushLeadToMarketo

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
requestId
 requestId string

リクエストの ID
result
 result array of Lead

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfLeadAttribute

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of LeadAttribute

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfLeadAttribute2

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of LeadAttribute2

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfProgramMemberAttributes

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ProgramMemberAttribute

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfProgramMemberAttributes2

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ProgramMemberAttribute2

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

警告

名前 パス 型 説明
code
 code integer

警告の整数コード
message
 message string

警告を説明するメッセージ

ResponseOfExportResponse

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
requestId
 requestId string

リクエストの ID
result
 result array of ExportResponse

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfExportResponseWithToken

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ExportResponse

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfProgramMember

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ProgramMember

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 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
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ProgramMemberStatusResponse

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfProgramMemberData

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ProgramMemberStatusResponse

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ResponseOfProgramMemberDelete

名前 パス 型 説明
errors
 errors array of Error

リクエストが失敗した場合に発生したエラーの配列
moreResult
 moreResult boolean

後続のページにさらに結果があるかどうかを示すブール値
nextPageToken
 nextPageToken string

結果セットが許可されたバッチ サイズを超えた場合に与えられるページング トークン
requestId
 requestId string

リクエストの ID
result
 result array of ProgramMemberDeleteResponse

操作内の個々のレコードの結果の配列。空の場合があります
成功
 success boolean

リクエストが成功したかどうか
warnings
 warnings array of Warning

操作に対して与えられた警告の配列

ImportLeadResponse

インポートステータス情報を含む応答

名前 パス 型 説明
batchId
 batchId integer

インポート バッチを表す一意の整数 id です
importId
 importId string
message
 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
 stream string

親プログラムがエンゲージメント プログラムの場合、リードがメンバーであるストリーム

ExportResponse

エクスポートジョブのステータス情報を含む応答

名前 パス 型 説明
createdAt
 createdAt date-time

エクスポート要求が作成された日付
errorMsg
 errorMsg string

「失敗」ステータスの場合のエラーメッセージ
exportId
 exportId string

エクスポート ジョブの一意 ID
fileSize
 fileSize integer

エクスポートされるファイルのサイズ (バイト)。 これはステータスが「完了」の場合にのみ値を持ち、それ以外の場合は null
fileChecksum
 fileChecksum string

エクスポートされたファイルの SHA-256 ハッシュです。 これはステータスが「完了」の場合にのみ値を持ち、それ以外の場合は null
finishedAt
 finishedAt date-time

エクスポート ジョブの終了時刻です。 これはステータスが「完了」または「失敗」の場合にのみ値を持ち、それ以外の場合は null
format
 format string

リクエストで指定されたファイルの形式 (「CSV」、「TSV」、「SSV」)
numberOfRecords
 numberOfRecords integer

エクスポート ファイルのレコード数です。 これはステータスが「完了」の場合にのみ値を持ち、それ以外の場合は null
queuedAt
 queuedAt date-time

エクスポート ジョブのキュー時刻です。 これは、null になる前に、「Queued」ステータスに達したときに値を持ちます
startedAt
 startedAt date-time

エクスポート ジョブの開始時刻です。 これは、null になる前に、「処理中」ステータスに達したときに値を持ちます
ステータス
 status string

エクスポート ジョブのステータス (「作成済み」、「キューに登録済み」、「処理中」、「キャンセル済み」、「完了」、「失敗」)

Reason

名前 パス 型 説明
code
 code string

理由の整数コード
message
 message string

操作ステータスの理由を説明するメッセージ

LeadMapAttribute

名前 パス 型 説明
名称
 name string

属性の名前
readOnly
 readOnly boolean

属性が読み取り専用かどうか

Error

名前 パス 型 説明
code
 code string

エラーのエラー コードです。 エラー コードの完全なリストは こちら を参照してください
message
 message string

エラーの原因を説明するメッセージ

ProgramMemberStatusResponse

名前 パス 型 説明
ステータス
 status string

レコードに対して行われた操作のステータス
reasons
 reasons array of Reason

操作が成功しなかった理由のリストです。 理由は API 応答にのみ存在するため、送信しないでください
leadId
 leadId integer

プログラムメンバーに関連するリードの ID
seq
 seq integer

応答のレコードの順序を示す整数です。 この値は、リクエスト入力に含まれるレコードの順序と相関しています。 Seq は応答の一部のみである必要があり、送信しないでください。

ProgramMemberDeleteResponse

名前 パス 型 説明
ステータス
 status string

レコードに対して行われた操作のステータス
reasons
 reasons array of Reason

操作が成功しなかった理由のリストです。 理由は API 応答にのみ存在するため、送信しないでください
leadId
 leadId integer

プログラムメンバーに関連するリードの ID
seq
 seq integer

応答のレコードの順序を示す整数です。 この値は、リクエスト入力に含まれるレコードの順序と相関しています。 Seq は応答の一部のみである必要があり、送信しないでください。

StaticList

名前 パス 型 説明
createdAt
 createdAt string

リストが作成された日時
description
 description string

静的リストの説明
id
 id integer

静的リストのユニークな整数 ID
名称
 name string

静的リストの名前
programName
 programName string

プログラムの名前
updatedAt
 updatedAt string

リストが最後に更新された日時
workspaceName
 workspaceName string

親ワークスペースの名前 (該当する場合)

BrowseAllPrograms

名前 パス 型 説明
channel
 channel string

プログラムのチャネル
createdAt
 createdAt date-time

アセットが作成された日時
description
 description string

アセットの説明です
folder
 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
 errors array of Error
requestId
 requestId string
result
 result array of ProgramResponse
成功
 success boolean
warnings
 warnings array of string

ResponseOfSmartListResponse

名前 パス 型 説明
errors
 errors array of Error
requestId
 requestId string
result
 result array of SmartListResponse
成功
 success boolean
warnings
 warnings array of string

ResponseOfSmartListResponseWithRules

名前 パス 型 説明
errors
 errors array of Error
requestId
 requestId string
result
 result array of SmartListResponseWithRules
成功
 success boolean
warnings
 warnings array of string

SmartListResponse

名前 パス 型 説明
id
 id integer

スマート リストの ID
名称
 name string

スマート リストの名前
description
 description string

スマート リストの説明
createdAt
 createdAt date-time

スマート リストが作成された日時
updatedAt
 updatedAt date-time

スマート リストが最後に更新された日時
url
 url string

Marketo UI のスマートリストの URL
folder
 folder Folder

フォルダーの JSON 表現
ワークスペース
 workspace string

ワークスペースの名前

SmartListResponseWithRules

名前 パス 型 説明
id
 id integer

スマート リストの ID
名称
 name string

スマート リストの名前
description
 description string

スマート リストの説明
createdAt
 createdAt date-time

スマート リストが作成された日時
updatedAt
 updatedAt date-time

スマート リストが最後に更新された日時
url
 url string

Marketo UI のスマートリストの URL
folder
 folder Folder

フォルダーの JSON 表現
ワークスペース
 workspace string

ワークスペースの名前
ルール
 rules SmartListRules

スマートリストルールの JSON 表現

ResponseOfStaticListResponse

名前 パス 型 説明
errors
 errors array of Error
requestId
 requestId string
result
 result array of StaticListResponse
成功
 success boolean
warnings
 warnings array of string

StaticListResponse

名前 パス 型 説明
id
 id integer

静的リストの ID
名称
 name string

静的リストの名前
description
 description string

静的リストの説明
createdAt
 createdAt date-time

静的リストが作成された日時
updatedAt
 updatedAt date-time

静的リストが最後に更新された日時
url
 url string

Marketo UI の静的リストの URL
folder
 folder Folder

フォルダーの JSON 表現
ワークスペース
 workspace string

ワークスペースの名前
computedUrl
 computedUrl string

ProgramResponse

名前 パス 型 説明
channel
 channel string

プログラムのチャネル
コスト
 costs array of Costs

関連する期間コストのリスト
createdAt
 createdAt date-time

アセットが作成された日時
description
 description string

アセットの説明です
endDate
 endDate date-time

プログラムの終了日です。 イベント、メール、ウェビナータイプのプログラムに適用可能
folder
 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

プログラムに対して「ヘッドスタート」機能が有効かどうか

FileResponse

名前 パス 型 説明
createdAt
 createdAt date-time

ファイルが作成された日付け
description
 description string

ファイルの説明
folder
 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
 errors array of Error
requestId
 requestId string
result
 result array of FileResponse
成功
 success boolean
warnings
 warnings array of string

FolderResponse

名前 パス 型 説明
accessZoneId
 accessZoneId integer
createdAt
 createdAt date-time

フォルダが作成された日時
description
 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
 errors array of Error
requestId
 requestId string
result
 result array of IdResponse
成功
 success boolean
warnings
 warnings array of string

Tags

名前 パス 型 説明
tagType
 tagType string

タグの名前
tagValue
 tagValue string

タグの値

ResponseOfBrowseAllPrograms

名前 パス 型 説明
errors
 errors array of Error
requestId
 requestId string
result
 result array of BrowseAllPrograms
成功
 success boolean
warnings
 warnings array of string

ResponseOfFolderResponse

名前 パス 型 説明
errors
 errors array of Error
requestId
 requestId string
result
 result array of FolderResponse
成功
 success boolean
warnings
 warnings array of string

ResponseOfFolderContentResponse

名前 パス 型 説明
errors
 errors array of Error
requestId
 requestId string
result
 result array of FolderContentResponse
成功
 success boolean
warnings
 warnings array of string

IdResponse

名前 パス 型 説明
id
 id integer

アセットの ID

コスト

名前 パス 型 説明
コスト
 cost integer

コストの金額
note
 note string

コストのメモ
startDate
 startDate date-time

期間費用の開始日

ProgramFolder

名前 パス 型 説明
タイプ
 type string

プログラム フォルダーの種類
価値
 value integer

プログラム フォルダーの ID
folderName
 folderName string

プログラム フォルダーの名前

Folder

フォルダーの 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
 operator string

演算子名
conditions
 conditions array of SmartListConditions

スマート リスト条件のリスト

SmartListConditions

スマート リスト条件の JSON 表現

名前 パス 型 説明
activityAttributeId
 activityAttributeId integer

アクティビティ属性の ID
activityAttributeName
 activityAttributeName string

活動属性の所有者の名前
operator
 operator string

演算子の値
values
 values array of string

値の一覧
isPrimary
 isPrimary boolean

条件がプライマリであるかどうか (スマート リストの最初の条件)

オブジェクト

’オブジェクト’ という種類です。