Method: targetingTypes.targetingOptions.search

Sucht anhand der angegebenen Suchbegriffe nach Targeting-Optionen eines bestimmten Typs.

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 Kontext diese Anfrage gestellt wird.

pageSize

integer

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

pageToken

string

Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. Normalerweise 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 werden soll. Nur ein Feld in search_terms darf ausgefüllt werden und es muss targeting_type entsprechen. Für search_terms ist nur einer der folgenden Werte zulässig:
poiSearchTerms

object (PoiSearchTerms)

Suchbegriffe für POI-Targeting-Optionen. Kann nur verwendet werden, wenn targetingType TARGETING_TYPE_POI ist.

businessChainSearchTerms

object (BusinessChainSearchTerms)

Suchbegriffe für Targeting-Optionen für Handelsketten. Kann nur verwendet werden, wenn targetingType TARGETING_TYPE_BUSINESS_CHAIN ist.

geoRegionSearchTerms

object (GeoRegionSearchTerms)

Suchbegriffe für Optionen für das geografische Targeting. Kann nur verwendet werden, wenn targetingType TARGETING_TYPE_GEO_REGION ist.

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.

Wenn die Liste leer ist, ist sie nicht vorhanden.

nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann. Übergeben Sie diesen Wert im Feld pageToken im nachfolgenden Aufruf der Methode targetingOptions.search, um die nächste Ergebnisseite abzurufen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

PoiSearchTerms

Suchbegriffe für POI-Targeting-Optionen.

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

string

Die Suchanfrage für den gewünschten POI-Namen, die Straßenadresse oder die Koordinate des gewünschten POI. Die Anfrage kann ein Präfix sein, z.B. „Times squar“, „40.7505045,-73.99562“, „315 W 44th St“ usw.

BusinessChainSearchTerms

Suchbegriffe für Targeting-Optionen für Handelsketten.

Mindestens eines der Felder muss ausgefüllt werden.

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

string

Die Suchanfrage für die gewünschte Unternehmensgruppe. Die Anfrage muss den vollständigen Namen des Unternehmens enthalten, z.B. „KFC“ oder „Mercedes-Benz“.

regionQuery

string

Der Suchbegriff für die gewünschte geografische Region, z.B. „Seattle“ oder „USA“.

GeoRegionSearchTerms

Suchbegriffe für Optionen für das geografische Targeting.

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

string

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