GOgoogle
ads

POST /userprofiles/{userprofilesId}/ads

Inserts a new ad.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Request body

accountIdstring int64

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

activeboolean

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

advertiserIdstring int64

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

archivedboolean

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

audienceSegmentIdstring int64

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

campaignIdstring int64

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

commentsstring

Comments for this 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.

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.

endTimestring date-time
idstring int64

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

kindstring

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

namestring

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

sslCompliantboolean

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

sslRequiredboolean

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

startTimestring date-time
subaccountIdstring int64

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

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.

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).

Response

Successful response

accountIdstring int64

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

activeboolean

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

advertiserIdstring int64

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

archivedboolean

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

audienceSegmentIdstring int64

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

campaignIdstring int64

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

commentsstring

Comments for this 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.

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.

endTimestring date-time
idstring int64

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

kindstring

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

namestring

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

sslCompliantboolean

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

sslRequiredboolean

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

startTimestring date-time
subaccountIdstring int64

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

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.

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).

Changes

No recorded changes to this operation across all 5 revisions of this API.