List creative works

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size

integer

Maximum number of records to return

project_id

string

filter

string

Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported. E.g. status:CREATIVE_WORK_STATUS_RELEASED and type_id:documentary For filtering on creative works without a type_id, use type_id:default.

order_by

string

Specifies the result ordering for List requests. Supported values are:

"title asc|desc"
"release_time asc|desc" This order is not applied when combined with search or pinned parameters.

page_token

string

The pagination token in the List request.

string

Any user-provided search query (as a plain string). This works in tandem with the filter parameter. Using search will automatically order all results by relevance instead of the supplied order_by value.

pinned

string[]

One or more creative work IDs that you want to receive at the top of the results (if it is available). Pinned items will not be included in the results if it does not match the filter. It will, however, ignore the search parameter. Using pinned will automatically order all results by relevance instead of the supplied order_by value.

Response

200 - application/json

creative_works

object[]

creative_works.project_id

string

required

creative_works.create_time

string

creative_works.description

string

creative_works.fields

object

creative_works.id

string

System generated unique identifier for the creative work.

creative_works.localized_description

object

A map of localized descriptions for this creative work. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the description field.

creative_works.localized_poster_asset_id

object

A map of localized poster asset IDs for this creative work. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the poster_asset_id field.

creative_works.localized_thumbnail_asset_id

object

A map of localized thumbnail asset IDs for this creative work. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the thumbnail_asset_id field.

creative_works.localized_title

object

A map of localized titles for this creative work, for end users to see. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc. If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.

Leaving this field empty will default to the title field.

creative_works.poster_asset_id

string

creative_works.release_time

string

The time at which this creative work was/will be released. This does not affect the visibility of the associated video(s), but can be displayed in the UI

creative_works.status

enum<string>

Current status of the creative work

Available options:

CREATIVE_WORK_STATUS_UNSPECIFIED,

CREATIVE_WORK_STATUS_SCHEDULED,

CREATIVE_WORK_STATUS_RELEASED

creative_works.thumbnail_asset_id

string

creative_works.title

string

creative_works.type_id

string

The type id of the creative work. For example documentary. May be set to default when no custom fields are present.

creative_works.video_ids

string[]

creative_works.visibility

enum<string>

Available options:

VISIBILITY_UNSPECIFIED,

VISIBILITY_PUBLISHED,

VISIBILITY_UNLISTED,

VISIBILITY_HIDDEN

next_page_token

string

The pagination token that should be used to get next page results. An empty value means no more results

Get Started

Studio API

Content Delivery API

Deep dive

List creative works

Authorizations

Query Parameters

Response