接続の確立

SendGrid への接続を追加

SendGrid への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
SendGrid アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSendGrid コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

SendGrid Sync App 経由で認証するには、API キーを使用する必要があります。

API キーの取得

API キーを取得するには以下の手順に従ってください。

SendGrid にログインします。
［Settings］をクリックします。
［API keys］をクリックします。
［Create API Key］をクリックします。
API キーの権限を選択します。Full Access またはRestricted Access のいずれかです。その後、API キーが表示されます。

NOTE： E メールイベントにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。

高度な機能

このセクションでは、SendGrid Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、SendGrid にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

Sync App は、SendGrid API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。大抵のテーブル、ビュー、およびストアドプロシージャは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。

しかし、Recipients テーブルは動的です。Sync App は、SendGrid に接続し、適切なWeb サービスを呼び出してこのテーブルのメタデータを取得します。Recipients テーブルに定義したカスタムフィルタに加えた変更はすべて接続時に利用可能です。これらのカスタムフィルタはWHERE 句内でカラムとして使用できます。これらのカスタムフィルタはCustomFields テーブル内に表示されます。

このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

新しいMarketing Campaigns データモデル

新しいMarketing Campaigns API で利用可能なエンティティについては、新しいMarketing Campaigns データモデルを参照してください。

レガシーデータモデル

Legacy API で利用可能なエンティティについては、レガシーデータモデルを参照してください。

新しいMarketing Campaigns データモデル

CData Sync App は、新しいMarketing Campaigns API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。ほとんどのテーブル、ビュー、ストアドプロシージャは、スキーマファイルに定義されています。テキストベースのシンプルな設定ファイルです。このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

新しいMarketing Campaigns データモデルを使用するには、Schema をNMC に設定します。

テーブル

テーブルは、簡単にクエリや更新ができる利用可能なテーブルについて説明します。

ビュー

ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャは、Sendgrid のファンクションライクなインターフェースです。これらを使用して、情報を検索、更新、および変更できます。

テーブル

Sync App はSendGrid のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

SendGrid Connector for CData Sync テーブル


Name	Description
Alerts	Create, update, delete, and query Alerts in SendGrid.
ApiKeys	Query, Create, Update and Delete the available ApiKeys in SendGrid.
Blocks	Query and Delete the available Blocks in SendGrid.
Bounces	Query and Delete the available Bounces in SendGrid.
CancelScheduledSends	Update, delete, and query Cancel Scheduled Sends in SendGrid.
GlobalUnsubscribes	Query Global Unsubscribes in SendGrid.
InvalidEmails	Query and Delete invalid emails in SendGrid.
NMCCustomFields	Create, delete, and query New Marketing Campaign Custom Fields in SendGrid.
NMCLists	Create, update, delete, and query the available New Marketing Campaign Lists in SendGrid.
NMCSegments	Create, update, delete, and query New Marketing Campaign Segments in SendGrid.
NMCSenders	Create, update, delete, and query New Marketing Campaign Senders in SendGrid.
NMCSingleSends	Create, update, delete, and query the available New Marketing Campaign Single Sends in SendGrid.
Spam	Query and delete Spam reports in SendGrid.
Teammates	Query Teammates in SendGrid.
UnsubscribeGroups	Create, update, delete, and query Unsubscribe Groups in SendGrid.
Users	Query the available Users in SendGrid.

Alerts

Create, update, delete, and query Alerts in SendGrid.

テーブル固有の情報

Select

このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM Alerts
SELECT * FROM Alerts WHERE Id = '148825'

Insert

Stats Notification の挿入には、次のカラムが必須です：Type、EmailTo、Frequency。

INSERT INTO Alerts (Type, EmailTo, Frequency) VALUES ('stats_notification', '[email protected]', 'daily')

Usage Limit の挿入には、次のカラムが必須です：Type、EmailTo、Percentage。

INSERT INTO Alerts (Type, EmailTo, Percentage) VALUES ('usage_limit', '[email protected]', 20)

Update

Id を指定することでEmailTo を更新できます。

UPDATE Alerts SET EmailTo = '[email protected]' WHERE Id = 1310789

Delete

Id を指定することでAlerts から削除できます。

DELETE FROM Alerts WHERE Id = 1310789

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False		The ID of the alert.
CreatedAt	Datetime	True		Date when the alert was created.
UpdatedAt	Datetime	True		Date when the alert was updated.
EmailTo	String	False		The email address that the alert will be sent to.
Percentage	Integer	False		The email address that the alert will be sent to.
Type	String	False		The type of alert. Allowed values (usage_limit, stats_notification).
Frequency	String	False		If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent.(daily, weekly, monthly).

ApiKeys

Query, Create, Update and Delete the available ApiKeys in SendGrid.

テーブル固有の情報

Select

すべてのApi Keys を取得します

SELECT * FROM ApiKeys

特定のApi Key に関する情報を取得します

SELECT * FROM Apikeys WHERE ApiKeyId = 'Dqdvdvdvdv4yLeuVQqO3rFxN5ktUxA'

Insert

挿入には、次のカラムが必須です：Name。 Scopes の値は次のとおりです: alerts.create, alerts.read, alerts.update, alerts.delete, asm.groups.create, asm.groups.read, asm.groups.update, asm.groups.delete, ips.pools.ips.read, mail.send, mail_settings.bcc.read, mail_settings.bcc.update, mail_settings.address_whitelist.read, mail_settings.address_whitelist.update, mail_settings.footer.read, mail_settings.footer.update, mail_settings.forward_spam.read, mail_settings.forward_spam.update, mail_settings.plain_content.read, mail_settings.plain_content.update, mail_settings.spam_check.read, mail_settings.spam_check.update, mail_settings.bounce_purge.read, mail_settings.bounce_purge.update, mail_settings.forward_bounce.read, mail_settings.forward_bounce.update, partner_settings.new_relic.read, partner_settings.new_relic.update, partner_settings.sendwithus.read, partner_settings.sendwithus.update, tracking_settings.click.read, tracking_settings.click.update, tracking_settings.subscription.read, tracking_settings.subscription.update, tracking_settings.open.read, tracking_settings.open.update, tracking_settings.google_analytics.read, tracking_settings.google_analytics.update, user.webhooks.event.settings.read, user.webhooks.event.settings.update, user.webhooks.event.test.create, user.webhooks.event.test.read, user.webhooks.event.test.update, user.webhooks.parse.settings.create, user.webhooks.parse.settings.read, user.webhooks.parse.settings.update, user.webhooks.parse.settings.delete, stats.read, stats.global.read, categories.stats.read, categories.stats.sums.read, devices.stats.read, clients.stats.read, clients.phone.stats.read, clients.tablet.stats.read, clients.webmail.stats.read, clients.desktop.stats.read, geo.stats.read, mailbox_providers.stats.read, browsers.stats.read, user.webhooks.parse.stats.read, templates.create, templates.read, templates.update, templates.delete, templates.versions.create, templates.versions.read, templates.versions.update, templates.versions.delete, templates.versions.activate.create, user.timezone.read, user.timezone.update, user.settings.enforced_tls.read, user.settings.enforced_tls.update, api_keys.create, api_keys.read, api_keys.update, api_keys.delete, email_activity.read, categories.create, categories.read, categories.update, categories.delete, mail_settings.template.read, mail_settings.template.update, marketing_campaigns.create, marketing_campaigns.read, marketing_campaigns.update, marketing_campaigns.delete, mail.batch.create, mail.batch.read, mail.batch.update, mail.batch.delete, user.scheduled_sends.create, user.scheduled_sends.read, user.scheduled_sends.update, user.scheduled_sends.delete, access_settings.whitelist.create, access_settings.whitelist.read, access_settings.whitelist.update, access_settings.whitelist.delete, access_settings.activity.read, whitelabel.create, whitelabel.read, whitelabel.update, whitelabel.delete, suppression.create, suppression.read, suppression.update, suppression.delete, messages.read

INSERT INTO Apikeys (Name) VALUES ('apiname')

INSERT INTO Apikeys (Name, Scopes, Sample) VALUES ('apiname', 'alerts.create,alerts.read', 'test')

Update

ApiKeyid を指定することでApiKeys を更新できます。更新を希望しない場合でも、UPDATE 中に名前とスコープの両方を指定する必要があります。

UPDATE Apikeys SET Name = 'apiname2', Scopes = 'alerts.create,alerts.read' WHERE apikeyid = 'Dqdvdvdvdv4yLeuVQqO3rFxN5kscsctUxA-P_Q'

Delete

ApiKeyid を指定してApiKeys を削除することができます。

DELETE FROM ApiKeys WHERE apikeyid = 'CMp4C8klscscscsQ0GxqvxtK2-P_Q'

Columns


Name	Type	ReadOnly	References	Description
ApiKeyId [KEY]	String	False		The ID of your API Key.
Name	String	False		The name of your API Key.
Scopes	String	False		The permissions this API Key has access to. This is populated only when Id is specified.

Blocks

Query and Delete the available Blocks in SendGrid.

テーブル固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM Blocks WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'

Delete

Email を指定することでBlocks から削除できます。

DELETE FROM Blocks WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
CreatedAt	Datetime	True		The time the block was created.
Reason	String	False		The reason for the block.
Email [KEY]	String	False		The email that blocked.
Status	String	False		The enhanced SMTP block response.

Bounces

Query and Delete the available Bounces in SendGrid.

テーブル固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM Bounces WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'

Delete

Email を指定することでBounces から削除できます。

DELETE FROM Bounces WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
CreatedAt	Datetime	True		The time the bounce was created.
Reason	String	False		The reason for the bounce.
Email [KEY]	String	False		The email that bounced.
Status	String	False		The enhanced SMTP bounce response.

CancelScheduledSends

Update, delete, and query Cancel Scheduled Sends in SendGrid.

テーブル固有の情報

Select

このテーブルはBatchId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM CancelScheduledSends
SELECT * FROM CancelScheduledSends WHERE BatchId = 148825

Update

BatchId を指定してCancelScheduledSends を更新することができます。

使用できる値はcancel、pause です。

UPDATE CancelScheduledSends SET Status = 'cancel'  WHERE BatchId = 1310789

Delete

BatchId を指定することでCancelScheduledSends から削除できます。

DELETE FROM CancelScheduledSends WHERE BatchId = 1310789

Columns


Name	Type	ReadOnly	References	Description
BatchId [KEY]	String	False		The Id of the batch.
Status	String	False		The status of the scheduled send.Allowed Values: cancel, pause

GlobalUnsubscribes

Query Global Unsubscribes in SendGrid.

テーブル固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。ただし、このフィルタは任意です。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM GlobalUnsubscribes WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'

INSERT

このテーブルでInsert 操作を行うには、GlobalUnsubscribes リストに追加されるE メールを指定する必要があります。次に例を示します。

INSERT INTO GlobalUnsubscribes (Email) VALUES ('[email protected]')

DELETE

このテーブルでDelete 操作を行うには、GlobalUnsubscribes リストから削除されるE メールを指定する必要があります。次に例を示します。

