接続の確立

ActiveCampaign への接続を追加

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

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

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

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

ActiveCampaign への接続

ActiveCampaign はAPI キーによる認証をサポートしています。ActiveCampaign に接続するには、自身のアカウントでDeveloper ページに移動して以下を設定します。

URL：このプロパティを設定するには、My Settings ページに移動します。例： https://<yourAccountName>.api-us1.com
APIKey：このプロパティを設定するには、Settings ページに移動します。ActiveCampaign アカウントの各ユーザーには、それぞれ固有のAPI キーがあります。

これらのプロパティを設定する際、My Settings とSettings をを間違えないようにしてください。

データモデル

概要

Sync App はContacts、Accounts などのActiveCampaign リソースをリレーショナルテーブルとしてモデル化し、SQL を記述してActiveCampaign データをクエリできるようにします。

これらのオブジェクトへのライブ接続により、Sync App を使用するとActiveCampaign アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューは変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。

ダイナミックビュー

デフォルトの静的ビューに加え、Sync App ではダイナミックビューでのクエリも可能です。

これらはActiveCampaign アカウントの"リスト"（"オーディエンス" とも呼ばれます）に基づいて作成されるビューです。
例えば、アカウントに以下の3つのリストがあると仮定しましょう：Master Contact List、New Audience、VIP List。

Sync App はそれらに基づいて3つのビューをリストします：List_MasterList、List_New Audience、List_VIP List。
ビューは、その特定のリストのメンバーである各コンタクトに関するデータを返します。

テーブル

テーブルでは、利用可能なテーブルを説明します。テーブルは、Accounts、Deals、DealGroups、DealStages、Tasks などのリソースを静的にモデル化するように定義されています。

Sync App はまた、AccountCustomFieldData、DealCustomFieldData、ContactCustomFieldData などのカスタムフィールドデータ情報を表すテーブルへのクエリもサポートしています。

さらに、Sync App は、メインリソース（Accounts、Contacts、Deals テーブルで利用可能）からのカスタムフィールドデータの更新や挿入をサポートし、カスタムフィールドはメインフィールドのカラムとして動的に追加されます。詳細については、特定のテーブルのセクションを参照してください。

テーブル

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

ActiveCampaign Connector for CData Sync テーブル


Name	Description
AccountContacts	Usage information for the operation AccountContacts.rsd.
AccountCustomFieldData	Create, modify, delete and query the available deal custom field data in ActiveCampaign.
Accounts	View many or all contacts by including their ID's or various filters.
ContactCustomFieldData	Create, modify, delete and query the available contact custom field data in ActiveCampaign.
Contacts	View many or all contacts by including their ID's or various filters.
DealCustomFieldData	Create, modify, delete and query the available deal custom field data in ActiveCampaign.
DealGroups	Lists all existing accounts.
Deals	Usage information for the operation Deals.rsd.
DealStages	Usage information for the operation DealStages.rsd.
Tasks	Lists all existing accounts.

AccountContacts

Usage information for the operation AccountContacts.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM AccountContacts WHERE Id = 10003

SELECT * FROM AccountContacts WHERE AccountId = 1 AND ContactId = 100

Insert

Inserting an account-contact association requires specifying a value for the AccountId and ContactId columns.

INSERT INTO AccountContacts (AccountId, ContactId) VALUES (2, 300)

INSERT INTO AccountContacts (AccountId, ContactId, Jobtitle) VALUES (2, 300, 'nurse')

Update

The driver supports updating account-contact information.

UPDATE AccountContacts SET ContactId = 3, JobTitle = 'updatedJobTitle' WHERE Id = 1

UPDATE AccountContacts SET JobTitle = 'updatedJobTitle' WHERE AccountId = 1

Delete

Remove all account-contacts association or an association by specifying the Id of the association.

DELETE FROM AccountContacts WHERE Id = 10003

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the account-contact association.
AccountId	String	False	The account Id.
ContactId	String	False	The contact Id.
CreatedTimestamp	Datetime	True	Datetime value which indicates when the assosiaction was created.
JobTitle	String	False	Job Title of the contact at the account.
AccountLink	String	True	Account link.
ContactLink	String	True	Contact link.
UpdatedTimestamp	Datetime	True	Datetime value which indicates when the assosiaction was last updated.

AccountCustomFieldData

Create, modify, delete and query the available deal custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM AccountCustomFieldData WHERE Id = 10003

SELECT * FROM AccountCustomFieldData WHERE AccountId = 1

Insert

Inserting an account custom field data requires specifying a value for the AccountId, CustomFieldId, FieldValue columns.

Additionally, the Sync App supports inserting account custom fields data from the Accounts table. See Accounts for more information.

INSERT INTO AccountCustomFieldData (FieldValue, CustomFieldId, AccountId) VALUES ('custom field value', 1, 5)

Update

The Sync App supports updating account custom field data information. Updating an account custom field data requires specifying a value for the Id and CustomFieldId columns.

Additionally, it is possible to update account custom fields data from the Accounts table.

UPDATE AccountCustomFieldData SET FieldValue = 'Custom Field Value' WHERE Id = 13 AND CustomFieldId = 1

Delete

The Sync App supports removing accounts' custom field data.

DELETE FROM AccountcustomFieldData WHERE Id = 10

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the account custom field data.
AccountCustomFieldMetumId	Integer	True	The custom field metum Id.
AccountId	Integer	False	The ID of the account the field value relates to.
CreatedTimestamp	Datetime	True	Datetime value that indicates when the custom field value was set.
CustomFieldId	Integer	False	The ID of the custom field metum the field value relates to.
CustomFieldName	String	True	The name of the custom field metum the field value relates to.
FieldValue	String	False	Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5).
AccountLink	String	True	Account link.
AccountCustomFieldMetumLink	String	True	AccountCustomFieldMetum link.
UpdatedTimestamp	Datetime	True	Datetime value which indicates when the custom field data was last updated.
FieldCurrency	String	False	Value of the custom field currency type for a specific contact. This field is required when inserting currency custom fields.

Accounts

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Accounts WHERE Id = 10003

SELECT * FROM Accounts WHERE Name = 'testAccount'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the AccountCustomFieldData table.

Insert

Inserting an account requires specifying the account name.

INSERT INTO Accounts (Name) VALUES ('testAccount2')

INSERT INTO Accounts (Name, AccountUrl) VALUES ('account', 'http://accountUrl.com/')

Additionally, the Sync App supports inserting account and account custom fields data from the Accounts table. All custom field columns start with CF_.

INSERT INTO Accounts (Name, CF_Description, CF_Hidden, CF_Number) VALUES ('testAccount3', 'custom field value', 'custom field value', 123)

Update

The Sync App supports updating account information.

Additionally, it is possible to update account custom fields data from the Accounts table.

