CData Sync App は、Mailchimp データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Mailchimp コネクタはCData Sync アプリケーションから使用可能で、Mailchimp からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、Core Mailchimp API のバージョン3 をデフォルトとしています。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Mailchimp は、次の認証メソッドをサポートしています:
Mailchimp に接続する最も簡単な方法は、API キーを使用する方法です。APIKey はMailchimp アカウントへのフルアクセスを許可します。APIKey を取得するには:
API キーの値が取得できたら:
認証用のクライアントId およびクライアントシークレットを含むカスタムアプリケーションを作成する必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。
接続の前に、以下の変数を設定します。
Mailchimp への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
ドライバーは、以下のようにOAuth プロセスを完了します。
Mailchimp への接続に使用できる認証方法は2つあります。APIKey を使うか、OAuth を使います。
OAuth を使って、他のユーザーが自身の情報にアクセスできるようにします。また、次のような場合にも有用です。
カスタムOAuth アプリケーションをMailchimp に登録してOAuth クライアントクレデンシャル、OAuthClientId、およびOAuthClientSecret を取得するには:
Web アプリケーションの場合は、アプリケーションへの権限付与後にユーザーをリダイレクトさせたいURL を入力します。
カスタムOAuth アプリを作成して登録したのち、ユーザーは「Mailchimp への接続」で説明するようにMailchimp に接続できます。
このセクションでは、Mailchimp Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
データモデルは3つのパートに分かれています。テーブル、ビュー、およびストアドプロシージャです。 このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
CData Sync App は、Mailchimp API をテーブル にモデル化し、標準SQL でのクエリおよび更新を容易にします。
Sync App は接続時にListMembers テーブルのカスタムフィールドを動的に取得します。新しいカスタムフィールドの追加や、カスタムフィールドのデータ型の変更など、カスタムフィールドへのあらゆる変更は、再接続時に自動的に反映されます。
Along with the default static tables, the Sync App also allows querying on dynamic tables. These are tables that are created based on the "audiences" (also called "lists") in your Mailchimp account.
For example, suppose you have these 3 audiences in your account: Old Audience, New Audience, VIP Audience. For each of these audiences the Sync App creates 2 new tables: One starting with "ListMembers_" and the other with "ListMergeFields_". So, for the case in hand, these 6 tables will be created:
Tables starting with "ListMembers_" display all members for a specific audience along with custom fields' values.
The ones starting with "ListMergeFields_" display all custom fields' names for members in that audience.
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
Along with the default static views, the Sync App also allows querying on dynamic views. These are views that are created based on the "audiences" (also called "lists") in your Mailchimp account.
For example, suppose you have these 3 audiences in your account: Old Audience, New Audience, VIP Audience. The Sync App lists 3 views based on them: ListMemberTags_OldAudience, ListMemberTags_NewAudience, ListMemberTags_VIPAudience.
The above 3 views are created by removing spaces from the audience's name and appending the result to "ListMemberTags" with an underscore. They return the tags that are assigned to each member of the audience you've specified.
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Sync App はMailchimp のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| CampaignFeedback | A summary of the comment feedback for a specific campaign. |
| CampaignFolders | Folders for organizing campaigns |
| Campaigns | A summary of the campaigns within an account. |
| EcommerceCartLines | A list of an ecommerce cart's lines. |
| EcommerceCarts | A list of an account's ecommerce carts. |
| EcommerceCustomers | A list of an account's ecommerce customers. |
| EcommerceOrderLines | A list of an ecommerce order's lines. |
| EcommerceOrders | A list of an account's ecommerce orders. |
| EcommerceProducts | A list of an account's ecommerce products. |
| EcommerceProductVariants | A list of an ecommerce product's variants. |
| FileManagerFiles | A listing of all avaialable images and files within an account's gallery. |
| FileManagerFolders | A listing of all avaialable folders within an account's gallery. |
| ListInterestCategories | A listing of this list's interest categories. |
| ListInterests | A list of this category's interests |
| ListMemberEvents | Events information for a specific list. |
| ListMemberNotes | The last 10 notes for a specific list member, based on date created. |
| ListMembers | Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed. |
| ListMergeFields | The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles. |
| Lists | A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization. |
| ListSegmentMembers | Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed. |
| ListSegments | A list of available segments. |
| ListsWebhooks | Webhooks configured for the given list. |
| TemplateFolders | Folders for organizing templates |
| Templates | A list an account's available templates. |
A summary of the comment feedback for a specific campaign.
CampaignFeedback ではSELECT、INSERT、UPDATE、およびDELTE がサポートされています。
SELECT * FROM CampaignFeedback
INSERT にはCampaignId とMessage を指定する必要があります。
INSERT INTO CampaignFeedback (CampaignId, Message) VALUES ('myCampaignId', 'myMessage')
| Name | Type | ReadOnly | Description |
| FeedbackId [KEY] | Integer | True |
The individual id for the feedback item. |
| ParentId | Integer | True |
If a reply, the id of the parent feedback item. |
| BlockId | Integer | False |
The block id for the editable block that the feedback addresses. |
| Message | String | False |
The content of the feedback. |
| IsComplete | Boolean | False |
The status of feedback. |
| CreatedBy | String | True |
The login name of the user who created the feedback. |
| CreatedAt | Datetime | True |
The date and time the feedback item was created. |
| UpdatedAt | Datetime | True |
The date and time the feedback was last updated. |
| Source | String | True |
The source of the feedback ('email', 'sms', 'web', 'ios', 'android', or 'api'). |
| CampaignId [KEY] | String | False |
The unique id for the campaign. |
Folders for organizing campaigns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifieds this campaign folder |
| Name | String | False |
The name of the folder |
| Count | Integer | True |
The number of campaigns in the folder |
A summary of the campaigns within an account.
Campaigns では、SELECT、UPDATE、およびDELETE がサポートされています。
UPDATE Campaigns SET Settings_Title = "Test" WHERE Id = "1234"
UPDATE Campaigns SET Recipients_SegmentOpts = "{"match":"any","saved_segment_id":314699}" WHERE Id = "cfb12c2228"
UPDATE Campaigns SET Settings_Title = "Test", Recipients_ListId = "1234", RssOpts_FeedUrl = "exampleUrl", Type = "rss", RssOpts_Frequency = "daily" WHERE Id = "1234"
Note: UPDATE operation cannot be performed on already SENT campaigns. Also, the type of a campaign cannot be updated once it is set. Depending on the campaign type, specific options can be updateable only for specific campaign types. For example: If a campaign is of type "rss" then only the Rss Options fields can be updateable for this campaign. Variant and AbSplitOps settings will not be updateable in this case.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifies this campaign. |
| Type | String | False |
The type of campaign (regular, plaintext, absplit, or rss). |
| CreateTime | Datetime | True |
The date and time the campaign was created. |
| ArchiveUrl | String | True |
The link to the campaign's archive version. |
| LongArchiveUrl | String | True |
The original link to the campaign's archive version. |
| Status | String | True |
The current status of the campaign ('save', 'paused', 'schedule', 'sending', 'sent'). |
| EmailsSent | Integer | True |
The total number of emails sent for this campaign. |
| SendTime | Datetime | True |
The time and date a campaign was sent. |
| ContentType | String | False |
How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). |
| Recipients_ListId | String | False |
The id of the list. |
| Recipients_ListName | String | True |
The name of the list. |
| Recipients_SegmentText | String | False |
A string marked-up with HTML explaining the segment used for the campaign in plain English. |
| Recipients_RecipientCount | Integer | True |
Count of the recipients on the associated list. Formatted as an integer |
| Recipients_SegmentOpts | String | False |
Segment options. |
| Settings_SubjectLine | String | False |
The subject line for the campaign. |
| Settings_Title | String | False |
The title of the campaign. |
| Settings_FromName | String | False |
The 'from' name on the campaign (not an email address). |
| Settings_ReplyTo | String | False |
The reply-to email address for the campaign. |
| Settings_UseConversation | Boolean | False |
Use MailChimp Conversation feature to manage out of office replies. |
| Settings_ToName | String | False |
The campaign's custom 'to' name. Typically something like the first name merge var. |
| Settings_FolderId | String | False |
If the campaign is listed in a folder, the id for that folder. |
| Settings_Authenticate | Boolean | False |
Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'. |
| Settings_AutoFooter | Boolean | False |
Automatically append MailChimp's default footer to the campaign. |
| Settings_InlineCss | Boolean | False |
Automatically inline the CSS included with the campaign content. |
| Settings_AutoTweet | Boolean | False |
Automatically tweet a link to the campaign archive page when the campaign is sent. |
| Settings_AutoFbPost | String | False |
An array of Facebook page ids to auto-post to. |
| Settings_FbComments | Boolean | False |
Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'. |
| Settings_Timewarp | Boolean | True |
Send this campaign using 'timewarp.' For more info, see the Knowledge Base article: http://eepurl.com/iAgs |
| Settings_TemplateId | Integer | False |
The id for the template used in this campaign. |
| Settings_DragAndDrop | Boolean | True |
Whether the campaign uses the drag-and-drop editor. |
| VariateSettings_WinningCombinationId | String | True |
ID of the combination that was chosen as the winner |
| VariateSettings_WinningCampaignId | String | True |
ID of the campaign that was sent to the remaining recipients based on the winning combination |
| VariateSettings_WinnerCriteria | String | False |
How the winning campaign will be chosen |
| VariateSettings_WaitTime | Integer | False |
The number of minutes to wait before the winning campaign is picked |
| VariateSettings_TestSize | Integer | False |
The percentage of subscribers to send the test combinations to, from 10 to 100 |
| VariateSettings_SubjectLines | String | False |
Possible subject lines |
| VariateSettings_SendTimes | String | False |
Possible send times |
| VariateSettings_FromNames | String | False |
Possible from names |
| VariateSettings_ReplyToAddresses | String | False |
Possible reply To addresses |
| VariateSettings_Contents | String | True |
Descriptions of possible email contents |
| VariateSettings_Combinations | String | True |
Combinations of possible variables that were used to build emails |
| Tracking_Opens | Boolean | False |
Whether to track opens. Defaults to 'true'. |
| Tracking_HtmlClicks | Boolean | False |
Whether to track clicks in the HTML version of the campaign. Defaults to 'true'. |
| Tracking_TextClicks | Boolean | False |
Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'. |
| Tracking_GoalTracking | Boolean | False |
Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH |
| Tracking_Ecomm360 | Boolean | False |
Whether to enable eCommerce360 tracking. |
| Tracking_GoogleAnalytics | String | False |
The custom slug for Google Analytics tracking (max of 50 bytes). |
| Tracking_Clicktale | String | False |
The custom slug for ClickTale Analytics tracking (max of 50 bytes). |
| Tracking_Salesforce | String | False |
Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration. |
| Tracking_Highrise | String | False |
Highrise tracking options for a campaign. Must be using MailChimp's built-in Highrise integration. |
| Tracking_Capsule | String | False |
Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration. |
| RssOpts_FeedUrl | String | False |
The URL for the RSS feed. |
| RssOpts_Frequency | String | False |
The frequency of the RSS-to-Email campaign ('daily', 'weekly', 'monthly'). |
| RssOpts_Schedule | String | False |
The schedule for sending the RSS campaign. |
| RssOpts_LastSent | String | True |
The date the campaign was last sent. |
| RssOpts_ConstrainRssImg | Boolean | False |
If true we will add css to images in the rss feed to constrain their width in the campaign content. |
| AbSplitOpts_SplitTest | String | False |
The type of AB split to run ('subject', 'from_name', or 'schedule'). |
| AbSplitOpts_PickWinner | String | False |
How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. |
| AbSplitOpts_WaitUnits | String | False |
How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. |
| AbSplitOpts_WaitTime | Integer | False |
The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. |
| AbSplitOpts_SplitSize | Integer | False |
The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. Ex. A 10% split would result in two groups of 10% of the subscribers plus a winner sending to the remaining 80%. |
| AbSplitOpts_FromNameA | String | False |
For campaigns split on 'From Name', the name for Group A. |
| AbSplitOpts_FromNameB | String | False |
For campaigns split on 'From Name', the name for Group B. |
| AbSplitOpts_ReplyEmailA | String | False |
For campaigns split on 'From Name', the reply-to address for Group A. |
| AbSplitOpts_ReplyEmailB | String | False |
For campaigns split on 'From Name', the reply-to address for Group B. |
| AbSplitOpts_SubjectA | String | False |
For campaings split on 'Subject Line', the subject line for Group A. |
| AbSplitOpts_SubjectB | String | False |
For campaings split on 'Subject Line', the subject line for Group B. |
| AbSplitOpts_SendTimeA | Datetime | False |
The send time for Group A. |
| AbSplitOpts_SendTimeB | Datetime | False |
The send time for Group B. |
| AbSplitOpts_SendTimeWinner | Datetime | False |
The send time for the winning version. |
| SocialCard_ImageUrl | String | False |
The url for the header image for the card. |
| SocialCard_Description | String | False |
A short summary of the campaign to display. |
| SocialCard_Title | String | False |
The title for the card. Typically the subject line of the campaign. |
| ReportSummary | String | False |
For sent campaigns, a summary of opens, clicks, and unsubscribes. |
| DeliveryStatus | String | False |
Updates on campaigns in the process of sending. |
A list of an ecommerce cart's lines.
The Sync App will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
The StoreId can be retrieved by selecting the ECommerceStores view.
SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' SELECT * FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' and Id = '88'
Note : API will throw error if the cart contains only one line item. You will have to delete the cart to delete all the lines.
DELETE FROM EcommerceCartLines WHERE StoreId = 'Test_Store123' and CartId = '44' and Id = '88'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| CartId [KEY] | String | False |
The CartId for the table. |
| Id [KEY] | String | False |
A unique identifier for the cart line item. |
| ProductId | String | False |
A unique identifier for the product associated with the cart line item. |
| ProductTitle | String | True |
The name of the product for the cart line item. |
| ProductVariantId | String | False |
A unique identifier for the product variant associated with the cart line item. |
| ProductVariantTitle | String | True |
The name of the product variant for the cart line item. |
| Quantity | Integer | False |
The quantity of a cart line item. |
| Price | Decimal | False |
The price of a cart line item. |
A list of an account's ecommerce carts.
The Sync App will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
The StoreId can be retrieved by selecting the ECommerceStores view.
SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123' SELECT * FROM EcommerceCarts WHERE StoreId = 'Test_Store123' and Id = '44'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| Id [KEY] | String | False |
A unique identifier for the cart. |
| Customer | String | False |
Information about a specific customer. Carts for existing customers should include only the id parameter in the customer object body. |
| CampaignId | String | False |
A string that uniquely identifies the campaign associated with a cart. |
| CheckoutUrl | String | False |
The URL for the cart. |
| CurrencyCode | String | False |
The three-letter ISO 4217 code for the currency that the cart uses. |
| OrderTotal | Decimal | False |
The order total for the cart. |
| TaxTotal | Decimal | False |
The total tax for the cart. |
| Lines | String | False |
An array of the cart's line items. The column will not work for Update. Lines can be updated using EcommerceCartLines table. |
| CreatedAt | Datetime | True |
The date and time when the cart was created. |
| UpdatedAt | Datetime | True |
The date and time when the cart was last updated. |
A list of an account's ecommerce customers.
The Sync App will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
The StoreId can be retrieved by selecting the ECommerceStores view.
SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123' SELECT * FROM EcommerceCustomers WHERE StoreId = 'Test_Store123' and Id = '44'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| Id [KEY] | String | False |
A unique identifier for the customer. |
| EmailAddress | String | False |
The customer's email address. |
| OptInStatus | Boolean | False |
The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing MailChimp list member, but will apply to list members that are added through the e-commerce API endpoints. |
| Company | String | False |
The customer's company. |
| FirstName | String | False |
The customer's first name. |
| LastName | String | False |
The customer's last name. |
| OrdersCount | Integer | True |
The customer's total order count. |
| TotalSpent | Decimal | True |
The total amount the customer has spent. |
| Address_Address1 | String | False |
The mailing address of the customer. |
| Address_Address2 | String | False |
An additional field for the customer's mailing address. |
| Address_City | String | False |
The city the customer is located in. |
| Address_Province | String | False |
The customer's state name or normalized province. |
| Address_ProvinceCode | String | False |
The two-letter code for the customer's province or state. |
| Address_PostalCode | String | False |
The customer's postal or zip code. |
| Address_Country | String | False |
The customer's country. |
| Address_CountryCode | String | False |
The two-letter code for the customer's country. |
| CreatedAt | Datetime | True |
The date and time the customer was created. |
| UpdatedAt | Datetime | True |
The date and time the customer was last updated. |
A list of an ecommerce order's lines.
The Sync App will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
The StoreId can be retrieved by selecting the ECommerceStores view.
SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' SELECT * FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' and Id = '88'
Note : API will throw error if the Order contains only one line item. You will have to delete the order to delete all the lines.
DELETE FROM EcommerceOrderLines WHERE StoreId = 'Test_Store123' and OrderId = '44' and Id = '88'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| OrderId [KEY] | String | False |
The OrderId for the table. |
| Id [KEY] | String | False |
A unique identifier for the order line item. |
| ProductId | String | False |
A unique identifier for the product associated with the order line item. |
| ProductTitle | String | True |
The name of the product for the order line item. |
| ProductVariantId | String | False |
A unique identifier for the product variant associated with the order line item. |
| ProductVariantTitle | String | True |
The name of the product variant for the order line item. |
| Quantity | Integer | False |
The quantity of an order line item. |
| Price | Decimal | False |
The price of an ecommerce order line item. |
A list of an account's ecommerce orders.
The Sync App will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
The StoreId can be retrieved by selecting the ECommerceStores view.
SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123' SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123' and Id = '44'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| Id [KEY] | String | False |
A unique identifier for the order. |
| Customer | String | False |
Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body. |
| CampaignId | String | False |
A string that uniquely identifies the campaign associated with an order. |
| FinancialStatus | String | False |
The order status. For example: `refunded`, `processing`, `cancelled`, etc. |
| FulfillmentStatus | String | False |
The fulfillment status for the order. For example: `partial`, `fulfilled`, etc. |
| CurrencyCode | String | False |
The three-letter ISO 4217 code for the currency that the store accepts. |
| OrderTotal | Decimal | False |
The order total for the order. |
| TaxTotal | Decimal | False |
The tax total for the order. |
| ShippingTotal | Decimal | False |
The shipping total for the order. |
| TrackingCode | String | False |
The MailChimp tracking code for the order. Uses the 'mc_tc' parameter in eCommerce360-enabled tracking urls. |
| ProcessedAtForeign | Datetime | False |
The date and time the order was processed. |
| CancelledAtForeign | Datetime | False |
The date and time the order was cancelled. |
| UpdatedAtForeign | Datetime | False |
The date and time the order was updated. |
| ShippingAddress_Name | String | False |
The name associated with an order's shipping address. |
| ShippingAddress_Address1 | String | False |
The shipping address for the order. |
| ShippingAddress_Address2 | String | False |
An additional field for the shipping address. |
| ShippingAddress_City | String | False |
The city in the order's shipping address. |
| ShippingAddress_Province | String | False |
The state or normalized province in the order's shipping address. |
| ShippingAddress_ProvinceCode | String | False |
The two-letter code for the province or state the order's shipping address is located in. |
| ShippingAddress_PostalCode | String | False |
The postal or zip code in the order's shipping address. |
| ShippingAddress_Country | String | False |
The country in the order's shipping address. |
| ShippingAddress_CountryCode | String | False |
The two-letter code for the country in the shipping address. |
| ShippingAddress_Longitude | Double | False |
The longitude for the shipping address location. |
| ShippingAddress_Latitude | Double | False |
The latitude for the shipping address location. |
| ShippingAddress_Phone | String | False |
The phone number for the order's shipping address |
| ShippingAddress_Company | String | False |
The company associated with an order's shipping address. |
| BillingAddress_Name | String | False |
The name associated with an order's billing address. |
| BillingAddress_Address1 | String | False |
The billing address for the order. |
| BillingAddress_Address2 | String | False |
An additional field for the billing address. |
| BillingAddress_City | String | False |
The city in the billing address. |
| BillingAddress_Province | String | False |
The state or normalized province in the billing address. |
| BillingAddress_ProvinceCode | String | False |
The two-letter code for the province or state in the billing address. |
| BillingAddress_PostalCode | String | False |
The postal or zip code in the billing address. |
| BillingAddress_Country | String | False |
The country in the billing address. |
| BillingAddress_CountryCode | String | False |
The two-letter code for the country in the billing address. |
| BillingAddress_Longitude | Double | False |
The longitude for the billing address location. |
| BillingAddress_Latitude | Double | False |
The latitude for the billing address location. |
| BillingAddress_Phone | String | False |
The phone number for the billing address. |
| BillingAddress_Company | String | False |
The company associated with the billing address. |
| Lines | String | False |
An array of the order's line items. The column will not work for Update. Lines can be updated using EcommerceOrderLines table. |
A list of an account's ecommerce products.
The Sync App will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
The StoreId can be retrieved by selecting the ECommerceStores view.
SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123' SELECT * FROM EcommerceProducts WHERE StoreId = 'Test_Store123' and Id = '44'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| Id [KEY] | String | False |
A unique identifier for the product. |
| Title | String | False |
The title of a product. |
| Handle | String | False |
The handle of a product. |
| Url | String | False |
The URL of a product. |
| Description | String | False |
The description of a product. |
| Type | String | False |
The type of product. |
| Vendor | String | False |
The vendor for a product. |
| ImageUrl | String | False |
The image URL for a product. |
| Variants | String | False |
An array of the product's variants. |
| PublishedAtForeign | Datetime | False |
The date and time when the product was published. |
A list of an ecommerce product's variants.
The Sync App will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Sync App.
The StoreId can be retrieved by selecting the ECommerceStores view.
SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' SELECT * FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' and Id = '88'
Note : API will throw error if the Product contains only one variant. You will have to delete the product to delete all the variants.
DELETE FROM EcommerceProductVariants WHERE StoreId = 'Test_Store123' and ProductId = '44' and Id = '88'
| Name | Type | ReadOnly | Description |
| StoreId [KEY] | String | False |
The StoreId for the table. |
| ProductId [KEY] | String | False |
The ProductId for the table. |
| Id [KEY] | String | False |
A unique identifier for the product variant. |
| Title | String | False |
The title of a product variant. |
| Url | String | False |
The URL of a product variant. |
| Sku | String | False |
The stock keeping unit (SKU) of a product variant. |
| Price | Decimal | False |
The price of a product variant. |
| InventoryQuantity | Integer | False |
The inventory quantity of a product variant. |
| ImageUrl | String | False |
The image URL for a product variant. |
| Backorders | String | False |
The backorders of a product variant. |
| Visibility | String | False |
The visibility of a product variant. |
| CreatedAt | Datetime | True |
The date and time when the product was created. |
| UpdatedAt | Datetime | True |
The date and time the product was last updated. |
A listing of all avaialable images and files within an account's gallery.
FileManagerFiles ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
SELECT * FROM FileManagerFiles
INSERT には、Name、FolderId、およびFileData を指定する必要があります。
INSERT INTO FileManagerFiles (Name, FolderID, FileData) VALUES ('myNewFolder', 'myFolderID', 'myBase64EncodedFileData')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique id given to the file. |
| FolderId | Integer | False |
The id of the folder. |
| Type | String | True |
The type of file in the gallery: Image or file. |
| Name | String | False |
The name of the file. |
| FullSizeUrl | String | True |
The url of the full-size file. |
| ThumbnailUrl | String | True |
The url of the thumbnail preview. |
| Size | Integer | True |
The size of the file in bytes. |
| CreatedAt | Datetime | True |
The date and time a file was added to the gallery. |
| CreatedBy | String | True |
The username of the profile that uploaded the file. |
| Width | Integer | True |
The width of the image. |
| Height | Integer | True |
The height of an image. |
| FileData | String | False |
When adding a new file, the base64-encoded file. Required for INSERT statement. |
A listing of all avaialable folders within an account's gallery.
FileManagerFiles ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
INSERT には、Name を指定する必要があります。
INSERT INTO FileManagerFolders (Name) VALUES ('myNewFolder'')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique id given to the folder. |
| Name | String | False |
The name of the folder. |
| FileCount | Integer | True |
The number of files within the folder. |
| CreatedAt | Datetime | True |
The date and time a file was added to the gallery. |
| CreatedBy | String | True |
The username of the profile that created the folder. |
A listing of this list's interest categories.
ListInterestCategories ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
SELECT * FROM ListInterestCategories WHERE ListId = 'abc'
INSERT にはTitle、Type、およびListId を指定する必要があります。
INSERT INTO ListInterestCategories (Name, Type, ListID) VALUES ('myNewListInterestCategory', 'myType', 'myListID')
| Name | Type | ReadOnly | Description |
| ListId [KEY] | String | False |
The ID for the list that this category belongs to. |
| Id [KEY] | String | True | |
| Title | String | False |
The text description of this category. This field is displayed on signup forms and is often phrased as a question. |
| DisplayOrder | Integer | False |
Order in which the categories display in the list. Lower numbers display first. |
| Type | String | False |
Determines how this category's interests are displayed on signup forms. |
A list of this category's interests
ListInterests ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
SELECT * FROM ListInterests WHERE ListId = 'abc'
INSERT にはTitle、CategoryId、およびListId を指定する必要があります。
INSERT INTO ListInterests (Name, CategoryId, ListID) VALUES ('myNewListInterest', 'myCategory', 'myListID')
| Name | Type | ReadOnly | Description |
| CategoryId [KEY] | String | False |
The id for the interest category. |
| ListId [KEY] | String | False |
The ID for the list that this interest belongs to. |
| Id [KEY] | String | True |
The ID for the interest. |
| Name | String | False |
The name of the interest. This can be shown publicly on a subscription form. |
| SubscriberCount | String | True |
The number of subscribers associated with this interest. |
| DisplayOrder | Integer | False |
Order in which the interests display. |
Events information for a specific list.
SELECT and INSERT are supported for ListMemberEvents.
SELECT * FROM ListMemberEvents
Name column is required when INSERTing.
| Name | Type | ReadOnly | Description |
| Name | String | False |
The name of the event. |
| OccurredAt | Datetime | False |
The occurred datetime of the event. |
| Properties | String | False |
Properties of the event in an aggregate JSON Format. |
| ListId [KEY] | String | False |
The unique id for the list. |
| MemberId [KEY] | String | False |
The MD5 hash of the list member's email address. |
The last 10 notes for a specific list member, based on date created.
ListMemberNotes ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
SELECT * FROM ListMemberNotes
INSERT の際は必要なフィールドはありません。
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The note's ID. |
| CreatedAt | Datetime | True |
The date the note was created. |
| CreatedBy | String | True |
The author of the note. |
| UpdatedAt | Datetime | True |
The date the note was last updated |
| Note | String | False |
The content of the note. |
| ListId [KEY] | String | False |
The unique id for the list. |
| MemberId [KEY] | String | False |
The MD5 hash of the list member's email address. |
Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
SELECT, INSERT, UPDATE, and DELETE are supported for ListMembers.
SELECT * FROM ListMembers
The ListId, EmailAddress, and Status are required for INSERTs.
INSERT INTO ListMembers (ListId, EmailAddress, Status) VALUES ('myListId', 'myEmailAddress', 'subscribed')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The MD5 hash of the list member's email address. |
| EmailAddress | String | False |
Email address for a subscriber. |
| UniqueEmailId [KEY] | String | True |
An identifier for the address across all of MailChimp. |
| EmailType | String | False |
Type of email this member asked to get ('html' or 'text'). |
| FullName | String | True |
The contact's full name. |
| Status | String | False |
Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', 'pending' or 'transactional'). 使用できる値は次のとおりです。subscribed, unsubscribed, cleaned, prending, transactional |
| StatusIfNew | String | False |
Subscriber's status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'), to be used only on a PUT request if the email is not already present on the list. |
| Interests | String | False |
The key of this object's properties is the ID of the interest in question. |
| Stats_AvgOpenRate | Double | True |
A subscriber's average open rate. |
| Stats_AvgClickRate | Double | True |
A subscriber's average clickthrough rate. |
| IpSignup | String | False |
IP address the subscriber signed up from. |
| TimestampSignup | Datetime | False |
Date and time the subscriber signed up for the list. |
| IpOpt | String | False |
IP address the subscriber confirmed their opt-in status. |
| TimestampOpt | Datetime | False |
Date and time the subscribe confirmed their opt-in status. |
| MemberRating | Integer | True |
Star rating for this member between 1 and 5. |
| LastChanged | Datetime | True |
Date and time the member's info was last changed. |
| Language | String | False |
If set/detected, the language of the subscriber. |
| Vip | Boolean | False |
VIP status for subscriber. |
| EmailClient | String | True |
The email client the address as using. |
| Location_Latitude | Double | False | |
| Location_Longitude | Double | False | |
| Location_Gmtoff | Integer | True | |
| Location_Dstoff | Integer | True | |
| Location_CountryCode | String | True | |
| Location_Timezone | String | True | |
| LastNote_NoteId | Integer | True |
The note's ID. |
| LastNote_CreatedAt | String | True |
The date the note was created. |
| LastNote_CreatedBy | String | True |
The author of the note. |
| LastNote_Note | String | True |
The content of the note. |
| ListId [KEY] | String | False |
The id for the list. |
| TagsAggregate | String | False |
Tags of the member, displayed as an aggregate. |
The merge field (formerly merge vars) for a given list. These correspond to merge fields in MailChimp's lists and subscriber profiles.
ListMergeFields ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
SELECT * FROM ListMergeFields WHERE ListId = 'abc'
INSERT にはName とListId を指定する必要があります。
INSERT INTO ListMergeFields (Name, ListID) VALUES ('myNewListMergeField', 'myListID')
| Name | Type | ReadOnly | Description |
| MergeId [KEY] | Integer | True |
An unchanging id for the merge field. |
| Tag | String | False |
The tag used in MailChimp campaigns and for the /members endpoint. |
| Name | String | False | |
| Type | String | False |
The type for the merge field. |
| Required | Boolean | False |
Boolean value for if the merge field is required |
| DefaultValue | String | False |
The default value for the merge field if null. |
| Public | Boolean | False |
Whether or not the merge field is displayed on the signup form. |
| DisplayOrder | Integer | False |
The order on the form where the merge field is displayed. |
| Options_DefaultCountry | Integer | False |
In an address field, the default country code if none supplied. |
| Options_PhoneFormat | String | False |
In a phone field, the phone number type: US or International. |
| Options_DateFormat | String | False |
In a date or birthday field, the format of the date. |
| Options_Choices | String | False |
In a radio or dropdown non-group field, the available options for members to pick from. |
| Options_Size | Integer | False |
In a text field, the default length of the text field. |
| HelpText | String | False |
Any extra text to help the subscriber. |
| ListId [KEY] | String | False |
A string that identifies this merge field collections' list. |
A collection of subscriber lists associated with this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization.
Lists ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
INSERT には、Name、PermissionReminder、EmailTypeOption、Contact_Company、Contact_Address1、Contact_City、Contact_State、Contact_Zip、Contact_Country、CampaignDefaults_FromName、CampaignDefaults_FromEmail、CampaignDefaults_Subject、およびCampaignDefaults_Language の指定が必要です。
INSERT INTO Lists (Name, PermissionReminder, EmailTypeOption, Contact_Company, Contact_Address1, Contact_City, Contact_State, Contact_Zip, Contact_Country, CampaignDefaults_FromName, CampaignDefaults_FromEmail, CampaignDefaults_Subject, CampaignDefaults_Language) VALUES ('myName', 'myPermissionReminder', 'true', 'myCompany', 'myAddress', 'myCity', 'myState', 'myZip', 'myCountry', 'myFromName', 'myFromEmail', 'myDefaultSubject', 'myDefaultLanguage')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifies this list |
| Name | String | False |
The name of the list. |
| Contact_Company | String | False |
The company name associated with the list. |
| Contact_Address1 | String | False |
The street address for the list contact. |
| Contact_Address2 | String | False |
The street address for the list contact. |
| Contact_City | String | False |
The city for the list contact. |
| Contact_State | String | False |
The state for the list contact. |
| Contact_Zip | String | False |
The postal or zip code for the list contact. |
| Contact_Country | String | False |
A two-character ISO3166 country code. Defaults to US if invalid. |
| Contact_Phone | String | False |
The phone number for the list contact. |
| PermissionReminder | String | False |
The permission reminder for the list: a line of text that appears in the footer of each campaign that explains why subscribers are receiving the email campaign. |
| UseArchiveBar | Boolean | False |
Whether or not campaigns for this list use the Archive Bar in archives by default. |
| CampaignDefaults_FromName | String | False |
The default from name for campaigns sent to this list. |
| CampaignDefaults_FromEmail | String | False |
The default from email (must be a valid email address) for campaigns sent to this list. |
| CampaignDefaults_Subject | String | False |
The default subject line for campaigns sent to this list. |
| CampaignDefaults_Language | String | False |
The default language for this lists's forms. |
| NotifyOnSubscribe | String | False |
The email address to send subscribe notifications to, when enabled. |
| NotifyOnUnsubscribe | String | False |
The email address to send unsubscribe notifications to, when enabled. |
| DateCreated | Datetime | True |
The date and time that this list was created. |
| ListRating | Integer | True |
An auto-generated activity score for the list (0-5). |
| EmailTypeOption | Boolean | False |
Whether or not the list supports multiple formats for emails. |
| SubscribeUrlShort | String | True |
Our eepurl shortened version of this list's subscribe form. |
| SubscribeUrlLong | String | True |
The full version of this list's subscribe form (host will vary). |
| BeamerAddress | String | True |
The email address to use for this list's Email Beamer. |
| Visibility | String | False |
Whether this list is public (pub) or private (prv). Used internally for projects like Wavelength. |
| Modules | String | True |
Any list-specific modules installed for this list. |
| Stats_MemberCount | Integer | True |
The number of active members in the given list. |
| Stats_UnsubscribeCount | Integer | True |
The number of members who have unsubscribed from the given list. |
| Stats_CleanedCount | Integer | True |
The number of members cleaned from the given list. |
| Stats_MemberCountSinceSend | Integer | True |
The number of active members in the given list since the last campaign was sent. |
| Stats_UnsubscribeCountSinceSend | Integer | True |
The number of members who have unsubscribed since the last campaign was sent. |
| Stats_CleanedCountSinceSend | Integer | True |
The number of members cleaned from the given list since the last campaign was sent. |
| Stats_CampaignCount | Integer | True |
The number of campaigns in any status that use this list. |
| Stats_CampaignLastSent | Datetime | True |
The date and time the last campaign was sent to this list. |
| Stats_MergeFieldCount | Integer | True |
The number of merge vars for this list (not including the required EMAIL one). |
| Stats_AvgSubRate | Double | True |
The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). |
| Stats_AvgUnsubRate | Double | True |
The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). |
| Stats_TargetSubRate | Double | True |
The target numberof subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). |
| Stats_OpenRate | Double | True |
The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). |
| Stats_ClickRate | Double | True |
The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). |
| Stats_LastSubDate | Datetime | True |
The date and time of the last time someone subscribed to this list. |
| Stats_LastUnsubDate | Datetime | True |
The date and time of the last time someone unsubscribed from this list. |
Individuals who are currently or have been previously suscribed to this list, including members who have bounced or unsubscribed.
SELECT, INSERT, and DELETE are supported for ListSegmentMembers.
SELECT * FROM ListSegmentMembers WHERE ListId = '5152' SELECT * FROM ListSegmentMembers WHERE SegmentId = '2623'
The Name and ListID are required for INSERTs.
INSERT INTO ListSegmentMembers (EmailAddress,ListId,SegmentId) VALUES ('[email protected]','44a64c46cb','7032720')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The MD5 hash of the list member's email address. |
| EmailAddress | String | False |
Email address for a subscriber. |
| UniqueEmailId [KEY] | String | True |
An identifier for the address across all of MailChimp. |
| EmailType | String | True |
Type of email this member asked to get ('html' or 'text'). |
| Status | String | True |
Subscriber's current status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'). |
| StatusIfNew | String | True |
Subscriber's status ('subscribed', 'unsubscribed', 'cleaned', or 'pending'), to be used only on a PUT request if the email is not already present on the list. |
| Interests | String | True |
The key of this object's properties is the ID of the interest in question. |
| Stats_AvgOpenRate | Double | True |
A subscriber's average open rate. |
| Stats_AvgClickRate | Double | True |
A subscriber's average clickthrough rate. |
| IpSignup | String | True |
IP address the subscriber signed up from. |
| TimestampSignup | Datetime | True |
Date and time the subscriber signed up for the list. |
| IpOpt | String | True |
IP address the subscriber confirmed their opt-in status. |
| TimestampOpt | Datetime | True |
Date and time the subscribe confirmed their opt-in status. |
| MemberRating | Integer | True |
Star rating for this member between 1 and 5. |
| LastChanged | Datetime | True |
Date and time the member's info was last changed. |
| Language | String | True |
If set/detected, the language of the subscriber. |
| Vip | Boolean | True |
VIP status for subscriber. |
| EmailClient | String | True |
The email client the address as using. |
| Location_Latitude | Double | True | |
| Location_Longitude | Double | True | |
| Location_Gmtoff | Integer | True | |
| Location_Dstoff | Integer | True | |
| Location_CountryCode | String | True | |
| Location_Timezone | String | True | |
| LastNote_NoteId | Integer | True |
The note's ID. |
| LastNote_CreatedAt | String | True |
The date the note was created. |
| LastNote_CreatedBy | String | True |
The author of the note. |
| LastNote_Note | String | True |
The content of the note. |
| ListId [KEY] | String | False |
The id for the list. |
| SegmentId [KEY] | String | False |
The id for the segment. |
A list of available segments.
ListSegments ではSELECT、INSERT、UPDATE、およびDELETE がサポートされています。
SELECT * FROM ListSegments WHERE ListId = '5152'
INSERT にはName とListId を指定する必要があります。
INSERT INTO ListSegments (Name, ListID) VALUES ('myNewListSegment', 'myListID')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
An integer to uniquely identify the segment. |
| Name | String | False |
The name of the segment. |
| MemberCount | Integer | True |
The number of active subscribers currently included in the segment. |
| Type | String | True |
The type of segment: saved, static, or fuzzy. |
| CreatedAt | Datetime | True |
The time and date the segment was created. |
| UpdatedAt | Datetime | True |
The time and date the segment was last updated. |
| Options_Match | String | False |
Match type of 'any' or 'all'. |
| Options_Conditions | String | False |
An array of segment conditions. |
| ListId [KEY] | String | False |
The id for the list. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| EmailList | String |
A comma-separated list of emails that you want to include in this ListSegment. |
Webhooks configured for the given list.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
An identifier for the webhook across all of MailChimp. |
| Url | String | False |
the URL for this Webhook. |
| Events_Subscribe | Boolean | False | |
| Events_Unsubscribe | Boolean | False | |
| Events_Profile | Boolean | False | |
| Events_Cleaned | Boolean | False | |
| Events_Upemail | Boolean | False | |
| Events_Campaign | Boolean | False | |
| Sources_User | Boolean | False | |
| Sources_Admin | Boolean | False | |
| Sources_Api | Boolean | False | |
| ListId [KEY] | String | False |
The id for the list. |
Folders for organizing templates
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A string that uniquely identifieds this folder |
| Name | String | False |
The name of the folder |
| Count | Integer | True |
The number of templates in the folder |
A list an account's available templates.
Templates では、SELECT およびDELETE がサポートされています。
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
The individual id for the template. |
| Type | String | True |
The type of template (user, base, or gallery). |
| Name | String | False |
The name of the template. |
| DragAndDrop | Boolean | True |
Whether or not the template uses the drag and drop editor. |
| Responsive | Boolean | True |
Whether or not the template contains media queries to make it responsive. |
| Category | String | True |
If available, the category the template is listed in. |
| DateCreated | Datetime | True |
The date and time the template was created. |
| CreatedBy | String | True |
The login name for template's creator. |
| Active | Boolean | False |
User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether or not the template is still active. |
| FolderId | String | False |
The id of the folder the template is currently in. |
| Thumbnail | String | True |
If available, the URL for a thumbnail of the template. |
| ShareUrl | String | True |
The URL used for template sharing. For more information, see: http://kb.mailchimp.com/templates/basic-and-themes/how-to-share-a-template |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AuthorizedApps | A list of applications authorized to access the account. |
| AutomationEmailQueues | A summary of the queue for an email in an automation workflow. |
| AutomationEmails | A summary of the emails in an automation workflow. |
| Automations | A summary of the automations within an account. |
| AutomationsRemovedSubscribers | A summary of the subscribers removed from an automation workflow. |
| CampaignOpenEmailDetails | A list of members who opened the campaign email. |
| ConversationMessages | Messages from a specific conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account. |
| Conversations | A collection of this account's tracked conversations. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account. |
| EcommerceStores | A list of an account's ecommerce stores. |
| ListAbuse | A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. |
| ListActivity | Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity. |
| ListClients | Top email clients used, as measured by their user-agent string |
| ListGrowthHistory | A month-by-month summary of a specific list's growth activity. |
| ListMemberActivity | The last 50 member events for a list. |
| ListMemberTags | Tags assigned to specific members. |
| ListSignupForms | Collection of List Signup Forms |
| ReportAbuse | A list of abuse complaints for a specific list. |
| ReportAdvice | A list of feedback based on a campaign's statistics. |
| ReportClickDetails | A list of URLs and unique IDs included in HTML and plain-text versions of a campaign. |
| ReportClickDetailsMembers | A collection of members who clicked on a specific link within a campaign. |
| ReportDomainPerformance | Statistics for the top-performing email domains in a campaign. |
| ReportEmailActivity | A list of member's subscriber activity in a specific campaign. |
| ReportLocations | Top open locations for a specific campaign. |
| Reports | A list of reports containing campaigns marked as Sent. |
| ReportSentTo | A list of subscribers who were sent a specific campaign. |
| ReportUnsubscribes | A list of members who have unsubscribed from a specific campaign. |
| SurveyResponses | List of survey responses. |
| Surveys | Get reports for surveys. |
A list of applications authorized to access the account.
SELECT is supported for AuthorizedApps.
| Name | Type | Description |
| Id [KEY] | String | The Id for this application integration. |
| Name | String | The name of the application. |
| Description | String | The description for the application. |
| Users | String | An array of usernames of the users who have linked this app. |
A summary of the queue for an email in an automation workflow.
AutomationEmailQueues では、SELECT がサポートされています。
SELECT Id, WorkflowId, EmailAddress, NextSend FROM AutomationEmailQueues WHERE WorkflowId = 'abc123';
| Name | Type | Description |
| Id [KEY] | String | The MD5 hash of the lowercase version of the list member's email address. |
| WorkflowId [KEY] | String | A string that uniquely identifies an automation workflow. |
| EmailId [KEY] | String | A string that uniquely identifies an email in an automation workflow. |
| ListId | String | A string that uniquely identifies a list. |
| EmailAddress | String | Email Address |
| NextSend | String | Next Send |
A summary of the emails in an automation workflow.
AutomationEmails では、SELECT がサポートされています。
SELECT * FROM AutomationEmails
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies the automation email. |
| WorkflowId [KEY] | String | A string that uniquely identifies an automation workflow. |
| Position | Integer | |
| Delay_Amount | Integer | The delay amount for an automation email. |
| Delay_Type | String | The type of delay for an automation email. |
| Delay_Direction | String | Whether the delay settings describe before or after the delay action of an automation email. |
| Delay_Action | String | The action that triggers the delay of an automation emails. |
| CreateTime | Datetime | The date and time the campaign was created. |
| StartTime | Datetime | The date and time the campaign was started. |
| ArchiveUrl | String | The link to the campaign's archive version. |
| Status | String | The current status of the campaign ('save', 'paused', 'sending'). |
| EmailsSent | Integer | The total number of emails sent for this campaign. |
| SendTime | Datetime | The time and date a campaign was sent. |
| ContentType | String | How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). |
| Recipients_ListId | String | The id of the list. |
| Recipients_SegmentOpts | String | Segment options. |
| Settings_SubjectLine | String | The subject line for the campaign. |
| Settings_Title | String | The title of the campaign. |
| Settings_FromName | String | The 'from' name on the campaign (not an email address). |
| Settings_ReplyTo | String | The reply-to email address for the campaign. |
| Settings_Authenticate | Boolean | Whether or not the campaign was authenticated by MailChimp. Defaults to 'true'. |
| Settings_AutoFooter | Boolean | Automatically append MailChimp's default footer to the campaign. |
| Settings_InlineCss | Boolean | Automatically inline the CSS included with the campaign content. |
| Settings_AutoTweet | Boolean | Automatically tweet a link to the campaign archive page when the campaign is sent. |
| Settings_AutoFbPost | String | An array of Facebook page ids (integers) to auto-post to. |
| Settings_FbComments | Boolean | Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to 'true'. |
| Settings_TemplateId | Integer | The id for the template used in this campaign. |
| Settings_DragAndDrop | Boolean | Whether the campaign uses the drag-and-drop editor. |
| Tracking_Opens | Boolean | Whether to track opens. Defaults to 'true'. |
| Tracking_HtmlClicks | Boolean | Whether to track clicks in the HTML version of the campaign. Defaults to 'true'. |
| Tracking_TextClicks | Boolean | Whether to track clicks in the plain-text version of the campaign. Defaults to 'true'. |
| Tracking_GoalTracking | Boolean | Whether to enable Goal racking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH |
| Tracking_Ecomm360 | Boolean | Whether to enable eCommerce360 tracking. |
| Tracking_GoogleAnalytics | String | The custom slug for Google Analytics tracking (max of 50 bytes). |
| Tracking_Clicktale | String | The custom slug for ClickTale Analytics tracking (max of 50 bytes). |
| Tracking_Salesforce | String | Salesforce tracking options for a campaign. Must be using MailChimp's built-in Salesforce integration. |
| Tracking_Highrise | String | Highrise tracking options for a campaign. Must be using MailChimp's built-in Highrise integration. |
| Tracking_Capsule | String | Capsule tracking option sfor a campaign. Must be using MailChimp's built-in Capsule integration. |
| SocialCard_ImageUrl | String | The url for the header image for the card. |
| SocialCard_Description | String | A short summary of the campaign to display. |
| SocialCard_Title | String | The title for the card. Typically the subject line of the campaign. |
| TriggerSettings_Runtime | String | The advanced scheduling options for an automation email. |
| ReportSummary | String | For sent campaigns, a summary of opens, clicks, and unsubscribes. |
A summary of the automations within an account.
| Name | Type | Description |
| Id [KEY] | String | A string that identifies this automation. |
| CreateTime | Datetime | The date and time the automation was created. |
| StartTime | Datetime | The date and time the automation was started. |
| Status | String | The current status of the automation ('save', 'paused', 'sending'). |
| EmailsSent | Integer | The total number of emails sent for this automation. |
| Recipients_ListId | String | The id of the list. |
| Recipients_ListName | String | List Name |
| Recipients_SegmentOpts | String | Segment options. |
| Settings_Title | String | The title of the automation. |
| Settings_FromName | String | The 'from' name on the automation (not an email address). |
| Settings_ReplyTo | String | The reply-to email address for the automation. |
| Settings_UseConversation | Boolean | Use MailChimp's Conversations feature to manage out of office replies. |
| Settings_ToName | String | The automation's custom 'to' name. Typically something like the first name merge var. |
| Settings_Authenticate | Boolean | Whether or not the automation is authenticated by MailChimp. Defaults to 'true'. |
| Settings_AutoFooter | Boolean | Automatically append MailChimp's default footer to the automation. |
| Settings_InlineCss | Boolean | Automatically inline the CSS included with the automation content. |
| Tracking_Opens | Boolean | Whether to track opens. Defaults to 'true'. |
| Tracking_HtmlClicks | Boolean | Whether to track clicks in the HTML version of the automation. Defaults to 'true'. |
| Tracking_TextClicks | Boolean | Whether to track clicks in the plain-text version of the automation. Defaults to 'true'. |
| Tracking_GoalTracking | Boolean | Whether to enable Goal tracking. For more information, see this Knowledge Base article: http://eepurl.com/GPMdH |
| Tracking_Ecomm360 | Boolean | Whether to enable eCommerce360 tracking. |
| Tracking_GoogleAnalytics | String | The custom slug for Google Analytics tracking (max of 50 bytes). |
| Tracking_Clicktale | String | The custom slug for ClickTale Analytics tracking (max of 50 bytes). |
| Tracking_Salesforce | String | Salesforce tracking options for an automation. Must be using MailChimp's built-in Salesforce integration. |
| Tracking_Highrise | String | Highrise tracking options for an automation. Must be using MailChimp's built-in Highrise integration. |
| Tracking_Capsule | String | Capsule tracking options for an automation. Must be using MailChimp's built-in Capsule integration. |
| TriggerSettings | String | A summary of an automation workflow's trigger settings. |
| ReportSummary | String | A summary of open and click activity for an automation workflow. |
A summary of the subscribers removed from an automation workflow.
SELECT is supported for AutomationsRemovedSubscribers.
SELECT Id, WorkflowId, EmailAddress FROM AutomationsRemovedSubscribers WHERE WorkflowId = 'abc123';
| Name | Type | Description |
| Id [KEY] | String | The MD5 hash of the lowercase version of the list member's email address. |
| WorkflowId [KEY] | String | A string that uniquely identifies an automation workflow. |
| ListId | String | A string that uniquely identifies a list. |
| EmailAddress | String | Email Address |
A list of members who opened the campaign email.
SELECT is supported for CampaignOpenEmailDetails.
For example:
SELECT * FROM CampaignOpenEmailDetails SELECT * FROM CampaignOpenEmailDetails WHERE CampaignId = '9f218dcf18'
| Name | Type | Description |
| CampaignId [KEY] | String | The Id for this application integration. |
| ListId [KEY] | String | The name of the application. |
| ListIsActive | Boolean | The description for the application. |
| ContactStatus | String | An array of usernames of the users who have linked this app. |
| EmailId [KEY] | String | The description for the application. |
| EmailAddress | String | The description for the application. |
| MergeFields | String | The description for the application. |
| Vip | Boolean | The description for the application. |
| OpensCount | Integer | The description for the application. |
| Opens | String | The description for the application. |
Messages from a specific conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account.
ConversationMessages では、SELECT がサポートされています。
SELECT * FROM ConversationMessages
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies this message |
| ConversationId [KEY] | String | A string that identifies this message's conversation |
| ListId [KEY] | String | The unique identifier of the list this conversation is associated with |
| FromLabel | String | A label representing the sender of this message |
| FromEmail | String | A label representing the email of the sender of this message |
| Subject | String | The subject of this message |
| Message | String | The plain-text content of the message |
| Read | Boolean | Whether or not this message has been marked as read |
| Timestamp | Datetime | Date the message was either sent or received |
A collection of this account's tracked conversations. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns from inside your MailChimp account.
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies this conversation |
| MessageCount | Integer | The total number of messages in this conversation |
| CampaignId [KEY] | String | The unique identifier of the campaign this conversation is associated with |
| ListId [KEY] | String | The unique identifier of the list this conversation is associated with |
| UnreadMessages | Integer | The number of unread messages in this conversation |
| FromLabel | String | A label representing the sender of this message |
| FromEmail | String | A label representing the email of the sender of this message |
| Subject | String | The subject of the message |
| LastMessage_FromLabel | String | A label representing the sender of this message |
| LastMessage_FromEmail | String | A label representing the email of the sender of this message |
| LastMessage_Subject | String | The subject of this message |
| LastMessage_Message | String | The plain-text content of the message |
| LastMessage_Read | Boolean | Whether or not this message has been marked as read |
| LastMessage_Timestamp | Datetime | Date the message was either sent or received |
A list of an account's ecommerce stores.
SELECT * FROM EcommerceStores WHERE Id = '44'
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the store. |
| ListId [KEY] | String | The unique identifier for the MailChimp list that's associated with the store. The list_id for a specific store can't change. |
| Name | String | The name of the store. |
| Platform | String | The ecommerce platform of the store. |
| Domain | String | The store domain. |
| EmailAddress | String | The email address for the store. |
| CurrencyCode | String | The three-letter ISO 4217 code for the currency that the store accepts. |
| MoneyFormat | String | The currency format for the store. For example: `$`, etc. |
| PrimaryLocale | String | The primary locale for the store. For example: `en`, `de`, etc. |
| Timezone | String | The timezone for the store. |
| Phone | String | The store phone number. |
| Address_Address1 | String | The store's mailing address. |
| Address_Address2 | String | An additional field for the store's mailing address. |
| Address_City | String | The city the store is located in. |
| Address_Province | String | The store's state name or normalized province. |
| Address_ProvinceCode | String | The two-letter code for the store's province or state. |
| Address_PostalCode | String | The store's postal or zip code. |
| Address_Country | String | The store's country. |
| Address_CountryCode | String | The two-letter code for to the store's country. |
| Address_Longitude | Double | The longitude of the store location. |
| Address_Latitude | Double | The latitude of the store location. |
| CreatedAt | Datetime | The date and time the store was created. |
| UpdatedAt | Datetime | The date and time the store was last updated. |
A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program.
ListAbuse ではSELECT がサポートされています。
SELECT * FROM ListAbuse WHERE ListId = 'abc'
| Name | Type | Description |
| Id [KEY] | String | The id for the abuse report |
| CampaignId [KEY] | String | The campaign id for the abuse report |
| ListId [KEY] | String | The list id for the abuse report. |
| EmailId [KEY] | String | The MD5 hash of the list member's email address. |
| EmailAddress | String | Email address for a subscriber |
| Date | String | Date for the abuse report |
Up to the previous 180 days of daily detailed aggregated activity stats for a given list. Does not include AutoResponder or Automation activity.
ListActivity ではSELECT がサポートされています。
SELECT * FROM ListActivity WHERE ListId = 'abc'
| Name | Type | Description |
| ListId [KEY] | String | The ListId for the table. |
| Day [KEY] | Date | The date for the activity summary. |
| EmailsSent | Integer | The total number of emails sent on the date for the activity summary. |
| UniqueOpens | Integer | The number of unique opens. |
| RecipientClicks | Integer | The number of clicks. |
| HardBounce | Integer | The number of hard bounces. |
| SoftBounce | Integer | The number of soft bounces |
| Subs | Integer | The number of subscribes. |
| Unsubs | Integer | The number of unsubscribes. |
| OtherAdds | Integer | The number of subscribers who may have been added outside of the double opt-in process such as imports or API activity. |
| OtherRemoves | Integer | The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam. For example, deleted subscribers. |
Top email clients used, as measured by their user-agent string
| Name | Type | Description |
| Client | String | The name of the email client. |
| Members | Integer | The number of subscribed members who used this email client. |
| ListId [KEY] | String | The unique id for the list. |
A month-by-month summary of a specific list's growth activity.
ListGrowthHistory ではSELECT がサポートされています。
SELECT * FROM ListGrowthHistory WHERE ListId = 'abc'
| Name | Type | Description |
| ListId [KEY] | String | The list id for the growth activity report. |
| Month [KEY] | String | The month that the growth history is describing. |
| Subscribed | Integer | Total subscribed members on the list at the end of the month. |
| Unsubscribed | Integer | Newly unsubscribed members on the list for a specific month. |
| Reconfirm | Integer | Newly reconfirmed members on the list for a specific month. |
| Cleaned | Integer | Newly cleaned (hard-bounced) members on the list for a specific month. |
| Pending | Integer | Pending members on the list for a specific month. |
| Deleted | Integer | Newly deleted members on the list for a specific month. |
| Transactional | Integer | Subscribers that have been sent transactional emails via Mandrill. |
The last 50 member events for a list.
SELECT is supported for ListMemberActivity.
SELECT * FROM ListMemberActivity
| Name | Type | Description |
| MemberId [KEY] | String | The MemberId of the member to get events for. |
| EmailId [KEY] | String | The EmailId for the table. |
| ListId [KEY] | String | The ListId for the table. |
| Action | String | The type of action recorded for the subscriber. |
| Timestamp [KEY] | Datetime | The date and time recorded for the action. |
| Url | String | For clicks, the URL the subscriber clicked on. |
| Type | String | The type of campaign that was sent. |
| CampaignId [KEY] | String | The web-based ID for the campaign. |
| Title | String | If set, the campaign's title. |
| ParentCampaign | String | The ID of the parent campaign. |
| ContactId | String | The ID of the contact. |
Tags assigned to specific members.
SELECT is supported for ListMemberTags.
SELECT Id, Name, TimeAdded FROM ListMemberTags WHERE ListId = '12345';
| Name | Type | Description |
| Id [KEY] | String | The unique ID of the tag. |
| Name | String | Name of the tag. When inserting, if the name doesn't exist, it will be created and then assigned to the member specified. |
| TimeAdded | Datetime | Date and time the tag was added to the member. |
| ListId | String | The ID of the list on which the member of this tag belongs to. |
| MemberId | String | The ID of the member this tag is assigned to. |
Collection of List Signup Forms
| Name | Type | Description |
| Header_ImageUrl | String | Header Image Url |
| Header_Text | String | Header Text |
| Header_ImageWidth | String | Image width |
| Header_ImageHeight | String | Image height |
| Header_ImageAlt | String | Image Alt |
| Header_ImageLink | String | Image Link |
| Header_ImageAlign | String | Image align |
| Header_ImageBorderWidth | String | Image border width |
| Header_ImageBorderStyle | String | Image border style |
| Header_ImageBorderColor | String | Image border color |
| Header_ImageTarget | String | Image target |
| Contents | String | Signup form body contents options |
| Styles | String | An array of objects, each representing each element of signup forms. |
| SignupFormUrl | String | Signup form URL |
| ListId [KEY] | String | A string that identifies this signup forms' list. |
A list of abuse complaints for a specific list.
ReportAbuse では、SELECT がサポートされています。
SELECT * FROM ReportAdvice WHERE CampaignId = 'abc'
| Name | Type | Description |
| Id [KEY] | String | The unique id for the abuse report. |
| CampaignId [KEY] | String | The campaign id for the abuse report |
| ListId [KEY] | String | The list id for the abuse report. |
| EmailId [KEY] | String | The list-specific ID for the given email address |
| EmailAddress | String | Email address for a subscriber |
| Date | String | Date for the abuse report |
A list of feedback based on a campaign's statistics.
ReportAdvice では、SELECT がサポートされています。
SELECT * FROM ReportAdvice WHERE CampaignId = 'abc'
| Name | Type | Description |
| CampaignId | String | The CampaignId for the table. |
| Type | String | The 'type' of message ('negative', 'positive', 'neutral'). |
| Message | String | The advice message. |
A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
ReportClickDetails では、SELECT がサポートされています。
SELECT * FROM ReportClickDetails WHERE CampaignId = 'abc'
| Name | Type | Description |
| Id [KEY] | String | |
| Url | String | The URL for the link in the campaign. |
| TotalClicks | Integer | The number of total clicks for a given link. |
| ClickPercentage | Double | The percentage of total clicks a given link generated for a campaign. |
| UniqueClicks | Integer | Number of unique clicks for a given link. |
| UniqueClickPercentage | Double | The percentage of unique clicks a given link generated for a campaign. |
| LastClick | Datetime | The date and time for the last recorded click for a given link. |
| AbSplit_A | String | |
| AbSplit_B | String | |
| CampaignId [KEY] | String | The id for the campaign. |
A collection of members who clicked on a specific link within a campaign.
ReportClickDetailsMembers では、SELECT がサポートされています。
SELECT * FROM ReportClickDetailsMembers
| Name | Type | Description |
| EmailId [KEY] | String | The list-specific ID for the given email address. |
| EmailAddress | String | Email address for a subscriber |
| Clicks | Integer | The total number of times the subscriber clicked on the link. |
| CampaignId [KEY] | String | The id for the campaign. |
| UrlId [KEY] | String | The id for the tracked URL in the campaign. |
| ListId [KEY] | String | The id for the list. |
Statistics for the top-performing email domains in a campaign.
ReportDomainPerformance では、SELECT がサポートされています。
SELECT * FROM ReportDomainPerformance WHERE CampaignId = 'abc'
| Name | Type | Description |
| CampaignId | String | The CampaignId for the table. |
| Domain | String | The name of the domain (gmail.com, hotmail.com, yahoo.com). |
| EmailsSent | Integer | The number of emails sent to that specific domain. |
| Bounces | Integer | The number of bounces at a domain. |
| Opens | Integer | The number of opens for a domain. |
| Clicks | Integer | The number of clicks for a domain. |
| Unsubs | Integer | The total number of unsubscribes for a domain. |
| Delivered | Integer | The number of successful deliveries for a domain. |
| EmailsPct | Double | The percentage of total emails that went to this domain. |
| BouncesPct | Double | The percentage of total bounces that came from this domain. |
| OpensPct | Double | The percentage of total opens that came from this domain. |
| ClicksPct | Double | The percentage of total clicks tht came from this domain. |
| UnsubsPct | Double | The percentage of total unsubscribes taht came from this domain. |
A list of member's subscriber activity in a specific campaign.
ReportEmailActivity では、SELECT がサポートされています。
SELECT * FROM ReportEmailActivity
| Name | Type | Description |
| CampaignId [KEY] | String | The unique id for the campaign. |
| ListId [KEY] | String | The unique id for the list. |
| EmailId [KEY] | String | The list-specific ID for the given email address. |
| EmailAddress | String | Email address for a subscriber |
| Activity | String | An array of objects, each showing an interaction with the email. |
Top open locations for a specific campaign.
| Name | Type | Description |
| CampaignId [KEY] | String | The CampaignId for the table. |
| Region [KEY] | String | A more specific location area such as city or state. |
| Opens | Integer | The number of unique campaign opens for a given region. |
A list of reports containing campaigns marked as Sent.
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies this campaign. |
| CampaignTitle | String | The title of the campaign. |
| Type | String | The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). |
| EmailsSent | Integer | The total number of emails sent for this campaign. |
| AbuseReports | Integer | The number of abuse reports generated for this campaign. |
| Unsubscribed | Integer | The total number of unsubscribed members for this campaign. |
| SendTime | Datetime | The time and date a campaign was sent. |
| Bounces_HardBounces | Integer | The total number of hard bounced email addresses. |
| Bounces_SoftBounces | Integer | The total number of soft bounced email addresses. |
| Bounces_SyntaxErrors | Integer | The total number of addresses that were syntax-related bounces. |
| Forwards_ForwardsCount | Integer | |
| Forwards_ForwardsOpens | Integer | |
| Opens_OpensTotal | Integer | The total number of opens for a campaign. |
| Opens_UniqueOpens | Integer | The total number of unique subscribers who opened a campaign. |
| Opens_OpenRate | Double | The number of unique subscribers who opened divided by the total number of successful deliveries. |
| Opens_LastOpen | Datetime | The date and time of the last recorded open. |
| Clicks_ClicksTotal | Integer | The total number of clicks for the campaign. |
| Clicks_UniqueClicks | Integer | The total number of unique clicks for links across a campaign. |
| Clicks_UniqueSubscriberClicks | Integer | The total number of subscribers who clicked on a campaign. |
| Clicks_ClickRate | Double | The number of unique subscribers who clicked divided by the total number of successful deliveries. |
| Clicks_LastClick | Datetime | The date and time of the last recorded click for the campaign. |
| FacebookLikes_RecipientLikes | Integer | |
| FacebookLikes_UniqueLikes | Integer | |
| FacebookLikes_FacebookLikes | Integer | |
| IndustryStats_Type | String | |
| IndustryStats_OpenRate | Double | |
| IndustryStats_ClickRate | Double | |
| IndustryStats_BounceRate | Double | |
| IndustryStats_UnopenRate | Double | |
| IndustryStats_UnsubRate | Double | |
| IndustryStats_AbuseRate | Double | |
| ListStats_SubRate | Double | The average number of subscriptions per month for the list. |
| ListStats_UnsubRate | Double | The average number of unsubscriptions per month for the list. |
| ListStats_OpenRate | Double | The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. |
| ListStats_ClickRate | Double | The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. |
| AbSplit_A | String | |
| AbSplit_B | String | |
| Timewarp | String | An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. |
| Timeseries | String | An hourly breakdown of the performance of the campaign over the first 24 hours. |
| ShareReport_ShareUrl | String | The URL for the VIP report. |
| ShareReport_SharePassword | String | If password protected, the password for the VIP report. |
| DeliveryStatus | String | Updates on campaigns in the process of sending. |
A list of subscribers who were sent a specific campaign.
ReportSentTo では、SELECT がサポートされています。
このテーブルからデータを取得するにはCampaignId を指定する必要があります。WHERE 句に何も指定されていない場合は、アカウントで使える最初のものが使用されます。
| Name | Type | Description |
| EmailId [KEY] | String | The list-specific ID for the given email address. |
| EmailAddress | String | Email address for a subscriber. |
| Status | String | The status of the member ('sent', 'hard' for hard bounce, or 'soft' for soft bounce). |
| OpenCount | Integer | The number of times a campaign was opened by this member. |
| LastOpen | String | The date and time of the last open for this member. |
| AbsplitGroup | String | For A/B Split Campaigns, the group the member was apart of ('a', 'b', or 'winner'). |
| GmtOffset | Integer | For campaigns sent with timewarp, the time zone group the member is apart of. |
| CampaignId [KEY] | String | The id for the campaign. |
| ListId [KEY] | String | The id for the list. |
A list of members who have unsubscribed from a specific campaign.
ReportUnsubscribes では、SELECT がサポートされています。
SELECT * FROM ReportUnsubscribes
| Name | Type | Description |
| EmailId [KEY] | String | The list-specific ID for the given email address |
| EmailAddress | String | Email address for a subscriber |
| Timestamp | Datetime | The date and time the member opted-out. |
| Reason | String | If available, the reason listed by the member for unsubscribing. |
| CampaignId [KEY] | String | The id for the campaign. |
| ListId [KEY] | String | The id for the list. |
List of survey responses.
SELECT is supported for SurveyResponses.
SELECT * FROM SurveyResponses
| Name | Type | Description |
| Id [KEY] | String | The ID for the survey response. |
| SubmittedAt | Datetime | The date and time when the survey response was submitted. |
| ContactEmailId | String | The MD5 hash of the lowercase version of the list member email address. |
| ContactId | String | The ID of this contact. |
| ContactStatus | String | The contact's current status. |
| ContactEmail | String | The contact's email address. |
| ContactFullName | String | The contact's full name. |
| ContactConsentsToOneToOneMessaging | Boolean | Indicates whether a contact consents to 1:1 messaging. |
| ContactAvatarUrl | String | URL for the contact's avatar or profile image. |
| IsNewContact | Boolean | If this contact was added to the Mailchimp audience via this survey. |
| SurveyId [KEY] | String | A string that uniquely identifies this survey. |
Get reports for surveys.
SELECT is supported for Surveys.
| Name | Type | Description |
| Id [KEY] | String | A string that uniquely identifies this survey. |
| WebId | Integer | The ID used in the Mailchimp web application. |
| ListId | String | The ID of the list connected to this survey. |
| ListName | String | The name of the list connected to this survey. |
| Title | String | The title of the survey. |
| Url | String | The URL for the survey. |
| Status | String | The status of the Surney. Possible values: published or unpublished. |
| PublishedAt | Datetime | The date and time the survey was published. |
| CreatedAt | Datetime | The date and time the survey was created. |
| UpdatedAt | Datetime | The date and time the survey was last updated. |
| TotalResponses | Integer | The total number of responses to this survey. |
| プロパティ | 説明 |
| AuthScheme | MailChimp への接続時にAPIKey 認証またはOAuth 認証のどちらを使用するか。 |
| APIKey | MailChimp アカウントへのアクセスに使用されるAPI キー。 |
| プロパティ | 説明 |
| IncludeCustomFields | Set whether to include custom fields that are added to the ListMembers view. This defaults to true. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Datacenter | MailChimp アカウントに使用されるデータセンター。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Mailchimp から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | MailChimp への接続時にAPIKey 認証またはOAuth 認証のどちらを使用するか。 |
| APIKey | MailChimp アカウントへのアクセスに使用されるAPI キー。 |
MailChimp への接続時にAPIKey 認証またはOAuth 認証のどちらを使用するか。
MailChimp アカウントへのアクセスに使用されるAPI キー。
MailChimp アカウントへのアクセスに使用されるAPI キー。API キーは、MailChimp で[Account]->[Extras]->[API Keys]をクリックすると見つけることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeCustomFields | Set whether to include custom fields that are added to the ListMembers view. This defaults to true. |
Set whether to include custom fields that are added to the ListMembers view. This defaults to true.
Set whether to include custom fields that are added to the ListMembers view. This defaults to true.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Datacenter | MailChimp アカウントに使用されるデータセンター。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
MailChimp アカウントに使用されるデータセンター。
MailChimp アカウントに使用されるデータセンター。この値は、ブラウザでMailChimp にログインするときのURL で見つけることができます。データセンターはAPIKey に埋め込まれており、OAuth 使用時にSync App はデータセンターを自動的に取得します。しかしこのプロパティを設定すると、OAuth を使用して認証するときに余分なリクエストを節約できます。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がMailchimp への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がMailchimp への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がMailchimp にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\MailChimp Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Mailchimp から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Mailchimp から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Lists WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。