CData Python Connector for LinkedIn Marketing Solutions

Build 25.0.9440

Campaigns

The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.

Table Specific Information

NOTE: The Account column is deprecated and will be removed in the next major version of the 本製品.

Select

The Campaigns view returns a list of the campaigns that belong to the authenticated user so they can be used as dimensions in analytic requests.

The 本製品 uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The 本製品 processes other filters client-side within the 本製品. For example, the following queries are processed server side.

SELECT * FROM Campaigns WHERE Status = 'ACTIVE'

SELECT * FROM Campaigns WHERE AdAccountId = '510013292'

CUD Operations

Insert

To create a new campaign there are some fields that are required in initial creation which are: Account, CampaignGroup, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, Status, Type, UnitCostAmount, UnitCostCurrency, AdAccountId.

While the following parameters are optional: AssociatedEntity, AudienceExpansionEnabled, CostType, CreativeSelection, ScheduleEndTime, ObjectiveType, ConnectedTelevisionOnly, TimeSpanDuration, TimeSpanUnit, Frequency, OptimizationType, OptimizationTargetType, BlockedIABCategories, AllowedPublisherRestrictionFiles, BlockedPublisherRestrictionFiles.

     "INSERT INTO Campaigns ( Id, Account, CampaignGroup, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, ScheduleEndTime, Status, Type, UnitCostAmount, UnitCostCurrency, AdAccountId ) VALUES ( 'camp789', 'urn:li:sponsoredAccount:515218099', 'urn:li:sponsoredCampaignGroup:756063323', '150.00', 'USD', 'US', 'en', 'Spring Lead Generation 4', FALSE, '2025-07-01 09:00:00', '2025-07-31 23:59:59', 'DRAFT', 'TEXT_AD', '2.50', 'USD', '515218099' );"
 

Update

To modify an existing campaign group, use an UPDATE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: CampaignGroup, AssociatedEntity, AudienceExpansionEnabled, CostType, CreativeSelection, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, ScheduleEndTime, Status, UnitCostAmount, UnitCostCurrency, ObjectiveType, TimeSpanDuration, TimeSpanUnit, Frequency, OptimizationType, OptimizationTargetType, BlockedIABCategories, AllowedPublisherRestrictionFiles, BlockedPublisherRestrictionFiles.

     "UPDATE Campaigns SET Account = 'urn:li:sponsoredAccount:515218099', CampaignGroup = 'urn:li:sponsoredCampaignGroup:756063323', AssociatedEntity = 'urn:li:organization:101877555', AudienceExpansionEnabled = TRUE, CostType = 'CPM', CreativeSelection = 'OPTIMIZED', DailyBudgetAmount = '250.00', DailyBudgetCurrency = 'USD', Country = 'GB', Language = 'en', Name = 'Updated Campaign Name', OffsiteDeliveryEnabled = FALSE, ScheduleStartTime = '2025-07-15 09:00:00', ScheduleEndTime = '2025-08-15 18:00:00', Status = 'PAUSED', Type = 'SPONSORED_UPDATES', UnitCostAmount = '2.75', UnitCostCurrency = 'USD', ConnectedTelevisionOnly = TRUE, TimeSpanDuration = 7, TimeSpanUnit = 'DAY', Frequency = 3, OptimizationType = 'MAX_FREQUENCY', BlockedIABCategories = 'urn:li:iabCategory:IAB4-2,urn:li:iabCategory:IAB17-31', AllowedPublisherRestrictionFiles = 'urn:li:adPublisherFile:1359990,urn:li:adPublisherFile:1360990', BlockedPublisherRestrictionFiles = 'urn:li:adPublisherFile:1359991,urn:li:adPublisherFile:1361990' WHERE Id = '403469283' and AdAccountId = '515218099'"
 

Delete

To remove a campaign, use a DELETE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

 DELETE FROM Campaigns WHERE Id = 123456789 AND AdAccountId = '123456789';
 

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Numerical identifier for the campaign

Account String False

URN identifying the advertising account associated with the Campaign.

CampaignGroup String False

Numerical identifier for the campaign group.

AssociatedEntity String False

An URN for a strongly associated object, with semantics varying based on the Campaign type.

AudienceExpansionEnabled Boolean False

Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria

CostType String False

CPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link

使用できる値は次のとおりです。CPM, CPC, CPV

CreativeSelection String False

ROUND_ROBIN - Rotate through available creatives to serve them as easily as possible. OPTIMIZED - Bias selection taking into account such things as expected performance

DailyBudgetAmount String False

The amount of money as a real number string

DailyBudgetCurrency String False

ISO currency code

Country String False

An uppercase two-letter country code as defined by ISO-3166.

Language String False

A lowercase two-letter language code as defined by ISO-639.

Name String False

The name of the Campaign

OffsiteDeliveryEnabled Boolean False

Allow this campaign access to be served on the LinkedIn Advertising Network.

ScheduleStartTime Datetime False

Scheduled date range to run associated creatives.

ScheduleEndTime Datetime False

Scheduled date range to run associated creatives.

Status String False

Current Status of the campaign

使用できる値は次のとおりです。ACTIVE, ARCHIVED, COMPLETED, CANCELED, DRAFT, PAUSED, PENDING_DELETION, REMOVED

Type String False

Type of campaign

使用できる値は次のとおりです。TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC

UnitCostAmount String False

Amount to bid per click, impression, or other event depending on the pricing model.

UnitCostCurrency String False

Currency of the UnitCostAmount

ObjectiveType String False

The Campaign Objective type.

使用できる値は次のとおりです。BRAND_AWARENESS, ENGAGEMENT, JOB_APPLICANTS, LEAD_GENERATION, WEBSITE_CONVERSIONS, WEBSITE_VISITS, VIDEO_VIEWS

AdAccountId String False

Id of the account

ConnectedTelevisionOnly Boolean False

Flag showing whether this campaign is a Connected Television Only campaign. Allow advertisers to specify when they’re creating a CTV campaign. Not specifying the boolean can be considered false.

TimeSpanDuration Integer False

Represents the length of time.

TimeSpanUnit String False

Represents the unit of the duration of time

Frequency Integer False

The number of times the campaign is shown to a member.

OptimizationType String False

Type of the frequency optimization strategy.

OptimizationTargetType String False

Determines how this campaign is optimized for spending. If this is not set, there is no optimization.

使用できる値は次のとおりです。NONE, ENHANCED_CONVERSION, TARGET_COST_PER_CLICK, TARGET_COST_PER_IMPRESSION, TARGET_COST_PER_VIDEO_VIEW, CAP_COST_AND_MAXIMIZE_CLICKS, CAP_COST_AND_MAXIMIZE_IMPRESSIONS, CAP_COST_AND_MAXIMIZE_VIDEO_VIEWS, MAX_REACH, MAX_LEAD, MAX_VIDEO_VIEW, MAX_CONVERSION, MAX_CLICK, MAX_IMPRESSION

BlockedIABCategories String False

The list of mobile application IAB (Interactive Advertising Bureau) categories that are prohibited from serving the campaign's advertisements off-network.

AllowedPublisherRestrictionFiles String False

The list of publisher restriction files containing the sites allowed to serve the campaign's advertisements off-network.

BlockedPublisherRestrictionFiles String False

The list of publisher restriction files containing the sites prohibited from serving the campaign's advertisements off-network.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9440