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).

API de consulta

Para solicitar información sobre contenidos en una cuenta de Backlot, ofrecemos una API de consulta flexible.

La solicitudes se realizan mediante llamadas GET tipo REST firmadas a http://api.ooyala.com/partner/query. Los resultados son paginados con el tamaño de página establecido por el parámetro límite y el número de página solicitado por el parámetro pageID. Cuando nextPageID tiene un valor de -1, no hay más resultados que buscar.

Parámetros de criterios de búsqueda necesarios:

  • pcode – Identificador de cuenta
  • expires – Fecha de expiración de la consulta en segundos desde epoch (00:00:00 1/1/1970 GMT)
  • signature – La firma digital de la consulta. La firma debe calcularse usando SHA-256 según las reglas de generación de firmas.

Parámetros de criterios de búsqueda opcionales:

  • contentType – Busca por tipo de contenido. Uno de entre Video, VideoAd, Channel, MultiChannel, LiveStream, YouTube o RemoteAsset.
  • description – Busca por palabras en la descripción.
  • title – Busca por palabras en el título. La asociación "LIKE" se usa à la SQL.
  • text – Busca por palabras en el título o descripción. Busca resultados que incluyan contenidos con palabras específicas en el título o en la descripción.
  • embedCode – Asocia con embedCode. Las asociaciones de varios embedCode pueden ser especificadas mediante una lista separada por comas.
  • fields – una lista separada por comas de campos adicionales para incluir los resultados. Los valores válidos para esta lista son:
    • labels
    • metadatos
    • ratings – La información de las valoraciones es devuelta por un elemento XML "movieRatings" con la forma: <movieRatings>4;3;2;0;0;0;0;0;0;0;0</movieRatings>. Este elemento estará ausente si el elemento de contenido aún no dispone de valoraciones.
    Note: Las etiquetas estarán incluidas en la respuesta si se ha incluido una etiqueta en los parámetros de búsqueda; lo mismo que en el caso de los metadatos.
  • includeDeleted – true o false. Especifica si se incluye o no contenido que ha sido borrado en los últimos 30 días en la respuesta de consulta. La opción por defecto es false.
  • label[<id>] – Asocia contenido con etiquetas con nombres totalmente calificados que coinciden con TODAS las cadenas dadas. Use caracteres alfanuméricos para la porción de parámetro del ID.
  • limit – El número de resultados que deben incluirse por página. La opción por defecto es 500.
  • pageID – El ID de la página solicitada. La opción por defecto es 0.
  • queryMode – El operador que debe utilizarse para evaluar varios criterios de búsqueda. Esto puede ser "AND" o "OR". La opción por defecto es AND.
  • statistics – Una lista separada por comas que especifica el período de tiempo de devolución de las estadísticas. Especifique uno o más del estilo, 1d, 2d, 3d, 4d, 5d, 7d, 14d, 28d, 29d, 30d, 31d
  • status – Asocia el estado del contenido. Las asociaciones de varios estados pueden ser especificadas mediante una lista separada por comas.
    • RemoteAsset – vídeo remoto
    • deleted – vídeo o canal eliminado del sistema
    • live – el vídeo o canal está libre de errores, procesado y puede reproducirse ahora
    • scheduled – el vídeo o canal está libre de errores, procesado está programado para encontrarse disponible en el futuro
    • finished airing – el vídeo o canal está libre de errores, procesado y ya no se encuentra disponible
    • error – error de pre o post procesamiento
    • filemissing – error de la etapa de carga
    • uploading – el archivo se está cargando
    • paused – el vídeo no se puede reproducir (el usuario establece el estado)
    • uploaded – estado entre carga y procesamiento
    • na – representa contenido desconocido
    • cremoved – contenido autosindicado que ha sido borrado y ya no se encuentra disponible en la cuenta de destino porque ha sido borrado en la cuenta fuente
    • uploading – 'a' aquí significa API, por lo que esto significa que es una carga de API. Cada carga que no se produzca mediante la interfaz de Backlot es una carga API.
    • auploaded – referencia auploading, arriba
    • duplicate – un archivo duplicado que detectamos a partir del nombre y el tamaño del archivo con una cuenta particular
    • pending – estado que es prácticamente el mismo que 'paused' (en pausa), pero cuyo nombre es diferente para denotar que se está produciendo un proceso de moderación de ordenación
    • processing – el vídeo está sometiéndose a un procedimiento
  • updatedAfter – Encuentra el contenido que fue cargado a partir de alguna fecha. Especifica la fecha en segundos desde epoch (00:00:00 1/1/1970 GMT)
  • orderBy – Se pueden especificar dos opciones de ordenación: uploadedat o updatedat, que corresponden al momento en que se cargó el vídeo y se actualizó por última vez, respectivamente. El orden viene especificado por asc o desc. Como ejemplo, si se desea ordenar los resultados en orden descendiente por hora de carga: orderBy=uploadedAt,desc.