UPDATE Accounts SET Name = 'updatedName', AccountUrl = 'http://updatedAccountUrl.com/' WHERE Id = 1

UPDATE Accounts SET Name = 'updatedName', CF_Description = 'custom field value', CF_Hidden = 'custom field value' WHERE Id = 1

Delete

Remove all accounts or an account by specifying the Id of the account.

DELETE FROM Accounts WHERE Id = 10003

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Accounts table.
AccountUrl	String	False	Account's website.
ContactCount	Integer	True	The ContactCount column of the Accounts table.
CreatedTimestamp	Datetime	True	The CreatedTimestamp column of the Accounts table.
DealCount	Integer	True	The DealCount column of the Accounts table.
AccountContactsLink	String	True	The AccountContactsLink column of the Accounts table.
AccountCustomFieldDataLink	String	True	The AccountCustomFieldDataLink column of the Accounts table.
ContactEmailsLink	String	True	The ContactEmailsLink column of the Accounts table.
EmailActivitiesLink	String	True	The EmailActivitiesLink column of the Accounts table.
NotesLink	String	True	The NotesLink column of the Accounts table.
Name	String	False	Account's name.
UpdatedTimestamp	Datetime	True	The UpdatedTimestamp column of the Accounts table.

ContactCustomFieldData

Create, modify, delete and query the available contact custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM ContactCustomFieldData WHERE Id = 10003

SELECT * FROM ContactCustomFieldData WHERE FieldValue = 'custom field value'

Insert

Inserting a contact custom field data requires specifying a value for the ContactId, FieldId, FieldValue columns.

Additionally, the Sync App supports inserting contact custom fields data from the Contacts table. See Contacts for more information.

INSERT INTO ContactCustomFieldData (FieldValue, FieldId, ContactId) VALUES ('custom field value', 1, 5)

Update

The Sync App supports updating contact custom field data information. Updating contact custom field data requires specifying a value for the Id, ContactId and FieldId columns.

Additionally, it is possible to update contact custom fields data from the Contacts table.

UPDATE ContactCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND ContactId = 3 AND FieldId = 2"

Delete

The Sync App supports removing contact custom field data.

DELETE FROM ContactCustomFieldData WHERE Id = 10

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id column of the ContactCustomFieldData table.
CDate	Datetime	False	The CDate column of the ContactCustomFieldData table.
ContactId	String	False	The ContactId column of the ContactCustomFieldData table.
CustomFieldName	String	True	The name of the custom field metum the field value relates to.
FieldId	String	False	ID of the field the value belongs to.
FieldLink	String	False	The FieldLink column of the ContactCustomFieldData table.
OwnerLink	String	False	The OwnerLink column of the ContactCustomFieldData table.
Owner	String	False	The Owner column of the ContactCustomFieldData table.
Udate	Datetime	False	The Udate column of the ContactCustomFieldData table.
FieldValue	String	False	Value of the custom field for a specific contact.

Contacts

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = 10

SELECT * FROM Contacts WHERE Udate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Udate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Cdate >= '2019-06-30T10:44:34-05:00' AND Cdate <= '2021-06-30T10:44:34-05:00'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the ContactCustomFieldData table.

Insert

Inserting a contact requires specifying the contact email.

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

INSERT INTO Contacts (Email, FirstName, LastName, Phone) VALUES ('[email protected]', 'test', 'test', 'contactphonenumber')

Additionally, the Sync App supports inserting contact and contact custom fields data from the Contacts table. All custom field columns start with CF_.

INSERT INTO Contacts (Name, CF_Description, CF_Hidden, CF_Number) VALUES ('testcontact3', 'custom field value', 'custom field value', 123)

Update

The Sync App supports updating contact information.

Additionally, it is possible to update contact custom fields data from the Contacts table.

UPDATE Contacts SET FirstName = 'updatedName' WHERE Id = 1

UPDATE Contacts SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1

Bulk Import Contacts

The Sync App supports uploading large numbers of contacts into your account. This operation includes:

Creating new contacts
Updating existing contacts
Subscribing and unsubscribing from lists

Contacts are imported in batches of up to 250 items. The importer is not recommended to be used for a small number of contacts. You can import contacts as below:

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

UPSERT INTO Contacts (Email) SELECT Email FROM Contacts#TEMP

Additionally, the Sync App supports BULK INSERT for the Contacts table. Please note this operation will cause a cost in performance as the Sync App validates if the submitted contacts exist before importing them.

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

INSERT INTO Contacts (Email) SELECT Email FROM Contacts#TEMP

To subscribe and unsubscribe contacts from a specific list set a value for the SubscribeTo and/or UnsubcribeFrom columns which accept a comma-separated list of list ids. For example:

INSERT INTO Contacts#TEMP (Email, SubscribeTo, UnsubcribeFrom) VALUES ('[email protected]', '1,2', '6,12')

INSERT INTO Contacts#TEMP (Email, SubscribeTo, UnsubcribeFrom) VALUES ('[email protected]', '3,7', '6,1')

UPSERT INTO Contacts (Email, SubscribeTo, UnsubcribeFrom) SELECT Email, SubscribeTo, UnsubcribeFrom FROM Contacts#TEMP

Contacts must meet all the following criteria in order to be created or updated with this API:

The imported contacts may not exceed your account limit
The contact must have an email address
The contact's email address must not be on an exclusion list
The contact's email must not be on a list of bounced email addresses
The contact must not have unsubscribed to a list that the import would add them to

If contacts do not meet all of these requirements, they will be skipped by the importer.

Delete

Remove all contacts or a contact by specifying the Id of the contact.

