Method: targetingTypes.targetingOptions.search

Recherche les options de ciblage d'un type donné en fonction des termes de recherche indiqués.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
targetingType

enum (TargetingType)

Obligatoire. Type d'options de ciblage à récupérer.

Les valeurs acceptées sont les suivantes :

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
advertiserId

string (int64 format)

Obligatoire. Annonceur pour lequel cette demande est effectuée.
pageSize

integer

Taille de la page demandée. Doit être compris entre 1 et 200. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. Renvoie le code d'erreur INVALID_ARGUMENT si une valeur non valide est spécifiée.
pageToken

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. En règle générale, il s'agit de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode targetingOptions.search. Si aucune valeur n'est spécifiée, la première page de résultats est renvoyée.
Champ d'union search_terms. Requêtes via lesquelles rechercher des options de ciblage. Vous ne pouvez renseigner qu'un seul champ dans search_terms. Celui-ci doit correspondre à targeting_type. search_terms ne peut être qu'un des éléments suivants:
poiSearchTerms

object (PoiSearchTerms)

Termes de recherche pour les options de ciblage des POI. Ne peut être utilisé que lorsque targetingType est défini sur TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

Termes de recherche pour les options de ciblage de la chaîne d'établissements. Ne peut être utilisé que lorsque targetingType est défini sur TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

Termes de recherche pour les options de ciblage par zone géographique. Ne peut être utilisé que lorsque targetingType est défini sur TARGETING_TYPE_GEO_REGION.

Corps de la réponse

Message de réponse pour targetingOptions.search.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
Champs
targetingOptions[]

object (TargetingOption)

Liste des options de ciblage qui correspondent aux critères de recherche.

Cette liste est absente si elle est vide.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans le champ pageToken lors de l'appel suivant de la méthode targetingOptions.search pour récupérer la page de résultats suivante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

PoiSearchTerms

Termes de recherche pour les options de ciblage des POI.

Représentation JSON 
{
  "poiQuery": string
}
Champs
poiQuery

string

Requête de recherche pour le nom, l'adresse postale ou les coordonnées du POI souhaité. La requête peut être un préfixe, par exemple "Times squareuar", "40.7505045,-73.99562", "315 W 44th St", etc.

BusinessChainSearchTerms

Termes de recherche pour les options de ciblage de la chaîne d'établissements.

Au moins l'un des champs doit être renseigné.

Représentation JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
Champs
businessChainQuery

string

Requête de recherche pour la chaîne d'établissements souhaitée. La requête doit correspondre au nom complet de l'entreprise (par exemple, "KFC" ou "mercedes-benz").
regionQuery

string

Requête de recherche pour la région géographique souhaitée (par exemple, "Seattle" ou "États-Unis").

GeoRegionSearchTerms

Termes de recherche pour les options de ciblage par zone géographique.

Représentation JSON 
{
  "geoRegionQuery": string
}
Champs
geoRegionQuery

string

Requête de recherche pour la région géographique souhaitée. La requête peut être un préfixe, par exemple "New Yor", "Seattle", "USA", etc.