DELETE FROM GlobalUnsubscribes WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
Email [KEY]	String	False		Email of the unsubscriber.
CreatedAt	Datetime	True		The time the unsubscriber was created.

InvalidEmails

Query and Delete invalid emails in SendGrid.

テーブル固有の情報

Select

このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM InvalidEmails
SELECT * FROM InvalidEmails WHERE Email = '[email protected]'

Delete

Email を指定することでInvalidEmails から削除できます。

DELETE FROM InvalidEmails WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
Created	Datetime	True		The time the when the email address was added to the invalid emails list.
Reason	String	False		A reason explaining why the email address was marked as invalid..
Email [KEY]	String	False		The email address that was marked as invalid.

NMCCustomFields

Create, delete, and query New Marketing Campaign Custom Fields in SendGrid.

テーブル固有の情報

新しいMarketing Campaign のカスタムフィールドは、ユーザーにより指定された連絡先を分類するフィルタです。NMC プレフィックスは、New Marketing Campaign の略です。

Select

すべてのNMCCustomFields の取得、またはId でのフィルタが可能です。

SELECT * FROM NMCCustomFields WHERE Id = '1'

タイプに関係なく、NMC Custom Fields をフィルタするには引用符を使用します。

Insert

NMCCustomFields に挿入するには、フィールド名とその種類の指定が必要です。タイプは、text、date、およびnumber が使用できます。

INSERT INTO NMCCustomFields (name, type) VALUES ('age', 'number')

Update

UPDATE NMCCustomFields SET name = 'updated name' WHERE Id = '123'

Delete

Id を指定することでNMCCustomFields から削除できます。

DELETE FROM NMCCustomFields WHERE Id = '1'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the custom field.
Name	String	False		The name of the custom field.
Type	String	False		The type of the custom field. Allowed values are number, text, or date.

NMCLists

Create, update, delete, and query the available New Marketing Campaign Lists in SendGrid.

テーブル固有の情報

NMC プレフィックスは、New Marketing Campaign の略です。

Select

NMCLists テーブルはId によってのみフィルタできます。

SELECT * FROM NMCLists WHERE Id = '123'

Insert

テーブルへの挿入には、NMCLists の名前のみ必要です。

INSERT INTO NMCLists (Name) VALUES ('TestList')

Update

Id を指定することでNMCLists を更新できます。

UPDATE NMCLists SET Name = 'New Name' WHERE Id = '123'

Delete

Id を指定することでNMCLists から削除できます。

DELETE FROM NMCLists WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the list.
Name	String	False		The name of the list.
ContactCount	Integer	True		The recipient count of the list.

NMCSegments

Create, update, delete, and query New Marketing Campaign Segments in SendGrid.

テーブル固有の情報

NMC プレフィックスは、New Marketing Campaign の略です。

Select

すべてのセグメントの取得、またはId でのフィルタが可能です。

SELECT * FROM NMCSegments WHERE Id = '1'

Insert

特定の抽出条件によってセグメントはNMCContacts を分割できます。これらの抽出条件を指定するには、QueryDSL フィルタを使用します。

INSERT INTO NMCSegments (Name, QueryDSL) VALUES ("New Segment", "Segment Cdata", "first_name LIKE '%test%'"))

上記のステートメントは、値 "test" を含むFirstName を持つNMCContacts を含んだNMCSegments を作成します。

Update

名前またはコンディションを更新することができます。すべてのセットが上書きされるので、フルセットを指定してください。

UPDATE NMCSegments SET Name = "Name Updated", QueryDSL = "first_name LIKE '%test update%'" WHERE Id = '123'

Delete

Id でのみNMCSegments を削除できます。

DELETE FROM NMCSegments WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the segment.
Name	String	False		The name of the segment.
ParentListId	String	False		The Id of the list associated with the segment.
ContactsCount	Integer	True		The recipient count of the segment.
CreatedAt	Datetime	True		Field name for the first condition.
SampleUpdatedAt	Datetime	False		Field name for the first condition.
UpdatedAt	Datetime	True		Field name for the first condition.
QueryDSL	String	False		Field name for the first condition.
NextSampleUpdate	Datetime	True		The last updated samples date.

NMCSenders

Create, update, delete, and query New Marketing Campaign Senders in SendGrid.

テーブル固有の情報

NMC は、New Marketing Campaign の略です。

Select

このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM NMCSenders
SELECT * FROM NMCSenders WHERE Id = '148825'

Insert

挿入には、次のカラムが必須です：Nickname、FromEmail、FromName、ReplytoEmail、Address、City、Country。

INSERT INTO NMCSenders (Nickname, FromEmail, FromName, ReplytoEmail, Address, City, Country) VALUES ('Nickname', 'FromEmail', 'FromName', 'ReplytoEmail', 'Address', 'City', 'Country')

Update

Id を指定してNMCSenders を更新することができます。

UPDATE NMCSenders SET Nickname = 'Nickname', FromEmail = 'FromEmail', FromName = 'FromName', ReplytoEmail = 'ReplytoEmail', Address = 'Address', City = 'City', Country = 'Country'  WHERE Id = 1310789

Delete

Id を指定することでAlerts から削除できます。

DELETE FROM NMCSenders WHERE Id = 1310789

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier of the sender identity.
Nickname	String	False		A nickname for the sender identity. Not used for sending..
FromEmail	String	False		This is where the email will appear to originate from for your recipient.
FromName	String	False		This is the name appended to the from email field. IE - Your name or company name.
ReplytoEmail	String	False		This is the email that your recipient will reply to.
ReplytoName	String	False		This is the name appended to the reply to email field. IE - Your name or company name.
Address	String	False		The physical address of the sender identity.
Address2	String	False		Additional sender identity address information.
City	String	False		The city of the sender identity.
State	String	False		The state of the sender identity.
Zip	String	False		The zipcode of the sender identity.
Locked	String	False		Indicator if the sender is locked.
VerifiedStatus	String	False		Verified status of the sender.
VerifiedReason	String	False		Verified reason of the sender.
Country	String	False		The country of the sender identity.
CreatedAt	Datetime	True		The end of the time range when the bounce was created.
UpdatedAt	Datetime	True		The end of the time range when the bounce was created.

NMCSingleSends

Create, update, delete, and query the available New Marketing Campaign Single Sends in SendGrid.

テーブル固有の情報

NMC は、New Marketing Campaign の略です。

Select

このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM NMCSingleSends
SELECT * FROM NMCSingleSends WHERE Id = '148825'

Insert

挿入には、次のカラムが必須です：Name。

INSERT INTO NMCSingleSends (Name) VALUES ('SingleSend Name')

Update

Id を指定してNMCSingleSends を更新することができます。

UPDATE NMCSingleSends SET Name = 'SingleSend Updated' WHERE Id = 1310789

Delete

Id を指定することでNMCSingleSends から削除できます。

DELETE FROM NMCSingleSends WHERE Id = 1310789

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the single send.
Name	String	False		The name of the single send.
Categories	String	False		The name of the single send.
Status	String	False		The status of the single send.
CreatedAt	String	True		The created timestamp of the single send.
UpdatedAt	String	True		The updated timestamp of the single send.
IsABTest	Boolean	False		Indicator showing if the single send is an AB Test.
SendAt	Datetime	False		The ISO 8601 time at which to send the single send.
EmailConfigCustomUnsubscribeUrl	String	False		The URL allowing recipients to unsubscribe.
EmailConfigEditor	String	False		The editor, design or code, used to modify the Single Send's design in the Marketing Campaigns application user interface. This is populated only when Id is specified.
EmailConfigGeneratePlainContent	Boolean	False		If this property is set to true, plain_content is always generated from html_content. If it's set to false, plain_content is not altered. This is populated only when Id is specified.
EmailConfigHtmlContent	String	False		The HTML content of the Single Send. This property is not used when a design_id value is set. This is populated only when Id is specified.
EmailConfigIpPool	String	False		The name of the IP Pool from which the Single Send emails are sent. This is populated only when Id is specified.
EmailConfigPlainContent	String	False		The plain text content of the Single Send. This is populated only when Id is specified.
EmailConfigSenderId	Integer	False		The ID of the verified sender from whom the Single Send will be sent. This is populated only when Id is specified.
EmailConfigSubject	String	False		The subject line of the Single Send. This is populated only when Id is specified.
EmailConfigSuppressionGroupId	Integer	False		The ID of the Suppression Group to allow recipients to unsubscribe. This is populated only when Id is specified.
SendToListIds	String	False		The IDs of each contact list to which the Single Send will be sent. This is populated only when Id is specified.
SendToSegmentIds	String	False		The IDs of each segment to which the Single Send will be sent. This is populated only when Id is specified.
SendToAll	Boolean	False		If this property is set to true, the Single Send will be sent to all of your contacts. This is populated only when Id is specified.

Spam

Query and delete Spam reports in SendGrid.

テーブル固有の情報

Select

このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM Spam
SELECT * FROM Spam WHERE Email = '[email protected]'

Delete

Delete from Spam

Email を指定することでSpam から削除できます。

DELETE FROM Spam WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
CreatedAt	Datetime	True		The time when the spam report was made.
Email [KEY]	String	False		The email address of the recipient who marked your message as spam.
Ip	String	False		The IP address that the message was sent on.

Teammates

Query Teammates in SendGrid.

ビュー固有の情報

Select

Sync App はSendGrid API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

Usernameは、'=,IN' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SQL

SELECT * FROM Teammates WHERE Username = 'test'

SELECT * FROM Teammates WHERE Username IN ('test', 'test2')

Insert

挿入には、次のカラムが必須です：Email およびScopes。Scopes カラムは、値のカンマ区切りのリストを許容します。利用できる値は以下です：user.account.read, user.credits.read, user.email.create, user.email.read, user.email.update, user.email.delete, user.profile.create, user.profile.read, user.profile.update, user.profile.delete

IsAdmin は任意で、デフォルトではAPI からはfalse として受け取られます。

INSERT INTO Teammates (Email, Scopes) VALUES ('[email protected]', 'user.profile.read,user.profile.update')

INSERT INTO Teammates (Email, Scopes, IsAdmin) VALUES ('[email protected]', 'user.profile.read,user.profile.update', 'true')

Update

更新には、次のカラムが必須です：Username およびScopes。Scopes カラムは、値のカンマ区切りのリストを許容します。利用できる値は以下です：user.account.read, user.credits.read, user.email.create, user.email.read, user.email.update, user.email.delete, user.profile.create, user.profile.read, user.profile.update, user.profile.delete

UPDATE Teammates SET Scopes = 'user.profile.read' WHERE Username = 'testuser'

Delete

Teammates テーブルからレコードを削除するには、username カラムのみが必要です。次に例を示します。

DELETE FROM Teammates WHERE Username = 'testuser'

Columns