DELETE FROM Contacts WHERE Id = 10003

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Contacts table.
Adate	Datetime	True	The Adate column of the Contacts table.
Anonymized	String	True	The Anonymized column of the Contacts table.
BouncedDate	String	True	The BouncedDate column of the Contacts table.
BouncedHard	String	True	The BouncedHard column of the Contacts table.
BouncedSoft	String	True	The BouncedSoft column of the Contacts table.
Cdate	Datetime	True	The Cdate column of the Contacts table.
CreatedBy	String	True	The CreatedBy column of the Contacts table.
CreatedTimestamp	Datetime	True	The CreatedTimestamp column of the Contacts table.
CreatedUtcTimestamp	Datetime	True	The CreatedUtcTimestamp column of the Contacts table.
Deleted	String	True	The Deleted column of the Contacts table.
DeletedAt	String	True	The DeletedAt column of the Contacts table.
Edate	Datetime	True	The Edate column of the Contacts table.
Email	String	False	The Email column of the Contacts table.
EmailDomain	String	True	The EmailDomain column of the Contacts table.
EmailEmpty	Boolean	True	The EmailEmpty column of the Contacts table.
EmailLocal	String	True	The EmailLocal column of the Contacts table.
FirstName	String	False	The FirstName column of the Contacts table.
Gravatar	String	True	The Gravatar column of the Contacts table.
Hash	String	True	The Hash column of the Contacts table.
Ip	String	True	The Ip column of the Contacts table.
LastName	String	False	The LastName column of the Contacts table.
AccountContactsLink	String	True	The AccountContactsLink column of the Contacts table.
AutomationEntryCountsLink	String	True	The AutomationEntryCountsLink column of the Contacts table.
BounceLogsLink	String	True	The BounceLogsLink column of the Contacts table.
ContactAutomationsLink	String	True	The ContactAutomationsLink column of the Contacts table.
ContactDataLink	String	True	The ContactDataLink column of the Contacts table.
ContactDealsLink	String	True	The ContactDealsLink column of the Contacts table.
ContactGoalsLink	String	True	The ContactGoalsLink column of the Contacts table.
ContactListsLink	String	True	The ContactListsLink column of the Contacts table.
ContactLogsLink	String	True	The ContactLogsLink column of the Contacts table.
ContactTagsLink	String	True	The ContactTagsLink column of the Contacts table.
DealsLink	String	True	The DealsLink column of the Contacts table.
FieldValuesLink	String	True	The FieldValuesLink column of the Contacts table.
GeoIpsLink	String	True	The GeoIpsLink column of the Contacts table.
NotesLink	String	True	The NotesLink column of the Contacts table.
OrganizationLink	String	True	The OrganizationLink column of the Contacts table.
PlusAppendLink	String	True	The PlusAppendLink column of the Contacts table.
ScoreValuesLink	String	True	The ScoreValuesLink column of the Contacts table.
TrackingLogsLink	String	True	The TrackingLogsLink column of the Contacts table.
Organization	String	True	The Organization column of the Contacts table.
Orgname	String	True	The Orgname column of the Contacts table.
Phone	String	False	The Phone column of the Contacts table.
RatingTStamp	String	True	The RatingTStamp column of the Contacts table.
SegmentioId	String	True	The SegmentioId column of the Contacts table.
Sentcnt	String	True	The Sentcnt column of the Contacts table.
SocialdataLastcheck	String	True	The SocialdataLastcheck column of the Contacts table.
Ua	String	True	The Ua column of the Contacts table.
Udate	Datetime	True	The Udate column of the Contacts table.
UpdatedTimestamp	String	True	The UpdatedTimestamp column of the Contacts table.
Updated_by	String	True	The Updated_by column of the Contacts table.
SubscribeTo	String	False	Comma-separated list of list Ids to subscribe a contact to.
UnsubscribeFrom	String	False	Comma-separated list of list Ids to unsubscribe a contact from.

DealCustomFieldData

Create, modify, delete and query the available deal custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealCustomFieldData WHERE Id = 10003

SELECT * FROM DealCustomFieldData WHERE DealId = 1

Insert

Inserting a deal custom field data requires specifying a value for the DealId, CustomFieldId, and FieldValue columns.

Additionally, the Sync App supports inserting deal custom fields data from the Deals table. See Deals for more information.

INSERT INTO DealCustomFieldData (FieldValue, CustomFieldId, DealId) VALUES ('custom field value', 1, 5)

Update

The Sync App supports updating deal custom field data information. Updating deal custom field data requires specifying a value for the Id, DealId and CustomFieldId columns.

Additionally, it is possible to update deal custom fields data from the Deals table.

UPDATE DealCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND DealId = 3 AND CustomFieldId = 2

Delete

The Sync App supports removing deal custom field data.

DELETE FROM DealCustomFieldData WHERE Id = 10

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id column of the DealCustomFieldData table.
CreatedTimestamp	Datetime	False	The CreatedTimestamp column of the DealCustomFieldData table.
CustomFieldName	String	True	The name of the custom field metum the field value relates to.
CustomFieldId	Integer	False	The CustomFieldId column of the DealCustomFieldData table.
DealCustomFieldMetumId	Integer	False	The DealCustomFieldMetumId column of the DealCustomFieldData table.
DealId	Integer	False	The DealId column of the DealCustomFieldData table.
FieldValue	String	False	The FieldValue column of the DealCustomFieldData table.
DealLink	String	False	The DealLink column of the DealCustomFieldData table.
DealCustomFieldMetumLink	String	False	The DealCustomFieldMetumLink column of the DealCustomFieldData table.
UpdatedTimestamp	Datetime	False	The UpdatedTimestamp column of the DealCustomFieldData.
FieldCurrency	String	False	Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.
FieldType	String	False	Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.

DealGroups

Lists all existing accounts.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealGroups WHERE Id = 10003

SELECT * FROM DealGroups WHERE Title = 'title'

Insert

Inserting a pipeline/dealgroup requires specifying a value for the Currency, Title columns.

INSERT INTO DealGroups (Currency, Title) VALUES (2, 300)

INSERT INTO DealGroups (Currency, Title, AutoAssign, AllUsers, AllGroups) VALUES ('USD', 'title', 1, 0, 1)

Update

The Sync App supports updating pipeline/dealgroup information.

UPDATE DealGroups SET AllUsers = 0, AllGroups = 1, Currency = 'EUR' WHERE Id = 1

Delete

Remove all pipelines or a pipeline by specifying the Id of the dealgroup.

DELETE FROM DealGroups WHERE Id = 10003

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The pipeline Id.
AllGroups	String	False	The AllGroups column of the DealGroups table. Indicates whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline.
AllUsers	String	False	The AllUsers column of the DealGroups table. Indicates whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter.
AutoAssign	String	False	The AutoAssign column of the DealGroups table. Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values.
Cdate	Datetime	True	The Cdate column of the DealGroups table.
Currency	String	False	The Currency column of the DealGroups table.
DealGroupGroupsLink	String	True	The DealGroupGroupsLink column of the DealGroups table.
DealGroupUsersLink	String	True	The DealGroupUsersLink column of the DealGroups table.
StagesLink	String	True	The StagesLink column of the DealGroups table.
Stages	String	True	The Stages column of the DealGroups table.
Title	String	False	Pipeline's title.
Udate	Datetime	True	The Udate column of the DealGroups table.

Deals

Usage information for the operation Deals.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Deals WHERE Id = 10

SELECT * FROM Deals WHERE GroupId = 1

SELECT * FROM Deals WHERE OwnerId = 1

SELECT * FROM Deals WHERE Stage = 1 AND Title = 'title'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the DealCustomFieldData table.

Insert

Inserting a deal requires specifying a value for the GroupId, Stage, OwnerId, Title, Value, Currency columns and a value for AccountId or ContactId column.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency) VALUES (1, 1, 1, 1, 'title', 100, 'USD')

INSERT INTO Deals (Email, FirstName, LastName, Phone) VALUES ('[email protected]', 'test', 'test', 'dealphonenumber')

