insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None)
Inserts a new creative asset.
insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None)
Inserts a new creative asset.
Args:
profileId: string, User profile ID associated with this request. (required)
advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
"detectedFeatures": [ # 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.
"A String",
],
"warnedValidationRules": [ # 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"
"A String",
],
"assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
"type": "A String", # 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.
"name": "A String", # 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.
},
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
"eventName": "A String", # 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.
"clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
"computedClickThroughUrl": "A String", # 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL.
},
"name": "A String", # 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.
},
],
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # 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.
"kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
"detectedFeatures": [ # 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.
"A String",
],
"warnedValidationRules": [ # 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"
"A String",
],
"assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
"type": "A String", # 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.
"name": "A String", # 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.
},
"clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
{ # Creative Click Tag.
"eventName": "A String", # 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.
"clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
"computedClickThroughUrl": "A String", # 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.
"customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
"landingPageId": "A String", # ID of the landing page for the click-through URL.
},
"name": "A String", # 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.
},
],
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
}