Method: customBiddingAlgorithms.list

Listet benutzerdefinierte Gebotsalgorithmen auf, auf die der aktuelle Nutzer zugreifen und die in Gebotsstrategien verwendet werden können.

Die Reihenfolge wird durch den Parameter orderBy definiert.

HTTP-Anfrage

GET https://displayvideo.googleapis.com/v2/customBiddingAlgorithms

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameters
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn keine Vorgabe erfolgt, wird standardmäßig 100 verwendet. Gibt den Fehlercode INVALID_ARGUMENT zurück, wenn ein ungültiger Wert angegeben wurde.

pageToken

string

Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. In der Regel ist dies der Wert von nextPageToken, der vom vorherigen Aufruf der customBiddingAlgorithms.list-Methode zurückgegeben wurde. Wenn nicht angegeben, wird die erste Ergebnisseite zurückgegeben.

orderBy

string

Feld, nach dem die Liste sortiert werden soll. Akzeptable Werte sind:

  • displayName (Standard)

Die standardmäßige Sortierreihenfolge ist aufsteigend. Wenn ein Feld absteigend sortiert werden soll, muss dem Feldnamen das Suffix „desc“ hinzugefügt werden. Beispiel: displayName desc.

filter

string

Ermöglicht das Filtern nach Algorithmusfeldern für die benutzerdefinierte Gebotseinstellung.

Unterstützte Syntax:

  • Filterausdrücke bestehen aus einer oder mehreren Einschränkungen.
  • Einschränkungen können mit AND kombiniert werden. Bei einer Abfolge von Einschränkungen wird implizit AND verwendet.
  • Eine Einschränkung hat das Format {field} {operator} {value}.
  • Im Feld customBiddingAlgorithmType muss der Operator EQUALS (=) verwendet werden.
  • Im Feld displayName muss der Operator HAS (:) verwendet werden.

Unterstützte Felder:

  • customBiddingAlgorithmType
  • displayName

Beispiele:

  • Alle Algorithmen für die benutzerdefinierte Gebotseinstellung, bei denen der Anzeigename „Politik“ enthält: displayName:"politics".
  • Alle Algorithmen für die benutzerdefinierte Gebotseinstellung, bei denen der Typ „Script_BASED“ ist: customBiddingAlgorithmType=SCRIPT_BASED

Die Länge dieses Feldes darf 500 Zeichen nicht überschreiten.

Weitere Informationen finden Sie im Leitfaden zu LIST-Filteranfragen.

Union-Parameter accessor. Erforderlich. Gibt an, in welcher DV360-Entität die Anfrage gesendet wird. Bei der LIST-Anfrage werden nur Algorithmen für die benutzerdefinierte Gebotseinstellung zurückgegeben, auf die die in accessor angegebene DV360-Entität zugreifen kann. Zum Ausführen einer LIST-Anfrage muss der Nutzer eine Berechtigung für die accessor-Entität haben. Für accessor ist nur einer der folgenden Werte zulässig:
partnerId

string (int64 format)

Die ID des DV360-Partners, der Zugriff auf den Algorithmus für die benutzerdefinierte Gebotseinstellung hat.

advertiserId

string (int64 format)

Die ID des DV360-Werbetreibenden, der Zugriff auf den Algorithmus für die benutzerdefinierte Gebotseinstellung hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung
{
  "customBiddingAlgorithms": [
    {
      object (CustomBiddingAlgorithm)
    }
  ],
  "nextPageToken": string
}
Felder
customBiddingAlgorithms[]

object (CustomBiddingAlgorithm)

Die Liste der Algorithmen für die benutzerdefinierte Gebotseinstellung.

Diese Liste fehlt, wenn sie leer ist.

nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann. Übergeben Sie diesen Wert im nachfolgenden Aufruf der ListCustomBiddingAlgorithmsRequest-Methode im Feld pageToken, um die nächste Ergebnisseite abzurufen. Wenn dieses Feld den Wert null enthält, bedeutet dies, dass dies die letzte Seite ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/display-video

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.