Error message

User warning: The following module is missing from the file system: fast_404. For information about how to fix this, see the documentation page. in _drupal_trigger_error_with_delayed_logging() (line 1143 of /mnt/www/html/ooyala/docroot/includes/bootstrap.inc).

Perfiles de detección del reproductor

Puede crear un perfil de detección que configura Ooyala Discovery para mostrar recomendaciones que aparecen dentro de un reproductor.

Si Ooyala Discovery está habilitado para un reproductor, pero no tiene un perfil de detección, el reproductor utiliza la misma configuración que el perfil de detección del reproductor por defecto.

Crear un perfil de detección por defecto

[PUT] /v2/players/player_id/discovery/profile
{ 
     properties
} 
   
Note: Si desea clonar una copia de un perfil de detección, realice una consulta GET con el perfil de detección del reproductor fuente y copie los datos desde el cuerpo de los resultados. A continuación, realice una consulta PUT con el nuevo perfil de detección del reproductor objetivo, utilizando el cuerpo del perfil de detección del reproductor fuente como entrada para el nuevo perfil.

Utilizar un perfil de detección creado previamente

Para utilizar perfiles de detección en cualquier consulta de la API de detección, agregue el parámetro de cadena de consulta discovery_profile_id=profile_id, donde profile_id es el identificador de un perfil previamente creado. Este parámetro de cadena de consulta sustituye a otros parámetros de cadena de consulta en la solicitud.

El siguiente es un ejemplo de la solicitud de recomendaciones personalizadas, modificado por el parámetro de cadena de consulta discovery_profile.

[GET] /v2/discover/personal/device_id?discovery_profile_id=profile_id
   

Ver información del perfil de detección

[GET] /v2/players/player_id/discovery/profile
   

Eliminar un perfil de detección

[DELETE] /v2/players/player_id/discovery/profile
   

Atributos de ruta

En la tabla siguiente se describen todos los atributos que se pueden expresar por medio de la ruta.

Atributo de ruta Descripción
player_id

El ID del reproductor. Para obtener una lista de reproductores, realice una consulta GET con la ruta /players.

Tipo: Cadena

Por defecto: Ninguno

Ejemplo: /players/b4f1a93b779145b4a9c8ef15f8502345

Propiedades

En la siguiente tabla se describen todas las propiedades que se pueden asociar a un reproductor.

Propiedad Descripción ¿Obligatorio?
default_countdown

Especifica el tiempo, en segundos, antes de que el siguiente vídeo se inicie automáticamente.

Tipo: Entero

Ejemplo: "10"

No
discovery_controls

Especifica la configuración de control de Ooyala Discovery.

Tipo: Contenedor

No
discovery_interface

Especifica la configuración de la interfaz de usuario.

Tipo: Contenedor

No
exclude_content_types

Lista separada por comas de los tipos de contenido que se excluirán en las recomendaciones de Ooyala Discovery.

Tipo: Lista de cadenas

Valores válidos: video | live_stream

Por defecto: none (ninguno)

Ejemplo: "live_stream","video"

No
exclude_labels

Lista separada por comas con las etiquetas que desea excluir de las recomendaciones de Ooyala Discovery. Para utilizar esta opción, filter_by se debe establecer en exclude_labels.

Tipo: Lista de cadenas

Por defecto: none (ninguno)

Ejemplo: "126ac19f053e424ab41bfbab5526ec30","d5751b77a0c24972888bf906734d8c34"

No
filter_by

Especifica el tipo de filtrado de etiquetas que se debe utilizar. Para excluir etiquetas, especifique exclude_labels y especifique una lista de etiquetas en el parámetro exclude_labels. Para incluir etiquetas específicas, especifique from_labels y especifique una lista de etiquetas en el parámetro from_labels. Para utilizar solamente etiquetas compartidas por la fuente y los vídeos recomendados, especifique shared_label.

Tipo: Cadena

Por defecto: none (ninguno)

Valores válidos: exclude_labels | from_labels | shared_label

Ejemplo: "exclude_labels"

No
from_content_types

Lista separada por comas de los tipos de contenido que se incluyen en las recomendaciones de Ooyala Discovery. Si no se admiten tipos de contenido y no se excluye ningún tipo, se puede devolver cualquier tipo de contenido.

Tipo: Lista de cadenas

Valores válidos: video | live_stream

Por defecto: none (ninguno)

Ejemplo: "video","live_stream"

No
from_labels

Lista separada por comas con las etiquetas utilizadas para las recomendaciones de Ooyala Discovery. Si no se especifican etiquetas, se permiten todas las etiquetas.

Tipo: Lista de cadenas

Por defecto: none (ninguno)

Ejemplo: "126ac19f053e424ab41bfbab5526ec30","d5751b77a0c24972888bf906734d8c34"

No
hide_thumbnail_title

Oculta el título de las vistas previas de los vídeos recomendados.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

No
include_sub_account_assets

