Method: creativeAssets.insert

  • This page details how to insert a new creative asset.

  • The process involves making an HTTP POST request to a specified URI, which can be for media upload or metadata only.

  • Request parameters include profileId and a required advertiserId.

  • The request body requires an instance of CreativeAssetMetadata.

  • A successful response provides details about the uploaded creative asset, including detected features, warnings, and various event configurations for rich media assets.

Inserts a new creative asset.

HTTP request

  • Upload URI, for media upload requests:
    POST https://dfareporting.googleapis.com/upload/dfareporting/v5/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets
  • Metadata URI, for metadata-only requests:
    POST https://dfareporting.googleapis.com/dfareporting/v5/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