ads
creative

List all creatives

Changed on
get/ads/{connection_id}/creative

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/ads/{connection_id}/creative
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

org_idstring

The org ID to filter by (reference to AdsOrganization)

group_idstring

The group ID to filter by (reference to AdsGroup)

statusstring

The status to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
campaign_idstring
group_idstring

(reference to AdsGroup)

item_idstring

references Commerce Item ID (reference to CommerceItem)

organization_idstring
status'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED'
creative_type'UNSPECIFIED' | 'STANDARD' | 'EXPANDABLE' | 'VIDEO' | 'NATIVE' | 'AUDIO' | 'PUBLISHER_HOSTED' | 'ASSET_BASED' | 'IMAGE' | 'DOCUMENT' | 'SHARE'
hosting_source'UNSPECIFIED' | 'CM' | 'THIRD_PARTY' | 'HOSTED' | 'RICH_MEDIA' | 'PUBLISHER_HOSTED'
widthnumber
heightnumber
asset_urlsstring[]

Hosted asset mode (best-effort, provider-specific

link_urlstring

Destination URL for creatives with links

url_tagsstring

Appended URL tracking params (e.g. utm_source=..&utm_medium=..); Meta url_tags, Google tracking template

bodystring
titlestring
ctastring
third_party_tagstring
vast_tag_urlstring
external_creative_referencestring
external_placement_referencestring
external_ad_referencestring
path1string

Display URL path 1 (Microsoft RSA Path1)

path2string

Display URL path 2 (Microsoft RSA Path2)

datastring
labelsstring[]
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status