- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- PoiSearchTerms
- BusinessChainSearchTerms
- GeoRegionSearchTerms
- Try it!
Searches for targeting options of a given type based on the given search terms.
HTTP request
POST https://displayvideo.googleapis.com/v3/targetingTypes/{targetingType}/targetingOptions:search
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
targetingType |
Required. The type of targeting options to retrieve. Accepted values are:
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "advertiserId": string, "pageSize": integer, "pageToken": string, // Union field |
Fields | |
---|---|
advertiserId |
Required. The Advertiser this request is being made in the context of. |
pageSize |
Requested page size. Must be between |
pageToken |
A token identifying a page of results the server should return. Typically, this is the value of |
Union field search_terms . Queries by which to search for targeting options. Only one field in search_terms may be filled out, and it must correspond to targeting_type . search_terms can be only one of the following: |
|
poiSearchTerms |
Search terms for POI targeting options. Can only be used when |
businessChainSearchTerms |
Search terms for Business Chain targeting options. Can only be used when |
geoRegionSearchTerms |
Search terms for geo region targeting options. Can only be used when |
Response body
Response message for targetingOptions.search
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"targetingOptions": [
{
object ( |
Fields | |
---|---|
targetingOptions[] |
The list of targeting options that match the search criteria. This list will be absent if empty. |
nextPageToken |
A token to retrieve the next page of results. Pass this value in the |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/display-video
For more information, see the OAuth 2.0 Overview.
PoiSearchTerms
Search terms for POI targeting options.
JSON representation |
---|
{ "poiQuery": string } |
Fields | |
---|---|
poiQuery |
The search query for the desired POI name, street address, or coordinate of the desired POI. The query can be a prefix, e.g. "Times squar", "40.7505045,-73.99562", "315 W 44th St", etc. |
BusinessChainSearchTerms
Search terms for Business Chain targeting options.
At least one of the field should be populated.
JSON representation |
---|
{ "businessChainQuery": string, "regionQuery": string } |
Fields | |
---|---|
businessChainQuery |
The search query for the desired business chain. The query must be the full name of the business, e.g. "KFC", "mercedes-benz". |
regionQuery |
The search query for the desired geo region, e.g. "Seattle", "United State". |
GeoRegionSearchTerms
Search terms for geo region targeting options.
JSON representation |
---|
{ "geoRegionQuery": string } |
Fields | |
---|---|
geoRegionQuery |
The search query for the desired geo region. The query can be a prefix, e.g. "New Yor", "Seattle", "USA", etc. |