Note: Si se han especificado varios parámetros de búsqueda, una asociación válida debería satisfacer todos los parámetros.

Resultado de la consulta

El resultado de una consulta es un documento XML que sirve como cuerpo de respuesta. La etiqueta raíz es <list> y todos los elementos de contenido asociados están incluidos como etiquetas <item> en esa lista. A continuación se muestra un resultado de ejemplo:

Campos posibles de datos de resultados de consulta:

  • embedCode: Código embebido del contenido dado
  • title: Título del contenido, si se aplica
  • description: Descripción del contenido, si se aplica
  • status: Estado del contenido
  • hostedAt: La URL de la página principal en la que está embebido el vídeo o el canal, si se aplica
  • remoteAssetURL: La URL subyacente del vídeo remoto, si se aplica
  • error: Error de procesamiento.
  • content_type: Uno de entre Video, VideoAd, Channel, Alias, AliasAd, MultiChannel, Autosynd
  • uploadedAt: Hora de la carga, en segundos desde epoch (00:00:00 1/1/1970 GMT)
  • length: Duración del vídeo, en milisegundos.
  • size: Tamaño original del vídeo en bytes
  • updatedAt: Hora de la última carga, en segundos desde epoch (00:00:00 1/1/1970 GMT)
  • flightStartTime: La hora de inicio de un vídeo proviene del grupo de sindicación al que esté asignado, a menos que reemplace este con la configuración en la Interfaz de usuario de Backlot. Si lo reemplaza, la hora de inicio se basa en la que establezca en el vídeo (cuyo valor por defecto es la hora de carga de la película).
  • flightEndTime: El vídeo no puede comenzar a partir de esta hora, en segundos desde epoch (00:00:00 1/1/1970 GMT).
  • width: Anchura del vídeo original en píxeles
  • height: Altura del vídeo original en píxeles
  • labels: Las etiquetas asociadas con el contenido. Tenga en cuenta que esta sección solo estará incluida si hay una etiqueta que forma parte de los criterios de búsqueda o se ha especificado el parámetro "fields=labels".
  • metadata: Todas las parejas de valores/nombres asociados con el contenido. Tenga en cuenta que esta sección solo se incluirá si el campo metadatos forma parte de los criterios de búsqueda o se ha especificado el parámetro "fields=metadata".
  • ratings: las valoraciones asociadas con este elemento de contenido. Devuelve un conjunto de 11 números enteros en el que los números enteros indican el número de veces que se ha otorgado una valoración concreta a este elemento. Por ejemplo, [0, 16, 0, 0, 0, 0, 0, 0, 25, 0, 0] indica que el elemento posee 16 votos con la puntuación de "1" y 25 votos con "8".
  • thumbnail: Información de la vista previa predeterminada incluyendo altura, anchura y URL
  • stat: Si se solicita, devuelve los bloques de duración concreta que contienen información estadística que incluye visualizaciones, reproducciones, rebobinados, tiempo de reproducción y visionado
Note: Los estados internos expuestos mediante la API de consulta pueden ser ligeramente diferentes a los estados presentes en la interfaz de usuario de Backlot.

Ejemplo de resultado de la consulta

<?xml version="1.0" encoding="UTF-8"?>
<list totalResults="277" nextPageID="10" size="2" statistics-as-of="1247507998"
 statistics-as-of_text="Mon Jul 13 17:59:58 UTC 2009" limit="2" pageID="9">
<item>
  <embedCode>RyY2IxOtfOye1qEPARlzC5S9oPt0tFeH</embedCode>
  <title>MOV00821.MPG</title>
  <description/>
  <status>pending</status>
  <content_type>Video</content_type>
  <uploadedAt>1211529928</uploadedAt>
  <length>12960</length>
  <size>4708348</size>
  <updatedAt>1211568871</updatedAt>
  <flightStartTime>1211529928</flightStartTime>
  <width>640</width>
  <height>480</height>
  <labels>
    <label>/any/another</label>
    <label>/any/some</label>
    <label>/bysmthng/qqq</label>
    <label>/byuser/u1</label>
  </labels>
  <metadata>
    <metadataItem name="director" value="Francis Ford Coppola"/>
    <metadataItem name="actor" value="Marlon Brando"/>
  </metadata>
  <thumbnail height="79" width="106">
    http://ak.c.ooyala.com/RyY2IxOtfOye1qEPARlzC5S9oPt0tFeH/Ut_HKthATH4eww8X5iMDoxOmEzOxWwy3
  </thumbnail>
  <stat>
    <lifetime>
      <displays total="0"/>
      <plays total="0"/>
      <rewinds total="0"/>
      <playtime ms="0"/>
      <watched _25="0" _50="0" _75="0" _100="0"/>
    </lifetime>
  </stat>
</item>
</list>