Additionally, the Sync App supports inserting deal and deal custom fields data from the Deals table. All custom field columns start with CF_.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency, CF_CustomField1, CF_CustomField2, CF_CustomField3) VALUES (1, 1, 1, 1, 'title', 100, 'USD', 'value', 'value', 'value')

Update

The Sync App supports updating deal information.

Additionally, it is possible to update deal custom fields data from the Deals table.

UPDATE Deals SET Title = 'updatedTitle' WHERE Id = 1

UPDATE Deals SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1

Delete

Remove all deals or a deal by specifying the Id of the deal.

DELETE FROM Deals

DELETE FROM Deals WHERE Id = 10003

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Deals table.
AccountId	String	False	The AccountId column of the Deals table.
ActivityCount	String	True	The ActivityCount column of the Deals table.
Cdate	Datetime	True	The Cdate column of the Deals table.
ContactId	String	False	Deal's primary contact's Id.
Currency	String	False	Deal's currency in 3-digit ISO format, lowercased.
CustomerAccount	String	True	The CustomerAccount column of the Deals table.
Description	String	False	The Description column of the Deals table.
Edate	String	True	The Edate column of the Deals table.
Group	String	False	Deal's pipeline Id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically.
Hash	String	True	The Hash column of the Deals table.
IsDisabled	String	True	The IsDisabled column of the Deals table.
AccountLink	String	True	The AccountLink column of the Deals table.
ContactLink	String	True	The ContactLink column of the Deals table.
ContactDealsLink	String	True	The ContactDealsLink column of the Deals table.
CustomerAccountLink	String	True	The CustomerAccountLink column of the Deals table.
DealActivitiesLink	String	True	The DealActivitiesLink column of the Deals table.
DealCustomFieldDataLink	String	True	The DealCustomFieldDataLink column of the Deals table.
GroupLink	String	True	The GroupLink column of the Deals table.
NextTaskLink	String	True	The NextTaskLink column of the Deals table.
NotesLink	String	True	The NotesLink column of the Deals table.
OrganizationLink	String	True	The OrganizationLink column of the Deals table.
OwnerLink	String	True	The OwnerLink column of the Deals table.
ScoreValuesLink	String	True	The ScoreValuesLink column of the Deals table.
StageLink	String	True	The StageLink column of the Deals table.
TasksLink	String	True	The TasksLink column of the Deals table.
Mdate	Datetime	True	The Mdate column of the Deals table.
NextTask	String	True	The NextTask column of the Deals table.
NextDate	Datetime	True	The NextDate column of the Deals table.
NextDealId	String	True	The NextDealId column of the Deals table.
NextTaskId	String	True	The NextTaskId column of the Deals table.
Organization	String	True	The Organization column of the Deals table.
Owner	String	False	Deal's owner Id. Required if pipeline's auto-assign option is disabled.
Percent	String	False	The Percent column of the Deals table.
Stage	String	False	Deal's stage Id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group.
Status	String	False	The Status column of the Deals table.
Title	String	False	The Title column of the Deals table.
Value	String	False	Deal's value in cents.
WinProbability	Integer	True	The WinProbability column of the Deals table.
WinProbabilityMdate	Datetime	True	The WinProbabilityMdate column of the Deals table.

DealStages

Usage information for the operation DealStages.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealStages WHERE Id = 10003

SELECT * FROM DealStages WHERE Title = 'title' AND GroupId = 1

Insert

Inserting a stage requires specifying a value for the GroupId, Title columns.

INSERT INTO DealStages (GroupId, Title) VALUES (2, 'title')

INSERT INTO DealStages (Title, GroupId, OrderId, CardRegion3, Color, Width) VALUES ('TestStage', 1, 2, 'hide-avatar', '434343', '280')

Update

The Sync App supports updating stage/dealstage information.

UPDATE DealStages SET Title = 'updatedTitle' WHERE Id = 1

Delete

Remove all stages or a stage by specifying the Id of the stage.

DELETE FROM DealStages WHERE Id = 10003

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the DealStages table.
CardRegion1	String	False	The CardRegion1 column of the DealStages table. Indicates what to show in upper-left corner of Deal Cards.
CardRegion2	String	False	The CardRegion2 column of the DealStages table. Indicates what to show in upper-right corner of Deal Cards.
CardRegion3	String	False	The CardRegion3 column of the DealStages table. Indicates whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars.
CardRegion4	String	False	The CardRegion4 column of the DealStages table. Indicates what to show next to the avatar in Deal Cards.
CardRegion5	String	False	The CardRegion5 column of the DealStages table. Indicates what to show in lower-right corner of Deal Cards.
Cdate	Datetime	True	The Cdate column of the DealStages table.
Color	String	False	Deal Stage's color. 6-character HEX color code without the hashtag. e.g. 434343 to assign the hex color value #434343.
DealOrder	String	False	Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either.
GroupId	String	False	The GroupId column of the DealStages table.
GroupLink	String	True	The GroupLink column of the DealStages table.
OrderId	String	False	The OrderId column of the DealStages table.
Title	String	False	The Title column of the DealStages table.
Udate	Datetime	True	The Udate column of the DealStages table.
Width	String	False	Deal stage's width in pixels, without px unit.

Tasks

Lists all existing accounts.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Tasks WHERE Id = 10003

SELECT * FROM Tasks WHERE DealTaskType = 1 

SELECT * FROM Tasks WHERE DueDate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE DueDate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE OutcomeId = 1 AND RelId = 1 AND Status = 1

Insert

Inserting a stage requires specifying a value for the DealTaskType, DueDate, Relid columns.

INSERT INTO Tasks (DealTaskType, DueDate, Relid) VALUES (2, '2021-06-30T10:44:34-05:00', 7)

Update

The Sync App supports updating stage/dealstage information.

UPDATE Tasks SET Title = 'updatedTitle' WHERE Id = 1

Delete

Remove all stages or a stage by specifying the Id of the stage.

DELETE FROM Tasks WHERE Id = 10003

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Tasks table.
Assignee	String	False	The Assignee column of the Tasks table.
Automation	String	True	The Automation column of the Tasks table.
Cdate	Datetime	True	The Cdate column of the Tasks table.
DealTaskType	String	False	The type of the task based on the available Task Types in the account.
DoneAutomation	String	False	The DoneAutomation column of the Tasks table.
DueDate	Datetime	False	Due date of the task.
Edate	Datetime	True	The Edate column of the Tasks table.
ActivitiesLink	String	True	The ActivitiesLink column of the Tasks table.
AssigneeLink	String	True	The AssigneeLink column of the Tasks table.
AutomationLink	String	True	The AutomationLink column of the Tasks table.
DealTasktypeLink	String	True	The DealTasktypeLink column of the Tasks table.
DoneAutomationLink	String	True	The DoneAutomationLink column of the Tasks table.
NotesLink	String	True	The NotesLink column of the Tasks table.
OwnerLink	String	True	The OwnerLink column of the Tasks table.
TaskNotificationsLink	String	True	The TaskNotificationsLink column of the Tasks table.
UserLink	String	True	The UserLink column of the Tasks table.
Note	String	False	The content describing the task.
OutcomeId	Integer	False	The OutcomeId column of the Tasks table.
OutcomeInfo	String	False	The OutcomeInfo column of the Tasks table.
OwnerId	String	True	The OwnerId column of the Tasks table.
OwnerType	String	False	The name of the relating object. Valid values are contact or deal.
Relid	String	False	The Id of the relational object for this task.
Reltype	String	True	The Reltype column of the Tasks table.
Status	Integer	False	The Status column of the Tasks table. 1 is complete and 0 is incomplete..
Title	String	False	The Title column of the Tasks table.
Udate	Datetime	True	The Udate column of the Tasks table.
User	String	True	The User column of the Tasks table.

