TDV Adapter for Twitter Ads

Build 24.0.9060

AdLineItems

Retrieve some or all funding instruments associated with the account specified.

View Specific Information

Select

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the adapter will try to get the first account from the list returned by the AdAccount view.

Columns

Name Type Description
Id [KEY] String The unique line item Id. Used to identify a specific line item.
AccountId String The identifier for the leveraged account.
CampaignId String The Id of the campaign to work with.
Name String A name assigned to the line item. If left blank, the name will default to Untitled.
TotalBudget Long An number representing the bid amount associated with this line item. The currency associated with the specified funding instrument will be used. For USD, $1.50 is encoded as 1.50*1e6, or 1,500,000.
BidType String The bidding mechanism.
AutomaticallySelectBid Boolean [DEPRECATED] This boolean parameter, when set to true, will automatically optimize bidding based on daily budget and campaign flight dates.
ProductType String The type of promoted product that this line item will contain.
Placements String The comma-separated list of placement locations for this line item to display in.
Objective String The campaign objective for this line item.
EntityStatus String The status for this entity: ACTIVE, DRAFT, and PAUSED.
IncludeSentiment String Whether this line item is targeted to tweets with both positive or negative sentiment. A tweet is said to have positive or negative sentiment if the tone of the tweet is positive. This is only valid for the ProductType of PROMOTED_TWEETS and with either placements of ALL_ON_TWITTER or TWITTER_TIMELINES. Possible values: POSITIVE_ONLY (default) targets only tweets with positive sentiment; ALL targets all tweets, including those with negative sentiment.
TotalBudgetAmountLocalMicro Long An number representing the total budget amount to be allocated to the line item. The currency associated with the specified funding instrument and campaign will be used. For USD, $37.50 is encoded as 37.50*1e6, or 37,500,000.
StartTime Datetime The UTC time that the line item will begin serving. Must be more recent than the current time.
EndTime Datetime The UTC time that the line item will stop serving. If specified, must be more recent than the StartTime of the line item.
PrimaryWebEventTag String The identifier of the primary Web event tag. Allows more accurate tracking of engagements for the campaign pertaining to this line item.
ChargeBy String This field is returned for line items using the APP_INSTALLS objective. Defaults to charging by bid unit except for line items with bid unit APP_INSTALLS, where it defaults to charging by app clicks.
AdvertiserDomain String The website domain for this advertiser, without protocol specification. This field is available for line items using the Twitter Audience Platform (TAP).
Categories String The relevant IAB categories for this advertiser. This setting is available for line items using the Twitter Audience Platform (TAP).
TargetCPALocalMicro Integer An integer representing the target CPA amount to be allocated to the line item. The currency associated with the specified funding instrument and campaign will be used. For USD, $5.50 is encoded as 5.50*1e6, or 5,500,000.
CreatedAt Datetime The time when the campaign was created.
UpdatedAt Datetime The time of the last change of the properties of this campaign.
Goal String The optimization setting used with this line item.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060