Name	Type	ReadOnly	References	Description
Username [KEY]	String	False		The username of the teammate.
Email	String	False		Email of the teammate.
FirstName	String	False		First name of the teammate.
LastName	String	False		Last name of the teammate.
UserType	String	False		User type of the teammate.
IsAdmin	Boolean	False		Indicator if the teammate is admin.
Phone	String	False		Phone of the teammate.
Website	String	False		Website of the teammate.
Company	String	False		Company of the teammate.
Address	String	False		Address of the teammate.
Address2	String	False		Address 2 of the teammate.
City	String	False		City of the teammate.
State	String	False		State of the teammate.
Country	String	False		Country of the teammate.
Zip	String	False		Zip of the teammate.
Scopes	String	False		Scope of the permissions for the new teammate. Multiple values are allowed and should be split by a comma symbol. Possible values are: user.account.read,user.credits.read,user.email.create,user.email.read,user.email.update,user.email.delete,user.profile.create,user.profile.read,user.profile.update,user.profile.delete

UnsubscribeGroups

Create, update, delete, and query Unsubscribe Groups in SendGrid.

テーブル固有の情報

Select

UnsubscribeGroups はId によってのみフィルタできます。

SELECT * FROM UnsubscribeGroups WHERE Id = '1'

Insert

UnsubscribeGroups に挿入するには、名前と説明を指定します。

INSERT INTO UnsubscribeGroups (Name, Description, IsDefault) VALUES ('Unsubscribe1', 'General Unsubscribe', true)

Update

Id を指定することでUnsubscribeGroups を更新できます。

UPDATE UnsubscribeGroups SET Name = 'New Name', Description = 'New Description' WHERE Id = '1'

Delete

Id を指定することでUnsubscribeGroups から削除できます。

DELETE FROM UnsubscribeGroups WHERE Id = '1'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		Id of the unsubscribe group.
Name	String	False		The name of the unsubscribe group.
Description	String	False		The description of the unsubscribe group.
LastEmailSentAt	Datetime	True		The last time an email was sent to the unsubscribe group.
IsDefault	Boolean	False		If the unsubscribe group is the default group or not.
Unsubscribes	Integer	True		The number of unsubscribes from this group.

Users

Query the available Users in SendGrid.

View-Specific Information

Select

Query this table to retrieve your current profile details.

SELECT * FROM Users

Update

You can update the all the columns marked as readonly false.

UPDATE Users Set Address='Milpitas', Address2='North Carolina' WHERE id='38713966'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the user.
Address	String	False		The address of the user.
Address2	String	False		The secondary address field for the user.
City	String	False		The city of the user.
Company	String	False		The company of the user.
Country	String	False		The country of the user.
FirstName	String	False		The first name of the user.
LastName	String	False		The last name of the user.
Phone	String	False		The phone number of the user.
State	String	False		The state the user is located in.
Website	String	False		The Web site URL of the user.
Zip	String	False		The ZIP code of the user.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

SendGrid Connector for CData Sync ビュー


Name	Description
AutomationStats	Get All Automation Stats
Categories	Query the available Categories in SendGrid.
CategoryStats	Query the available Category Stats in SendGrid.
Designs	List Designs
GlobalStats	Query the available Global Stats in SendGrid.
GroupSuppressions	Query group suppressions in SendGrid.
IPAccessManagement	Query Global Unsubscribes in SendGrid.
MailSettings	Query all the mail settings in SendGrid.
MessageEvents	List of events related to email message in SendGrid.
Messages	Query Email Activities in SendGrid.
NMCContacts	Query New Marketing Campaign Contacts in SendGrid.
NMCReservedFields	Query the available New Marketing Campaign Reserved Fields in SendGrid.
PartnerSettings	Query all the partner settings in SendGrid.
SingleSendClickTrackingStats	Get Single Send Click Tracking Stats by ID
SingleSendsStats	Get All Single Sends Stats
StatsByBrowser	Query Browser Statistics in SendGrid.
StatsByClient	Query Client Statistics in SendGrid.
StatsByDevice	Query Device Statistics in SendGrid.
StatsByLocation	Query Location Statistics in SendGrid.
StatsByMailboxProvider	Query Mailbox Provider Statistics in SendGrid.
SubuserStats	Query Subuser Statistics in SendGrid.
Templates	Retrieve paged transactional templates

AutomationStats

Get All Automation Stats

View-Specific Information

Select

The following is an example to query the AutomationStats view:

 
SELECT * FROM AutomationStats

Columns


Name	Type	References	Description
Id	String		This is the ID of the Automation you are requesting stats for.
Aggregation	String		This describes the time unit to which the stat is rolled up. It is based on the aggregated_by parameter included in the request. It can be 'total' or the date (in YYYY-MM-DD format) the stats are for.
StepId	String		This is the ID of the step if the stats were requested to be grouped by step_id.
BounceDrops	Integer		BounceDrops
Bounces	Integer		Bounces
Clicks	Integer		Clicks
Delivered	Integer		Delivered
InvalidEmails	Integer		InvalidEmails
Opens	Integer		Opens
Requests	Integer		Requests
SpamReportDrops	Integer		SpamReportDrops
SpamReports	Integer		SpamReports
UniqueClicks	Integer		UniqueClicks
UniqueOpens	Integer		UniqueOpens
Unsubscribes	Integer		Unsubscribes

CategoryStats

Query the available Category Stats in SendGrid.

ビュー固有の情報

Select

以下は、CategoryStats ビューをクエリする例です。

 
SELECT * FROM CategoryStats WHERE Name = 'news'

日付でフィルタをかけることもできます。指定しない場合は、過去1年間のデフォルト期間が適用されます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。

SELECT * FROM CategoryStats WHERE Name = 'news' AND Date > '2016-01-01' AND Date < '2016-01-30'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the category.
Date	Date		The time the global statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
Drops	Integer		The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links clicked in your emails.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails confirmed delivered.
InvalidEmails	Integer		The number of emails with a malformed address or reported as invalid by the receiving server.
Opens	Integer		The number of times your emails were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid.
Requests	Integer		The number of emails you requested to send via SendGrid.
SpamReportDrops	Integer		The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports	Integer		The number of emails marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.
UnsubscribeDrops	Integer		The number of emails in this category dropped by SendGrid because the recipient unsubscribed from your emails.
Unsubscribes	Integer		The number of recipients who unsubscribed from your emails.

Designs

List Designs

View-Specific Information

Select

The following is an example to query the Designs view:

 
SELECT * FROM Designs

Columns


Name	Type	References	Description
Id	String		ID of the Design.
UpdatedAt	String		Datetime that Design was last updated.
CreatedAt	String		Datetime that Design was created.
ThumbnailURL	String		A Thumbnail preview of the template's html content.
Name	String		The name of the new design.
Editor	String		The editor used in the UI.

GlobalStats

Query the available Global Stats in SendGrid.

ビュー固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去1年間のデフォルト期間が適用されます。Date カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM GlobalStats

SELECT * FROM GlobalStats WHERE Date > '2016-01-01' AND Date < '2016-03-30'

Columns


Name	Type	References	Description
Date	Date		The time the global statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
BounceDrops	Integer		The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links clicked in your emails.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails confirmed delivered.
InvalidEmails	Integer		The number of emails with a malformed address or reported as invalid by the receiving server.
Opens	Integer		The number of times your emails were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid.
Requests	Integer		The number of emails you requested to send via SendGrid.
SpamReportDrops	Integer		The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports	Integer		The number of emails marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.
UnsubscribeDrops	Integer		The number of emails globally dropped by SendGrid because the recipient unsubscribed from your emails.
Unsubscribes	Integer		The number of recipients who unsubscribed from your emails.

GroupSuppressions

Query group suppressions in SendGrid.

テーブル固有の情報

Select

以下は、GroupSuppressions テーブルをクエリする例です。

SELECT * FROM GroupSuppressions WHERE GroupId = 391

SELECT * FROM GroupSuppressions WHERE GroupId IN (391, 392, 393)

Columns


Name	Type	References	Description
GroupId [KEY]	Integer		Email of the unsubscriber.
Emails	String		The time the unsubscriber was created.

IPAccessManagement

Query Global Unsubscribes in SendGrid.

ビュー固有の情報

Select

Sync App はSendGrid API を使用してアカウントにアクセスしたIP アドレスの情報を取得します。ただし、このビューではサーバーサイドのフィルタリングはサポートされていません。

次のクエリのみがサーバーサイドで処理されます。

SQL

SELECT * FROM IPAccessManagement

Columns


Name	Type	References	Description
IP	String		IP Address.
Allowed	Boolean		Indicator if this IP is allowed for access.
AuthMethod	String		Authentication method.
FirstAt	Timestamp		First time when IP has accessed the account.
LastAt	Timestamp		Last time when IP has accessed the account.
Location	String		Location of the IP.

MailSettings

Query all the mail settings in SendGrid.

Table-Specific Information

Select

You can retrieve all the mail settings.

SELECT * FROM MailSettings

Columns


Name	Type	References	Description
Title	String		The title of the mail setting.
Enabled	String		Indicates if this mail setting is currently enabled.
Name	String		The name of the mail setting.
Description	String		A description of the mail setting.

MessageEvents

List of events related to email message in SendGrid.

NOTE： E メールイベントにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。

ビュー固有の情報

Select

Sync App はSendGrid API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

MessageId は'=' 比較演算子をサポートします。

SQL

SELECT * FROM MessageEvents WHERE MessageId = '1234'

Columns


Name	Type	References	Description
MessageId	String		The Id of the message.
EventName	String		Name of event. 使用できる値は次のとおりです。bounced, opened, clicked, processed, dropped, delivered, deferred, spam_report, unsubscribe, group_unsubscribe, group_resubscribe
Processed	Datetime		The date when the event was processed.
Reason	String		Explanation of what caused the message to be 'bounced', 'deferred', or 'blocked'.
AttemptNum	Integer		Used with 'deferred' events to indicate the attempt number out of 10.
Url	String		Used with 'clicked' event to indicate which url the user clicked.
BounceType	String		Use to distinguish between types of bounces. 使用できる値は次のとおりです。soft, hard
HttpUserAgent	String		Client recipient used to click or open message.
MXServer	String		The MX server that received the email.
ApiKeyId	String		Id of the API Key.
AsmGroupId	String		ASM Group Id.
Categories	String		Categories users associated to the message.
UniqueArgs	String		JSON hash of key-value pairs associated with the message.
OriginatingIp	String		This is the IP address of the person sending the message
OutboundIp	String		This is the SendGrid dedicated IP address used to send the email
OutboundIpType	String		The type of the outbound IP.
Teammate	String		Username of the teammate.
TemplateId	String		Template ID of the email.

Messages

Query Email Activities in SendGrid.

NOTE： E メールアクティビティにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。

ビュー固有の情報

Select

Sync App はSendGrid API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

Note：API は1000 レコードのみを返します。検索を制限するために、利用可能なフィルタから選択してください。

