Method: targetingTypes.targetingOptions.search

Cerca le opzioni di targeting di un determinato tipo in base ai termini di ricerca specificati.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
targetingType

enum (TargetingType)

Obbligatorio. Il tipo di opzioni di targeting da recuperare.

I valori accettati sono:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "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.
}
Campi
advertiserId

string (int64 format)

Obbligatorio. L'inserzionista nel cui contesto viene presentata la richiesta.
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificato, il valore predefinito è 100. Restituisce il codice di errore INVALID_ARGUMENT se viene specificato un valore non valido.
pageToken

string

Un token che identifica una pagina di risultati che il server deve restituire. In genere, si tratta del valore di nextPageToken restituito dalla chiamata precedente al metodo targetingOptions.search. Se non specificato, verrà restituita la prima pagina di risultati.
Campo unione search_terms. Query in base alle quali cercare le opzioni di targeting. È possibile compilare un solo campo in search_terms e deve corrispondere a targeting_type. search_terms può essere solo uno dei seguenti:
poiSearchTerms

object (PoiSearchTerms)

Termini di ricerca per le opzioni di targeting dei PDI. Può essere utilizzato solo quando targetingType è TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

Termini di ricerca per le opzioni di targeting della catena commerciale. Può essere utilizzato solo quando targetingType è TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

Termini di ricerca per le opzioni di targeting per regione geografica. Può essere utilizzato solo quando targetingType è TARGETING_TYPE_GEO_REGION.

Corpo della risposta

Messaggio di risposta per targetingOptions.search.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
Campi
targetingOptions[]

object (TargetingOption)

L'elenco delle opzioni di targeting che corrispondono ai criteri di ricerca.

Questo elenco non sarà presente se è vuoto.
nextPageToken

string

Un token per recuperare la pagina di risultati successiva. Passa questo valore nel campo pageToken nella chiamata successiva al metodo targetingOptions.search per recuperare la pagina di risultati successiva.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la sezione OAuth 2.0 Overview.

PoiSearchTerms

Termini di ricerca per le opzioni di targeting dei PDI.

Rappresentazione JSON 
{
  "poiQuery": string
}
Campi
poiQuery

string

La query di ricerca per il nome, l'indirizzo o le coordinate del PDI desiderato. La query può essere un prefisso, ad esempio "Times squar", "40.7505045,-73.99562", "315 W 44th St" e così via.

BusinessChainSearchTerms

Termini di ricerca per le opzioni di targeting della catena commerciale.

È necessario compilare almeno un campo.

Rappresentazione JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
Campi
businessChainQuery

string

La query di ricerca per la catena di attività desiderata. La query deve essere il nome completo dell'attività, ad esempio "KFC", "mercedes-benz".
regionQuery

string

La query di ricerca per la regione geografica desiderata, ad esempio "Seattle", "Stati Uniti".

GeoRegionSearchTerms

Termini di ricerca per le opzioni di targeting per regione geografica.

Rappresentazione JSON 
{
  "geoRegionQuery": string
}
Campi
geoRegionQuery

string

La query di ricerca per la regione geografica desiderata. La query può essere un prefisso, ad esempio "New Yor", "Seattle", "USA" e così via.