Support Kontakt Support | Systemstatus Systemstatus

CMS /Playback API: Videosuche v1

In diesem Thema erfahren Sie, wie Sie in Ihrem Konto nach Videos suchen CMS APIdem „Vermischten Geschmack“. Seine CMS API bietet eine programmatische Möglichkeit, nach Videos in Ihrem Browser zu suchen Video Cloud Bibliothek. Dieses Thema enthält Details zur Suchsyntax. Hinweis: Dies ist die ursprüngliche Suchsyntax. Wir empfehlen die Verwendung der einfacheren Videosuchsyntax v2.

Einführung

In diesem Thema erfahren Sie, wie Sie Folgendes tun:

  • Erstellen und begrenzen Sie eine einfache Suche mit dem q Parameter
  • Suchergebnisse sortieren
  • Suche nach erforderlichen und ausgeschlossenen Begriffen
  • Verwenden Sie eine Suche in Anführungszeichen, um exakte Begriffe und mehrere Wörter zu finden
  • Suche in benutzerdefinierten Feldern
  • Sucht Datumsfelder mit einem bestimmten Datum und mit Bereichen
  • Kombinieren Sie Suchkriterien

API-Nutzung

Die Suchfunktion kann entweder mit dem CMS API oder Playback API.

CMS API

Bei der Suche mit der CMS APIgilt Folgendes:

  • Alle Anfragen (einschließlich der Suche) benötigen einen Berechtigungs-Header, der Ihre Zugriffstoken enthält. Weitere Informationen zum Abrufen von Clientanmeldeinformationen und zum Abrufen von Zugriffstokens finden Sie unter Brightcove OAuth Übersicht.
  • Es gibt keine Begrenzung für die maximale Anzahl von Videos, die von einer Suche zurückgegeben werden, aber die Ratenbegrenzung gilt.
  • Die Suchergebnisse umfassen alle Videos in Ihrem Konto, unabhängig davon, ob sie spielbar sind oder nicht und / oder geografisch eingeschränkt sind.

Details zur API-Anfrage / Antwort finden Sie in der Holen Sie sich Videos Abschnitt der CMS API Referenz.

Playback API

Bei der Suche mit der Playback APIgilt Folgendes:

  • Suchanfragen mit der Playback API benötigen einen Policy Key Suche aktiviert.
  • Da ist ein begrenzen Die maximale Anzahl von Videos, die von einer Suche zurückgegeben wurden.
  • Suchergebnisse geben nur Videos zurück, die abspielbar sind (Videos mit state:inactive wird ignoriert).
  • Durchsuchungen erzwingen Einschränkungen für die Wiedergabe von Richtlinien, z. B. das Auslassen geo-eingeschränkter Videos aus den Ergebnissen.
  • Die Zwischenspeicherung von Ergebnissen liefert höhere Anfrageraten und schnellere Antworten, und es gibt keine Ratenbegrenzung.

Details zur API-Anfrage / Antwort finden Sie in der Holen Sie sich Videos Abschnitt der Playback API Referenz.

Um nach Begriffen in Ihrer Medienbibliothek zu suchen, verwenden Sie die q Parameters.

      q={search terms}

Die Suchbegriffe, die Sie angeben, sollten eine URL-codierte Liste von Termen sein, die durch ein Leerzeichen getrennt sind.

Suche unterstützt stammenden. Stemmen ist das Mapping eines Wortes auf das Wort root und andere Wörter, die von der gleichen Wurzel stammen. Zum Beispiel sollte eine Suche nach "run" Videos entsprechen, die "running" oder "ran" in den angegebenen Feldern haben. Es würde nicht passe "rune" an, weil "rune" nicht als Wurzel "run" hat.

Wenn Sie keinen Qualifier für einen Suchbegriff angeben, z q=birdDie Anfrage sucht in den folgenden Feldern nach diesem Wert:

  • id [1-1]
  • name
  • description
  • long_description
  • text (kein echtes Metadatenfeld, sondern ein Pseudo-Feld, mit dem Sie das suchen können name, description, und long_description - z.B q=text:bird)
  • tags
  • reference_id
  • custom_fields (Durchsucht alle benutzerdefinierten Felder)
  • custom_field_name (Durchsucht ein bestimmtes benanntes benutzerdefiniertes Feld)[1-2]