Idは、'=,IN' 演算子をサポートします。
Statusは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
Subjectは、'=,!=,LIKE,NOT LIKE'演算子をサポートします。
FromEmailは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
ToEmailは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
Clicksは、'>,<,<=,>=,=,!=' 演算子をサポートします。
LastEventTimeは、'>=, <=, BETWEEN' 演算子をサポートします。
ApiKeyIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
AsmGroupIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
MarketingCampaignIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
MarketingCampaignNameは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
OriginatingIpは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
OutboundIpは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
Teammateは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
TemplateIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SQL

SELECT * FROM Messages WHERE Id = '1234'

SELECT * FROM Messages WHERE Id IN ('1234', '4567')

SELECT * FROM Messages WHERE Status = 'not_delivered'

SELECT * FROM Messages WHERE LastEventTime BETWEEN '2020-01-01' AND '2020-01-15'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the message.
Status	String		Status of the email.
Subject	String		Subject of the email.
FromEmail	String		The email of the sender.
ToEmail	String		The email of the receiver.
ClicksCount	Integer		The number of clicks.
OpensCount	Integer		The number of times that the email was opened.
LastEventTime	Datetime		The datetime of the event.
ApiKeyId	String		Id of the API Key.
AsmGroupId	String		ASM Group Id.
MarketingCampaignId	String		The id of the marketing campaign.
MarketingCampaignName	String		The name of the marketing campaign.
MarketingCampaignSplitId	String		Split id of the campaign.
MarketingCampaignVersion	String		Version of the campaign.
OriginatingIp	String		This is the IP address of the person sending the message
OutboundIp	String		This is the SendGrid dedicated IP address used to send the email
OutboundIpType	String		The type of the outbound IP.
Teammate	String		Username of the teammate.
TemplateId	String		Template ID of the email.
Events	String		List of events related to email message in SendGrid.

NMCContacts

Query New Marketing Campaign Contacts in SendGrid.

ビュー固有の情報

新しいMarketing Campaign の連絡先はユーザーが管理する受信者です。NMC プレフィックスは、New Marketing Campaign の略です。

Select

すべてのNMCContacts の取得、またはId、ListId、SegmentId でのフィルタが可能です。

SELECT * FROM NMCCustomFields WHERE Id = '1'
SELECT * FROM NMCCustomFields WHERE Id IN ('1', '2', '3')
SELECT * FROM NMCCustomFields WHERE ListId = '1'
SELECT * FROM NMCCustomFields WHERE ListId IN ('1', '2', '3')
SELECT * FROM NMCCustomFields WHERE SegmentId = '1'
SELECT * FROM NMCCustomFields WHERE SegmentId IN ('1', '2', '3')

Columns


Name	Type	References	Description
Id [KEY]	String		This column is dynamic and maps to the corresponding field in the API.
AddressLine1	String		This column is dynamic and maps to the corresponding field in the API.
AddressLine2	String		This column is dynamic and maps to the corresponding field in the API.
City	String		This column is dynamic and maps to the corresponding field in the API.
Country	String		This column is dynamic and maps to the corresponding field in the API.
PostalCode	String		This column is dynamic and maps to the corresponding field in the API.
StateProvinceRegion	String		This column is dynamic and maps to the corresponding field in the API.
Line	String		This column is dynamic and maps to the corresponding field in the API.
Facebook	String		This column is dynamic and maps to the corresponding field in the API.
PhoneNumber	String		This column is dynamic and maps to the corresponding field in the API.
UniqueName	String		This column is dynamic and maps to the corresponding field in the API.
WhatsApp	String		This column is dynamic and maps to the corresponding field in the API.
Email	String		This column is dynamic and maps to the corresponding field in the API.
FirstName	String		This column is dynamic and maps to the corresponding field in the API.
LastName	String		This column is dynamic and maps to the corresponding field in the API.
CreatedAt	Datetime		This column is dynamic and maps to the corresponding field in the API.
UpdatedAt	Datetime		This column is dynamic and maps to the corresponding field in the API.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
SegmentId	String		This column is dynamic and maps to the corresponding field in the API.
ListId	String		This column is dynamic and maps to the corresponding field in the API.

NMCReservedFields

Query the available New Marketing Campaign Reserved Fields in SendGrid.

ビュー固有の情報

Select

このテーブルは、フィルタリングをサポートしていません。NMC プレフィックスは、New Marketing Campaign の略です。

SELECT * FROM NMCReservedFields

Columns


Name	Type	References	Description
Id	String		The Id of the reserved field.
Name	String		The name of the reserved field.
Type	String		The type of the reserved field.

PartnerSettings

Query all the partner settings in SendGrid.

Table-Specific Information

Select

You can retrieve all the partner settings.

SELECT * FROM PartnerSettings

Columns


Name	Type	References	Description
Title	String		The title of the partner.
Enabled	String		Indicates if this partner setting has been enabled.
Name	String		The name of the partner setting.
Description	String		A description of this partner setting.

SingleSendClickTrackingStats

Get Single Send Click Tracking Stats by ID

View-Specific Information

Select

Get Single Send Click Tracking Stats. To access the view, you’ll need to provide the Single Send ID.

 
SELECT * FROM SingleSendClickTrackingStats where SingleSendId = '74550809-66a2-11ef-ad7f-460f539623db'

Columns


Name	Type	References	Description
SingleSendId	String	NMCSingleSends.Id	The ID of Single Send for which you want to retrieve Click Tracking stats.
Url	String		This is the URL of the link clicked. If {{custom_fields}} are part of the URL, they will be included.
UrlLocation	Integer		This is the location of the link clicked in each Single Send A/B variation, or in the Single Send itself if there are no variations. Links are numbered from the top down; the topmost link is index 0.
ABvariation	String		This is the A/B variation of the Single Send stat returned. It is set to 'all' if the ab_variation query parameter was not set in the request and group_by doesn't contain ab_variation.
ABphase	String		This is the A/B phase of the Single Send stat returned. If the ab_phase query parameter was not provided, it will return 'all'.
Clicks	Integer		The number of clicks on this particular link.

SingleSendsStats

Get All Single Sends Stats

View-Specific Information

Select

The Sync App uses the SendGrid API to process search criteria that refer to the Id column, while other filters are processed client side within the Sync App.

Get All Single Sends Stats

SELECT * FROM SingleSendsStats

Get Single Send Stats by ID

SELECT * FROM SingleSendsStats where id = '25723e10-669e-11ef-b50f-0e4b6974e9ad'

Columns


Name	Type	References	Description
Id [KEY]	String		This is the ID of the Single Send you require stats for.
ABvariation	String		This is the A/B variation of the Single Send stat returned. If the group_by parameter doesn't include ab_variation in the request, then the value is 'all'.
ABphase	String		This is the A/B phase of the Single Send stat returned. If the group_by parameter doesn't include ab_phase in the request, then the value is 'all'.
Aggregation	String		This describes the time unit to which the stat is rolled up. It is based on the aggregated_by parameter included in the request. It can be 'total' or the date (in YYYY-MM-DD format) the stats are for.
BounceDrops	Integer		BounceDrops
Bounces	Integer		Bounces
Clicks	Integer		Clicks
Delivered	Integer		Delivered
InvalidEmails	Integer		InvalidEmails
Opens	Integer		Opens
Requests	Integer		Requests
SpamReportDrops	Integer		SpamReportDrops
SpamReports	Integer		SpamReports
UniqueClicks	Integer		UniqueClicks
UniqueOpens	Integer		UniqueOpens
Unsubscribes	Integer		Unsubscribes

StatsByBrowser

Query Browser Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByBrowser WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Browser Statistics by name.

SELECT * FROM StatsByBrowser WHERE Name = 'Firefox'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Clicks	Integer		The number of links clicked in your emails.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.

StatsByClient

Query Client Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByClient WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Client Statistics by name.

SELECT * FROM StatsByClient WHERE Name = 'Other'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Opens	Integer		The number of times your emails were opened by recipients.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

StatsByDevice

Query Device Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByDevice WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Device Statistics by name.

SELECT * FROM StatsByDevice WHERE Name = 'Phone'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Opens	Integer		The number of times your emails were opened by recipients.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

StatsByLocation

Query Location Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByLocation WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Location Statistics by name.

SELECT * FROM StatsByLocation WHERE Name = 'US'

To query Location Statistics by type.

SELECT * FROM StatsByLocation WHERE Type = 'country'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Clicks	Integer		The number of links clicked in your emails.
Opens	Integer		The number of times your emails were opened by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

StatsByMailboxProvider

Query Mailbox Provider Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByMailboxProvider WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Mailbox Provider Statistics by name.

SELECT * FROM StatsByMailboxProvider WHERE Name = 'Microsoft Outlook Live'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
Drops	Integer		The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links clicked in your emails.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails confirmed delivered.
Opens	Integer		The number of times your emails were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid.
Requests	Integer		The number of emails you requested to send via SendGrid.
SpamReports	Integer		The number of emails marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

SubuserStats

Query Subuser Statistics in SendGrid.

ビュー固有の情報

Select

SubuserName でフィルタリングすると、特定のサブユーザーの統計情報を取得できます。

SELECT * FROM SubuserStats WHERE SubuserName = 'Example'

日付でフィルタをかけることもできます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。指定しない場合は、過去1年間のデフォルト期間が適用されます。

SELECT * FROM SubuserStats WHERE SubuserName = 'News' AND Date > '2016-01-01' AND Date < '2016-01-30'

Columns


Name	Type	References	Description
Date	Datetime		The time the subuser statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
Drops	Integer		The number of emails automatically dropped because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links that were clicked in the emails from this subuser.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails from this subsuer that were confirmed delivered.
InvalidEmails	Integer		The number of emails with a malformed address or reported as invalid by the receiving server.
Opens	Integer		The number of times emails from this subuser were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid by this subuser.
Requests	Integer		The number of emails that you requested to send via SendGrid from this subuser.
SpamReportDrops	Integer		The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports	Integer		The number of emails from this subuser that were marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked on links in your emails from this subuser.
UniqueOpens	Integer		The number of unique recipients who opened your emails from this subuser.
UnsubscribeDrops	Integer		The number of emails from this subuser dropped by SendGrid because the recipients unsubscribed from your emails.
Unsubscribes	Integer		The number of recipients who unsubscribed from your emails from this subuser.
SubuserName	String		The name of the statistic.
Type	String		The type of the statistic.

Templates

Retrieve paged transactional templates

View-Specific Information

Select

The following is an example to query the Templates view:

 
SELECT * FROM Templates

The Sync App will use the SendGrid API to process WHERE clause conditions built with the following column and operator.

Generation supports the '='.

 
SELECT * FROM Templates WHERE Generation = 'dynamic'

Columns


Name	Type	References	Description
ID [KEY]	String		The ID of the transactional template.
Generation	String		Defines the generation of the template. By default, we will get data for both dynamic and legacy. 使用できる値は次のとおりです。dynamic, legacy
Name	String		The name for the transactional template.
UpdatedAt	String		The date and time that this transactional template version was updated.
Versions	String		The different versions of this transactional template.

レガシーデータモデル

