Player fields

List of fields to return for requests in the player object. Retrieve them using the fields query-string parameter on any player object request.

Fields

Description

ad_pressure_optimization

Optimize ad pressure based on selected model: monetization, balanced, standard

aspect_ratio

To specify the aspect ratio of the Player.

autoskip_after

After how many seconds the video is skipped (min: 10).

autostart

To control how the Player handles autoplay.

color

Change the default highlight color used in the controls.

contextual_content_freshness

Define the freshness of the content (in days) that can be selected by the contextual embed feature.

contextual_content_source

Define if your contextual content should be taken from your Organization, your channel, or Dailymotion’s global catalog.

created_time

Date and time when this Player was created.

Sample value: 1287507036

embed_html_url

URL of the Player HTML embed.

embed_script_url

URL of the Player to be used in a script HTML tag.

enable_ads

Whether to enable ads and associated tracking.

enable_ads_controls

Whether to display the Player controls during an ad.

enable_attention_peaks

Whether to display attention peaks above seekbar (boolean)

enable_automatic_recommendations

Whether to enable automatic recommendations.

enable_autonext

Whether to automatically play the next video item.

enable_autoskip

Whether to activate the "Autoskip" feature.

enable_channel_link

Whether to activate the link on the channel owner.

enable_click_to_unmute

Whether to enable the click to unmute feature.

enable_contextual_content

Whether to load relevant content based on contextual information from the embedder page.

enable_contextual_content_fallback

Whether to allow the contextual embed feature to play less relevant videos from your channel or other sources, to avoid displaying an empty player when content with high relevancy is not available.

enable_contextual_content_freshness

Whether to activate the "Contextual content freshness" feature.

enable_custom_recommendations

Whether to enable custom recommendations.

enable_dm_logo

Whether to display the Dailymotion logo.

enable_dynamic_thumbnail

Whether to display animated video preview instead of a static thumbnail

enable_eco_mode

Whether to enable eco mode to apply a quality limit.

enable_google_policy_ui

When pip is activated: Whether to activate the UI to be Google policy compliant (e.g.: PIP close button outside Player UI).

enable_info

Whether to display the video title and owner information.

enable_keyboard_shortcuts

Whether to enable the keyboard shortcuts.

enable_legacy_pip

When enabled, player displays the legacy PiP version

enable_live_offair_screen

Whether to display streaming status before and after live streaming.

enable_paid_partnership_label

Whether to enable the paid partnership label (if the playing video is flagged as such).

enable_pip_placement

Whether to choose the webpage corner where PiP is initialized. If used, overwrites PiP CSS customization

enable_playback_controls

Whether to display the player controls during a video

enable_receive_url_location

Allow Player to receive full page URL where Player is embedded.

enable_sharing

Whether to enable the sharing button.

enable_sharing_url_location

Whether to share the location where the video is embedded (video URL by default).

enable_spinner

Whether to display spinner during video loading

enable_start_pip_expanded

Whether to start PiP in expanded mode on mobile.

enable_startscreen_dm_link

Whether to show the "Watch on Dailymotion" link on the start screen.

enable_subtitles

Whether to activate the subtitles in the Player.

enable_tap_to_unmute

Whether to enable the tap to unmute feature.

enable_titles_in_video_cards

Whether to show the videos titles in the carousel on the end screen.

enable_video_title_link

Whether to activate the link on the video title.

enable_wait_for_custom_config

Whether to configure the Player to wait for the custom config object before starting playback.

enable_watch_now_card

Whether to display one video card after playback.

has_reached_playback_limits

Whether the Organization that owns the Player has reached some limits (bandwidth, plays).

has_recommendations_from_org_only

Whether the Organization that owns the Player includes only videos from this Organization in recommendations.

has_ssai

Whether the Organization that owns the Player has SSAI enabled.

id

Unique object identifier (unique among all Players).

item_type

Graph type of this object (hopefully player).

label

Mandatory Player label.

lib_script_url

URL of the Player Embed Library to be used in a <script> HTML tag.

owner

Owner of this Player. You can retrieve sub-fields of this user object using the dot-notation (e.g.: owner.id).

pip

Whether to activate Picture-in-Picture mode.

pip_selected_placement

Define the webpage corner where PiP is initialized

recommendations_optimisation

Optimise recommendations based on the selected model.

