転送元 - SendGrid | TROCCO Docs

本ページでは、SendGridからデータを取得するための設定（転送設定）について説明します。
接続に関する設定については、接続情報 - SendGridを参照ください。

利用上の注意・制約

レート制限

SendGrid APIにはエンドポイントごとにレート制限があります。

制限値はレスポンスヘッダー（X-RateLimit-Limit・X-RateLimit-Remaining・X-RateLimit-Reset）で確認できます。
制限を超えるとHTTP 429が返却され、TROCCOは X-RateLimit-Reset ヘッダーに示されたリセット時刻まで待機したうえでリクエストを再試行します。ただし、再試行回数が上限を超えた場合はエラーで終了します。

詳しくは、SendGrid APIのレート制限を参照ください。

SendGridのオプション契約が必要な取得対象

以下の取得対象は、SendGrid側で有償オプション「Additional Email Activity History」の購入が必要です。

メッセージ一覧
メッセージ詳細

取得対象

アラート一覧

SendGridに設定されているアラートの一覧を取得します。

設定項目

このエンドポイントの取得にはパラメータが必要ありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`long`	アラートID
`type`	`string`	アラートタイプ
`percentage`	`long`	使用量のしきい値（%）
`email_to`	`string`	通知先メールアドレス
`created_at`	`long`	作成日時（Unixタイムスタンプ）
`updated_at`	`long`	更新日時（Unixタイムスタンプ）

キャンペーン一覧

SendGridに作成されているマーケティングキャンペーンの一覧を取得します。

設定項目

項目名	必須	デフォルト値	説明
Limit	-	10	取得件数の上限を指定します。
Offset	-	10	取得開始位置のオフセットを指定します。

キャンペーンの全件取得について

キャンペーン一覧で指定できるLimitとOffsetは、ページネーションによる全件取得には対応していません。
取得を開始する位置をOffsetで指定し、開始位置からの取得件数をLimitで指定する絞り込みのみ可能です。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`long`	キャンペーンID
`title`	`string`	キャンペーンタイトル
`ip_pool`	`string`	使用するIPプール名
`categories`	`json`	カテゴリ一覧
`plain_content`	`string`	プレーンテキストのメール本文
`html_content`	`string`	HTMLのメール本文
`subject`	`string`	メール件名
`sender_id`	`long`	送信者ID
`list_ids`	`json`	送信対象リストIDの一覧
`segment_ids`	`json`	送信対象セグメントIDの一覧
`suppression_group_id`	`long`	配信停止グループID
`custom_unsubscribe_url`	`string`	カスタム配信停止URL
`status`	`string`	キャンペーンのステータス
`editor`	`string`	使用したエディタの種類

リスト一覧

SendGridに作成されている連絡先リストの一覧を取得します。

設定項目

このエンドポイントの取得にはパラメータが必要ありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`long`	リストID
`name`	`string`	リスト名
`recipient_count`	`long`	リストに含まれる宛先の数

リスト内宛先一覧

指定したリストに含まれる宛先の一覧を取得します。

設定項目

項目名	必須	デフォルト値	説明
リストID	✓	-	取得対象とするリストのIDを指定します。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	宛先ID
`email`	`string`	メールアドレス
`created_at`	`long`	作成日時（Unixタイムスタンプ）
`updated_at`	`long`	更新日時（Unixタイムスタンプ）
`last_emailed`	`long`	最後にメールを送信した日時（Unixタイムスタンプ）
`last_clicked`	`long`	最後にクリックした日時（Unixタイムスタンプ）
`last_opened`	`long`	最後に開封した日時（Unixタイムスタンプ）
`first_name`	`string`	名
`last_name`	`string`	姓
`custom_fields`	`json`	カスタムフィールド

宛先一覧

SendGridに登録されているすべての宛先の一覧を取得します。

設定項目

このエンドポイントの取得にはパラメータが必要ありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	宛先ID
`email`	`string`	メールアドレス
`created_at`	`long`	作成日時（Unixタイムスタンプ）
`updated_at`	`long`	更新日時（Unixタイムスタンプ）
`last_emailed`	`long`	最後にメールを送信した日時（Unixタイムスタンプ）
`last_clicked`	`long`	最後にクリックした日時（Unixタイムスタンプ）
`last_opened`	`long`	最後に開封した日時（Unixタイムスタンプ）
`first_name`	`string`	名
`last_name`	`string`	姓
`custom_fields`	`json`	カスタムフィールド

セグメント一覧

SendGridに作成されているセグメントの一覧を取得します。

設定項目

項目名	必須	デフォルト値	説明
Excluded	-	-	指定すると、各セグメントの宛先数を最新の値に更新せず取得します。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`long`	セグメントID
`name`	`string`	セグメント名
`conditions`	`json`	セグメントの条件
`recipient_count`	`long`	セグメントに含まれる宛先の数