Especifica si las recomendaciones de Ooyala Discovery incluyen el contenido de sus subcuentas.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

No
overrides

Especifica las anulaciones en Ooyala Discovery que le permiten insertar contenido en determinadas ubicaciones de los resultados. Puede especificar la posición de la anulación, el tipo de anulación e información adicional.

Si desea insertar contenido promocional, puede especificar "label" y escribir el ID de la etiqueta promocional.

Si desea obtener información de los metadatos de cada vídeo, especifique "relation" y la clave de metadatos que desea utilizar. Por ejemplo, es posible que desee elegir el siguiente vídeo de la serie. Para ello, puede crear una entrada de metadatos llamada next_series_video y agregar este fragmento de metadatos a cada vídeo de la serie (especificando el ID de contenido del próximo vídeo).

Si desea insertar contenido en vivo, especifique "live" sin ninguna información adicional.

Tipo: Contenedor

Valores válidos: label | relation | live

Por defecto: none (ninguno)

Ejemplos:

“1”: { “label”: “126ac19f053e424ab41bfbab5526ec30” }

“3”: { “relation”: “next_series_video” }

“5”: “live”

No
post_order

Ooyala Discovery, después de producir un conjunto de resultados, puede reordenar los resultados. Si se especifica "recency", los resultados se ordenan desde los más recientes a los más antiguos.

Note: La configuración post_order no afecta a las anulaciones editoriales.

Tipo: Cadena

Valores válidos: recency | <blank>

Por defecto: <blank>

Ejemplo: "recency"

No
recency_threshold_in_days

Especifica la antigüedad máxima del contenido que se va a mostrar, en días. Por ejemplo, es posible que desee crear un reproductor que solo contiene recomendaciones para el contenido cargado durante la semana pasada.

Tipo: Entero

Ejemplo: "7"

No
recommendation_scope

Especifica el alcance de las recomendaciones.

Tipo: Contenedor

No
shared_root_label

Especifica el ID de la etiqueta de base que se utiliza para generar recomendaciones. Por ejemplo, puede establecer el ID de la etiqueta "deportes".

Tipo: Cadena

Por defecto: none (ninguno)

Ejemplo: "126ac19f053e424ab41bfbab5526ec30"

No
show_pause_screen

Habilita la pantalla de pausa, que muestra las recomendaciones de Ooyala Discovery cada vez que el usuario pausa el vídeo.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

No
when_done

Especifica lo que ocurre cuando termina el vídeo. Las opciones incluyen la visualización de la pantalla de detección de Ooyala, mostrar la siguiente pantalla y comenzar automáticamente el siguiente vídeo, y ninguno (uso de la configuración predeterminada de la pantalla final).

Tipo: Cadena

Valores válidos: discovery_tray | up_next | none

Por defecto: none (ninguno)

Ejemplo: "up_next"

No

Ejemplos

Este ejemplo crea un reproductor básico que utiliza toda la configuración por defecto:

 [PUT] /v2/players/1fc11f8bc80e4a1a87303ee16fb8ad43/discovery/profile
{}
    

Backlot devuelve una respuesta similar a la siguiente:

{
 "discovery_interface": {
  "default_countdown": "0",
  "show_pause_screen": "false",
  "hide_thumbnail_title": "false",
  "when_done": ""
 },
 "discovery_controls": {
  "compute_trending_labels": "false",
  "trending_min_granularity": "2",
  "include_sub_account_assets": "",
  "recommendation_scope": {
   "from_content_types": [    ],
   "exclude_content_types": [    ],
   "exclude_labels": [    ],
   "recency_threshold_in_days": "",
   "from_labels": [    ]
  },
  "fallback_rules": [   ],
  "optimization_goal": ""
 }
}
    

Ordenando Pruébelo

Note: Puede obtener esta información en cualquier momento generando una consulta GET contra el ID del reproductor (por ej., [GET] /v2/players/1fc11f8bc80e4a1a87303ee16fb8ad43/discovery/profile).

Este ejemplo establece por defecto la cuenta regresiva en 10 segundos:

[PATCH] /v2/players/1fc11f8bc80e4a1a87303ee16fb8ad43/discovery/profile
{
 "discovery_interface": {
  "default_countdown": "10"
 }
}
    

Backlot devuelve una respuesta similar a la siguiente:

{
 "discovery_interface": {
  "default_countdown": "10",
  "show_pause_screen": "false",
  "hide_thumbnail_title": "false",
  "when_done": ""
 },
 "discovery_controls": {
  "compute_trending_labels": "false",
  "trending_min_granularity": "2",
  "include_sub_account_assets": "",
  "recommendation_scope": {
   "from_content_types": [    ],
   "exclude_content_types": [    ],
   "exclude_labels": [    ],
   "recency_threshold_in_days": "",
   "from_labels": [    ]
  },
  "fallback_rules": [   ],
  "optimization_goal": ""
 }
}
    

Ordenando Pruébelo