Method: creativeAssets.insert

Inserts a new creative asset.

HTTP request

  • Upload URI, for media upload requests:
    POST https://dfareporting.googleapis.com/upload/dfareporting/v4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets
  • Metadata URI, for metadata-only requests:
    POST https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.
advertiserId

string (int64 format)

Advertiser ID of this creative. This is a required field.

Request body

The request body contains an instance of CreativeAssetMetadata.

Response body

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.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "assetIdentifier": {
    object (CreativeAssetId)
  },
  "detectedFeatures": [
    enum (Html5Feature)
  ],
  "warnedValidationRules": [
    enum (ValidationRule)
  ],
  "clickTags": [
    {
      object (ClickTag)
    }
  ],
  "id": string,
  "idDimensionValue": {
    object (DimensionValue)
  },
  "richMedia": boolean,
  "counterCustomEvents": [
    {
      object (CreativeCustomEvent)
    }
  ],
  "exitCustomEvents": [
    {
      object (CreativeCustomEvent)
    }
  ],
  "timerCustomEvents": [
    {
      object (CreativeCustomEvent)
    }
  ],
  "kind": string
}
Fields
assetIdentifier

object (CreativeAssetId)

ID of the creative asset. This is a required field.
detectedFeatures[]

enum (Html5Feature)

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.
warnedValidationRules[]

enum (ValidationRule)

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

    "
clickTags[]

object (ClickTag)

List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.
id

string (int64 format)

Numeric ID of the asset. This is a read-only, auto-generated field.
idDimensionValue

object (DimensionValue)

Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
richMedia

boolean

True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.
counterCustomEvents[]

object (CreativeCustomEvent)

List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
exitCustomEvents[]

object (CreativeCustomEvent)

List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
timerCustomEvents[]

object (CreativeCustomEvent)

List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#creativeAssetMetadata"

.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking

ValidationRule

Rules that the upload and/or html5 conversion service needs to validate against.

Enums
CLICK_TAG_NON_TOP_LEVEL Click tag initialization detected but not at the top level of the primary html file.
CLICK_TAG_MISSING No click tag detected.
CLICK_TAG_MORE_THAN_ONE More than one click tag detected.
CLICK_TAG_INVALID Click tag invalid (failed url validation).
ORPHANED_ASSET Orphaned asset not referenced.
PRIMARY_HTML_MISSING Primary html file missing.
EXTERNAL_FILE_REFERENCED Reference to a third-party resource.
MRAID_REFERENCED Reference to INAPP MRAID feature.
ADMOB_REFERENCED Reference to INAPP ADMOB feature.
FILE_TYPE_INVALID Invalid file type referenced.
ZIP_INVALID Invalid zip passed in
LINKED_FILE_NOT_FOUND A relative file was linked to that wasn't included in zip.
MAX_FLASH_VERSION_11 Max flash version at 11.
NOT_SSL_COMPLIANT Whether the asset uses secure urls or not.
FILE_DETAIL_EMPTY File detail empty.
ASSET_INVALID Asset is not valid and could not be processed.
GWD_PROPERTIES_INVALID GWD properties are invalid.
ENABLER_UNSUPPORTED_METHOD_DCM Unsupported Enabler methods in DCM.
ASSET_FORMAT_UNSUPPORTED_DCM Asset ad format is unsupported in DCM.
COMPONENT_UNSUPPORTED_DCM Component is unsupported in DCM.
HTML5_FEATURE_UNSUPPORTED Html5 feature is unsupported.
CLICK_TAG_IN_GWD Click tag defined in GWD asset. GWD-published creatives should use exit events instead of defining var clickTag. Defined var clickTags are a symptom of an unsupported workflow, and an error should be thrown.
CLICK_TAG_HARD_CODED Whether the asset has hard coded click tag url(s).
SVG_INVALID Whether an SVG block could not be parsed.
CLICK_TAG_IN_RICH_MEDIA Click tag defined in rich media asset. Rich media creatives should use exit events instead of defining var clickTag. Defined var clickTags are a symptom of an unsupported workflow, and an error should be thrown.
MISSING_ENABLER_REFERENCE Rich media primary asset is missing the Enabler reference.