API de CMS: Búsqueda de vídeos v2

Este tema explica la sintaxis para usar la versión 2 de la búsqueda de videos, compatible con la API de CMS.

Introducción

Versión 2 de la búsqueda de videos utilizada por el CMS API simplifica la sintaxis y facilita su uso.

Elegir qué sintaxis usar es una simple cuestión de elegir el parámetro de URL apropiado:

  • Para utilizar la nueva búsqueda v2:
        .../videos?query={search_string}
  • Para utilizar la búsqueda original:
        .../videos?q={search_string}

Conceptos básicos

El elemento básico de una cadena de búsqueda es un término de búsqueda , que puede ir precedido de un nombre de campo. Si se incluye el nombre del campo, solo se buscará en ese campo de metadatos. De lo contrario, se buscarán varios campos (enumerados a continuación).

Por ejemplo:

Búsqueda básica
Cadena de búsqueda Lo que se devolverá
bird Videos que esa la palabra "bird " en los campos enumerados a continuación
name:bird Videos que tienen la palabra "bird " en el name (título) será devuelto.

Cuando no proporciona un nombre de campo para buscar, la solicitud buscará ese valor en los siguientes campos:

  • id
  • name
  • description
  • long_description
  • text(no es un campo de metadatos real, sino un pseudo-campo que puede usar para buscar el name , description , y long_description - p.ej text:bird)
  • tags
  • reference_id
  • custom_fields(busca todos los campos personalizados)
  • custom_field_name(busca un campo personalizado con nombre específico)

Los campos admitidos para buscar son:

Campos de búsqueda admitidos
Campo Valores legales
name cadenas o cadenas entre comillas
texto cadenas o cadenas entrecomilladas (busca el name , description , y long_description)
tags cadenas o cadenas entre comillas (varias etiquetas deben estar delimitadas por comas)
custom_fields cadenas o cadenas entre comillas (busca en todos los campos personalizados; también puede usar un campo personalizado específico interno nombre)
reference_id cadena o cadena entre comillas
state ACTIVE, INACTIVE , PENDING , DELETED (solo se devolverán los videos eliminados en los últimos 10 días)
updated_at fecha y hora o rango (detalles abajo)
created_at fecha y hora o rango (detalles abajo)
schedule.starts_at fecha y hora o rango (detalles abajo)
schedule.ends_at fecha y hora o rango (detalles abajo)
published_at fecha y hora o rango (detalles abajo)
complete true o false

En los dos ejemplos que se muestran arriba, los videos que no tienen la palabra "bird " en cualquier campo relevante aún podría devolverse. La siguiente sección explica cómo limitar los resultados de la búsqueda a solo videos que tienen los términos especificados.

Palabras ignoradas

Algunas palabras se ignoran en las cadenas de búsqueda porque son tan comunes que es probable que devuelvan muchos resultados que no están relacionados con lo que realmente está buscando. A continuación se muestra una lista de palabras que se ignoran en la búsqueda:

"a", "una", "y", "son", "como", "en", "ser", "pero", "por", "para", "si", "en", "en "," es "," eso "," no "," no "," de "," en "," o "," tal "," ese "," el "," su "," entonces ", "allí", "estos", "ellos", "esto", "a", "estaba", "será", "con"

Además, los caracteres no alfanuméricos como guiones, guiones bajos, saltos de línea, "$", "& ", "*", etc. se tratan como delimitadores de palabras. Por ejemplo, una cadena de búsqueda como small-town será tratado como small town.

¿Qué es la derivación?

Los campos de vídeo que admiten la derivación devuelven palabras que tienen la raíz de la palabra de búsqueda en común. Además, el stemming solo permite introducir palabras enteras, no palabras parciales:

  • Ejemplo 1: Al buscar en, running se devolverán resultados que contienen: running, run, runs
  • Ejemplo 2: La búsqueda en vid no devolverá resultados que contengan: video

Busque con trabajos derivados en los siguientes campos:

  • custom_fields
  • description
  • name
  • long_description
  • tags
  • labels
  • variants

Hay algunos modificadores que le ayudan a limitar los resultados de la búsqueda exactamente a los videos que desea.

Modificadores de búsqueda
Modificador Descripción Ejemplos
+ El prefijo de un término de búsqueda con el signo más (+) significa que los videos devueltos deber tener el término especificado
  • +bird(devoluciones solo vídeos con "bird " en los campos enumerados anteriormente)
  • +tags:bird(devoluciones solo vídeos con "bird " en el tags)
- o NOT Prefijar un término de búsqueda con el signo menos (-) o NOT significa que los videos devueltos no debe tener el término especificado
  • -birds o NOT birds (devuelve solo videos que no no tener "bird " en los campos enumerados anteriormente)
  • -name:birds o NOT name:birds (devuelve solo videos que no no tener "bird " en el name)
(term) AND (term)
o
(term) OR (term)
La lógica AND y OR Los operadores le permiten combinar varios términos de búsqueda para consultas complejas.
  • (+name:heron) AND (+tags:bird)(devolvería videos que tienen ambos "heron " en el name y "bird " en el tags)
  • (+name:heron) OR (+tags:bird)(devolvería videos que tienen cualquiera "heron " en el name y "bird " en el tags)
  • ((+name:heron) AND (+tags:bird)) AND (NOT tags:internal)(devolvería videos que tienen ambos "heron " en el name y "bird " en el tags , pero no la etiqueta "internal")

Búsqueda de frases

Puede buscar una frase (en lugar de una sola palabra) colocándola entre comillas:

  • "blue heron"
  • name:"blue heron"

Fecha / Horas

Puede buscar en un intervalo de fecha y hora mediante:

[{start} TO {end}]

Para buscar en una sola fecha / hora, configure el start y end al mismo valor:

[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z]

Los valores de fecha y hora se especifican utilizando el formato ISO 8601:

Formatos de fecha / hora
Fecha y hora Formato Ejemplo
Fecha y hora yyyy-MM-ddThh:mm:ss.sssZ 2019-09-30T14:24:33.512Z
Comodín (se puede utilizar para la fecha / hora de inicio o finalización) *
  • 2019-09-30T14:24:33.512Z TO *
  • * TO 2019-09-30T14:24:33.512-4:00Z

A continuación se muestran algunos ejemplos de cadenas de búsqueda de fecha / hora.

Búsquedas de datos / tiempo de muestra
Cadena de búsqueda Descripción
+updated_at:[2019-09-30T00:00:00.000Z TO 2019-10-07T00:00:00.000Z] Vídeos actualizados entre el 30 de septiembre de 2019 y el 7 de octubre de 2019
+created_at:[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z] Vídeos añadidos el 30 Sep 2019
+created_at:[2019-09-30T14:00:00.000Z TO 2019-09-30T16:30:00.000Z] Videos agregados entre las 2:00 p. m. y las 4:30 p. m. (UTC) el 30 de septiembre de 2019
+created_at:[* TO 2019-09-30T00:00:00.000Z] Vídeos añadidos antes del 30 de septiembre de 2019

Problemas conocidos

  • Resultados duplicados: en ciertos casos, algunos elementos de los resultados de la búsqueda pueden aparecer más de una vez.

    Solución alterna: para evitar resultados de búsqueda duplicados, utilice siempre un sort parámetro en sus solicitudes de búsqueda.