Introducción
La versión 2 de la búsqueda de vídeo utilizada por el CMS API simplifica la sintaxis y hace que sea más fácil de usar.
Elegir qué sintaxis usar es una cuestión simple de elegir el parámetro URL apropiado:
- Para usar la nueva búsqueda v2:
.../videos?query={search_string}
- Para utilizar la búsqueda original:
.../videos?q={search_string}
Fundamentos
El elemento básico de una cadena de búsqueda es un término de búsqueda, que puede estar precedido por un nombre de campo. Si se incluye el nombre del campo, sólo se buscará en ese campo de metadatos. De lo contrario, se buscarán varios campos (enumerados a continuación).
Por ejemplo:
Cadena de búsqueda | Lo que se devolverá |
---|---|
bird |
Vídeos que la palabra "bird " en los campos enumerados a continuación |
name:bird |
Los vídeos que tengan la palabra "bird " en el name (título) se devolverán. |
Cuando no proporciona ningún 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 reales, sino un pseudo-campo que puede usar para buscar elname
,description
, ylong_description
- por ejemplotext:bird
)tags
reference_id
custom_fields
( busca todos los campos personalizados)custom_field_name
( busca un campo personalizado específico con nombre)
Los campos admitidos para buscar son:
Campo | Valores legales |
---|---|
name |
cadenas de texto suelto o entrecomillado |
text | cadenas o cadenas entre comillas (busca en,, y)name description 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 nombre interno de campo personalizado específico) |
reference_id |
cadena o cadena entre comillas |
state |
ACTIVE , INACTIVE , PENDING , DELETED (solo se devolverán los vídeos eliminados en los últimos 10 días) |
updated_at |
fecha y hora o rango (detalles a continuación) |
created_at |
fecha y hora o rango (detalles a continuación) |
schedule.starts_at |
fecha y hora o rango (detalles a continuación) |
schedule.ends_at |
fecha y hora o rango (detalles a continuación) |
published_at |
fecha y hora o rango (detalles a continuación) |
complete |
true o false |
En ambos ejemplos anteriores, es posible que se devuelvan vídeos que no tengan la palabrabird
" " en ningún campo pertinente. En la siguiente sección se explica cómo limitar los resultados de búsqueda sólo a vídeos que tengan los términos especificados.
Búsqueda avanzada
Hay algunos modificadores que ayudan a limitar los resultados de búsqueda a exactamente los vídeos que desea.
Modificador | Descripción | Ejemplos |
---|---|---|
+ |
El prefijo de un término de búsqueda con el signo más (+) significa que los vídeos devueltos deben tener el término especificado |
|
- o NOT |
Prefijar un término de búsqueda con el signo menos (-) o NOT significa que los vídeos devueltos no deben tener el término especificado |
|
(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. |
|
Búsqueda de frases
Puede buscar una frase (en lugar de una sola palabra) colocando entre comillas:
"blue heron"
name:"blue heron"
Fecha/Horario
Puede buscar en un intervalo de fecha y hora mediante:
[{start} TO {end}]
Para buscar en una única fecha/hora, establezca el start
y end
en el mismo valor:
[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z]
Los valores de fecha-hora se especifican utilizando el formato ISO 8601:
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 final) | * |
|
A continuación se muestran algunas cadenas de búsqueda de fecha/hora 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 Sep 2019 y el 7 Oct 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] |
Vídeos añadidos entre las 2:00 PM y las 4:30 PM (UTC) del 30 sep 2019 |
+created_at:[* TO 2019-09-30T00:00:00.000Z] |
Vídeos añadidos antes del 30 Sep 2019 |