updated_time

Date and time when this Player was updated.

wait_for_custom_config_delay

How long to wait before the ad request is made (min: 1s – max: 10s).

watermark_image_type

Image type of the watermark.

watermark_link_type

Type of watermark link.

watermark_link_url

URL of the watermark link.




ad_pressure_optimization

Optimize ad pressure based on selected model: monetization, balanced, standard

Possible values: monetization balanced standard

TypeSample valueRead accessWrite access
stringmonetizationPublicPrivate, can be written by the owner of the object

aspect_ratio

To specify the aspect ratio of the Player.

Possible values: 16:9 4:3 1:1 3:4 9:16 inherit

TypeSample valueRead accessWrite access
stringPublicPrivate

autoskip_after

After how many seconds the video is skipped (min: 10).
Note: Needs to be combined with "enable_autoskip": true.

Sample value: 20

TypeSample valueRead accessWrite access
number20PublicPrivate

autostart

To control how the Player handles autoplay.

Possible values: on off firstTimeViewable

TypeSample valueRead accessWrite access
stringPublicPrivate

color

Change the default highlight color used in the controls.

Sample value: 00aaff

TypeSample valueRead accessWrite access
string00aaffPublicPrivate

contextual_content_freshness

Define the freshness of the content (in days) that can be selected by the contextual embed feature.
Note: Needs to be combined with "enable_contextual_content": true

Sample value: 1800

TypeSample valueRead accessWrite access
number1800PublicPrivate

contextual_content_source

Define if your contextual content should be taken from your Organization, your channel, or Dailymotion’s global catalog.
Note: Needs to be combined with "enable_contextual_content": true

Possible values: channel organization dailymotion

TypeSample valueRead accessWrite access
stringPublicPrivate

created_time

Date and time when this Player was created.

Sample value: 1287507036

TypeSample valueRead accessWrite access
date1287507036PublicPrivate

embed_html_url

URL of the Player HTML embed.

Sample value: https://geo.dailymotion.com/player/x123.html

TypeSample valueRead accessWrite access
urlhttps://geo.dailymotion.com/player/x123.htmlPublicPrivate

embed_script_url

URL of the Player to be used in a script HTML tag.

Sample value: https://geo.dailymotion.com/player/x123.js

TypeSample valueRead accessWrite access
urlPublicPrivate

enable_ads

Whether to enable ads and associated tracking.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_ads_controls

Whether to display the Player controls during an ad.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_attention_peaks

Whether to display attention peaks above seekbar (boolean)

default : true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_automatic_recommendations

Whether to enable automatic recommendations.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_autonext

Whether to automatically play the next video item.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_autoskip

Whether to activate the "Autoskip" feature.

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_channel_link

Whether to activate the link on the channel owner.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_click_to_unmute

Whether to enable the click to unmute feature.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_contextual_content

Whether to load relevant content based on contextual information from the embedder page.

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_contextual_content_fallback

Whenenable_contextual_content is activated: Whether to allow the contextual embed feature to play less relevant videos from your channel or other sources, to avoid displaying an empty player when content with high relevancy is not available.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_contextual_content_freshness

Whenenable_contextual_content is activated: Whether to activate the "Contextual content freshness" feature.
**If set to true: ** Combine with contextual_content_freshness to define the freshness of the content (in days).

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_custom_recommendations

Whether to enable custom recommendations.

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_dm_logo

Whether to display the Dailymotion logo.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_dynamic_thumbnail

Whether to display animated video preview instead of a static thumbnail

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate, can be written by the owner of the object

enable_eco_mode

Whether to enable eco mode to apply a quality limit.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_google_policy_ui

When pip is activated: Whether to activate the UI to be Google policy compliant (e.g.: PIP close button outside Player UI).

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_info

Whether to display the video title and owner information.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_keyboard_shortcuts

Whether to enable the keyboard shortcuts.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_legacy_pip

When enabled, player displays the legacy PiP version

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_live_offair_screen

Whether to display streaming status before and after live streaming.

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_paid_partnership_label

Whether to enable the paid partnership label (if the playing video is flagged as such).

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_pip_placement

Whether to choose the webpage corner where PiP is initialized. If used, overwrites PiP CSS customization

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_playback_controls

Whether to display the player controls during a video

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate, can be written by the owner of the object.