ビュー

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

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

ActiveCampaign Connector for CData Sync ビュー


Name	Description
Addresses	Usage information for the operation Addresses.rsd.
Automations	Usage information for the operation Automations.rsd.
Campaigns	Query the campaigns information in ActiveCampaign.
ContactAutomations	View many or all contacts by including their ID's or various filters.
ContactLists	Retrieve ContactList for each contact Group or for the specific Contact group.
ContactTags	Retrieve tags added for each contact or for the specific Contact Id
DealActivities	Retrieve Deal Activities for each Deal or for the specific Deal Id.
Lists	Usage information for the operation Lists.rsd.
Scores	View many or all contacts by including their ID's or various filters.
Tags	View many or all tags by including their ID's or various filters.
TrackingLogs	Retrieve trackingLogs for the specific contact or all contacts
Users	Usage information for the operation Users.rsd.

Addresses

Usage information for the operation Addresses.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM AccountContacts WHERE Id = 10003

Columns


Name	Type	Description
Id	String	The Id column of the Addresses table.
Address1	String	The Address1 column of the Addresses table.
Address2	String	The Address2 column of the Addresses table.
Allgroup	String	The Allgroup column of the Addresses table.
City	String	The City column of the Addresses table.
CompanyName	String	The CompanyName column of the Addresses table.
Country	String	The Country column of the Addresses table.
District	String	The District column of the Addresses table.
isDefault	String	The isDefault column of the Addresses table.
AddressGroupLink	String	The AddressGroupLink column of the Addresses table.
AddressListLink	String	The AddressListLink column of the Addresses table.
FormsLink	String	The FormsLink column of the Addresses table.
State	String	The State column of the Addresses table.
Zip	String	The Zip column of the Addresses table.

Automations

Usage information for the operation Automations.rsd.

Columns


Name	Type	Description
Id	String	The Id column of the Automations table.
Cdate	Datetime	The Cdate column of the Automations table.
DefaultScreenshot	String	The DefaultScreenshot column of the Automations table.
Entered	String	The Entered column of the Automations table.
Exited	String	The Exited column of the Automations table.
Hidden	String	The Hidden column of the Automations table.
BlocksLink	String	The BlocksLink column of the Automations table.
CampaignsLink	String	The CampaignsLink column of the Automations table.
ContactAutomationsLink	String	The ContactAutomationsLink column of the Automations table.
ContactGoalsLink	String	The ContactGoalsLink column of the Automations table.
GoalsLink	String	The GoalsLink column of the Automations table.
SiteMessagesLink	String	The SiteMessagesLink column of the Automations table.
SmsLink	String	The SmsLink column of the Automations table.
Mdate	Datetime	The Mdate column of the Automations table.
Name	String	The Name column of the Automations table.
Screenshot	String	The Screenshot column of the Automations table.
Status	String	The Status column of the Automations table.
UserId	String	The UserId column of the Automations table.

Campaigns

Query the campaigns information in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Campaigns WHERE Id = 10003

Columns


