2023-01-21
▼ ▲ displayvideo.advertisers.youtubeAdGroupAds.get
Description: Gets a YouTube ad group ad.
Path: v2/advertisers/{+advertiserId}/youtubeAdGroupAds/{+youtubeAdGroupAdId}
Flat Path: v2/advertisers/{advertisersId}/youtubeAdGroupAds/{youtubeAdGroupAdsId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
youtubeAdGroupAdId
Location: path
Type: string
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the ad group ad to fetch.
Required: Yes
advertiserId
Description: Required. The ID of the advertiser this ad group ad belongs to.
Type: string
Required: Yes
Pattern: ^[^/]+$
Format: int64
Location: path
Parameter Order:
▼ ▲ displayvideo.advertisers.youtubeAdGroupAds.list
Flat Path: v2/advertisers/{advertisersId}/youtubeAdGroupAds
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Description: Lists YouTube ad group ads.
Parameter Order: advertiserId
Path: v2/advertisers/{+advertiserId}/youtubeAdGroupAds
Parameters:
orderBy
Location: query
Type: string
Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
filter
Type: string
Description: Allows filtering by custom YouTube ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. Only the restrictions for * the same field can be combined by `OR`. A sequence of restrictions * implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported properties: - `adGroupId` - `displayName` - `entityStatus` - `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` and its * entityStatus is `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters.
Location: query
pageToken
Location: query
Type: string
Description: 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 `ListYoutubeAdGroupAds` method. If not specified, the first page of results will be returned.
pageSize
Type: integer
Description: Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format: int32
Location: query
advertiserId
Location: path
Description: Required. The ID of the advertiser the ad groups belongs to.
Required: Yes
Pattern: ^[^/]+$
Format: int64
Type: string
▼ ▲ displayvideo.advertisers.youtubeAdGroups.bulkListAdGroupAssignedTargetingOptions
Parameter Order: advertiserId
Flat Path: v2/advertisers/{advertisersId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptions
Parameters:
pageToken
Location: query
Type: string
Description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
pageSize
Type: integer
Format: int32
Location: query
Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
orderBy
Location: query
Type: string
Description: Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
advertiserId
Description: Required. The ID of the advertiser the line items belongs to.
Type: string
Format: int64
Location: path
Pattern: ^[^/]+$
Required: Yes
youtubeAdGroupIds
Format: int64
Location: query
Description: Required. The IDs of the youtube ad groups to list assigned targeting options for.
Repeated: Yes
Type: string
filter
Description: Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_YOUTUBE_VIDEO or TARGETING_TYPE_YOUTUBE_CHANNEL `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters.
Location: query
Type: string
Path: v2/advertisers/{+advertiserId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptions
Scopes: https://www.googleapis.com/auth/display-video
Description: Lists assigned targeting options for multiple YouTube ad groups across targeting types.
HTTP Method: GET
▼ ▲ displayvideo.advertisers.youtubeAdGroups.get
Path: v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}
Description: Gets a YouTube ad group.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Parameters:
youtubeAdGroupId
Type: string
Required: Yes
Format: int64
Pattern: ^[^/]+$
Location: path
Description: Required. The ID of the ad group to fetch.
advertiserId
Pattern: ^[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The ID of the advertiser this ad group belongs to.
Format: int64
Flat Path: v2/advertisers/{advertisersId}/youtubeAdGroups/{youtubeAdGroupsId}
Parameter Order:
▼ ▲ displayvideo.advertisers.youtubeAdGroups.list
Description: Lists YouTube ad groups.
Flat Path: v2/advertisers/{advertisersId}/youtubeAdGroups
Parameters:
filter
Description: Allows filtering by custom YouTube ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. Only the restrictions for * the same field can be combined by `OR`. A sequence of restrictions * implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported properties: - `adGroupId` - `displayName` - `entityStatus` - `lineItemId` - `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters.
Type: string
Location: query
pageSize
Description: 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.
Type: integer
Location: query
Format: int32
advertiserId
Format: int64
Pattern: ^[^/]+$
Type: string
Description: Required. The ID of the advertiser the ad groups belongs to.
Location: path
Required: Yes
orderBy
Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Type: string
Location: query
pageToken
Type: string
Location: query
Description: 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 `ListYoutubeAdGroups` method. If not specified, the first page of results will be returned.
Parameter Order: advertiserId
Scopes: https://www.googleapis.com/auth/display-video
Path: v2/advertisers/{+advertiserId}/youtubeAdGroups
HTTP Method: GET
▼ ▲ displayvideo.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.get
Scopes: https://www.googleapis.com/auth/display-video
Description: Gets a single targeting option assigned to a YouTube ad group. Inherited targeting is not included.
HTTP Method: GET
Parameter Order:
Path: v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameters:
targetingType
Location: path
Required: Yes
Enum:
Pattern: ^[^/]+$
Enum Descriptions:
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Type: string
advertiserId
Location: path
Required: Yes
Format: int64
Description: Required. The ID of the advertiser the ad group belongs to.
Type: string
Pattern: ^[^/]+$
youtubeAdGroupId
Pattern: ^[^/]+$
Format: int64
Type: string
Location: path
Required: Yes
Description: Required. The ID of the ad group the assigned targeting option belongs to.
assignedTargetingOptionId
Type: string
Location: path
Description: Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Pattern: ^[^/]+$
Required: Yes
Flat Path: v2/advertisers/{advertisersId}/youtubeAdGroups/{youtubeAdGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.list
Flat Path: v2/advertisers/{advertisersId}/youtubeAdGroups/{youtubeAdGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description: Lists the targeting options assigned to a YouTube ad group. Inherited targeting is not included.
HTTP Method: GET
Path: v2/advertisers/{+advertiserId}/youtubeAdGroups/{+youtubeAdGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order:
Parameters:
filter
Description: Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters.
Type: string
Location: query
pageSize
Location: query
Type: integer
Format: int32
Description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
advertiserId
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the advertiser the ad group belongs to.
Type: string
Location: path
Required: Yes
orderBy
Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (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: `assignedTargetingOptionId desc`.
Type: string
Location: query
targetingType
Type: string
Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Pattern: ^[^/]+$
Enum:
Enum Descriptions:
Location: path
Required: Yes
pageToken
Description: 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 `ListYoutubeAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location: query
Type: string
youtubeAdGroupId
Required: Yes
Pattern: ^[^/]+$
Description: Required. The ID of the ad group to list assigned targeting options for.
Type: string
Location: path
Format: int64
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
Parameters:
targetingType
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
Enum TARGETING_TYPE_SESSION_POSITION
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Parameters:
targetingType
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
Enum TARGETING_TYPE_SESSION_POSITION
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Parameters:
targetingType
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
Enum TARGETING_TYPE_SESSION_POSITION
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Parameters:
targetingType
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
Enum TARGETING_TYPE_SESSION_POSITION
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Parameters:
targetingType
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
Enum TARGETING_TYPE_SESSION_POSITION
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get
Parameters:
targetingType
Enum TARGETING_TYPE_SESSION_POSITION
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
▼ ▲ displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list
Parameters:
targetingType
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
Enum TARGETING_TYPE_SESSION_POSITION
▼ ▲ displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get
Parameters:
targetingType
Enum Descriptions Target ads to a serve it in a certain position of a session. Only supported for the AdGroup of YouTube Programmatic Reservation line item.
Enum TARGETING_TYPE_SESSION_POSITION