{ "revision": "20260511", "name": "dfareporting", "basePath": "/dfareporting/v3.5/", "batchPath": "batch", "servicePath": "dfareporting/v3.5/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerName": "Google", "kind": "discovery#restDescription", "protocol": "rest", "schemas": { "CreativeAssetMetadata": { "id": "CreativeAssetMetadata", "description": "CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.", "type": "object", "properties": { "assetIdentifier": { "description": "ID of the creative asset. This is a required field.", "$ref": "CreativeAssetId" }, "detectedFeatures": { "description": "List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "enum": [ "CSS_FONT_FACE", "CSS_BACKGROUND_SIZE", "CSS_BORDER_IMAGE", "CSS_BORDER_RADIUS", "CSS_BOX_SHADOW", "CSS_FLEX_BOX", "CSS_HSLA", "CSS_MULTIPLE_BGS", "CSS_OPACITY", "CSS_RGBA", "CSS_TEXT_SHADOW", "CSS_ANIMATIONS", "CSS_COLUMNS", "CSS_GENERATED_CONTENT", "CSS_GRADIENTS", "CSS_REFLECTIONS", "CSS_TRANSFORMS", "CSS_TRANSFORMS3D", "CSS_TRANSITIONS", "APPLICATION_CACHE", "CANVAS", "CANVAS_TEXT", "DRAG_AND_DROP", "HASH_CHANGE", "HISTORY", "AUDIO", "VIDEO", "INDEXED_DB", "INPUT_ATTR_AUTOCOMPLETE", "INPUT_ATTR_AUTOFOCUS", "INPUT_ATTR_LIST", "INPUT_ATTR_PLACEHOLDER", "INPUT_ATTR_MAX", "INPUT_ATTR_MIN", "INPUT_ATTR_MULTIPLE", "INPUT_ATTR_PATTERN", "INPUT_ATTR_REQUIRED", "INPUT_ATTR_STEP", "INPUT_TYPE_SEARCH", "INPUT_TYPE_TEL", "INPUT_TYPE_URL", "INPUT_TYPE_EMAIL", "INPUT_TYPE_DATETIME", "INPUT_TYPE_DATE", "INPUT_TYPE_MONTH", "INPUT_TYPE_WEEK", "INPUT_TYPE_TIME", "INPUT_TYPE_DATETIME_LOCAL", "INPUT_TYPE_NUMBER", "INPUT_TYPE_RANGE", "INPUT_TYPE_COLOR", "LOCAL_STORAGE", "POST_MESSAGE", "SESSION_STORAGE", "WEB_SOCKETS", "WEB_SQL_DATABASE", "WEB_WORKERS", "GEO_LOCATION", "INLINE_SVG", "SMIL", "SVG_HREF", "SVG_CLIP_PATHS", "TOUCH", "WEBGL", "SVG_FILTERS", "SVG_FE_IMAGE" ] } }, "warnedValidationRules": { "description": "Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - \"ZIP_INVALID\" ", "type": "array", "items": { "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "enum": [ "CLICK_TAG_NON_TOP_LEVEL", "CLICK_TAG_MISSING", "CLICK_TAG_MORE_THAN_ONE", "CLICK_TAG_INVALID", "ORPHANED_ASSET", "PRIMARY_HTML_MISSING", "EXTERNAL_FILE_REFERENCED", "MRAID_REFERENCED", "ADMOB_REFERENCED", "FILE_TYPE_INVALID", "ZIP_INVALID", "LINKED_FILE_NOT_FOUND", "MAX_FLASH_VERSION_11", "NOT_SSL_COMPLIANT", "FILE_DETAIL_EMPTY", "ASSET_INVALID", "GWD_PROPERTIES_INVALID", "ENABLER_UNSUPPORTED_METHOD_DCM", "ASSET_FORMAT_UNSUPPORTED_DCM", "COMPONENT_UNSUPPORTED_DCM", "HTML5_FEATURE_UNSUPPORTED", "CLICK_TAG_IN_GWD", "CLICK_TAG_HARD_CODED", "SVG_INVALID", "CLICK_TAG_IN_RICH_MEDIA", "MISSING_ENABLER_REFERENCE" ] } }, "clickTags": { "description": "List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.", "type": "array", "items": { "$ref": "ClickTag" } }, "id": { "description": "Numeric ID of the asset. This is a read-only, auto-generated field.", "type": "string", "format": "int64" }, "idDimensionValue": { "description": "Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.", "$ref": "DimensionValue" }, "richMedia": { "description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.", "type": "boolean" }, "counterCustomEvents": { "description": "List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.", "type": "array", "items": { "$ref": "CreativeCustomEvent" } }, "exitCustomEvents": { "description": "List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.", "type": "array", "items": { "$ref": "CreativeCustomEvent" } }, "timerCustomEvents": { "description": "List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.", "type": "array", "items": { "$ref": "CreativeCustomEvent" } }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".", "type": "string" } } }, "CreativeAssetId": { "id": "CreativeAssetId", "description": "Creative Asset ID.", "type": "object", "properties": { "type": { "description": "Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "IMAGE", "FLASH", "VIDEO", "HTML", "HTML_IMAGE", "AUDIO" ] }, "name": { "description": "Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: \".-_ \". Spaces are allowed.", "type": "string" } } }, "ClickTag": { "id": "ClickTag", "description": "Creative Click Tag.", "type": "object", "properties": { "name": { "description": "Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.", "type": "string" }, "eventName": { "description": "Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.", "type": "string" }, "clickThroughUrl": { "description": "Parameter value for the specified click tag. This field contains a click-through url.", "$ref": "CreativeClickThroughUrl" } } }, "CreativeClickThroughUrl": { "id": "CreativeClickThroughUrl", "description": "Click-through URL", "type": "object", "properties": { "landingPageId": { "description": "ID of the landing page for the click-through URL.", "type": "string", "format": "int64" }, "customClickThroughUrl": { "description": "Custom click-through URL. Applicable if the landingPageId field is left unset.", "type": "string" }, "computedClickThroughUrl": { "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. ", "type": "string" } } }, "DimensionValue": { "id": "DimensionValue", "description": "Represents a DimensionValue resource.", "type": "object", "properties": { "dimensionName": { "description": "The name of the dimension.", "type": "string" }, "value": { "description": "The value of the dimension.", "type": "string" }, "id": { "description": "The ID associated with the value if available.", "type": "string" }, "matchType": { "description": "Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "EXACT", "BEGINS_WITH", "CONTAINS", "WILDCARD_EXPRESSION" ] }, "kind": { "description": "The kind of resource this is, in this case dfareporting#dimensionValue.", "type": "string" }, "etag": { "description": "The eTag of this response for caching purposes.", "type": "string" } } }, "CreativeCustomEvent": { "id": "CreativeCustomEvent", "description": "Creative Custom Event.", "type": "object", "properties": { "artworkLabel": { "description": "Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.", "type": "string" }, "id": { "description": "ID of this event. This is a required field and should not be modified after insertion.", "type": "string", "format": "int64" }, "videoReportingId": { "description": "Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.", "type": "string" }, "artworkType": { "description": "Artwork type used by the creative.This is a read-only field.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "ARTWORK_TYPE_FLASH", "ARTWORK_TYPE_HTML5", "ARTWORK_TYPE_MIXED", "ARTWORK_TYPE_IMAGE" ] }, "advertiserCustomEventName": { "description": "User-entered name for the event.", "type": "string" }, "targetType": { "description": "Target type used by the event.", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "TARGET_BLANK", "TARGET_TOP", "TARGET_SELF", "TARGET_PARENT", "TARGET_POPUP" ] }, "advertiserCustomEventType": { "description": "Type of the event. This is a read-only field.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ADVERTISER_EVENT_TIMER", "ADVERTISER_EVENT_EXIT", "ADVERTISER_EVENT_COUNTER" ] }, "popupWindowProperties": { "description": "Properties for rich media popup windows. This field is used only for exit events.", "$ref": "PopupWindowProperties" }, "advertiserCustomEventId": { "description": "Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.", "type": "string", "format": "int64" }, "exitClickThroughUrl": { "description": "Exit click-through URL for the event. This field is used only for exit events.", "$ref": "CreativeClickThroughUrl" } } }, "PopupWindowProperties": { "id": "PopupWindowProperties", "description": "Popup Window Properties.", "type": "object", "properties": { "offset": { "description": "Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.", "$ref": "OffsetPosition" }, "showScrollBar": { "description": "Whether to display the browser scroll bar.", "type": "boolean" }, "showToolBar": { "description": "Whether to display the browser tool bar.", "type": "boolean" }, "showMenuBar": { "description": "Whether to display the browser menu bar.", "type": "boolean" }, "showAddressBar": { "description": "Whether to display the browser address bar.", "type": "boolean" }, "showStatusBar": { "description": "Whether to display the browser status bar.", "type": "boolean" }, "positionType": { "description": "Popup window position either centered or at specific coordinate.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "CENTER", "COORDINATES" ] }, "dimension": { "description": "Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID", "$ref": "Size" }, "title": { "description": "Title of popup window.", "type": "string" } } }, "OffsetPosition": { "id": "OffsetPosition", "description": "Offset Position.", "type": "object", "properties": { "top": { "description": "Offset distance from top side of an asset or a window.", "type": "integer", "format": "int32" }, "left": { "description": "Offset distance from left side of an asset or a window.", "type": "integer", "format": "int32" } } }, "Size": { "id": "Size", "description": "Represents the dimensions of ads, placements, creatives, or creative assets.", "type": "object", "properties": { "id": { "description": "ID of this size. This is a read-only, auto-generated field.", "type": "string", "format": "int64" }, "width": { "description": "Width of this size. Acceptable values are 0 to 32767, inclusive.", "type": "integer", "format": "int32" }, "height": { "description": "Height of this size. Acceptable values are 0 to 32767, inclusive.", "type": "integer", "format": "int32" }, "iab": { "description": "IAB standard size. This is a read-only, auto-generated field.", "type": "boolean" }, "kind": { "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#size\".", "type": "string" } } } }, "id": "dfareporting:v3.5", "rootUrl": "https://dfareporting.googleapis.com/", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "fullyEncodeReservedExpansion": true, "canonicalName": "Dfareporting", "documentationLink": "https://developers.google.com/doubleclick-advertisers/", "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.", "mtlsRootUrl": "https://dfareporting.mtls.googleapis.com/", "title": "Campaign Manager 360 API", "resources": { "media": { "methods": { "upload": { "id": "dfareporting.media.upload", "path": "userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets", "flatPath": "userprofiles/{userprofilesId}/creativeAssets/{creativeAssetsId}/creativeAssets", "httpMethod": "POST", "parameters": { "profileId": { "description": "User profile ID associated with this request.", "pattern": "^[^/]+$", "location": "path", "required": true, "type": "string", "format": "int64" }, "advertiserId": { "description": "Advertiser ID of this creative. This is a required field.", "pattern": "^[^/]+$", "location": "path", "required": true, "type": "string", "format": "int64" } }, "parameterOrder": [ "profileId", "advertiserId" ], "supportsMediaUpload": true, "mediaUpload": { "accept": [ "*/*" ], "maxSize": "1073741824", "protocols": { "simple": { "multipart": true, "path": "/upload/dfareporting/v3.5/userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets" } } }, "request": { "$ref": "CreativeAssetMetadata" }, "response": { "$ref": "CreativeAssetMetadata" }, "scopes": [ "https://www.googleapis.com/auth/dfatrafficking" ], "description": "Inserts a new creative asset." } } } }, "baseUrl": "https://dfareporting.googleapis.com/dfareporting/v3.5/", "discoveryVersion": "v1", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/dfatrafficking": { "description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns" } } } }, "version": "v3.5", "ownerDomain": "google.com" }