Name	Type	Description
Id [KEY]	String	The Id column of the Campaigns table.
ActiveRssInterval	String	The ActiveRssInterval column of the Campaigns table.
ActiveRssItems	String	The ActiveRssItems column of the Campaigns table.
ActiveRssUrl	String	The ActiveRssUrl column of the Campaigns table.
AddressId	String	The AddressId column of the Campaigns table.
AnalyticsCampaignName	String	The AnalyticsCampaignName column of the Campaigns table.
Automation	String	The Automation column of the Campaigns table.
BaseMessageId	String	The BaseMessageId column of the Campaigns table.
BaseTemplateId	String	The BaseTemplateId column of the Campaigns table.
BounceId	String	The BounceId column of the Campaigns table.
CanSkipApproval	String	The can_skip_approval column of the Campaigns table.
Cdate	Datetime	The Cdate column of the Campaigns table.
CreatedBy	String	The Created By column of the Campaigns table.
CreatedTimestamp	Datetime	The Created Timestamp column of the Campaigns table.
DeleteStamp	String	The DeleteStamp column of the Campaigns table.
EmbedImages	String	The EmbedImages column of the Campaigns table.
Facebook	String	The Facebook column of the Campaigns table.
FormId	String	The FormId column of the Campaigns table.
Forwards	String	The Forwards column of the Campaigns table.
HardBounces	String	The HardBounces column of the Campaigns table.
HasPredictiveContent	Bit	The HasPredictiveContent column of the Campaigns table.
HtmlUnsub	String	The HtmlUnsub column of the Campaigns table.
HtmlUnsubdata	String	The HtmlUnsubdata column of the Campaigns table.
Ip	String	The Ip column of the Campaigns table.
Ip4	String	The Ip4 column of the Campaigns table.
LastStep	String	The LastStep column of the Campaigns table.
Ldate	String	The Ldate column of the Campaigns table.
LinkClicks	String	The LinkClicks column of the Campaigns table.
AutomationLink	String	The AutomationLink column of the Campaigns table.
CampaignAggregateRevenuesLink	String	The AggregateRevenues column of the Campaigns table.
CampaignListsLink	String	The CampaignListsLink column of the Campaigns table.
CampaignMessageLink	String	The CampaignMessageLink column of the Campaigns table.
CampaignMessagesLink	String	The CampaignMessagesLink column of the Campaigns table.
LinksLink	String	The LinksLink column of the Campaigns table.
LinksSegment	String	The Segment column of the Campaigns table.
UserLink	String	The UserLink column of the Campaigns table.
MailCleanup	String	The MailCleanup column of the Campaigns table.
MailSend	String	The MailSend column of the Campaigns table.
MailTransfer	String	The MailTransfer column of the Campaigns table.
MailerLogFile	String	The MailerLogFile column of the Campaigns table.
ManageText	String	The ManageText column of the Campaigns table.
Mdate	Datetime	The Mdate column of the Campaigns table.
Name	String	The Name column of the Campaigns table.
Opens	String	The Opens column of the Campaigns table.
Public	String	The Public column of the Campaigns table.
RealCid	String	The RealCid column of the Campaigns table.
Recurring	String	The Recurring column of the Campaigns table.
ReminderField	String	The ReminderField column of the Campaigns table.
ReminderFormat	String	The ReminderFormat column of the Campaigns table.
ReminderLastCronRun	String	The ReminderLastCronRun column of the Campaigns table.
ReminderOffset	String	The ReminderOffset column of the Campaigns table.
ReminderOffsetSign	String	The ReminderOffsetSign column of the Campaigns table.
ReminderOffsetType	String	The ReminderOffsetType column of the Campaigns table.
ReminderType	String	The ReminderType column of the Campaigns table.
Replies	String	The Replies column of the Campaigns table.
ReplySys	String	The ReplySys column of the Campaigns table.
ResponderExisting	String	The ResponderExisting column of the Campaigns table.
ResponderOffset	String	The ResponderOffset column of the Campaigns table.
ResponderType	String	The ResponderType column of the Campaigns table.
Schedule	String	The Schedule column of the Campaigns table.
ScheduledDate	String	The ScheduledDate column of the Campaigns table.
Screenshot	String	The Screenshot column of the Campaigns table.
Sdate	String	The Sdate column of the Campaigns table.
SegmentId	String	The SegmentId column of the Campaigns table.
SegmentName	String	The SegmentName column of the Campaigns table.
SendAmt	String	The SendAmt column of the Campaigns table.
SendId	String	The SendId column of the Campaigns table.
SeriesId	String	The SeriesId column of the Campaigns table.
Series Send Lock Time	String	The SeriesSendLockTime column of the Campaigns table.
SocialShares	String	The SocialShares column of the Campaigns table.
SoftBounces	String	The SoftBounces column of the Campaigns table.
Source	String	The Source column of the Campaigns table.
SplitContent	String	The SplitContent column of the Campaigns table.
SplitOffset	String	The SplitOffset column of the Campaigns table.
SplitOffsetType	String	The SplitOffsetType column of the Campaigns table.
SplitType	String	The SplitType column of the Campaigns table.
SplitWinnerAwaiting	String	The SplitWinnerAwaiting column of the Campaigns table.
SplitWinnerMessageId	String	The SplitWinnerMessageId column of the Campaigns table.
Status	String	The Status column of the Campaigns table.
SubscriberClicks	String	The SubscriberClicks column of the Campaigns table.
Survey	String	The Survey column of the Campaigns table.
TextUnsub	String	The TextUnsub column of the Campaigns table.
TextUnsubData	String	The TextUnsubData column of the Campaigns table.
ThreadId	String	The ThreadId column of the Campaigns table.
TotalAmt	String	The TotalAmt column of the Campaigns table.
TrackLinks	String	The TrackLinks column of the Campaigns table.
TrackLinksAnalytics	String	The TrackLinksAnalytics column of the Campaigns table.
TrackReads	String	The TrackReads column of the Campaigns table.
TrackReadsAnalytics	String	The TrackReadsAnalytics column of the Campaigns table.
Tweet	String	The Tweet column of the Campaigns table.
Type	String	The Type column of the Campaigns table.
UniqueForwards	String	The UniqueForwards column of the Campaigns table.
UniqueLinkClicks	String	The UniqueLinkClicks column of the Campaigns table.
UniqueOpens	String	The UniqueOpens column of the Campaigns table.
UniqueReplies	String	The UniqueReplies column of the Campaigns table.
UnsubReasons	String	The UnsubReasons column of the Campaigns table.
Unsubscribes	String	The Unsubscribes column of the Campaigns table.
Updated By	String	The UpdatedBy column of the Campaigns table.
Updated Timestamp	String	The UpdatedTimestamp column of the Campaigns table.
Updates	String	The Updates column of the Campaigns table.
User	String	The User column of the Campaigns table.
UserId	String	The UserId column of the Campaigns table.
WaitPreview	String	The WaitPreview column of the Campaigns table.
WillRecur	String	The WillRecur column of the Campaigns table.

ContactAutomations

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM ContactAutomations WHERE Id = 10003

Columns


Name	Type	Description
Id	String	The Id column of the ContactAutomations table.
Adddate	Datetime	The Adddate column of the ContactAutomations table.
Automation	String	The Automation column of the ContactAutomations table.
Batchid	Unknown	The Batchid column of the ContactAutomations table.
CompleteValue	Integer	The CompleteValue column of the ContactAutomations table.
Completed	Integer	The Completed column of the ContactAutomations table.
CompletedElements	String	The CompletedElements column of the ContactAutomations table.
ContactId	String	The ContactId column of the ContactAutomations table.
Lastblock	String	The Lastblock column of the ContactAutomations table.
Lastdate	Datetime	The Lastdate column of the ContactAutomations table.
LastLogId	String	The LastLogId column of the ContactAutomations table.
AutomationLink	String	The AutomationLink column of the ContactAutomations table.
ContactLink	String	The ContactLink column of the ContactAutomations table.
ContactGoalsLink	String	The ContactGoalsLink column of the ContactAutomations table.
Remdate	Datetime	The Remdate column of the ContactAutomations table.
SeriesId	String	The SeriesId column of the ContactAutomations table.
StartId	String	The StartId column of the ContactAutomations table.
Status	String	The Status column of the ContactAutomations table.
TimeSpan	String	The TimeSpan column of the ContactAutomations table.
TotalElements	String	The TotalElements column of the ContactAutomations table.

ContactLists

Retrieve ContactList for each contact Group or for the specific Contact group.

Table Specific Information

Select

Retrieving information from ContactLists requires specifying a ContactId.

SELECT * FROM ContactLists WHERE ContactId = 1000

Columns