Wichtige Informationen

[1-1] Hinweis: Die Suche nach ID ist aus Konsistenzgründen enthalten, aber eine Suche nach q=id:12345 liefert genau die gleichen Ergebnisse wie die Anfrage https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/12345
[1-2] Wenn Sie ein benutzerdefiniertes Feld vom Listentyp haben und Videos mit einem von mehreren Werten zurückgeben möchten, können Sie dies wie folgt tun:

Nehmen wir an, Sie haben ein Feld namens color das kann die Werte annehmen: red, green, yellow, oder blue. Sie möchten Videos suchen, deren Feld auf den Wert eingestellt ist green or blue:

      q=color:green%20color:blue

Beispiel: Diese Anfrage liefert Videos mit einem Wert von bird in mindestens einem der oben aufgeführten Felder.

      https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=bird 

Begrenzen Sie die Suche auf eine bestimmte Eigenschaft

Wenn Sie ein Qualifikationsmerkmal für einen Suchbegriff angeben, z q=name:bird, die Anfrage wird das Video durchsuchen name Feld für einen Wert von bird.

Beispiel: Diese Anfrage liefert Videos mit einem Wert von wildlife in name Feld.

      https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=name:wildlife

Die unterstützten Suchfelder sind:

Unterstützte Suchfelder
Feld Rechtliche Werte
name Strings oder zitierte Strings
Text Zeichenketten oder in Anführungszeichen stehende Zeichenfolgen (sucht im name, description, und long_description)
tags Zeichenfolgen oder Zeichenfolgen in Anführungszeichen (mehrere Tags sollten durch Kommas getrennt sein)
custom_fields Zeichenfolgen oder Zeichenfolgen in Anführungszeichen (durchsucht alle benutzerdefinierten Felder - Sie können auch ein bestimmtes benutzerdefiniertes Feld verwenden intern Name) [2-1]
reference_id Zeichenfolge oder Zeichenfolge in Anführungszeichen
state ACTIVE, INACTIVE, PENDING, DELETED [2-3]
updated_at Datumsbereich
created_at Datumsbereich
schedule.starts_at Datumsbereich
schedule.ends_at Datumsbereich
published_at Datumsbereich
complete [2-2] true or false

Wichtige Informationen

  • [2-1] Es ist nicht möglich, nach Videos zu suchen, die ein benutzerdefiniertes Feld haben, das keinen Wert oder einen Wert von hat null, denn wenn dem Feld kein Wert zugewiesen wurde, ist es in den Video-Metadaten überhaupt nicht enthalten.
  • [2-2] Wenn Sie ein neues Video erstellen, das complete Eigenschaft wird automatisch auf festgelegt false. Sobald eine Version für das Video existiert, wird die complete Eigenschaft wird automatisch auf eingestellt true.
  • [2-3] Die folgenden Einschränkungen gelten für die Suche nach gelöschten Videos:
    • Suche nach gelöschten Videos ist ausschließlich verfügbar mit dem CMS API; das Playback API werden nicht Gelöschte Videos zurückgeben
    • Only Videos, die während der letzten 10-Tage gelöscht wurden (die aktuelle Zeit minus 10-Tage) werden zurückgegeben

Sortierung der Suchergebnisse

Unser sort Mit diesem Parameter können Sie die Ergebnisse einer Abrufanforderung für Videos sortieren. Sie können nach Folgendem sortieren:

  • reference_id
  • name
  • created_at
  • published_at
  • updated_at
  • schedule.starts_at
  • schedule.ends_at
  • state
  • plays_total
  • plays_trailing_week

Wenn die Ergebnisse nicht explizit durch die Verwendung von sortiert werden sortwerden die Ergebnisse nach einem Algorithmus sortiert, der als Term Frequency / Inverse Document Frequency oder bezeichnet wird TF-IDF. Sehen .

