Sign in

v1

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

Inserts a new ad.

post/userprofiles/{+profileId}/ads

Path parameters

profileIdstring required

User profile ID associated with this request.

Request body

sslRequiredboolean

Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.

accountIdstring int64

Account ID of this ad. This is a read-only field that can be left blank.

namestring

Name of this ad. This is a required field and must be less than 256 characters long.

dynamicClickTrackerboolean

Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.

startTimestring date-time
sslCompliantboolean

Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.

targetingTemplateIdstring int64

Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.

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

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.

idstring int64

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

activeboolean

Whether this ad is active. When true, archived must be false.

type'AD_SERVING_STANDARD_AD' | 'AD_SERVING_DEFAULT_AD' | 'AD_SERVING_CLICK_TRACKER' | 'AD_SERVING_TRACKING' | 'AD_SERVING_BRAND_SAFE_AD'

Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).

kindstring

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

subaccountIdstring int64

Subaccount ID of this ad. This is a read-only field that can be left blank.

archivedboolean

Whether this ad is archived. When true, active must be false.

endTimestring date-time
campaignIdstring int64

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

commentsstring

Comments for this ad.

advertiserIdstring int64

Advertiser ID of this ad. This is a required field on insertion.

audienceSegmentIdstring int64

Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.

Response

Successful response