CData Sync App は、レガシーAPI をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。大抵のテーブル、ビュー、およびストアドプロシージャは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。

しかし、Recipients テーブルは動的です。Sync App は、SendGrid に接続し、適切なWeb サービスを呼び出してこのテーブルのメタデータを取得します。Recipients テーブルに定義したカスタムフィルタに加えた変更はすべて接続時に利用可能です。これらのカスタムフィルタはWHERE 句内でカラムとして使用できます。これらのカスタムフィルタはCustomFields テーブル内に表示されます。

このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

従来のデータモデルを使用するには、Schema をLegacy に設定します。

テーブル

テーブルは、簡単にクエリや更新ができる利用可能なテーブルについて説明します。

ビュー

ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャは、Sendgrid のファンクションライクなインターフェースです。これらを使用して、情報を検索、更新、および変更できます。

テーブル

Sync App はSendGrid のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

SendGrid Connector for CData Sync テーブル


Name	Description
Alerts	Create, update, delete, and query Alerts in SendGrid.
ApiKeys	Query, Create, Update and Delete the available ApiKeys in SendGrid.
Blocks	Query and Delete the available Blocks in SendGrid.
Bounces	Query and Delete the available Bounces in SendGrid.
CancelScheduledSends	Update, delete, and query Cancel Scheduled Sends in SendGrid.
CustomFields	Create, delete, and query Custom Fields in SendGrid.
GlobalUnsubscribes	Query Global Unsubscribes in SendGrid.
InvalidEmails	Query and Delete invalid emails in SendGrid.
Lists	Create, update, delete, and query the available Lists in SendGrid.
MarketingCampaigns	Create, update, delete, and query Marketing Campaigns in SendGrid.
Recipients	The SendGrid table Recipients.
Schedules	Create, update, delete, and query Campaign Schedules in SendGrid.
Segments	Create, update, delete, and query Segments in SendGrid.
SenderIdentities	Create, update, delete, and query Sender Identities in SendGrid.
Spam	Query and delete Spam reports in SendGrid.
Teammates	Query Teammates in SendGrid.
UnsubscribeGroups	Create, update, delete, and query Unsubscribe Groups in SendGrid.
Users	Query the available Users in SendGrid.

Alerts

Create, update, delete, and query Alerts in SendGrid.

テーブル固有の情報

Select

このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM Alerts WHERE Id = '148825'

Insert

Stats Notification の挿入には、次のカラムが必須です：Type、EmailTo、Frequency。

INSERT INTO Alerts (Type, EmailTo, Frequency) VALUES ('stats_notification', '[email protected]', 'daily')

Usage Limit の挿入には、次のカラムが必須です：Type、EmailTo、Percentage。

INSERT INTO Alerts (Type, EmailTo, Percentage) VALUES ('usage_limit', '[email protected]', 20)

Update

Id を指定することでEmailTo を更新できます。

UPDATE Alerts SET EmailTo = '[email protected]' WHERE Id = 1310789

Delete

Id を指定することでAlerts から削除できます。

DELETE FROM Alerts WHERE Id = 1310789

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False		The ID of the alert.
CreatedAt	Datetime	True		Date when the alert was created.
UpdatedAt	Datetime	True		Date when the alert was updated.
EmailTo	String	False		The email address that the alert will be sent to.
Percentage	Integer	False		The email address that the alert will be sent to.
Type	String	False		The type of alert. Allowed values (usage_limit, stats_notification).
Frequency	String	False		If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent.(daily, weekly, monthly).

ApiKeys

Query, Create, Update and Delete the available ApiKeys in SendGrid.

テーブル固有の情報

Select

すべてのApi Keys を取得します

SELECT * FROM ApiKeys

特定のApi Key に関する情報を取得します

SELECT * FROM Apikeys WHERE ApiKeyId = 'Dqdvdvdvdv4yLeuVQqO3rFxN5ktUxA'

Insert

挿入には、次のカラムが必須です：Name。 Scopes の値は次のとおりです: alerts.create, alerts.read, alerts.update, alerts.delete, asm.groups.create, asm.groups.read, asm.groups.update, asm.groups.delete, ips.pools.ips.read, mail.send, mail_settings.bcc.read, mail_settings.bcc.update, mail_settings.address_whitelist.read, mail_settings.address_whitelist.update, mail_settings.footer.read, mail_settings.footer.update, mail_settings.forward_spam.read, mail_settings.forward_spam.update, mail_settings.plain_content.read, mail_settings.plain_content.update, mail_settings.spam_check.read, mail_settings.spam_check.update, mail_settings.bounce_purge.read, mail_settings.bounce_purge.update, mail_settings.forward_bounce.read, mail_settings.forward_bounce.update, partner_settings.new_relic.read, partner_settings.new_relic.update, partner_settings.sendwithus.read, partner_settings.sendwithus.update, tracking_settings.click.read, tracking_settings.click.update, tracking_settings.subscription.read, tracking_settings.subscription.update, tracking_settings.open.read, tracking_settings.open.update, tracking_settings.google_analytics.read, tracking_settings.google_analytics.update, user.webhooks.event.settings.read, user.webhooks.event.settings.update, user.webhooks.event.test.create, user.webhooks.event.test.read, user.webhooks.event.test.update, user.webhooks.parse.settings.create, user.webhooks.parse.settings.read, user.webhooks.parse.settings.update, user.webhooks.parse.settings.delete, stats.read, stats.global.read, categories.stats.read, categories.stats.sums.read, devices.stats.read, clients.stats.read, clients.phone.stats.read, clients.tablet.stats.read, clients.webmail.stats.read, clients.desktop.stats.read, geo.stats.read, mailbox_providers.stats.read, browsers.stats.read, user.webhooks.parse.stats.read, templates.create, templates.read, templates.update, templates.delete, templates.versions.create, templates.versions.read, templates.versions.update, templates.versions.delete, templates.versions.activate.create, user.timezone.read, user.timezone.update, user.settings.enforced_tls.read, user.settings.enforced_tls.update, api_keys.create, api_keys.read, api_keys.update, api_keys.delete, email_activity.read, categories.create, categories.read, categories.update, categories.delete, mail_settings.template.read, mail_settings.template.update, marketing_campaigns.create, marketing_campaigns.read, marketing_campaigns.update, marketing_campaigns.delete, mail.batch.create, mail.batch.read, mail.batch.update, mail.batch.delete, user.scheduled_sends.create, user.scheduled_sends.read, user.scheduled_sends.update, user.scheduled_sends.delete, access_settings.whitelist.create, access_settings.whitelist.read, access_settings.whitelist.update, access_settings.whitelist.delete, access_settings.activity.read, whitelabel.create, whitelabel.read, whitelabel.update, whitelabel.delete, suppression.create, suppression.read, suppression.update, suppression.delete, messages.read

INSERT INTO Apikeys (Name) VALUES ('apiname')

INSERT INTO Apikeys (Name, Scopes, Sample) VALUES ('apiname', 'alerts.create,alerts.read', 'test')

Update

ApiKeyid を指定することでApiKeys を更新できます。更新を希望しない場合でも、UPDATE 中に名前とスコープの両方を指定する必要があります。

UPDATE Apikeys SET Name = 'apiname2', Scopes = 'alerts.create,alerts.read' WHERE apikeyid = 'Dqdvdvdvdv4yLeuVQqO3rFxN5kscsctUxA-P_Q'

Delete

ApiKeyid を指定してApiKeys を削除することができます。

DELETE FROM ApiKeys WHERE apikeyid = 'CMp4C8klscscscsQ0GxqvxtK2-P_Q'

Columns


Name	Type	ReadOnly	References	Description
ApiKeyId [KEY]	String	False		The ID of your API Key.
Name	String	False		The name of your API Key.
Scopes	String	False		The permissions this API Key has access to. This is populated only when Id is specified.

Blocks

Query and Delete the available Blocks in SendGrid.

テーブル固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM Blocks WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'

Delete

Email を指定することでBlocks から削除できます。

DELETE FROM Blocks WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
CreatedAt	Datetime	True		The time the block was created.
Reason	String	False		The reason for the block.
Email [KEY]	String	False		The email that blocked.
Status	String	False		The enhanced SMTP block response.

Bounces

Query and Delete the available Bounces in SendGrid.

テーブル固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM Bounces WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'

Delete

Email を指定することでBounces から削除できます。

DELETE FROM Bounces WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
CreatedAt	Datetime	True		The time the bounce was created.
Reason	String	False		The reason for the bounce.
Email [KEY]	String	False		The email that bounced.
Status	String	False		The enhanced SMTP bounce response.

CancelScheduledSends

Update, delete, and query Cancel Scheduled Sends in SendGrid.

テーブル固有の情報

Select

このテーブルはBatchId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM CancelScheduledSends
SELECT * FROM CancelScheduledSends WHERE BatchId = 148825

Update

BatchId を指定してCancelScheduledSends を更新することができます。

使用できる値はcancel、pause です。

UPDATE CancelScheduledSends SET Status = 'cancel' WHERE BatchId = 1310789

Delete

BatchId を指定することでCancelScheduledSends から削除できます。

DELETE FROM CancelScheduledSends WHERE BatchId = 1310789

Columns


Name	Type	ReadOnly	References	Description
BatchId [KEY]	String	False		The Id of the batch.
Status	String	False		The status of the scheduled send.Allowed Values: cancel, pause

CustomFields

Create, delete, and query Custom Fields in SendGrid.

テーブル固有の情報

カスタムフィールドは、ユーザーにより指定された受信者を分類するフィルタです。

Select

すべてのCustomFields の取得、またはId でのフィルタが可能です。

SELECT * FROM CustomFields WHERE Id = '1'

タイプに関係なく、Custom Fields をフィルタするには引用符を使用します。

Insert

CustomFields に挿入するには、フィールド名とその種類の指定が必要です。タイプは、text、date、およびnumber が使用できます。

INSERT INTO CustomFields (name, type) VALUES ('age', 'number')

Update

このテーブルは、アップデートをサポートしていません。

Delete

Id を指定することでCustomFields から削除できます。

DELETE FROM CustomFields WHERE Id = '1'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the custom field.
Name	String	False		The name of the custom field.
Type	String	False		The type of the custom field. Allowed values are number, text, or date.

GlobalUnsubscribes

Query Global Unsubscribes in SendGrid.

テーブル固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。ただし、このフィルタは任意です。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM GlobalUnsubscribes WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'

INSERT

このテーブルでInsert 操作を行うには、GlobalUnsubscribes リストに追加されるE メールを指定する必要があります。次に例を示します。

INSERT INTO GlobalUnsubscribes (Email) VALUES ('[email protected]')

DELETE

このテーブルでDelete 操作を行うには、GlobalUnsubscribes リストから削除されるE メールを指定する必要があります。次に例を示します。

DELETE FROM GlobalUnsubscribes WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
Email [KEY]	String	False		Email of the unsubscriber.
CreatedAt	Datetime	True		The time the unsubscriber was created.

InvalidEmails

