Insert
|
|||||
|
|
||||
Inserts a new creative asset
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 23 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
advertiserId Required |
INTEGER |
Advertiser ID of this creative. This is a required field |
assetIdentifier |
OBJECT |
Creative Asset ID |
assetIdentifier.name |
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 |
assetIdentifier.type |
ENUMERATION |
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 |
clickTags[] |
OBJECT |
Creative Click Tag |
clickTags[].clickThroughUrl |
OBJECT |
Click-through URL |
clickTags[].clickThroughUrl.computedClickThroughUrl |
STRING |
Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
|
clickTags[].clickThroughUrl.customClickThroughUrl |
STRING |
Custom click-through URL. Applicable if the landingPageId field is left unset |
clickTags[].clickThroughUrl.landingPageId |
INTEGER |
ID of the landing page for the click-through URL |
clickTags[].eventName |
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 |
clickTags[].name |
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 |
detectedFeatures[] |
ENUMERATION |
|
id |
INTEGER |
Numeric ID of the asset. This is a read-only, auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
idDimensionValue.matchType |
ENUMERATION |
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 |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata" |
warnedValidationRules[] |
ENUMERATION |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
advertiserId INTEGER Required Advertiser ID of this creative. This is a required field |
|
assetIdentifier OBJECT Creative Asset ID |
|
assetIdentifier.name 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 |
|
assetIdentifier.type ENUMERATION 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 |
|
clickTags[] OBJECT Creative Click Tag |
|
clickTags[].clickThroughUrl OBJECT Click-through URL |
|
clickTags[].clickThroughUrl.computedClickThroughUrl STRING Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
|
|
clickTags[].clickThroughUrl.customClickThroughUrl STRING Custom click-through URL. Applicable if the landingPageId field is left unset |
|
clickTags[].clickThroughUrl.landingPageId INTEGER ID of the landing page for the click-through URL |
|
clickTags[].eventName 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 |
|
clickTags[].name 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 |
|
detectedFeatures[] ENUMERATION |
|
id INTEGER Numeric ID of the asset. This is a read-only, auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
idDimensionValue.matchType ENUMERATION 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 |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata" |
|
warnedValidationRules[] ENUMERATION |
Output
This building block provides 21 output parameters
| Name | Format | Description |
|---|---|---|
assetIdentifier |
OBJECT |
Creative Asset ID |
assetIdentifier.name |
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 |
assetIdentifier.type |
ENUMERATION |
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 |
clickTags[] |
OBJECT |
Creative Click Tag |
clickTags[].clickThroughUrl |
OBJECT |
Click-through URL |
clickTags[].clickThroughUrl.computedClickThroughUrl |
STRING |
Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
|
clickTags[].clickThroughUrl.customClickThroughUrl |
STRING |
Custom click-through URL. Applicable if the landingPageId field is left unset |
clickTags[].clickThroughUrl.landingPageId |
INTEGER |
ID of the landing page for the click-through URL |
clickTags[].eventName |
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 |
clickTags[].name |
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 |
detectedFeatures[] |
ENUMERATION |
|
id |
INTEGER |
Numeric ID of the asset. This is a read-only, auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
idDimensionValue.matchType |
ENUMERATION |
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 |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata" |
warnedValidationRules[] |
ENUMERATION |
= Parameter name
= Format
|
assetIdentifier OBJECT Creative Asset ID |
|
assetIdentifier.name 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 |
|
assetIdentifier.type ENUMERATION 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 |
|
clickTags[] OBJECT Creative Click Tag |
|
clickTags[].clickThroughUrl OBJECT Click-through URL |
|
clickTags[].clickThroughUrl.computedClickThroughUrl STRING Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
|
|
clickTags[].clickThroughUrl.customClickThroughUrl STRING Custom click-through URL. Applicable if the landingPageId field is left unset |
|
clickTags[].clickThroughUrl.landingPageId INTEGER ID of the landing page for the click-through URL |
|
clickTags[].eventName 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 |
|
clickTags[].name 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 |
|
detectedFeatures[] ENUMERATION |
|
id INTEGER Numeric ID of the asset. This is a read-only, auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
idDimensionValue.matchType ENUMERATION 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 |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata" |
|
warnedValidationRules[] ENUMERATION |