Sign in

v1

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

Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.

post/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions

Path parameters

advertiserIdstring required

Required. The ID of the advertiser the line item belongs to.

lineItemIdstring required

Required. The ID of the line item the assigned targeting option will belong to.

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. Identifies the type of this assigned targeting option. Supported targeting types include: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_APP * TARGETING_TYPE_APP_CATEGORY * TARGETING_TYPE_AUDIENCE_GROUP * TARGETING_TYPE_AUDIO_CONTENT_TYPE * TARGETING_TYPE_AUTHORIZED_SELLER_STATUS * TARGETING_TYPE_BROWSER * TARGETING_TYPE_BUSINESS_CHAIN * TARGETING_TYPE_CARRIER_AND_ISP * TARGETING_TYPE_CATEGORY * TARGETING_TYPE_CHANNEL * TARGETING_TYPE_CONTENT_DURATION * TARGETING_TYPE_CONTENT_GENRE * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION * TARGETING_TYPE_CONTENT_STREAM_TYPE * TARGETING_TYPE_DAY_AND_TIME * TARGETING_TYPE_DEVICE_MAKE_MODEL * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_GEO_REGION * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_INVENTORY_SOURCE * TARGETING_TYPE_INVENTORY_SOURCE_GROUP * TARGETING_TYPE_KEYWORD * TARGETING_TYPE_LANGUAGE * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_NEGATIVE_KEYWORD_LIST * TARGETING_TYPE_OMID * TARGETING_TYPE_ON_SCREEN_POSITION * TARGETING_TYPE_OPERATING_SYSTEM * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_POI * TARGETING_TYPE_PROXIMITY_LOCATION_LIST * TARGETING_TYPE_REGIONAL_LOCATION_LIST * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_SUB_EXCHANGE * TARGETING_TYPE_THIRD_PARTY_VERIFIER * TARGETING_TYPE_URL * TARGETING_TYPE_USER_REWARDED_CONTENT * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY

Request body

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'

Output only. Identifies the type of this assigned targeting option.

assignedTargetingOptionIdstring

Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.

assignedTargetingOptionIdAliasstring

Output only. An alias for the assigned_targeting_option_id. This value can be used in place of assignedTargetingOptionId when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * TARGETING_TYPE_AGE_RANGE * TARGETING_TYPE_DEVICE_TYPE * TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION * TARGETING_TYPE_ENVIRONMENT * TARGETING_TYPE_EXCHANGE * TARGETING_TYPE_GENDER * TARGETING_TYPE_HOUSEHOLD_INCOME * TARGETING_TYPE_NATIVE_CONTENT_POSITION * TARGETING_TYPE_OMID * TARGETING_TYPE_PARENTAL_STATUS * TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION * TARGETING_TYPE_VIDEO_PLAYER_SIZE * TARGETING_TYPE_VIEWABILITY This field is also supported for line item assigned targeting options of the following targeting types: * TARGETING_TYPE_CONTENT_INSTREAM_POSITION * TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION

namestring

Output only. The resource name for this assigned targeting option.

inheritance'INHERITANCE_UNSPECIFIED' | 'NOT_INHERITED' | 'INHERITED_FROM_PARTNER' | 'INHERITED_FROM_ADVERTISER'

Output only. The inheritance status of the assigned targeting option.

Response

Successful response