Query and Delete invalid emails in SendGrid.

テーブル固有の情報

Select

このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM InvalidEmails
SELECT * FROM InvalidEmails WHERE Email = '[email protected]'

Delete

Email を指定することでInvalidEmails から削除できます。

DELETE FROM InvalidEmails WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
Created	Datetime	True		The time the when the email address was added to the invalid emails list.
Reason	String	False		A reason explaining why the email address was marked as invalid..
Email [KEY]	String	False		The email address that was marked as invalid.

Lists

Create, update, delete, and query the available Lists in SendGrid.

テーブル固有の情報

Select

リストテーブルはId によってのみフィルタできます。

SELECT * FROM Lists WHERE Id = '123'

Insert

テーブルへの挿入には、リストの名前のみ必要です。

INSERT INTO Lists (Name) VALUES ('TestList')

Update

Id を指定することでLists から更新できます。

UPDATE Lists SET Name = 'New Name' WHERE Id = '123'

Delete

Id を指定することでLists から削除できます。

DELETE FROM Lists WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The Id of the list.
Name	String	False		The name of the list.
RecipientCount	Integer	True		The recipient count of the list.

MarketingCampaigns

Create, update, delete, and query Marketing Campaigns in SendGrid.

テーブル固有の情報

Select

このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM MarketingCampaigns
SELECT * FROM MarketingCampaigns WHERE Id = '1'

Insert

挿入は、次のカラムが必須です：Title、Subject、SenderId、ListIds、SegmentIds、Categories、SuppressionGroupId、HtmlContent、およびPlainContent。

CustomUnsubscribeUrl はSuppressionGroupId の代わりに使えます。ただし、SendGrid はSuppressionGroupId の使用を強く推奨しています。

以下のチェックポイントを使って、SenderId およびSuppressionGroupId のインプットを見つけてください。

［Marketing］->［MarketingCampaigns］->［Senders］の順に進むと、SenderId を見つけることができます。差し出し人情報がまだない場合は、新たに作ります。アクションカラム上の歯車をクリックし、［編集］を選択します。ナビゲーションバー上の / senders / id の後ろにId が表示されます。
SuppressionGroupId を見つけるためには、UnsubscribeGroups テーブルに挿入し、作成されたId がSuppressionGroupId です。

INSERT INTO MarketingCampaigns (Title, Subject, SenderId, ListIds, Categories, SuppressionGroupId, HtmlContent, PlainContent) VALUES ('Test Campaign', 'March Newsletter', '123', '1,2', 'fruits, health', '12', '<b>Eat Healthy</b>', 'Eat healthy')

Update

Id を指定することでMarketingCampaigns を更新できます。

UPDATE MarketingCampaigns SET PlainContent = 'Eat healthier' WHERE Id = '123'

Delete

Id を指定することでMarketingCampaigns から削除できます。

DELETE FROM MarketingCampaigns WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the marketing campaign.
Title	String	False		The title of the marketing campaign.
Subject	String	False		The subject of the marketing campaign.
SenderId	Integer	False		The sender Ids of the marketing campaign, separated by a comma.
ListIds	String	False		The list of list Ids of the marketing campaign, separated by a comma.
SegmentIds	String	False		The list of segment Ids of the marketing campaign, separated by a comma.
Categories	String	False		The categories of the marketing campaign.
SuppressionGroupId	Integer	False		The suppression group Id of the marketing campaign.
CustomUnsubscribeUrl	String	False		The custom unsubscribe URL of the marketing campaign.
IpPool	String	False		The IP pool of the marketing campaign.
HtmlContent	String	False		The HTML content of the marketing campaign.
PlainContent	String	False		The content of the marketing campaign.
Status	String	True		The status of the marketing campaign.
Editor	String	False		The editor used in the UI. 使用できる値は次のとおりです。code, design

Recipients

The SendGrid table Recipients.

テーブル固有の情報

SendGrid はユーザーにより定義されたフィルタでRecipients を分類できます。それに応じて、フィルタを使った検索やそれらのフィルタを挿入するためにRecipients テーブルにステートメントを実行します。しかし、これらのフィルタはカスタムフィールドテーブルの属性として記録されます。

Select

以下のクエリはRecipients テーブルのデフォルトフィールドのみ取得します。作成したカスタムフィールドは取得できません。受信者のカスタムフィールドの値を取得するには、カスタムフィールドテーブルをクエリします。

特定のリスト内またはセグメント内のすべてのRecipients を取得することもできますが、両方でのフィルタはできません。代わりに複数のクエリを使用します：

SELECT * FROM Recipients WHERE SegmentId = '1'
SELECT * FROM Recipients WHERE ListId = '2'

カスタムフィールドによって抽出条件を作成できます。タイプに関係なく、クエリでは引用符を使います。この種のフィルタリングはクライアント側で行われます。この場合、Age はユーザーによって作成されたカスタムフィールドです。

SELECT * FROM Recipients WHERE Age = '30'

Insert

Recipients に挿入するには、Email が必要です。

カスタムフィールドをRecipients テーブルに挿入できます。カスタムフィールドの作成に関する詳しい情報は、CustomFields セクションを参照してください。

INSERT INTO Recipients (Email, FirstName, LastName, Age, Department ... Other Custom Fields as necessary) VALUES ('[email protected]', 'name', 'surname', '30', 'Education' ... Other Custom Field values)

Update

Id を指定することでこのテーブルから更新できます。また、E メールカラムは更新ができません。

UPDATE Recipients SET Age = '12' WHERE Id = '1'

Delete

Id を指定することでこのテーブルから削除できます。

DELETE FROM Recipients WHERE Id = '1'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		This column is dynamic and maps to the corresponding field in the API.
SegmentId	Int32	False		This column is dynamic and maps to the corresponding field in the API.
ListId	Int32	False		This column is dynamic and maps to the corresponding field in the API.
Email	String	False		This column is dynamic and maps to the corresponding field in the API.
FirstName	String	False		This column is dynamic and maps to the corresponding field in the API.
LastName	String	False		This column is dynamic and maps to the corresponding field in the API.
CreatedAt	Datetime	True		This column is dynamic and maps to the corresponding field in the API.
LastClicked	Datetime	True		This column is dynamic and maps to the corresponding field in the API.
LastEmailed	Datetime	False		This column is dynamic and maps to the corresponding field in the API.
LastOpened	Datetime	True		This column is dynamic and maps to the corresponding field in the API.
UpdatedAt	Datetime	True		This column is dynamic and maps to the corresponding field in the API.
Age	String	False		This column is dynamic and maps to the corresponding field in the API.
Department	String	False		This column is dynamic and maps to the corresponding field in the API.
University	String	False		This column is dynamic and maps to the corresponding field in the API.

Schedules

Create, update, delete, and query Campaign Schedules in SendGrid.

テーブル固有の情報

Select

以下は、Schedules テーブルをクエリする例です。

SELECT * FROM Schedules WHERE MarketingCampaignId = '123'

Insert

MarketingCampaignId とSendAt を指定すると、特定の時間にキャンペーンを設定できます。SendAt を指定するだけですぐにキャンペーンを送信できます。SendGrid でキャンペーンを送信するには、HTML とプレーンテキストの両コンテンツに [unsubscribe] タグが必要です。

INSERT INTO Schedules (MarketingCampaignId) VALUES (3091692)

INSERT INTO Schedules (MarketingCampaignId, SendAt) VALUES (1, '11/11/2018')

Update

MarketingCampaignId を指定することでスケジュールを更新できます。

UPDATE Schedules SET SendAt = '01-01-2016' WHERE MarketingCampaignId = '123'

Delete

MarketingCampaignId を指定することでスケジュールを削除できます。

DELETE FROM Schedules WHERE MarketingCampaignId = '123'

Columns


Name	Type	ReadOnly	References	Description
MarketingCampaignId [KEY]	Integer	False		Id of the campaign.
Status	String	True		Status of the campaign.
SendAt	Datetime	False		Date to start the campaign.

Segments

Create, update, delete, and query Segments in SendGrid.

テーブル固有の情報

Select

すべてのセグメントの取得、またはId でのフィルタが可能です。

SELECT * FROM Segments WHERE Id = '1'

Insert

特定の抽出条件によってセグメントは受信者を分割できます。抽出条件を指定するには、ConditionsField カラムと抽出条件を適用するリストのId を使います。

ConditionsAndOr カラムは与えられたフィールドと前のフィールドを接続します。

INSERT INTO Segments (Name, ListId, ConditionsField1, ConditionsValue1, ConditionsOperator1, ConditionsAndOr1, ConditionsField2, ConditionsValue2, ConditionsOperator2, ConditionsAndOr2) VALUES ("New Segment", 123, 'age', '20', '>', '', 'age', '30', '<', 'and')

上記のステートメントは20歳～30歳の受信者が含まれているセグメントを作成します。

Update

名前またはコンディションを更新することができます。すべてのセットが上書きされるので、フルセットを指定してください。

UPDATE Segments SET Name = 'Name Updated', ConditionsField1 = 'age', ConditionsOperator1 = '<=', ConditionsAndOr1 = '', ConditionsValue1 = '30' WHERE Id = '123'

Delete

Id を指定することでセグメントを削除できます。

DELETE FROM Segments WHERE Id = '123'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The Id of the segment.
Name	String	False		The name of the segment.
ListId	Integer	False		The Id of the list associated with the segment.
RecipientCount	Integer	True		The recipient count of the segment.
ConditionsField1	String	False		Field name for the first condition.
ConditionsValue1	String	False		Field value for the first condition.
ConditionsOperator1	String	False		Condition operator for the first condition.
ConditionsAndOr1	String	False		How to connect to the previous condition. Allowed values are AND or OR.
ConditionsField2	String	False		Field name for the second condition.
ConditionsValue2	String	False		Field value for the second condition.
ConditionsOperator2	String	False		Condition operator for the second condition.
ConditionsAndOr2	String	False		How to connect to the previous condition. Allowed values are AND or OR.
ConditionsField3	String	False		Field name for the third condition.
ConditionsValue3	String	False		Field value for the third condition.
ConditionsOperator3	String	False		Condition operator for the third condition.
ConditionsAndOr3	String	False		How to connect to the previous condition. Allowed values are AND or OR.
ConditionsField4	String	False		Field name for the fourth condition.
ConditionsValue4	String	False		Field value for the fourth condition.
ConditionsOperator4	String	False		Condition operator for the fourth condition.
ConditionsAndOr4	String	False		How to connect to the previous condition. Allowed values are AND or OR.
ConditionsField5	String	False		Field name for the fifth condition.
ConditionsValue5	String	False		Field value for the fifth condition.
ConditionsOperator5	String	False		Condition operator for the fifth condition.
ConditionsAndOr5	String	False		How to connect to the previous condition. Allowed values are AND or OR.

SenderIdentities

Create, update, delete, and query Sender Identities in SendGrid.

テーブル固有の情報

Select

このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM SenderIdentities
SELECT * FROM SenderIdentities WHERE Id = '148825'

