HubSpot Marketing V2 (独立系発行者) (プレビュー)
収益の向上、時間とリソースの節約、投資の測定と最適化を可能にするマーケティング ソフトウェア。 すべてが 1 つの使いやすいプラットフォーム上にあります。 メール、ランディング ページ、フォームなどを通じて、適切な時間と場所でリードとつながることで、収益を促進します。 取引先担当者とキャンペーンを 1 か所で管理し、自動化ツールを使用して効率を拡大します。 強力なレポート ツールを使用して、キャンペーンの成功を測定します。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Troy Taylor |
| [URL] | https://www.hitachisolutions.com |
| メール | ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| 発行者 | Troy Taylor |
| Web サイト | https://www.hubspot.com/products/marketing |
| プライバシー ポリシー | https://legal.hubspot.com/privacy-policy |
| カテゴリー | マーケティング |
HubSpot Marketing V2
収益の向上、時間とリソースの節約、投資の測定と最適化を可能にするマーケティング ソフトウェア。 すべてが 1 つの使いやすいプラットフォーム上にあります。 メール、ランディング ページ、フォームなどを通じて、適切な時間と場所でリードとつながることで、収益を促進します。 取引先担当者とキャンペーンを 1 か所で管理し、自動化ツールを使用して効率を拡大します。 強力なレポート ツールを使用して、キャンペーンの成功を測定します。
公開元: Troy Taylor、Hitachi Solutions
前提条件
HubSpot のアカウントを持ち、スーパー管理者である必要があります。
資格情報の取得
アカウントにログインしたら、「設定 -> アカウント設定 ->統合 ->プライベートアプリ」にアクセスします。 プライベート アプリを作成し、アクションを使用するスコープのみを割り当てる必要があります。 プライベート アプリが作成されると、プライベート アプリの 「認証」 セクションに アクセス トークン が表示されます。
サポートされている操作
メールを送信
トランザクション電子メールを非同期的に送信します。 電子メール送信ステータスを使用してステータスを継続的にクエリするために使用できるステータス識別子を含む電子メール送信のステータスを返します。
登録された取引先担当者
連絡先を指定されたサブスクリプション タイプに登録します。 このアクションは、ブランドまたはポータル レベルで連絡先を購読するために使用するのは無効であり、エラーが返されます。
取引先担当者の登録を解除
連絡先を指定されたサブスクリプション タイプから登録解除します。 このアクションは、ブランドまたはポータル レベルで連絡先を登録解除するために使用するのは無効であり、エラーが返されます。
サブスクリプションの状態を取得する
指定された連絡先のサブスクリプションとそのステータスのリストを返します。
一括通信の基本設定を作成
一括通信の基本設定要求を作成します。 この要求は、バルク通信設定ステータスを使用してステータスを継続的にクエリするために使用できるステータス識別子を返します。
サブスクリプションの詳細を取得する
ポータルのすべてのサブスクリプション詳細のリストを取得します。
集計された統計を取得
指定された時間間隔の集計された統計を取得します。 また、その期間中に送信された電子メールのリストも返します。
集計された統計間隔を取得する
指定された期間の間隔で集計された統計を取得します。 各間隔には、その時間内に送信された電子メールの集計統計が含まれます。
AB マーケティング電子メール バリエーションを取得
A/B マーケティング電子メール のバリエーションを取得します。 電子メールがバリエーション A (マスター) の場合、バリエーション B (バリアント) が返され、その逆も同様です。
ドラフトのリセット
ドラフトをライブ オブジェクトのコピーにリセットします。
下書きマーケティング電子メールを取得する
マーケティング電子メール の以前のリビジョンを DRAFT 状態に復元します。 そのオブジェクトのドラフトに現在何かがある場合、それは上書きされます。
マーケティング電子メールの下書きを取得する
メールの下書きバージョンを取得します (存在する場合)。 下書きバージョンが存在しない場合は、公開されたメールが返されます。
下書きメールの作成または更新
マーケティング電子メール の下書きバージョンを作成または更新します。 下書きが存在しない場合、システムは現在の "ライブ" 電子メールから下書きを作成し、要求の本文をその下書きに適用します。 下書きのバージョンはバッファ上にのみ存在し、電子メールは複製されません。
マーケティング電子メールの変更を取得する
マーケティング電子メール のすべてのバージョンのリストを取得します。各エントリには、その特定のバージョンの完全な状態が含まれます。 現在のリビジョンの ID は -1 です。
マーケティング電子メールのリビジョンを取得する
マーケティング電子メールの特定のリビジョンを取得します。
AB テスト マーケティング電子メールを作成する
A/B テスト用の マーケティング電子メール のバリエーションを作成します。 新しいバリエーションはドラフトとして作成されます。 アクティブなバリエーションがすでに存在する場合、新しいバリエーションは作成されません。
マーケティング電子メールを取得する
すべてのマーケティング電子メールのリストを取得します。 結果をフィルタリングして、特定の電子メールのセットを見つけることができます。
マーケティング電子メールの作成
新しいマーケティング電子メールを作成します。
下書きマーケティング電子メールのリビジョン
マーケティング電子メール の以前のリビジョンを復元します。 現在のリビジョンは古くなり、復元されたリビジョンには新しいバージョン番号が与えられます。
クローン マーケティング電子メール
一意の識別子を除き、元のメールと同じプロパティを持つ複製メールを作成します。
マーケティング電子メールを取得する
マーケティング電子メールの詳細を取得します。
マーケティング 電子メールを削除する
マーケティング電子メールを削除します。
マーケティング電子メールの更新
マーケティング電子メール のプロパティを変更します。
SMTP トークンを作成する
SMTP トークンを作成します。
SMTP トークンのクエリ
キャンペーン名で複数の SMTP トークンをクエリするか、電子メール キャンペーン ID で単一のトークンをクエリします。
トークンの削除
識別子で単一トークンを削除します。
トークンのクエリ
識別子で単一トークンをクエリします。
トークン パスワードのリセット
特定のトークンの代替パスワードを作成できるようにします。 パスワードが正常にリセットされると、トークンの古いパスワードは無効になります。
既知の問題と制限事項
現時点で、既知の問題は発生していません。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | Description | Required |
|---|---|---|---|
| アクセス トークン ('Bearer YOUR_ACCESS_TOKEN' の形式) | securestring | この API のアクセストークン ('Bearer YOUR_ACCESS_TOKEN' 形式) | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| AB テスト マーケティング電子メールを作成する |
A/B テスト用の マーケティング電子メール のバリエーションを作成します。 新しいバリエーションはドラフトとして作成されます。 アクティブなバリエーションがすでに存在する場合、新しいバリエーションは作成されません。 |
| AB マーケティング電子メール バリエーションを取得 |
A/B マーケティング電子メール のバリエーションを取得します。 電子メールがバリエーション A (マスター) の場合、バリエーション B (バリアント) が返され、その逆も同様です。 |
| SMTP トークンのクエリ |
キャンペーン名で複数の SMTP トークンをクエリするか、電子メール キャンペーン ID で単一のトークンをクエリします。 |
| SMTP トークンを作成する |
SMTP トークンを作成します。 |
| クローン マーケティング電子メール |
一意の識別子を除き、元のメールと同じプロパティを持つ複製メールを作成します。 |
| サブスクリプションの状態を取得する |
指定された連絡先のサブスクリプションとそのステータスのリストを返します。 |
| サブスクリプションの詳細を取得する |
ポータルのすべてのサブスクリプション詳細のリストを取得します。 |
| トークン パスワードのリセット |
特定のトークンの代替パスワードを作成できるようにします。 パスワードが正常にリセットされると、トークンの古いパスワードは無効になります。 |
| トークンのクエリ |
識別子で単一トークンをクエリします。 |
| トークンの削除 |
識別子で単一トークンを削除します。 |
| ドラフトをリセット |
ドラフトをライブ オブジェクトのコピーにリセットします。 |
| マーケティング 電子メールを削除する |
マーケティング電子メールを削除します。 |
| マーケティング電子メールのリビジョンを取得する |
マーケティング電子メールの特定のリビジョンを取得します。 |
| マーケティング電子メールの下書きを取得する |
メールの下書きバージョンを取得します (存在する場合)。 下書きバージョンが存在しない場合は、公開されたメールが返されます。 |
| マーケティング電子メールの作成 |
新しいマーケティング電子メールを作成します。 |
| マーケティング電子メールの変更を取得する |
マーケティング電子メール のすべてのバージョンのリストを取得します。各エントリには、その特定のバージョンの完全な状態が含まれます。 現在のリビジョンの ID は -1 です。 |
| マーケティング電子メールの更新 |
マーケティング電子メール のプロパティを変更します。 |
| マーケティング電子メールを取得する |
マーケティング電子メールの詳細を取得します。 |
| マーケティング電子メールを取得する |
すべてのマーケティング電子メールのリストを取得します。 結果をフィルタリングして、特定の電子メールのセットを見つけることができます。 |
| メールを送信 |
トランザクション電子メールを非同期的に送信します。 電子メール送信ステータスを使用してステータスを継続的にクエリするために使用できるステータス識別子を含む電子メール送信のステータスを返します。 |
| 一括通信の基本設定を作成 |
一括通信の基本設定要求を作成します。 この要求は、バルク通信設定ステータスを使用してステータスを継続的にクエリするために使用できるステータス識別子を返します。 |
| 下書きマーケティング電子メールのリビジョン |
マーケティング電子メール の以前のリビジョンを復元します。 現在のリビジョンは古くなり、復元されたリビジョンには新しいバージョン番号が与えられます。 |
| 下書きマーケティング電子メールを取得する |
マーケティング電子メール の以前のリビジョンを DRAFT 状態に復元します。 そのオブジェクトのドラフトに現在何かがある場合、それは上書きされます。 |
| 下書きメールの作成または更新 |
マーケティング電子メール の下書きバージョンを作成または更新します。 下書きが存在しない場合、システムは現在の "ライブ" 電子メールから下書きを作成し、要求の本文をその下書きに適用します。 下書きのバージョンはバッファ上にのみ存在し、電子メールは複製されません。 |
| 取引先担当者の登録を解除 |
連絡先を指定されたサブスクリプション タイプから登録解除します。 このアクションは、ブランドまたはポータル レベルで連絡先を登録解除するために使用するのは無効であり、エラーが返されます。 |
| 登録された取引先担当者 |
連絡先を指定されたサブスクリプション タイプに登録します。 このアクションは、ブランドまたはポータル レベルで連絡先を購読するために使用するのは無効であり、エラーが返されます。 |
| 集計された統計を取得 |
指定された時間間隔の集計された統計を取得します。 また、その期間中に送信された電子メールのリストも返します。 |
| 集計された統計間隔を取得する |
指定された期間の間隔で集計された統計を取得します。 各間隔には、その時間内に送信された電子メールの集計統計が含まれます。 |
AB テスト マーケティング電子メールを作成する
A/B テスト用の マーケティング電子メール のバリエーションを作成します。 新しいバリエーションはドラフトとして作成されます。 アクティブなバリエーションがすでに存在する場合、新しいバリエーションは作成されません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
|
コンテンツ ID
|
contentId | string |
コンテンツ識別子。 |
|
|
Variation Name
|
variationName | string |
バリエーション名。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
AB マーケティング電子メール バリエーションを取得
A/B マーケティング電子メール のバリエーションを取得します。 電子メールがバリエーション A (マスター) の場合、バリエーション B (バリアント) が返され、その逆も同様です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
件名
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
SMTP トークンのクエリ
キャンペーン名で複数の SMTP トークンをクエリするか、電子メール キャンペーン ID で単一のトークンをクエリします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Campaign
|
campaignName | string |
キャンペーン名。 |
|
|
メール キャンペーン
|
emailCampaignId | string |
メール キャンペーン識別子。 |
|
|
後
|
after | string |
以後。 |
|
|
Limit
|
limit | string |
制限。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
キャンペーンの名前
|
results.campaignName | string |
キャンペーン名。 |
|
取引先担当者を作成
|
results.createContact | string |
取引先担当者を作成します。 |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
作成者
|
results.createdBy | string |
作成者。 |
|
メール キャンペーン ID
|
results.emailCampaignId | string |
メール キャンペーン識別子。 |
|
ID
|
results.id | string |
識別子。 |
|
Password
|
results.password | string |
パスワード。 |
|
後
|
paging.next.after | string |
リンクの後。 |
|
Link
|
paging.next.link | string |
リンク。 |
SMTP トークンを作成する
SMTP トークンを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーンの名前
|
campaignName | string |
キャンペーン名。 |
|
|
取引先担当者を作成
|
createContact | string |
取引先担当者を作成します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
キャンペーンの名前
|
campaignName | string |
キャンペーン名。 |
|
取引先担当者を作成
|
createContact | string |
取引先担当者を作成します。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
作成者
|
createdBy | string |
作成者。 |
|
メール キャンペーン ID
|
emailCampaignId | string |
メール キャンペーン識別子。 |
|
ID
|
id | string |
識別子。 |
|
Password
|
password | string |
パスワード。 |
クローン マーケティング電子メール
一意の識別子を除き、元のメールと同じプロパティを持つ複製メールを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
|
件名
|
name | string |
名前。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
サブスクリプションの状態を取得する
指定された連絡先のサブスクリプションとそのステータスのリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
電子メールアドレス
|
emailAddress | True | string |
メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Recipient
|
recipient | string |
受信者。 |
|
サブスクリプションの状態
|
subscriptionStatuses | array of object | |
|
Description
|
subscriptionStatuses.description | string |
説明設定。 |
|
ID
|
subscriptionStatuses.id | string |
識別子。 |
|
件名
|
subscriptionStatuses.name | string |
名前。 |
|
ステータスのソース
|
subscriptionStatuses.sourceOfStatus | string |
ステータスのソース |
|
Status
|
subscriptionStatuses.status | string |
状態。 |
|
ブランド ID
|
subscriptionStatuses.brandId | string |
ブランドの識別子。 |
|
基本設定グループ
|
subscriptionStatuses.preferenceGroupName | string |
基本設定グループ名。 |
|
法的根拠
|
subscriptionStatuses.legalBasis | string |
法的根拠。 |
|
法的根拠の説明
|
subscriptionStatuses.legalBasisExplanation | string |
法的根拠の説明。 |
サブスクリプションの詳細を取得する
ポータルのすべてのサブスクリプション詳細のリストを取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サブスクリプション詳細
|
subscriptionDefinitions | array of object | |
|
作成日
|
subscriptionDefinitions.createdAt | string |
作成日時。 |
|
Description
|
subscriptionDefinitions.description | string |
説明設定。 |
|
ID
|
subscriptionDefinitions.id | string |
識別子。 |
|
アクティブである
|
subscriptionDefinitions.isActive | boolean |
アクティブかどうか。 |
|
Is Default
|
subscriptionDefinitions.isDefault | boolean |
既定かどうか。 |
|
内部
|
subscriptionDefinitions.isInternal | boolean |
内部かどうか。 |
|
件名
|
subscriptionDefinitions.name | string |
名前。 |
|
更新日
|
subscriptionDefinitions.updatedAt | string |
更新時刻。 |
|
パーパス
|
subscriptionDefinitions.purpose | string |
目的。 |
|
通信方法
|
subscriptionDefinitions.communicationMethod | string |
通信方法。 |
トークン パスワードのリセット
特定のトークンの代替パスワードを作成できるようにします。 パスワードが正常にリセットされると、トークンの古いパスワードは無効になります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Token
|
tokenId | True | string |
トークン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
キャンペーンの名前
|
campaignName | string |
キャンペーン名。 |
|
取引先担当者を作成
|
createContact | string |
取引先担当者を作成します。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
作成者
|
createdBy | string |
作成者。 |
|
メール キャンペーン ID
|
emailCampaignId | string |
メール キャンペーン識別子。 |
|
ID
|
id | string |
識別子。 |
|
Password
|
password | string |
パスワード。 |
トークンのクエリ
識別子で単一トークンをクエリします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Token
|
tokenId | True | string |
トークン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
キャンペーンの名前
|
campaignName | string |
キャンペーン名。 |
|
取引先担当者を作成
|
createContact | string |
取引先担当者を作成します。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
作成者
|
createdBy | string |
作成者。 |
|
メール キャンペーン ID
|
emailCampaignId | string |
メール キャンペーン識別子。 |
|
ID
|
id | string |
識別子。 |
|
Password
|
password | string |
パスワード。 |
トークンの削除
ドラフトをリセット
ドラフトをライブ オブジェクトのコピーにリセットします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
- 返答
- string
マーケティング 電子メールを削除する
マーケティング電子メールを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
- 返答
- string
マーケティング電子メールのリビジョンを取得する
マーケティング電子メールの特定のリビジョンを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
|
改訂 ID
|
revisionId | True | string |
リビジョン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
識別子。 |
|
テンプレート パス
|
object.content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
object.content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
件名
|
object.from.fromName | string |
送信者名。 |
|
返信先
|
object.from.replyTo | string |
返信先。 |
|
カスタム返信先
|
object.from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
object.id | string |
識別子。 |
|
件名
|
object.name | string |
名前。 |
|
公開へと送信
|
object.sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
object.state | string |
都道府県。 |
|
サブカテゴリ
|
object.subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
object.subject | string |
件名。 |
|
参照項目
|
object.to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
object.to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
object.to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
object.to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
object.to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
object.to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
object.createdById | string |
識別子によって作成。 |
|
タイプ
|
object.type | string |
種類。 |
|
アクティブなドメイン
|
object.activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
object.archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
object.folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
object.feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
object.testing.testId | string |
テスト識別子。 |
|
待機する時間
|
object.testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
object.testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
object.testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
object.testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
object.testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
object.testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
ID
|
object.subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
object.subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
object.subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
object.updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
object.publishedById | string |
識別子によって公開済み。 |
|
Language
|
object.language | string |
言語。 |
|
Campaign
|
object.campaign | string |
キャンペーン。 |
|
Slug
|
object.webversion.slug | string |
置換フィールド。 |
|
Domain
|
object.webversion.domain | string |
ドメイン。 |
|
肩書き
|
object.webversion.title | string |
肩書き。 |
|
メタ記述
|
object.webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
object.webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
object.webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
object.webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
object.rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
object.rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
object.rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
object.rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
object.rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
object.rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
object.rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
object.rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
object.isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
object.isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
object.publishDate | string |
公開された日。 |
|
更新日
|
object.updatedAt | string |
更新時刻。 |
|
作成日
|
object.createdAt | string |
作成日時。 |
|
Deleted At
|
object.deletedAt | string |
削除日時。 |
|
Published At
|
object.publishedAt | string |
公開日時。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
メール
|
user.email | string |
メール アドレス。 |
|
正式な名前
|
user.fullName | string |
氏名。 |
|
ID
|
user.id | string |
識別子。 |
マーケティング電子メールの下書きを取得する
メールの下書きバージョンを取得します (存在する場合)。 下書きバージョンが存在しない場合は、公開されたメールが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
マーケティング電子メールの作成
新しいマーケティング電子メールを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート パス
|
templatePath | string |
テンプレート パス。 |
|
|
プレーン テキスト バージョン
|
plainTextVersion | string |
プレーン テキスト バージョン。 |
|
|
送信者
|
fromName | string |
送信者名。 |
|
|
返信先
|
replyTo | string |
返信先。 |
|
|
カスタム返信先
|
customReplyTo | string |
カスタム返信先。 |
|
|
ID
|
id | string |
識別子。 |
|
|
件名
|
name | string |
名前。 |
|
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
|
状態
|
state | string |
都道府県。 |
|
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
|
サブジェクト
|
subject | string |
件名。 |
|
|
参照項目
|
include | array of string |
アレイが含まれます。 |
|
|
除外する
|
exclude | array of string |
アレイを除外。 |
|
|
参照項目
|
include | array of string |
アレイが含まれます。 |
|
|
除外する
|
exclude | array of string |
アレイを除外。 |
|
|
送信頻度の制限
|
limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
|
グレイメールの抑制
|
suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
|
タイプ
|
type | string |
種類。 |
|
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
|
テスト ID
|
testId | string |
テスト識別子。 |
|
|
待機する時間
|
hoursToWait | integer |
待機する時間。 |
|
|
AB 成功指標
|
abSuccessMetric | string |
A/B 成功指標。 |
|
|
AB サンプル サイズのデフォルト
|
abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
|
AB ステータス
|
abStatus | string |
A/B の状態。 |
|
|
AB テストのパーセント
|
abTestPercentage | string |
A/B テストのパーセント。 |
|
|
AB サンプリングのデフォルト
|
abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
|
Subscription ID
|
subscriptionId | string |
サブスクリプション識別子です。 |
|
|
基本設定グループID
|
preferencesGroupId | string |
基本設定のグループ識別子。 |
|
|
オフィスの位置 ID
|
officeLocationId | string |
オフィスの場所の識別子。 |
|
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
|
Language
|
language | string |
言語。 |
|
|
Campaign
|
campaign | string |
キャンペーン。 |
|
|
Slug
|
slug | string |
置換フィールド。 |
|
|
Domain
|
domain | string |
ドメイン。 |
|
|
肩書き
|
title | string |
肩書き。 |
|
|
メタ記述
|
metaDescription | string |
メタ記述です。 |
|
|
URL にリダイレクト
|
redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
|
ページ ID にリダイレクト
|
redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
|
有効期限
|
expiresAt | string |
期限切れになる時。 |
|
|
最大エントリ
|
maxEntries | string |
最大エントリ。 |
|
|
[URL]
|
url | string |
URL アドレス。 |
|
|
HubSpot ブログ ID
|
hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
|
ブログ メールの種類
|
blogEmailType | string |
ブログ メールの種類。 |
|
|
ブログ画像の最大幅
|
blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
|
エントリ テンプレート
|
rssEntryTemplate | string |
エントリ テンプレート。 |
|
|
見出しを件名として使用する
|
useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
|
ブログのレイアウト
|
blogLayout | string |
ブログのレイアウト。 |
|
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
|
公開日
|
publishDate | string |
公開された日。 |
|
|
更新日
|
updatedAt | string |
更新時刻。 |
|
|
作成日
|
createdAt | string |
作成日時。 |
|
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
|
Published At
|
publishedAt | string |
公開場所。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
マーケティング電子メールの変更を取得する
マーケティング電子メール のすべてのバージョンのリストを取得します。各エントリには、その特定のバージョンの完全な状態が含まれます。 現在のリビジョンの ID は -1 です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
後
|
after | string |
以後。 |
|
|
前
|
before | string |
以前。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
識別子。 |
|
待機する AB 時間
|
results.object.abHoursToWait | string |
待機する A/B 時間。 |
|
AB ステータス
|
results.object.abStatus | string |
A/B の状態。 |
|
AB テスト ID
|
results.object.abTestId | string |
A/B テスト識別子。 |
|
アーカイブ日時
|
results.object.archivedAt | string |
アーカイブ日時。 |
|
ダッシュボードにアーカイブ
|
results.object.archivedInDashboard | boolean |
ダッシュボードにアーカイブするかどうか。 |
|
アタッチされたスタイルシート
|
results.object.attachedStylesheets | array of object |
アタッチされたスタイルシート オブジェクト。 |
|
Author
|
results.object.authorName | string |
作成者の名前。 |
|
ブログ メールの種類
|
results.object.blogEmailType | string |
ブログ メールの種類。 |
|
Campaign
|
results.object.campaign | string |
キャンペーン。 |
|
Category ID
|
results.object.categoryId | string |
カテゴリの識別子。 |
|
コンテンツ グループ ID
|
results.object.contentGroupId | string |
コンテンツ グループ識別子。 |
|
コンテンツ タイプ カテゴリ
|
results.object.contentTypeCategory | string |
コンテンツ タイプ カテゴリ。 |
|
ページを作成する
|
results.object.createPage | string |
ページを作成します。 |
|
Created
|
results.object.created | string |
作成日。 |
|
作成者 ID
|
results.object.createdById | string |
識別子によって作成。 |
|
現在の状態
|
results.object.currentState | string |
現在の状態。 |
|
現在公開中
|
results.object.currentlyPublished | boolean |
現在公開中かどうか。 |
|
カスタム返信先
|
results.object.customReplyTo | string |
カスタム返信先。 |
|
カスタム返信を有効
|
results.object.customReplyToEnabled | boolean |
カスタム返信を有効にするかどうか。 |
|
Domain
|
results.object.domain | string |
ドメイン。 |
|
動的ページ データ ソース ID
|
results.object.dynamicPageDataSourceId | string |
動的ページ データ ソース識別子。 |
|
動的ページ データ ソース タイプ
|
results.object.dynamicPageDataSourceType | string |
動的ページ データ ソース タイプ。 |
|
動的ページ HubDb テーブル ID
|
results.object.dynamicPageHubDbTableId | string |
動的ページ HubDb テーブル識別子。 |
|
電子メールの種類
|
results.object.emailType | string |
電子メールの種類。 |
|
ドメイン スタイルシートを有効にする
|
results.object.enableDomainStylesheets | boolean |
ドメイン スタイルシートを有効にするかどうか。 |
|
レイアウト スタイルシートを有効にする
|
results.object.enableLayoutStylesheets | boolean |
レイアウト スタイルシートを有効にするかどうか。 |
|
おすすめのイメージ
|
results.object.featuredImage | string |
注目の画像。 |
|
注目の画像の代替テキスト
|
results.object.featuredImageAltText | string |
注目の画像の代替テキスト。 |
|
フォルダー ID
|
results.object.folderId | string |
フォルダー識別子。 |
|
フッター HTML
|
results.object.footerHtml | string |
フッター HTML コード。 |
|
送信者
|
results.object.fromName | string |
送信者名。 |
|
ヘッダー HTML
|
results.object.headHtml | string |
ヘッダー HTML コード。 |
|
HTML タイトル
|
results.object.htmlTitle | string |
HTML タイトル。 |
|
ID
|
results.object.id | string |
識別子。 |
|
既定のカスタム CSS を含める
|
results.object.includeDefaultCustomCss | boolean |
既定のカスタム CSS を含めるかどうか。 |
|
グレイメール抑制は有効になっているか
|
results.object.isGraymailSuppressionEnabled | boolean |
グレイメール抑制は有効になっているかどうか。 |
|
Language
|
results.object.language | string |
言語。 |
|
Rel Canonical URL のリンク
|
results.object.linkRelCanonicalUrl | string |
rel canonical URL アドレスのリンク。 |
|
mab 実験 ID
|
results.object.mabExperimentId | string |
mab 実験識別子。 |
|
除外されるメーリングリスト
|
results.object.mailingListsExcluded | array of string |
除外される配列のメーリングリスト |
|
含まれるメーリングリスト
|
results.object.mailingListsIncluded | array of string |
配列を含むメーリングリスト |
|
最大 RSS エントリ
|
results.object.maxRssEntries | integer |
最大 RSS エントリ。 |
|
メタ記述
|
results.object.metaDescription | string |
メタ記述です。 |
|
件名
|
results.object.name | string |
名前。 |
|
ページ有効期限
|
results.object.pageExpiryDate | string |
ページの有効期限。 |
|
ページ有効期限が有効化
|
results.object.pageExpiryEnabled | boolean |
ページの有効期限が有効かどうか。 |
|
ページ期限リダイレクト ID
|
results.object.pageExpiryRedirectId | string |
ページ有効期限リダイレクト識別子。 |
|
ページ期限リダイレクト ID
|
results.object.pageExpiryRedirectUrl | string |
ページ有効期限リダイレクト URL アドレス。 |
|
ページをリダイレクト
|
results.object.pageRedirected | string |
リダイレクトされたページ。 |
|
Password
|
results.object.password | string |
パスワード。 |
|
パブリック アクセス ルールが有効
|
results.object.publicAccessRulesEnabled | boolean |
パブリック アクセス ルールが有効かどうか。 |
|
公開日
|
results.object.publishDate | string |
公開された日。 |
|
公開即時
|
results.object.publishImmediately | boolean |
すぐに公開するかどうか。 |
|
返信先
|
results.object.replyTo | string |
返信先。 |
|
RSS メール作成者行テンプレート
|
results.object.rssEmailAuthorLineTemplate | string |
RSS メール作成者行テンプレート。 |
|
RSS メール ブログ画像の最大幅
|
results.object.rssEmailBlogImageMaxWidth | string |
RSS メール ブログ画像の最大幅。 |
|
テキストによる RSS 電子メール
|
results.object.rssEmailByText | string |
テキストによる RSS メール |
|
RSS メールのクリック スルー テキスト
|
results.object.rssEmailClickThroughText | string |
RSS メールのクリック スルー テキスト |
|
RSS メール コメント テキスト
|
results.object.rssEmailCommentText | string |
RSS メール コメント テキスト。 |
|
RSS メール エントリ テンプレート
|
results.object.rssEmailEntryTemplate | string |
RSS メール エントリ テンプレート。 |
|
RSS メール エントリ テンプレートが有効化
|
results.object.rssEmailEntryTemplateEnabled | string |
RSS メール エントリ テンプレートが有効化。 |
|
RSS メール ID
|
results.object.rssEmailId | string |
RSS メール識別子。 |
|
RSS メール URL
|
results.object.rssEmailUrl | string |
RSS メール URL アドレス。 |
|
Slug
|
results.object.slug | string |
置換フィールド。 |
|
状態
|
results.object.state | string |
都道府県。 |
|
サブカテゴリ
|
results.object.subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
results.object.subject | string |
件名。 |
|
サブスクリプション
|
results.object.subscription | string |
サブスクリプション。 |
|
サブスクリプション ブログ ID
|
results.object.subscriptionBlogId | string |
サブスクリプション ブログ識別子。 |
|
サブスクリプション
|
results.object.subscriptionName | string |
サブスクリプション名。 |
|
テンプレート パス
|
results.object.templatePath | string |
テンプレート パス。 |
|
トランザクション
|
results.object.transactional | string |
トランザクション。 |
|
ID から翻訳される
|
results.object.translatedFromId | string |
識別子から翻訳されています。 |
|
更新済み
|
results.object.updated | string |
更新日。 |
|
ID で更新
|
results.object.updatedById | string |
識別子で更新。 |
|
[URL]
|
results.object.url | string |
URL アドレス。 |
|
注目の画像を使用する
|
results.object.useFeaturedImage | boolean |
注目の画像を使用するかどうか。 |
|
RSS 見出しを件名として使用する
|
results.object.useRssHeadlineAsSubject | boolean |
RSS 見出しを件名として使用するかどうか。 |
|
VID が除外
|
results.object.vidsExcluded | array of string |
VID の除外配列。 |
|
VID が含まれている
|
results.object.vidsIncluded | array of string |
配列が含まれている VID。 |
|
ワークフロー
|
results.object.workflowNames | array of string |
ワークフロー名。 |
|
受信者の疲労抑制は有効になっていますか
|
results.object.isRecipientFatigueSuppressionEnabled | boolean |
受信者の疲労抑制が有効になっているかどうか。 |
|
フィードバック アンケート ID
|
results.object.feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
メール
|
results.user.email | string |
メール アドレス。 |
|
正式な名前
|
results.user.fullName | string |
氏名。 |
|
ID
|
results.user.id | string |
識別子。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
リンクの後。 |
|
Link
|
paging.next.link | string |
リンク。 |
|
前
|
paging.prev.before | string |
リンクの前。 |
|
Link
|
paging.prev.link | string |
リンク。 |
マーケティング電子メールの更新
マーケティング電子メール のプロパティを変更します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
|
テンプレート パス
|
templatePath | string |
テンプレート パス。 |
|
|
プレーン テキスト バージョン
|
plainTextVersion | string |
プレーン テキスト バージョン。 |
|
|
送信者
|
fromName | string |
送信者名。 |
|
|
返信先
|
replyTo | string |
返信先。 |
|
|
カスタム返信先
|
customReplyTo | string |
カスタム返信先。 |
|
|
ID
|
id | string |
識別子。 |
|
|
件名
|
name | string |
名前。 |
|
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
|
状態
|
state | string |
都道府県。 |
|
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
|
サブジェクト
|
subject | string |
件名。 |
|
|
参照項目
|
include | array of string |
アレイが含まれます。 |
|
|
除外する
|
exclude | array of string |
アレイを除外。 |
|
|
参照項目
|
include | array of string |
アレイが含まれます。 |
|
|
除外する
|
exclude | array of string |
アレイを除外。 |
|
|
送信頻度の制限
|
limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
|
グレイメールの抑制
|
suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
|
タイプ
|
type | string |
種類。 |
|
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
|
テスト ID
|
testId | string |
テスト識別子。 |
|
|
待機する時間
|
hoursToWait | integer |
待機する時間。 |
|
|
AB 成功指標
|
abSuccessMetric | string |
A/B 成功指標。 |
|
|
AB サンプル サイズのデフォルト
|
abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
|
AB ステータス
|
abStatus | string |
A/B の状態。 |
|
|
AB テストのパーセント
|
abTestPercentage | string |
A/B テストのパーセント。 |
|
|
AB サンプリングのデフォルト
|
abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
|
Subscription ID
|
subscriptionId | string |
サブスクリプション識別子です。 |
|
|
基本設定グループID
|
preferencesGroupId | string |
基本設定のグループ識別子。 |
|
|
オフィスの位置 ID
|
officeLocationId | string |
オフィスの場所の識別子。 |
|
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
|
Language
|
language | string |
言語。 |
|
|
Campaign
|
campaign | string |
キャンペーン。 |
|
|
Slug
|
slug | string |
置換フィールド。 |
|
|
Domain
|
domain | string |
ドメイン。 |
|
|
肩書き
|
title | string |
肩書き。 |
|
|
メタ記述
|
metaDescription | string |
メタ記述です。 |
|
|
URL にリダイレクト
|
redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
|
ページ ID にリダイレクト
|
redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
|
有効期限
|
expiresAt | string |
期限切れになる時。 |
|
|
最大エントリ
|
maxEntries | string |
最大エントリ。 |
|
|
[URL]
|
url | string |
URL アドレス。 |
|
|
HubSpot ブログ ID
|
hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
|
ブログ メールの種類
|
blogEmailType | string |
ブログ メールの種類。 |
|
|
ブログ画像の最大幅
|
blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
|
エントリ テンプレート
|
rssEntryTemplate | string |
エントリ テンプレート。 |
|
|
見出しを件名として使用する
|
useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
|
ブログのレイアウト
|
blogLayout | string |
ブログのレイアウト。 |
|
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
|
公開日
|
publishDate | string |
公開された日。 |
|
|
更新日
|
updatedAt | string |
更新時刻。 |
|
|
作成日
|
createdAt | string |
作成日時。 |
|
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
|
Published At
|
publishedAt | string |
公開場所。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
マーケティング電子メールを取得する
マーケティング電子メールの詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
統計を含める
|
includeStats | boolean |
統計を含めるかどうか。 |
|
|
プロパティを含める
|
includedProperties | boolean |
プロパティを含めるかどうか。 |
|
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
マーケティング電子メールを取得する
すべてのマーケティング電子メールのリストを取得します。 結果をフィルタリングして、特定の電子メールのセットを見つけることができます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
作成日
|
createdAt | string |
作成日時。 |
|
|
作成後
|
createdAfter | string |
以降に作成した。 |
|
|
Created Before
|
createdBefore | string |
前に作成した。 |
|
|
更新日
|
updatedAt | string |
更新時刻。 |
|
|
Updated After
|
updatedAfter | string |
その後更新済み。 |
|
|
Updated Before
|
updatedBefore | string |
前に更新済み。 |
|
|
並び替え
|
sort | string |
並べ替え。 |
|
|
後
|
after | string |
以後。 |
|
|
Limit
|
limit | string |
制限。 |
|
|
統計を含める
|
includeStats | boolean |
統計を含めるかどうか。 |
|
|
タイプ
|
type | string |
種類。 |
|
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
|
プロパティを含める
|
includedProperties | boolean |
プロパティを含めるかどうか。 |
|
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
テンプレート パス
|
results.content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
results.content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
results.from.fromName | string |
送信者名。 |
|
返信先
|
results.from.replyTo | string |
返信先。 |
|
カスタム返信先
|
results.from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
results.id | string |
識別子。 |
|
件名
|
results.name | string |
名前。 |
|
公開へと送信
|
results.sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
results.state | string |
都道府県。 |
|
サブカテゴリ
|
results.subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
results.subject | string |
件名。 |
|
参照項目
|
results.to.contactLists.include | array of string |
含まれている。 |
|
除外する
|
results.to.contactLists.exclude | array of string |
除外されている。 |
|
参照項目
|
results.to.contactIds.include | array of string |
含まれている。 |
|
除外する
|
results.to.contactIds.exclude | array of string |
除外されている。 |
|
送信頻度の制限
|
results.to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
results.to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
results.createdById | string |
識別子によって作成。 |
|
タイプ
|
results.type | string |
種類。 |
|
アクティブなドメイン
|
results.activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
results.archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
results.folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
results.feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
results.testing.testId | string |
テスト識別子。 |
|
待機する時間
|
results.testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
results.testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
results.testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
results.testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
results.testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
results.testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
results.subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
results.subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
results.subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
results.updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
results.publishedById | string |
識別子によって公開済み。 |
|
Language
|
results.language | string |
言語。 |
|
Campaign
|
results.campaign | string |
キャンペーン。 |
|
Slug
|
results.webversion.slug | string |
置換フィールド。 |
|
Domain
|
results.webversion.domain | string |
ドメイン。 |
|
肩書き
|
results.webversion.title | string |
肩書き。 |
|
メタ記述
|
results.webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
results.webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
results.webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
results.webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
results.rssData.maxEntries | string |
最大エントリ |
|
[URL]
|
results.rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
results.rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
results.rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
results.rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
RSS エントリ テンプレート
|
results.rssData.rssEntryTemplate | string |
RSS。 |
|
見出しを件名として使用する
|
results.rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
results.rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
results.isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
results.isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
results.publishDate | string |
公開日です。 |
|
更新日
|
results.updatedAt | string |
更新時刻。 |
|
作成日
|
results.createdAt | string |
作成日時。 |
|
Deleted At
|
results.deletedAt | string |
削除日時。 |
|
Published At
|
results.publishedAt | string |
公開場所。 |
|
トータル
|
total | integer |
総数。 |
|
後
|
paging.next.after | string |
リンクの後。 |
|
Link
|
paging.next.link | string |
リンク。 |
メールを送信
トランザクション電子メールを非同期的に送信します。 電子メール送信ステータスを使用してステータスを継続的にクエリするために使用できるステータス識別子を含む電子メール送信のステータスを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | string |
メール アドレスの識別子。 |
|
|
受信先
|
to | string |
受信先アドレス。 |
|
|
送信者
|
from | string |
送信者アドレス。 |
|
|
送信 ID
|
sendId | string |
送信の識別子。 |
|
|
返信先
|
replyTo | array of string |
返信先配列。 |
|
|
CC
|
cc | array of string |
CC 配列。 |
|
|
BCC
|
bcc | array of string |
BCC 配列。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Status
|
status | string |
状態。 |
|
状態 ID
|
statusId | string |
状態の識別子。 |
|
送信結果
|
sendResult | string |
送信結果。 |
|
依頼者
|
requestedAt | string |
要求時刻。 |
|
開始した
|
startedAt | string |
開始日時。 |
|
完了日時
|
completedAt | string |
完了日時。 |
|
Created
|
eventId.created | string |
作成日。 |
|
ID
|
eventId.id | string |
識別子。 |
一括通信の基本設定を作成
一括通信の基本設定要求を作成します。 この要求は、バルク通信設定ステータスを使用してステータスを継続的にクエリするために使用できるステータス識別子を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
body
|
body | True | array of string |
戻り値
下書きマーケティング電子メールのリビジョン
マーケティング電子メール の以前のリビジョンを復元します。 現在のリビジョンは古くなり、復元されたリビジョンには新しいバージョン番号が与えられます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
|
改訂 ID
|
revisionId | True | string |
リビジョン識別子。 |
戻り値
- 返答
- string
下書きマーケティング電子メールを取得する
マーケティング電子メール の以前のリビジョンを DRAFT 状態に復元します。 そのオブジェクトのドラフトに現在何かがある場合、それは上書きされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
|
改訂 ID
|
revisionId | True | string |
リビジョン識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
下書きメールの作成または更新
マーケティング電子メール の下書きバージョンを作成または更新します。 下書きが存在しない場合、システムは現在の "ライブ" 電子メールから下書きを作成し、要求の本文をその下書きに適用します。 下書きのバージョンはバッファ上にのみ存在し、電子メールは複製されません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール ID
|
emailId | True | string |
メール アドレスの識別子。 |
|
テンプレート パス
|
templatePath | string |
テンプレート パス。 |
|
|
プレーン テキスト バージョン
|
plainTextVersion | string |
プレーン テキスト バージョン。 |
|
|
送信者
|
fromName | string |
送信者名。 |
|
|
返信先
|
replyTo | string |
返信先。 |
|
|
カスタム返信先
|
customReplyTo | string |
カスタム返信先。 |
|
|
ID
|
id | string |
識別子。 |
|
|
件名
|
name | string |
名前。 |
|
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
|
状態
|
state | string |
都道府県。 |
|
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
|
サブジェクト
|
subject | string |
件名。 |
|
|
参照項目
|
include | array of string |
アレイが含まれます。 |
|
|
除外する
|
exclude | array of string |
アレイを除外。 |
|
|
参照項目
|
include | array of string |
アレイが含まれます。 |
|
|
除外する
|
exclude | array of string |
アレイを除外。 |
|
|
送信頻度の制限
|
limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
|
グレイメールの抑制
|
suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
|
タイプ
|
type | string |
種類。 |
|
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
|
テスト ID
|
testId | string |
テスト識別子。 |
|
|
待機する時間
|
hoursToWait | integer |
待機する時間。 |
|
|
AB 成功指標
|
abSuccessMetric | string |
A/B 成功指標。 |
|
|
AB サンプル サイズのデフォルト
|
abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
|
AB ステータス
|
abStatus | string |
A/B の状態。 |
|
|
AB テストのパーセント
|
abTestPercentage | string |
A/B テストのパーセント。 |
|
|
AB サンプリングのデフォルト
|
abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
|
Subscription ID
|
subscriptionId | string |
サブスクリプション識別子です。 |
|
|
基本設定グループID
|
preferencesGroupId | string |
基本設定のグループ識別子。 |
|
|
オフィスの位置 ID
|
officeLocationId | string |
オフィスの場所の識別子。 |
|
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
|
Language
|
language | string |
言語。 |
|
|
Campaign
|
campaign | string |
キャンペーン。 |
|
|
Slug
|
slug | string |
置換フィールド。 |
|
|
Domain
|
domain | string |
ドメイン。 |
|
|
肩書き
|
title | string |
肩書き。 |
|
|
メタ記述
|
metaDescription | string |
メタ記述です。 |
|
|
URL にリダイレクト
|
redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
|
ページ ID にリダイレクト
|
redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
|
有効期限
|
expiresAt | string |
期限切れになる時。 |
|
|
最大エントリ
|
maxEntries | string |
最大エントリ。 |
|
|
[URL]
|
url | string |
URL アドレス。 |
|
|
HubSpot ブログ ID
|
hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
|
ブログ メールの種類
|
blogEmailType | string |
ブログ メールの種類。 |
|
|
ブログ画像の最大幅
|
blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
|
エントリ テンプレート
|
rssEntryTemplate | string |
エントリ テンプレート。 |
|
|
見出しを件名として使用する
|
useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
|
ブログのレイアウト
|
blogLayout | string |
ブログのレイアウト。 |
|
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
|
公開日
|
publishDate | string |
公開された日。 |
|
|
更新日
|
updatedAt | string |
更新時刻。 |
|
|
作成日
|
createdAt | string |
作成日時。 |
|
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
|
Published At
|
publishedAt | string |
公開場所。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
テンプレート パス
|
content.templatePath | string |
テンプレート パス。 |
|
プレーン テキスト バージョン
|
content.plainTextVersion | string |
プレーン テキスト バージョン。 |
|
送信者
|
from.fromName | string |
送信者名。 |
|
返信先
|
from.replyTo | string |
返信先。 |
|
カスタム返信先
|
from.customReplyTo | string |
カスタム返信先。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
公開へと送信
|
sendOnPublish | boolean |
公開に送信するかどうか。 |
|
状態
|
state | string |
都道府県。 |
|
サブカテゴリ
|
subcategory | string |
サブカテゴリ。 |
|
サブジェクト
|
subject | string |
件名。 |
|
参照項目
|
to.contactLists.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactLists.exclude | array of string |
アレイを除外。 |
|
参照項目
|
to.contactIds.include | array of string |
アレイが含まれます。 |
|
除外する
|
to.contactIds.exclude | array of string |
アレイを除外。 |
|
送信頻度の制限
|
to.limitSendFrequency | boolean |
送信頻度を制限するかどうか。 |
|
グレイメールの抑制
|
to.suppressGraymail | boolean |
グレーメールを抑制するかどうか。 |
|
作成者 ID
|
createdById | string |
識別子によって作成。 |
|
タイプ
|
type | string |
種類。 |
|
アクティブなドメイン
|
activeDomain | string |
アクティブなドメイン。 |
|
Archived
|
archived | boolean |
アーカイブ済みかどうか。 |
|
フォルダー ID
|
folderId | string |
フォルダー識別子。 |
|
フィードバック アンケート ID
|
feedbackSurveyId | string |
フィードバック アンケート識別子。 |
|
テスト ID
|
testing.testId | string |
テスト識別子。 |
|
待機する時間
|
testing.hoursToWait | integer |
待機する時間。 |
|
AB 成功指標
|
testing.abSuccessMetric | string |
A/B 成功指標。 |
|
AB サンプル サイズのデフォルト
|
testing.abSampleSizeDefault | string |
A/B サンプル サイズのデフォルト。 |
|
AB ステータス
|
testing.abStatus | string |
A/B の状態。 |
|
AB テストのパーセント
|
testing.abTestPercentage | string |
A/B テストのパーセント。 |
|
AB サンプリングのデフォルト
|
testing.abSamplingDefault | string |
A/B サンプリングのデフォルト。 |
|
Subscription ID
|
subscriptionDetails.subscriptionId | string |
サブスクリプション識別子です。 |
|
基本設定グループID
|
subscriptionDetails.preferencesGroupId | string |
基本設定のグループ識別子。 |
|
オフィスの位置 ID
|
subscriptionDetails.officeLocationId | string |
オフィスの場所の識別子。 |
|
ID で更新
|
updatedById | string |
識別子で更新。 |
|
ID によって公開済み
|
publishedById | string |
識別子によって公開済み。 |
|
Language
|
language | string |
言語。 |
|
Campaign
|
campaign | string |
キャンペーン。 |
|
Slug
|
webversion.slug | string |
置換フィールド。 |
|
Domain
|
webversion.domain | string |
ドメイン。 |
|
肩書き
|
webversion.title | string |
肩書き。 |
|
メタ記述
|
webversion.metaDescription | string |
メタ記述です。 |
|
URL にリダイレクト
|
webversion.redirectToUrl | string |
URL アドレスにリダイレクト。 |
|
ページ ID にリダイレクト
|
webversion.redirectToPageId | string |
ページ識別子にリダイレクト。 |
|
有効期限
|
webversion.expiresAt | string |
期限切れになる時。 |
|
最大エントリ
|
rssData.maxEntries | string |
最大エントリ。 |
|
[URL]
|
rssData.url | string |
URL アドレス。 |
|
HubSpot ブログ ID
|
rssData.hubspotBlogId | string |
HubSpot ブログの識別子。 |
|
ブログ メールの種類
|
rssData.blogEmailType | string |
ブログ メールの種類。 |
|
ブログ画像の最大幅
|
rssData.blogImageMaxWidth | string |
ブログ画像の最大幅。 |
|
エントリ テンプレート
|
rssData.rssEntryTemplate | string |
エントリ テンプレート。 |
|
見出しを件名として使用する
|
rssData.useHeadlineAsSubject | boolean |
見出しを件名として使用するかどうか。 |
|
ブログのレイアウト
|
rssData.blogLayout | string |
ブログのレイアウト。 |
|
トランザクション
|
isTransactional | boolean |
トランザクションかどうか。 |
|
公開済み
|
isPublished | boolean |
公開済みかどうか。 |
|
公開日
|
publishDate | string |
公開された日。 |
|
更新日
|
updatedAt | string |
更新時刻。 |
|
作成日
|
createdAt | string |
作成日時。 |
|
Deleted At
|
deletedAt | string |
削除日時。 |
|
Published At
|
publishedAt | string |
公開場所。 |
取引先担当者の登録を解除
連絡先を指定されたサブスクリプション タイプから登録解除します。 このアクションは、ブランドまたはポータル レベルで連絡先を登録解除するために使用するのは無効であり、エラーが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
電子メールアドレス
|
emailAddress | string |
メール アドレス。 |
|
|
Subscription ID
|
subscriptionId | string |
サブスクリプション識別子です。 |
|
|
法的根拠
|
legalBasis | string |
法的根拠。 |
|
|
法的根拠の説明
|
legalBasisExplanation | string |
法的根拠の説明。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Description
|
description | string |
説明設定。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
ステータスのソース
|
sourceOfStatus | string |
ステータスのソース |
|
Status
|
status | string |
状態。 |
|
ブランド ID
|
brandId | string |
ブランドの識別子。 |
|
基本設定グループ
|
preferenceGroupName | string |
基本設定グループ名。 |
|
法的根拠
|
legalBasis | string |
法的根拠。 |
|
法的根拠の説明
|
legalBasisExplanation | string |
法的根拠の説明。 |
登録された取引先担当者
連絡先を指定されたサブスクリプション タイプに登録します。 このアクションは、ブランドまたはポータル レベルで連絡先を購読するために使用するのは無効であり、エラーが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
電子メールアドレス
|
emailAddress | string |
メール アドレス。 |
|
|
Subscription ID
|
subscriptionId | string |
サブスクリプション識別子です。 |
|
|
法的根拠
|
legalBasis | string |
法的根拠。 |
|
|
法的根拠の説明
|
legalBasisExplanation | string |
法的根拠の説明。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Description
|
description | string |
説明設定。 |
|
ID
|
id | string |
識別子。 |
|
件名
|
name | string |
名前。 |
|
ステータスのソース
|
sourceOfStatus | string |
ステータスのソース |
|
Status
|
status | string |
状態。 |
|
ブランド ID
|
brandId | string |
ブランドの識別子。 |
|
基本設定グループ
|
preferenceGroupName | string |
基本設定グループ名。 |
|
法的根拠
|
legalBasis | string |
法的根拠。 |
|
法的根拠の説明
|
legalBasisExplanation | string |
法的根拠の説明。 |
集計された統計を取得
指定された時間間隔の集計された統計を取得します。 また、その期間中に送信された電子メールのリストも返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
先頭
|
startTimestamp | string |
開始タイムスタンプ。 |
|
|
末尾
|
endTimestamp | string |
終了タイムスタンプ。 |
|
|
メール ID
|
emailIds | string |
メール識別子。 |
|
|
Property
|
property | string |
プロパティ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メール
|
emails | array of string |
メール アドレスの配列。 |
集計された統計間隔を取得する
指定された期間の間隔で集計された統計を取得します。 各間隔には、その時間内に送信された電子メールの集計統計が含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Interval
|
interval | string |
サイクル間隔。 |
|
|
先頭
|
startTimestamp | string |
開始タイムスタンプ。 |
|
|
末尾
|
endTimestamp | string |
終了タイムスタンプ。 |
|
|
メール ID
|
emailIds | string |
メール識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
末尾
|
results.interval.end | string |
終了。 |
|
先頭
|
results.interval.start | string |
開始。 |
|
トータル
|
total | integer |
総数。 |
定義
string
これは基本的なデータ型 '文字列' です。