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 |
|---|---|
| Optimize ad pressure based on selected model: monetization, balanced, standard |
| To specify the aspect ratio of the Player. |
| After how many seconds the video is skipped (min: |
| To control how the Player handles autoplay. |
| Change the default highlight color used in the controls. |
| Define the freshness of the content (in days) that can be selected by the contextual embed feature. |
| Define if your contextual content should be taken from your Organization, your channel, or Dailymotion’s global catalog. |
| Date and time when this Player was created. Sample value: |
| URL of the Player HTML embed. |
| URL of the Player to be used in a script HTML tag. |
| Whether to enable ads and associated tracking. |
| Whether to display the Player controls during an ad. |
| Whether to display attention peaks above seekbar (boolean) |
| Whether to enable automatic recommendations. |
| Whether to automatically play the next video item. |
| Whether to activate the "Autoskip" feature. |
| Whether to activate the link on the channel owner. |
| Whether to enable the click to unmute feature. |
| Whether to load relevant content based on contextual information from the embedder page. |
| 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. |
| Whether to activate the "Contextual content freshness" feature. |
| Whether to enable custom recommendations. |
| Whether to display the Dailymotion logo. |
| Whether to display animated video preview instead of a static thumbnail |
| Whether to enable eco mode to apply a quality limit. |
| When |
| Whether to display the video title and owner information. |
| Whether to enable the keyboard shortcuts. |
| When enabled, player displays the legacy PiP version |
| Whether to display streaming status before and after live streaming. |
| Whether to enable the paid partnership label (if the playing video is flagged as such). |
| Whether to choose the webpage corner where PiP is initialized. If used, overwrites PiP CSS customization |
| Whether to display the player controls during a video |
| Allow Player to receive full page URL where Player is embedded. |
| Whether to enable the sharing button. |
| Whether to share the location where the video is embedded (video URL by default). |
| Whether to display spinner during video loading |
| Whether to start PiP in expanded mode on mobile. |
| Whether to show the "Watch on Dailymotion" link on the start screen. |
| Whether to activate the subtitles in the Player. |
| Whether to enable the tap to unmute feature. |
| Whether to show the videos titles in the carousel on the end screen. |
| Whether to activate the link on the video title. |
| Whether to configure the Player to wait for the custom config object before starting playback. |
| Whether to display one video card after playback. |
| Whether the Organization that owns the Player has reached some limits (bandwidth, plays). |
| Whether the Organization that owns the Player includes only videos from this Organization in recommendations. |
| Whether the Organization that owns the Player has SSAI enabled. |
| Unique object identifier (unique among all Players). |
| Graph type of this object (hopefully |
| Mandatory Player label. |
| URL of the Player Embed Library to be used in a |
| Owner of this Player. You can retrieve sub-fields of this user object using the dot-notation (e.g.: |
| Whether to activate Picture-in-Picture mode. |
| Define the webpage corner where PiP is initialized |
| Optimise recommendations based on the selected model. |
| Date and time when this Player was updated. |
| How long to wait before the ad request is made (min: 1s – max: 10s). |
| Image type of the watermark. |
| Type of watermark link. |
| URL of the watermark link. |
ad_pressure_optimization
Optimize ad pressure based on selected model: monetization, balanced, standard
Possible values: monetization balanced standard
| Type | Sample value | Read access | Write access |
|---|---|---|---|
monetization | Public | Private, 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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
autoskip_after
After how many seconds the video is skipped (min: 10).
Note: Needs to be combined with "enable_autoskip": true.
Sample value: 20
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| 20 | Public | Private |
autostart
To control how the Player handles autoplay.
Possible values: on off firstTimeViewable
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
color
Change the default highlight color used in the controls.
Sample value: 00aaff
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| 00aaff | Public | Private |
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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| 1800 | Public | Private |
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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
created_time
Date and time when this Player was created.
Sample value: 1287507036
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| 1287507036 | Public | Private |
embed_html_url
URL of the Player HTML embed.
Sample value: https://geo.dailymotion.com/player/x123.html
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| https://geo.dailymotion.com/player/x123.html | Public | Private |
embed_script_url
URL of the Player to be used in a script HTML tag.
Sample value: https://geo.dailymotion.com/player/x123.js
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_ads
Whether to enable ads and associated tracking.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_ads_controls
Whether to display the Player controls during an ad.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_attention_peaks
Whether to display attention peaks above seekbar (boolean)
default : true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_automatic_recommendations
Whether to enable automatic recommendations.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_autonext
Whether to automatically play the next video item.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_autoskip
Whether to activate the "Autoskip" feature.
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_channel_link
Whether to activate the link on the channel owner.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_click_to_unmute
Whether to enable the click to unmute feature.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_contextual_content
Whether to load relevant content based on contextual information from the embedder page.
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_custom_recommendations
Whether to enable custom recommendations.
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_dm_logo
Whether to display the Dailymotion logo.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_dynamic_thumbnail
Whether to display animated video preview instead of a static thumbnail
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private, can be written by the owner of the object |
enable_eco_mode
Whether to enable eco mode to apply a quality limit.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_info
Whether to display the video title and owner information.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_keyboard_shortcuts
Whether to enable the keyboard shortcuts.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_legacy_pip
When enabled, player displays the legacy PiP version
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_live_offair_screen
Whether to display streaming status before and after live streaming.
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_paid_partnership_label
Whether to enable the paid partnership label (if the playing video is flagged as such).
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_pip_placement
Whether to choose the webpage corner where PiP is initialized. If used, overwrites PiP CSS customization
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_playback_controls
Whether to display the player controls during a video
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private, 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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_sharing
Whether to enable the sharing button.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_sharing_url_location
Whether to share the location where the video is embedded (video URL by default).
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_spinner
Whether to display spinner during video loading
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_start_pip_expanded
Whenpip is true: Whether to start PiP in expanded mode on mobile.
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_startscreen_dm_link
Whether to show the "Watch on Dailymotion" link on the start screen.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_subtitles
Whether to activate the subtitles in the Player.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_tap_to_unmute
Whether to enable the tap to unmute feature.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_titles_in_video_cards
Whether to show the videos titles in the carousel on the end screen.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_video_title_link
Whether to activate the link on the video title.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_wait_for_custom_config
Whether to configure the Player to wait for the custom config object before starting playback.
Default: false
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
enable_watch_now_card
Whether to display one video card after playback.
Default: true
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
has_reached_playback_limits
Whether the Organization that owns the Player has reached some limits (bandwidth, plays).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
has_recommendations_from_org_only
Whether the Organization that owns the Player includes only videos from this Organization in recommendations.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
has_ssai
Whether the Organization that owns the Player has SSAI enabled.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
id
Unique object identifier (unique among all Players).
Example: xgzn1qy
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| identifier | xgzn1qy | Public | Private |
item_type
Graph type of this object (hopefully player).
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| Public | Private |
label
Mandatory Player label.
Example: My Player name
Min length: 1
Max length: 250
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| My Player name | Public | Private |
lib_script_url
URL of the Player Embed Library to be used in a <script> HTML tag.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
https://geo.dailymotion.com/libs/player/x123.js | Public | Private |
owner
Owner of this Player. You can retrieve sub-fields of this user object using the dot-notation (e.g.: owner.id).
Example: xgzn1qy
| Type | Sample value | Read access | Write access |
|---|---|---|---|
xat79kp | Public | Private |
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.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
on | Public | Private |
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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
bottom_right | Public | Private |
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.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
monetization | Public | Private |
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.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
1287507036 | Public | Private |
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
| Type | Sample value | Read access | Write access |
|---|---|---|---|
10 | Public | Private |
watermark_image_type
Image type of the watermark.
Possible values: none from_channel custom
| Type | Sample value | Read access | Write access |
|---|---|---|---|
from_channel | Public | Private |
watermark_link_type
Type of watermark link.
Possible values: none from_channel custom
| Type | Sample value | Read access | Write access |
|---|---|---|---|
custom | Public | Private |
watermark_link_url
URL of the watermark link.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
https://www.dailymotion.com | Public | Private |