Insert

挿入には、次のカラムが必須です：Nickname、FromEmail、FromName、ReplytoEmail、Address、City、Country。

INSERT INTO SenderIdentities (Nickname, FromEmail, FromName, ReplytoEmail, Address, City, Country) VALUES ('Nickname', 'FromEmail', 'FromName', 'ReplytoEmail', 'Address', 'City', 'Country')

Update

Id を指定してSenderIdentities を更新することができます。

UPDATE SenderIdentities SET Nickname = 'Nickname', FromEmail = 'FromEmail', FromName = 'FromName', ReplytoEmail = 'ReplytoEmail', Address = 'Address', City = 'City', Country = 'Country' WHERE Id = 1310789

Delete

Id を指定することでAlerts から削除できます。

DELETE FROM SenderIdentities WHERE Id = 1310789

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	False		The unique identifier of the sender identity.
Nickname	String	False		A nickname for the sender identity. Not used for sending..
FromEmail	String	False		This is where the email will appear to originate from for your recipient.
FromName	String	False		This is the name appended to the from email field. IE - Your name or company name.
ReplytoEmail	String	False		This is the email that your recipient will reply to.
ReplytoName	String	False		This is the name appended to the reply to email field. IE - Your name or company name.
Address	String	False		The physical address of the sender identity.
Address2	String	False		Additional sender identity address information.
City	String	False		The city of the sender identity.
State	String	False		The state of the sender identity.
Zip	String	False		The zipcode of the sender identity.
Country	String	False		The country of the sender identity.
CreatedAt	Datetime	True		The end of the time range when the bounce was created.
UpdatedAt	Datetime	True		The end of the time range when the bounce was created.
Locked	Boolean	True		A boolean flag that is true when the Sender is associated with a campaign in Draft, Scheduled, or In Progress status. You cannot update or delete a locked Sender.
VerifiedReason	String	True		The reason for verifying the sender
VerifiedStatus	Boolean	True		A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.

Spam

Query and delete Spam reports in SendGrid.

テーブル固有の情報

Select

このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。

SELECT * FROM Spam
SELECT * FROM Spam WHERE Email = '[email protected]'

Delete

Delete from Spam

Email を指定することでSpam から削除できます。

DELETE FROM Spam WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
CreatedAt	Datetime	True		The time when the spam report was made.
Email [KEY]	String	False		The email address of the recipient who marked your message as spam.
Ip	String	False		The IP address that the message was sent on.

Teammates

Query Teammates in SendGrid.

ビュー固有の情報

Select

Sync App はSendGrid API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

Usernameは、'=,IN' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SQL

SELECT * FROM Teammates WHERE Username = 'test'

SELECT * FROM Teammates WHERE Username IN ('test', 'test2')

Insert

挿入には、次のカラムが必須です：Email およびScopes。Scopes カラムは、値のカンマ区切りのリストを許容します。利用できる値は以下です：user.account.read, user.credits.read, user.email.create, user.email.read, user.email.update, user.email.delete, user.profile.create, user.profile.read, user.profile.update, user.profile.delete

IsAdmin は任意で、デフォルトではAPI からはfalse として受け取られます。

INSERT INTO Teammates (Email, Scopes) VALUES ('[email protected]', 'user.profile.read, user.profile.update')

INSERT INTO Teammates (Email, Scopes, IsAdmin) VALUES ('[email protected]', 'user.profile.read, user.profile.update', 'true')

Update

更新には、次のカラムが必須です：Username およびScopes。Scopes カラムは、値のカンマ区切りのリストを許容します。利用できる値は以下です：user.account.read, user.credits.read, user.email.create, user.email.read, user.email.update, user.email.delete, user.profile.create, user.profile.read, user.profile.update, user.profile.delete

UPDATE Teammates SET Scopes = 'user.profile.read' WHERE Username = 'testuser'

Delete

Teammates テーブルからレコードを削除するには、username カラムのみが必要です。次に例を示します。

DELETE FROM Teammates WHERE Username = 'testuser'

Columns


Name	Type	ReadOnly	References	Description
Username [KEY]	String	False		The username of the teammate.
Email	String	False		Email of the teammate.
FirstName	String	False		First name of the teammate.
LastName	String	False		Last name of the teammate.
UserType	String	False		User type of the teammate.
IsAdmin	Boolean	False		Indicator if the teammate is admin.
Phone	String	False		Phone of the teammate.
Website	String	False		Website of the teammate.
Company	String	False		Company of the teammate.
Address	String	False		Address of the teammate.
Address2	String	False		Address 2 of the teammate.
City	String	False		City of the teammate.
State	String	False		State of the teammate.
Country	String	False		Country of the teammate.
Zip	String	False		Zip of the teammate.
Scopes	String	False		Scope of the permissions for the new teammate. Multiple values are allowed and should be split by a comma symbol. Possible values are: user.account.read,user.credits.read,user.email.create,user.email.read,user.email.update,user.email.delete,user.profile.create,user.profile.read,user.profile.update,user.profile.delete

UnsubscribeGroups

Create, update, delete, and query Unsubscribe Groups in SendGrid.

テーブル固有の情報

Select

UnsubscribeGroups はId によってのみフィルタできます。

SELECT * FROM UnsubscribeGroups WHERE Id = '1'

Insert

UnsubscribeGroups に挿入するには、名前と説明を指定します。

INSERT INTO UnsubscribeGroups (Name, Description, IsDefault) VALUES ('Unsubscribe1', 'General Unsubscribe', true)

Update

Id を指定することでUnsubscribeGroups を更新できます。

UPDATE UnsubscribeGroups SET Name = 'New Name', Description = 'New Description' WHERE Id = '1'

Delete

Id を指定することでUnsubscribeGroups から削除できます。

DELETE FROM UnsubscribeGroups WHERE Id = '1'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		Id of the unsubscribe group.
Name	String	False		The name of the unsubscribe group.
Description	String	False		The description of the unsubscribe group.
LastEmailSentAt	Datetime	True		The last time an email was sent to the unsubscribe group.
IsDefault	Boolean	False		If the unsubscribe group is the default group or not.
Unsubscribes	Integer	True		The number of unsubscribes from this group.

Users

Query the available Users in SendGrid.

View-Specific Information

Select

Query this table to retrieve your current profile details.

SELECT * FROM Users

Update

You can update the all the columns marked as readonly false.

UPDATE Users Set Address='Milpitas', Address2='North Carolina' WHERE id='38713966'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the user.
Address	String	False		The address of the user.
Address2	String	False		The secondary address field for the user.
City	String	False		The city of the user.
Company	String	False		The company of the user.
Country	String	False		The country of the user.
FirstName	String	False		The first name of the user.
LastName	String	False		The last name of the user.
Phone	String	False		The phone number of the user.
State	String	False		The state the user is located in.
Website	String	False		The Web site URL of the user.
Zip	String	False		The ZIP code of the user.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

SendGrid Connector for CData Sync ビュー


Name	Description
Categories	Query the available Categories in SendGrid.
CategoryStats	Query the available Category Stats in SendGrid.
GlobalStats	Query the available Global Stats in SendGrid.
GroupSuppressions	Query group suppressions in SendGrid.
IPAccessManagement	Query Global Unsubscribes in SendGrid.
MailSettings	Query all the mail settings in SendGrid.
MessageEvents	List of events related to email message in SendGrid.
Messages	Query Email Activities in SendGrid.
PartnerSettings	Query all the partner settings in SendGrid.
ReservedFields	Query the available Reserved Fields in SendGrid.
StatsByBrowser	Query Browser Statistics in SendGrid.
StatsByClient	Query Client Statistics in SendGrid.
StatsByDevice	Query Device Statistics in SendGrid.
StatsByLocation	Query Location Statistics in SendGrid.
StatsByMailboxProvider	Query Mailbox Provider Statistics in SendGrid.
SubuserStats	Query Subuser Statistics in SendGrid.

CategoryStats

Query the available Category Stats in SendGrid.

ビュー固有の情報

Select

以下は、CategoryStats ビューをクエリする例です。

SELECT * FROM CategoryStats WHERE Name = 'news'

日付でフィルタをかけることもできます。指定しない場合は、過去1年間のデフォルト期間が適用されます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。

SELECT * FROM CategoryStats WHERE Name = 'news' AND Date > '2016-01-01' AND Date < '2016-01-30'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the category.
Date	Date		The time the global statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
Drops	Integer		The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links clicked in your emails.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails confirmed delivered.
InvalidEmails	Integer		The number of emails with a malformed address or reported as invalid by the receiving server.
Opens	Integer		The number of times your emails were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid.
Requests	Integer		The number of emails you requested to send via SendGrid.
SpamReportDrops	Integer		The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports	Integer		The number of emails marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.
UnsubscribeDrops	Integer		The number of emails in this category dropped by SendGrid because the recipient unsubscribed from your emails.
Unsubscribes	Integer		The number of recipients who unsubscribed from your emails.

GlobalStats

Query the available Global Stats in SendGrid.

ビュー固有の情報

Select

このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去1年間のデフォルト期間が適用されます。Date カラムは、>、<、=、<=、および>= 演算子をサポートします。

SELECT * FROM GlobalStats

SELECT * FROM GlobalStats WHERE Date > '2016-01-01' AND Date < '2016-03-30'

Columns


Name	Type	References	Description
Date	Date		The time the global statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
BounceDrops	Integer		The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links clicked in your emails.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails confirmed delivered.
InvalidEmails	Integer		The number of emails with a malformed address or reported as invalid by the receiving server.
Opens	Integer		The number of times your emails were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid.
Requests	Integer		The number of emails you requested to send via SendGrid.
SpamReportDrops	Integer		The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports	Integer		The number of emails marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.
UnsubscribeDrops	Integer		The number of emails globally dropped by SendGrid because the recipient unsubscribed from your emails.
Unsubscribes	Integer		The number of recipients who unsubscribed from your emails.

GroupSuppressions

Query group suppressions in SendGrid.

テーブル固有の情報

Select

以下は、GroupSuppressions テーブルをクエリする例です。

SELECT * FROM GroupSuppressions WHERE GroupId = 391

SELECT * FROM GroupSuppressions WHERE GroupId IN (391, 392, 393)

Columns


Name	Type	References	Description
GroupId [KEY]	Integer		Email of the unsubscriber.
Emails	String		The time the unsubscriber was created.

IPAccessManagement

Query Global Unsubscribes in SendGrid.

ビュー固有の情報

Select

Sync App はSendGrid API を使用してアカウントにアクセスしたIP アドレスの情報を取得します。ただし、このビューではサーバーサイドのフィルタリングはサポートされていません。

次のクエリのみがサーバーサイドで処理されます。

SQL

SELECT * FROM IPAccessManagement

Columns


Name	Type	References	Description
IP	String		IP Address.
Allowed	Boolean		Indicator if this IP is allowed for access.
AuthMethod	String		Authentication method.
FirstAt	Timestamp		First time when IP has accessed the account.
LastAt	Timestamp		Last time when IP has accessed the account.
Location	String		Location of the IP.