Angenommen, Sie suchen nach den Begriffen coastal,city und es gibt 120-Videos in deinem Konto, die diese Begriffe irgendwo in den Video-Metadaten enthalten ( name, description, tagsusw.) und die auch den Sortierkriterien für die Ergebnisse entsprechen (z. B. haben sie alle das gleiche) schedule_starts_at Terminzeit). Wie hoch die Ergebnisse eines Videos sind, hängt von der Häufigkeit ab, mit der ein oder beide Begriffe in den Metadaten erscheinen, wobei der Begriff, der in Ihrer Videobibliothek als Ganzes am häufigsten auftritt, stärker gewichtet wird.

Erforderliche / ausgeschlossene Begriffe

Sie können einen Suchbegriff nach Bedarf markieren (zurückgegebene Videos müssen übereinstimmen) oder ausgeschlossen (zurückgegebene Videos dürfen NICHT übereinstimmen). Dies wird mit einem URI-encoded gesteuert + (%2B) or - Zeichen unmittelbar vor dem Begriff.

Du musst kodieren + as %2B wenn es verwendet wird, um einen erforderlichen Begriff anzugeben.

Erforderliche / ausgeschlossene Bedingungen
Beispiel URL-codiert Bedeutung
+foo %2Bfoo Videos müssen den Begriff enthalten foo in name, description, long_description, tags, reference_id or custom_fields
+custom_fields:foo %2Bcustom_fields:foo Video muss den Wert enthalten foo für einige benutzerdefinierte Felder
+foo -bar %2Bfoo%20-bar Videos müssen den Begriff enthalten foo darf aber NICHT den Begriff enthalten bar in name, description, long_description, tags, reference_id or custom_fields
+name:foo -name:bar %2Bname:foo%20-name:bar Videos müssen den Begriff enthalten foo darf aber NICHT den Begriff enthalten bar in name

Beispiel: Diese Anfrage gibt Videos zurück, die einen Wert von HABEN haben sea aber NICHT einen Wert von lake in tags Feld.

      https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=%2Btags:sea%20-tags:lake

[VORLÄUFIGE VOLLAUTOMATISCHE TEXTÜBERSETZUNG - muss noch überarbeitet werden. Wir bitten um Ihr Verständnis.] Für eine detailliertere Anleitung gehen Sie bitte auf: Suchkriterien kombinieren weiter unten, um zu sehen, wie die erforderliche / ausgeschlossene Syntax verwendet wird, um UND-Logik für mehrere Suchbegriffe durchzusetzen.

Kombiniert mit anderen Params

Suche (mit der q Parameter) kann mit anderen Parametern kombiniert werden, z sort, limit und offset. Alle URL-Parameter sind durch getrennt &. Die Reihenfolge der Parameter spielt keine Rolle.

Beispiele

Beispiel: Diese Anfrage gibt Videos zurück, deren Wert den Wert haben muss bar in tag Feld und kann eine haben name Wert enthalten foo

      .../videos?q=name:foo%20%2Btags:bar&sort=updated_at

Beispiel: Diese Anfrage gibt die gleichen Videos wie oben zurück, sortiert diese Ergebnisse jedoch zusätzlich nach Feld updated_at und begrenzt dann die Ergebnisse auf nur 10-Videos.

      .../videos?sort=updated_at&q=name:foo%20%2Btags:bar&limit=10

Zitierte Suchbegriffe

Standardmäßig stimmt eine Suche mit ähnlichen Wörtern mit Ihren Suchbegriffen überein. Wenn Sie mehrere Wörter zuordnen möchten, schließen Sie den Begriff einfach in Anführungszeichen ein.

Die meisten Browser und andere Agenten behandeln wörtliche Anführungszeichen ("...") richtig, aber wenn Sie auf einen Fall stoßen, in dem zitierte Suchbegriffe scheinbar nicht die richtigen Ergebnisse liefern, versuchen Sie, die Anführungszeichen durch zu ersetzen %22 (%22...%22)

            
              q="foo" or q=%22foo%22
              q="foo%20bar" or q=%22foo%20bar%22
            
          

Dies funktioniert auch bei der Suche nach einem bestimmten Feld:

            
              q=name:"home"
              q=name:"home%20run"
            
          