Name	Type	Description
Id [KEY]	String	The Id column of the ContactLists table.
ContactId	String	The ContactId column of the ContactLists table.
AutomationId	String	The AutomationId column of the ContactLists table.
AutosyncLog	String	The AutosyncLog column of the ContactLists table.
Campaign	String	The Campaign column of the ContactLists table.
CreatedBy	String	The CreatedBy column of the ContactLists table.
CreatedTimestamp	Datetime	The CreatedTimestamp column of the ContactLists table.
FirstName	String	The FirstName column of the ContactLists table.
Form	String	The Form column of the ContactLists table.
Ip4Sub	String	The Ip4Sub column of the ContactLists table.
Ip4Unsub	String	The Ip4Unsub column of the ContactLists table.
Ip4Last	String	The Ip4Last column of the ContactLists table.
LastName	String	The LastName column of the ContactLists table.
AutomationLink	String	The AutomationLink column of the ContactLists table.
AutosyncLogLink	String	The AutosyncLogLink column of the ContactLists table.
CampaignLink	String	The CampaignLink column of the ContactLists table.
ContactLink	String	The ContactLink column of the ContactLists table.
FormLink	String	The FormLink column of the ContactLists table.
ListLink	String	The ListLink column of the ContactLists table.
MessageLink	String	The MessageLink column of the ContactLists table.
UnsubscribeAutomationLink	String	The UnsubscribeAutomationLink column of the ContactLists table.
ListId	String	The ListId column of the ContactLists table.
Message	String	The Message column of the ContactLists table.
Responder	String	The Responder column of the ContactLists table.
Sdate	Datetime	The Sdate column of the ContactLists table.
SeriesId	String	The SeriesId column of the ContactLists table.
Status	String	The Status column of the ContactLists table.
SourceId	String	The SourceId column of the ContactLists table.
Sync	String	The Sync column of the ContactLists table.
Unsubreason	String	The Unsubreason column of the ContactLists table.
UnsubscribeAutomation	String	The UnsubscribeAutomation column of the ContactLists table.
UpdatedBy	String	The UpdatedBy column of the ContactLists table.
UpdatedTimestamp	Datetime	The UpdatedTimestamp column of the ContactLists table.

ContactTags

Retrieve tags added for each contact or for the specific Contact Id

Table Specific Information

Select

Retrieving information for ContactTags requires specifying a ContactId.

SELECT * FROM ContactTags WHERE ContactId = 1

Columns


Name	Type	Description
Id [KEY]	String	The Id column of the ContactTags table.
ContactId	String	The ContactId column of the ContactTags table.
Cdate	Datetime	The Cdate column of the ContactTags table.
CreatedBy	String	The CreatedBy column of the ContactTags table.
CreatedTimestamp	Datetime	The CreatedTimestamp column of the ContactTags table.
ContactLink	String	The ContactLink column of the ContactTags table.
TagLink	String	The TagLink column of the ContactTags table.
Tag	String	The Tag column of the ContactTags table.
UpdatedBy	String	The UpdatedBy column of the ContactTags table.
UpdatedTimestamp	Datetime	The UpdatedTimestamp column of the ContactTags table.

DealActivities

Retrieve Deal Activities for each Deal or for the specific Deal Id.

Columns


Name	Type	Description
Id [KEY]	String	The Id of the activity.
DealId	String	The Id of the Deal to which the activity belongs to.
StageId	String	The Id of the Stage to which the parent Deal of the activity belongs to.
UserId	String	The Id of the User which triggered the activity.
DataId	String	The Id for the related object (e.g. a Task or Note or similar), if relevant.
DataType	String	The type of the activity. Examples include 'userid' or 'subscriberid' or 'task' or 'note' or empty quotes ('') for the deal's initial creation.
DataAction	String	The action taken by this activity. Examples include 'add' or 'complete' or the new value ('100') if the value is changing.
DataOldVal	String	The previous value, if the value has changed (see DataAction); otherwise, empty quotes ('')
CreatedDate	Datetime	The creation date of the activity.
SortDate	Datetime
IsAddTask	Boolean	Indicates whether the activity was adding a task to the deal.
Deleted	Boolean	Indicates whethere the activity was deleted or not.
SeriesId	String
DealLink	String	The API endpoint to the Deal related to this activity.
StageLink	String	The API endpoint to the Stage related to this activity.
UserLink	String	The API endpoint to the User related to this activity.
AutomationLink	String	The API endpoint to the Automation related to this activity.
ActivityLink	String	The API endpoint to the Activity.
Deal	String	The related to this Activity.
Stage	String	The Stage column of the DealActivities table.
User	String	The User column of the DealActivities table.
Automation	String	The Automation which triggered this activity.

Pseudo-Columns

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


Name	Type	Description
Exclude	String	Include this param to exclude 'email', 'connection_email', and 'LinkData' activity types. 使用できる値は次のとおりです。email

Lists

Usage information for the operation Lists.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Lists WHERE Id = 1

SELECT * FROM Lists WHERE Name = 'list1'

In addition the Sync App supports retrieving information about members of lists in your account by supporting them dynamically as VIEWS. Selecting from a dynamic list will return information about all the contacts that are members of that list. Lists names always start with "List_".

Columns


Name	Type	Description
Id [KEY]	String	The Id column of the Lists table.
AnalyticsDomains	String	The AnalyticsDomains column of the Lists table.
AnalyticsSource	String	The AnalyticsSource column of the Lists table.
AnalyticsUa	String	The AnalyticsUa column of the Lists table.
CarbonCopy	String	The CarbonCopy column of the Lists table.
Cdate	Datetime	The Cdate column of the Lists table.
Udate	Datetime	The Udate column of the Lists table.
DeleteStamp	String	The DeleteStamp column of the Lists table.
FacebookSession	String	The FacebookSession column of the Lists table.
FullAddress	String	The FullAddress column of the Lists table.
UnsubscribeReason	String	The UnsubscribeReason column of the Lists table.
AddressListsLink	String	The AddressListsLink column of the Lists table.
ContactGoalListsLink	String	The ContactGoalListsLink column of the Lists table.
UserLink	String	The UserLink column of the Lists table.
Name	String	The Name column of the Lists table.
OptinMessageId	String	The OptinMessageId column of the Lists table.
OptinOptout	String	The OptinOptout column of the Lists table.
OptoutConf	String	The OptoutConf column of the Lists table.
EmbedImage	String	The EmbedImage column of the Lists table.
UseAnalyticsLink	String	The UseAnalyticsLink column of the Lists table.
UseAnalyticsRead	String	The UseAnalyticsRead column of the Lists table.
UseCaptcha	String	The UseCaptcha column of the Lists table.
UseFacebook	String	The UseFacebook column of the Lists table.
UseTracking	String	The UseTracking column of the Lists table.
UseTwitter	String	The UseTwitter column of the Lists table.
Private	String	The Private column of the Lists table.
RequireName	String	The RequireName column of the Lists table.
SendLastBroadcast	String	The SendLastBroadcast column of the Lists table.
SenderAddr1	String	The SenderAddr1 column of the Lists table.
SenderAddr2	String	The SenderAddr2 column of the Lists table.
SenderCity	String	The SenderCity column of the Lists table.
SenderCountry	String	The SenderCountry column of the Lists table.
SenderName	String	The SenderName column of the Lists table.
SenderPhone	String	The SenderPhone column of the Lists table.
SenderReminder	String	The SenderReminder column of the Lists table.
SenderState	String	The SenderState column of the Lists table.
SenderUrl	String	The SenderUrl column of the Lists table.
SenderZip	String	The SenderZip column of the Lists table.
StringId	String	The StringId column of the Lists table.
SubscriptionNotify	String	The SubscriptionNotify column of the Lists table.
ToName	String	The ToName column of the Lists table.
TwitterToken	String	The TwitterToken column of the Lists table.
TwitterTokenSecret	String	The TwitterTokenSecret column of the Lists table.
UnsubscriptionNotify	String	The UnsubscriptionNotify column of the Lists table.
ListsUser	String	The ListsUser column of the Lists table.
ListsUserid	String	The ListsUserid column of the Lists table.

