Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
Creative

Create a new Creative.

Create a new creative of the product. One and only one of the sources must be specified for the Creative.

post/cm/v1/creatives

Query parameters

ad_account_idstring required

The AdAccount ID which the Creative belongs to.

product_idstring required

The Product ID which the Creative belongs to.

Request body

idstring

Unique identifier of the Creative. Automatically set by server on creation.

ad_account_idstring

ID of the AdAccount the Creative belongs to.

product_idstring

ID of the Product the Creative belongs to.

titlestring required

A descriptive name of the Creative.

enabling_state'UNSPECIFIED' | 'ENABLED' | 'DISABLED'

Enumeration of the enabling states with a default UNSPECIFIED state.

type'UNKNOWN_TYPE' | 'IMAGE' | 'VIDEO' | 'VAST_VIDEO' | 'NATIVE' | 'NATIVE_IMAGE' | 'NATIVE_VIDEO' | 'CUSTOM_HTML' | 'TEMPLATE_HTML' | 'RICH_CUSTOM_HTML' | 'DYNAMIC_HTML' | 'AD_TAG'

Type of the Creative. Only one of the Creative source fields matching the type is allowed to be specified.

  • UNKNOWN_TYPE: This value is not part of the specification.
  • IMAGE: Image Creative. The image Creative source must be specified for this type.
  • VIDEO: Video Creative. The video Creative source must be specified for this type.
  • VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type.
  • NATIVE: Deprecated. v1.5 is the last version supporting this version. Native Creative. The native Creative source must be specified for this type.
  • NATIVE_IMAGE: Native image Creative. The native image Creative source must be specified for this type.
  • NATIVE_VIDEO: Native video Creative. The native video Creative source must be specified for this type.
  • CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative source must be specified for this type.
  • TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The template HTML Creative source must be specified for this type.
  • RICH_CUSTOM_HTML: The rich custom HTML Creative. The rich custom HTML Creative source must be specified for this type.
  • DYNAMIC_HTML: (Will be supported soon) The dynamic HTML Creative. The dynamic HTML Creative source must be specified for this type.
  • AD_TAG: (Will be supported soon) Third-party ad tag Creative with script-based or vast tag-based ad tag.
original_filenamestring required

Original Creative filename given by user.

size_in_bytesinteger

Estimated size of the Creative in bytes.

custom_key_valuesobject

Custom key/values managed by the Moloco Ads client platform. It's up to the client ads platform to define the schema for the values and their optionality.

The keys are recommended, but not required, to be prefixed with the reversed internet domain of the AdCloud client platform company. For example, keys defined by the client ads platform company "example.com" should have "com.example." as the prefix.

For complex values, JSON payload is recommended.

Moloco doesn't interpret these data in any way for ads serving. Upon serving, the custom key/values in the AdAccount, Campaign, and Creative models will be combined into the serving Creative proto in the order of precedence, with Creative's value having the highest precedence on the same key.

feature_type'UNKNOWN_CREATIVE_FEATURE_TYPE' | 'GENERAL' | 'DYNAMIC_CREATIVE'

CreativeFeatureType.

creator_tagstring

Creator tag to identify who is the resource creator.

created_atstring date-time

Created time.

updated_atstring date-time

Last updated time. Should not modify on the client side.

Response

A successful response.