Campaign Object – API Help Center

Related Entities

Endpoints Using the Campaign Object

Campaign Resource

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 Amazon Ad Server (AAS) 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
visibilityCollectBasicData	Not supported.	Not supported	Not supported
visibilityCollectEnhancedData	Not supported.	Not supported	Not supported
yahooPCPBTList	Not supported.	Not supported	Not supported
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	View values Live Idle New Published PendingIO Enabled
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	View values Basic Full Limited
verificationEnabled	Internal.	Read-only	Internal
collectMobileInfo	Internal.	Boolean	Read-only

Object JSON Example

{
   result":
      {
         "type":"Campaign",
         "id":1073741800,
         "relationsBag":{
            "parents":{
               "account":{
                  "id":1073741800,
                  "name":"SanityAccount",
                  "internal":true
               },
               "advertiser":{
                  "id":1073741800,
                  "name":"SanityAdvertiser"
               },
               "brand":{
                  "id":1073741800,
                  "name":"SanityBrand"
               },
               "campaign":null,
               "site":null
            },
            "children":{
               "advertisers":{
                  "count":0
               },
               "brands":{
                  "count":0
               },
               "campaigns":{
                  "count":0
               },
               "users":{
                  "count":0
               }
            },
            "creativeAccountContact":false
         },
         "version":1516691401261973504,
         "createdBy":1073741800,
         "createdByName":"User",
         "createdByAccount":1073741800,
         "createdByAccountName":"Account",
         "createdOn":1516691401264,
         "lastUpdatedBy":1073741800,
         "lastUpdatedByName":"User",
         "lastUpdatedByAccount":1073741800,
         "lastUpdatedByAccountName":"Account",
         "lastUpdateOn":1516691401200,
         "name":"CampReFVBL4a",
         "brandId":1073741800,
         "analyticsSettings":{
            "type":"AnalyticsSettings",
            "ignoreOverDelivery":true,
            "verificationMode":"BASIC_COLLECTION",
            "viewabilityThreshold":{
               "type":"ViewabilityThreshold",
               "minimumSurface":50,
               "minimumDuration":1
            }
         },
         "accountAnalyticsSettings":{
            "type":"AnalyticsSettings",
            "ignoreOverDelivery":true,
            "verificationMode":"BASIC_COLLECTION",
            "viewabilityThreshold":{
               "type":"ViewabilityThreshold",
               "minimumSurface":1,
               "minimumDuration":1
            }
         },
         "advertiserAnalyticsSettings":{
            "type":"AnalyticsSettings",
            "ignoreOverDelivery":true,
            "verificationMode":"BASIC_COLLECTION",
            "viewabilityThreshold":{
               "type":"ViewabilityThreshold",
               "minimumSurface":50,
               "minimumDuration":1
            }
         },
         "adminSettings":{
            "type":"AdminSettings",
            "regionalSettings":{
               "type":"RegionalSettings",
               "defaultTimeZone":"GMT_Plus_11",
               "market":null
            },
            "defaultContacts":{
               "type":"DefaultContacts",
               "relationsBag":null,
               "version":null,
               "sizmekContacts":[
                  {
                     "type":"DefaultSizmekContact",
                     "id":892097658800,
                     "relationsBag":null,
                     "version":null,
                     "contactId":1073741800,
                     "name":"FirstSizmekUser",
                     "campaignRole":"ClientServicesManager"
                  },
                  {
                     "type":"DefaultSizmekContact",
                     "id":892097658800,
                     "relationsBag":null,
                     "version":null,
                     "contactId":1073741800,
                     "name":"FirstSizmekUser",
                     "campaignRole":"SalesManager"
                  }
               ],
               "campaignManagerContacts":[

               ],
               "creativeManagerContacts":[

               ],
               "creativeAccounts":[

               ],
               "siteContacts":[

               ]
            },
            "thirdPartyTracking":"ClickTracking",
            "servingSettings":{
               "type":"ServingSettings",
               "collectBelowTheFold":true,
               "dfCollectionID":253595777,
               "pathLength":0,
               "visibilityMinimumSurface":450763803,
               "visibilityMinimumDuration":-1557522063,
               "agencyVisibilityMinimumDuration":-2021180899,
               "agencyVisibilityMinimumSurface":1807183053,
               "adChoicesCertificationProgramID":-1204250715,
               "adChoicesClickthroughURL":"DkPhCje7tO",
               "disableCookie":true,
               "saveAdCookie":true,
               "retargetingCookieWindow":1878218860,
               "deviceIntelligenceTypeId":-1639063779
            },
            "campaignSettings":{
               "type":"CampaignSettings",
               "hardStopMethod":"KEEP_SERVING_AS_USUAL",
               "creativeManagerAccess":true,
               "traffickingMode":"AdvancedMode",
               "targetAudiencePriorityPolicy":"Server"
            },
            "privacy":{
               "type":"Privacy",
               "adMarker":{
                  "includeInAllAds":false,
                  "regulationProgram":"IAB_EU",
                  "markerClickthroughURL":null
               },
               "disableCookies":false
            },
            "video":{
               "type":"Video",
               "autoTranscode":true
            }
         },
         "customFields":null,
         "office":null,
         "totalImpressions":9525124902729,
         "totalClicks":9525135562222,
         "ctr":0.30577682343509494,
         "lastServedImpression":1516691401114,
         "status":"Live",
         "startDate":null,
         "endDate":null,
         "lastUpdated":null,
         "placementsCount":0,
         "masterAdsCount":0,
         "placementAdsCount":0,
         "salesForceOpportunityId":null,
         "collectDataFeed":true,
         "collectPublisherKeywordsData":true,
         "visibilityCollectBasicData":true,
         "visibilityCollectEnhancedData":true,
         "selectedAdBlockingCategories":"fpqBaVS9vl",
         "yahooPCPBTList":"ddVQRsFR4e",
         "traffickingMode":"AdvancedMode",
         "accessLevel":"Full",
         "verificationEnabled":false,
         "collectMobileInfo":false
      }
}

Related Entities

Endpoints Using the Campaign Object

Object Definition

Note

Object JSON Example

Comments