happygapi.dfareporting.creatives — happygapi 0.4.2

DCM/DFA Reporting And Trafficking API: creatives. Manages your DoubleClick Campaign Manager ad campaigns and reports. See: https://developers.google.com/doubleclick-advertisers/api/reference/rest/v3.4/creatives

get$ clj

(get$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v3.4/creatives/get

Required parameters: id, profileId

Optional parameters: none

Gets one creative by ID.

insert$ clj

(insert$ auth parameters body)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v3.4/creatives/insert

Required parameters: profileId

Optional parameters: none

Body:

{:archived boolean, :counterCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :thirdPartyBackupImageImpressionsUrl string, :overrideCss string, :adParameters string, :skippable boolean, :allowScriptAccess boolean, :customKeyValues [string], :studioCreativeId string, :idDimensionValue {:dimensionName string, :etag string, :id string, :kind string, :matchType string, :value string}, :additionalSizes [{:height integer, :iab boolean, :id string, :kind string, :width integer}], :fsCommand {:left integer, :positionOption string, :top integer, :windowHeight integer, :windowWidth integer}, :backupImageClickThroughUrl {:computedClickThroughUrl string, :customClickThroughUrl string, :landingPageId string}, :timerCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :sslOverride boolean, :compatibility [string], :sslCompliant boolean, :skipOffset {:offsetPercentage integer, :offsetSeconds integer}, :thirdPartyRichMediaImpressionsUrl string, :name string, :convertFlashToHtml5 boolean, :universalAdId {:registry string, :value string}, :artworkType string, :authoringSource string, :type string, :creativeAssets [{:role string, :fileSize string, :idDimensionValue DimensionValue, :additionalSizes [Size], :windowMode string, :bitRate integer, :verticallyLocked boolean, :offset OffsetPosition, :horizontallyLocked boolean, :sslCompliant boolean, :positionLeftUnit string, :frameRate number, :alignment string, :pushdownDuration number, :artworkType string, :zipFilesize string, :childAssetType string, :startTimeType string, :orientation string, :flashVersion integer, :duration integer, :streamingServingUrl string, :audioSampleRate integer, :displayType string, :detectedFeatures [string], :size Size, :progressiveServingUrl string, :originalBackup boolean, :collapsedSize Size, :durationType string, :hideFlashObjects boolean, :positionTopUnit string, :active boolean, :id string, :customStartTimeValue integer, :pushdown boolean, :mimeType string, :zIndex integer, :position OffsetPosition, :hideSelectionBoxes boolean, :politeLoad boolean, :expandedDimension Size, :companionCreativeIds [string], :zipFilename string, :assetIdentifier CreativeAssetId, :mediaDuration number, :audioBitRate integer, :actionScript3 boolean, :transparency boolean, :backupImageExit CreativeCustomEvent}], :exitCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :size {:height integer, :iab boolean, :id string, :kind string, :width integer}, :studioAdvertiserId string, :creativeFieldAssignments [{:creativeFieldId string, :creativeFieldValueId string}], :thirdPartyUrls [{:thirdPartyUrlType string, :url string}], :commercialId string, :backupImageFeatures [string], :authoringTool string, :advertiserId string, :htmlCode string, :active boolean, :id string, :requiredFlashPluginVersion string, :kind string, :progressOffset {:offsetPercentage integer, :offsetSeconds integer}, :creativeAssetSelection {:defaultAssetId string, :rules [Rule]}, :adTagKeys [string], :obaIcon {:iconClickThroughUrl string, :program string, :resourceUrl string, :size Size, :xPosition string, :yPosition string}, :clickTags [{:clickThroughUrl CreativeClickThroughUrl, :eventName string, :name string}], :lastModifiedInfo {:time string}, :latestTraffickedCreativeId string, :totalFileSize string, :redirectUrl string, :requiredFlashVersion integer, :backupImageTargetWindow {:customHtml string, :targetWindowOption string}, :subaccountId string, :version integer, :dynamicAssetSelection boolean, :renderingIdDimensionValue {:dimensionName string, :etag string, :id string, :kind string, :matchType string, :value string}, :mediaDuration number, :autoAdvanceImages boolean, :backgroundColor string, :companionCreatives [string], :accountId string, :backupImageReportingLabel string, :studioTraffickedCreativeId string, :mediaDescription string, :htmlCodeLocked boolean, :renderingId string}

Inserts a new creative.

list$ clj

(list$ auth parameters)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v3.4/creatives/list

Required parameters: profileId

Optional parameters: archived, studioCreativeId, campaignId, renderingIds, ids, searchString, types, pageToken, sortField, advertiserId, active, sortOrder, creativeFieldIds, companionCreativeIds, sizeIds, maxResults

Retrieves a list of creatives, possibly filtered. This method supports paging.

patch$ clj

(patch$ auth parameters body)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v3.4/creatives/patch

Required parameters: id, profileId

Optional parameters: none

Body:

{:archived boolean, :counterCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :thirdPartyBackupImageImpressionsUrl string, :overrideCss string, :adParameters string, :skippable boolean, :allowScriptAccess boolean, :customKeyValues [string], :studioCreativeId string, :idDimensionValue {:dimensionName string, :etag string, :id string, :kind string, :matchType string, :value string}, :additionalSizes [{:height integer, :iab boolean, :id string, :kind string, :width integer}], :fsCommand {:left integer, :positionOption string, :top integer, :windowHeight integer, :windowWidth integer}, :backupImageClickThroughUrl {:computedClickThroughUrl string, :customClickThroughUrl string, :landingPageId string}, :timerCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :sslOverride boolean, :compatibility [string], :sslCompliant boolean, :skipOffset {:offsetPercentage integer, :offsetSeconds integer}, :thirdPartyRichMediaImpressionsUrl string, :name string, :convertFlashToHtml5 boolean, :universalAdId {:registry string, :value string}, :artworkType string, :authoringSource string, :type string, :creativeAssets [{:role string, :fileSize string, :idDimensionValue DimensionValue, :additionalSizes [Size], :windowMode string, :bitRate integer, :verticallyLocked boolean, :offset OffsetPosition, :horizontallyLocked boolean, :sslCompliant boolean, :positionLeftUnit string, :frameRate number, :alignment string, :pushdownDuration number, :artworkType string, :zipFilesize string, :childAssetType string, :startTimeType string, :orientation string, :flashVersion integer, :duration integer, :streamingServingUrl string, :audioSampleRate integer, :displayType string, :detectedFeatures [string], :size Size, :progressiveServingUrl string, :originalBackup boolean, :collapsedSize Size, :durationType string, :hideFlashObjects boolean, :positionTopUnit string, :active boolean, :id string, :customStartTimeValue integer, :pushdown boolean, :mimeType string, :zIndex integer, :position OffsetPosition, :hideSelectionBoxes boolean, :politeLoad boolean, :expandedDimension Size, :companionCreativeIds [string], :zipFilename string, :assetIdentifier CreativeAssetId, :mediaDuration number, :audioBitRate integer, :actionScript3 boolean, :transparency boolean, :backupImageExit CreativeCustomEvent}], :exitCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :size {:height integer, :iab boolean, :id string, :kind string, :width integer}, :studioAdvertiserId string, :creativeFieldAssignments [{:creativeFieldId string, :creativeFieldValueId string}], :thirdPartyUrls [{:thirdPartyUrlType string, :url string}], :commercialId string, :backupImageFeatures [string], :authoringTool string, :advertiserId string, :htmlCode string, :active boolean, :id string, :requiredFlashPluginVersion string, :kind string, :progressOffset {:offsetPercentage integer, :offsetSeconds integer}, :creativeAssetSelection {:defaultAssetId string, :rules [Rule]}, :adTagKeys [string], :obaIcon {:iconClickThroughUrl string, :program string, :resourceUrl string, :size Size, :xPosition string, :yPosition string}, :clickTags [{:clickThroughUrl CreativeClickThroughUrl, :eventName string, :name string}], :lastModifiedInfo {:time string}, :latestTraffickedCreativeId string, :totalFileSize string, :redirectUrl string, :requiredFlashVersion integer, :backupImageTargetWindow {:customHtml string, :targetWindowOption string}, :subaccountId string, :version integer, :dynamicAssetSelection boolean, :renderingIdDimensionValue {:dimensionName string, :etag string, :id string, :kind string, :matchType string, :value string}, :mediaDuration number, :autoAdvanceImages boolean, :backgroundColor string, :companionCreatives [string], :accountId string, :backupImageReportingLabel string, :studioTraffickedCreativeId string, :mediaDescription string, :htmlCodeLocked boolean, :renderingId string}

Updates an existing creative. This method supports patch semantics.

update$ clj

(update$ auth parameters body)

https://developers.google.com/doubleclick-advertisers/api/reference/rest/v3.4/creatives/update

Required parameters: profileId

Optional parameters: none

Body:

{:archived boolean, :counterCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :thirdPartyBackupImageImpressionsUrl string, :overrideCss string, :adParameters string, :skippable boolean, :allowScriptAccess boolean, :customKeyValues [string], :studioCreativeId string, :idDimensionValue {:dimensionName string, :etag string, :id string, :kind string, :matchType string, :value string}, :additionalSizes [{:height integer, :iab boolean, :id string, :kind string, :width integer}], :fsCommand {:left integer, :positionOption string, :top integer, :windowHeight integer, :windowWidth integer}, :backupImageClickThroughUrl {:computedClickThroughUrl string, :customClickThroughUrl string, :landingPageId string}, :timerCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :sslOverride boolean, :compatibility [string], :sslCompliant boolean, :skipOffset {:offsetPercentage integer, :offsetSeconds integer}, :thirdPartyRichMediaImpressionsUrl string, :name string, :convertFlashToHtml5 boolean, :universalAdId {:registry string, :value string}, :artworkType string, :authoringSource string, :type string, :creativeAssets [{:role string, :fileSize string, :idDimensionValue DimensionValue, :additionalSizes [Size], :windowMode string, :bitRate integer, :verticallyLocked boolean, :offset OffsetPosition, :horizontallyLocked boolean, :sslCompliant boolean, :positionLeftUnit string, :frameRate number, :alignment string, :pushdownDuration number, :artworkType string, :zipFilesize string, :childAssetType string, :startTimeType string, :orientation string, :flashVersion integer, :duration integer, :streamingServingUrl string, :audioSampleRate integer, :displayType string, :detectedFeatures [string], :size Size, :progressiveServingUrl string, :originalBackup boolean, :collapsedSize Size, :durationType string, :hideFlashObjects boolean, :positionTopUnit string, :active boolean, :id string, :customStartTimeValue integer, :pushdown boolean, :mimeType string, :zIndex integer, :position OffsetPosition, :hideSelectionBoxes boolean, :politeLoad boolean, :expandedDimension Size, :companionCreativeIds [string], :zipFilename string, :assetIdentifier CreativeAssetId, :mediaDuration number, :audioBitRate integer, :actionScript3 boolean, :transparency boolean, :backupImageExit CreativeCustomEvent}], :exitCustomEvents [{:advertiserCustomEventName string, :popupWindowProperties PopupWindowProperties, :artworkType string, :artworkLabel string, :videoReportingId string, :advertiserCustomEventId string, :id string, :targetType string, :exitClickThroughUrl CreativeClickThroughUrl, :advertiserCustomEventType string}], :size {:height integer, :iab boolean, :id string, :kind string, :width integer}, :studioAdvertiserId string, :creativeFieldAssignments [{:creativeFieldId string, :creativeFieldValueId string}], :thirdPartyUrls [{:thirdPartyUrlType string, :url string}], :commercialId string, :backupImageFeatures [string], :authoringTool string, :advertiserId string, :htmlCode string, :active boolean, :id string, :requiredFlashPluginVersion string, :kind string, :progressOffset {:offsetPercentage integer, :offsetSeconds integer}, :creativeAssetSelection {:defaultAssetId string, :rules [Rule]}, :adTagKeys [string], :obaIcon {:iconClickThroughUrl string, :program string, :resourceUrl string, :size Size, :xPosition string, :yPosition string}, :clickTags [{:clickThroughUrl CreativeClickThroughUrl, :eventName string, :name string}], :lastModifiedInfo {:time string}, :latestTraffickedCreativeId string, :totalFileSize string, :redirectUrl string, :requiredFlashVersion integer, :backupImageTargetWindow {:customHtml string, :targetWindowOption string}, :subaccountId string, :version integer, :dynamicAssetSelection boolean, :renderingIdDimensionValue {:dimensionName string, :etag string, :id string, :kind string, :matchType string, :value string}, :mediaDuration number, :autoAdvanceImages boolean, :backgroundColor string, :companionCreatives [string], :accountId string, :backupImageReportingLabel string, :studioTraffickedCreativeId string, :mediaDescription string, :htmlCodeLocked boolean, :renderingId string}

Updates an existing creative.