Filtern von 10 DLC-Ergebnissen

Alle 10 DLC GET API-Endpunkte ermöglichen es Ihnen, Ihre Ergebnisse mit Hilfe von Filtern einzugrenzen.

Anstatt die Liste aller Marken zu erhalten, könnten Sie sich beispielsweise für Marken innerhalb der REAL_ESTATE vertikal. In diesem Fall können Sie einen Filter anwenden, der Folgendes zurückgibt REAL_ESTATE nur verwandte Marken.

Struktur der Anfrage

Filter werden als Abfrageparameter an den Endpunkt übergeben. In Ihrer Abfrage verwenden Sie das Schlüsselwort filter als Schlüssel, gefolgt von der Abfrage in Form eines JSON-Objekts.

Hier ist ein Beispiel:

https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns?filter=[[{"field":"vertical","type":"==","value":"REAL_ESTATE"}]]

Objekt filtern

Ein Filterobjekt ist ein JSON-Objekt, das eine Filterabfrage enthält. Ein Filterobjekt enthält drei Schlüssel/Wert-Paare:

[
   [
      {
         "field":"vertical",
         "type":"==",
         "value":"REAL_ESTATE"
      }
   ]
]

Feld: ist der Name des Feldes, nach dessen Wert Sie filtern möchten.

Typ: ist die passende Bedingung, die Sie bei der Filtersuche anwenden möchten. Besuchen Sie die Filterbedingungen um die verfügbaren Bedingungen zu sehen.

Wert: ist der Wert, nach dem Sie filtern möchten.

Bedingungen filtern

  • regexp: Regex - Gibt Datensätze zurück, die mit dem Filterwert auf der Grundlage des angegebenen regulären Ausdrucks übereinstimmen.
  • ==: Gleichberechtigt - Gibt Datensätze zurück, die genau mit dem Filterwert übereinstimmen.
  • = : Gleiche Faltung - Entspricht Datensätzen ohne Unterscheidung von Groß- und Kleinschreibung (Dies gilt für UTF-8-Zeichen).
  • ^=: Beginnt mit - Findet Datensätze, die mit dem Filterwert beginnen.
  • =$: Endet mit - Findet Datensätze, die mit dem Filterwert enden.
  • ~=: Enthält - Findet Datensätze, die den Filterwert enthalten.
  • <: Weniger als - findet Datensätze, die kleiner als der Filterwert sind.
  • <=: Kleiner als oder gleich - findet Datensätze, die kleiner oder gleich dem Filterwert sind.
  • >: Größer als - findet Datensätze, die größer als der angegebene Filterwert sind.
  • >=: Größer als oder gleich - findet Datensätze, die größer oder gleich dem Filterwert sind.

Sie können gegenteilige Datensätze abrufen, indem Sie eine der oben genannten Bedingungen negieren, indem Sie der Bedingung das Zeichen ! Symbol. Zum Beispiel, !== ist gleichbedeutend mit Nicht gleichwertig.

Regeln für die Filterung

Sie können maximal eine Anzahl von drei Filterobjekte in einer Abfrage. Das bedeutet, dass Sie Ergebnisse finden können, die mit maximal drei Feldern übereinstimmen. Filterobjekte können auch auf unterschiedliche Weise gekoppelt werden.

Sie können zum Beispiel Ergebnisse abrufen, die einem Filterobjekt entsprechen OR ein anderes. Außerdem können Ergebnisse, die mit einem Filterobjekt übereinstimmen UND eine andere.

Nehmen wir den Fall an, dass wir Marken abrufen möchten, bei denen die vertical ist entweder REAL_ESTATE OR NGO UND wobei die ID des Wiederverkäufers(reseller_id) ist 12345.

Wir können dies als logische Aussage formulieren: ( (vertical == REAL_ESTATE OR vertical == NGO) AND (reseller_id == 12345) )

Filterabfragen mit OR Ausdrücke werden durch eckige Klammern dargestellt []. Zum Beispiel der folgende Ausdruck(vertical == REAL_ESTATE OR vertical == NGO) wird [ [{filter object 1}, {filter object 2}] ].

Die innere eckige Klammer bedeutet, dass Sie Ergebnisse abrufen möchten, die entweder Filterobjekt 1 OR Filterobjekt 2.

Die äußere eckige Klammer markiert den Beginn einer Filterabfrage und ist für alle Filterabfragen obligatorisch und erforderlich.

Beispiele für Filterregeln

  1. Spiel Filterobjekt 1; [ [{filter object 1}] ].
  2. Spiel Filterobjekt 1 UND Filterobjekt 2; [ [{filter object 1}], [{filter object 2}] ]
  3. Spiel Filterobjekt 1 OR Filterobjekt 2; [ [{filter object 1},{filter object 2}] ]
  4. Spiel (Filterobjekt 1 OR Filterobjekt 2) UND Filterobjekt 3 ; [ [{filter object 1},{filter object 2}], [{filter object 3}] ].

NB: Filterobjekte sollten immer innerhalb einer eckigen Klammer stehen, auch wenn es sich um ein einzelnes Objekt handelt. Ein gutes Beispiel ist der Filterobjekt 3 im obigen Beispiel 4.

Wenn man die Filterobjekte in Beispiel 4. weiter ausbaut, erhält man die folgende Filterabfrage:

[
   [
      {
         "field":"vertical",
         "type":"==",
         "value":"REAL_ESTATE"
      },
      {
         "field":"vertical",
         "type":"==",
         "value":"NGO"
      }
   ],
   [{
      "field":"reseller_id",
      "type":"==",
      "value":"12345"
   }]
]