Moosend (独立した発行元) (プレビュー)
あなたの銀行を壊さない究極の電子メールマーケティングソフトウェアとマーケティングオートメーションプラットフォーム。 何百もの up-to日付テンプレートから選択すると、電子メールマーケティングキャンペーンは成功に向けて服を着るでしょう。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | トロイ・テイラー |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | トロイ・テイラー |
| Website | https://moosend.com/ |
| プライバシー ポリシー | https://www.sitecore.com/trust/privacy-policy |
| カテゴリ | Marketing |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| API キー | securestring | この API の API キー | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| AB テスト キャンペーンの概要を取得する |
送信された AB テスト キャンペーンの結果の基本的な概要を、受信者の数、開く、クリック、バウンス、サブスクライブ解除、転送など、バージョン (A と B) ごとに個別に提供します。 |
| ID でサブスクライバーを取得する |
指定したメーリング リストで、指定した一意識別子を持つサブスクライバーを検索します。 |
| すべてのアクティブなメーリング リストを取得する |
アカウント内のアクティブなメーリング リストのリストを取得します。 |
| アカウントからサブスクライバーの登録を解除する |
サブスクライバーをアカウントからサブスクライブ解除します。 |
| カスタム フィールドを作成する |
指定したメーリング リストに新しいユーザー設定フィールドを作成します。 |
| キャンペーンのスケジュールを解除する |
事前に定義したスケジュールされた日時をキャンペーンから削除して、既にキューに登録されている場合や送信されたときにすぐに配信されるようにします。 |
| キャンペーンの削除 |
アカウント、下書き、または送信済みからキャンペーンを削除します。 |
| キャンペーンの概要を取得する |
受信者の数、開く、クリック、バウンス、サブスクライブ解除、転送など、送信されたキャンペーンの結果の基本的な概要を取得します。 |
| キャンペーンの統計情報を取得する |
送信されたメール、開封済み、バウンス済み、クリックされたリンクなどのアクティビティに基づいて、特定のキャンペーンの統計情報の詳細な一覧を取得します。 |
| キャンペーンの詳細を取得する |
要求されたキャンペーンの詳細を説明するプロパティの完全なセットを返します。 |
| キャンペーンをスケジュールする |
キャンペーンを配信する予定の日時を割り当てます。 |
| キャンペーンをテストする |
プレビュー用に指定したメール アドレスの一覧に、下書きキャンペーンのテスト メールを送信します。 |
| キャンペーンを取得する |
アカウント内のすべてのキャンペーンの一覧と詳細情報を返します。 |
| キャンペーンを送信する |
既存の下書きキャンペーンを、メーリング リストで指定されたすべての受信者に送信します。 キャンペーンはすぐに送信されます。 |
| サブスクライバーの追加 |
指定したメーリング リストに新しいサブスクライバーを追加します。 |
| サブスクライバーを削除する |
指定したメーリング リストからサブスクライバーを完全に削除します。 |
| サブスクライバーを取得する |
特定のメーリング リスト内のすべてのサブスクライバーのリストを取得します。 |
| サブスクライバーを更新する |
指定したメーリング リストのサブスクライバーを更新します。 |
| メーリング リストの詳細を取得する |
特定のメーリング リストの詳細を取得します。 |
| メーリング リストを作成する |
アカウントに新しい空のメーリング リストを作成します。 |
| メーリング リストを削除する |
アカウントからメーリング リストを削除します。 |
| メーリング リストを更新する |
既存のメーリング リストのプロパティを更新します。 |
| メール アドレスでサブスクライバーを取得する |
指定したメーリング リスト内の指定したメール アドレスを持つサブスクライバーを検索します。 |
| ユーザー設定フィールドを削除する |
指定したメーリング リストからユーザー設定フィールド定義を削除します。 |
| ユーザー設定フィールドを更新する |
指定したメーリング リストの既存のユーザー設定フィールドのプロパティを更新します。 |
| リンク アクティビティを取得する |
キャンペーン リンクと、受信者が行ったクリック数 (一意または合計) を含むリストを返します。 |
| 下書きキャンペーンを作成する |
アカウントに新しいドラフト キャンペーンを作成します。 |
| 下書きキャンペーンを更新する |
アカウント内の既存のドラフト AB キャンペーンのプロパティを更新します。 ドラフト以外のキャンペーンは更新できません。 通常のキャンペーンを作成する場合は無視します (AB 分割キャンペーン オプション)。 |
| 場所別にアクティビティを取得する |
キャンペーンの詳細なレポート (一意および合計) を国別に返します。 |
| 既存のキャンペーンを複製する |
既存のキャンペーンの正確なコピーを作成します。 新しいキャンペーンが下書きとして作成されます。 |
| 複数のサブスクライバーを削除する |
指定したメーリング リストからサブスクライバーのリストを完全に削除します。 |
| 複数のサブスクライバーを追加する |
1 回の通話でメーリング リストに複数のサブスクライバーを追加します。 |
| 購読者をメーリング リストからサブスクライブ解除する |
指定されたメーリング リストからサブスクライバーの登録を解除します。 |
| 送信者の詳細を取得する |
指定した送信者の電子メール アドレスで識別される情報を返します。 |
| 送信者を取得する |
アカウント内のアクティブな送信者の一覧を取得します。 |
AB テスト キャンペーンの概要を取得する
送信された AB テスト キャンペーンの結果の基本的な概要を、受信者の数、開く、クリック、バウンス、サブスクライブ解除、転送など、バージョン (A と B) ごとに個別に提供します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
キャンペーン ID
|
Context.CampaignID | string |
キャンペーン識別子。 |
|
キャンペーン ID
|
Context.A.CampaignID | string |
キャンペーン識別子。 |
|
AB バージョン
|
Context.A.ABVersion | integer |
AB バージョン。 |
|
キャンペーン名
|
Context.A.CampaignName | string |
キャンペーン名。 |
|
キャンペーンの件名
|
Context.A.CampaignSubject | string |
キャンペーンの件名。 |
|
メーリング リスト
|
Context.A.MailingLists | array of object | |
|
キャンペーン
|
Context.A.MailingLists.Campaign | string |
キャンペーン。 |
|
ID
|
Context.A.MailingLists.MailingList.ID | string |
識別子。 |
|
名前
|
Context.A.MailingLists.MailingList.Name | string |
名前。 |
|
アクティブなメンバー数
|
Context.A.MailingLists.MailingList.ActiveMemberCount | integer |
アクティブなメンバー数。 |
|
バウンスされたメンバー数
|
Context.A.MailingLists.MailingList.BouncedMemberCount | integer |
バウンスされたメンバー数。 |
|
メンバー数の削除
|
Context.A.MailingLists.MailingList.RemovedMemberCount | integer |
削除されたメンバー数。 |
|
登録解除されたメンバー数
|
Context.A.MailingLists.MailingList.UnsubscribedMemberCount | integer |
サブスクライブ解除されたメンバー数。 |
|
ステータス
|
Context.A.MailingLists.MailingList.Status | integer |
状態。 |
|
ユーザー設定フィールドの定義
|
Context.A.MailingLists.MailingList.CustomFieldsDefinition | array of |
ユーザー設定フィールドの定義。 |
|
作成者
|
Context.A.MailingLists.MailingList.CreatedBy | string |
作成者。 |
|
作成日
|
Context.A.MailingLists.MailingList.CreatedOn | string |
作成時。 |
|
更新者
|
Context.A.MailingLists.MailingList.UpdatedBy | string |
更新者。 |
|
更新日
|
Context.A.MailingLists.MailingList.UpdatedOn | string |
更新日。 |
|
インポート操作
|
Context.A.MailingLists.MailingList.ImportOperation | string |
インポート操作。 |
|
セグメント
|
Context.A.MailingLists.Segment | string |
セグメント。 |
|
キャンペーン配信日
|
Context.A.CampaignDeliveredOn | string |
配信されたキャンペーン。 |
|
移行先
|
Context.A.To | string |
宛先アドレス。 |
|
より
|
Context.A.From | string |
From アドレス。 |
|
[Total Opens]
|
Context.A.TotalOpens | integer |
合計が開きます。 |
|
一意の開き
|
Context.A.UniqueOpens | integer |
一意が開きます。 |
|
バウンスの合計
|
Context.A.TotalBounces | integer |
合計バウンス数。 |
|
合計苦情数
|
Context.A.TotalComplaints | integer |
苦情の合計。 |
|
転送の合計数
|
Context.A.TotalForwards | integer |
転送の合計。 |
|
一意の転送
|
Context.A.UniqueForwards | integer |
一意の転送。 |
|
サブスクライブ解除の合計数
|
Context.A.TotalUnsubscribes | integer |
サブスクリプションの合計。 |
|
リンククリック数の合計
|
Context.A.TotalLinkClicks | integer |
合計リンククリック数。 |
|
一意のリンクのクリック
|
Context.A.UniqueLinkClicks | integer |
一意のリンクがクリックされます。 |
|
Sent
|
Context.A.Sent | integer |
送信された番号。 |
|
キャンペーンがアーカイブされている
|
Context.A.CampaignIsArchived | boolean |
キャンペーンをアーカイブするかどうか。 |
|
キャンペーン ID
|
Context.B.CampaignID | string |
キャンペーン識別子。 |
|
AB バージョン
|
Context.B.ABVersion | integer |
AB バージョン。 |
|
キャンペーン名
|
Context.B.CampaignName | string |
キャンペーン名。 |
|
キャンペーンの件名
|
Context.B.CampaignSubject | string |
キャンペーンの件名。 |
|
メーリング リスト
|
Context.B.MailingLists | array of object | |
|
キャンペーン
|
Context.B.MailingLists.Campaign | string |
キャンペーン。 |
|
ID
|
Context.B.MailingLists.MailingList.ID | string |
識別子。 |
|
名前
|
Context.B.MailingLists.MailingList.Name | string |
名前。 |
|
アクティブなメンバー数
|
Context.B.MailingLists.MailingList.ActiveMemberCount | integer |
アクティブなメンバー数。 |
|
バウンスされたメンバー数
|
Context.B.MailingLists.MailingList.BouncedMemberCount | integer |
バウンスされたメンバー数。 |
|
メンバー数の削除
|
Context.B.MailingLists.MailingList.RemovedMemberCount | integer |
削除されたメンバー数。 |
|
登録解除されたメンバー数
|
Context.B.MailingLists.MailingList.UnsubscribedMemberCount | integer |
サブスクライブ解除されたメンバー数。 |
|
ステータス
|
Context.B.MailingLists.MailingList.Status | integer |
状態。 |
|
ユーザー設定フィールドの定義
|
Context.B.MailingLists.MailingList.CustomFieldsDefinition | array of |
ユーザー設定フィールドの定義。 |
|
作成者
|
Context.B.MailingLists.MailingList.CreatedBy | string |
作成者。 |
|
作成日
|
Context.B.MailingLists.MailingList.CreatedOn | string |
作成時。 |
|
更新者
|
Context.B.MailingLists.MailingList.UpdatedBy | string |
更新者。 |
|
更新日
|
Context.B.MailingLists.MailingList.UpdatedOn | string |
更新日。 |
|
インポート操作
|
Context.B.MailingLists.MailingList.ImportOperation | string |
インポート操作。 |
|
セグメント
|
Context.B.MailingLists.Segment | string |
セグメント。 |
|
キャンペーン配信日
|
Context.B.CampaignDeliveredOn | string |
配信されたキャンペーン。 |
|
移行先
|
Context.B.To | string |
宛先アドレス。 |
|
より
|
Context.B.From | string |
From アドレス。 |
|
[Total Opens]
|
Context.B.TotalOpens | integer |
合計が開きます。 |
|
一意の開き
|
Context.B.UniqueOpens | integer |
一意が開きます。 |
|
バウンスの合計
|
Context.B.TotalBounces | integer |
合計バウンス数。 |
|
合計苦情数
|
Context.B.TotalComplaints | integer |
苦情の合計。 |
|
転送の合計数
|
Context.B.TotalForwards | integer |
転送の合計。 |
|
一意の転送
|
Context.B.UniqueForwards | integer |
一意の転送。 |
|
サブスクライブ解除の合計数
|
Context.B.TotalUnsubscribes | integer |
サブスクリプションの合計。 |
|
リンククリック数の合計
|
Context.B.TotalLinkClicks | integer |
合計リンククリック数。 |
|
一意のリンクのクリック
|
Context.B.UniqueLinkClicks | integer |
一意のリンクがクリックされます。 |
|
Sent
|
Context.B.Sent | integer |
送信された番号。 |
|
キャンペーンがアーカイブされている
|
Context.B.CampaignIsArchived | boolean |
キャンペーンをアーカイブするかどうか。 |
ID でサブスクライバーを取得する
指定したメーリング リストで、指定した一意識別子を持つサブスクライバーを検索します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
サブスクライバー ID
|
SubscriberId | True | string |
サブスクライバー識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
Email
|
Context.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
登録解除日
|
Context.UnsubscribedOn | string |
登録を解除した場合。 |
|
ID からサブスクライブ解除済み
|
Context.UnsubscribedFromID | string |
識別子の登録を解除した値。 |
|
サブスクライブの種類
|
Context.SubscribeType | integer |
サブスクライブの種類。 |
|
Subscribe メソッド
|
Context.SubscribeMethod | integer |
サブスクライブ メソッド。 |
|
ユーザー設定フィールド
|
Context.CustomFields | array of |
ユーザー設定フィールド。 |
|
削除日
|
Context.RemovedOn | string |
削除された場合。 |
すべてのアクティブなメーリング リストを取得する
アカウント内のアクティブなメーリング リストのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
Page | True | integer |
ページ。 |
|
ページ サイズ
|
PageSize | True | integer |
ページ サイズ。 |
|
並べ替え順
|
SortBy | string |
並べ替え基準。 |
|
|
Sort メソッド
|
SortMethod | string |
並べ替えメソッド。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ページ サイズ
|
Context.Paging.PageSize | integer |
ページ サイズ。 |
|
現在のページ
|
Context.Paging.CurrentPage | integer |
現在のページ。 |
|
合計結果
|
Context.Paging.TotalResults | integer |
結果の合計。 |
|
合計ページ数
|
Context.Paging.TotalPageCount | integer |
合計ページ数。 |
|
並べ替え式
|
Context.Paging.SortExpression | string |
並べ替え式。 |
|
並べ替えの昇順
|
Context.Paging.SortIsAscending | boolean |
並べ替えが昇順かどうかを示します。 |
|
メーリング リスト
|
Context.MailingLists | array of object | |
|
ID
|
Context.MailingLists.ID | string |
識別子。 |
|
名前
|
Context.MailingLists.Name | string |
名前。 |
|
アクティブなメンバー数
|
Context.MailingLists.ActiveMemberCount | integer |
アクティブなメンバー数。 |
|
バウンスされたメンバー数
|
Context.MailingLists.BouncedMemberCount | integer |
バウンスされたメンバー数。 |
|
メンバー数の削除
|
Context.MailingLists.RemovedMemberCount | integer |
削除されたメンバー数。 |
|
登録解除されたメンバー数
|
Context.MailingLists.UnsubscribedMemberCount | integer |
サブスクライブ解除されたメンバー数。 |
|
ステータス
|
Context.MailingLists.Status | integer |
状態。 |
|
ユーザー設定フィールドの定義
|
Context.MailingLists.CustomFieldsDefinition | array of object | |
|
ID
|
Context.MailingLists.CustomFieldsDefinition.ID | string |
識別子。 |
|
名前
|
Context.MailingLists.CustomFieldsDefinition.Name | string |
名前。 |
|
Context
|
Context.MailingLists.CustomFieldsDefinition.Context | string |
コンテキスト。 |
|
必須
|
Context.MailingLists.CustomFieldsDefinition.IsRequired | boolean |
必須かどうか。 |
|
タイプ
|
Context.MailingLists.CustomFieldsDefinition.Type | integer |
型。 |
|
作成者
|
Context.MailingLists.CreatedBy | string |
作成者。 |
|
作成日
|
Context.MailingLists.CreatedOn | string |
作成時。 |
|
更新者
|
Context.MailingLists.UpdatedBy | string |
更新者。 |
|
更新日
|
Context.MailingLists.UpdatedOn | string |
更新日。 |
|
ID
|
Context.MailingLists.ImportOperation.ID | integer |
識別子。 |
|
データ ハッシュ
|
Context.MailingLists.ImportOperation.DataHash | string |
データ ハッシュ。 |
|
マッピング
|
Context.MailingLists.ImportOperation.Mappings | string |
マッピング。 |
|
電子メール通知
|
Context.MailingLists.ImportOperation.EmailNotify | string |
通知メール。 |
|
作成日
|
Context.MailingLists.ImportOperation.CreatedOn | string |
作成時。 |
|
開始日時
|
Context.MailingLists.ImportOperation.StartedOn | string |
起動時。 |
|
完了日
|
Context.MailingLists.ImportOperation.CompletedOn | string |
完了時。 |
|
合計挿入数
|
Context.MailingLists.ImportOperation.TotalInserted | integer |
挿入された合計。 |
|
合計更新数
|
Context.MailingLists.ImportOperation.TotalUpdated | integer |
更新された合計。 |
|
サブスクライブ解除済みの合計
|
Context.MailingLists.ImportOperation.TotalUnsubscribed | integer |
サブスクライブ解除された合計。 |
|
合計が無効です
|
Context.MailingLists.ImportOperation.TotalInvalid | integer |
合計が無効です。 |
|
Total Duplicate
|
Context.MailingLists.ImportOperation.TotalDuplicate | integer |
重複の合計。 |
|
合計メンバー数
|
Context.MailingLists.ImportOperation.TotalMembers | integer |
メンバーの合計数。 |
|
メッセージ
|
Context.MailingLists.ImportOperation.Message | string |
メッセージ。 |
|
Success
|
Context.MailingLists.ImportOperation.Success | boolean |
成功したかどうか。 |
アカウントからサブスクライバーの登録を解除する
サブスクライバーをアカウントからサブスクライブ解除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Email
|
True | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
カスタム フィールドを作成する
指定したメーリング リストに新しいユーザー設定フィールドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
名前
|
Name | string |
名前。 |
|
|
ユーザー設定フィールドの種類
|
CustomFieldType | string |
ユーザー設定フィールドの種類。 |
|
|
オプション
|
Options | string |
オプション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
キャンペーンのスケジュールを解除する
事前に定義したスケジュールされた日時をキャンペーンから削除して、既にキューに登録されている場合や送信されたときにすぐに配信されるようにします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
キャンペーンの削除
アカウント、下書き、または送信済みからキャンペーンを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
キャンペーンの概要を取得する
受信者の数、開く、クリック、バウンス、サブスクライブ解除、転送など、送信されたキャンペーンの結果の基本的な概要を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
キャンペーン ID
|
Context.CampaignID | string |
キャンペーン識別子。 |
|
AB バージョン
|
Context.ABVersion | string |
AB バージョン。 |
|
キャンペーン名
|
Context.CampaignName | string |
キャンペーン名。 |
|
キャンペーンの件名
|
Context.CampaignSubject | string |
キャンペーンの件名。 |
|
メーリング リスト
|
Context.MailingLists | array of object | |
|
メーリング リスト ID
|
Context.MailingLists.MailingListID | string |
メーリング リスト識別子。 |
|
セグメント ID
|
Context.MailingLists.SegmentID | integer |
セグメント識別子。 |
|
キャンペーン配信日
|
Context.CampaignDeliveredOn | string |
キャンペーンが配信されたとき。 |
|
移行先
|
Context.To | string |
宛先アドレス。 |
|
より
|
Context.From | string |
From アドレス。 |
|
[Total Opens]
|
Context.TotalOpens | integer |
合計が開きます。 |
|
一意の開き
|
Context.UniqueOpens | integer |
一意が開きます。 |
|
バウンスの合計
|
Context.TotalBounces | integer |
合計バウンス数。 |
|
合計苦情数
|
Context.TotalComplaints | integer |
苦情の合計。 |
|
転送の合計数
|
Context.TotalForwards | integer |
転送の合計。 |
|
一意の転送
|
Context.UniqueForwards | integer |
一意の転送。 |
|
サブスクライブ解除の合計数
|
Context.TotalUnsubscribes | integer |
サブスクリプションの合計。 |
|
リンククリック数の合計
|
Context.TotalLinkClicks | integer |
合計リンククリック数。 |
|
一意のリンクのクリック
|
Context.UniqueLinkClicks | integer |
一意のリンクがクリックされます。 |
|
Sent
|
Context.Sent | integer |
送信された番号。 |
|
キャンペーンがアーカイブされている
|
Context.CampaignIsArchived | boolean |
キャンペーンをアーカイブするかどうか。 |
キャンペーンの統計情報を取得する
送信されたメール、開封済み、バウンス済み、クリックされたリンクなどのアクティビティに基づいて、特定のキャンペーンの統計情報の詳細な一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
|
タイプ
|
Type | True | string |
型。 |
|
ページ
|
Page | integer |
ページ。 |
|
|
ページ サイズ
|
PageSize | integer |
ページ サイズ。 |
|
|
より
|
From | string |
From アドレス。 |
|
|
移行先
|
To | string |
宛先アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ページ サイズ
|
Context.Paging.PageSize | integer |
ページ サイズ。 |
|
現在のページ
|
Context.Paging.CurrentPage | integer |
現在のページ。 |
|
合計結果
|
Context.Paging.TotalResults | integer |
結果の合計。 |
|
合計ページ数
|
Context.Paging.TotalPageCount | integer |
合計ページ数。 |
|
並べ替え式
|
Context.Paging.SortExpression | string |
並べ替え式。 |
|
並べ替えの昇順
|
Context.Paging.SortIsAscending | boolean |
並べ替えが昇順かどうかを示します。 |
|
Analytics
|
Context.Analytics | array of object | |
|
Context
|
Context.Analytics.Context | string |
コンテキスト。 |
|
コンテキスト名
|
Context.Analytics.ContextName | string |
コンテキスト名。 |
|
総計
|
Context.Analytics.TotalCount | integer |
合計カウント。 |
|
一意の数
|
Context.Analytics.UniqueCount | integer |
一意の数。 |
|
コンテキストの説明
|
Context.Analytics.ContextDescription | string |
コンテキストの説明。 |
キャンペーンの詳細を取得する
要求されたキャンペーンの詳細を説明するプロパティの完全なセットを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
サブジェクト
|
Context.Subject | string |
件名。 |
|
Web の場所
|
Context.WebLocation | string |
Web の場所。 |
|
HTML コンテンツ
|
Context.HTMLContent | string |
HTML コンテンツ。 |
|
プレーン コンテンツ
|
Context.PlainContent | string |
プレーンコンテンツ。 |
|
ID
|
Context.Sender.ID | string |
識別子。 |
|
名前
|
Context.Sender.Name | string |
名前。 |
|
Email
|
Context.Sender.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.Sender.CreatedOn | string |
作成時。 |
|
有効
|
Context.Sender.IsEnabled | boolean |
有効かどうか。 |
|
SPF 検証済み
|
Context.Sender.SpfVerified | boolean |
SPF が検証されたかどうか。 |
|
DKIM 検証済み
|
Context.Sender.DkimVerified | boolean |
DKIM が検証されたかどうか。 |
|
DKIM パブリック
|
Context.Sender.DkimPublic | string |
パブリック DKIM。 |
|
配送日
|
Context.DeliveredOn | string |
配信時。 |
|
ID
|
Context.ReplyToEmail.ID | string |
識別子。 |
|
名前
|
Context.ReplyToEmail.Name | string |
名前。 |
|
Email
|
Context.ReplyToEmail.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.ReplyToEmail.CreatedOn | string |
作成時。 |
|
有効
|
Context.ReplyToEmail.IsEnabled | boolean |
有効かどうか。 |
|
SPF 検証済み
|
Context.ReplyToEmail.SpfVerified | boolean |
SPF が検証されたかどうか。 |
|
DKIM 検証済み
|
Context.ReplyToEmail.DkimVerified | boolean |
DKIM が検証されたかどうか。 |
|
DKIM パブリック
|
Context.ReplyToEmail.DkimPublic | string |
パブリック DKIM。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
スケジュール対象
|
Context.ScheduledFor | string |
スケジュールされている場合。 |
|
Timezone
|
Context.Timezone | string |
タイムゾーン。 |
|
書式の種類
|
Context.FormatType | integer |
形式の種類。 |
|
AB キャンペーン データ
|
Context.ABCampaignData | string |
AB キャンペーン データ。 |
|
メーリング リスト
|
Context.MailingLists | array of object | |
|
メーリング リスト ID
|
Context.MailingLists.MailingListID | string |
メーリング リスト識別子。 |
|
セグメント ID
|
Context.MailingLists.SegmentID | integer |
セグメント識別子。 |
|
確認の行
|
Context.ConfirmationTo | string |
確認を行います。 |
|
ステータス
|
Context.Status | integer |
状態。 |
|
Is Transactional
|
Context.IsTransactional | boolean |
トランザクションかどうか。 |
キャンペーンをスケジュールする
キャンペーンを配信する予定の日時を割り当てます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
|
日時
|
DateTime | True | string |
日付と時刻。 |
|
Timezone
|
Timezone | string |
タイムゾーン。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
キャンペーンをテストする
プレビュー用に指定したメール アドレスの一覧に、下書きキャンペーンのテスト メールを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
|
電子メールのテスト
|
TestEmails | True | array of string |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
キャンペーンを取得する
アカウント内のすべてのキャンペーンの一覧と詳細情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
Page | True | string |
ページ。 |
|
ページ サイズ
|
PageSize | True | string |
ページ サイズ。 |
|
並べ替え順
|
SortBy | string |
並べ替え基準。 |
|
|
Sort メソッド
|
SortMethod | string |
並べ替えメソッド。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ページ サイズ
|
Context.Paging.PageSize | integer |
ページ サイズ。 |
|
現在のページ
|
Context.Paging.CurrentPage | integer |
現在のページ。 |
|
合計結果
|
Context.Paging.TotalResults | integer |
結果の合計。 |
|
合計ページ数
|
Context.Paging.TotalPageCount | integer |
合計ページ数。 |
|
並べ替え式
|
Context.Paging.SortExpression | string |
並べ替え式。 |
|
並べ替えの昇順
|
Context.Paging.SortIsAscending | boolean |
並べ替えが昇順かどうかを示します。 |
|
Campaigns
|
Context.Campaigns | array of object | |
|
ID
|
Context.Campaigns.ID | string |
識別子。 |
|
名前
|
Context.Campaigns.Name | string |
名前。 |
|
サブジェクト
|
Context.Campaigns.Subject | string |
件名。 |
|
サイト名
|
Context.Campaigns.SiteName | string |
サイト名。 |
|
確認の行
|
Context.Campaigns.ConfirmationTo | string |
確認を行います。 |
|
作成日
|
Context.Campaigns.CreatedOn | string |
作成時。 |
|
AB のテスト時間
|
Context.Campaigns.ABHoursToTest | string |
テストする AB 時間。 |
|
AB キャンペーンの種類
|
Context.Campaigns.ABCampaignType | string |
AB キャンペーンの種類。 |
|
A/B 勝者
|
Context.Campaigns.ABWinner | string |
AB の勝者。 |
|
AB優勝者選定タイプ
|
Context.Campaigns.ABWinnerSelectionType | string |
AB 勝者の選択の種類。 |
|
ステータス
|
Context.Campaigns.Status | integer |
状態。 |
|
配送日
|
Context.Campaigns.DeliveredOn | string |
配信時。 |
|
スケジュール対象
|
Context.Campaigns.ScheduledFor | string |
スケジュールされている場合。 |
|
タイムゾーンのスケジュール
|
Context.Campaigns.ScheduledForTimezone | string |
タイムゾーンのスケジュール。 |
|
メーリング リスト
|
Context.Campaigns.MailingLists | array of object | |
|
キャンペーン
|
Context.Campaigns.MailingLists.Campaign | string |
キャンペーン。 |
|
ID
|
Context.Campaigns.MailingLists.MailingList.ID | string |
識別子。 |
|
名前
|
Context.Campaigns.MailingLists.MailingList.Name | string |
名前。 |
|
アクティブなメンバー数
|
Context.Campaigns.MailingLists.MailingList.ActiveMemberCount | integer |
アクティブなメンバー数。 |
|
バウンスされたメンバー数
|
Context.Campaigns.MailingLists.MailingList.BouncedMemberCount | integer |
バウンスされたメンバー数。 |
|
メンバー数の削除
|
Context.Campaigns.MailingLists.MailingList.RemovedMemberCount | integer |
削除されたメンバー数。 |
|
登録解除されたメンバー数
|
Context.Campaigns.MailingLists.MailingList.UnsubscribedMemberCount | integer |
サブスクライブ解除されたメンバー数。 |
|
ステータス
|
Context.Campaigns.MailingLists.MailingList.Status | integer |
状態。 |
|
ユーザー設定フィールドの定義
|
Context.Campaigns.MailingLists.MailingList.CustomFieldsDefinition | array of |
ユーザー設定フィールドの定義。 |
|
作成者
|
Context.Campaigns.MailingLists.MailingList.CreatedBy | string |
作成者。 |
|
作成日
|
Context.Campaigns.MailingLists.MailingList.CreatedOn | string |
作成時。 |
|
更新者
|
Context.Campaigns.MailingLists.MailingList.UpdatedBy | string |
更新者。 |
|
更新日
|
Context.Campaigns.MailingLists.MailingList.UpdatedOn | string |
更新時。 |
|
インポート操作
|
Context.Campaigns.MailingLists.MailingList.ImportOperation | string |
インポート操作。 |
|
セグメント
|
Context.Campaigns.MailingLists.Segment | string |
セグメント。 |
|
Total Sent
|
Context.Campaigns.TotalSent | integer |
送信された合計。 |
|
[Total Opens]
|
Context.Campaigns.TotalOpens | integer |
合計が開きます。 |
|
一意の開き
|
Context.Campaigns.UniqueOpens | integer |
一意が開きます。 |
|
バウンスの合計
|
Context.Campaigns.TotalBounces | integer |
合計バウンス数。 |
|
転送の合計数
|
Context.Campaigns.TotalForwards | integer |
転送の合計。 |
|
一意の転送
|
Context.Campaigns.UniqueForwards | integer |
一意の転送。 |
|
リンククリック数の合計
|
Context.Campaigns.TotalLinkClicks | integer |
合計リンククリック数。 |
|
一意のリンクのクリック
|
Context.Campaigns.UniqueLinkClicks | integer |
一意のリンクがクリックされます。 |
|
受信者数
|
Context.Campaigns.RecipientsCount | integer |
受信者数。 |
|
Is Transactional
|
Context.Campaigns.IsTransactional | boolean |
トランザクションかどうか。 |
|
合計苦情数
|
Context.Campaigns.TotalComplaints | integer |
苦情の合計。 |
|
サブスクライブ解除の合計数
|
Context.Campaigns.TotalUnsubscribes | integer |
サブスクリプションの合計。 |
キャンペーンを送信する
既存の下書きキャンペーンを、メーリング リストで指定されたすべての受信者に送信します。 キャンペーンはすぐに送信されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
サブスクライバーの追加
指定したメーリング リストに新しいサブスクライバーを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
名前
|
Name | string |
名前。 |
|
|
Email
|
string |
電子メール アドレス。 |
||
|
外部ダブル オプトインがある
|
HasExternalDoubleOptIn | boolean |
外部ダブル オプトインがあるかどうか。 |
|
|
ユーザー設定フィールド
|
CustomFields | array of string |
ユーザー設定フィールド。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
Email
|
Context.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
登録解除日
|
Context.UnsubscribedOn | string |
登録を解除した場合。 |
|
ID からサブスクライブ解除済み
|
Context.UnsubscribedFromID | string |
識別子の登録を解除した値。 |
|
サブスクライブの種類
|
Context.SubscribeType | integer |
サブスクライブの種類。 |
|
Subscribe メソッド
|
Context.SubscribeMethod | integer |
サブスクライブ メソッド。 |
|
ユーザー設定フィールド
|
Context.CustomFields | array of object | |
|
ユーザー設定フィールド ID
|
Context.CustomFields.CustomFieldID | string |
ユーザー設定フィールド識別子。 |
|
名前
|
Context.CustomFields.Name | string |
名前。 |
|
価値
|
Context.CustomFields.Value | string |
値。 |
|
削除日
|
Context.RemovedOn | string |
削除された場合。 |
サブスクライバーを削除する
指定したメーリング リストからサブスクライバーを完全に削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
Email
|
True | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
サブスクライバーを取得する
特定のメーリング リスト内のすべてのサブスクライバーのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
ページ
|
Page | integer |
ページ。 |
|
|
ページ サイズ
|
PageSize | integer |
ページ サイズ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ページ サイズ
|
Context.Paging.PageSize | integer |
ページ サイズ。 |
|
現在のページ
|
Context.Paging.CurrentPage | integer |
現在のページ。 |
|
合計結果
|
Context.Paging.TotalResults | integer |
結果の合計。 |
|
合計ページ数
|
Context.Paging.TotalPageCount | integer |
合計ページ数。 |
|
並べ替え式
|
Context.Paging.SortExpression | string |
並べ替え式。 |
|
並べ替えの昇順
|
Context.Paging.SortIsAscending | boolean |
並べ替えが昇順かどうかを示します。 |
|
Subscribers
|
Context.Subscribers | array of object | |
|
ID
|
Context.Subscribers.ID | string |
識別子。 |
|
名前
|
Context.Subscribers.Name | string |
名前。 |
|
Email
|
Context.Subscribers.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.Subscribers.CreatedOn | string |
作成時。 |
|
更新日
|
Context.Subscribers.UpdatedOn | string |
更新日。 |
|
登録解除日
|
Context.Subscribers.UnsubscribedOn | string |
登録を解除した場合。 |
|
ID からサブスクライブ解除済み
|
Context.Subscribers.UnsubscribedFromID | string |
識別子の登録を解除した値。 |
|
サブスクライブの種類
|
Context.Subscribers.SubscribeType | integer |
サブスクライブの種類。 |
|
Subscribe メソッド
|
Context.Subscribers.SubscribeMethod | integer |
サブスクライブ メソッド。 |
|
ユーザー設定フィールド
|
Context.Subscribers.CustomFields | array of object | |
|
ユーザー設定フィールド ID
|
Context.Subscribers.CustomFields.CustomFieldID | string |
ユーザー設定フィールド識別子。 |
|
名前
|
Context.Subscribers.CustomFields.Name | string |
名前。 |
|
価値
|
Context.Subscribers.CustomFields.Value | string |
値。 |
|
削除日
|
Context.Subscribers.RemovedOn | string |
削除された場合。 |
サブスクライバーを更新する
指定したメーリング リストのサブスクライバーを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
サブスクライバー ID
|
SubscriberId | True | string |
サブスクライバー識別子。 |
|
名前
|
Name | string |
名前。 |
|
|
外部ダブル オプトインがある
|
HasExternalDoubleOptIn | boolean |
外部ダブル オプトインがあるかどうか。 |
|
|
Email
|
string |
電子メール アドレス。 |
||
|
ユーザー設定フィールド
|
CustomFields | array of string |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
Email
|
Context.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
登録解除日
|
Context.UnsubscribedOn | string |
登録を解除した場合。 |
|
ID からサブスクライブ解除済み
|
Context.UnsubscribedFromID | string |
識別子の登録を解除した値。 |
|
サブスクライブの種類
|
Context.SubscribeType | integer |
サブスクライブの種類。 |
|
Subscribe メソッド
|
Context.SubscribeMethod | integer |
サブスクライブ メソッド。 |
|
ユーザー設定フィールド
|
Context.CustomFields | array of object | |
|
ユーザー設定フィールド ID
|
Context.CustomFields.CustomFieldID | string |
ユーザー設定フィールド識別子。 |
|
名前
|
Context.CustomFields.Name | string |
名前。 |
|
価値
|
Context.CustomFields.Value | string |
値。 |
|
削除日
|
Context.RemovedOn | string |
削除された場合。 |
メーリング リストの詳細を取得する
特定のメーリング リストの詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
統計あり
|
WithStatistics | boolean |
統計を使用するかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
アクティブなメンバー数
|
Context.ActiveMemberCount | integer |
アクティブなメンバー数。 |
|
バウンスされたメンバー数
|
Context.BouncedMemberCount | integer |
バウンスされたメンバー数。 |
|
メンバー数の削除
|
Context.RemovedMemberCount | integer |
削除されたメンバー数。 |
|
登録解除されたメンバー数
|
Context.UnsubscribedMemberCount | integer |
サブスクライブ解除されたメンバー数。 |
|
ステータス
|
Context.Status | integer |
状態。 |
|
ユーザー設定フィールドの定義
|
Context.CustomFieldsDefinition | array of object | |
|
ID
|
Context.CustomFieldsDefinition.ID | string |
識別子。 |
|
名前
|
Context.CustomFieldsDefinition.Name | string |
名前。 |
|
Context
|
Context.CustomFieldsDefinition.Context | string |
コンテキスト。 |
|
必須
|
Context.CustomFieldsDefinition.IsRequired | boolean |
必須かどうか。 |
|
タイプ
|
Context.CustomFieldsDefinition.Type | integer |
型。 |
|
作成者
|
Context.CreatedBy | string |
作成者。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新者
|
Context.UpdatedBy | string |
更新者。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
ID
|
Context.ImportOperation.ID | integer |
識別子。 |
|
データ ハッシュ
|
Context.ImportOperation.DataHash | string |
データ ハッシュ。 |
|
マッピング
|
Context.ImportOperation.Mappings | string |
マッピング。 |
|
電子メール通知
|
Context.ImportOperation.EmailNotify | string |
電子メール通知。 |
|
作成日
|
Context.ImportOperation.CreatedOn | string |
作成時。 |
|
開始日時
|
Context.ImportOperation.StartedOn | string |
起動時。 |
|
完了日
|
Context.ImportOperation.CompletedOn | string |
完了時。 |
|
合計挿入数
|
Context.ImportOperation.TotalInserted | integer |
挿入された合計。 |
|
合計更新数
|
Context.ImportOperation.TotalUpdated | integer |
更新された合計。 |
|
サブスクライブ解除済みの合計
|
Context.ImportOperation.TotalUnsubscribed | integer |
サブスクライブ解除された合計。 |
|
合計が無効です
|
Context.ImportOperation.TotalInvalid | integer |
合計が無効です。 |
|
無視された合計
|
Context.ImportOperation.TotalIgnored | integer |
合計は無視されます。 |
|
Total Duplicate
|
Context.ImportOperation.TotalDuplicate | integer |
重複の合計。 |
|
合計メンバー数
|
Context.ImportOperation.TotalMembers | integer |
メンバーの合計数。 |
|
メッセージ
|
Context.ImportOperation.Message | string |
メッセージ。 |
|
Success
|
Context.ImportOperation.Success | boolean |
成功したかどうか。 |
|
新しいメンバーをスキップする
|
Context.ImportOperation.SkipNewMembers | boolean |
新しいメンバーをスキップするかどうか。 |
メーリング リストを作成する
アカウントに新しい空のメーリング リストを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
Name | string |
名前。 |
|
|
確認ページ
|
ConfirmationPage | string |
確認ページ。 |
|
|
[登録解除後にリダイレクトする] ページ
|
RedirectAfterUnsubscribePage | string |
登録解除後のリダイレクト ページ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
メーリング リストを削除する
アカウントからメーリング リストを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
メーリング リストを更新する
既存のメーリング リストのプロパティを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
名前
|
Name | string |
名前。 |
|
|
確認ページ
|
ConfirmationPage | string |
確認ページ。 |
|
|
[登録解除後にリダイレクトする] ページ
|
RedirectAfterUnsubscribePage | string |
登録解除後のリダイレクト ページ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
メール アドレスでサブスクライバーを取得する
指定したメーリング リスト内の指定したメール アドレスを持つサブスクライバーを検索します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
Email
|
True | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
Email
|
Context.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
登録解除日
|
Context.UnsubscribedOn | string |
登録を解除した場合。 |
|
ID からサブスクライブ解除済み
|
Context.UnsubscribedFromID | string |
識別子の登録を解除した値。 |
|
サブスクライブの種類
|
Context.SubscribeType | integer |
サブスクライブの種類。 |
|
Subscribe メソッド
|
Context.SubscribeMethod | integer |
サブスクライブ メソッド。 |
|
ユーザー設定フィールド
|
Context.CustomFields | array of object | |
|
ユーザー設定フィールド ID
|
Context.CustomFields.CustomFieldID | string |
ユーザー設定フィールド識別子。 |
|
名前
|
Context.CustomFields.Name | string |
名前。 |
|
価値
|
Context.CustomFields.Value | string |
値。 |
|
削除日
|
Context.RemovedOn | string |
削除された場合。 |
ユーザー設定フィールドを削除する
指定したメーリング リストからユーザー設定フィールド定義を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
ユーザー設定フィールド ID
|
CustomFieldId | True | string |
ユーザー設定フィールド識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
ユーザー設定フィールドを更新する
指定したメーリング リストの既存のユーザー設定フィールドのプロパティを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
ユーザー設定フィールド ID
|
CustomFieldId | True | string |
ユーザー設定フィールド識別子。 |
|
名前
|
Name | string |
名前。 |
|
|
ユーザー設定フィールドの種類
|
CustomFieldType | string |
ユーザー設定フィールドの種類。 |
|
|
オプション
|
Options | string |
オプション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
リンク アクティビティを取得する
キャンペーン リンクと、受信者が行ったクリック数 (一意または合計) を含むリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ページ サイズ
|
Context.Paging.PageSize | integer |
ページ サイズ。 |
|
現在のページ
|
Context.Paging.CurrentPage | integer |
現在のページ。 |
|
合計結果
|
Context.Paging.TotalResults | integer |
結果の合計。 |
|
合計ページ数
|
Context.Paging.TotalPageCount | integer |
合計ページ数。 |
|
並べ替え式
|
Context.Paging.SortExpression | string |
並べ替え式。 |
|
並べ替えの昇順
|
Context.Paging.SortIsAscending | boolean |
並べ替えが昇順かどうかを示します。 |
|
Analytics
|
Context.Analytics | array of object | |
|
Context
|
Context.Analytics.Context | string |
コンテキスト。 |
|
コンテキスト名
|
Context.Analytics.ContextName | string |
コンテキスト名。 |
|
総計
|
Context.Analytics.TotalCount | integer |
合計カウント。 |
|
一意の数
|
Context.Analytics.UniqueCount | integer |
一意の数。 |
|
コンテキストの説明
|
Context.Analytics.ContextDescription | string |
コンテキストの説明。 |
下書きキャンペーンを作成する
アカウントに新しいドラフト キャンペーンを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
Name | string |
名前。 |
|
|
サブジェクト
|
Subject | string |
件名。 |
|
|
送信者の電子メール
|
SenderEmail | string |
送信者のメール アドレス。 |
|
|
メールに返信する
|
ReplyToEmail | string |
電子メール アドレスへの返信。 |
|
|
電子メールへの確認
|
ConfirmationToEmail | string |
電子メール アドレスへの確認。 |
|
|
Web の場所
|
WebLocation | string |
Web の場所。 |
|
|
メーリング リスト ID
|
MailingListID | string |
メーリング リスト識別子。 |
|
|
セグメント ID
|
SegmentID | string |
セグメント識別子。 |
|
|
Is AB
|
IsAB | string |
は AB です。 |
|
|
AB キャンペーンの種類
|
ABCampaignType | string |
AB キャンペーンの種類。 |
|
|
B Web の場所
|
WebLocationB | string |
B Web の場所。 |
|
|
テストする時間
|
HoursToTest | string |
テストする時間。 |
|
|
リストの割合
|
ListPercentage | string |
リストの割合。 |
|
|
AB優勝者選定タイプ
|
ABWinnerSelectionType | string |
AB 勝者の選択の種類。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
下書きキャンペーンを更新する
アカウント内の既存のドラフト AB キャンペーンのプロパティを更新します。 ドラフト以外のキャンペーンは更新できません。 通常のキャンペーンを作成する場合は無視します (AB 分割キャンペーン オプション)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
|
名前
|
Name | string |
名前。 |
|
|
サブジェクト
|
Subject | string |
件名。 |
|
|
送信者の電子メール
|
SenderEmail | string |
送信者のメール アドレス。 |
|
|
メールに返信する
|
ReplyToEmail | string |
電子メール アドレスへの返信。 |
|
|
電子メールへの確認
|
ConfirmationToEmail | string |
電子メール アドレスへの確認。 |
|
|
Web の場所
|
WebLocation | string |
Web の場所。 |
|
|
メーリング リスト ID
|
MailingListID | string |
メーリング リスト識別子。 |
|
|
セグメント ID
|
SegmentID | string |
セグメント識別子。 |
|
|
Is AB
|
IsAB | string |
は AB です。 |
|
|
AB キャンペーンの種類
|
ABCampaignType | string |
AB キャンペーンの種類。 |
|
|
B Web の場所
|
WebLocationB | string |
B Web の場所。 |
|
|
テストする時間
|
HoursToTest | string |
テストする時間。 |
|
|
リストの割合
|
ListPercentage | string |
リストの割合。 |
|
|
AB優勝者選定タイプ
|
ABWinnerSelectionType | string |
AB 勝者の選択の種類。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
場所別にアクティビティを取得する
キャンペーンの詳細なレポート (一意および合計) を国別に返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ページ サイズ
|
Context.Paging.PageSize | integer |
ページ サイズ。 |
|
現在のページ
|
Context.Paging.CurrentPage | integer |
現在のページ。 |
|
合計結果
|
Context.Paging.TotalResults | integer |
結果の合計。 |
|
合計ページ数
|
Context.Paging.TotalPageCount | integer |
合計ページ数。 |
|
並べ替え式
|
Context.Paging.SortExpression | string |
並べ替え式。 |
|
並べ替えの昇順
|
Context.Paging.SortIsAscending | boolean |
並べ替えが昇順かどうかを示します。 |
|
Analytics
|
Context.Analytics | array of object | |
|
Context
|
Context.Analytics.Context | string |
コンテキスト。 |
|
コンテキスト名
|
Context.Analytics.ContextName | string |
コンテキスト名。 |
|
総計
|
Context.Analytics.TotalCount | integer |
合計カウント。 |
|
一意の数
|
Context.Analytics.UniqueCount | integer |
一意の数。 |
|
コンテキストの説明
|
Context.Analytics.ContextDescription | string |
コンテキストの説明。 |
既存のキャンペーンを複製する
既存のキャンペーンの正確なコピーを作成します。 新しいキャンペーンが下書きとして作成されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
CampaignId | True | string |
キャンペーン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
サブジェクト
|
Context.Subject | string |
件名。 |
|
Web の場所
|
Context.WebLocation | string |
Web の場所。 |
|
HTML コンテンツ
|
Context.HTMLContent | string |
HTML コンテンツ。 |
|
プレーン コンテンツ
|
Context.PlainContent | string |
プレーンコンテンツ。 |
|
ID
|
Context.Sender.ID | string |
識別子。 |
|
名前
|
Context.Sender.Name | string |
名前。 |
|
Email
|
Context.Sender.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.Sender.CreatedOn | string |
作成時。 |
|
有効
|
Context.Sender.IsEnabled | boolean |
有効かどうか。 |
|
SPF 検証済み
|
Context.Sender.SpfVerified | boolean |
SPF が検証されたかどうか。 |
|
DKIM 検証済み
|
Context.Sender.DkimVerified | boolean |
DKIM が検証されたかどうか。 |
|
DKIM パブリック
|
Context.Sender.DkimPublic | string |
パブリック DKIM。 |
|
配送日
|
Context.DeliveredOn | string |
配信時。 |
|
ID
|
Context.ReplyToEmail.ID | string |
識別子。 |
|
名前
|
Context.ReplyToEmail.Name | string |
名前。 |
|
Email
|
Context.ReplyToEmail.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.ReplyToEmail.CreatedOn | string |
作成時。 |
|
有効
|
Context.ReplyToEmail.IsEnabled | boolean |
有効かどうか。 |
|
SPF 検証済み
|
Context.ReplyToEmail.SpfVerified | boolean |
SPF が検証されたかどうか。 |
|
DKIM 検証済み
|
Context.ReplyToEmail.DkimVerified | boolean |
DKIM が検証されたかどうか。 |
|
DKIM パブリック
|
Context.ReplyToEmail.DkimPublic | string |
パブリック DKIM。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
スケジュール対象
|
Context.ScheduledFor | string |
スケジュールされている場合。 |
|
Timezone
|
Context.Timezone | string |
タイムゾーン。 |
|
書式の種類
|
Context.FormatType | integer |
形式の種類。 |
|
ID
|
Context.ABCampaignData.ID | integer |
識別子。 |
|
B 件名
|
Context.ABCampaignData.SubjectB | string |
B の件名。 |
|
B プレーン コンテンツ
|
Context.ABCampaignData.PlainContentB | string |
B プレーン コンテンツ。 |
|
B HTML コンテンツ
|
Context.ABCampaignData.HTMLContentB | string |
B HTML コンテンツ。 |
|
B Web の場所
|
Context.ABCampaignData.WebLocationB | string |
B Web の場所。 |
|
B 送信者
|
Context.ABCampaignData.SenderB | string |
B 送信者。 |
|
テストする時間
|
Context.ABCampaignData.HoursToTest | integer |
テストする時間。 |
|
リストの割合
|
Context.ABCampaignData.ListPercentage | integer |
リストの割合。 |
|
AB キャンペーンの種類
|
Context.ABCampaignData.ABCampaignType | integer |
AB キャンペーンの種類。 |
|
AB優勝者選定タイプ
|
Context.ABCampaignData.ABWinnerSelectionType | integer |
AB 勝者の選択の種類。 |
|
配信日
|
Context.ABCampaignData.DeliveredOnA | string |
配信された A。 |
|
B 配信日
|
Context.ABCampaignData.DeliveredOnB | string |
B が配信されました。 |
|
メーリング リスト
|
Context.MailingLists | array of object | |
|
メーリング リスト ID
|
Context.MailingLists.MailingListID | string |
メーリング リスト識別子。 |
|
セグメント ID
|
Context.MailingLists.SegmentID | integer |
セグメント識別子。 |
|
確認の行
|
Context.ConfirmationTo | string |
確認を行います。 |
|
ステータス
|
Context.Status | integer |
状態。 |
|
Is Transactional
|
Context.IsTransactional | boolean |
トランザクションかどうか。 |
複数のサブスクライバーを削除する
指定したメーリング リストからサブスクライバーのリストを完全に削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
電子メール
|
Emails | True | string |
電子メール。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
無視された電子メール
|
Context.EmailsIgnored | integer |
メールは無視されます。 |
|
処理された電子メール
|
Context.EmailsProcessed | integer |
処理された電子メール。 |
複数のサブスクライバーを追加する
1 回の通話でメーリング リストに複数のサブスクライバーを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
外部ダブル オプトインがある
|
HasExternalDoubleOptIn | boolean |
外部ダブル オプトインがあるかどうか。 |
|
|
名前
|
Name | string |
名前。 |
|
|
Email
|
string |
電子メール アドレス。 |
||
|
ユーザー設定フィールド
|
CustomFields | array of string |
ユーザー設定フィールド。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | array of object | |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
Email
|
Context.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
更新日
|
Context.UpdatedOn | string |
更新時。 |
|
登録解除日
|
Context.UnsubscribedOn | string |
登録を解除した場合。 |
|
ID からサブスクライブ解除済み
|
Context.UnsubscribedFromID | string |
識別子の登録を解除した値。 |
|
サブスクライブの種類
|
Context.SubscribeType | integer |
サブスクライブの種類。 |
|
Subscribe メソッド
|
Context.SubscribeMethod | integer |
サブスクライブ メソッド。 |
|
ユーザー設定フィールド
|
Context.CustomFields | array of object | |
|
ユーザー設定フィールド ID
|
Context.CustomFields.CustomFieldID | string |
ユーザー設定フィールド識別子。 |
|
名前
|
Context.CustomFields.Name | string |
名前。 |
|
価値
|
Context.CustomFields.Value | string |
値。 |
|
削除日
|
Context.RemovedOn | string |
削除はオンです。 |
購読者をメーリング リストからサブスクライブ解除する
指定されたメーリング リストからサブスクライバーの登録を解除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メーリング リスト ID
|
MailingListId | True | string |
メーリング リスト識別子。 |
|
Email
|
True | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | string |
コンテキスト。 |
送信者の詳細を取得する
指定した送信者の電子メール アドレスで識別される情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Email
|
True | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
Email
|
Context.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
有効
|
Context.IsEnabled | boolean |
有効かどうか。 |
|
SPF 検証済み
|
Context.SpfVerified | boolean |
SPF が検証されたかどうか。 |
|
DKIM 検証済み
|
Context.DkimVerified | boolean |
DKIM が検証されたかどうか。 |
|
DKIM パブリック
|
Context.DkimPublic | string |
パブリック DKIM。 |
送信者を取得する
アカウント内のアクティブな送信者の一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Code
|
Code | integer |
コード。 |
|
エラー
|
Error | string |
エラー。 |
|
Context
|
Context | array of object | |
|
ID
|
Context.ID | string |
識別子。 |
|
名前
|
Context.Name | string |
名前。 |
|
Email
|
Context.Email | string |
電子メール アドレス。 |
|
作成日
|
Context.CreatedOn | string |
作成時。 |
|
有効
|
Context.IsEnabled | boolean |
有効かどうか。 |
|
SPF 検証済み
|
Context.SpfVerified | boolean |
SPF が検証されたかどうか。 |
|
DKIM 検証済み
|
Context.DkimVerified | boolean |
DKIM が検証されたかどうか。 |
|
DKIM パブリック
|
Context.DkimPublic | string |
パブリック DKIM。 |