ConvertKit (独立系発行元)
ConvertKit は、クリエイターにとって頼りになるマーケティング ハブであり、対象ユーザーの増加と収益化を容易にします。 美しいランディング ページとオプトイン テンプレートを使用して、ソーシャル メディア、YouTube などのフォロワーをメール リストに変換します。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor、Hitachi Solutions |
Web サイト | https://convertkit.com/ |
プライバシー ポリシー | https://convertkit.com/privacy |
カテゴリー | マーケティング |
コネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
名前 | タイプ | 説明 | 必須 |
---|---|---|---|
API シークレット | securestring | このプリの API シークレット | True |
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アカウントを取得する |
現在のアカウントを取得します。 |
サブスクライバーからタグを削除する |
サブスクライバーからタグを削除します。 |
サブスクライバーのタグを一覧表示する |
サブスクライバーのすべてのタグの一覧を取得します。 |
サブスクライバーの一覧を表示する |
サブスクライバーの一覧を返します。 登録解除の場合のみ、並べ替えフィールド パラメーターに cancelled at 値を使用します (現在サポートされている唯一の追加の並べ替えフィールド)。 |
サブスクライバーをタグ付けする |
タグはサブスクリプションとして処理されます。 メール アドレスをタグに登録すると、そのタグをそのメール アドレスを持つサブスクライバーに適用します。 |
サブスクライバーを取得する |
1 つのサブスクライバー レコードを取得します。 |
サブスクライバーを更新する |
単一のサブスクライバーの情報を更新します。 |
サブスクライバーを登録解除する |
すべてのフォームとシーケンスからサブスクライバーの登録を解除します。 |
シーケンスにサブスクライバーを追加する |
いずれかのシーケンスにメール アドレスを登録します。 |
シーケンスの一覧を表示する |
アカウントのシーケンスの一覧を取得します。 |
シーケンスへのサブスクリプションを一覧表示する |
サブスクライバー データを含むシーケンスへのサブスクリプションの一覧を取得します。 |
タグへのサブスクリプションを一覧表示する |
サブスクライバー データを含むタグへのサブスクリプションの一覧を取得します。 |
タグを一覧表示する |
アカウントのタグの一覧を取得します。 |
タグを作成する |
タグを新規作成します。 |
フォームにサブスクライバーを追加する |
いずれかのフォームにメール アドレスを登録します。 |
フォームのサブスクリプションを一覧表示する |
サブスクライバー データを含むフォームへのサブスクリプションの一覧を取得します。 |
フォームを取得する |
アカウントのすべてのフォームのリストを取得します。 |
メールでサブスクライバーからタグを削除する |
メール アドレスでサブスクライバーからタグを削除します。 |
購入の一覧を表示する |
アカウントのすべての購入の一覧を取得します。 |
購入を作成する |
購入を作成します。 |
購入を取得する |
ID で特定の購入を取得します。 |
配信の一覧を表示する |
アカウントのすべての配信のリストを取得します。 |
配信を作成する |
ドラフトまたはスケジュール化された配信を作成します。 属性なしでドラフト配信を作成できます。 スケジュール化された配信には、少なくとも件名行とコンテンツが含まれている必要があります。 |
配信を取得する |
ドラフト、スケジュール済み、以前に送信された配信を含む、特定の配信の詳細を取得します。 |
配信を更新する |
特定の配信の属性を更新します。 現在送信中または送信済みの配信は更新されない場合があります。 |
配信を破棄する |
ドラフトまたはスケジュール化された配信レコードを完全に削除します。 現在送信中または送信済みの配信は削除できません。 |
配信統計を取得する |
特定の配信の統計 (受信者数、開封率、クリック率、登録解除数、合計クリック数、状態、送信の進行状況) を取得します。 |
現在のアカウントを取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Name
|
name | string |
名前。 |
Plan Type
|
plan_type | string |
プランの種類。 |
Primary Email Address
|
primary_email_address | string |
メインのメール アドレス。 |
サブスクライバーからタグを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
Tag ID
|
tag_id | True | string |
タグの一意識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | integer |
一意識別子。 |
Name
|
name | string |
名前。 |
Created At
|
created_at | string |
作成日時。 |
サブスクライバーのすべてのタグの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Tags
|
tags | array of object | |
ID
|
tags.id | integer |
一意識別子。 |
Name
|
tags.name | string |
名前。 |
Created At
|
tags.created_at | string |
作成日時。 |
サブスクライバーの一覧を返します。 登録解除の場合のみ、並べ替えフィールド パラメーターに cancelled at 値を使用します (現在サポートされている唯一の追加の並べ替えフィールド)。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
From
|
from | string |
差出人。 |
|
To
|
to | string |
宛先。 |
|
Updated From
|
updated_from | string |
から更新された場合。 |
|
Updated To
|
updated_to | string |
に更新された場合。 |
|
Sort Order
|
sort_order | string |
並べ替え順。 |
|
Sort Field
|
sort_field | string |
並べ替えフィールド。 |
|
Email Address
|
email_address | string |
メール アドレス。 |
|
Page
|
page | integer |
ページ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Total Subscribers
|
total_subscribers | integer |
サブスクライバーの合計数。 |
Page
|
page | integer |
ページ。 |
Total Pages
|
total_pages | integer |
合計ページ数。 |
Subscribers
|
subscribers | array of object | |
ID
|
subscribers.id | integer |
一意識別子。 |
First Name
|
subscribers.first_name | string |
名。 |
Email Address
|
subscribers.email_address | string |
メール アドレス。 |
State
|
subscribers.state | string |
状態。 |
Created At
|
subscribers.created_at | string |
作成日時。 |
Last Name
|
subscribers.fields.last_name | string |
姓。 |
タグはサブスクリプションとして処理されます。 メール アドレスをタグに登録すると、そのタグをそのメール アドレスを持つサブスクライバーに適用します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Tag ID
|
tag_id | True | string |
タグの一意識別子。 |
メール
|
string |
メール アドレス。 |
||
First Name
|
first_name | string |
名。 |
|
Tags
|
tags | array of integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
subscription.id | integer |
一意識別子。 |
状態
|
subscription.state | string |
都道府県。 |
作成日
|
subscription.created_at | string |
作成日時。 |
Source
|
subscription.source | string |
ソース。 |
Referrer
|
subscription.referrer | string |
参照元。 |
Subscribable ID
|
subscription.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
Subscribable Type
|
subscription.subscribable_type | string |
サブスクライブ可能な種類。 |
ID
|
subscription.subscriber.id | integer |
一意識別子。 |
1 つのサブスクライバー レコードを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
subscriber.id | integer |
一意識別子。 |
First Name
|
subscriber.first_name | string |
名。 |
Email Address
|
subscriber.email_address | string |
メール アドレス。 |
State
|
subscriber.state | string |
状態。 |
Created At
|
subscriber.created_at | string |
作成日時。 |
Last Name
|
subscriber.fields.last_name | string |
姓。 |
単一のサブスクライバーの情報を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
サブスクライバーの一意識別子。 |
First Name
|
first_name | string |
名。 |
|
Email Address
|
email_address | string |
メール アドレス。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
subscriber.id | integer |
一意識別子。 |
First Name
|
subscriber.first_name | string |
名。 |
Email Address
|
subscriber.email_address | string |
メール アドレス。 |
State
|
subscriber.state | string |
状態。 |
Created At
|
subscriber.created_at | string |
作成日時。 |
すべてのフォームとシーケンスからサブスクライバーの登録を解除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Email
|
True | string |
メール アドレス。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
subscriber.id | integer |
一意識別子。 |
First Name
|
subscriber.first_name | string |
名。 |
Email Address
|
subscriber.email_address | string |
メール アドレス。 |
State
|
subscriber.state | string |
状態。 |
Created At
|
subscriber.created_at | string |
作成日時。 |
Last Name
|
subscriber.fields.last_name | string |
姓。 |
いずれかのシーケンスにメール アドレスを登録します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Sequence ID
|
sequence_id | True | string |
シーケンスの一意識別子。 |
メール
|
True | string |
メール アドレス。 |
|
First Name
|
first_name | string |
名。 |
|
Tags
|
tags | array of integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
subscription.id | integer |
一意識別子。 |
状態
|
subscription.state | string |
都道府県。 |
作成日
|
subscription.created_at | string |
作成日時。 |
Source
|
subscription.source | string |
ソース。 |
Referrer
|
subscription.referrer | string |
参照元。 |
Subscribable ID
|
subscription.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
Subscribable Type
|
subscription.subscribable_type | string |
サブスクライブ可能な種類。 |
ID
|
subscription.subscriber.id | integer |
一意識別子。 |
アカウントのシーケンスの一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Courses
|
courses | array of object | |
ID
|
courses.id | integer |
一意識別子。 |
Name
|
courses.name | string |
名前。 |
Created At
|
courses.created_at | string |
作成日時。 |
サブスクライバー データを含むシーケンスへのサブスクリプションの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Sequence ID
|
sequence_id | True | string |
シーケンスの一意識別子。 |
Sort Order
|
sort_order | string |
並べ替え順。 |
|
Subscriber State
|
subscriber_state | string |
サブスクライバーの状態。 |
|
Page
|
page | integer |
ページ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Total Subscriptions
|
total_subscriptions | integer |
サブスクリプションの合計数。 |
Page
|
page | integer |
ページ。 |
Total Pages
|
total_pages | integer |
合計ページ数。 |
Subscriptions
|
subscriptions | array of object | |
ID
|
subscriptions.id | integer |
一意識別子。 |
State
|
subscriptions.state | string |
状態。 |
Created At
|
subscriptions.created_at | string |
作成日時。 |
Source
|
subscriptions.source | string |
ソース。 |
Referrer
|
subscriptions.referrer | string |
参照元。 |
Subscribable ID
|
subscriptions.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
Subscribable Type
|
subscriptions.subscribable_type | string |
サブスクライブ可能な種類。 |
ID
|
subscriptions.subscriber.id | integer |
一意識別子。 |
First Name
|
subscriptions.subscriber.first_name | string |
名。 |
Email Address
|
subscriptions.subscriber.email_address | string |
メール アドレス。 |
State
|
subscriptions.subscriber.state | string |
状態。 |
Created At
|
subscriptions.subscriber.created_at | string |
作成日時。 |
Last Name
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
サブスクライバー データを含むタグへのサブスクリプションの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Tag ID
|
tag_id | True | string |
タグの一意識別子。 |
Sort Order
|
sort_order | string |
並べ替え順。 |
|
Subscriber State
|
subscriber_state | string |
サブスクライバーの状態。 |
|
Page
|
page | integer |
ページ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Total Subscriptions
|
total_subscriptions | integer |
サブスクリプションの合計数。 |
Page
|
page | integer |
ページ。 |
Total Pages
|
total_pages | integer |
合計ページ数。 |
Subscriptions
|
subscriptions | array of object | |
ID
|
subscriptions.id | integer |
一意識別子。 |
State
|
subscriptions.state | string |
状態。 |
Created At
|
subscriptions.created_at | string |
作成日時。 |
Source
|
subscriptions.source | string |
ソース。 |
Referrer
|
subscriptions.referrer | string |
参照元。 |
Subscribable ID
|
subscriptions.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
Subscribable Type
|
subscriptions.subscribable_type | string |
サブスクライブ可能な種類。 |
ID
|
subscriptions.subscriber.id | integer |
一意識別子。 |
First Name
|
subscriptions.subscriber.first_name | string |
名。 |
Email Address
|
subscriptions.subscriber.email_address | string |
メール アドレス。 |
State
|
subscriptions.subscriber.state | string |
状態。 |
Created At
|
subscriptions.subscriber.created_at | string |
作成日時。 |
Last Name
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
アカウントのタグの一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Tags
|
tags | array of object | |
ID
|
tags.id | integer |
一意識別子。 |
Name
|
tags.name | string |
名前。 |
Created At
|
tags.created_at | string |
作成日時。 |
タグを新規作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Name
|
name | True | string |
名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Account ID
|
account_id | integer |
アカウントの一意識別子。 |
Created At
|
created_at | string |
作成日時。 |
Deleted At
|
deleted_at | string |
削除日時。 |
ID
|
id | integer |
一意識別子。 |
Name
|
name | string |
名前。 |
State
|
state | string |
状態。 |
Updated At
|
updated_at | string |
更新時刻。 |
いずれかのフォームにメール アドレスを登録します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Form ID
|
form_id | True | string |
フォームの一意識別子。 |
メール
|
True | string |
メール アドレス。 |
|
First Name
|
first_name | string |
名。 |
|
Tags
|
tags | array of integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
subscription.id | integer |
一意識別子。 |
状態
|
subscription.state | string |
都道府県。 |
作成日
|
subscription.created_at | string |
作成日時。 |
Source
|
subscription.source | string |
ソース。 |
Referrer
|
subscription.referrer | string |
参照元。 |
Subscribable ID
|
subscription.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
Subscribable Type
|
subscription.subscribable_type | string |
サブスクライブ可能な種類。 |
ID
|
subscription.subscriber.id | integer |
一意識別子。 |
First Name
|
subscription.subscriber.first_name | string |
名。 |
Email Address
|
subscription.subscriber.email_address | string |
メール アドレス。 |
State
|
subscription.subscriber.state | string |
状態。 |
Created At
|
subscription.subscriber.created_at | string |
作成日時。 |
サブスクライバー データを含むフォームへのサブスクリプションの一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Form ID
|
form_id | True | string |
フォームの一意識別子。 |
Sort Order
|
sort_order | string |
並べ替え順。 |
|
Subscriber State
|
subscriber_state | string |
サブスクライバーの状態。 |
|
Page
|
page | integer |
ページ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Total Subscriptions
|
total_subscriptions | integer |
サブスクリプションの合計数。 |
Page
|
page | integer |
ページ。 |
Total Pages
|
total_pages | integer |
合計ページ数。 |
Subscriptions
|
subscriptions | array of object | |
ID
|
subscriptions.id | integer |
一意識別子。 |
State
|
subscriptions.state | string |
状態。 |
Created At
|
subscriptions.created_at | string |
作成日時。 |
Source
|
subscriptions.source | string |
ソース。 |
Referrer
|
subscriptions.referrer | string |
参照元。 |
Subscribable ID
|
subscriptions.subscribable_id | integer |
サブスクライブ可能な一意識別子。 |
Subscribable Type
|
subscriptions.subscribable_type | string |
サブスクライブ可能な種類。 |
ID
|
subscriptions.subscriber.id | integer |
一意識別子。 |
First Name
|
subscriptions.subscriber.first_name | string |
名。 |
Email Address
|
subscriptions.subscriber.email_address | string |
メール アドレス。 |
State
|
subscriptions.subscriber.state | string |
状態。 |
Created At
|
subscriptions.subscriber.created_at | string |
作成日時。 |
Last Name
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
アカウントのすべてのフォームのリストを取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Forms
|
forms | array of object | |
ID
|
forms.id | integer |
一意識別子。 |
Name
|
forms.name | string |
名前。 |
Created At
|
forms.created_at | string |
作成日時。 |
Type
|
forms.type | string |
種類。 |
Format
|
forms.format | string |
形式。 |
URL
|
forms.url | string |
URL アドレス。 |
Embed JS
|
forms.embed_js | string |
埋め込む Javascript。 |
Embed URL
|
forms.embed_url | string |
埋め込む URL アドレス。 |
Title
|
forms.title | string |
肩書き。 |
Description
|
forms.description | string |
説明。 |
Sign Up Button Text
|
forms.sign_up_button_text | string |
サインアップ ボタンのテキスト。 |
Success Message
|
forms.success_message | string |
成功メッセージ。 |
Archived
|
forms.archived | boolean |
アーカイブ済みかどうか。 |
UID
|
forms.uid | string |
一意識別子。 |
メール アドレスでサブスクライバーからタグを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Tag ID
|
tag_id | True | string |
タグの一意識別子。 |
Email
|
True | string |
メール アドレス。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | integer |
一意識別子。 |
Name
|
name | string |
名前。 |
Created At
|
created_at | string |
作成日時。 |
アカウントのすべての購入の一覧を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Page
|
page | integer |
ページ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Total Purchases
|
total_purchases | integer |
購入の合計。 |
Page
|
page | integer |
ページ。 |
Total Pages
|
total_pages | integer |
合計ページ数。 |
Purchases
|
purchases | array of object | |
ID
|
purchases.id | integer |
一意識別子。 |
Transaction ID
|
purchases.transaction_id | string |
トランザクションの一意識別子。 |
Status
|
purchases.status | string |
状態。 |
Email Address
|
purchases.email_address | string |
メール アドレス。 |
Currency
|
purchases.currency | string |
通貨。 |
Transaction Time
|
purchases.transaction_time | string |
トランザクションの時刻。 |
Subtotal
|
purchases.subtotal | integer |
小計。 |
Shipping
|
purchases.shipping | integer |
発送。 |
Discount
|
purchases.discount | integer |
割引。 |
Tax
|
purchases.tax | integer |
税。 |
Total
|
purchases.total | integer |
合計。 |
Products
|
purchases.products | array of object | |
Unit Price
|
purchases.products.unit_price | integer |
単価。 |
Quantity
|
purchases.products.quantity | integer |
数量。 |
SKU
|
purchases.products.sku | string |
SKU。 |
Name
|
purchases.products.name | string |
名前。 |
購入を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Transaction ID
|
transaction_id | True | string |
トランザクションの一意識別子。 |
Email Address
|
email_address | True | string |
メール アドレス。 |
First Name
|
first_name | string |
名。 |
|
Currency
|
currency | True | string |
通貨。 |
Transaction Time
|
transaction_time | string |
トランザクションの時刻。 |
|
Subtotal
|
subtotal | integer |
小計。 |
|
Tax
|
tax | integer |
税。 |
|
Shipping
|
shipping | integer |
発送。 |
|
Discount
|
discount | integer |
割引。 |
|
Total
|
total | integer |
合計。 |
|
Status
|
status | string |
状態。 |
|
PID
|
pid | True | integer |
個人識別子。 |
LID
|
lid | True | integer |
LID。 |
Name
|
name | True | string |
名前。 |
SKU
|
sku | string |
SKU。 |
|
Unit Price
|
unit_price | True | integer |
単価。 |
Quantity
|
quantity | True | integer |
数量。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | integer |
一意識別子。 |
Transaction ID
|
transaction_id | string |
トランザクションの一意識別子。 |
Status
|
status | string |
状態。 |
Email Address
|
email_address | string |
メール アドレス。 |
Currency
|
currency | string |
通貨。 |
Transaction Time
|
transaction_time | string |
トランザクションの時刻。 |
Subtotal
|
subtotal | integer |
小計。 |
Discount
|
discount | integer |
割引。 |
Tax
|
tax | integer |
税。 |
Shipping
|
shipping | integer |
発送。 |
Total
|
total | integer |
合計。 |
Products
|
products | array of object | |
Unit Price
|
products.unit_price | integer |
単価。 |
Quantity
|
products.quantity | integer |
数量。 |
SKU
|
products.sku | string |
SKU。 |
Name
|
products.name | string |
名前。 |
ID で特定の購入を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Purchase ID
|
purchase_id | True | string |
購入の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | integer |
一意識別子。 |
Transaction ID
|
transaction_id | string |
トランザクションの一意識別子。 |
Status
|
status | string |
状態。 |
Email Address
|
email_address | string |
メール アドレス。 |
Currency
|
currency | string |
通貨。 |
Transaction Time
|
transaction_time | string |
トランザクションの時刻。 |
Subtotal
|
subtotal | integer |
小計。 |
Shipping
|
shipping | integer |
発送。 |
Discount
|
discount | integer |
割引。 |
Tax
|
tax | integer |
税。 |
Total
|
total | integer |
合計。 |
Products
|
products | array of object | |
Unit Price
|
products.unit_price | integer |
単価。 |
Quantity
|
products.quantity | integer |
数量。 |
SKU
|
products.sku | string |
SKU。 |
Name
|
products.name | string |
名前。 |
アカウントのすべての配信のリストを取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Broadcasts
|
broadcasts | array of object | |
ID
|
broadcasts.id | integer |
一意識別子。 |
Created At
|
broadcasts.created_at | string |
作成日時。 |
Subject
|
broadcasts.subject | string |
件名。 |
ドラフトまたはスケジュール化された配信を作成します。 属性なしでドラフト配信を作成できます。 スケジュール化された配信には、少なくとも件名行とコンテンツが含まれている必要があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Description
|
description | string |
説明。 |
|
Subject
|
subject | string |
件名。 |
|
Content
|
content | string |
コンテンツ。 |
|
Email Address
|
email_address | string |
メール アドレス。 |
|
Email Layout Template
|
email_layout_template | string |
メール レイアウト テンプレート。 |
|
Public
|
public | boolean |
公開かどうか。 |
|
Published At
|
published_at | string |
公開日時。 |
|
Send At
|
send_at | string |
送信日時。 |
|
Thumbnail Alt
|
thumbnail_alt | string |
サムネイルの代替テキスト。 |
|
Thumbnail URL
|
thumbnail_url | string |
サムネイルの URL アドレス。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
broadcast.id | integer |
一意識別子。 |
Created At
|
broadcast.created_at | string |
作成日時。 |
Subject
|
broadcast.subject | string |
件名。 |
Description
|
broadcast.description | string |
説明。 |
Content
|
broadcast.content | string |
コンテンツ。 |
Public
|
broadcast.public | boolean |
公開かどうか。 |
Published At
|
broadcast.published_at | string |
公開日時。 |
Send At
|
broadcast.send_at | string |
送信日時。 |
Thumbnail Alt
|
broadcast.thumbnail_alt | string |
サムネイルの代替テキスト。 |
Thumbnail URL
|
broadcast.thumbnail_url | string |
サムネイルの URL アドレス。 |
Email Address
|
broadcast.email_address | string |
メール アドレス。 |
Email Layout Template
|
broadcast.email_layout_template | string |
メール レイアウト テンプレート。 |
ドラフト、スケジュール済み、以前に送信された配信を含む、特定の配信の詳細を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
配信の一意識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
broadcast.id | integer |
一意識別子。 |
Created At
|
broadcast.created_at | string |
作成日時。 |
Subject
|
broadcast.subject | string |
件名。 |
Description
|
broadcast.description | string |
説明。 |
Content
|
broadcast.content | string |
コンテンツ。 |
Public
|
broadcast.public | boolean |
公開かどうか。 |
Published At
|
broadcast.published_at | string |
公開日時。 |
Send At
|
broadcast.send_at | string |
送信日時。 |
Thumbnail Alt
|
broadcast.thumbnail_alt | string |
サムネイルの代替テキスト。 |
Thumbnail URL
|
broadcast.thumbnail_url | string |
サムネイルの URL アドレス。 |
Email Address
|
broadcast.email_address | string |
メール アドレス。 |
Email Layout Template
|
broadcast.email_layout_template | string |
メール レイアウト テンプレート。 |
特定の配信の属性を更新します。 現在送信中または送信済みの配信は更新されない場合があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
配信の一意識別子。 |
Description
|
description | string |
説明。 |
|
Subject
|
subject | string |
件名。 |
|
Content
|
content | string |
コンテンツ。 |
|
Email Address
|
email_address | string |
メール アドレス。 |
|
Email Layout Template
|
email_layout_template | string |
メール レイアウト テンプレート。 |
|
Public
|
public | boolean |
公開かどうか。 |
|
Published At
|
published_at | string |
公開日時。 |
|
Send At
|
send_at | string |
送信日時。 |
|
Thumbnail Alt
|
thumbnail_alt | string |
サムネイルの代替テキスト。 |
|
Thumbnail URL
|
thumbnail_url | string |
サムネイルの URL アドレス。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
broadcast.id | integer |
一意識別子。 |
Created At
|
broadcast.created_at | string |
作成日時。 |
Subject
|
broadcast.subject | string |
件名。 |
Description
|
broadcast.description | string |
説明。 |
Content
|
broadcast.content | string |
コンテンツ。 |
Public
|
broadcast.public | boolean |
公開かどうか。 |
Published At
|
broadcast.published_at | string |
公開日時。 |
Send At
|
broadcast.send_at | string |
送信日時。 |
Thumbnail Alt
|
broadcast.thumbnail_alt | string |
サムネイルの代替テキスト。 |
Thumbnail URL
|
broadcast.thumbnail_url | string |
サムネイルの URL アドレス。 |
Email Address
|
broadcast.email_address | string |
メール アドレス。 |
Email Layout Template
|
broadcast.email_layout_template | string |
メール レイアウト テンプレート。 |
ドラフトまたはスケジュール化された配信レコードを完全に削除します。 現在送信中または送信済みの配信は削除できません。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
配信の一意識別子。 |
戻り値
- response
- string
特定の配信の統計 (受信者数、開封率、クリック率、登録解除数、合計クリック数、状態、送信の進行状況) を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
配信の一意識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Broadcast
|
broadcast | array of object | |
ID
|
broadcast.id | integer |
一意識別子。 |
Recipients
|
broadcast.stats.recipients | integer |
受信者。 |
Open Rate
|
broadcast.stats.open_rate | float |
開封率。 |
Click Rate
|
broadcast.stats.click_rate | float |
クリック率。 |
Unsubscribes
|
broadcast.stats.unsubscribes | integer |
登録解除。 |
Total Clicks
|
broadcast.stats.total_clicks | integer |
合計クリック数。 |
Show Total Clicks
|
broadcast.stats.show_total_clicks | boolean |
合計クリック数を表示するかどうか。 |
Status
|
broadcast.stats.status | string |
状態。 |
Progress
|
broadcast.stats.progress | integer |
進捗状況。 |
これは基本的なデータ型 '文字列' です。