soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Trabajando con etiquetas

    En este tema, aprenderá cómo crear, administrar y usar etiquetas usando el CMS API.

    Introducción

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

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

      Esto es importante especialmente si su propósito es organizar su biblioteca de videos. Por ejemplo, si está tratando de 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 que agrega un nuevo video accidentalmente escribe bird en lugar de birds, ahora tiene una nueva etiqueta y el video no pertenece a su birds colecció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.

    • 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 vídeos
      • q=labels:/nature/birds/shore_birds - devuelve el shore_birds subgrupo de la /nature/birds vídeos

    Crear y gestionar 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 la API que se muestran a continuación se agregarán a la URL base del CMS:

    https://cms.api.brightcove.com

    Crear una etiqueta

    Se pueden crear nuevas etiquetas enviando la ruta completa en un POST petición:

    Punto final de solicitud de muestra

    /v1/accounts/1234567890/labels

    Ejemplo de solicitud de cuerpo

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

    Tenga en cuenta que todos 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 se creará una sub-etiqueta, 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"
    }

    Muestra de respuesta

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

    Obteniendo etiquetas

    Puede obtener todas las etiquetas de una cuenta enviando un GET petición:

    Punto final de solicitud de muestra

    /v1/accounts/1234567890/labels

    Muestra de respuesta

    {
      "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

    Ejemplo de solicitud de cuerpo

    {
      "new_label": "coastal_birds"
    }

    Tenga en cuenta que new_label el valor reemplazará el último elemento en el {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/
    Solicitar cuerpo
    {
      "new_label": "avian"
    }

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

    La respuesta incluirá el número de etiquetas que se actualizaron.

    Muestra de respuesta
    {
      "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 finaliza con esa sub-etiqueta (y las rutas que tienen sub-etiquetas adicionales), mientras que se retienen las etiquetas de nivel superior.

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

    
          /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 matriz de rutas de etiquetas completas:

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

    La matriz de etiquetas se puede incluir en un solicitud de crear 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

    Puedes buscar videos por labels tal como puede, otros campos que son compatibles con la búsqueda. Como se mencionó en la introducción, agregar sub-etiquetas a la ruta de búsqueda filtra los resultados de búsqueda:

    Buscar por ejemplos de etiquetas
    Búsqueda de muestra Lo que devuelve
    q=labels:/nature Todos los videos con rutas de etiquetas que comienzan con /nature
    q=labels:/nature/wildlife Todos los videos con rutas de etiquetas que comienzan con /nature/wildlife
    q=labels:/nature/wildlife/avian Todos los videos con rutas de etiquetas que comienzan con /nature/wildlife/avian

    Limitaciones


    Página actualizada por última vez el 22 jul 2020