MailSettings

Query all the mail settings in SendGrid.

Table-Specific Information

Select

You can retrieve all the mail settings.

SELECT * FROM MailSettings

Columns


Name	Type	References	Description
Title	String		The title of the mail setting.
Enabled	String		Indicates if this mail setting is currently enabled.
Name	String		The name of the mail setting.
Description	String		A description of the mail setting.

MessageEvents

List of events related to email message in SendGrid.

NOTE： E メールイベントにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。

ビュー固有の情報

Select

Sync App はSendGrid API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

MessageId は'=' 比較演算子をサポートします。

SQL

SELECT * FROM MessageEvents WHERE MessageId = '1234'

Columns


Name	Type	References	Description
MessageId	String		The Id of the message.
EventName	String		Name of event. 使用できる値は次のとおりです。bounced, opened, clicked, processed, dropped, delivered, deferred, spam_report, unsubscribe, group_unsubscribe, group_resubscribe
Processed	Datetime		The date when the event was processed.
Reason	String		Explanation of what caused the message to be 'bounced', 'deferred', or 'blocked'.
AttemptNum	Integer		Used with 'deferred' events to indicate the attempt number out of 10.
Url	String		Used with 'clicked' event to indicate which url the user clicked.
BounceType	String		Use to distinguish between types of bounces. 使用できる値は次のとおりです。soft, hard
HttpUserAgent	String		Client recipient used to click or open message.
MXServer	String		The MX server that received the email.
ApiKeyId	String		Id of the API Key.
AsmGroupId	String		ASM Group Id.
Categories	String		Categories users associated to the message.
UniqueArgs	String		JSON hash of key-value pairs associated with the message.
OriginatingIp	String		This is the IP address of the person sending the message
OutboundIp	String		This is the SendGrid dedicated IP address used to send the email
OutboundIpType	String		The type of the outbound IP.
Teammate	String		Username of the teammate.
TemplateId	String		Template ID of the email.

Messages

Query Email Activities in SendGrid.

NOTE： E メールアクティビティにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。

ビュー固有の情報

Select

Sync App はSendGrid API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

Note：API は1000 レコードのみを返します。検索を制限するために、利用可能なフィルタから選択してください。

Idは、'=,IN' 演算子をサポートします。
Statusは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
Subjectは、'=,!=,LIKE,NOT LIKE'演算子をサポートします。
FromEmailは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
ToEmailは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
Clicksは、'>,<,<=,>=,=,!=' 演算子をサポートします。
LastEventTimeは、'>=, <=, BETWEEN' 演算子をサポートします。
ApiKeyIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
AsmGroupIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
MarketingCampaignIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
MarketingCampaignNameは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
OriginatingIpは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
OutboundIpは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
Teammateは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。
TemplateIdは、'=,!=,LIKE,NOT LIKE' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SQL

SELECT * FROM Messages WHERE Id = '1234'

SELECT * FROM Messages WHERE Id IN ('1234', '4567')

SELECT * FROM Messages WHERE Status = 'not_delivered'

SELECT * FROM Messages WHERE LastEventTime BETWEEN '2020-01-01' AND '2020-01-15'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the message.
Status	String		Status of the email.
Subject	String		Subject of the email.
FromEmail	String		The email of the sender.
ToEmail	String		The email of the receiver.
ClicksCount	Integer		The number of clicks.
OpensCount	Integer		The number of times that the email was opened.
LastEventTime	Datetime		The datetime of the event.
ApiKeyId	String		Id of the API Key.
AsmGroupId	String		ASM Group Id.
MarketingCampaignId	String		The id of the marketing campaign.
MarketingCampaignName	String		The name of the marketing campaign.
MarketingCampaignSplitId	String		Split id of the campaign.
MarketingCampaignVersion	String		Version of the campaign.
OriginatingIp	String		This is the IP address of the person sending the message
OutboundIp	String		This is the SendGrid dedicated IP address used to send the email
OutboundIpType	String		The type of the outbound IP.
Teammate	String		Username of the teammate.
TemplateId	String		Template ID of the email.
Events	String		List of events related to email message in SendGrid.

PartnerSettings

Query all the partner settings in SendGrid.

Table-Specific Information

Select

You can retrieve all the partner settings.

SELECT * FROM PartnerSettings

Columns


Name	Type	References	Description
Title	String		The title of the partner.
Enabled	String		Indicates if this partner setting has been enabled.
Name	String		The name of the partner setting.
Description	String		A description of this partner setting.

ReservedFields

Query the available Reserved Fields in SendGrid.

ビュー固有の情報

Select

このテーブルは、フィルタリングをサポートしていません。

SELECT * FROM ReservedFields

Columns


Name	Type	References	Description
Name	String		The name of the reserved field.
Type	String		The type of the reserved field.

StatsByBrowser

Query Browser Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByBrowser WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Browser Statistics by name.

SELECT * FROM StatsByBrowser WHERE Name = 'Firefox'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Clicks	Integer		The number of links clicked in your emails.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.

StatsByClient

Query Client Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByClient WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Client Statistics by name.

SELECT * FROM StatsByClient WHERE Name = 'Other'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Opens	Integer		The number of times your emails were opened by recipients.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

StatsByDevice

Query Device Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByDevice WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Device Statistics by name.

SELECT * FROM StatsByDevice WHERE Name = 'Phone'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Opens	Integer		The number of times your emails were opened by recipients.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

StatsByLocation

Query Location Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByLocation WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Location Statistics by name.

SELECT * FROM StatsByLocation WHERE Name = 'US'

To query Location Statistics by type.

SELECT * FROM StatsByLocation WHERE Type = 'country'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Clicks	Integer		The number of links clicked in your emails.
Opens	Integer		The number of times your emails were opened by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

StatsByMailboxProvider

Query Mailbox Provider Statistics in SendGrid.

View-Specific Information

Select

You need to specify a time span to select from this table. If you do not specify one, a default span of the past 1 year is used. The Date column supports the >, <, =, <=, and >= operators.

SELECT * FROM StatsByMailboxProvider

SELECT * FROM StatsByMailboxProvider WHERE Date > '2016-01-01' AND Date < '2016-03-30'

To query Mailbox Provider Statistics by name.

SELECT * FROM StatsByMailboxProvider WHERE Name = 'Microsoft Outlook Live'

Columns


Name	Type	References	Description
Type	String		The type of the statistic.
Name	String		The name of the statistic.
Date	Date		The time the global statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
Drops	Integer		The number of emails automatically dropped by SendGrid because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links clicked in your emails.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails confirmed delivered.
Opens	Integer		The number of times your emails were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid.
Requests	Integer		The number of emails you requested to send via SendGrid.
SpamReports	Integer		The number of emails marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked links in your emails.
UniqueOpens	Integer		The number of unique recipients who opened your emails.

SubuserStats

Query Subuser Statistics in SendGrid.

ビュー固有の情報

Select

SubuserName でフィルタリングすると、特定のサブユーザーの統計情報を取得できます。

SELECT * FROM SubuserStats WHERE SubuserName = 'Example'

日付でフィルタをかけることもできます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。指定しない場合は、過去1年間のデフォルト期間が適用されます。

SELECT * FROM SubuserStats WHERE SubuserName = 'News' AND Date > '2016-01-01' AND Date < '2016-01-30'

Columns


Name	Type	References	Description
Date	Datetime		The time the subuser statistic was created.
Blocks	Integer		The number of emails that were not allowed to be delivered by ISPs.
Drops	Integer		The number of emails automatically dropped because they appear on one of the suppression lists.
Bounces	Integer		The number of emails that bounced instead of being delivered.
Clicks	Integer		The number of links that were clicked in the emails from this subuser.
Deferred	Integer		The number of emails temporarily refused by the receiving server.
Delivered	Integer		The number of emails from this subsuer that were confirmed delivered.
InvalidEmails	Integer		The number of emails with a malformed address or reported as invalid by the receiving server.
Opens	Integer		The number of times emails from this subuser were opened by recipients.
Processed	Integer		The number of emails pushed to SendGrid by this subuser.
Requests	Integer		The number of emails that you requested to send via SendGrid from this subuser.
SpamReportDrops	Integer		The number of emails automatically dropped because the emails were marked as spam by the recipients.
SpamReports	Integer		The number of emails from this subuser that were marked as spam by recipients.
UniqueClicks	Integer		The number of unique recipients who clicked on links in your emails from this subuser.
UniqueOpens	Integer		The number of unique recipients who opened your emails from this subuser.
UnsubscribeDrops	Integer		The number of emails from this subuser dropped by SendGrid because the recipients unsubscribed from your emails.
Unsubscribes	Integer		The number of recipients who unsubscribed from your emails from this subuser.
SubuserName	String		The name of the statistic.
Type	String		The type of the statistic.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
APIKey	現在の認証ユーザーのAPI キー。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
Schema	使用するスキーマの種類。

Miscellaneous

プロパティ	説明
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
APIKey	現在の認証ユーザーのAPI キー。

APIKey

現在の認証ユーザーのAPI キー。

解説

現在の認証ユーザーのAPI キー。これは、SendGrid Sync App を介して認証するために必須のパラメータです。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がSendGrid への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がSendGrid への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がSendGrid にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
Schema	使用するスキーマの種類。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

Note： Sync App は複数のスキーマをサポートするため、SendGrid のカスタムスキーマファイルは以下のような構造にになります。

各スキーマには、そのスキーマ名に対応するフォルダが作られます。
すべてのスキーマフォルダは、親フォルダに含まれる必要があります。

Location は常に親フォルダに設定されるべきで、個々のスキーマのフォルダに設定すべきではありません。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SendGrid Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Schema

使用するスキーマの種類。

解説

利用可能なスキーマはNMC およびLegacy です。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

解説

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM MarketingCampaigns WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビューを参照してください。

SendGrid Connector for CData Sync

SendGrid Connector for CData Sync

概要

SendGrid バージョンサポート

接続の確立

SendGrid への接続を追加

API キーの取得

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

新しいMarketing Campaigns データモデル

レガシーデータモデル

新しいMarketing Campaigns データモデル

テーブル

ビュー

ストアドプロシージャ

テーブル

SendGrid Connector for CData Sync テーブル

Alerts

テーブル固有の情報

Select

Insert

Update

Delete

Columns

ApiKeys

テーブル固有の情報

Select

Insert

Update

Delete

Columns

Blocks

テーブル固有の情報

Select

Delete

Columns

Bounces

テーブル固有の情報

Select

Delete

Columns

CancelScheduledSends

テーブル固有の情報

Select

Update

Delete

Columns

GlobalUnsubscribes

テーブル固有の情報

Select

INSERT

DELETE

Columns

InvalidEmails

テーブル固有の情報

Select

Delete

Columns

NMCCustomFields

テーブル固有の情報

Select

Insert

Update

Delete

Columns

NMCLists

テーブル固有の情報

Select

Insert