CData Sync App は、SendGrid データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
SendGrid コネクタはCData Sync アプリケーションから使用可能で、SendGrid からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はSendGrid Web API をリレーショナルデータベースとしてモデル化します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
SendGrid Sync App 経由で認証するには、API キーを使用する必要があります。
API キーを取得するには以下の手順に従ってください。
NOTE: E メールイベントにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。
このセクションでは、SendGrid Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、SendGrid にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
Sync App は、SendGrid API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。大抵のテーブル、ビュー、およびストアドプロシージャは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
しかし、Recipients テーブルは動的です。Sync App は、SendGrid に接続し、適切なWeb サービスを呼び出してこのテーブルのメタデータを取得します。Recipients テーブルに定義したカスタムフィルタに加えた変更はすべて接続時に利用可能です。これらのカスタムフィルタはWHERE 句内でカラムとして使用できます。これらのカスタムフィルタはCustomFields テーブル内に表示されます。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
新しいMarketing Campaigns API で利用可能なエンティティについては、新しいMarketing Campaigns データモデル を参照してください。
Legacy API で利用可能なエンティティについては、レガシーデータモデル を参照してください。
CData Sync App は、新しいMarketing Campaigns API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。ほとんどのテーブル、ビュー、ストアドプロシージャは、スキーマファイルに定義されています。テキストベースのシンプルな設定ファイルです。 このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
新しいMarketing Campaigns データモデルを使用するには、Schema をNMC に設定します。
テーブル は、簡単にクエリや更新ができる利用可能なテーブルについて説明します。
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
ストアドプロシージャ は、Sendgrid のファンクションライクなインターフェースです。これらを使用して、情報を検索、更新、および変更できます。
Sync App はSendGrid のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
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. |
Create, update, delete, and query Alerts in SendGrid.
このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM Alerts SELECT * FROM Alerts WHERE Id = '148825'
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)
Id を指定することでEmailTo を更新できます。
UPDATE Alerts SET EmailTo = '[email protected]' WHERE Id = 1310789
Id を指定することでAlerts から削除できます。
DELETE FROM Alerts WHERE Id = 1310789
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). |
Query, Create, Update and Delete the available ApiKeys in SendGrid.
すべてのApi Keys を取得します
SELECT * FROM ApiKeys
特定のApi Key に関する情報を取得します
SELECT * FROM Apikeys WHERE ApiKeyId = 'Dqdvdvdvdv4yLeuVQqO3rFxN5ktUxA'
挿入には、次のカラムが必須です: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')
ApiKeyid を指定することでApiKeys を更新できます。更新を希望しない場合でも、UPDATE 中に名前とスコープの両方を指定する必要があります。
UPDATE Apikeys SET Name = 'apiname2', Scopes = 'alerts.create,alerts.read' WHERE apikeyid = 'Dqdvdvdvdv4yLeuVQqO3rFxN5kscsctUxA-P_Q'
ApiKeyid を指定してApiKeys を削除することができます。
DELETE FROM ApiKeys WHERE apikeyid = 'CMp4C8klscscscsQ0GxqvxtK2-P_Q'
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. |
Query and Delete the available Blocks in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM Blocks WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'
Email を指定することでBlocks から削除できます。
DELETE FROM Blocks WHERE Email = '[email protected]'
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. |
Query and Delete the available Bounces in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM Bounces WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'
Email を指定することでBounces から削除できます。
DELETE FROM Bounces WHERE Email = '[email protected]'
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. |
Update, delete, and query Cancel Scheduled Sends in SendGrid.
このテーブルはBatchId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM CancelScheduledSends SELECT * FROM CancelScheduledSends WHERE BatchId = 148825
BatchId を指定してCancelScheduledSends を更新することができます。
使用できる値はcancel、pause です。
UPDATE CancelScheduledSends SET Status = 'cancel' WHERE BatchId = 1310789
BatchId を指定することでCancelScheduledSends から削除できます。
DELETE FROM CancelScheduledSends WHERE BatchId = 1310789
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 |
Query Global Unsubscribes in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。ただし、このフィルタは任意です。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM GlobalUnsubscribes WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'
このテーブルでInsert 操作を行うには、GlobalUnsubscribes リストに追加されるE メールを指定する必要があります。次に例を示します。
INSERT INTO GlobalUnsubscribes (Email) VALUES ('[email protected]')
このテーブルでDelete 操作を行うには、GlobalUnsubscribes リストから削除されるE メールを指定する必要があります。次に例を示します。
DELETE FROM GlobalUnsubscribes WHERE Email = '[email protected]'
Name | Type | ReadOnly | References | Description |
Email [KEY] | String | False |
Email of the unsubscriber. | |
CreatedAt | Datetime | True |
The time the unsubscriber was created. |
Query and Delete invalid emails in SendGrid.
このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM InvalidEmails SELECT * FROM InvalidEmails WHERE Email = '[email protected]'
Email を指定することでInvalidEmails から削除できます。
DELETE FROM InvalidEmails WHERE Email = '[email protected]'
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.. | |
String | False |
The email address that was marked as invalid. |
Create, delete, and query New Marketing Campaign Custom Fields in SendGrid.
新しいMarketing Campaign のカスタムフィールドは、ユーザーにより指定された連絡先を分類するフィルタです。NMC プレフィックスは、New Marketing Campaign の略です。
すべてのNMCCustomFields の取得、またはId でのフィルタが可能です。
SELECT * FROM NMCCustomFields WHERE Id = '1'
タイプに関係なく、NMC Custom Fields をフィルタするには引用符を使用します。
NMCCustomFields に挿入するには、フィールド名とその種類の指定が必要です。タイプは、text、date、およびnumber が使用できます。
INSERT INTO NMCCustomFields (name, type) VALUES ('age', 'number')
UPDATE NMCCustomFields SET name = 'updated name' WHERE Id = '123'
Id を指定することでNMCCustomFields から削除できます。
DELETE FROM NMCCustomFields WHERE Id = '1'
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. |
Create, update, delete, and query the available New Marketing Campaign Lists in SendGrid.
NMC プレフィックスは、New Marketing Campaign の略です。
NMCLists テーブルはId によってのみフィルタできます。
SELECT * FROM NMCLists WHERE Id = '123'
テーブルへの挿入には、NMCLists の名前のみ必要です。
INSERT INTO NMCLists (Name) VALUES ('TestList')
Id を指定することでNMCLists を更新できます。
UPDATE NMCLists SET Name = 'New Name' WHERE Id = '123'
Id を指定することでNMCLists から削除できます。
DELETE FROM NMCLists WHERE Id = '123'
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. |
Create, update, delete, and query New Marketing Campaign Segments in SendGrid.
NMC プレフィックスは、New Marketing Campaign の略です。
すべてのセグメントの取得、またはId でのフィルタが可能です。
SELECT * FROM NMCSegments WHERE Id = '1'
特定の抽出条件によってセグメントはNMCContacts を分割できます。これらの抽出条件を指定するには、QueryDSL フィルタを使用します。
INSERT INTO NMCSegments (Name, QueryDSL) VALUES ("New Segment", "Segment Cdata", "first_name LIKE '%test%'"))
上記のステートメントは、値 "test" を含むFirstName を持つNMCContacts を含んだNMCSegments を作成します。
名前またはコンディションを更新することができます。すべてのセットが上書きされるので、フルセットを指定してください。
UPDATE NMCSegments SET Name = "Name Updated", QueryDSL = "first_name LIKE '%test update%'" WHERE Id = '123'
Id でのみNMCSegments を削除できます。
DELETE FROM NMCSegments WHERE Id = '123'
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. |
Create, update, delete, and query New Marketing Campaign Senders in SendGrid.
NMC は、New Marketing Campaign の略です。
このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM NMCSenders SELECT * FROM NMCSenders WHERE Id = '148825'
挿入には、次のカラムが必須です: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')
Id を指定してNMCSenders を更新することができます。
UPDATE NMCSenders SET Nickname = 'Nickname', FromEmail = 'FromEmail', FromName = 'FromName', ReplytoEmail = 'ReplytoEmail', Address = 'Address', City = 'City', Country = 'Country' WHERE Id = 1310789
Id を指定することでAlerts から削除できます。
DELETE FROM NMCSenders WHERE Id = 1310789
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. |
Create, update, delete, and query the available New Marketing Campaign Single Sends in SendGrid.
NMC は、New Marketing Campaign の略です。
このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM NMCSingleSends SELECT * FROM NMCSingleSends WHERE Id = '148825'
挿入には、次のカラムが必須です:Name。
INSERT INTO NMCSingleSends (Name) VALUES ('SingleSend Name')
Id を指定してNMCSingleSends を更新することができます。
UPDATE NMCSingleSends SET Name = 'SingleSend Updated' WHERE Id = 1310789
Id を指定することでNMCSingleSends から削除できます。
DELETE FROM NMCSingleSends WHERE Id = 1310789
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
The Id of the single send. | |
Name | 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. | |
SenderId | Integer | False |
The ID of the verified sender identity. | |
CustomUnsubscribeUrl | String | False |
The URL allowing contacts to unsubscribe. | |
SuppressionGroupId | Integer | False |
The ID of the suppression group to allow customers to unsubscribe. | |
SendAt | Datetime | False |
The ISO 8601 time at which to send the single send. | |
TemplateId | String | False |
Id of the template used. | |
IpPool | String | False |
The name of the IP pool from which the single send emails appear to be sent. |
Query and delete Spam reports in SendGrid.
このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM Spam SELECT * FROM Spam WHERE Email = '[email protected]'
Delete from Spam
Email を指定することでSpam から削除できます。
DELETE FROM Spam WHERE Email = '[email protected]'
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. |
Query Teammates in SendGrid.
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Teammates WHERE Username = 'test' SELECT * FROM Teammates WHERE Username IN ('test', 'test2')
挿入には、次のカラムが必須です: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')
更新には、次のカラムが必須です: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'
Teammates テーブルからレコードを削除するには、username カラムのみが必要です。次に例を示します。
DELETE FROM Teammates WHERE Username = 'testuser'
Name | Type | ReadOnly | References | Description |
Username [KEY] | String | False |
The username of the teammate. | |
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 |
Create, update, delete, and query Unsubscribe Groups in SendGrid.
UnsubscribeGroups はId によってのみフィルタできます。
SELECT * FROM UnsubscribeGroups WHERE Id = '1'
UnsubscribeGroups に挿入するには、名前と説明を指定します。
INSERT INTO UnsubscribeGroups (Name, Description, IsDefault) VALUES ('Unsubscribe1', 'General Unsubscribe', true)
Id を指定することでUnsubscribeGroups を更新できます。
UPDATE UnsubscribeGroups SET Name = 'New Name', Description = 'New Description' WHERE Id = '1'
Id を指定することでUnsubscribeGroups から削除できます。
DELETE FROM UnsubscribeGroups WHERE Id = '1'
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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
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. |
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. |
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. |
Users | Query the available Users in SendGrid. |
Query the available Categories in SendGrid.
このテーブルをクエリして、SendGrid で使用可能なカテゴリを取得します。
SELECT * FROM Categories
Name | Type | References | Description |
Name | String | The name of the categories. |
Query the available Category Stats in SendGrid.
以下は、CategoryStats ビューをクエリする例です。
SELECT * FROM CategoryStats WHERE Name = 'news'
日付でフィルタをかけることもできます。指定しない場合は、過去1年間のデフォルト期間が適用されます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。
SELECT * FROM CategoryStats WHERE Name = 'news' AND Date > '2016-01-01' AND Date < '2016-01-30'
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. |
Query the available Global Stats in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去1年間のデフォルト期間が適用されます。Date カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM GlobalStats
SELECT * FROM GlobalStats WHERE Date > '2016-01-01' AND Date < '2016-03-30'
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. |
Query group suppressions in SendGrid.
以下は、GroupSuppressions テーブルをクエリする例です。
SELECT * FROM GroupSuppressions WHERE GroupId = 391 SELECT * FROM GroupSuppressions WHERE GroupId IN (391, 392, 393)
Name | Type | References | Description |
GroupId [KEY] | Integer | Email of the unsubscriber. | |
Emails | String | The time the unsubscriber was created. |
Query Global Unsubscribes in SendGrid.
次のクエリのみがサーバーサイドで処理されます。
SELECT * FROM IPAccessManagement
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. |
List of events related to email message in SendGrid.
NOTE: E メールイベントにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。
SELECT * FROM MessageEvents WHERE MessageId = '1234'
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. |
Query Email Activities in SendGrid.
NOTE: E メールアクティビティにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。
Note:API は1000 レコードのみを返します。検索を制限するために、利用可能なフィルタから選択してください。
例えば、次のクエリはサーバーサイドで処理されます。
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'
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. |
Query New Marketing Campaign Contacts in SendGrid.
新しいMarketing Campaign の連絡先はユーザーが管理する受信者です。NMC プレフィックスは、New Marketing Campaign の略です。
すべての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')
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. | |
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. | |
String | This column is dynamic and maps to the corresponding field in the API. | ||
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. |
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. |
Query the available New Marketing Campaign Reserved Fields in SendGrid.
このテーブルは、フィルタリングをサポートしていません。NMC プレフィックスは、New Marketing Campaign の略です。
SELECT * FROM NMCReservedFields
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. |
Query Browser Statistics in SendGrid.
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'
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. |
Query Client Statistics in SendGrid.
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'
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. |
Query Device Statistics in SendGrid.
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'
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. |
Query Location Statistics in SendGrid.
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'
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. |
Query Mailbox Provider Statistics in SendGrid.
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'
Name | Type | References | Description |
Type | String | The type of the statistic. Avaible values (categorie, device, client, mailbox_provider, browser, subuser) | |
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. |
Query Subuser Statistics in SendGrid.
SubuserName でフィルタリングすると、特定のサブユーザーの統計情報を取得できます。
SELECT * FROM SubuserStats WHERE SubuserName = 'Example'
日付でフィルタをかけることもできます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。指定しない場合は、過去1年間のデフォルト期間が適用されます。
SELECT * FROM SubuserStats WHERE SubuserName = 'News' AND Date > '2016-01-01' AND Date < '2016-01-30'
Name | Type | References | Description |
Id [KEY] | String | The Id of the subuser statistic. | |
SubuserName | String | The name of the subuser. | |
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. | |
Name | String | The name of the statistic. | |
Type | String | The type of the statistic. |
Query the available Users in SendGrid.
ユーザーはId によってのみフィルタできます。
SELECT * FROM Users WHERE Id = '1'
Name | Type | References | Description |
Id [KEY] | String | The Id of the user. | |
Address | String | The address of the user. | |
Address2 | String | The secondary address field for the user. | |
City | String | The city of the user. | |
Company | String | The company of the user. | |
Country | String | The country of the user. | |
FirstName | String | The first name of the user. | |
LastName | String | The last name of the user. | |
Phone | String | The phone number of the user. | |
State | String | The state the user is located in. | |
Website | String | The Web site URL of the user. | |
Zip | String | The ZIP code of the user. |
CData Sync App は、レガシーAPI をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。大抵のテーブル、ビュー、およびストアドプロシージャは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
しかし、Recipients テーブルは動的です。Sync App は、SendGrid に接続し、適切なWeb サービスを呼び出してこのテーブルのメタデータを取得します。Recipients テーブルに定義したカスタムフィルタに加えた変更はすべて接続時に利用可能です。これらのカスタムフィルタはWHERE 句内でカラムとして使用できます。これらのカスタムフィルタはCustomFields テーブル内に表示されます。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
従来のデータモデルを使用するには、Schema をLegacy に設定します。
テーブル は、簡単にクエリや更新ができる利用可能なテーブルについて説明します。
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
ストアドプロシージャ は、Sendgrid のファンクションライクなインターフェースです。これらを使用して、情報を検索、更新、および変更できます。
Sync App はSendGrid のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
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. |
Create, update, delete, and query Alerts in SendGrid.
このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM Alerts WHERE Id = '148825'
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)
Id を指定することでEmailTo を更新できます。
UPDATE Alerts SET EmailTo = '[email protected]' WHERE Id = 1310789
Id を指定することでAlerts から削除できます。
DELETE FROM Alerts WHERE Id = 1310789
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). |
Query, Create, Update and Delete the available ApiKeys in SendGrid.
すべてのApi Keys を取得します
SELECT * FROM ApiKeys
特定のApi Key に関する情報を取得します
SELECT * FROM Apikeys WHERE ApiKeyId = 'Dqdvdvdvdv4yLeuVQqO3rFxN5ktUxA'
挿入には、次のカラムが必須です: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')
ApiKeyid を指定することでApiKeys を更新できます。更新を希望しない場合でも、UPDATE 中に名前とスコープの両方を指定する必要があります。
UPDATE Apikeys SET Name = 'apiname2', Scopes = 'alerts.create,alerts.read' WHERE apikeyid = 'Dqdvdvdvdv4yLeuVQqO3rFxN5kscsctUxA-P_Q'
ApiKeyid を指定してApiKeys を削除することができます。
DELETE FROM ApiKeys WHERE apikeyid = 'CMp4C8klscscscsQ0GxqvxtK2-P_Q'
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. |
Query and Delete the available Blocks in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM Blocks WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'
Email を指定することでBlocks から削除できます。
DELETE FROM Blocks WHERE Email = '[email protected]'
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. |
Query and Delete the available Bounces in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去120日間のデフォルト期間が適用されます。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM Bounces WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'
Email を指定することでBounces から削除できます。
DELETE FROM Bounces WHERE Email = '[email protected]'
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. |
Update, delete, and query Cancel Scheduled Sends in SendGrid.
このテーブルはBatchId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM CancelScheduledSends SELECT * FROM CancelScheduledSends WHERE BatchId = 148825
BatchId を指定してCancelScheduledSends を更新することができます。
使用できる値はcancel、pause です。
UPDATE CancelScheduledSends SET Status = 'cancel' WHERE BatchId = 1310789
BatchId を指定することでCancelScheduledSends から削除できます。
DELETE FROM CancelScheduledSends WHERE BatchId = 1310789
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 |
Create, delete, and query Custom Fields in SendGrid.
カスタムフィールドは、ユーザーにより指定された受信者を分類するフィルタです。
すべてのCustomFields の取得、またはId でのフィルタが可能です。
SELECT * FROM CustomFields WHERE Id = '1'
タイプに関係なく、Custom Fields をフィルタするには引用符を使用します。
CustomFields に挿入するには、フィールド名とその種類の指定が必要です。タイプは、text、date、およびnumber が使用できます。
INSERT INTO CustomFields (name, type) VALUES ('age', 'number')
このテーブルは、アップデートをサポートしていません。
Id を指定することでCustomFields から削除できます。
DELETE FROM CustomFields WHERE Id = '1'
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. |
Query Global Unsubscribes in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。ただし、このフィルタは任意です。CreatedAt カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM GlobalUnsubscribes WHERE CreatedAt > '2016-01-01' AND CreatedAt < '2016-01-30'
このテーブルでInsert 操作を行うには、GlobalUnsubscribes リストに追加されるE メールを指定する必要があります。次に例を示します。
INSERT INTO GlobalUnsubscribes (Email) VALUES ('[email protected]')
このテーブルでDelete 操作を行うには、GlobalUnsubscribes リストから削除されるE メールを指定する必要があります。次に例を示します。
DELETE FROM GlobalUnsubscribes WHERE Email = '[email protected]'
Name | Type | ReadOnly | References | Description |
Email [KEY] | String | False |
Email of the unsubscriber. | |
CreatedAt | Datetime | True |
The time the unsubscriber was created. |
Query and Delete invalid emails in SendGrid.
このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM InvalidEmails SELECT * FROM InvalidEmails WHERE Email = '[email protected]'
Email を指定することでInvalidEmails から削除できます。
DELETE FROM InvalidEmails WHERE Email = '[email protected]'
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.. | |
String | False |
The email address that was marked as invalid. |
Create, update, delete, and query the available Lists in SendGrid.
リストテーブルはId によってのみフィルタできます。
SELECT * FROM Lists WHERE Id = '123'
テーブルへの挿入には、リストの名前のみ必要です。
INSERT INTO Lists (Name) VALUES ('TestList')
Id を指定することでLists から更新できます。
UPDATE Lists SET Name = 'New Name' WHERE Id = '123'
Id を指定することでLists から削除できます。
DELETE FROM Lists WHERE Id = '123'
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. |
Create, update, delete, and query Marketing Campaigns in SendGrid.
このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM MarketingCampaigns SELECT * FROM MarketingCampaigns WHERE Id = '1'
挿入は、次のカラムが必須です:Title、Subject、SenderId、ListIds、SegmentIds、Categories、SuppressionGroupId、HtmlContent、およびPlainContent。
CustomUnsubscribeUrl はSuppressionGroupId の代わりに使えます。ただし、SendGrid はSuppressionGroupId の使用を強く推奨しています。
以下のチェックポイントを使って、SenderId および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')
Id を指定することでMarketingCampaigns を更新できます。
UPDATE MarketingCampaigns SET PlainContent = 'Eat healthier' WHERE Id = '123'
Id を指定することでMarketingCampaigns から削除できます。
DELETE FROM MarketingCampaigns WHERE Id = '123'
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. |
The SendGrid table Recipients.
SendGrid はユーザーにより定義されたフィルタでRecipients を分類できます。それに応じて、フィルタを使った検索やそれらのフィルタを挿入するためにRecipients テーブルにステートメントを実行します。しかし、これらのフィルタはカスタムフィールドテーブルの属性として記録されます。
以下のクエリはRecipients テーブルのデフォルトフィールドのみ取得します。作成したカスタムフィールドは取得できません。受信者のカスタムフィールドの値を取得するには、カスタムフィールドテーブルをクエリします。
特定のリスト内またはセグメント内のすべてのRecipients を取得することもできますが、両方でのフィルタはできません。代わりに複数のクエリを使用します:
SELECT * FROM Recipients WHERE SegmentId = '1' SELECT * FROM Recipients WHERE ListId = '2'
カスタムフィールドによって抽出条件を作成できます。タイプに関係なく、クエリでは引用符を使います。この種のフィルタリングはクライアント側で行われます。この場合、Age はユーザーによって作成されたカスタムフィールドです。
SELECT * FROM Recipients WHERE Age = '30'
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)
Id を指定することでこのテーブルから更新できます。また、E メールカラムは更新ができません。
UPDATE Recipients SET Age = '12' WHERE Id = '1'
Id を指定することでこのテーブルから削除できます。
DELETE FROM Recipients WHERE Id = '1'
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. | |
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. |
Create, update, delete, and query Campaign Schedules in SendGrid.
以下は、Schedules テーブルをクエリする例です。
SELECT * FROM Schedules WHERE MarketingCampaignId = '123'
MarketingCampaignId とSendAt を指定すると、特定の時間にキャンペーンを設定できます。SendAt を指定するだけですぐにキャンペーンを送信できます。SendGrid でキャンペーンを送信するには、HTML とプレーンテキストの両コンテンツに [unsubscribe] タグが必要です。
INSERT INTO Schedules (MarketingCampaignId) VALUES (3091692)
INSERT INTO Schedules (MarketingCampaignId, SendAt) VALUES (1, '11/11/2018')
MarketingCampaignId を指定することでスケジュールを更新できます。
UPDATE Schedules SET SendAt = '01-01-2016' WHERE MarketingCampaignId = '123'
MarketingCampaignId を指定することでスケジュールを削除できます。
DELETE FROM Schedules WHERE MarketingCampaignId = '123'
Name | Type | ReadOnly | References | Description |
MarketingCampaignId [KEY] | Integer | True |
Id of the campaign. | |
Status | String | True |
Status of the campaign. | |
SendAt | Datetime | False |
Date to start the campaign. |
Create, update, delete, and query Segments in SendGrid.
すべてのセグメントの取得、またはId でのフィルタが可能です。
SELECT * FROM Segments WHERE Id = '1'
特定の抽出条件によってセグメントは受信者を分割できます。抽出条件を指定するには、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 Segments SET Name = 'Name Updated', ConditionsField1 = 'age', ConditionsOperator1 = '<=', ConditionsAndOr1 = '', ConditionsValue1 = '30' WHERE Id = '123'
Id を指定することでセグメントを削除できます。
DELETE FROM Segments WHERE Id = '123'
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. |
Create, update, delete, and query Sender Identities in SendGrid.
このテーブルはId によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM SenderIdentities SELECT * FROM SenderIdentities WHERE Id = '148825'
挿入には、次のカラムが必須です: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')
Id を指定してSenderIdentities を更新することができます。
UPDATE SenderIdentities SET Nickname = 'Nickname', FromEmail = 'FromEmail', FromName = 'FromName', ReplytoEmail = 'ReplytoEmail', Address = 'Address', City = 'City', Country = 'Country' WHERE Id = 1310789
Id を指定することでAlerts から削除できます。
DELETE FROM SenderIdentities WHERE Id = 1310789
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. |
Query and delete Spam reports in SendGrid.
このテーブルはEmail によるフィルタのみをサポートしています。唯一可能なSELECT クエリは次のとおりです。
SELECT * FROM Spam SELECT * FROM Spam WHERE Email = '[email protected]'
Delete from Spam
Email を指定することでSpam から削除できます。
DELETE FROM Spam WHERE Email = '[email protected]'
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. |
Query Teammates in SendGrid.
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Teammates WHERE Username = 'test' SELECT * FROM Teammates WHERE Username IN ('test', 'test2')
挿入には、次のカラムが必須です: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')
更新には、次のカラムが必須です: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'
Teammates テーブルからレコードを削除するには、username カラムのみが必要です。次に例を示します。
DELETE FROM Teammates WHERE Username = 'testuser'
Name | Type | ReadOnly | References | Description |
Username [KEY] | String | False |
The username of the teammate. | |
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 |
Create, update, delete, and query Unsubscribe Groups in SendGrid.
UnsubscribeGroups はId によってのみフィルタできます。
SELECT * FROM UnsubscribeGroups WHERE Id = '1'
UnsubscribeGroups に挿入するには、名前と説明を指定します。
INSERT INTO UnsubscribeGroups (Name, Description, IsDefault) VALUES ('Unsubscribe1', 'General Unsubscribe', true)
Id を指定することでUnsubscribeGroups を更新できます。
UPDATE UnsubscribeGroups SET Name = 'New Name', Description = 'New Description' WHERE Id = '1'
Id を指定することでUnsubscribeGroups から削除できます。
DELETE FROM UnsubscribeGroups WHERE Id = '1'
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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
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. |
MessageEvents | List of events related to email message in SendGrid. |
Messages | Query Email Activities 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. |
Users | Query the available Users in SendGrid. |
Query the available Categories in SendGrid.
このテーブルをクエリして、SendGrid で使用可能なカテゴリを取得します。
SELECT * FROM Categories
Name | Type | References | Description |
Name | String | The name of the categories. |
Query the available Category Stats in SendGrid.
以下は、CategoryStats ビューをクエリする例です。
SELECT * FROM CategoryStats WHERE Name = 'news'
日付でフィルタをかけることもできます。指定しない場合は、過去1年間のデフォルト期間が適用されます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。
SELECT * FROM CategoryStats WHERE Name = 'news' AND Date > '2016-01-01' AND Date < '2016-01-30'
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. |
Query the available Global Stats in SendGrid.
このテーブルからデータを取得する期間を指定する必要があります。指定しない場合は、過去1年間のデフォルト期間が適用されます。Date カラムは、>、<、=、<=、および>= 演算子をサポートします。
SELECT * FROM GlobalStats
SELECT * FROM GlobalStats WHERE Date > '2016-01-01' AND Date < '2016-03-30'
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. |
Query group suppressions in SendGrid.
以下は、GroupSuppressions テーブルをクエリする例です。
SELECT * FROM GroupSuppressions WHERE GroupId = 391 SELECT * FROM GroupSuppressions WHERE GroupId IN (391, 392, 393)
Name | Type | References | Description |
GroupId [KEY] | Integer | Email of the unsubscriber. | |
Emails | String | The time the unsubscriber was created. |
Query Global Unsubscribes in SendGrid.
次のクエリのみがサーバーサイドで処理されます。
SELECT * FROM IPAccessManagement
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. |
List of events related to email message in SendGrid.
NOTE: E メールイベントにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。
SELECT * FROM MessageEvents WHERE MessageId = '1234'
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. |
Query Email Activities in SendGrid.
NOTE: E メールアクティビティにアクセスする場合は、SendGrid のEmail Activity History アドインを購入する必要があります。Restricted Access のキーを使用する場合は、messages.read およびemail_activity.read スコープを与える必要があります。
Note:API は1000 レコードのみを返します。検索を制限するために、利用可能なフィルタから選択してください。
例えば、次のクエリはサーバーサイドで処理されます。
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'
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. |
Query the available Reserved Fields in SendGrid.
このテーブルは、フィルタリングをサポートしていません。
SELECT * FROM ReservedFields
Name | Type | References | Description |
Name | String | The name of the reserved field. | |
Type | String | The type of the reserved field. |
Query Browser Statistics in SendGrid.
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'
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. |
Query Client Statistics in SendGrid.
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'
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. |
Query Device Statistics in SendGrid.
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'
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. |
Query Location Statistics in SendGrid.
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'
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. |
Query Mailbox Provider Statistics in SendGrid.
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'
Name | Type | References | Description |
Type | String | The type of the statistic. Avaible values (categorie, device, client, mailbox_provider, browser, subuser) | |
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. |
Query Subuser Statistics in SendGrid.
SubuserName でフィルタリングすると、特定のサブユーザーの統計情報を取得できます。
SELECT * FROM SubuserStats WHERE SubuserName = 'Example'
日付でフィルタをかけることもできます。このカラムでは=、>=、<=、<、および> 演算子がサポートされています。指定しない場合は、過去1年間のデフォルト期間が適用されます。
SELECT * FROM SubuserStats WHERE SubuserName = 'News' AND Date > '2016-01-01' AND Date < '2016-01-30'
Name | Type | References | Description |
Id [KEY] | String | The Id of the subuser statistic. | |
SubuserName | String | The name of the subuser. | |
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. | |
Name | String | The name of the statistic. | |
Type | String | The type of the statistic. |
Query the available Users in SendGrid.
ユーザーはId によってのみフィルタできます。
SELECT * FROM Users WHERE Id = '1'
Name | Type | References | Description |
Id [KEY] | String | The Id of the user. | |
Address | String | The address of the user. | |
Address2 | String | The secondary address field for the user. | |
City | String | The city of the user. | |
Company | String | The company of the user. | |
Country | String | The country of the user. | |
FirstName | String | The first name of the user. | |
LastName | String | The last name of the user. | |
Phone | String | The phone number of the user. | |
State | String | The state the user is located in. | |
Website | String | The Web site URL of the user. | |
Zip | String | The ZIP code of the user. |
プロパティ | 説明 |
APIKey | 現在の認証ユーザーのAPI キー。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Schema | 使用するスキーマの種類。 |
プロパティ | 説明 |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
現在の認証ユーザーのAPI キー。
現在の認証ユーザーのAPI キー。これは、SendGrid Sync App を介して認証するために必須のパラメータです。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
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 プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はSendGrid への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Schema | 使用するスキーマの種類。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
Note: このSync App は複数のスキーマをサポートするため、SendGrid カスタムスキーマファイルの構造は以下のようになります。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\SendGrid Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用するスキーマの種類。
利用可能なスキーマはNMC およびLegacy です。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
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.
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM MarketingCampaigns WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。