ConvertKit (独立した発行元)
ConvertKit は、視聴者の成長と収益化を簡単に行うのに役立つクリエイター向けの go-to マーケティング ハブです。 あなたのフォロワーをソーシャルメディアやYouTubeから美しいランディングページとオプトインテンプレートを使用してメールリストに変換します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | 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://convertkit.com/ |
| プライバシー ポリシー | https://convertkit.com/privacy |
| カテゴリ | Marketing |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| API シークレット | securestring | この API の API シークレット | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アカウントを取得する |
現在のアカウントを取得します。 |
| サブスクライバーからタグを削除する |
サブスクライバーからタグを削除します。 |
| サブスクライバーにタグを付け |
タグはサブスクリプションとして処理されます。 メール アドレスをタグにサブスクライブして、そのメール アドレスを持つサブスクライバーにそのタグを適用します。 |
| サブスクライバーのタグを一覧表示する |
サブスクライバーのすべてのタグの一覧を取得します。 |
| サブスクライバーの一覧表示 |
サブスクライバーの一覧を返します。 登録解除のみの場合は、並べ替えフィールドパラメーターの値で取り消された値を使用します (現在サポートされている唯一の追加の並べ替えフィールド)。 |
| サブスクライバーの更新 |
1 つのサブスクライバーの情報を更新します。 |
| サブスクライバーの登録を解除する |
すべてのフォームとシーケンスからサブスクライバーの登録を解除します。 |
| サブスクライバーを取得する |
1 つのサブスクライバー レコードを取得します。 |
| シーケンスにサブスクライバーを追加する |
いずれかのシーケンスにメール アドレスをサブスクライブします。 |
| シーケンスのサブスクリプションを一覧表示する |
サブスクライバー データを含むシーケンスへのサブスクリプションを取得します。 |
| シーケンスを一覧表示する |
アカウントのシーケンスの一覧を取得します。 |
| タグのサブスクリプションを一覧表示する |
サブスクライバー データを含むタグへのサブスクリプションの一覧を取得します。 |
| タグを一覧表示する |
アカウントのタグの一覧を取得します。 |
| タグを作成する |
新しいタグを作成します。 |
| フォームにサブスクライバーを追加する |
フォームの 1 つにメール アドレスをサブスクライブします。 |
| フォームへのサブスクリプションを一覧表示する |
サブスクライバー データを含むフォームへのサブスクリプションの一覧を取得します。 |
| フォームを取得する |
アカウントのすべてのフォームの一覧を取得します。 |
| ブロードキャストを一覧表示する |
アカウントのすべてのブロードキャストの一覧を取得します。 |
| ブロードキャストを作成する |
下書きまたはスケジュールされたブロードキャストを作成します。 属性を指定せずに下書きブロードキャストを作成できます。 スケジュールされたブロードキャストには、少なくとも件名とコンテンツが含まれている必要があります。 |
| ブロードキャストを取得する |
ドラフト、スケジュール済み、以前に送信されたブロードキャストなど、特定のブロードキャストの詳細を取得します。 |
| ブロードキャストを更新する |
特定のブロードキャストの属性を更新します。 現在送信中または送信済みのブロードキャストは更新されない場合があります。 |
| ブロードキャストを破棄する |
下書きまたはスケジュールされたブロードキャスト レコードを完全に削除します。 現在送信中または送信済みのブロードキャストは削除できません。 |
| ブロードキャスト統計を取得する |
特定のブロードキャストの統計情報 (受信者数、開封率、クリック率、サブスクライブ解除数、合計クリック数、状態、送信進行状況) を取得します。 |
| メールでサブスクライバーからタグを削除する |
メール アドレスでサブスクライバーからタグを削除します。 |
| 購入を一覧表示する |
アカウントのすべての購入の一覧を取得します。 |
| 購入を作成する |
購入を作成します。 |
| 購入を取得する |
ID で特定の購入を取得します。 |
アカウントを取得する
現在のアカウントを取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string |
名前。 |
|
プランの種類
|
plan_type | string |
プランの種類。 |
|
プライマリ メール アドレス
|
primary_email_address | string |
プライマリ メール アドレス。 |
サブスクライバーからタグを削除する
サブスクライバーからタグを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクライバー ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
|
タグ ID
|
tag_id | True | string |
タグの一意識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
一意識別子。 |
|
名前
|
name | string |
名前。 |
|
Created At
|
created_at | string |
作成時に指定します。 |
サブスクライバーにタグを付け
タグはサブスクリプションとして処理されます。 メール アドレスをタグにサブスクライブして、そのメール アドレスを持つサブスクライバーにそのタグを適用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
タグ ID
|
tag_id | True | string |
タグの一意識別子。 |
|
Email
|
string |
電子メール アドレス。 |
||
|
名前
|
first_name | string |
名。 |
|
|
タグ
|
tags | array of integer |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
subscription.id | integer |
一意識別子。 |
|
State
|
subscription.state | string |
都道府県。 |
|
Created At
|
subscription.created_at | string |
作成時に指定します。 |
|
情報源
|
subscription.source | string |
ソース。 |
|
参照元
|
subscription.referrer | string |
参照元。 |
|
サブスクライブ可能な ID
|
subscription.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
|
サブスクライブ可能な型
|
subscription.subscribable_type | string |
サブスクライブ可能な型。 |
|
ID
|
subscription.subscriber.id | integer |
一意識別子。 |
サブスクライバーのタグを一覧表示する
サブスクライバーのすべてのタグの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクライバー ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タグ
|
tags | array of object | |
|
ID
|
tags.id | integer |
一意識別子。 |
|
名前
|
tags.name | string |
名前。 |
|
Created At
|
tags.created_at | string |
作成時に指定します。 |
サブスクライバーの一覧表示
サブスクライバーの一覧を返します。 登録解除のみの場合は、並べ替えフィールドパラメーターの値で取り消された値を使用します (現在サポートされている唯一の追加の並べ替えフィールド)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
より
|
from | string |
From。 |
|
|
移行先
|
to | string |
次の値を指定します。 |
|
|
更新後
|
updated_from | string |
更新のタイミング。 |
|
|
更新日
|
updated_to | string |
更新のタイミング。 |
|
|
並べ替え順序
|
sort_order | string |
並べ替え順序。 |
|
|
並べ替えフィールド
|
sort_field | string |
並べ替えフィールド。 |
|
|
メール アドレス
|
email_address | string |
電子メール アドレス。 |
|
|
ページ
|
page | integer |
ページ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
合計サブスクライバー数
|
total_subscribers | integer |
サブスクライバーの合計数。 |
|
ページ
|
page | integer |
ページ。 |
|
合計ページ数
|
total_pages | integer |
合計ページ数。 |
|
Subscribers
|
subscribers | array of object | |
|
ID
|
subscribers.id | integer |
一意識別子。 |
|
名前
|
subscribers.first_name | string |
名。 |
|
メール アドレス
|
subscribers.email_address | string |
電子メール アドレス。 |
|
State
|
subscribers.state | string |
都道府県。 |
|
Created At
|
subscribers.created_at | string |
作成時に指定します。 |
|
姓
|
subscribers.fields.last_name | string |
姓。 |
サブスクライバーの更新
1 つのサブスクライバーの情報を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクライバー ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
|
名前
|
first_name | string |
名。 |
|
|
メール アドレス
|
email_address | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
一意識別子。 |
|
名前
|
subscriber.first_name | string |
名。 |
|
メール アドレス
|
subscriber.email_address | string |
電子メール アドレス。 |
|
State
|
subscriber.state | string |
都道府県。 |
|
Created At
|
subscriber.created_at | string |
作成時に指定します。 |
サブスクライバーの登録を解除する
すべてのフォームとシーケンスからサブスクライバーの登録を解除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Email
|
True | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
一意識別子。 |
|
名前
|
subscriber.first_name | string |
名。 |
|
メール アドレス
|
subscriber.email_address | string |
電子メール アドレス。 |
|
State
|
subscriber.state | string |
都道府県。 |
|
Created At
|
subscriber.created_at | string |
作成時に指定します。 |
|
姓
|
subscriber.fields.last_name | string |
姓。 |
サブスクライバーを取得する
1 つのサブスクライバー レコードを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクライバー ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
一意識別子。 |
|
名前
|
subscriber.first_name | string |
名。 |
|
メール アドレス
|
subscriber.email_address | string |
電子メール アドレス。 |
|
State
|
subscriber.state | string |
都道府県。 |
|
Created At
|
subscriber.created_at | string |
作成時に指定します。 |
|
姓
|
subscriber.fields.last_name | string |
姓。 |
シーケンスにサブスクライバーを追加する
いずれかのシーケンスにメール アドレスをサブスクライブします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シーケンス ID
|
sequence_id | True | string |
シーケンスの一意識別子。 |
|
Email
|
True | string |
電子メール アドレス。 |
|
|
名前
|
first_name | string |
名。 |
|
|
タグ
|
tags | array of integer |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
subscription.id | integer |
一意識別子。 |
|
State
|
subscription.state | string |
都道府県。 |
|
Created At
|
subscription.created_at | string |
作成時に指定します。 |
|
情報源
|
subscription.source | string |
ソース。 |
|
参照元
|
subscription.referrer | string |
参照元。 |
|
サブスクライブ可能な ID
|
subscription.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
|
サブスクライブ可能な型
|
subscription.subscribable_type | string |
サブスクライブ可能な型。 |
|
ID
|
subscription.subscriber.id | integer |
一意識別子。 |
シーケンスのサブスクリプションを一覧表示する
サブスクライバー データを含むシーケンスへのサブスクリプションを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
シーケンス ID
|
sequence_id | True | string |
シーケンスの一意識別子。 |
|
並べ替え順序
|
sort_order | string |
並べ替え順序。 |
|
|
サブスクライバーの状態
|
subscriber_state | string |
サブスクライバーの状態。 |
|
|
ページ
|
page | integer |
ページ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サブスクリプションの合計数
|
total_subscriptions | integer |
サブスクリプションの合計。 |
|
ページ
|
page | integer |
ページ。 |
|
合計ページ数
|
total_pages | integer |
合計ページ数。 |
|
サブスクリプション
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
一意識別子。 |
|
State
|
subscriptions.state | string |
都道府県。 |
|
Created At
|
subscriptions.created_at | string |
作成時に指定します。 |
|
情報源
|
subscriptions.source | string |
ソース。 |
|
参照元
|
subscriptions.referrer | string |
参照元。 |
|
サブスクライブ可能な ID
|
subscriptions.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
|
サブスクライブ可能な型
|
subscriptions.subscribable_type | string |
サブスクライブ可能な型。 |
|
ID
|
subscriptions.subscriber.id | integer |
一意識別子。 |
|
名前
|
subscriptions.subscriber.first_name | string |
名。 |
|
メール アドレス
|
subscriptions.subscriber.email_address | string |
電子メール アドレス。 |
|
State
|
subscriptions.subscriber.state | string |
都道府県。 |
|
Created At
|
subscriptions.subscriber.created_at | string |
作成時に指定します。 |
|
姓
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
シーケンスを一覧表示する
アカウントのシーケンスの一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Courses
|
courses | array of object | |
|
ID
|
courses.id | integer |
一意識別子。 |
|
名前
|
courses.name | string |
名前。 |
|
Created At
|
courses.created_at | string |
作成時に指定します。 |
タグのサブスクリプションを一覧表示する
サブスクライバー データを含むタグへのサブスクリプションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
タグ ID
|
tag_id | True | string |
タグの一意識別子。 |
|
並べ替え順序
|
sort_order | string |
並べ替え順序。 |
|
|
サブスクライバーの状態
|
subscriber_state | string |
サブスクライバーの状態。 |
|
|
ページ
|
page | integer |
ページ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サブスクリプションの合計数
|
total_subscriptions | integer |
サブスクリプションの合計。 |
|
ページ
|
page | integer |
ページ。 |
|
合計ページ数
|
total_pages | integer |
合計ページ数。 |
|
サブスクリプション
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
一意識別子。 |
|
State
|
subscriptions.state | string |
都道府県。 |
|
Created At
|
subscriptions.created_at | string |
作成時に指定します。 |
|
情報源
|
subscriptions.source | string |
ソース。 |
|
参照元
|
subscriptions.referrer | string |
参照元。 |
|
サブスクライブ可能な ID
|
subscriptions.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
|
サブスクライブ可能な型
|
subscriptions.subscribable_type | string |
サブスクライブ可能な型。 |
|
ID
|
subscriptions.subscriber.id | integer |
一意識別子。 |
|
名前
|
subscriptions.subscriber.first_name | string |
名。 |
|
メール アドレス
|
subscriptions.subscriber.email_address | string |
電子メール アドレス。 |
|
State
|
subscriptions.subscriber.state | string |
都道府県。 |
|
Created At
|
subscriptions.subscriber.created_at | string |
作成時に指定します。 |
|
姓
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
タグを一覧表示する
アカウントのタグの一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タグ
|
tags | array of object | |
|
ID
|
tags.id | integer |
一意識別子。 |
|
名前
|
tags.name | string |
名前。 |
|
Created At
|
tags.created_at | string |
作成時に指定します。 |
タグを作成する
新しいタグを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string |
名前。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アカウント ID
|
account_id | integer |
アカウントの一意識別子。 |
|
Created At
|
created_at | string |
作成時に指定します。 |
|
削除日
|
deleted_at | string |
削除日時: |
|
ID
|
id | integer |
一意識別子。 |
|
名前
|
name | string |
名前。 |
|
State
|
state | string |
都道府県。 |
|
更新日時
|
updated_at | string |
更新日時: |
フォームにサブスクライバーを追加する
フォームの 1 つにメール アドレスをサブスクライブします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォーム ID
|
form_id | True | string |
フォームの一意識別子。 |
|
Email
|
True | string |
電子メール アドレス。 |
|
|
名前
|
first_name | string |
名。 |
|
|
タグ
|
tags | array of integer |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
subscription.id | integer |
一意識別子。 |
|
State
|
subscription.state | string |
都道府県。 |
|
Created At
|
subscription.created_at | string |
作成時に指定します。 |
|
情報源
|
subscription.source | string |
ソース。 |
|
参照元
|
subscription.referrer | string |
参照元。 |
|
サブスクライブ可能な ID
|
subscription.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
|
サブスクライブ可能な型
|
subscription.subscribable_type | string |
サブスクライブ可能な型。 |
|
ID
|
subscription.subscriber.id | integer |
一意識別子。 |
|
名前
|
subscription.subscriber.first_name | string |
名。 |
|
メール アドレス
|
subscription.subscriber.email_address | string |
電子メール アドレス。 |
|
State
|
subscription.subscriber.state | string |
都道府県。 |
|
Created At
|
subscription.subscriber.created_at | string |
作成時に指定します。 |
フォームへのサブスクリプションを一覧表示する
サブスクライバー データを含むフォームへのサブスクリプションの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォーム ID
|
form_id | True | string |
フォームの一意識別子。 |
|
並べ替え順序
|
sort_order | string |
並べ替え順序。 |
|
|
サブスクライバーの状態
|
subscriber_state | string |
サブスクライバーの状態。 |
|
|
ページ
|
page | integer |
ページ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サブスクリプションの合計数
|
total_subscriptions | integer |
サブスクリプションの合計。 |
|
ページ
|
page | integer |
ページ。 |
|
合計ページ数
|
total_pages | integer |
合計ページ数。 |
|
サブスクリプション
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
一意識別子。 |
|
State
|
subscriptions.state | string |
都道府県。 |
|
Created At
|
subscriptions.created_at | string |
作成時に指定します。 |
|
情報源
|
subscriptions.source | string |
ソース。 |
|
参照元
|
subscriptions.referrer | string |
参照元。 |
|
サブスクライブ可能な ID
|
subscriptions.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
|
サブスクライブ可能な型
|
subscriptions.subscribable_type | string |
サブスクライブ可能な型。 |
|
ID
|
subscriptions.subscriber.id | integer |
一意識別子。 |
|
名前
|
subscriptions.subscriber.first_name | string |
名。 |
|
メール アドレス
|
subscriptions.subscriber.email_address | string |
電子メール アドレス。 |
|
State
|
subscriptions.subscriber.state | string |
都道府県。 |
|
Created At
|
subscriptions.subscriber.created_at | string |
作成時に指定します。 |
|
姓
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
フォームを取得する
アカウントのすべてのフォームの一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
書式
|
forms | array of object | |
|
ID
|
forms.id | integer |
一意識別子。 |
|
名前
|
forms.name | string |
名前。 |
|
Created At
|
forms.created_at | string |
作成時に指定します。 |
|
タイプ
|
forms.type | string |
型。 |
|
Format
|
forms.format | string |
形式。 |
|
URL
|
forms.url | string |
URL アドレス。 |
|
埋め込み JS
|
forms.embed_js | string |
埋め込む Javascript。 |
|
埋め込み URL
|
forms.embed_url | string |
埋め込む URL アドレス。 |
|
Title
|
forms.title | string |
タイトル。 |
|
Description
|
forms.description | string |
説明。 |
|
サインアップ ボタンのテキスト
|
forms.sign_up_button_text | string |
サインアップ ボタンのテキスト。 |
|
成功メッセージ
|
forms.success_message | string |
成功メッセージ。 |
|
Archived
|
forms.archived | boolean |
アーカイブ済みかどうか。 |
|
UID
|
forms.uid | string |
一意識別子。 |
ブロードキャストを一覧表示する
アカウントのすべてのブロードキャストの一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
放送
|
broadcasts | array of object | |
|
ID
|
broadcasts.id | integer |
一意識別子。 |
|
Created At
|
broadcasts.created_at | string |
作成時に指定します。 |
|
サブジェクト
|
broadcasts.subject | string |
件名。 |
ブロードキャストを作成する
下書きまたはスケジュールされたブロードキャストを作成します。 属性を指定せずに下書きブロードキャストを作成できます。 スケジュールされたブロードキャストには、少なくとも件名とコンテンツが含まれている必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Description
|
description | string |
説明。 |
|
|
サブジェクト
|
subject | string |
件名。 |
|
|
Content
|
content | string |
コンテンツ。 |
|
|
メール アドレス
|
email_address | string |
電子メール アドレス。 |
|
|
電子メール レイアウト テンプレート
|
email_layout_template | string |
メール レイアウト テンプレート。 |
|
|
Public
|
public | boolean |
パブリックかどうか。 |
|
|
発行日
|
published_at | string |
発行日時。 |
|
|
送信先
|
send_at | string |
送信日時。 |
|
|
サムネイル Alt
|
thumbnail_alt | string |
サムネイルの代替テキスト。 |
|
|
サムネイル URL
|
thumbnail_url | string |
サムネイルの URL アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
一意識別子。 |
|
Created At
|
broadcast.created_at | string |
作成時に指定します。 |
|
サブジェクト
|
broadcast.subject | string |
件名。 |
|
Description
|
broadcast.description | string |
説明。 |
|
Content
|
broadcast.content | string |
コンテンツ。 |
|
Public
|
broadcast.public | boolean |
パブリックかどうか。 |
|
発行日
|
broadcast.published_at | string |
発行日時。 |
|
送信先
|
broadcast.send_at | string |
送信日時。 |
|
サムネイル Alt
|
broadcast.thumbnail_alt | string |
サムネイルの代替テキスト。 |
|
サムネイル URL
|
broadcast.thumbnail_url | string |
サムネイルの URL アドレス。 |
|
メール アドレス
|
broadcast.email_address | string |
電子メール アドレス。 |
|
電子メール レイアウト テンプレート
|
broadcast.email_layout_template | string |
メール レイアウト テンプレート。 |
ブロードキャストを取得する
ドラフト、スケジュール済み、以前に送信されたブロードキャストなど、特定のブロードキャストの詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ブロードキャスト ID
|
broadcast_id | True | string |
ブロードキャストの一意識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
一意識別子。 |
|
Created At
|
broadcast.created_at | string |
作成時に指定します。 |
|
サブジェクト
|
broadcast.subject | string |
件名。 |
|
Description
|
broadcast.description | string |
説明。 |
|
Content
|
broadcast.content | string |
コンテンツ。 |
|
Public
|
broadcast.public | boolean |
パブリックかどうか。 |
|
発行日
|
broadcast.published_at | string |
発行日時。 |
|
送信先
|
broadcast.send_at | string |
送信日時。 |
|
サムネイル Alt
|
broadcast.thumbnail_alt | string |
サムネイルの代替テキスト。 |
|
サムネイル URL
|
broadcast.thumbnail_url | string |
サムネイルの URL アドレス。 |
|
メール アドレス
|
broadcast.email_address | string |
電子メール アドレス。 |
|
電子メール レイアウト テンプレート
|
broadcast.email_layout_template | string |
メール レイアウト テンプレート。 |
ブロードキャストを更新する
特定のブロードキャストの属性を更新します。 現在送信中または送信済みのブロードキャストは更新されない場合があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ブロードキャスト ID
|
broadcast_id | True | string |
ブロードキャストの一意識別子。 |
|
Description
|
description | string |
説明。 |
|
|
サブジェクト
|
subject | string |
件名。 |
|
|
Content
|
content | string |
コンテンツ。 |
|
|
メール アドレス
|
email_address | string |
電子メール アドレス。 |
|
|
電子メール レイアウト テンプレート
|
email_layout_template | string |
メール レイアウト テンプレート。 |
|
|
Public
|
public | boolean |
パブリックかどうか。 |
|
|
発行日
|
published_at | string |
発行日時。 |
|
|
送信先
|
send_at | string |
送信日時。 |
|
|
サムネイル Alt
|
thumbnail_alt | string |
サムネイルの代替テキスト。 |
|
|
サムネイル URL
|
thumbnail_url | string |
サムネイルの URL アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
一意識別子。 |
|
Created At
|
broadcast.created_at | string |
作成時に指定します。 |
|
サブジェクト
|
broadcast.subject | string |
件名。 |
|
Description
|
broadcast.description | string |
説明。 |
|
Content
|
broadcast.content | string |
コンテンツ。 |
|
Public
|
broadcast.public | boolean |
パブリックかどうか。 |
|
発行日
|
broadcast.published_at | string |
発行日時。 |
|
送信先
|
broadcast.send_at | string |
送信日時。 |
|
サムネイル Alt
|
broadcast.thumbnail_alt | string |
サムネイルの代替テキスト。 |
|
サムネイル URL
|
broadcast.thumbnail_url | string |
サムネイルの URL アドレス。 |
|
メール アドレス
|
broadcast.email_address | string |
電子メール アドレス。 |
|
電子メール レイアウト テンプレート
|
broadcast.email_layout_template | string |
メール レイアウト テンプレート。 |
ブロードキャストを破棄する
下書きまたはスケジュールされたブロードキャスト レコードを完全に削除します。 現在送信中または送信済みのブロードキャストは削除できません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ブロードキャスト ID
|
broadcast_id | True | string |
ブロードキャストの一意識別子。 |
戻り値
- response
- string
ブロードキャスト統計を取得する
特定のブロードキャストの統計情報 (受信者数、開封率、クリック率、サブスクライブ解除数、合計クリック数、状態、送信進行状況) を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ブロードキャスト ID
|
broadcast_id | True | string |
ブロードキャストの一意識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Broadcast
|
broadcast | array of object | |
|
ID
|
broadcast.id | integer |
一意識別子。 |
|
受取人
|
broadcast.stats.recipients | integer |
受信者。 |
|
オープン レート
|
broadcast.stats.open_rate | float |
オープンレート。 |
|
クリック率
|
broadcast.stats.click_rate | float |
クリック率。 |
|
購読取り消し数
|
broadcast.stats.unsubscribes | integer |
登録を解除します。 |
|
合計クリック数
|
broadcast.stats.total_clicks | integer |
クリック数の合計。 |
|
合計クリック数を表示する
|
broadcast.stats.show_total_clicks | boolean |
合計クリック数を表示するかどうかを指定します。 |
|
ステータス
|
broadcast.stats.status | string |
状態。 |
|
進捗
|
broadcast.stats.progress | integer |
進行状況。 |
メールでサブスクライバーからタグを削除する
メール アドレスでサブスクライバーからタグを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
タグ ID
|
tag_id | True | string |
タグの一意識別子。 |
|
Email
|
True | string |
電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
一意識別子。 |
|
名前
|
name | string |
名前。 |
|
Created At
|
created_at | string |
作成時に指定します。 |
購入を一覧表示する
アカウントのすべての購入の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
ページ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
合計購入数
|
total_purchases | integer |
合計購入数。 |
|
ページ
|
page | integer |
ページ。 |
|
合計ページ数
|
total_pages | integer |
合計ページ数。 |
|
購入
|
purchases | array of object | |
|
ID
|
purchases.id | integer |
一意識別子。 |
|
トランザクション ID
|
purchases.transaction_id | string |
トランザクションの一意識別子。 |
|
ステータス
|
purchases.status | string |
状態。 |
|
メール アドレス
|
purchases.email_address | string |
電子メール アドレス。 |
|
通貨
|
purchases.currency | string |
通貨。 |
|
トランザクション時間
|
purchases.transaction_time | string |
トランザクション時間。 |
|
Subtotal
|
purchases.subtotal | integer |
小計。 |
|
出荷
|
purchases.shipping | integer |
発送。 |
|
Discount
|
purchases.discount | integer |
割引。 |
|
税金
|
purchases.tax | integer |
税金。 |
|
合計
|
purchases.total | integer |
合計。 |
|
プロダクツ
|
purchases.products | array of object | |
|
単価
|
purchases.products.unit_price | integer |
単価。 |
|
数量
|
purchases.products.quantity | integer |
数量。 |
|
SKU
|
purchases.products.sku | string |
SKU。 |
|
名前
|
purchases.products.name | string |
名前。 |
購入を作成する
購入を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トランザクション ID
|
transaction_id | True | string |
トランザクションの一意識別子。 |
|
メール アドレス
|
email_address | True | string |
電子メール アドレス。 |
|
名前
|
first_name | string |
名。 |
|
|
通貨
|
currency | True | string |
通貨。 |
|
トランザクション時間
|
transaction_time | string |
トランザクション時間。 |
|
|
Subtotal
|
subtotal | integer |
小計。 |
|
|
税金
|
tax | integer |
税金。 |
|
|
出荷
|
shipping | integer |
発送。 |
|
|
Discount
|
discount | integer |
割引。 |
|
|
合計
|
total | integer |
合計。 |
|
|
ステータス
|
status | string |
状態。 |
|
|
PID
|
pid | True | integer |
個人識別子。 |
|
蓋
|
lid | True | integer |
LID。 |
|
名前
|
name | True | string |
名前。 |
|
SKU
|
sku | string |
SKU。 |
|
|
単価
|
unit_price | True | integer |
単価。 |
|
数量
|
quantity | True | integer |
数量。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
一意識別子。 |
|
トランザクション ID
|
transaction_id | string |
トランザクションの一意識別子。 |
|
ステータス
|
status | string |
状態。 |
|
メール アドレス
|
email_address | string |
電子メール アドレス。 |
|
通貨
|
currency | string |
通貨。 |
|
トランザクション時間
|
transaction_time | string |
トランザクション時間。 |
|
Subtotal
|
subtotal | integer |
小計。 |
|
Discount
|
discount | integer |
割引。 |
|
税金
|
tax | integer |
税金。 |
|
出荷
|
shipping | integer |
発送。 |
|
合計
|
total | integer |
合計。 |
|
プロダクツ
|
products | array of object | |
|
単価
|
products.unit_price | integer |
単価。 |
|
数量
|
products.quantity | integer |
数量。 |
|
SKU
|
products.sku | string |
SKU。 |
|
名前
|
products.name | string |
名前。 |
購入を取得する
ID で特定の購入を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
購入 ID
|
purchase_id | True | string |
購入識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
一意識別子。 |
|
トランザクション ID
|
transaction_id | string |
トランザクションの一意識別子。 |
|
ステータス
|
status | string |
状態。 |
|
メール アドレス
|
email_address | string |
電子メール アドレス。 |
|
通貨
|
currency | string |
通貨。 |
|
トランザクション時間
|
transaction_time | string |
トランザクション時間。 |
|
Subtotal
|
subtotal | integer |
小計。 |
|
出荷
|
shipping | integer |
発送。 |
|
Discount
|
discount | integer |
割引。 |
|
税金
|
tax | integer |
税金。 |
|
合計
|
total | integer |
合計。 |
|
プロダクツ
|
products | array of object | |
|
単価
|
products.unit_price | integer |
単価。 |
|
数量
|
products.quantity | integer |
数量。 |
|
SKU
|
products.sku | string |
SKU。 |
|
名前
|
products.name | string |
名前。 |
定義
文字列
これは基本的なデータ型 'string' です。