Einleitung
Version 2 der von der CMS API vereinfacht die Syntax und vereinfacht die Verwendung.
Die Auswahl der zu verwendenden Syntax ist eine einfache Frage der Auswahl des entsprechenden URL-Parameters:
- So verwenden Sie die neue v2-Suche:
.../videos?query={search_string}
- So verwenden Sie die ursprüngliche Suche:
.../videos?q={search_string}
Grundlagen
Das Grundelement einer Suchzeichenfolge ist ein Suchbegriff, dem ein Feldname vorangestellt werden kann. Wenn der Feldname enthalten ist, wird nur dieses Metadatenfeld durchsucht. Andernfalls werden mehrere Felder (unten aufgeführt) durchsucht.
Zum Beispiel:
Suchbegriff | Was wird zurückgegeben |
---|---|
bird |
Videos, die in den unten aufgeführten Feldern das Wortbird " " enthalten |
name:bird |
Videos, die das Wort "bird " im name (Titel) enthalten, werden zurückgegeben. |
Wenn Sie keinen zu suchenden Feldnamen angeben, sucht die Anfrage nach diesem Wert in den folgenden Feldern:
id
name
description
long_description
text
(kein echtes Metadatenfeld, sondern ein Pseudofeld, mit dem Sie nachname
description
, und suchen könnenlong_description
- z. B.text:bird
)tags
reference_id
custom_fields
(durchsucht alle benutzerdefinierten Felder)custom_field_name
(sucht ein bestimmtes benanntes benutzerdefiniertes Feld)
Die unterstützten Felder für die Suche sind:
Feld | Gesetzliche Werte |
---|---|
name |
Zeichenketten oder Zeichenketten in Anführungszeichen |
Text | Zeichenketten oder Zeichenketten in Anführungszeichen (sucht nach name description , und long_description ) |
tags |
Zeichenketten oder Zeichenketten in Anführungszeichen (mehrere Tags sollten durch Kommas getrennt sein) |
custom_fields |
Zeichenketten oder Zeichenketten in Anführungszeichen (durchsucht alle benutzerdefinierten Felder — Sie können auch einen bestimmten internen Namen für benutzerdefinierte Felder verwenden) |
reference_id |
Zeichenfolge oder Zeichenfolge in Anführungszeichen |
state |
ACTIVE , INACTIVE PENDING , DELETED (Es werden nur Videos zurückgegeben, die innerhalb der letzten 10 Tage gelöscht wurden) |
updated_at |
Datum, Uhrzeit oder Bereich (Details unten) |
created_at |
Datum, Uhrzeit oder Bereich (Details unten) |
schedule.starts_at |
Datum, Uhrzeit oder Bereich (Details unten) |
schedule.ends_at |
Datum, Uhrzeit oder Bereich (Details unten) |
published_at |
Datum, Uhrzeit oder Bereich (Details unten) |
complete |
true oder false |
In den beiden oben gezeigten Beispielen werden möglicherweise trotzdem Videos zurückgegeben, die in keinem relevanten Feld das Wortbird
" " enthalten. Im nächsten Abschnitt wird erläutert, wie Sie Suchergebnisse auf Videos mit den angegebenen Begriffen beschränken.
Ignorierte Wörter
Bestimmte Wörter werden in Suchzeichenfolgen ignoriert, da sie so häufig sind, dass sie wahrscheinlich viele Ergebnisse liefern, die nichts mit dem zu tun haben, wonach Sie tatsächlich suchen. Nachfolgend finden Sie eine Liste von Wörtern, die bei der Suche ignoriert werden:
„a“, „an“, „und“, „sind“, „als“, „bei“, „sein“, „aber“, „von“, „für“, „wenn“, „in“, „in“, „in“, „ist“, „es“, „nein“, „nicht“, „von“, „am“, „oder“, „solche“, „dass“, „der“, „ihr“, „dann“, „dort“, „diese“, „sie“, „dies“, „zu“, „war“, „werden“, „mit“
Darüber hinaus werden nicht-alphanumerische Zeichen wie Bindestriche, Unterstriche, Zeilenumbrüche, "$", "&", "*" usw. als Worttrennzeichen behandelt. Beispielsweise wird eine Suchzeichenfolge wie small-town
wird behandelt als small town
.
Was ist Stemming?
Videofelder, die das Stemmen unterstützen, geben Wörter zurück, die den Stamm des Suchwortes gemeinsam haben. Darüber hinaus unterstützt Stemming nur die Eingabe ganzer Wörter, nicht teilweise Wörter:
- Beispiel 1: Bei der Suche nach
running
werden Ergebnisse zurückgegeben, die Folgendes enthalten:running
,run
,runs
- Beispiel 2: Bei der Suche nach
vid
werden keine Ergebnisse zurückgegeben, die Folgendes enthaltenvideo
Die Suche mit Stemming funktioniert in den folgenden Bereichen:
custom_fields
description
name
long_description
tags
labels
variants
Erweiterte Suche
Es gibt einige Modifikatoren, mit denen Sie die Suchergebnisse auf genau die gewünschten Videos beschränken können.
Modifikator | Beschreibung | Beispiele |
---|---|---|
+ |
Das Voranstellen eines Suchbegriffs mit dem Pluszeichen (+) bedeutet, dass die zurückgegebenen Videos muss den angegebenen Begriff haben |
|
- oder NOT |
Voranstellen eines Suchbegriffs mit dem Minuszeichen (-) oder NOT bedeutet, dass die zurückgegebenen Videos darf nicht den angegebenen Begriff haben |
|
(term) AND (term) oder (term) OR (term) |
Die logische AND und OR Operatoren ermöglichen es Ihnen, mehrere Suchbegriffe für komplexe Abfragen zu kombinieren |
|
Phrasensuche
Sie können nach einer Phrase (und nicht nach einem einzelnen Wort) suchen, indem Sie sie in Anführungszeichen setzen:
"blue heron"
name:"blue heron"
Datum/Uhrzeit
Sie können nach einem Datum-Uhrzeit-Intervall suchen, indem Sie Folgendes verwenden:
[{start} TO {end}]
Um nach einem einzelnen Datum/einer Uhrzeit zu suchen, stellen Sie die start
und end
auf den gleichen Wert:
[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z]
Datum-Uhrzeit-Werte werden im ISO 8601-Format angegeben:
Terminzeit | Formatieren | Beispiel |
---|---|---|
Terminzeit | yyyy-MM-ddThh:mm:ss.sssZ |
2019-09-30T14:24:33.512Z |
Platzhalter (kann für Start- oder Enddatum/-uhrzeit verwendet werden) | * |
|
Unten sind einige Beispiel-Suchzeichenfolgen für Datum/Uhrzeit.
Suchbegriff | Beschreibung |
---|---|
+updated_at:[2019-09-30T00:00:00.000Z TO 2019-10-07T00:00:00.000Z] |
Videos aktualisiert zwischen 30. September 2019 und 7. Oktober 2019 |
+created_at:[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z] |
Videos hinzugefügt am 30. September 2019 |
+created_at:[2019-09-30T14:00:00.000Z TO 2019-09-30T16:30:00.000Z] |
Videos wurden zwischen 14:00 Uhr und 16:30 Uhr (UTC) am 30. September 2019 hinzugefügt |
+created_at:[* TO 2019-09-30T00:00:00.000Z] |
Vor dem 30. September 2019 hinzugefügte Videos |
Bekannte Probleme
- Doppelte Ergebnisse: In bestimmten Fällen können einige Elemente in den Suchergebnissen mehr als einmal erscheinen.
Problemumgehung: Um doppelte Suchergebnisse zu vermeiden, verwenden Sie immer a
sort
Parameter in Ihren Suchanfragen.