Trabajar con etiquetas

Introducción

Las etiquetas son similares a las etiquetas. Puede agregarlos a videos y luego usarlos para buscar un grupo de videos o, pero tienen algunas ventajas distintas:

• Las etiquetas se crean a nivel de cuenta y se aplican a los videos.

  Esto es especialmente importante si su propósito es organizar su biblioteca de videos. Por ejemplo, si intenta organizar sus videos usando etiquetas, puede crear etiquetas como birds , fish , y insects. Entonces es fácil buscar y encontrar todos sus videos de aves y crear una lista de reproducción inteligente para ellos. Pero si un usuario agrega un nuevo video accidentalmente escribe bird en lugar de birds , ahora tiene una nueva etiqueta y el video no pertenece a su birds recopilación.

  Si crea una etiqueta llamada birds en cambio, solo esa etiqueta se puede agregar a un video. No puede agregar accidentalmente la etiqueta inexistente birds en lugar de.

• Las etiquetas se crean como ruta jerárquica, como /nature/birds/shore_birds.

  Esto significa que puede buscar (o crear una lista de reproducción basada en) una ruta parcial o completa:

  • q=labels:/nature- devuelve todos los videos que tienen la etiqueta nature
  • q=labels:/nature/birds- devuelve el birds subgrupo de la nature videos
  • q=labels:/nature/birds/shore_birds- devuelve el shore_birds subgrupo de la /nature/birds videos

Crear y administrar etiquetas

Las etiquetas para su cuenta se pueden crear y administrar utilizando el CMS API /v1/accounts/{account_id}/labels puntos finales.

Tenga en cuenta que todos los puntos finales de API que se muestran a continuación se agregarían a la URL base de CMS:

https://cms.api.brightcove.com

Creando una etiqueta

Se pueden crear nuevas etiquetas enviando la ruta completa en un POST pedido:

Punto final de solicitud de muestra

/v1/accounts/1234567890/labels

Cuerpo de solicitud de muestra

{
  "path": "/nature/birds/shore_birds/"
}

Tenga en cuenta que todas Se crearán etiquetas en la ruta que aún no existen. Si desea agregar otro grupo de forest_birds , enviarías:

{
  "path": "/nature/birds/forest_birds/"
}

Esta vez, solo el forest_birds subetiqueta, se creará, ya que nature y birds ya existe.

Del mismo modo, si desea agregar un nuevo subgrupo sandpipers a shore_birds , enviarías:

{
  "path": "/nature/birds/shore_birds/sandpipers"
}

Respuesta de muestra

{
  "path": "/nature/birds/shore_birds/sandpipers/"
}

Obtener etiquetas

Puede obtener todas las etiquetas de una cuenta enviando un GET pedido:

Punto final de solicitud de muestra

/v1/accounts/1234567890/labels

Respuesta de muestra

{
  "account_id": "57838016001",
  "labels": [
    "/nature/birds/",
    "/nature/birds/shore_birds/",
    "/nature/birds/forest_birds/",
    "/nature/mammals/seamammals/"
  ],
  "version": 4
}

Actualizar una etiqueta

Para actualizar una etiqueta, envía un PATCH solicitud de:

/v1/accounts/{account_id}/labels/by_path/{path}

Punto final de solicitud de muestra

/v1/accounts/1234567890/labels/by_path//nature/birds/shore_birds

Cuerpo de solicitud de muestra

{
  "new_label": "coastal_birds"
}

Tenga en cuenta que el new_label El valor reemplazará el último elemento de la {path} incluido en la solicitud. Entonces, si en cambio quisieras reemplazar /birds con /avian , la solicitud y el cuerpo se verían así:

Punto final

/v1/accounts/1234567890/labels/by_path//nature/birds/

Cuerpo de la solicitud

{
  "new_label": "avian"
}

Después de esta solicitud, el coastal_birds camino se convertiría /nature/avian/coastal_birds. La ruta cambiaría para cualquier subetiqueta adicional en la jerarquía, por lo que /nature/birds/forest_birds se convertiría /nature/avian/forest_birds

La respuesta incluirá la cantidad de etiquetas que se actualizaron.

Respuesta de muestra

{
  "path": "/nature/avian",
  "labels_updated": "2"
}

Eliminar una etiqueta

Eliminar una etiqueta usa un DELETE solicitud enviada al mismo punto final que la solicitud de actualización. Solo se eliminará la ruta que termine con esa etiqueta secundaria (y las rutas que tengan etiquetas secundarias adicionales), mientras que las etiquetas de nivel superior se conservarán.

Por ejemplo, supongamos que tiene estas tres rutas de etiquetas:

      /nature/wildlife/avian/coastal_birds
      /nature/wildlife/avian/coastal_birds/sandpipers
      /nature/wildlife/avian/forest_birds
    

Enviando un DELETE solicitud de /v1/accounts/1234567890/labels/by_path//nature/wildlife/avian/coastal_birds eliminaría las primeras rutas anteriores, pero no afectaría a la tercera.

Agregar y actualizar etiquetas a videos

Agregue etiquetas a los videos como una variedad de rutas de etiquetas completas:

[
      "/nature/wildlife/avian/coastal_birds",
      "/nature/wildlife/avian/coastal_birds/sandpipers"
]

La matriz de etiquetas se puede incluir en una crear solicitud de video (POST) o un solicitud de actualización de video (PATCH).

Para actualizar las etiquetas de video, envíe la matriz de videos completa y actualizada en un solicitud de actualización de video (PATCH). Entonces, por ejemplo, para agregar el /nature/wildlife/avian/forest_birds , enviarías la matriz:

[
      "/nature/wildlife/avian/coastal_birds",
      "/nature/wildlife/avian/coastal_birds/sandpipers",
      "/nature/wildlife/avian/forest_birds"
]

Búsqueda de videos por etiquetas

Puede buscar videos por labels al igual que puede hacer con otros campos que son compatibles con la búsqueda. Como se mencionó en la introducción, agregar subetiquetas a la ruta de búsqueda filtra los resultados de la búsqueda:

Limitaciones

• Se puede agregar un máximo de 10,000 etiquetas a una cuenta
• Las etiquetas solo se pueden administrar mediante la API. Actualmente no hay ninguna opción en la interfaz de usuario
• Actualmente, la búsqueda por etiquetas es compatible con solo sintaxis de búsqueda v1
• Las etiquetas son no incluido en los metadatos del video que se comparte con un afiliado mediante Uso compartido de medios.