Scores

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Scores WHERE Id = 10

Columns


Name	Type	Description
Id	String	The Id column of the Scores table.
Cdate	Datetime	The Cdate column of the Scores table.
Descript	String	The Descript column of the Scores table.
Mdate	Datetime	The Mdate column of the Scores table.
Name	String	The Name column of the Scores table.
RelType	String	The RelType column of the Scores table.
Status	String	The Status column of the Scores table.

TrackingLogs

Retrieve trackingLogs for the specific contact or all contacts

Columns


Name	Type	Description
Id [KEY]	String	The Id column of the TrackingLogs table.
ContactId	String	The ContactId column of the TrackingLogs table.
Hash	String	The Hash column of the TrackingLogs table.
ContactLink	String	The ContactLink column of the TrackingLogs table.
SubscriberidLink	String	The SubscriberidLink column of the TrackingLogs table.
TstampLink	Datetime	The TstampLink column of the TrackingLogs table.
TypeLink	String	The TypeLink column of the TrackingLogs table.
ValueLink	String	The ValueLink column of the TrackingLogs table.

Pseudo-Columns

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


Name	Type	Description
UDateLink	Datetime

Users

Usage information for the operation Users.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = 10003

Columns


Name	Type	Description
Id	String	The Id column of the Users table.
Email	String	The Email column of the Users table.
FirstName	String	The FirstName column of the Users table.
LastName	String	The LastName column of the Users table.
ConfigsLink	String	The ConfigsLinks column of the Users table.
DealGroupTotalsLink	String	The DealGroupTotalsLink column of the Users table.
DealGroupUsersLink	String	The DealGroupUsersLink column of the Users table.
ListsLink	String	The ListsLink column of the Users table.
UserGroupLink	String	The UserGroupLink column of the Users table.
Phone	Unknown	The Phone column of the Users table.
Signature	Unknown	The Signature column of the Users table.
Username	String	The Username column of the Users table.

接続文字列オプション

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

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

Authentication

プロパティ	説明
APIKey	The APIKey obtained from the ActiveCampaign UI.
URL	Base URL which is used to access the API.

SSL

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

Firewall

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

Proxy

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

Logging

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

Schema

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

Miscellaneous

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	The maximum number of results to return per page from ActiveCampaign.
PaginationMode	Specifies the type of pagination to use: either ID-based (which works only with Contacts ) or limit-offset (default). Use limit-offset pagination with the limit and offset parameters. Use ID-based pagination with the limit, id_greater and orders[id] parameters.
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Authentication

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

プロパティ	説明
APIKey	The APIKey obtained from the ActiveCampaign UI.
URL	Base URL which is used to access the API.

APIKey

The APIKey obtained from the ActiveCampaign UI.

解説

API key can be found in your account on the Settings page under the "Developer" tab. Each user in your ActiveCampaign account has their own unique API key.

URL

Base URL which is used to access the API.

解説

URL can be found in your account on the My Settings page under the "Developer" tab. For example: https://{yourAccountName}.api-us1.com

SSL

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

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

SSLServerCert

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

解説

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

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


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

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

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

Firewall

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

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

FirewallType

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

解説

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

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

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

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


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

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

FirewallServer

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

解説

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

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

FirewallPort

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

解説

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

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

FirewallUser

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

解説

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

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

FirewallPassword

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

解説

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

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

Proxy

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

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

ProxyAutoDetect

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

解説

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

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

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

ProxyServer

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

解説

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

ProxyPort

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

解説

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

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

ProxyAuthScheme

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

解説

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

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

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

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

ProxyUser

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

解説

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

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


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

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

ProxyPassword

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

解説

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

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


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

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

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

ProxySSLType

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

解説

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


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

ProxyExceptions

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

解説

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

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

Logging

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

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

LogModules

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

解説

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

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

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

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

Schema

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

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

Location

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

解説

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

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


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

BrowsableSchemas

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

解説

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

Tables

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

解説

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

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

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

Views

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

解説

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

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

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

Miscellaneous

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

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	The maximum number of results to return per page from ActiveCampaign.
PaginationMode	Specifies the type of pagination to use: either ID-based (which works only with Contacts ) or limit-offset (default). Use limit-offset pagination with the limit and offset parameters. Use ID-based pagination with the limit, id_greater and orders[id] parameters.
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

MaxRows

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

解説

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

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

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

Other

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

解説

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

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

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

統合およびフォーマット


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

Pagesize

The maximum number of results to return per page from ActiveCampaign.

解説

The Pagesize property affects the maximum number of results to return per page from ActiveCampaign. ActiveCampaign allows a maximum of 100 records to be returned in each page.

PaginationMode

Specifies the type of pagination to use: either ID-based (which works only with Contacts ) or limit-offset (default). Use limit-offset pagination with the limit and offset parameters. Use ID-based pagination with the limit, id_greater and orders[id] parameters.

解説

Since ID-based pagination currently works only with Contacts, if you specify the LimitID enum, only Contacts is paginated in that fashion; the pagination for other entities in the data model uses limit-offset pagination. You can use the PageSize connection property to control the number of rows returned per request in both cases.
ActiveCampaign recommends using LimitID pagination if you have a large number of records for better performance.
Since ID-based pagination is serial, the MaxThreads connection property can only be used with limit-offset pagination.

PseudoColumns

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

解説

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

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

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

Timeout

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

解説

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

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

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

UserDefinedViews

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

解説

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

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

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

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

ActiveCampaign Connector for CData Sync

ActiveCampaign Connector for CData Sync

概要

ActiveCampaign バージョンサポート

接続の確立

ActiveCampaign への接続を追加

ActiveCampaign への接続

データモデル

概要

ビュー

ダイナミックビュー

テーブル

テーブル

ActiveCampaign Connector for CData Sync テーブル

AccountContacts

Table Specific Information

Select

Insert

Update

Delete

Columns

AccountCustomFieldData

Table Specific Information

Select

Insert

Update

Delete

Columns

Accounts

Table Specific Information

Select

Insert

Update

Delete

Columns

ContactCustomFieldData

Table Specific Information

Select

Insert

Update

Delete

Columns

Contacts

Table Specific Information

Select

Insert

Update

Bulk Import Contacts

Delete

Columns

DealCustomFieldData

Table Specific Information

Select

Insert

Update

Delete

Columns

DealGroups

Table Specific Information

Select

Insert

Update

Delete

Columns

Deals

Table Specific Information

Select

Insert

Update

Delete

Columns

DealStages

Table Specific Information

Select

Insert

Update

Delete

Columns

Tasks

Table Specific Information