CData Python Connector for LinkedIn Marketing Solutions

Build 25.0.9454

CampaignGroups

Lists all campaign groups available to the authenticated user, filtered by status, to help organize and manage related campaigns.

Table Specific Information

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

Select

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

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

SELECT * FROM CampaignGroups WHERE Status = 'ACTIVE'

SELECT * FROM CampaignGroups WHERE AdAccountId = '510013292'

CUD Operations

Insert

To create a new campaign group there are some fields that are required in initial creation which are: Account, Name, ScheduleStartTime, AdAccountId.

While the following parameters are optional: Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleEndTime

Note: When specifying the status of the campaign group in creation it can only be ACTIVE or DRAFT.

    INSERT INTO CampaignGroups (Account, Name, Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleStartTime, ScheduleEndTime, AdAccountId ) VALUES ( 'urn:li:sponsoredAccount:12345', 'Sample Campaign Group', 'ACTIVE', 5000.00, 'USD', '2025-07-15 09:00:00', '2025-12-31 23:59:59', '123465798' );

Update

To modify an existing campaign group the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: Name, Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleStartTime, ScheduleEndTime.

    UPDATE CampaignGroups SET Name = 'Updated Campaign Group Name', Status = 'PAUSED', TotalBudgetAmount = 7500.00, TotalBudgetCurrencyCode = 'USD', ScheduleStartTime = '2025-08-01 00:00:00', ScheduleEndTime = '2025-12-31 23:59:59' WHERE Id = 789 AND AdAccountId = '123456789';

Delete

To remove a campaign group the Id and AdAccountId columns are required in the WHERE clause.

    DELETE FROM CampaignGroups WHERE Id = 789 AND AdAccountId = '123456789';

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Unique numerical identifier assigned to the campaign group.

Account String False

Uniform Resource Name (URN) that identifies the advertising account associated with the campaign group. This value cannot be changed after creation.

Name String False

Descriptive name of the campaign group, used to identify and manage related campaigns within the account.

Status String False

Indicates the current operational status of the campaign group.

The allowed values are ACTIVE, PENDING_DELETION, REMOVED, PAUSED, ARCHIVED, DRAFT, CANCELED.

TotalBudgetAmount Decimal False

Specifies the maximum total budget allocated for all campaigns within the campaign group.

TotalBudgetCurrencyCode String False

Currency code defined by the ISO that specifies the currency for the total budget. It must match the parent account's currency.

ScheduleStartTime Datetime False

Start date and time for when the campaign group becomes active and eligible to run associated campaigns.

ScheduleEndTime Datetime False

End date and time defining when the campaign group stops running associated campaigns.

Backfilled Boolean True

If the value is 'true', the campaign group was created to backfill pre-existing campaigns rather than being created organically.

AdAccountId String False

Unique identifier of the advertising account linked to the campaign group.

URN String True

URN that uniquely identifies the campaign group within LinkedIn Ads.

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