enable_receive_url_location

Allow Player to receive full page URL where Player is embedded.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_sharing

Whether to enable the sharing button.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_sharing_url_location

Whether to share the location where the video is embedded (video URL by default).

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_spinner

Whether to display spinner during video loading

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_start_pip_expanded

Whenpip is true: Whether to start PiP in expanded mode on mobile.

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_startscreen_dm_link

Whether to show the "Watch on Dailymotion" link on the start screen.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_subtitles

Whether to activate the subtitles in the Player.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_tap_to_unmute

Whether to enable the tap to unmute feature.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_titles_in_video_cards

Whether to show the videos titles in the carousel on the end screen.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_video_title_link

Whether to activate the link on the video title.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_wait_for_custom_config

Whether to configure the Player to wait for the custom config object before starting playback.

Default: false

TypeSample valueRead accessWrite access
booleanPublicPrivate

enable_watch_now_card

Whether to display one video card after playback.

Default: true

TypeSample valueRead accessWrite access
booleanPublicPrivate

has_reached_playback_limits

Whether the Organization that owns the Player has reached some limits (bandwidth, plays).

TypeSample valueRead accessWrite access
booleanPublicPrivate

has_recommendations_from_org_only

Whether the Organization that owns the Player includes only videos from this Organization in recommendations.

TypeSample valueRead accessWrite access
booleanPublicPrivate

has_ssai

Whether the Organization that owns the Player has SSAI enabled.

TypeSample valueRead accessWrite access
booleanPublicPrivate

id

Unique object identifier (unique among all Players).

Example: xgzn1qy

TypeSample valueRead accessWrite access
identifierxgzn1qyPublicPrivate

item_type

Graph type of this object (hopefully player).

TypeSample valueRead accessWrite access
stringPublicPrivate

label

Mandatory Player label.

Example: My Player name
Min length: 1 Max length: 250

TypeSample valueRead accessWrite access
stringMy Player namePublicPrivate


lib_script_url

URL of the Player Embed Library to be used in a <script> HTML tag.

TypeSample valueRead accessWrite access
urlhttps://geo.dailymotion.com/libs/player/x123.jsPublicPrivate

owner

Owner of this Player. You can retrieve sub-fields of this user object using the dot-notation (e.g.: owner.id).

Example: xgzn1qy

TypeSample valueRead accessWrite access
stringxat79kpPublicPrivate

pip

Whether to activate Picture-in-Picture mode.

Possible values:

  • instant: PiP launches as soon as the Player is loaded.
  • on: PiP enabled.
  • off: PiP disabled.
TypeSample valueRead accessWrite access
stringonPublicPrivate

pip_selected_placement

Define the webpage corner where PiP is initialized

Possible values:
bottom_right, bottom_left, top_right, top_left

Default value: bottom_right

TypeSample valueRead accessWrite access
enumbottom_rightPublicPrivate


recommendations_optimisation

Optimise recommendations based on the selected model.

Possible values:

  • monetization: Recommends videos with high revenue potential.
  • engagement: Recommends videos relevant to the initial one, with a focus on content generating more user interactions.
  • views: Recommends videos relevant to the initial one, with a focus on content generating more views.

TypeSample valueRead accessWrite access
stringmonetizationPublicPrivate

updated_time

Optimise recommendations based on the selected model.

Possible values:

  • monetization: Recommends videos with high revenue potential.
  • engagement: Recommends videos relevant to the initial one, with a focus on content generating more user interactions.
  • views: Recommends videos relevant to the initial one, with a focus on content generating more views.

TypeSample valueRead accessWrite access
date1287507036PublicPrivate

wait_for_custom_config_delay

Whenenable_wait_for_custom_config is true: How long to wait before the ad request is made (min: 1s – max: 10s).

Min: 1
Max: 10

TypeSample valueRead accessWrite access
number10PublicPrivate

watermark_image_type

Image type of the watermark.

Possible values: none from_channel custom


TypeSample valueRead accessWrite access
stringfrom_channelPublicPrivate

watermark_link_type

Type of watermark link.

Possible values: none from_channel custom

TypeSample valueRead accessWrite access
stringcustomPublicPrivate

watermark_link_url

URL of the watermark link.

TypeSample valueRead accessWrite access
urlhttps://www.dailymotion.comPublicPrivate