Introducción
La opción de compartir contenido multimedia de Video Cloud permite a los editores compartir vídeos con otros editores, lo que permite gestionar vídeos más fácilmente en varias cuentas. Por ejemplo, los editores pueden mantener una cuenta maestra de contenido de vídeo y, a continuación, compartir vídeos con otras divisiones o subsidiarias de la organización.
Tenga en cuenta que todas las operaciones de uso compartido de medios también se pueden realizar en Studio. Consulte Administración de la configuración de uso compartido de medios.
Los medios compartidos y la facturación
Para obtener información sobre cómo funciona la facturación para medios compartidos, consulte Uso compartido de medios mediante el módulo multimedia.
Terminología
En el uso compartido de medios, existe una relación entre una cuenta maestra (que comparte vídeos) y una o más cuentas de afiliados (que reciben vídeos compartidos) involucradas:
Cuenta | Descripción |
---|---|
Maestro | La cuenta que creó el vídeo original.
El Máster es el propietario del contenido y es responsable de configurar, administrar y proporcionar contenido a los Afiliados. |
Asociado | La cuenta que está recibiendo el video.
El Afiliado puede aceptar contenido compartido a él desde un Maestro. |
Canal | Una canalización a través del cual el contenido se comparte desde un Maestro a cualquier número de Afiliados. Cuando esté habilitado el uso compartido de contenido multimedia, se creará un default canal en su cuenta. |
Relación | Describe la interacción entre un maestro y un afiliado.
Una relación se compone de un Maestro para compartir contenido, un Canal a través del cual se comparte el contenido, un Contrato para aceptar contenido y un Afiliado para recibir contenido. |
Contrato | Describe la relación compartida entre un maestro y un afiliado.
Un contrato es creado por el Maestro, y luego debe ser aceptado para que se active el uso compartido. El Afiliado también puede especificar si los vídeos compartidos se aceptan automáticamente o deben ser aprobados uno por uno. |
URL base
En cuanto a todas las CMS API solicitudes, la URL base para las operaciones que se describen a continuación es:
https://cms.api.brightcove.com/v1
Todos los extremos que se describen a continuación se agregarán a la URL base cuando realice solicitudes.
Autenticación
La autenticación para solicitudes requiere un encabezado de autorización:
Authorization: Bearer {access_token}
El es un token de acceso temporal de OAuth2 que debe obtenerse del servicio OAuth de Brightcove.access_token
Para obtener información detallada sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la descripción general de OAuth de Brightcove.
Tenga en cuenta que todas las operaciones relacionadas con relaciones requieren nuevos permisos:
video-cloud/video/all
video-cloud/sharing-relationships/read
video-cloud/sharing-relationships/create
video-cloud/sharing-relationships/update
video-cloud/sharing-relationships/delete
Alternativamente, puede usar:
video-cloud/sharing-relationships/all
En la página Administrador de autenticación de API de Studio, se muestran dos permisos:
- Compartir lectura (equivalente a
video-cloud/sharing-relationships/read
) - Compartir lectura/escritura (equivalente a
video-cloud/sharing-relationships/all
)
Restricciones de uso compartido
De forma predeterminada, todos los vídeos se pueden compartir. Sin embargo, puede evitar el uso compartido si:
- La cuenta de afiliado no tiene un campo personalizado para el que se establece un valor en el video en la cuenta principal
- La cuenta maestra tiene habilitado el geo-filtrado, pero la cuenta de afiliado no
Coincidencia de campos personalizados
Puede exigir la coincidencia de campos personalizados para un canal, lo que significa que los recursos compartidos de vídeo fallarán si el vídeo tiene valores para campos personalizados que no están presentes en la cuenta de afiliado. Los vídeos se seguirán compartiendo correctamente si el vídeo no tiene valores para ningún campo personalizado que no coincida
De forma predeterminada, no se aplica la coincidencia de campos personalizados.
Si un recurso compartido de vídeo falla debido a campos personalizados que no coinciden, verá un error como este en la respuesta:
{
"video_id": "5691312273001",
"affiliate_id": "47509719001",
"affiliate_video_id": null,
"status": "PROCESSING",
"error_message": [{"error_code":"MISSING_CUSTOM_FIELDS","error_message":"Affiliate account is missing custom fields: [subject]"}],
"shared_at": "2018-01-03T16:29:19.080Z",
"updated_at": "2018-01-03T16:29:19.080Z"
}
Coincidencia de geo-filtrado
Si la coincidencia de geofiltrado está habilitada para un canal, los vídeos no se pueden compartir si la cuenta maestra tiene habilitado el filtrado geográfico y la cuenta de afiliado no.
De forma predeterminada, se aplica la coincidencia de filtrado geográfico.
El error se verá así:
{
"video_id": "5691312273001",
"affiliate_id": "47509719001",
"affiliate_video_id": null,
"status": "PROCESSING",
"error_message": [{"error_code":"CONFLICT","error_message":"Affiliate account is not configured for geo restriction."}],
"shared_at": "2018-01-03T16:29:19.080Z",
"updated_at": "2018-01-03T16:29:19.080Z"
Consulte Actualizar canal a continuación para ver cómo actualiza un canal para exigir la coincidencia de campos personalizados y/o de geofiltrado.
¿Qué se comparte?
En esta sección se explica qué se comparte y cómo se gestionan los cambios posteriores en el vídeo.
Cuando se comparte el vídeo
La mayoría de los campos de metadatos de vídeo se copian de la cuenta principal a la cuenta de afiliado cuando se comparte el vídeo. Las excepciones notables son:
id
- el vídeo tendrá su propia identificación única en la cuenta de afiliado- campos de fecha como
created_at
yupdated_at
Todos los activos de vídeo (representaciones, imágenes, text_tracks, etc.) son utilizados por las cuentas de afiliados para su reproducción.
Después de compartir el vídeo
Después de compartir el vídeo, algunos cambios en el vídeo en la cuenta maestra son heredados automáticamente por las cuentas de afiliados, y otros no lo son.
Activos de vídeo
A excepción de las imágenes, los Afiliados siempre heredan los cambios Master en los activos de vídeo. Los afiliados no pueden cambiar activos como copias, manifiestos, pistas de texto o el maestro digital.
Los cambios en las imágenes por el Maestro son heredados por el Afiliado a menos que el Afiliado haya reemplazado la (s) imagen (s). Una vez que un Afiliado cambia una imagen, esa imagen ya no se heredará del Maestro.
Metadatos de vídeo
Los metadatos de vídeo (como el nombre, la descripción y la identificación de referencia) pueden ser modificados por el Afiliado, y los cambios realizados en el video maestro no son heredados por el Afiliado.
Volver a compartir vídeos
Tenga en cuenta, sin embargo, que si el Maestro vuelve a compartir el vídeo (esto solo se puede hacer a través de la API de CMS, no en Studio), todos los activos y metadatos (aparte de los campos de datos/hora) se compartirán con los Afiliados, sobrescribiendo cualquier cambio que los Afiliados hayan realizado.
Descripción general de los pasos para compartir contenido multimedia
Configurar una relación
A continuación se muestra un resumen de las operaciones para configurar una relación (haga clic en el nombre de la operación para obtener más detalles):
Operaciones maestras | ||
---|---|---|
Operación | Método/Endpoint | Descripción |
Lista de canales | GET /accounts/ master_account_id/channels |
Obtener una lista de canales para la cuenta |
Obtener detalles del canal | GET /accounts/ master_account_id/channels/ channel_name [2-1] |
Obtener detalles de un canal |
Actualizar canal | POST /accounts/ master_account_id/channels/ channel_name |
Actualizar la configuración de canales |
Listar afiliados de canal | GET /accounts/ master_account_id/channels/default/members |
Obtener los afiliados de un canal |
Añadir afiliados | PUT /accounts/ master_account_id/channels/default/members |
Añadir afiliados a un canal |
Eliminar afiliado | DELETE /accounts/ master_account_id/channels/default/members/ affiliate_account_id |
Elimina un afiliado de un canal |
Operaciones de afiliados | ||
Operación | Método/Endpoint | Descripción |
Enumerar los contratos disponibles | GET /accounts/ affiliate_account_id/contracts |
Obtiene todos los contratos disponibles para la cuenta |
Obtener contrato para una cuenta específica | GET /accounts/ affiliate_account_id/contracts/ master_account_id |
Obtiene un contrato, si lo hay, de una cuenta específica |
Aprobar un contrato | PATCH /accounts/ affiliate_account_id/contracts/ master_account_id |
Aceptar y configurar las condiciones de aceptación del contrato |
Notas
- [ 2-1] Actualmente sólo hay un canal llamado
default
Compartir vídeos
Las operaciones de uso compartido de vídeo son realizadas por la cuenta maestra. La cuenta de afiliado puede aceptar el recurso compartido (si auto_accept
está configurado en false
) y puede actualizar los metadatos e imágenes de vídeo compartidos utilizando la operación estándar Actualizar vídeo .
Estas son las operaciones de uso compartido que se pueden realizar una vez configurada una relación (haga clic en el nombre de una operación para obtener más detalles):
Operaciones maestras | ||
---|---|---|
Operación | Método/Endpoint | Descripción |
Enumerar recursos compartidos existentes | GET /accounts/ master_account_id/videos/ video_id/shares |
Obtener una lista de las acciones existentes para un video - esto es importante debido a las consecuencias de volver a compartir un video cuando ya se ha compartido |
Compartir un vídeo | POST /accounts/ master_account_id/videos/ video_id/shares |
Comparte un video a uno o más afiliados - tenga en cuenta que si el video ya ha sido compartido, esta operación lo volverá a compartir - eso probablemente no es lo que quieres hacer |
Anular el uso compartido de un vídeo para un Afiliado | DELETE /accounts/ master_account_id/videos/ video_id/shares |
No comparte un vídeo para un Afiliado específico. Tenga en cuenta que si no se comparte y vuelve a compartir, el vídeo compartido tendrá un nuevo ID de vídeo en la cuenta de afiliado |
Operaciones de afiliados | ||
Operación | Método/Endpoint | Descripción |
Aceptar un vídeo compartido | PATCH /accounts/ affiliate_account_id/videos/ video_id |
Aceptar un vídeo compartido (si auto_accept está desactivado) |
Solicitudes de API de CMS - configuración
En esta sección se enumeran las CMS API operaciones implicadas en la configuración del uso compartido de medios.
Operaciones maestras
Lista de canal (s)
Método | GET |
---|---|
Endpoint | /accounts/ master_account_id/channels |
Cuerpo de solicitud | |
Respuesta de muestra |
|
Obtener detalles del canal
Método | GET |
---|---|
Endpoint | https://cms.api.brightcove.com/v1/accounts/ master_account_id/channels/ channel_name [5-1] |
Cuerpo de solicitud | |
Respuesta de muestra |
|
Notas
- [ 5-1] Actualmente sólo hay un canal llamado
default
Actualizar canal
Método | PATCH |
---|---|
Endpoint | /accounts/ master_account_id/channels/ channel_name [ 6-1] |
Cuerpo de solicitud |
|
Respuesta de muestra |
|
Notas
- [ 6-1] Actualmente sólo hay un canal llamado
default
Lista de afiliados para el canal
Método | GET |
---|---|
Endpoint | /accounts/ master_account_id/channels/default/members |
Cuerpo de solicitud | |
Respuesta de muestra |
|
El valor del approved
campo indica si el Afiliado ha aprobado o no el contrato.
Añadir afiliado al canal
Método | PUT |
---|---|
Endpoint | /accounts/ master_account_id/channels/default/members/ affiliate_account_id |
Cuerpo de solicitud |
|
Respuesta de muestra |
|
Eliminar afiliado del canal
Método | DELETE |
---|---|
Endpoint | /accounts/ master_account_id/channels/default/members/ affiliate_account_id |
Cuerpo de solicitud | |
Respuesta de muestra | 204 NO CONTENT ( cuerpo de respuesta vacío) |
Operaciones de afiliados
Enumerar los contratos disponibles
Método | GET |
---|---|
Endpoint | /accounts/ affiliate_account_id/contracts |
Cuerpo de solicitud | |
Respuesta de muestra |
|
Los dos campos esenciales de la respuesta son:
approved
- cuando se establece en true, el contrato es aceptado por el Afiliadoauto-accept
- cuando se establece en true, los vídeos compartidos a través de este contrato serán automáticamente aceptados por el Afiliado; de lo contrario, deberán ser aprobados uno por uno
Veremos cómo actualizar el contrato a continuación.
Obtener contrato para una cuenta específica
Método | GET |
---|---|
Endpoint | /accounts/ affiliate_account_id/contracts/ master_account_id |
Cuerpo de solicitud | |
Respuesta de muestra |
|
Aprobar contrato
Método | PATCH |
---|---|
Endpoint | /accounts/ affiliate_account_id/contracts/ master_account_id |
Cuerpo de solicitud |
|
Respuesta de muestra |
|
Si solo incluye "approved":true
, cada vídeo tendrá que ser aprobado individualmente.
Solicitudes de API de CMS - compartir
En esta sección se detallan las CMS API solicitudes utilizadas para compartir vídeos. Las operaciones de uso compartido de medios las realiza la cuenta maestra. La cuenta de Afiliado puede aceptar acciones si auto_accept
está desactivada.
Operaciones maestras
Enumerar recursos compartidos existentes
Para saber si un vídeo ya se ha compartido con otras cuentas, puede utilizar la solicitud que aparece a continuación.
Método | GET |
---|---|
Endpoint | /accounts/ master_account_id/videos/ video_id/shares |
Cuerpo de solicitud | |
Respuesta de muestra |
|
Compartir (o volver a compartir) un vídeo
La solicitud que se describe a continuación compartirá un vídeo en una o más cuentas de afiliados.
Método | POST |
---|---|
Endpoint | /accounts/ master_account_id/videos/ video_id/shares |
Cuerpo de solicitud |
|
Respuesta de muestra |
Respuesta al éxito
Respuesta al fallo
|
Compartir creará un nuevo vídeo en la cuenta del Afiliado. El recurso compartido state
de vídeo será PROCESSING
hasta que se complete el recurso compartido y el vídeo se cree en la cuenta de afiliado. Es posible que el Afiliado tenga que aceptar el video (si auto_accept
está establecido false
en el contrato por el Afiliado, consulte la sección anterior sobre la configuración de compartir).
Anular de compartir un vídeo para un Afiliado
Método | DELETE |
---|---|
Endpoint | /accounts/ master_account_id/videos/ video_id/shares/ affiliate_account_id |
Cuerpo de solicitud | |
Respuesta de muestra | 202 ACCEPTED ( cuerpo de respuesta vacío) - la respuesta indica que la solicitud ha sido aceptada para su procesamiento, pero la operación puede no completarse durante un par de minutos |
Operaciones de afiliados
Aceptar vídeo compartido
Para aceptar un vídeo compartido, el Afiliado actualiza el vídeo compartido, configurando su state
como ACTIVE
. (Establecer state
a INACTIVE
rechaza el recurso compartido.)
Método | PATCH |
---|---|
Endpoint | /accounts/ affiliate_account_id/videos/ affiliate_video_id |
Cuerpo de solicitud |
|
Respuesta de muestra |
|
Establezca state
a INACTIVE
para rechazar el recurso compartido.
Ten en cuenta que no hay ninguna notificación especial que indique que se ha compartido un vídeo en tu cuenta. Sin embargo, si busca vídeos para state:pending
, que encontrará las acciones no aceptadas. Alternativamente, puede utilizar la lista Recursos compartidos pendientes del módulo Studio Media para ver y aceptar/rechazar recursos compartidos pendientes:

Errores
Los errores de uso compartido de medios no se devuelven como una respuesta de error independiente a la solicitud de API, sino más bien en un campo de la respuesta normal:error_message
[
{
"video_id" : "1239817239128",
"affiliate_id" : "32871239",
"affiliate_video_id" : "30308254055202",
"status" : "COMPLETE",
"shared_at" : "2017-12-11T17:57:45.530Z",
"updated_at" : "2017-12-11T18:03:32.789Z",
"error_message" : "[{"error_code":"MISSING_CUSTOM_FIELDS","error_message":"Affiliate account is missing custom fields: [whisky]"}]"
}
]
Consulte la Referencia CMS API de errores para obtener más detalles.
Limitaciones
Actualmente, el uso compartido de medios tiene las siguientes limitaciones:
- DRM: actualmente no CMS API se admite el uso compartido de medios a través de las cuentas habilitadas para DRM. Se admite el uso compartido de vídeos desde una cuenta que no está habilitada para DRM con una cuenta habilitada para DRM, pero los vídeos compartidos no se empaquetarán para DRM.
-
Si el canal definido por la cuenta maestra se ha establecido
enforce_custom_fields
entrue
, y luego comparte un vídeo que tiene un campo personalizado con un valor que no está permitido por la cuenta de afiliado, ese intento de compartir fallará. El estado del recurso compartido se actualizará con un mensaje de error similar a este:[{"error_code": "ILLEGAL_CUSTOM_FIELD_VALUE", "error_message": "Illegal value for custom fields: [topic]"}]
Si el canal definido por la cuenta maestra se ha establecido
enforce_custom_fields
enfalse
, y luego comparte un vídeo que tiene un campo personalizado con un valor que no está permitido por la cuenta de afiliado, entonces el intento de compartir funcionará, pero el con el valor incorrecto no se incluirá en la copia del afiliado del video. -
Al reproducir un vídeo compartido con SSAI, el reemplazo de macros SSAI utilizará los metadatos del vídeo principal en lugar del vídeo secundario. SSAI también omitirá la búsqueda de anuncios si el vídeo principal está marcado como, incluso si el vídeo secundario está etiquetado como.
Advertising='Free'
Ad Supported