Method: targetingTypes.targetingOptions.search

Sucht nach Ausrichtungsoptionen eines bestimmten Typs basierend auf den angegebenen Suchbegriffen.

HTTP-Anfrage

POST https://displayvideo.googleapis.com/v3/targetingTypes/{targetingType}/targetingOptions:search

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
targetingType

enum (TargetingType)

Erforderlich. Der Typ der Targeting-Optionen, die abgerufen werden sollen.

Zulässige Werte:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,

  // Union field search_terms can be only one of the following:
  "poiSearchTerms": {
    object (PoiSearchTerms)
  },
  "businessChainSearchTerms": {
    object (BusinessChainSearchTerms)
  },
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
  // End of list of possible types for union field search_terms.
}
Felder
advertiserId

string (int64 format)

Erforderlich. Der Werbetreibende, in dessen Zusammenhang diese Anfrage gestellt wird.

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 ist.

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 Methode targetingOptions.search zurückgegeben wurde. Wenn keine Angabe erfolgt, wird die erste Ergebnisseite zurückgegeben.

Union-Feld search_terms. Suchanfragen, mit denen nach Ausrichtungsoptionen gesucht wird. Es darf nur ein Feld in search_terms ausgefüllt werden, das targeting_type entsprechen muss. Für search_terms ist nur einer der folgenden Werte zulässig:
poiSearchTerms

object (PoiSearchTerms)

Suchbegriffe für POI-Ausrichtungsoptionen Kann nur verwendet werden, wenn targetingType den Wert TARGETING_TYPE_POI hat.

businessChainSearchTerms

object (BusinessChainSearchTerms)

Suchbegriffe für die Ausrichtungsoptionen für Handelsketten. Kann nur verwendet werden, wenn targetingType den Wert TARGETING_TYPE_BUSINESS_CHAIN hat.

geoRegionSearchTerms

object (GeoRegionSearchTerms)

Suchbegriffe für Optionen für die geografische Ausrichtung. Kann nur verwendet werden, wenn targetingType den Wert TARGETING_TYPE_GEO_REGION hat.

Antworttext

Antwortnachricht für targetingOptions.search.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

object (TargetingOption)

Die Liste der Targeting-Optionen, die den Suchkriterien entsprechen.

Diese Liste ist nicht vorhanden, 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 Methode targetingOptions.search im Feld pageToken, um die nächste Ergebnisseite abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

PoiSearchTerms

Suchbegriffe für POI-Ausrichtungsoptionen

JSON-Darstellung
{
  "poiQuery": string
}
Felder
poiQuery

string

Die Suchanfrage nach dem Namen, der Adresse oder den Koordinaten des gewünschten POI. Die Abfrage kann ein Präfix sein, z.B. „Times squar“, „40.7505045,-73.99562“, „315 W 44th St“ usw.

BusinessChainSearchTerms

Suchbegriffe für die Ausrichtungsoptionen für Handelsketten.

Mindestens eines der Felder muss ausgefüllt sein.

JSON-Darstellung
{
  "businessChainQuery": string,
  "regionQuery": string
}
Felder
businessChainQuery

string

Die Suchanfrage für die gewünschte Handelskette. Die Suchanfrage muss den vollständigen Namen des Unternehmens enthalten, z.B. „KFC“, „mercedes-benz“.

regionQuery

string

Die Suchanfrage für die gewünschte geografische Region, z.B. „Seattle“, „USA“.

GeoRegionSearchTerms

Suchbegriffe für Optionen für die geografische Ausrichtung.

JSON-Darstellung
{
  "geoRegionQuery": string
}
Felder
geoRegionQuery

string

Die Suchanfrage für die gewünschte geografische Region. Die Abfrage kann ein Präfix sein, z.B. „New Yor“, „Seattle“, „USA“ usw.