Mehrere Wörter

Beispiel: Beachten Sie, dass diese Anfrage Videos zurückgibt, die entweder den Wert sea or mammal in tags Feld.

      https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=tags:sea,mammal

Die folgende Anforderung gibt jedoch nur die Videos zurück, die ein Tag haben sea,mammal.

      https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=tags:"sea,mammal"

Benutzerdefinierte Felder

Sie können nach jedem benutzerdefinierten Feld suchen, das Sie für Ihre Videos definiert haben.

      q=my_field:foo
      q=my_field:"foo"

Hinweis: Alle benutzerdefinierten Feldwerte werden als Zeichenfolgen behandelt. Wenn Sie beispielsweise ein benutzerdefiniertes Feld vom Listentyp haben, das die Werte übernehmen kann true or falsesucht die Suche nach diesen Zeichenfolgen, nicht nach booleschen Werten (in vielen Programmiersprachen, 1 und 0 kann mit austauschbar verwendet werden true und false als boolesche Werte, aber suchen weiter q=my_boolean_field:1 Videos werden nicht zurückgegeben my_boolean_field einstellen true).

Beispiel: Diese Anfrage liefert Videos mit einem Wert von Tier in subject benutzerdefinierte Feld.

      https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=subject:animal

Datumsbereiche

Wenn Sie nach einem Datumsfeld suchen, können Sie ein bestimmtes Datum oder einen Datumsbereich angeben. Verwenden Sie zwei Punkte, um Start- und Enddatum zu trennen (q=updated_at:2018-01-01..2018-02-01).

Dies wird nach allen Videos mit einem suchen updated_at Wert zwischen Aug 1, 2012 und Oktober 8, 2012. Hier geben wir jedes Datum im UTC-Format an.

      q=updated_at:2012-08-01T00:00:00Z..2012-10-08T23:59:59Z

Sie können diese Suche vereinfachen, indem Sie die Zeitkomponenten löschen. Folgendes entspricht der obigen Suche.

      q=updated_at:2012-08-01..2012-10-08

Unterstützte Datumsformate

Die unterstützten Datumsformate umfassen UTC und relativ.

Datumsformat Beispiele
Format (URI-kodiertes Format) Bedeutung
2015-08-01T06:15:00Z Dies entspricht einer Zeit in UTC.
2012-08-01 Dies entspricht Mitternacht an einem Tag in UTC. Das Beispiel entspricht 2012-08-01T00: 00: 00Z
-1d Die aktuelle Uhrzeit minus 1-Tag. (sehen unten)

Relative Daten

Für relative Daten unterstützen wir eine Richtung ( + or -) gefolgt von einer Nummer, gefolgt von einer Dauer. Relative Daten werden immer von der aktuellen Zeit gemessen. Die gesetzliche Dauer ist: Minuten, Stunden, Tage.

Beispiele:

Relative Datum Proben
q Parameter für Daten Bedeutung
q = aktualisiert_at: -1day..NOW Videos wurden von 1 vor einem Tag auf den aktuellen Tag aktualisiert
q = created_at: -2days Videos vor 2 Tagen hinzugefügt
q = Updated_at: -4hours..NOW Video aktualisiert von 4 Stunden vor der aktuellen Zeit
q = create_at: -60minutes .. Videos von 60 Minuten vor der aktuellen Zeit hinzugefügt
q = erstellt_at: 2016-01-01 ..- 1d Videos erstellt von Januar 1, 2015 bis vor einem Tag
q = aktualisiert_at: -14d..NOW Videos in den letzten zwei Wochen

Offene Bereiche

Wenn Sie alle Daten bis zu einer bestimmten Zeit abgleichen oder alle Daten seit einer bestimmten Zeit abgleichen möchten, lassen Sie ein Ende des Bereichs aus.

Beispiel: Suche nach allen Videos, die in den letzten 2-Tagen geändert wurden

      q=updated_at:-2days..
      
      

Beispiel: Suche nach allen Videos, die am oder nach August 11, 2013 geändert wurden:

      q=updated_at:2013-08-11T00:00:00Z..
      
      

NOW Operator für Terminpläne