セグメント内宛先一覧

指定したセグメントに含まれる宛先の一覧を取得します。

設定項目

項目名	必須	デフォルト値	説明
セグメントID	✓	-	取得対象とするセグメントのIDを指定します。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	宛先ID
`email`	`string`	メールアドレス
`created_at`	`long`	作成日時（Unixタイムスタンプ）
`updated_at`	`long`	更新日時（Unixタイムスタンプ）
`last_emailed`	`long`	最後にメールを送信した日時（Unixタイムスタンプ）
`last_clicked`	`long`	最後にクリックした日時（Unixタイムスタンプ）
`last_opened`	`long`	最後に開封した日時（Unixタイムスタンプ）
`first_name`	`string`	名
`last_name`	`string`	姓
`custom_fields`	`json`	カスタムフィールド

メッセージ一覧

SendGridで送受信されたメールメッセージの一覧を取得します（最大1,000件）。

設定項目

このエンドポイントの取得にはパラメータが必要ありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`from_email`	`string`	送信元メールアドレス
`msg_id`	`string`	メッセージID
`subject`	`string`	メール件名
`to_email`	`string`	宛先メールアドレス
`status`	`string`	メッセージのステータス
`opens_count`	`long`	開封回数
`clicks_count`	`long`	クリック回数
`last_event_time`	`timestamp`	最後のイベント発生日時

メッセージ詳細

指定したメッセージIDのメールメッセージの詳細情報を取得します。

設定項目

項目名	必須	デフォルト値	説明
メッセージID	✓	-	取得対象とするメッセージのIDを指定します。

取得データ

カラム名	デフォルトのデータ型	補足事項
`from_email`	`string`	送信元メールアドレス
`msg_id`	`string`	メッセージID
`subject`	`string`	メール件名
`to_email`	`string`	宛先メールアドレス
`status`	`string`	メッセージのステータス
`template_id`	`string`	使用したテンプレートID
`asm_group_id`	`long`	配信停止グループID
`teammate`	`string`	担当チームメート
`api_key_id`	`string`	使用したAPIキーID
`events`	`json`	メッセージに関連するイベントの一覧
`originating_ip`	`string`	送信元IPアドレス
`categories`	`json`	カテゴリ一覧
`unique_args`	`json`	カスタム引数
`outbound_ip`	`string`	送信に使用したIPアドレス
`outbound_ip_type`	`string`	送信IPのタイプ
`marketing_campaign_id`	`long`	マーケティングキャンペーンID
`marketing_campaign_name`	`string`	マーケティングキャンペーン名
`marketing_campaign_split_id`	`string`	マーケティングキャンペーン分割ID
`marketing_campaign_version`	`string`	マーケティングキャンペーンのバージョン

送信者情報一覧

SendGridに登録されている送信者情報（Sender Identity）の一覧を取得します。

設定項目

このエンドポイントの取得にはパラメータが必要ありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`long`	送信者ID
`nickname`	`string`	ニックネーム
`from`	`json`	送信元情報（メールアドレス・名前）
`reply_to`	`json`	返信先情報（メールアドレス・名前）
`address`	`string`	住所
`address_2`	`string`	住所（補足）
`city`	`string`	市区町村
`state`	`string`	都道府県・州
`zip`	`string`	郵便番号
`country`	`string`	国
`verified`	`json`	認証状態
`updated_at`	`long`	更新日時（Unixタイムスタンプ）
`created_at`	`long`	作成日時（Unixタイムスタンプ）
`locked`	`boolean`	ロック状態

送信統計情報一覧

SendGridの送信統計情報の一覧を取得します。

設定項目

項目名	必須	デフォルト値	説明
開始日	✓	-	統計情報の取得開始日を `YYYY-MM-DD` 形式で指定します。
終了日	-	-	統計情報の取得終了日を `YYYY-MM-DD` 形式で指定します。

取得データ

カラム名	デフォルトのデータ型	補足事項
`date`	`string`	集計日
`stats`	`json`	統計情報（送信数・開封数・クリック数等）

配信停止中宛先一覧

SendGridで配信停止中のすべての宛先の一覧を取得します。

設定項目

このエンドポイントの取得にはパラメータが必要ありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`email`	`string`	配信停止中のメールアドレス
`group_id`	`long`	配信停止グループID
`group_name`	`string`	配信停止グループ名
`created_at`	`long`	配信停止日時（Unixタイムスタンプ）

配信停止グループ一覧

SendGridに作成されている配信停止グループの一覧を取得します。

設定項目

このエンドポイントの取得にはパラメータが必要ありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`name`	`string`	グループ名
`id`	`long`	グループID
`description`	`string`	グループの説明
`is_default`	`boolean`	デフォルトグループかどうか
`unsubscribes`	`long`	配信停止中の宛先数