Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
Creative

List up Creatives.

List up all creatives of the AdAccount or the Product.

get/cm/v1/creatives

Query parameters

ad_account_idstring required

The AdAccount ID to which the Creatives belong to.

product_idstring

The Product ID to which the Creatives belong to.

typesstring[]

The type of the Creatives to be listed. If not specified, all types of Creatives will be listed.

  • 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.
order_by.key'UNKNOWN_ORDER_BY' | 'UPDATED_AT'
order_by.is_descendingboolean
inquiry_option'UNKNOWN_INQUIRY_OPTION' | 'INQUIRY_ENTITY' | 'INQUIRY_OVERVIEW' | 'INQUIRY_ALL'

InquiryOption to specify which information to retrieve.

  • INQUIRY_ENTITY: Only the target entity itself is returned in response. This InquiryOption is faster than other options as it reads the single entity from the database.
  • INQUIRY_OVERVIEW: The target entity's overview information is returned in response. In general, the overview information includes the brief content of the target entity and its related entities. This InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.
  • INQUIRY_ALL: The target entity and its summary information is returned in response. This InquiryOption is equivalent to INQUIRY_ENTITY + INQUIRY_OVERVIEW, and it's slow and big.

Response

A successful response.