PRODUCT
Follow

Endpoints Using the Campaign Object

Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Sizmek internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

name

Name of campaign.

String

Required

type

Type of entity.

String

Required

id

ID of campaign.

Long

Read-only

Auto-generated, read-only value.

adminSettings

Object that includes settings and contacts objects.

adminSettings Object

Optional

collectPublisherKeywordsData

Deprecated.

Deprecated

Deprecated

visibilityCollectBasicData

Not supported.

Not supported

Not supported

visibilityCollectEnhancedData

Not supported.

Not supported

Not supported

selectAdBlockingCategories

Deprecated.

Deprecated

Deprecated

yahooPCPBTList

Not supported.

Not supported

Not supported

traffickingMode

Deprecated. You can ignore this field if it is in the GET call. traffickingMode is under campaignsettings object.

Deprecated

Deprecated

analyticsSettings

Analytics settings for the campaign. By default, these settings are inherited from the advertiser.

analyticsSettings Object

Optional

advertiserAnalyticsSettings

Analytics settings for the advertiser running this campaign. By default, these settings are inherited from the account.

analyticsSettings Object

Optional

accountAnalyticsSettings

Analytics settings for the account running this campaign.

analyticsSettings Object

Optional

createdBy

ID of the user that created the account.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

String

Internal

createdByName

Name of the user that created the entity.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (date epoch).

Long

Read-only

lastUpdatedBy

ID of the user that was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user that was last to update the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Parent advertiser analytics settings.

String

Read-only

lastUpdateOn

Date of last update (date epoch).

Long

Read-only

status

Campaign status.

String

Read-only

brandid

Parent brand ID.

Long

Required

customFields

Custom fields values on entity level, each field must have metadata definition on parent account.

customFields Object

Optional

version

Internal.

Internal

Internal

office

Account office (office, market, currency).

Internal

Internal

totalImpressions

Total number of impressions for this campaign.

Long

Read-only

totalClicks

Total number of clicks for this campaign.

Long

Read-only

ctr

Total number of clicks divided by the total impressions.

Float

Read-only

lastServedImpression

Date and time of last served impression for this campaign.

Long

Read-only

startDate

Start date and time of campaign.

Long

Read-only

endDate

End date and time of campaign.

Long

Read-only

lastUpdated

Date and time that the last changes were made to the campaign.

Long

Read-only

placementAdsCount

Number of ads attached to placements in the campaign.

Integer

Read-only

salesForceOpportunityId

Internal.

Internal

Internal

CollectDataFeed

Internal.

Internal

Internal

accessLevel

Internal.

Internal

Internal

verificationEnabled

Internal.

Read-only

Internal

collectMobileInfo

Internal.

Boolean

Read-only

Object JSON Example

Child Objects

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk