v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
targetingTypes

Lists targeting options of a given type.

get/v4/targetingTypes/{+targetingType}/targetingOptions

Path parameters

targetingType'TARGETING_TYPE_UNSPECIFIED' | 'TARGETING_TYPE_CHANNEL' | 'TARGETING_TYPE_APP_CATEGORY' | 'TARGETING_TYPE_APP' | 'TARGETING_TYPE_URL' | 'TARGETING_TYPE_DAY_AND_TIME' | 'TARGETING_TYPE_AGE_RANGE' | 'TARGETING_TYPE_REGIONAL_LOCATION_LIST' | 'TARGETING_TYPE_PROXIMITY_LOCATION_LIST' | 'TARGETING_TYPE_GENDER' | 'TARGETING_TYPE_VIDEO_PLAYER_SIZE' | 'TARGETING_TYPE_USER_REWARDED_CONTENT' | 'TARGETING_TYPE_PARENTAL_STATUS' | 'TARGETING_TYPE_CONTENT_INSTREAM_POSITION' | 'TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION' | 'TARGETING_TYPE_DEVICE_TYPE' | 'TARGETING_TYPE_AUDIENCE_GROUP' | 'TARGETING_TYPE_BROWSER' | 'TARGETING_TYPE_HOUSEHOLD_INCOME' | 'TARGETING_TYPE_ON_SCREEN_POSITION' | 'TARGETING_TYPE_THIRD_PARTY_VERIFIER' | 'TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION' | 'TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION' | 'TARGETING_TYPE_ENVIRONMENT' | 'TARGETING_TYPE_CARRIER_AND_ISP' | 'TARGETING_TYPE_OPERATING_SYSTEM' | 'TARGETING_TYPE_DEVICE_MAKE_MODEL' | 'TARGETING_TYPE_KEYWORD' | 'TARGETING_TYPE_NEGATIVE_KEYWORD_LIST' | 'TARGETING_TYPE_VIEWABILITY' | 'TARGETING_TYPE_CATEGORY' | 'TARGETING_TYPE_INVENTORY_SOURCE' | 'TARGETING_TYPE_LANGUAGE' | 'TARGETING_TYPE_AUTHORIZED_SELLER_STATUS' | 'TARGETING_TYPE_GEO_REGION' | 'TARGETING_TYPE_INVENTORY_SOURCE_GROUP' | 'TARGETING_TYPE_EXCHANGE' | 'TARGETING_TYPE_SUB_EXCHANGE' | 'TARGETING_TYPE_POI' | 'TARGETING_TYPE_BUSINESS_CHAIN' | 'TARGETING_TYPE_CONTENT_DURATION' | 'TARGETING_TYPE_CONTENT_STREAM_TYPE' | 'TARGETING_TYPE_NATIVE_CONTENT_POSITION' | 'TARGETING_TYPE_OMID' | 'TARGETING_TYPE_AUDIO_CONTENT_TYPE' | 'TARGETING_TYPE_CONTENT_GENRE' | 'TARGETING_TYPE_YOUTUBE_VIDEO' | 'TARGETING_TYPE_YOUTUBE_CHANNEL' | 'TARGETING_TYPE_SESSION_POSITION' | 'TARGETING_TYPE_CONTENT_THEME_EXCLUSION' | 'TARGETING_TYPE_YOUTUBE_CHANNEL_PACK' required

Required. The type of targeting option to be listed. Accepted values are: * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_BROWSER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_VIEWABILITY * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID

Query parameters

advertiserIdstring

Required. The Advertiser this request is being made in the context of.

filterstring

Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by OR logical operators. * A restriction has the form of {field} {operator} {value}. * All fields must use the EQUALS (=) operator. Supported fields: * carrierAndIspDetails.type * geoRegionDetails.geoRegionType * targetingOptionId Examples: * All GEO REGION targeting options that belong to sub type GEO_REGION_TYPE_COUNTRY or GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE" * All CARRIER AND ISP targeting options that belong to sub type CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

orderBystring

Field by which to sort the list. Acceptable values are: * targetingOptionId (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingOptionId desc.

pageSizeinteger

Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageTokenstring

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListTargetingOptions method. If not specified, the first page of results will be returned.

Response

Successful response