v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
placements

Updates an existing placement.

put/userprofiles/{+profileId}/placements

Path parameters

profileIdstring required

User profile ID associated with this request.

Request body

accountIdstring int64

Account ID of this placement. This field can be left blank.

namestring

Name of this placement.This is a required field and must be less than or equal to 512 characters long.

adBlockingOptOutboolean

Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.

sslRequiredboolean

Whether creatives assigned to this placement must be SSL-compliant.

wrappingOptOutboolean

Whether this placement opts out of tag wrapping.

tagFormatsstring[]

Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"

primaryboolean

Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.

status'PENDING_REVIEW' | 'PAYMENT_ACCEPTED' | 'PAYMENT_REJECTED' | 'ACKNOWLEDGE_REJECTION' | 'ACKNOWLEDGE_ACCEPTANCE' | 'DRAFT'

Third-party placement status.

allowOnYoutubeboolean

Optional. Whether the placement is enabled for YouTube integration.

paymentApprovedboolean

Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.

idstring int64

ID of this placement. This is a read-only, auto-generated field.

adServingPlatformIdstring int64

Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * 1, Adelphic * 2, Adform * 3, Adobe * 4, Amobee * 5, Basis (Centro) * 6, Beeswax * 7, Amazon * 8, DV360 (DBM) * 9, Innovid * 10, MediaMath * 11, Roku OneView DSP * 12, TabMo Hawk * 13, The Trade Desk * 14, Xandr Invest DSP * 15, Yahoo DSP * 16, Zeta Global * 17, Scaleout * 18, Bidtellect * 19, Unicorn * 20, Teads * 21, Quantcast * 22, Cognitiv * 23, AdTheorent * 24, DeepIntent * 25, Pulsepoint

placementStrategyIdstring int64

ID of the placement strategy assigned to this placement.

videoActiveViewOptOutboolean

Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.

activeStatus'PLACEMENT_STATUS_UNKNOWN' | 'PLACEMENT_STATUS_ACTIVE' | 'PLACEMENT_STATUS_INACTIVE' | 'PLACEMENT_STATUS_ARCHIVED' | 'PLACEMENT_STATUS_PERMANENTLY_ARCHIVED'

Whether this placement is active, inactive, archived or permanently archived.

compatibility'DISPLAY' | 'DISPLAY_INTERSTITIAL' | 'APP' | 'APP_INTERSTITIAL' | 'IN_STREAM_VIDEO' | 'IN_STREAM_AUDIO'

Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.

contentCategoryIdstring int64

ID of the content category assigned to this placement.

subaccountIdstring int64

Subaccount ID of this placement. This field can be left blank.

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".

paymentSource'PLACEMENT_AGENCY_PAID' | 'PLACEMENT_PUBLISHER_PAID'

Payment source for this placement. This is a required field that is read-only after insertion.

campaignIdstring int64

Campaign ID of this placement. This field is a required field on insertion.

placementGroupIdstring int64

ID of this placement's group, if applicable.

keyNamestring

Key name of this placement. This is a read-only, auto-generated field.

vpaidAdapterChoice'DEFAULT' | 'FLASH' | 'HTML5' | 'BOTH'

VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.

externalIdstring

External ID for this placement.

commentstring

Comments for this placement.

advertiserIdstring int64

Advertiser ID of this placement. This field can be left blank.

siteIdstring int64

Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.

siteServedboolean

Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.

directorySiteIdstring int64

Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.

Response

Successful response