Für schedule.starts_at und schedule.ends_at, Können Sie NOW als Datumswert. Dies ist ein praktischer Operator, mit dem Sie eine dynamische Abfrage basierend auf dem aktuellen Datum und Uhrzeit einrichten können. Einige Beispiele:

Schedule Daten Beispiele
von / nach params URI-codiert Bedeutung
? q = schedule.start_at: .. JETZT ? q = schedule.start_at: .. JETZT starts_at ist vom Anfang der Zeit bis zu diesem Moment
q = schedule.starts_at: JETZT q = schedule.starts_at: JETZT starts_at ist von diesem Moment an
? q = schedule.ends_at: JETZT .. ? q = schedule.ends_at: JETZT .. ends_at ist von diesem Moment bis zum Ende der Zeit
q = + schedule.starts_at: .. JETZT + schedule.ends_at: JETZT .. q =% 2Bschedule.starts_at: .. JETZT% 20% 2Bschedule.ends_at: JETZT .. starts_at vor diesem Moment und ends_at nach diesem Moment (Video ist in diesem Moment im Zeitplan)

Kombinieren Sie Suchkriterien

Sie können Kriterien für komplexe Suchen kombinieren.

Beispiel: Diese Anfrage sucht nach Videos mit einem name Wert von Klatsch, die zwischen August 1, 2010 und Oktober 8, 2010 aktualisiert wurden. Es sortiert dann die Antwortdaten nach updated_at Datum in absteigender Reihenfolge.

      q=%2Bname:gossip%20%2Bupdated_at:2010-08-01..2010-10-08&sort=-updated_at

Begriffe kombinieren

Verwenden Sie das benötigte / ausgeschlossene Syntax Videos zurückgeben, die haben und all das der angegebenen Begriffe.

Zum Beispiel, wenn Sie suchen:

      q=name:foo +tags:bar (URI-encoded: q=name:foo%20%2Btags:bar)

Die Antwort enthält Videos, die das Tag "bar" haben und möglicherweise auch haben foo im Namen. Wenn Sie nur die Videos zurückgeben möchten, die das haben foo Im Namen UND dem Tag 'bar' müssen Sie suchen:

      (unencoded) q=+name:foo +tags:bar (URI-encoded) q=%2Bname:foo%20%2Btags:bar

Genauso, wenn du nur Videos zurückgeben möchtest, die das haben foo im Namen, aber tun nicht Haben Sie das Tag 'bar', würden Sie suchen:

      (unencoded) q=+name:foo -tags:bar (encoded) q=%2Bname:foo%20-tags:bar

Beispiele

Beispiele: Kombinieren von Begriffen
Nicht codierte Suchzeichenfolge URI-codierte Suchzeichenfolge Bedeutung
q=foo bar q=foo%20bar zurückgegebene Artikel haben "foo" ODER "bar"
q=foo +bar q=foo%20%2Bbar zurückgegebene Artikel müssen "bar" haben, möglicherweise "foo"
q=+foo bar q =%2Bfoo%20bar zurückgegebene Artikel müssen "foo" haben, können "bar" haben
q=+foo +bar q=%2Bfoo%20%2Bbar Zurückgegebener Artikel muss "foo" UND "bar" haben
q=-foo +bar q=-foo%20%2Bbar returned item muss "bar" UND nicht "foo" haben
Mehrere Tag-Suchen
q=tags:bee,bop q=tags:bee,bop gibt Videos mit dem Tag "bee" oder "bop" zurück
q=tags:bee tags:bop q=tags:bee%20tags:bop gibt Videos mit dem Tag "bee" oder "bop" zurück
q=+tags:bee tags:bop q=%2Btags:bee%20tags:bop Alle zurückgegebenen Videos müssen das Tag "bee" haben. Sie können auch das Tag "bop" haben
q=+tags:bee +tags:bop q=%2Btags:bee%20%2Btags:bop Alle zurückgesendeten Videos haben das Tag "bee" UND das Tag "bop"

Suche bestimmte Videos

Wenn Sie Ihre Suche auf einen bestimmten Satz von Videos beschränken möchten, können Sie dies auch suchen id:

Beispiel: Diese Anfrage gibt Videos mit IDs zurück 123456789, 987654321 und 48376387

      q=id:123456789%20id:987654321%20id:48376387

Suche nach Bundesland

Sie können Suchen anhand des Status des Videos mithilfe des folgenden Parameters durchführen oder filtern:

      q=state:ACTIVE( | INACTIVE | PENDING | DELETED)[3]

Wichtige Informationen

  • [3] Die Suche nach DELETED-Videos ist nur für Videos verfügbar, die in den vergangenen 10-Tagen (die aktuelle Zeit minus 10-Tage) gelöscht wurden, und nur über die CMS API (nicht der Playback API).

Stemming

Stemming wird unterstützt, aber nicht Teilwortsuche. Beispielsweise, q=name:ban sollte Videos mit den Namen zurückgeben "Parking Ban Announced"Oder"Parking to be Banned"Oder"City Banning Parking" aber nicht "Bank Holiday"Oder"Bandit Captured".

Leerzeichen / Sonderzeichen

Unser CMS API behandelt normalerweise Sonderzeichen in Suchzeichenfolgen mit einigen Ausnahmen:

  • Leerzeichen sind nicht zulässig und müssen als codiert werden %20. (Nicht codiert + Zeichen können auch Leerzeichen ersetzen, was jedoch zu Verwirrung in Ihren Abfragen führen kann + kann auch anzeigen, dass ein Begriff erforderlich ist. Sehen benötigte / ausgeschlossene Syntax)

    Um beispielsweise nach "Mein Lieblingsvideo" im Namen zu suchen:

    q=name:"my%20favorite%20video"

  • Nach einem Literal suchen + signieren oder benutzen + um die zurückgegebenen Videos anzuzeigen sollen Fügen Sie einen Begriff ein, den Sie codieren müssen + as %2B:

    Suchen nach Videos, die enthalten müssen "two+two" im Namensfeld

    q=name:two%2Btwo

    Suchen nach Videos, die enthalten müssen "heron" im Namensfeld

    q=%2Bname:heron

  • Einige Agents verarbeiten literale Anführungszeichen möglicherweise nicht korrekt, sodass die Codierung sicherer ist "foo" as %22foo%22

Für einmalige Anfragen können Sie Brightcove Learning verwenden String-Encoder um Ihre Suchbegriffe zu kodieren. Für Apps müssen Sie eine URI-Codierungsfunktion in der von Ihnen verwendeten Sprache finden.

Suchbegriffe trennen

Clips sind Videos, die aus Abschnitten anderer Videos erstellt wurden. Clips können erzeugt werden durch Brightcove Socialund andere Mittel werden in Zukunft verfügbar sein. Es gibt einige spezielle Suchbegriffe, mit denen Sie nach generierten Clips in einem Konto suchen können:

  • q=%2Bis_clip:true - Gibt nur Clips zurück
  • q=%2Bis_clip:false - Gibt nur Nicht-Clips zurück
  • q=%2Bclip_source_video_id:video_id - Gibt Clips aus dem angegebenen Video zurück

Ignorierte Wörter

Bestimmte Wörter werden in Suchzeichenfolgen ignoriert, da sie so häufig vorkommen, dass sie viele Ergebnisse zurückgeben, die nicht mit dem übereinstimmen, nach dem Sie tatsächlich suchen. Im Folgenden finden Sie eine Liste von Wörtern, die bei der Suche ignoriert werden:

"an", "an", "und", "sind", "wie", "an", "sein", "aber", "für", "für", "wenn", "in", "in" "," ist "," es "," nein "," nicht "," von "," an "," oder "," so "," das "," das "," ihr "," dann ", "da", "diese", "sie", "diese", "zu", "war", "wird", "mit"

Bekannte Probleme

  • Doppelte Ergebnisse: In bestimmten Fällen werden einige Elemente in den Suchergebnissen möglicherweise mehrmals angezeigt.

    Workaround: Um doppelte Suchergebnisse zu vermeiden, verwenden Sie immer a sort Parameter in Ihren Suchanfragen.


Seite zuletzt aktualisiert am 12. Juni 2020