2026-05-26
▼ ▲ displayvideo.media.upload
Description : Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.
Parameters :
resourceName
Required : Yes
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Type : string
Location : path
Pattern : ^.*$
Parameter Order : resourceName
Path : media/{+resourceName}
Supportsmediaupload : Yes
Scopes :
Flat Path : media/{mediaId}
HTTP Method : POST
Mediaupload :
Protocols :
Simple :
Multipart : Yes
Path : /upload/media/{+resourceName}
Accept : */*
▼ ▲ displayvideo.media.download
Scopes :
Path : download/{+resourceName}
HTTP Method : GET
Flat Path : download/{downloadId}
Parameters :
resourceName
Location : path
Pattern : ^.*$
Required : Yes
Type : string
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Description : Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.
Parameter Order : resourceName
Supportsmediadownload : Yes
▼ ▲ displayvideo.customBiddingAlgorithms.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}
HTTP Method : PATCH
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Parameters :
customBiddingAlgorithmId
Pattern : ^[^/]+$
Location : path
Description : Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Type : string
Required : Yes
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
Description : Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Location : query
Format : int64
customBiddingAlgorithmId
Type : string
Description : Required. The ID of the custom bidding algorithm owns the script.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Description : Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.
Parameter Order : customBiddingAlgorithmId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript
HTTP Method : GET
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript
▼ ▲ displayvideo.customBiddingAlgorithms.uploadRules
Parameters :
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
Format : int64
Description : Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.
Parameter Order : customBiddingAlgorithmId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules
HTTP Method : GET
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
▼ ▲ displayvideo.customBiddingAlgorithms.create
Description : Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
HTTP Method : POST
Flat Path : v3/customBiddingAlgorithms
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms
▼ ▲ displayvideo.customBiddingAlgorithms.get
HTTP Method : GET
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Parameter Order : customBiddingAlgorithmId
Parameters :
advertiserId
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Type : string
Location : query
Format : int64
customBiddingAlgorithmId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the custom bidding algorithm to fetch.
Type : string
partnerId
Location : query
Format : int64
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Type : string
Description : Gets a custom bidding algorithm.
▼ ▲ displayvideo.customBiddingAlgorithms.list
Flat Path : v3/customBiddingAlgorithms
HTTP Method : GET
Path : v3/customBiddingAlgorithms
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.
Parameters :
advertiserId
Location : query
Format : int64
Description : The ID of the DV360 advertiser that has access to the custom bidding algorithm.
Type : string
filter
Location : query
Description : Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (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: `displayName desc`.
pageSize
Location : query
Format : int32
Type : integer
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.
pageToken
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 `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
Location : query
▼ ▲ displayvideo.customBiddingAlgorithms.rules.get
Parameter Order :
Parameters :
partnerId
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
Location : query
Format : int64
customBiddingAlgorithmId
Required : Yes
Format : int64
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Type : string
Location : path
Pattern : ^[^/]+$
customBiddingAlgorithmRulesId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the rules resource to fetch.
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Location : query
Format : int64
Description : Retrieves a rules resource.
HTTP Method : GET
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
HTTP Method : GET
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Parameters :
pageSize
Type : integer
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.
Location : query
Format : int32
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 `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.
Type : string
customBiddingAlgorithmId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Type : string
Required : Yes
Format : int64
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Description : Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
HTTP Method : POST
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : customBiddingAlgorithmId
Description : Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error.
Parameters :
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
customBiddingAlgorithmId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Type : string
partnerId
Location : query
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.
Type : string
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
HTTP Method : GET
Description : Gets a custom bidding script.
Parameters :
partnerId
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Location : query
Format : int64
customBiddingAlgorithmId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the custom bidding algorithm owns the script.
Location : path
Pattern : ^[^/]+$
customBiddingScriptId
Description : Required. The ID of the custom bidding script to fetch.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Parameter Order :
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
Parameter Order : customBiddingAlgorithmId
Description : Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
Parameters :
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.
Location : query
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Type : string
Description : Required. The ID of the custom bidding algorithm owns the script.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
pageSize
Location : query
Format : int32
Type : integer
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.
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 `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
Type : string
Location : query
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
HTTP Method : GET
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.create
Description : Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.
Parameters :
partnerId
Location : query
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Type : string
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the custom bidding algorithm that owns the script.
Location : path
Pattern : ^[^/]+$
Parameter Order : customBiddingAlgorithmId
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
HTTP Method : POST
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
Parameter Order : inventorySourceGroupId
Description : Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.
Parameters :
inventorySourceGroupId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the inventory source group to which the assignments are assigned.
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit
HTTP Method : POST
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
Parameter Order : inventorySourceGroupId
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.
Type : string
Location : query
Format : int64
inventorySourceGroupId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the inventory source group to which the assignment will be assigned.
Type : string
Required : Yes
Format : int64
partnerId
Description : The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.
Type : string
Location : query
Format : int64
Description : Creates an assignment between an inventory source and an inventory source group.
HTTP Method : POST
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
HTTP Method : DELETE
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Deletes the assignment between an inventory source and an inventory source group.
Parameters :
assignedInventorySourceId
Type : string
Description : Required. The ID of the assigned inventory source to delete.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.
Type : string
inventorySourceGroupId
Required : Yes
Format : int64
Description : Required. The ID of the inventory source group to which this assignment is assigned.
Type : string
Location : path
Pattern : ^[^/]+$
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
HTTP Method : GET
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceGroupId
Description : Lists inventory sources assigned to an inventory source group.
Parameters :
inventorySourceGroupId
Description : Required. The ID of the inventory source group to which these assignments are assigned.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
partnerId
Description : The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
Type : string
Location : query
Format : int64
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (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: `assignedInventorySourceId desc`.
advertiserId
Description : The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.
Type : string
Location : query
Format : int64
filter
Location : query
Description : Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
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.
Location : query
Format : int32
pageToken
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 `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.
Location : query
▼ ▲ displayvideo.inventorySourceGroups.delete
Description : Deletes an inventory source group.
Parameters :
inventorySourceGroupId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the inventory source group to delete.
partnerId
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Type : string
Location : query
Format : int64
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Type : string
Parameter Order : inventorySourceGroupId
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}
HTTP Method : DELETE
▼ ▲ displayvideo.inventorySourceGroups.patch
Description : Updates an inventory source group. Returns the updated inventory source group if successful.
Parameters :
inventorySourceGroupId
Type : string
Description : Output only. The unique ID of the inventory source group. Assigned by the system.
Required : Yes
Format : int64
Location : path
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Type : string
Parameter Order : inventorySourceGroupId
Path : v3/inventorySourceGroups/{inventorySourceGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupId}
HTTP Method : PATCH
▼ ▲ displayvideo.inventorySourceGroups.get
Description : Gets an inventory source group.
Parameters :
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
inventorySourceGroupId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the inventory source group to fetch.
Type : string
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Parameter Order : inventorySourceGroupId
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}
HTTP Method : GET
▼ ▲ displayvideo.inventorySourceGroups.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/inventorySourceGroups
HTTP Method : GET
Flat Path : v3/inventorySourceGroups
Parameters :
advertiserId
Description : The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Type : string
Location : query
Format : int64
filter
Location : query
Description : Allows filtering by inventory source group fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
partnerId
Type : string
Description : The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
Location : query
Format : int64
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
Location : query
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Format : int32
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Description : Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
▼ ▲ displayvideo.inventorySourceGroups.create
Parameters :
partnerId
Location : query
Format : int64
Description : The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.
Type : string
advertiserId
Description : The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
Type : string
Location : query
Format : int64
Description : Creates a new inventory source group. Returns the newly created inventory source group if successful.
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/inventorySourceGroups
HTTP Method : POST
Flat Path : v3/inventorySourceGroups
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Path : v3/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
HTTP Method : GET
Description : Gets a single targeting option.
Parameters :
targetingOptionId
Type : string
Description : Required. The ID of the of targeting option to retrieve.
Required : Yes
Pattern : ^[^/]+$
Location : path
advertiserId
Location : query
Format : int64
Type : string
Description : Required. The Advertiser this request is being made in the context of.
targetingType
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Type : string
Enum :
Description : Required. The type of targeting option to retrieve. 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`
Required : Yes
Parameter Order :
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Flat Path : v3/targetingTypes/{targetingTypesId}/targetingOptions
HTTP Method : GET
Path : v3/targetingTypes/{+targetingType}/targetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : targetingType
Description : Lists targeting options of a given type.
Parameters :
targetingType
Required : Yes
Description : 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`
Type : string
Enum :
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
orderBy
Location : query
Type : string
Description : 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`.
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Type : string
Location : query
Format : int64
filter
Location : query
Description : 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](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
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
pageToken
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 `ListTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Parameter Order : targetingType
Description : Searches for targeting options of a given type based on the given search terms.
Parameters :
targetingType
Description : Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`
Type : string
Enum :
Required : Yes
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Flat Path : v3/targetingTypes/{targetingTypesId}/targetingOptions:search
HTTP Method : POST
Path : v3/targetingTypes/{+targetingType}/targetingOptions:search
▼ ▲ displayvideo.floodlightGroups.get
Description : Gets a Floodlight group.
Parameters :
floodlightGroupId
Required : Yes
Format : int64
Description : Required. The ID of the Floodlight group to fetch.
Type : string
Location : path
Pattern : ^[^/]+$
partnerId
Type : string
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Format : int64
Parameter Order : floodlightGroupId
Path : v3/floodlightGroups/{+floodlightGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/floodlightGroups/{floodlightGroupsId}
HTTP Method : GET
▼ ▲ displayvideo.floodlightGroups.patch
HTTP Method : PATCH
Flat Path : v3/floodlightGroups/{floodlightGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/floodlightGroups/{floodlightGroupId}
Parameter Order : floodlightGroupId
Parameters :
partnerId
Type : string
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Format : int64
updateMask
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Type : string
floodlightGroupId
Location : path
Required : Yes
Format : int64
Description : Output only. The unique ID of the Floodlight group. Assigned by the system.
Type : string
Description : Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.get
Parameter Order :
Description : Gets a Floodlight activity.
Parameters :
partnerId
Type : string
Description : Required. The ID of the partner through which the Floodlight activity is being accessed.
Location : query
Format : int64
floodlightActivityId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the Floodlight activity to fetch.
floodlightGroupId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
Flat Path : v3/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}
HTTP Method : GET
Path : v3/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.list
Parameter Order : floodlightGroupId
Description : Lists Floodlight activities in a Floodlight group.
Parameters :
floodlightGroupId
Type : string
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
partnerId
Location : query
Format : int64
Description : Required. The ID of the partner through which the Floodlight activities are being accessed.
Type : string
orderBy
Type : string
Description : Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` 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`.
Location : query
pageSize
Location : query
Format : int32
Description : Optional. 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
pageToken
Description : Optional. 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 `ListFloodlightActivities` method. If not specified, the first page of results will be returned.
Type : string
Location : query
Flat Path : v3/floodlightGroups/{floodlightGroupsId}/floodlightActivities
HTTP Method : GET
Path : v3/floodlightGroups/{+floodlightGroupId}/floodlightActivities
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Description : Deletes a negative keyword from a negative keyword list.
Parameters :
negativeKeywordListId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the parent negative keyword list to which the negative keyword belongs.
keywordValue
Required : Yes
Type : string
Description : Required. The keyword value of the negative keyword to delete.
Location : path
Pattern : ^[^/]+$
advertiserId
Location : path
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Parameter Order :
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
Parameter Order :
Parameters :
negativeKeywordListId
Required : Yes
Format : int64
Description : Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Type : string
Location : path
Pattern : ^[^/]+$
advertiserId
Location : path
Required : Yes
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Type : string
Description : Creates a negative keyword in a negative keyword list.
HTTP Method : POST
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Lists negative keywords in a negative keyword list.
Parameters :
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Format : int32
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 `ListNegativeKeywords` method. If not specified, the first page of results will be returned.
Type : string
Location : query
negativeKeywordListId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
Type : string
Required : Yes
Format : int64
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `keywordValue` (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: `keywordValue desc`.
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
Pattern : ^[^/]+$
filter
Type : string
Description : Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace
HTTP Method : POST
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
Parameters :
advertiserId
Location : path
Type : string
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Format : int64
negativeKeywordListId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Required : Yes
Format : int64
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit
Description : Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.
Parameters :
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
negativeKeywordListId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Type : string
Required : Yes
Format : int64
Parameter Order :
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
HTTP Method : POST
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists
HTTP Method : POST
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Description : Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Required : Yes
Format : int64
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Parameter Order :
Description : Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Type : string
negativeKeywordListId
Type : string
Description : Required. The ID of the negative keyword list to fetch.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Description : Lists negative keyword lists based on a given advertiser id.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
Type : string
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Format : int32
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 `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.
Type : string
Location : query
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
Parameters :
negativeKeywordListId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the negative keyword list to delete.
Type : string
advertiserId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Type : string
Required : Yes
Format : int64
Description : Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
negativeKeywordListId
Description : Output only. The unique ID of the negative keyword list. Assigned by the system.
Type : string
Required : Yes
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
Description : Updates a negative keyword list. Returns the updated negative keyword list if successful.
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroupAds.delete
Parameter Order :
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser the ad belongs to.
adGroupAdId
Type : string
Description : Required. The ID of the ad to delete. Only Demand Gen ads are supported.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
▼ ▲ displayvideo.advertisers.adGroupAds.patch
Parameters :
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
advertiserId
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser the ad belongs to.
Location : path
Pattern : ^[^/]+$
adGroupAdId
Type : string
Description : Output only. The unique ID of the ad. Assigned by the system.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
▼ ▲ displayvideo.advertisers.adGroupAds.get
Parameter Order :
Parameters :
adGroupAdId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the ad to fetch.
Location : path
Pattern : ^[^/]+$
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser this ad group ad belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
Description : Gets an ad group ad.
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
▼ ▲ displayvideo.advertisers.adGroupAds.list
Description : Lists ad group ads.
Parameters :
pageSize
Type : integer
Description : Optional. 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.
Location : query
Format : int32
pageToken
Location : query
Description : Optional. 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 `ListAdGroupAds` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Description : Required. The ID of the advertiser the ads belong to.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
filter
Location : query
Description : Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
orderBy
Location : query
Type : string
Description : Optional. 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`.
Parameter Order : advertiserId
Path : v3/advertisers/{+advertiserId}/adGroupAds
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/adGroupAds
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adGroupAds.create
Parameter Order : advertiserId
Description : Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Output only. The unique ID of the advertiser the ad belongs to.
Type : string
Flat Path : v3/advertisers/{advertisersId}/adGroupAds
HTTP Method : POST
Path : v3/advertisers/{+advertiserId}/adGroupAds
▼ ▲ displayvideo.advertisers.creatives.create
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/creatives
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/creatives
Parameter Order : advertiserId
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser the creative belongs to.
Description : Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
▼ ▲ displayvideo.advertisers.creatives.get
Parameter Order :
Description : Gets a creative.
Parameters :
advertiserId
Description : Required. The ID of the advertiser this creative belongs to.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
creativeId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the creative to fetch.
Type : string
Flat Path : v3/advertisers/{advertisersId}/creatives/{creativesId}
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/creatives/{+creativeId}
▼ ▲ displayvideo.advertisers.creatives.list
Flat Path : v3/advertisers/{advertisersId}/creatives
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/creatives
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Description : Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`.
Type : string
Location : query
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser to list creatives for.
Type : string
Location : path
Pattern : ^[^/]+$
filter
Location : query
Type : string
Description : Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
pageSize
Location : query
Format : int32
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
pageToken
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 `ListCreatives` method. If not specified, the first page of results will be returned.
Type : string
▼ ▲ displayvideo.advertisers.creatives.patch
Description : Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
Parameters :
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Location : query
Format : google-fieldmask
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser the creative belongs to.
creativeId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Output only. The unique ID of the creative. Assigned by the system.
Type : string
Parameter Order :
Path : v3/advertisers/{+advertiserId}/creatives/{+creativeId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/creatives/{creativesId}
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.creatives.delete
Parameter Order :
Description : Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Description : The ID of the advertiser this creative belongs to.
Type : string
Required : Yes
Format : int64
creativeId
Description : The ID of the creative to be deleted.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Flat Path : v3/advertisers/{advertisersId}/creatives/{creativesId}
HTTP Method : DELETE
Path : v3/advertisers/{+advertiserId}/creatives/{+creativeId}
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Parameter Order :
Description : Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
Parameters :
advertiserId
Description : Required. The ID of the advertiser the ad group belongs to.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
assignedTargetingOptionId
Pattern : ^[^/]+$
Location : path
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Type : string
Required : Yes
adGroupId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Required : Yes
Format : int64
targetingType
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Type : string
Enum :
Description : 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_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
Parameters :
pageSize
Type : integer
Description : Optional. 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.
Location : query
Format : int32
pageToken
Location : query
Type : string
Description : Optional. 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 `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
adGroupId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the ad group to list assigned targeting options for.
Type : string
Required : Yes
Format : int64
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser the ad group belongs to.
filter
Location : query
Type : string
Description : Optional. Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
targetingType
Type : string
Enum :
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Required : Yes
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
orderBy
Location : query
Type : string
Description : Optional. 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`.
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create
Parameters :
advertiserId
Type : string
Description : Required. The ID of the advertiser the ad group belongs to.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
adGroupId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the ad group the assigned targeting option will belong to.
targetingType
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Type : string
Enum :
Required : Yes
Description : Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : DELETE
Description : Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameters :
adGroupId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Required : Yes
Format : int64
targetingType
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Type : string
Enum :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
assignedTargetingOptionId
Required : Yes
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Location : path
Pattern : ^[^/]+$
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser the ad group belongs to.
Location : path
Pattern : ^[^/]+$
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.create
Path : v3/advertisers/{+advertiserId}/adGroups
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/adGroups
HTTP Method : POST
Description : Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameters :
advertiserId
Type : string
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.adGroups.get
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the advertiser this ad group belongs to.
Type : string
adGroupId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the ad group to fetch.
Description : Gets an ad group.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}
▼ ▲ displayvideo.advertisers.adGroups.list
Parameter Order : advertiserId
Description : Lists ad groups.
Parameters :
pageSize
Description : Optional. 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
pageToken
Location : query
Description : Optional. 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 `ListAdGroups` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Description : Required. The ID of the advertiser the ad groups belongs to.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
filter
Description : Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. 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` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
orderBy
Type : string
Description : Optional. 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`.
Location : query
Flat Path : v3/advertisers/{advertisersId}/adGroups
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/adGroups
▼ ▲ displayvideo.advertisers.adGroups.bulkListAdGroupAssignedTargetingOptions
Parameter Order : advertiserId
Parameters :
pageSize
Type : integer
Description : Optional. 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.
Location : query
Format : int32
pageToken
Location : query
Description : Optional. 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.
Type : string
orderBy
Location : query
Type : string
Description : Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (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
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
filter
Location : query
Type : string
Description : Optional. Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
adGroupIds
Location : query
Repeated : Yes
Format : int64
Description : Required. The IDs of the ad groups to list assigned targeting options for.
Type : string
Description : Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/adGroups:bulkListAdGroupAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroups:bulkListAdGroupAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions
Parameter Order : advertiserId
Description : Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser the ad groups belong to.
Flat Path : v3/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions
HTTP Method : POST
Path : v3/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.delete
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the advertiser this ad group belongs to.
Required : Yes
Format : int64
adGroupId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the ad group to delete.
Required : Yes
Format : int64
Description : Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.patch
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}
HTTP Method : PATCH
Description : Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameters :
adGroupId
Type : string
Description : Output only. The unique ID of the ad group. Assigned by the system.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
updateMask
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Type : string
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Parameter Order :
▼ ▲ displayvideo.advertisers.assets.upload
HTTP Method : POST
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/v3/advertisers/{+advertiserId}/assets
Multipart : Yes
Flat Path : v3/advertisers/{advertisersId}/assets
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/assets
Supportsmediaupload : Yes
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser this asset belongs to.
Location : path
Pattern : ^[^/]+$
Description : Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the advertiser.
Type : string
targetingType
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Type : string
Enum :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
Description : Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Parameter Order :
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
Parameters :
targetingType
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Type : string
Enum :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
Required : Yes
assignedTargetingOptionId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Required : Yes
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser.
Location : path
Pattern : ^[^/]+$
Description : Deletes an assigned targeting option from an advertiser.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the advertiser.
Required : Yes
Format : int64
targetingType
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`
Type : string
Enum :
Required : Yes
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
Description : Gets a single targeting option assigned to an advertiser.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
Description : Lists the targeting options assigned to an advertiser.
Parameters :
targetingType
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`
Type : string
Enum :
Required : Yes
orderBy
Location : query
Type : string
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`.
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser.
Type : string
Location : path
Pattern : ^[^/]+$
filter
Location : query
Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
pageSize
Type : integer
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.
Location : query
Format : int32
pageToken
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 `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.list
Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : GET
Description : Lists locations assigned to a location list.
Parameters :
locationListId
Required : Yes
Format : int64
Description : Required. The ID of the location list to which these assignments are assigned.
Type : string
Location : path
pageSize
Location : query
Format : int32
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
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 `ListAssignedLocations` method. If not specified, the first page of results will be returned.
Type : string
Location : query
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `assignedLocationId` (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: `assignedLocationId desc`.
Type : string
advertiserId
Location : path
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
filter
Description : Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
Description : Creates an assignment between a location and a location list.
Parameters :
locationListId
Description : Required. The ID of the location list for which the assignment will be created.
Type : string
Required : Yes
Format : int64
Location : path
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Type : string
Required : Yes
Format : int64
Location : path
Parameter Order :
Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : POST
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
Parameters :
locationListId
Required : Yes
Format : int64
Description : Required. The ID of the location list to which this assignment is assigned.
Type : string
Location : path
advertiserId
Location : path
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Format : int64
assignedLocationId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the assigned location to delete.
Type : string
Required : Yes
Format : int64
Description : Deletes the assignment between a location and a location list.
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
HTTP Method : POST
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit
Parameter Order :
Parameters :
locationListId
Required : Yes
Format : int64
Description : Required. The ID of the location list to which these assignments are assigned.
Type : string
Location : path
Pattern : ^[^/]+$
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Type : string
Required : Yes
Format : int64
Location : path
Description : Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.
▼ ▲ displayvideo.advertisers.locationLists.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/locationLists/{locationListId}
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/locationLists/{locationListId}
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location lists belongs.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
locationListId
Location : path
Type : string
Description : Output only. The unique ID of the location list. Assigned by the system.
Required : Yes
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
Description : Updates a location list. Returns the updated location list if successful.
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.create
Parameter Order : advertiserId
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Format : int64
Description : Creates a new location list. Returns the newly created location list if successful.
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/locationLists
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/locationLists
▼ ▲ displayvideo.advertisers.locationLists.get
Path : v3/advertisers/{+advertiserId}/locationLists/{+locationListId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/locationLists/{locationListsId}
HTTP Method : GET
Description : Gets a location list.
Parameters :
locationListId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the location list to fetch.
Type : string
advertiserId
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.list
Path : v3/advertisers/{+advertiserId}/locationLists
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/locationLists
HTTP Method : GET
Description : Lists location lists based on a given advertiser id.
Parameters :
pageSize
Location : query
Format : int32
Type : integer
Description : Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken
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 `ListLocationLists` method. If not specified, the first page of results will be returned.
Location : query
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` 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
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Required : Yes
Format : int64
filter
Location : query
Type : string
Description : Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.insertionOrders.create
Parameter Order : advertiserId
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Required : Yes
Format : int64
Description : Creates a new insertion order. Returns the newly created insertion order if successful.
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/insertionOrders
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/insertionOrders
▼ ▲ displayvideo.advertisers.insertionOrders.get
Flat Path : v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
Parameters :
advertiserId
Type : string
Description : Required. The ID of the advertiser this insertion order belongs to.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
insertionOrderId
Required : Yes
Format : int64
Description : Required. The ID of the insertion order to fetch.
Type : string
Location : path
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.insertionOrders.list
Parameters :
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.
Location : query
Format : int32
pageToken
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 `ListInsertionOrders` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Type : string
Description : Required. The ID of the advertiser to list insertion orders for.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
filter
Location : query
Type : string
Description : Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy
Description : Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" 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
Description : Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/insertionOrders
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/insertionOrders
▼ ▲ displayvideo.advertisers.insertionOrders.patch
Parameter Order :
Parameters :
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Type : string
insertionOrderId
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the insertion order. Assigned by the system.
Location : path
Pattern : ^[^/]+$
Description : Updates an existing insertion order. Returns the updated insertion order if successful.
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
▼ ▲ displayvideo.advertisers.insertionOrders.delete
Path : v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
HTTP Method : DELETE
Description : Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
Parameters :
advertiserId
Required : Yes
Format : int64
Description : The ID of the advertiser this insertion order belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
insertionOrderId
Pattern : ^[^/]+$
Location : path
Description : The ID of the insertion order to delete.
Type : string
Required : Yes
Format : int64
Parameter Order :
▼ ▲ displayvideo.advertisers.lineItems.list
Flat Path : v3/advertisers/{advertisersId}/lineItems
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Description : Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Parameters :
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` 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
advertiserId
Type : string
Description : Required. The ID of the advertiser to list line items for.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
filter
Description : Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
pageSize
Type : integer
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.
Location : query
Format : int32
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 `ListLineItems` method. If not specified, the first page of results will be returned.
▼ ▲ displayvideo.advertisers.lineItems.create
Description : Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Output only. The unique ID of the advertiser the line item belongs to.
Required : Yes
Format : int64
Parameter Order : advertiserId
Path : v3/advertisers/{+advertiserId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/lineItems
HTTP Method : POST
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
Parameter Order : advertiserId
Description : Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
Parameters :
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser the line items belong to.
Type : string
Location : path
Pattern : ^[^/]+$
Flat Path : v3/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions
HTTP Method : POST
Path : v3/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.duplicate
Description : Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser this line item belongs to.
lineItemId
Description : Required. The ID of the line item to duplicate.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Parameter Order :
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
HTTP Method : POST
▼ ▲ displayvideo.advertisers.lineItems.patch
Parameters :
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
lineItemId
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the line item. Assigned by the system.
Location : path
Pattern : ^[^/]+$
advertiserId
Required : Yes
Format : int64
Description : Output only. The unique ID of the advertiser the line item belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
Description : Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
▼ ▲ displayvideo.advertisers.lineItems.get
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
Parameters :
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser this line item belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
lineItemId
Type : string
Description : Required. The ID of the line item to fetch.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Gets a line item.
Parameter Order :
▼ ▲ displayvideo.advertisers.lineItems.bulkUpdate
Flat Path : v3/advertisers/{advertisersId}/lineItems:bulkUpdate
HTTP Method : POST
Path : v3/advertisers/{+advertiserId}/lineItems:bulkUpdate
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Description : Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser this line item belongs to.
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple line items across targeting types.
Parameters :
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `lineItemId` (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`.
Type : string
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser the line items belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
filter
Location : query
Type : string
Description : Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
lineItemIds
Location : query
Repeated : Yes
Format : int64
Type : string
Description : Required. The IDs of the line items to list assigned targeting options for.
pageSize
Location : query
Format : int32
Type : integer
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.
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 `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Parameter Order : advertiserId
Path : v3/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
HTTP Method : GET
▼ ▲ displayvideo.advertisers.lineItems.delete
Description : Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.
Parameters :
advertiserId
Required : Yes
Format : int64
Description : The ID of the advertiser this line item belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
lineItemId
Required : Yes
Format : int64
Description : The ID of the line item to delete.
Type : string
Location : path
Pattern : ^[^/]+$
Parameter Order :
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : POST
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : 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.
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Type : string
Required : Yes
Format : int64
lineItemId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the line item the assigned targeting option will belong to.
Type : string
Required : Yes
Format : int64
targetingType
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Type : string
Enum :
Description : 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`
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
Parameter Order :
Parameters :
lineItemId
Required : Yes
Format : int64
Description : Required. The ID of the line item the assigned targeting option belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
targetingType
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Type : string
Enum :
Description : 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`
assignedTargetingOptionId
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Required : Yes
Pattern : ^[^/]+$
Location : path
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser the line item belongs to.
Location : path
Pattern : ^[^/]+$
Description : Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Gets a single targeting option assigned to a line item.
Parameters :
assignedTargetingOptionId
Required : Yes
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Type : string
Location : path
Pattern : ^[^/]+$
lineItemId
Description : Required. The ID of the line item the assigned targeting option belongs to.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
targetingType
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Description : 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` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)
Type : string
Enum :
advertiserId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser the line item belongs to.
Location : path
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
Description : Lists the targeting options assigned to a line item.
Parameters :
targetingType
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Required : Yes
Description : Required. Identifies the type of assigned targeting options to list. 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` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)
Type : string
Enum :
orderBy
Location : query
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
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Type : string
filter
Description : Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
lineItemId
Type : string
Description : Required. The ID of the line item to list assigned targeting options for.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
pageSize
Location : query
Format : int32
Type : integer
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.
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 `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Parameter Order :
▼ ▲ displayvideo.advertisers.campaigns.delete
Scopes :
Path : v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/campaigns/{campaignsId}
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : The ID of the advertiser this campaign belongs to.
campaignId
Required : Yes
Format : int64
Type : string
Description : The ID of the campaign we need to delete.
Location : path
Pattern : ^[^/]+$
Description : Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Parameter Order :
▼ ▲ displayvideo.advertisers.campaigns.patch
Parameters :
campaignId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the campaign. Assigned by the system.
updateMask
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Type : string
advertiserId
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Location : path
Pattern : ^[^/]+$
Description : Updates an existing campaign. Returns the updated campaign if successful.
Parameter Order :
Scopes :
Path : v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.campaigns.get
Path : v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
Scopes :
Flat Path : v3/advertisers/{advertisersId}/campaigns/{campaignsId}
HTTP Method : GET
Description : Gets a campaign.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the advertiser this campaign belongs to.
campaignId
Type : string
Description : Required. The ID of the campaign to fetch.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Parameter Order :
▼ ▲ displayvideo.advertisers.campaigns.list
Description : Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Parameters :
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` 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`.
Location : query
advertiserId
Description : The ID of the advertiser to list campaigns for.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
filter
Type : string
Description : Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
pageSize
Location : query
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
pageToken
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 `ListCampaigns` method. If not specified, the first page of results will be returned.
Type : string
Parameter Order : advertiserId
Path : v3/advertisers/{+advertiserId}/campaigns
Scopes :
Flat Path : v3/advertisers/{advertisersId}/campaigns
HTTP Method : GET
▼ ▲ displayvideo.advertisers.campaigns.create
Scopes :
Path : v3/advertisers/{+advertiserId}/campaigns
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/campaigns
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Creates a new campaign. Returns the newly created campaign if successful.
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.channels.get
Flat Path : v3/advertisers/{advertisersId}/channels/{channelsId}
HTTP Method : GET
Path : v3/advertisers/{+advertiserId}/channels/{+channelId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Gets a channel for a partner or advertiser.
Parameters :
advertiserId
Type : string
Description : The ID of the advertiser that owns the fetched channel.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the fetched channel.
channelId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the channel to fetch.
Location : path
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.channels.list
Parameters :
partnerId
Location : query
Format : int64
Description : The ID of the partner that owns the channels.
Type : string
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` 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`.
advertiserId
Required : Yes
Format : int64
Description : The ID of the advertiser that owns the channels.
Type : string
Location : path
Pattern : ^[^/]+$
filter
Location : query
Type : string
Description : Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
pageSize
Location : query
Format : int32
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
pageToken
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 `ListChannels` method. If not specified, the first page of results will be returned.
Type : string
Description : Lists channels for a partner or advertiser.
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/channels
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/channels
▼ ▲ displayvideo.advertisers.channels.create
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/channels
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/channels
Parameter Order : advertiserId
Parameters :
advertiserId
Type : string
Description : The ID of the advertiser that owns the created channel.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the created channel.
Description : Creates a new channel. Returns the newly created channel if successful.
▼ ▲ displayvideo.advertisers.channels.patch
Flat Path : v3/advertisers/{advertisersId}/channels/{channelId}
HTTP Method : PATCH
Path : v3/advertisers/{+advertiserId}/channels/{channelId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Updates a channel. Returns the updated channel if successful.
Parameters :
advertiserId
Required : Yes
Format : int64
Description : The ID of the advertiser that owns the created channel.
Type : string
Location : path
Pattern : ^[^/]+$
channelId
Description : Output only. The unique ID of the channel. Assigned by the system.
Type : string
Required : Yes
Format : int64
Location : path
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Required. The mask to control which fields to update.
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the created channel.
▼ ▲ displayvideo.advertisers.channels.sites.delete
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
Parameters :
urlOrAppId
Type : string
Description : Required. The URL or app ID of the site to delete.
Required : Yes
Pattern : ^[^/]+$
Location : path
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Type : string
Required : Yes
Format : int64
Location : path
channelId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the parent channel to which the site belongs.
Type : string
Required : Yes
Format : int64
partnerId
Description : The ID of the partner that owns the parent channel.
Type : string
Location : query
Format : int64
Description : Deletes a site from a channel.
Parameter Order :
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
Parameter Order :
Description : Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
Parameters :
advertiserId
Required : Yes
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Type : string
Location : path
channelId
Required : Yes
Format : int64
Description : Required. The ID of the parent channel to which the sites belong.
Type : string
Location : path
Pattern : ^[^/]+$
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
HTTP Method : POST
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit
▼ ▲ displayvideo.advertisers.channels.sites.replace
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites:replace
HTTP Method : POST
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites:replace
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Parameters :
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Format : int64
Location : path
channelId
Type : string
Description : Required. The ID of the parent channel whose sites will be replaced.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
▼ ▲ displayvideo.advertisers.channels.sites.list
Path : v3/advertisers/{+advertiserId}/channels/{+channelId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}/channels/{channelsId}/sites
HTTP Method : GET
Description : Lists sites in a channel.
Parameters :
advertiserId
Required : Yes
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent channel.
Location : path
Pattern : ^[^/]+$
filter
Location : query
Type : string
Description : Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that owns the parent channel.
orderBy
Description : Field by which to sort the list. Acceptable values are: * `urlOrAppId` (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: `urlOrAppId desc`.
Type : string
Location : query
channelId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the parent channel to which the requested sites belong.
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
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 `ListSites` method. If not specified, the first page of results will be returned.
Type : string
Location : query
Parameter Order :
▼ ▲ displayvideo.advertisers.channels.sites.create
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites
HTTP Method : POST
Description : Creates a site in a channel.
Parameters :
partnerId
Type : string
Description : The ID of the partner that owns the parent channel.
Location : query
Format : int64
channelId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the parent channel in which the site will be created.
Type : string
Required : Yes
Format : int64
advertiserId
Location : path
Required : Yes
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent channel.
Parameter Order :
▼ ▲ displayvideo.advertisers.invoices.list
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/invoices
Scopes :
Path : v3/advertisers/{+advertiserId}/invoices
Parameter Order : advertiserId
Parameters :
advertiserId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the advertiser to list invoices for.
Required : Yes
Format : int64
loiSapinInvoiceType
Type : string
Enum :
Description : Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
Enum Descriptions :
Location : query
issueMonth
Location : query
Description : The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.
Type : string
pageSize
Type : integer
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.
Location : query
Format : int32
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 `ListInvoices` method. If not specified, the first page of results will be returned.
Description : Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Description : Retrieves the invoice currency used by an advertiser in a given month.
Parameters :
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser to lookup currency for.
Type : string
Location : path
Pattern : ^[^/]+$
invoiceMonth
Type : string
Description : Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
Location : query
Parameter Order : advertiserId
Path : v3/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
Scopes :
Flat Path : v3/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
HTTP Method : GET
▼ ▲ displayvideo.advertisers.patch
Parameter Order : advertiserId
Description : Updates an existing advertiser. Returns the updated advertiser if successful.
Parameters :
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Required. The mask to control which fields to update.
advertiserId
Required : Yes
Format : int64
Type : string
Description : Output only. The unique ID of the advertiser. Assigned by the system.
Location : path
Pattern : ^[^/]+$
Flat Path : v3/advertisers/{advertisersId}
HTTP Method : PATCH
Path : v3/advertisers/{+advertiserId}
▼ ▲ displayvideo.advertisers.delete
Path : v3/advertisers/{+advertiserId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}
HTTP Method : DELETE
Description : Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.
Parameters :
advertiserId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : The ID of the advertiser we need to delete.
Type : string
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.audit
Description : Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.
Parameters :
advertiserId
Type : string
Description : Required. The ID of the advertiser to audit.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
readMask
Location : query
Format : google-fieldmask
Description : Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount
Type : string
Parameter Order : advertiserId
Path : v3/advertisers/{+advertiserId}:audit
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}:audit
HTTP Method : GET
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Path : v3/advertisers/{+advertiserId}:listAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/advertisers/{advertisersId}:listAssignedTargetingOptions
HTTP Method : GET
Description : Lists assigned targeting options of an advertiser across targeting types.
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `targetingType` (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: `targetingType desc`.
Type : string
Location : query
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Type : string
Location : path
Pattern : ^[^/]+$
filter
Type : string
Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
pageSize
Type : integer
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.
Location : query
Format : int32
pageToken
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 `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
Location : query
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.create
Description : Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
HTTP Method : POST
Flat Path : v3/advertisers
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers
▼ ▲ displayvideo.advertisers.editAssignedTargetingOptions
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}:editAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}:editAssignedTargetingOptions
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Format : int64
Description : Required. The ID of the advertiser.
Type : string
Location : path
Pattern : ^[^/]+$
Description : Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
▼ ▲ displayvideo.advertisers.get
Parameters :
advertiserId
Description : Required. The ID of the advertiser to fetch.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
Description : Gets an advertiser.
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.list
Parameters :
filter
Location : query
Description : Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
partnerId
Location : query
Format : int64
Type : string
Description : Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.
orderBy
Description : Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
Type : string
Location : query
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Format : int32
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 `ListAdvertisers` method. If not specified, the first page of results will be returned.
Description : Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers
HTTP Method : GET
Flat Path : v3/advertisers
▼ ▲ displayvideo.firstAndThirdPartyAudiences.patch
Description : Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Parameters :
advertiserId
Location : query
Format : int64
Description : Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.
Type : string
firstAndThirdPartyAudienceId
Description : Output only. The unique ID of the first and third party audience. Assigned by the system.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
updateMask
Description : Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
Type : string
Location : query
Format : google-fieldmask
Parameter Order : firstAndThirdPartyAudienceId
Path : v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
HTTP Method : PATCH
▼ ▲ displayvideo.firstAndThirdPartyAudiences.create
Path : v3/firstAndThirdPartyAudiences
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/firstAndThirdPartyAudiences
HTTP Method : POST
Description : Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Parameters :
advertiserId
Location : query
Format : int64
Type : string
Description : Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.
▼ ▲ displayvideo.firstAndThirdPartyAudiences.get
Parameter Order : firstAndThirdPartyAudienceId
Description : Gets a first and third party audience.
Parameters :
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that has access to the fetched first and third party audience.
Type : string
firstAndThirdPartyAudienceId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the first and third party audience to fetch.
Location : path
Pattern : ^[^/]+$
partnerId
Description : The ID of the partner that has access to the fetched first and third party audience.
Type : string
Location : query
Format : int64
Flat Path : v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
HTTP Method : GET
Path : v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
▼ ▲ displayvideo.firstAndThirdPartyAudiences.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/firstAndThirdPartyAudiences
HTTP Method : GET
Flat Path : v3/firstAndThirdPartyAudiences
Parameters :
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that has access to the fetched first and third party audiences.
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` 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`.
Location : query
advertiserId
Description : The ID of the advertiser that has access to the fetched first and third party audiences.
Type : string
Location : query
Format : int64
filter
Location : query
Type : string
Description : Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Format : int32
pageToken
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 `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.
Location : query
Description : Lists first and third party audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers
Flat Path : v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers
HTTP Method : POST
Path : v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : firstAndThirdPartyAudienceId
Description : Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Parameters :
firstAndThirdPartyAudienceId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.
Location : path
Pattern : ^[^/]+$
▼ ▲ displayvideo.sdfdownloadtasks.operations.get
HTTP Method : GET
Flat Path : v3/sdfdownloadtasks/operations/{operationsId}
Scopes :
Path : v3/{+name}
Parameter Order : name
Parameters :
name
Pattern : ^sdfdownloadtasks/operations/[^/]+$
Location : path
Type : string
Description : The name of the operation resource.
Required : Yes
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
▼ ▲ displayvideo.sdfdownloadtasks.create
HTTP Method : POST
Flat Path : v3/sdfdownloadtasks
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/sdfdownloadtasks
Description : Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty.
▼ ▲ displayvideo.guaranteedOrders.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/guaranteedOrders/{+guaranteedOrderId}
HTTP Method : PATCH
Flat Path : v3/guaranteedOrders/{guaranteedOrdersId}
Parameters :
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that the request is being made within.
guaranteedOrderId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Required : Yes
partnerId
Description : The ID of the partner that the request is being made within.
Type : string
Location : query
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
Description : Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Parameter Order : guaranteedOrderId
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Path : v3/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
HTTP Method : POST
Description : Edits read advertisers of a guaranteed order.
Parameters :
guaranteedOrderId
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Parameter Order : guaranteedOrderId
▼ ▲ displayvideo.guaranteedOrders.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/guaranteedOrders
HTTP Method : POST
Flat Path : v3/guaranteedOrders
Parameters :
partnerId
Description : The ID of the partner that the request is being made within.
Type : string
Location : query
Format : int64
advertiserId
Type : string
Description : The ID of the advertiser that the request is being made within.
Location : query
Format : int64
Description : Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
▼ ▲ displayvideo.guaranteedOrders.get
Description : Gets a guaranteed order.
Parameters :
partnerId
Location : query
Format : int64
Description : The ID of the partner that has access to the guaranteed order.
Type : string
advertiserId
Type : string
Description : The ID of the advertiser that has access to the guaranteed order.
Location : query
Format : int64
guaranteedOrderId
Description : Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
Parameter Order : guaranteedOrderId
Path : v3/guaranteedOrders/{+guaranteedOrderId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/guaranteedOrders/{guaranteedOrdersId}
HTTP Method : GET
▼ ▲ displayvideo.guaranteedOrders.list
Description : Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Parameters :
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that has access to the guaranteed order.
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that has access to the guaranteed order.
Type : string
filter
Location : query
Description : Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
pageToken
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 `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.
Type : string
Path : v3/guaranteedOrders
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/guaranteedOrders
HTTP Method : GET
▼ ▲ displayvideo.users.delete
Description : Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Parameters :
userId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the user to delete.
Type : string
Required : Yes
Format : int64
Parameter Order : userId
Path : v3/users/{+userId}
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v3/users/{usersId}
HTTP Method : DELETE
▼ ▲ displayvideo.users.patch
Scopes : https://www.googleapis.com/auth/display-video-user-management
Path : v3/users/{+userId}
HTTP Method : PATCH
Flat Path : v3/users/{usersId}
Parameters :
userId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Output only. The unique ID of the user. Assigned by the system.
Type : string
updateMask
Location : query
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Type : string
Description : Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Parameter Order : userId
▼ ▲ displayvideo.users.create
Description : Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
HTTP Method : POST
Flat Path : v3/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
Path : v3/users
▼ ▲ displayvideo.users.get
Parameter Order : userId
Description : Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Parameters :
userId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the user to fetch.
Location : path
Pattern : ^[^/]+$
Flat Path : v3/users/{usersId}
HTTP Method : GET
Path : v3/users/{+userId}
Scopes : https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.users.list
Description : Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Parameters :
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
Location : query
pageSize
Location : query
Format : int32
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
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 `ListUsers` method. If not specified, the first page of results will be returned.
filter
Location : query
Description : Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Path : v3/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v3/users
HTTP Method : GET
▼ ▲ displayvideo.users.bulkEditAssignedUserRoles
Path : v3/users/{+userId}:bulkEditAssignedUserRoles
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v3/users/{usersId}:bulkEditAssignedUserRoles
HTTP Method : POST
Description : Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Parameters :
userId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the user to which the assigned user roles belong.
Parameter Order : userId
▼ ▲ displayvideo.customLists.get
HTTP Method : GET
Flat Path : v3/customLists/{customListsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customLists/{+customListId}
Parameter Order : customListId
Parameters :
customListId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the custom list to fetch.
Type : string
advertiserId
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Type : string
Location : query
Format : int64
Description : Gets a custom list.
▼ ▲ displayvideo.customLists.list
Path : v3/customLists
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/customLists
HTTP Method : GET
Description : Lists custom lists. The order is defined by the order_by parameter.
Parameters :
advertiserId
Location : query
Format : int64
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Type : string
filter
Description : Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` 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`.
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
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 `ListCustomLists` method. If not specified, the first page of results will be returned.
Type : string
Location : query
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
Description : Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .
Parameters :
partnerId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the partner.
Parameter Order : partnerId
Path : v3/partners/{+partnerId}:editAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/partners/{partnersId}:editAssignedTargetingOptions
HTTP Method : POST
▼ ▲ displayvideo.partners.get
Parameter Order : partnerId
Description : Gets a partner.
Parameters :
partnerId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the partner to fetch.
Type : string
Flat Path : v3/partners/{partnersId}
HTTP Method : GET
Path : v3/partners/{+partnerId}
▼ ▲ displayvideo.partners.list
Description : Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
Parameters :
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Format : int32
pageToken
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 `ListPartners` method. If not specified, the first page of results will be returned.
Location : query
filter
Location : query
Type : string
Description : Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
Flat Path : v3/partners
HTTP Method : GET
Path : v3/partners
▼ ▲ displayvideo.partners.channels.sites.delete
Parameters :
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent channel.
urlOrAppId
Required : Yes
Type : string
Description : Required. The URL or app ID of the site to delete.
Location : path
Pattern : ^[^/]+$
partnerId
Location : path
Type : string
Description : The ID of the partner that owns the parent channel.
Required : Yes
Format : int64
channelId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : Required. The ID of the parent channel to which the site belongs.
Type : string
Description : Deletes a site from a channel.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
HTTP Method : DELETE
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.partners.channels.sites.replace
Path : v3/partners/{partnerId}/channels/{+channelId}/sites:replace
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites:replace
HTTP Method : POST
Description : Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Parameters :
partnerId
Location : path
Type : string
Description : The ID of the partner that owns the parent channel.
Required : Yes
Format : int64
channelId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the parent channel whose sites will be replaced.
Parameter Order :
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit
HTTP Method : POST
Path : v3/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
Parameters :
partnerId
Type : string
Description : The ID of the partner that owns the parent channel.
Required : Yes
Format : int64
Location : path
channelId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the parent channel to which the sites belong.
Type : string
Required : Yes
Format : int64
▼ ▲ displayvideo.partners.channels.sites.create
Parameters :
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the parent channel.
channelId
Description : Required. The ID of the parent channel in which the site will be created.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
partnerId
Description : The ID of the partner that owns the parent channel.
Type : string
Required : Yes
Format : int64
Location : path
Description : Creates a site in a channel.
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/partners/{partnerId}/channels/{+channelId}/sites
HTTP Method : POST
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites
▼ ▲ displayvideo.partners.channels.sites.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/partners/{+partnerId}/channels/{+channelId}/sites
HTTP Method : GET
Flat Path : v3/partners/{partnersId}/channels/{channelsId}/sites
Parameters :
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location : query
Format : int32
pageToken
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 `ListSites` method. If not specified, the first page of results will be returned.
Location : query
channelId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the parent channel to which the requested sites belong.
Required : Yes
Format : int64
partnerId
Type : string
Description : The ID of the partner that owns the parent channel.
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
orderBy
Type : string
Description : Field by which to sort the list. Acceptable values are: * `urlOrAppId` (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: `urlOrAppId desc`.
Location : query
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Type : string
Location : query
Format : int64
filter
Type : string
Description : Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Description : Lists sites in a channel.
Parameter Order :
▼ ▲ displayvideo.partners.channels.patch
Flat Path : v3/partners/{partnersId}/channels/{channelId}
HTTP Method : PATCH
Path : v3/partners/{+partnerId}/channels/{channelId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Description : Updates a channel. Returns the updated channel if successful.
Parameters :
partnerId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : The ID of the partner that owns the created channel.
channelId
Location : path
Description : Output only. The unique ID of the channel. Assigned by the system.
Type : string
Required : Yes
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Location : query
Format : google-fieldmask
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that owns the created channel.
▼ ▲ displayvideo.partners.channels.create
Parameter Order : partnerId
Description : Creates a new channel. Returns the newly created channel if successful.
Parameters :
partnerId
Description : The ID of the partner that owns the created channel.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
advertiserId
Description : The ID of the advertiser that owns the created channel.
Type : string
Location : query
Format : int64
Flat Path : v3/partners/{partnersId}/channels
HTTP Method : POST
Path : v3/partners/{+partnerId}/channels
▼ ▲ displayvideo.partners.channels.get
Description : Gets a channel for a partner or advertiser.
Parameters :
partnerId
Required : Yes
Format : int64
Type : string
Description : The ID of the partner that owns the fetched channel.
Location : path
Pattern : ^[^/]+$
channelId
Description : Required. The ID of the channel to fetch.
Type : string
Required : Yes
Format : int64
Pattern : ^[^/]+$
Location : path
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the fetched channel.
Type : string
Parameter Order :
Path : v3/partners/{+partnerId}/channels/{+channelId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/partners/{partnersId}/channels/{channelsId}
HTTP Method : GET
▼ ▲ displayvideo.partners.channels.list
Parameters :
pageSize
Location : query
Format : int32
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
pageToken
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 `ListChannels` method. If not specified, the first page of results will be returned.
Location : query
partnerId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Description : The ID of the partner that owns the channels.
Type : string
orderBy
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` 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
advertiserId
Location : query
Format : int64
Description : The ID of the advertiser that owns the channels.
Type : string
filter
Description : Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
Description : Lists channels for a partner or advertiser.
Parameter Order : partnerId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/partners/{+partnerId}/channels
HTTP Method : GET
Flat Path : v3/partners/{partnersId}/channels
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
HTTP Method : POST
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order :
Parameters :
partnerId
Pattern : ^[^/]+$
Location : path
Type : string
Description : Required. The ID of the partner.
Required : Yes
Format : int64
targetingType
Required : Yes
Type : string
Enum :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Description : Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Description : Deletes an assigned targeting option from a partner.
Parameters :
assignedTargetingOptionId
Description : Required. The ID of the assigned targeting option to delete.
Type : string
Required : Yes
Pattern : ^[^/]+$
Location : path
partnerId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the partner.
targetingType
Required : Yes
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Type : string
Enum :
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
Parameter Order :
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : DELETE
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
HTTP Method : GET
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order :
Parameters :
partnerId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the partner.
Type : string
Required : Yes
Format : int64
targetingType
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Type : string
Enum :
Required : Yes
Pattern : ^[^/]+$
Enum Descriptions :
Location : path
assignedTargetingOptionId
Required : Yes
Type : string
Description : Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Location : path
Pattern : ^[^/]+$
Description : Gets a single targeting option assigned to a partner.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Description : Lists the targeting options assigned to a partner.
Parameters :
partnerId
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the partner.
Location : path
Pattern : ^[^/]+$
targetingType
Required : Yes
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Type : string
Enum :
Location : path
Pattern : ^[^/]+$
Enum Descriptions :
orderBy
Location : query
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
filter
Description : Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type : string
Location : query
pageSize
Location : query
Format : int32
Type : integer
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.
pageToken
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 `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location : query
Parameter Order :
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
▼ ▲ displayvideo.googleAudiences.get
Parameters :
advertiserId
Description : The ID of the advertiser that has access to the fetched Google audience.
Type : string
Location : query
Format : int64
partnerId
Type : string
Description : The ID of the partner that has access to the fetched Google audience.
Location : query
Format : int64
googleAudienceId
Location : path
Pattern : ^[^/]+$
Required : Yes
Format : int64
Type : string
Description : Required. The ID of the Google audience to fetch.
Description : Gets a Google audience.
Parameter Order : googleAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/googleAudiences/{+googleAudienceId}
HTTP Method : GET
Flat Path : v3/googleAudiences/{googleAudiencesId}
▼ ▲ displayvideo.googleAudiences.list
Description : Lists Google audiences. The order is defined by the order_by parameter.
Parameters :
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
pageToken
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 `ListGoogleAudiences` method. If not specified, the first page of results will be returned.
Location : query
partnerId
Description : The ID of the partner that has access to the fetched Google audiences.
Type : string
Location : query
Format : int64
orderBy
Location : query
Description : Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` 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
advertiserId
Description : The ID of the advertiser that has access to the fetched Google audiences.
Type : string
Location : query
Format : int64
filter
Type : string
Description : Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Path : v3/googleAudiences
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v3/googleAudiences
HTTP Method : GET
▼ ▲ displayvideo.combinedAudiences.get
Parameters :
advertiserId
Description : The ID of the advertiser that has access to the fetched combined audience.
Type : string
Location : query
Format : int64
partnerId
Description : The ID of the partner that has access to the fetched combined audience.
Type : string
Location : query
Format : int64
combinedAudienceId
Pattern : ^[^/]+$
Location : path
Description : Required. The ID of the combined audience to fetch.
Type : string
Required : Yes
Format : int64
Description : Gets a combined audience.
Parameter Order : combinedAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/combinedAudiences/{+combinedAudienceId}
HTTP Method : GET
Flat Path : v3/combinedAudiences/{combinedAudiencesId}
▼ ▲ displayvideo.combinedAudiences.list
Parameters :
pageSize
Type : integer
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.
Location : query
Format : int32
pageToken
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 `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
Type : string
advertiserId
Location : query
Format : int64
Type : string
Description : The ID of the advertiser that has access to the fetched combined audiences.
filter
Location : query
Type : string
Description : Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
partnerId
Location : query
Format : int64
Type : string
Description : The ID of the partner that has access to the fetched combined audiences.
orderBy
Description : Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` 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
Description : Lists combined audiences. The order is defined by the order_by parameter.
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/combinedAudiences
HTTP Method : GET
Flat Path : v3/combinedAudiences
▼ ▲ displayvideo.advertisers.get
HTTP Method : GET
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser to fetch.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertisersId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}
Description : Gets an advertiser.
▼ ▲ displayvideo.advertisers.list
HTTP Method : GET
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `advertiserId` (default) * `displayName` * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
Location : query
Type : string
filter
Description : Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
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 `ListAdvertisers` method. If not specified, the first page of results will be returned.
Location : query
Type : string
partnerId
Location : query
Type : string
Description : Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.
Format : int64
pageSize
Location : query
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Flat Path : v3/advertisers
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers
Description : Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Description : Lists assigned targeting options of an advertiser across targeting types.
Path : v3/advertisers/{+advertiserId}:listAssignedTargetingOptions
Flat Path : v3/advertisers/{advertisersId}:listAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `targetingType` (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: `targetingType desc`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
advertiserId
Location : path
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Type : string
Required : Yes
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 `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
pageSize
Format : int32
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.
Location : query
Type : integer
Parameter Order : advertiserId
HTTP Method : GET
▼ ▲ displayvideo.advertisers.editAssignedTargetingOptions
Description : Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests .
Path : v3/advertisers/{+advertiserId}:editAssignedTargetingOptions
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertisersId}:editAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.delete
Path : v3/advertisers/{+advertiserId}
Description : Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.
Parameter Order : advertiserId
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Format : int64
Description : The ID of the advertiser we need to delete.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
▼ ▲ displayvideo.advertisers.create
Path : v3/advertisers
Description : Creates a new advertiser. Returns the newly created advertiser if successful. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
HTTP Method : POST
Flat Path : v3/advertisers
▼ ▲ displayvideo.advertisers.patch
Description : Updates an existing advertiser. Returns the updated advertiser if successful.
Path : v3/advertisers/{+advertiserId}
Flat Path : v3/advertisers/{advertisersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Format : int64
Description : Output only. The unique ID of the advertiser. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Required : Yes
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
Parameter Order : advertiserId
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.audit
Description : Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.
Path : v3/advertisers/{+advertiserId}:audit
Parameters :
advertiserId
Format : int64
Description : Required. The ID of the advertiser to audit.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
readMask
Description : Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount
Format : google-fieldmask
Location : query
Type : string
Flat Path : v3/advertisers/{advertisersId}:audit
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.adGroups.delete
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser this ad group belongs to.
Format : int64
adGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the ad group to delete.
Format : int64
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameter Order :
Description : Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}
▼ ▲ displayvideo.advertisers.adGroups.get
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Location : path
Description : Required. The ID of the advertiser this ad group belongs to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
adGroupId
Format : int64
Description : Required. The ID of the ad group to fetch.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Description : Gets an ad group.
▼ ▲ displayvideo.advertisers.adGroups.list
Flat Path : v3/advertisers/{advertisersId}/adGroups
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
pageSize
Format : int32
Description : Optional. 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.
Location : query
Type : integer
advertiserId
Location : path
Description : Required. The ID of the advertiser the ad groups belongs to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
pageToken
Description : Optional. 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 `ListAdGroups` method. If not specified, the first page of results will be returned.
Location : query
Type : string
orderBy
Description : Optional. 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`.
Location : query
Type : string
filter
Description : Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. 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` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
Parameter Order : advertiserId
HTTP Method : GET
Description : Lists ad groups.
Path : v3/advertisers/{+advertiserId}/adGroups
▼ ▲ displayvideo.advertisers.adGroups.bulkListAdGroupAssignedTargetingOptions
Description : Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
Path : v3/advertisers/{+advertiserId}/adGroups:bulkListAdGroupAssignedTargetingOptions
Flat Path : v3/advertisers/{advertisersId}/adGroups:bulkListAdGroupAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
adGroupIds
Type : string
Repeated : Yes
Location : query
Description : Required. The IDs of the ad groups to list assigned targeting options for.
Format : int64
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the advertiser the line items belongs to.
Location : path
pageToken
Description : Optional. 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.
Location : query
Type : string
pageSize
Location : query
Type : integer
Description : Optional. 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.
Format : int32
orderBy
Location : query
Type : string
Description : Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (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`.
filter
Description : Optional. Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
Parameter Order : advertiserId
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adGroups.create
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Format : int64
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertisersId}/adGroups
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/adGroups
Description : Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
▼ ▲ displayvideo.advertisers.adGroups.patch
Description : Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
adGroupId
Format : int64
Description : Output only. The unique ID of the ad group. Assigned by the system.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Format : int64
Location : path
Parameter Order :
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions
Description : Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Path : v3/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions
Parameters :
advertiserId
Location : path
Format : int64
Description : Required. The ID of the advertiser the ad groups belong to.
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Format : int64
Description : Required. The ID of the advertiser the ad group belongs to.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
targetingType
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Location : path
Enum Descriptions :
Description : 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_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
assignedTargetingOptionId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
adGroupId
Location : path
Format : int64
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
Parameter Order :
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the advertiser the ad group belongs to.
pageToken
Description : Optional. 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 `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. 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.
orderBy
Location : query
Type : string
Description : Optional. 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`.
filter
Description : Optional. Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
targetingType
Location : path
Enum Descriptions :
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
adGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the ad group to list assigned targeting options for.
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser the ad group belongs to.
Format : int64
targetingType
Location : path
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
adGroupId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Location : path
assignedTargetingOptionId
Location : path
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Type : string
Required : Yes
Parameter Order :
HTTP Method : DELETE
Description : Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create
Description : Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Path : v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser the ad group belongs to.
Format : int64
targetingType
Location : path
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
adGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the ad group the assigned targeting option will belong to.
Flat Path : v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.create
Path : v3/advertisers/{+advertiserId}/locationLists
Description : Creates a new location list. Returns the newly created location list if successful.
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/locationLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
▼ ▲ displayvideo.advertisers.locationLists.patch
Description : Updates a location list. Returns the updated location list if successful.
Path : v3/advertisers/{+advertiserId}/locationLists/{locationListId}
Flat Path : v3/advertisers/{advertisersId}/locationLists/{locationListId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the location lists belongs.
locationListId
Format : int64
Description : Output only. The unique ID of the location list. Assigned by the system.
Location : path
Required : Yes
Type : string
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Parameter Order :
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.locationLists.get
Path : v3/advertisers/{+advertiserId}/locationLists/{+locationListId}
Description : Gets a location list.
Parameter Order :
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/locationLists/{locationListsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
locationListId
Description : Required. The ID of the location list to fetch.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.locationLists.list
Parameter Order : advertiserId
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/locationLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Format : int64
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 `ListLocationLists` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Type : integer
Description : Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
orderBy
Description : Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` 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`.
Location : query
Type : string
filter
Description : Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
Path : v3/advertisers/{+advertiserId}/locationLists
Description : Lists location lists based on a given advertiser id.
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.list
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Type : string
Required : Yes
Location : path
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Format : int64
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 `ListAssignedLocations` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
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.
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `assignedLocationId` (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: `assignedLocationId desc`.
filter
Location : query
Type : string
Description : Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
locationListId
Type : string
Required : Yes
Location : path
Description : Required. The ID of the location list to which these assignments are assigned.
Format : int64
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Description : Lists locations assigned to a location list.
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
HTTP Method : DELETE
Parameter Order :
Parameters :
assignedLocationId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the assigned location to delete.
Format : int64
locationListId
Location : path
Format : int64
Description : Required. The ID of the location list to which this assignment is assigned.
Type : string
Required : Yes
advertiserId
Format : int64
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Location : path
Required : Yes
Type : string
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
Description : Deletes the assignment between a location and a location list.
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
Description : Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.
Path : v3/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit
Parameters :
locationListId
Description : Required. The ID of the location list to which these assignments are assigned.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
Flat Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
locationListId
Description : Required. The ID of the location list for which the assignment will be created.
Format : int64
Location : path
Required : Yes
Type : string
advertiserId
Location : path
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Format : int64
Type : string
Required : Yes
Parameter Order :
HTTP Method : POST
Description : Creates an assignment between a location and a location list.
Path : v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
HTTP Method : DELETE
Parameter Order :
Parameters :
advertiserId
Location : path
Description : Required. The ID of the advertiser.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
targetingType
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Location : path
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
assignedTargetingOptionId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the assigned targeting option to delete.
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Deletes an assigned targeting option from an advertiser.
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Format : int64
Description : Required. The ID of the advertiser.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
targetingType
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`
Location : path
Enum Descriptions :
Required : Yes
Enum :
Pattern : ^[^/]+$
Type : string
assignedTargetingOptionId
Location : path
Description : Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
Type : string
Required : Yes
Parameter Order :
HTTP Method : GET
Description : Gets a single targeting option assigned to an advertiser.
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
HTTP Method : GET
Parameter Order :
Parameters :
targetingType
Location : path
Enum Descriptions :
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
pageSize
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.
Format : int32
Location : query
Type : integer
advertiserId
Location : path
Description : Required. The ID of the advertiser.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
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 `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
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`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to an advertiser.
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Flat Path : v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Description : Required. The ID of the advertiser.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
targetingType
Location : path
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Parameter Order :
HTTP Method : POST
Description : Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Path : v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.assets.upload
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/assets
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the advertiser this asset belongs to.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Supportsmediaupload : Yes
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/v3/advertisers/{+advertiserId}/assets
Path : v3/advertisers/{+advertiserId}/assets
Description : Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).
▼ ▲ displayvideo.advertisers.insertionOrders.create
Path : v3/advertisers/{+advertiserId}/insertionOrders
Description : Creates a new insertion order. Returns the newly created insertion order if successful.
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/insertionOrders
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Format : int64
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Pattern : ^[^/]+$
Type : string
Required : Yes
▼ ▲ displayvideo.advertisers.insertionOrders.patch
Flat Path : v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Location : path
insertionOrderId
Location : path
Format : int64
Description : Output only. The unique ID of the insertion order. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Required : Yes
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing insertion order. Returns the updated insertion order if successful.
Path : v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
▼ ▲ displayvideo.advertisers.insertionOrders.get
HTTP Method : GET
Parameter Order :
Parameters :
insertionOrderId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the insertion order to fetch.
Format : int64
advertiserId
Location : path
Format : int64
Description : Required. The ID of the advertiser this insertion order belongs to.
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Description : Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
▼ ▲ displayvideo.advertisers.insertionOrders.list
Parameter Order : advertiserId
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/insertionOrders
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" 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`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the advertiser to list insertion orders for.
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 `ListInsertionOrders` method. If not specified, the first page of results will be returned.
pageSize
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
Type : integer
Path : v3/advertisers/{+advertiserId}/insertionOrders
Description : Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
▼ ▲ displayvideo.advertisers.insertionOrders.delete
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
insertionOrderId
Description : The ID of the insertion order to delete.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : The ID of the advertiser this insertion order belongs to.
Location : path
Path : v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Description : Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
Parameter Order : advertiserId
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Format : int64
Description : Required. The ID of the advertiser the line items belongs to.
Pattern : ^[^/]+$
Type : string
Required : Yes
lineItemIds
Repeated : Yes
Type : string
Location : query
Format : int64
Description : Required. The IDs of the line items to list assigned targeting options for.
pageToken
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 `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Type : integer
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.
Format : int32
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `lineItemId` (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`.
filter
Description : Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
Path : v3/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple line items across targeting types.
▼ ▲ displayvideo.advertisers.lineItems.duplicate
Parameters :
lineItemId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the line item to duplicate.
Format : int64
Location : path
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser this line item belongs to.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order :
Description : Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Format : int64
Description : Required. The ID of the advertiser the line items belong to.
Pattern : ^[^/]+$
Type : string
Required : Yes
Path : v3/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions
Description : Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
▼ ▲ displayvideo.advertisers.lineItems.bulkUpdate
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser this line item belongs to.
Format : int64
Flat Path : v3/advertisers/{advertisersId}/lineItems:bulkUpdate
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : advertiserId
Description : Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.
Path : v3/advertisers/{+advertiserId}/lineItems:bulkUpdate
▼ ▲ displayvideo.advertisers.lineItems.create
Path : v3/advertisers/{+advertiserId}/lineItems
Description : Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API.
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the line item belongs to.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
▼ ▲ displayvideo.advertisers.lineItems.patch
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Description : Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Parameter Order :
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Output only. The unique ID of the advertiser the line item belongs to.
lineItemId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Output only. The unique ID of the line item. Assigned by the system.
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
▼ ▲ displayvideo.advertisers.lineItems.delete
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : The ID of the advertiser this line item belongs to.
lineItemId
Description : The ID of the line item to delete.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameter Order :
Description : Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API.
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
▼ ▲ displayvideo.advertisers.lineItems.get
Description : Gets a line item.
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
lineItemId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the line item to fetch.
Format : int64
advertiserId
Location : path
Format : int64
Description : Required. The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
Type : string
Required : Yes
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.advertisers.lineItems.list
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` 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`.
Location : query
Type : string
filter
Description : Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the advertiser to list line items for.
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 `ListLineItems` method. If not specified, the first page of results will be returned.
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.
Format : int32
Location : query
Type : integer
Flat Path : v3/advertisers/{advertisersId}/lineItems
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : advertiserId
Description : Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Path : v3/advertisers/{+advertiserId}/lineItems
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser the line item belongs to.
Format : int64
Location : path
targetingType
Location : path
Enum Descriptions :
Description : 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`
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
lineItemId
Location : path
Description : Required. The ID of the line item the assigned targeting option will belong to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Parameter Order :
HTTP Method : POST
Description : 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.
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API.
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
assignedTargetingOptionId
Location : path
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Type : string
Required : Yes
advertiserId
Description : Required. The ID of the advertiser the line item belongs to.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
targetingType
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Location : path
Enum Descriptions :
Description : 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`
lineItemId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the line item the assigned targeting option belongs to.
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Parameters :
lineItemId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the line item the assigned targeting option belongs to.
Location : path
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
targetingType
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Location : path
Enum Descriptions :
Description : 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` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
Description : Gets a single targeting option assigned to a line item.
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
Path : v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to a line item.
HTTP Method : GET
Parameter Order :
Parameters :
pageSize
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.
Format : int32
Location : query
Type : integer
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Location : path
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 `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location : query
Type : string
orderBy
Location : query
Type : string
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`.
filter
Location : query
Type : string
Description : Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
lineItemId
Format : int64
Description : Required. The ID of the line item to list assigned targeting options for.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
targetingType
Location : path
Enum Descriptions :
Description : Required. Identifies the type of assigned targeting options to list. 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` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Flat Path : v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.invoices.list
Path : v3/advertisers/{+advertiserId}/invoices
Description : Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.
Parameter Order : advertiserId
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/invoices
Scopes :
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the advertiser to list invoices for.
Format : int64
Location : path
loiSapinInvoiceType
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
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 `ListInvoices` method. If not specified, the first page of results will be returned.
issueMonth
Description : The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.
Location : query
Type : string
pageSize
Format : int32
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.
Location : query
Type : integer
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Path : v3/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
Description : Retrieves the invoice currency used by an advertiser in a given month.
HTTP Method : GET
Parameter Order : advertiserId
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the advertiser to lookup currency for.
invoiceMonth
Location : query
Type : string
Description : Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
Flat Path : v3/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
Scopes :
▼ ▲ displayvideo.advertisers.campaigns.create
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertisersId}/campaigns
Scopes :
Path : v3/advertisers/{+advertiserId}/campaigns
Description : Creates a new campaign. Returns the newly created campaign if successful.
▼ ▲ displayvideo.advertisers.campaigns.patch
Flat Path : v3/advertisers/{advertisersId}/campaigns/{campaignsId}
Scopes :
Parameters :
advertiserId
Location : path
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
campaignId
Location : path
Format : int64
Description : Output only. The unique ID of the campaign. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Required : Yes
updateMask
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
Type : string
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing campaign. Returns the updated campaign if successful.
Path : v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
▼ ▲ displayvideo.advertisers.campaigns.delete
Parameters :
advertiserId
Format : int64
Description : The ID of the advertiser this campaign belongs to.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
campaignId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : The ID of the campaign we need to delete.
Format : int64
Flat Path : v3/advertisers/{advertisersId}/campaigns/{campaignsId}
Scopes :
HTTP Method : DELETE
Parameter Order :
Description : Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Path : v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
▼ ▲ displayvideo.advertisers.campaigns.get
Description : Gets a campaign.
Path : v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the advertiser this campaign belongs to.
Location : path
campaignId
Location : path
Format : int64
Description : Required. The ID of the campaign to fetch.
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertisersId}/campaigns/{campaignsId}
Scopes :
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.campaigns.list
HTTP Method : GET
Parameter Order : advertiserId
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` 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`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : The ID of the advertiser to list campaigns for.
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 `ListCampaigns` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location : query
Type : integer
Flat Path : v3/advertisers/{advertisersId}/campaigns
Scopes :
Path : v3/advertisers/{+advertiserId}/campaigns
Description : Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
▼ ▲ displayvideo.advertisers.channels.create
Path : v3/advertisers/{+advertiserId}/channels
Description : Creates a new channel. Returns the newly created channel if successful.
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/channels
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the created channel.
Format : int64
advertiserId
Description : The ID of the advertiser that owns the created channel.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
▼ ▲ displayvideo.advertisers.channels.patch
Description : Updates a channel. Returns the updated channel if successful.
Path : v3/advertisers/{+advertiserId}/channels/{channelId}
Parameters :
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that owns the created channel.
advertiserId
Description : The ID of the advertiser that owns the created channel.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
channelId
Description : Output only. The unique ID of the channel. Assigned by the system.
Format : int64
Location : path
Required : Yes
Type : string
updateMask
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
Type : string
Flat Path : v3/advertisers/{advertisersId}/channels/{channelId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameter Order :
▼ ▲ displayvideo.advertisers.channels.get
Flat Path : v3/advertisers/{advertisersId}/channels/{channelsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Format : int64
Description : The ID of the advertiser that owns the fetched channel.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
channelId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the channel to fetch.
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that owns the fetched channel.
Parameter Order :
HTTP Method : GET
Description : Gets a channel for a partner or advertiser.
Path : v3/advertisers/{+advertiserId}/channels/{+channelId}
▼ ▲ displayvideo.advertisers.channels.list
Path : v3/advertisers/{+advertiserId}/channels
Description : Lists channels for a partner or advertiser.
Parameter Order : advertiserId
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/channels
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` 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`.
Location : query
Type : string
filter
Description : Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
advertiserId
Description : The ID of the advertiser that owns the channels.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
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 `ListChannels` method. If not specified, the first page of results will be returned.
Location : query
Type : string
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the channels.
Format : int64
pageSize
Location : query
Type : integer
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.
Format : int32
▼ ▲ displayvideo.advertisers.channels.sites.list
Description : Lists sites in a channel.
Path : v3/advertisers/{+advertiserId}/channels/{+channelId}/sites
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `urlOrAppId` (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: `urlOrAppId desc`.
Location : query
Type : string
filter
Description : Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
advertiserId
Location : path
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Pattern : ^[^/]+$
Type : string
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 `ListSites` method. If not specified, the first page of results will be returned.
Location : query
Type : string
partnerId
Description : The ID of the partner that owns the parent channel.
Format : int64
Location : query
Type : string
pageSize
Location : query
Type : integer
Description : Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
channelId
Format : int64
Description : Required. The ID of the parent channel to which the requested sites belong.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertisersId}/channels/{channelsId}/sites
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.channels.sites.delete
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
Description : Deletes a site from a channel.
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Location : path
channelId
Description : Required. The ID of the parent channel to which the site belongs.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
urlOrAppId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The URL or app ID of the site to delete.
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent channel.
Format : int64
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
Parameters :
advertiserId
Required : Yes
Type : string
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Location : path
channelId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the parent channel to which the sites belong.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order :
Description : Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit
▼ ▲ displayvideo.advertisers.channels.sites.replace
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites:replace
Description : Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
HTTP Method : POST
Parameter Order :
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Location : path
Required : Yes
Type : string
channelId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the parent channel whose sites will be replaced.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites:replace
▼ ▲ displayvideo.advertisers.channels.sites.create
Parameters :
partnerId
Format : int64
Description : The ID of the partner that owns the parent channel.
Location : query
Type : string
advertiserId
Location : path
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Type : string
Required : Yes
channelId
Description : Required. The ID of the parent channel in which the site will be created.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertiserId}/channels/{channelsId}/sites
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order :
Description : Creates a site in a channel.
Path : v3/advertisers/{advertiserId}/channels/{+channelId}/sites
▼ ▲ displayvideo.advertisers.creatives.create
Path : v3/advertisers/{+advertiserId}/creatives
Description : Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
Parameter Order : advertiserId
HTTP Method : POST
Flat Path : v3/advertisers/{advertisersId}/creatives
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Output only. The unique ID of the advertiser the creative belongs to.
Format : int64
▼ ▲ displayvideo.advertisers.creatives.patch
Description : Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
Path : v3/advertisers/{+advertiserId}/creatives/{+creativeId}
Parameters :
creativeId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Output only. The unique ID of the creative. Assigned by the system.
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
advertiserId
Description : Output only. The unique ID of the advertiser the creative belongs to.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertisersId}/creatives/{creativesId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameter Order :
▼ ▲ displayvideo.advertisers.creatives.get
Parameters :
creativeId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the creative to fetch.
Format : int64
advertiserId
Description : Required. The ID of the advertiser this creative belongs to.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/advertisers/{advertisersId}/creatives/{creativesId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
Description : Gets a creative.
Path : v3/advertisers/{+advertiserId}/creatives/{+creativeId}
▼ ▲ displayvideo.advertisers.creatives.list
Flat Path : v3/advertisers/{advertisersId}/creatives
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser to list creatives for.
Format : int64
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 `ListCreatives` method. If not specified, the first page of results will be returned.
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.
Format : int32
Location : query
Type : integer
orderBy
Description : Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Parameter Order : advertiserId
HTTP Method : GET
Description : Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Path : v3/advertisers/{+advertiserId}/creatives
▼ ▲ displayvideo.advertisers.creatives.delete
Path : v3/advertisers/{+advertiserId}/creatives/{+creativeId}
Description : Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request.
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/creatives/{creativesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
creativeId
Location : path
Format : int64
Description : The ID of the creative to be deleted.
Pattern : ^[^/]+$
Type : string
Required : Yes
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : The ID of the advertiser this creative belongs to.
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists
Description : Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Parameters :
advertiserId
Location : path
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
updateMask
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
Type : string
negativeKeywordListId
Location : path
Description : Output only. The unique ID of the negative keyword list. Assigned by the system.
Format : int64
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameter Order :
Description : Updates a negative keyword list. Returns the updated negative keyword list if successful.
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Description : Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Format : int64
negativeKeywordListId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the negative keyword list to fetch.
Location : path
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Parameter Order : advertiserId
HTTP Method : GET
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
Format : int64
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 `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.
pageSize
Description : Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
Location : query
Type : integer
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists
Description : Lists negative keyword lists based on a given advertiser id.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
HTTP Method : DELETE
Parameter Order :
Parameters :
advertiserId
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Pattern : ^[^/]+$
Type : string
Required : Yes
negativeKeywordListId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the negative keyword list to delete.
Format : int64
Location : path
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Description : Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
Parameter Order :
HTTP Method : POST
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Type : string
Required : Yes
negativeKeywordListId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
Description : Creates a negative keyword in a negative keyword list.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list
HTTP Method : GET
Parameter Order :
Parameters :
negativeKeywordListId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
Location : path
orderBy
Description : Field by which to sort the list. Acceptable values are: * `keywordValue` (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: `keywordValue desc`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
advertiserId
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
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 `ListNegativeKeywords` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Type : integer
Description : Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
Flat Path : v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
Description : Lists negative keywords in a negative keyword list.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
keywordValue
Description : Required. The keyword value of the negative keyword to delete.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Format : int64
Location : path
negativeKeywordListId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Format : int64
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
Description : Deletes a negative keyword from a negative keyword list.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit
HTTP Method : POST
Parameter Order :
Parameters :
advertiserId
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
Required : Yes
Type : string
negativeKeywordListId
Location : path
Format : int64
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit
Description : Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
Description : Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.
Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace
Flat Path : v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Format : int64
Location : path
Required : Yes
Type : string
negativeKeywordListId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Format : int64
Parameter Order :
HTTP Method : POST
▼ ▲ displayvideo.advertisers.adGroupAds.create
Description : Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Path : v3/advertisers/{+advertiserId}/adGroupAds
Parameters :
advertiserId
Location : path
Description : Output only. The unique ID of the advertiser the ad belongs to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertisersId}/adGroupAds
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.adGroupAds.patch
Parameter Order :
HTTP Method : PATCH
Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
adGroupAdId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Output only. The unique ID of the ad. Assigned by the system.
updateMask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
advertiserId
Location : path
Description : Output only. The unique ID of the advertiser the ad belongs to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Description : Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
▼ ▲ displayvideo.advertisers.adGroupAds.delete
Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Description : Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
adGroupAdId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the ad to delete. Only Demand Gen ads are supported.
Format : int64
advertiserId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the advertiser the ad belongs to.
Format : int64
▼ ▲ displayvideo.advertisers.adGroupAds.get
Description : Gets an ad group ad.
Path : v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Parameters :
adGroupAdId
Location : path
Format : int64
Description : Required. The ID of the ad to fetch.
Pattern : ^[^/]+$
Type : string
Required : Yes
advertiserId
Location : path
Description : Required. The ID of the advertiser this ad group ad belongs to.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroupAds.list
Flat Path : v3/advertisers/{advertisersId}/adGroupAds
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Location : query
Type : string
Description : Optional. 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
Description : Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
advertiserId
Description : Required. The ID of the advertiser the ads belong to.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
pageToken
Location : query
Type : string
Description : Optional. 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 `ListAdGroupAds` method. If not specified, the first page of results will be returned.
pageSize
Format : int32
Description : Optional. 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.
Location : query
Type : integer
Parameter Order : advertiserId
HTTP Method : GET
Description : Lists ad group ads.
Path : v3/advertisers/{+advertiserId}/adGroupAds
▼ ▲ displayvideo.media.download
Supportsmediadownload : Yes
Description : Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.
Path : download/{+resourceName}
Flat Path : download/{downloadId}
Scopes :
Parameters :
resourceName
Required : Yes
Pattern : ^.*$
Type : string
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Location : path
Parameter Order : resourceName
HTTP Method : GET
▼ ▲ displayvideo.media.upload
Flat Path : media/{mediaId}
Scopes :
Parameters :
resourceName
Required : Yes
Pattern : ^.*$
Type : string
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Location : path
Parameter Order : resourceName
HTTP Method : POST
Description : Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.
Supportsmediaupload : Yes
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/media/{+resourceName}
Path : media/{+resourceName}
▼ ▲ displayvideo.inventorySourceGroups.get
HTTP Method : GET
Parameter Order : inventorySourceGroupId
Parameters :
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
inventorySourceGroupId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the inventory source group to fetch.
Location : path
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Location : query
Type : string
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}
Description : Gets an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.list
HTTP Method : GET
Flat Path : v3/inventorySourceGroups
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Format : int64
Description : The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Format : int64
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Location : query
Type : string
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
filter
Location : query
Type : string
Description : Allows filtering by inventory source group fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Path : v3/inventorySourceGroups
Description : Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
▼ ▲ displayvideo.inventorySourceGroups.delete
HTTP Method : DELETE
Parameter Order : inventorySourceGroupId
Parameters :
inventorySourceGroupId
Format : int64
Description : Required. The ID of the inventory source group to delete.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Format : int64
Location : query
Type : string
partnerId
Format : int64
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Location : query
Type : string
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}
Description : Deletes an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.create
HTTP Method : POST
Flat Path : v3/inventorySourceGroups
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
partnerId
Description : The ID of the partner that owns the inventory source group. Only this partner will have write access to this group. Only advertisers to which this group is explicitly shared will have read access to this group.
Format : int64
Location : query
Type : string
Path : v3/inventorySourceGroups
Description : Creates a new inventory source group. Returns the newly created inventory source group if successful.
▼ ▲ displayvideo.inventorySourceGroups.patch
Parameters :
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Format : int64
inventorySourceGroupId
Location : path
Format : int64
Description : Output only. The unique ID of the inventory source group. Assigned by the system.
Type : string
Required : Yes
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameter Order : inventorySourceGroupId
Description : Updates an inventory source group. Returns the updated inventory source group if successful.
Path : v3/inventorySourceGroups/{inventorySourceGroupId}
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
Parameter Order : inventorySourceGroupId
HTTP Method : POST
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
inventorySourceGroupId
Location : path
Description : Required. The ID of the inventory source group to which the assignment will be assigned.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
advertiserId
Description : The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source.
Format : int64
Location : query
Type : string
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that owns the parent inventory source group. Only this partner will have write access to this assigned inventory source.
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Description : Creates an assignment between an inventory source and an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Description : Deletes the assignment between an inventory source and an inventory source group.
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
assignedInventorySourceId
Location : path
Description : Required. The ID of the assigned inventory source to delete.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
inventorySourceGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the inventory source group to which this assignment is assigned.
Format : int64
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source.
Format : int64
partnerId
Description : The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
Format : int64
Location : query
Type : string
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
Description : Bulk edits multiple assignments between inventory sources and a single inventory source group. The operation will delete the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources and then create the assigned inventory sources provided in BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources.
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
inventorySourceGroupId
Format : int64
Description : Required. The ID of the inventory source group to which the assignments are assigned.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Parameter Order : inventorySourceGroupId
HTTP Method : POST
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
Description : Lists inventory sources assigned to an inventory source group.
Path : v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Flat Path : v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
inventorySourceGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the inventory source group to which these assignments are assigned.
Format : int64
advertiserId
Description : The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.
Format : int64
Location : query
Type : string
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 `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.
Location : query
Type : string
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
Format : int64
pageSize
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
Type : integer
orderBy
Description : Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (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: `assignedInventorySourceId desc`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Parameter Order : inventorySourceGroupId
HTTP Method : GET
▼ ▲ displayvideo.customLists.get
Path : v3/customLists/{+customListId}
Description : Gets a custom list.
Parameter Order : customListId
HTTP Method : GET
Flat Path : v3/customLists/{customListsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
customListId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the custom list to fetch.
Format : int64
▼ ▲ displayvideo.customLists.list
Path : v3/customLists
Description : Lists custom lists. The order is defined by the order_by parameter.
HTTP Method : GET
Parameters :
advertiserId
Location : query
Type : string
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Format : int64
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 `ListCustomLists` method. If not specified, the first page of results will be returned.
pageSize
Location : query
Type : integer
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.
Format : int32
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` 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
Description : Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
Flat Path : v3/customLists
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
Path : v3/partners/{+partnerId}:editAssignedTargetingOptions
Description : Edits targeting options under a single partner. The operation will delete the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.deleteRequests and then create the assigned targeting options provided in BulkEditPartnerAssignedTargetingOptionsRequest.createRequests .
Parameter Order : partnerId
HTTP Method : POST
Flat Path : v3/partners/{partnersId}:editAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the partner.
▼ ▲ displayvideo.partners.get
Parameter Order : partnerId
HTTP Method : GET
Flat Path : v3/partners/{partnersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : path
Format : int64
Description : Required. The ID of the partner to fetch.
Pattern : ^[^/]+$
Type : string
Required : Yes
Path : v3/partners/{+partnerId}
Description : Gets a partner.
▼ ▲ displayvideo.partners.list
Flat Path : v3/partners
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
filter
Description : Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
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 `ListPartners` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
HTTP Method : GET
Description : Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
Path : v3/partners
▼ ▲ displayvideo.partners.channels.get
Flat Path : v3/partners/{partnersId}/channels/{channelsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : path
Format : int64
Description : The ID of the partner that owns the fetched channel.
Pattern : ^[^/]+$
Type : string
Required : Yes
channelId
Format : int64
Description : Required. The ID of the channel to fetch.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Description : The ID of the advertiser that owns the fetched channel.
Format : int64
Location : query
Type : string
Parameter Order :
HTTP Method : GET
Description : Gets a channel for a partner or advertiser.
Path : v3/partners/{+partnerId}/channels/{+channelId}
▼ ▲ displayvideo.partners.channels.list
Parameters :
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that owns the channels.
Format : int64
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 `ListChannels` method. If not specified, the first page of results will be returned.
Location : query
Type : string
partnerId
Location : path
Format : int64
Description : The ID of the partner that owns the channels.
Pattern : ^[^/]+$
Type : string
Required : Yes
pageSize
Location : query
Type : integer
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.
Format : int32
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` 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
Location : query
Type : string
Description : Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Flat Path : v3/partners/{partnersId}/channels
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : partnerId
Description : Lists channels for a partner or advertiser.
Path : v3/partners/{+partnerId}/channels
▼ ▲ displayvideo.partners.channels.create
Description : Creates a new channel. Returns the newly created channel if successful.
Path : v3/partners/{+partnerId}/channels
Parameters :
partnerId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : The ID of the partner that owns the created channel.
Format : int64
advertiserId
Format : int64
Description : The ID of the advertiser that owns the created channel.
Location : query
Type : string
Flat Path : v3/partners/{partnersId}/channels
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : partnerId
▼ ▲ displayvideo.partners.channels.patch
Parameters :
partnerId
Location : path
Format : int64
Description : The ID of the partner that owns the created channel.
Pattern : ^[^/]+$
Type : string
Required : Yes
channelId
Location : path
Description : Output only. The unique ID of the channel. Assigned by the system.
Format : int64
Type : string
Required : Yes
advertiserId
Format : int64
Description : The ID of the advertiser that owns the created channel.
Location : query
Type : string
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Flat Path : v3/partners/{partnersId}/channels/{channelId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameter Order :
Description : Updates a channel. Returns the updated channel if successful.
Path : v3/partners/{+partnerId}/channels/{channelId}
▼ ▲ displayvideo.partners.channels.sites.delete
Path : v3/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
Description : Deletes a site from a channel.
Parameter Order :
HTTP Method : DELETE
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
channelId
Format : int64
Description : Required. The ID of the parent channel to which the site belongs.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
urlOrAppId
Description : Required. The URL or app ID of the site to delete.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent channel.
partnerId
Format : int64
Description : The ID of the partner that owns the parent channel.
Location : path
Required : Yes
Type : string
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
Path : v3/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit
Description : Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites.
Parameter Order :
HTTP Method : POST
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
channelId
Format : int64
Description : Required. The ID of the parent channel to which the sites belong.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
partnerId
Format : int64
Description : The ID of the partner that owns the parent channel.
Location : path
Required : Yes
Type : string
▼ ▲ displayvideo.partners.channels.sites.replace
Parameters :
partnerId
Required : Yes
Type : string
Format : int64
Description : The ID of the partner that owns the parent channel.
Location : path
channelId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the parent channel whose sites will be replaced.
Format : int64
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites:replace
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order :
Description : Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
Path : v3/partners/{partnerId}/channels/{+channelId}/sites:replace
▼ ▲ displayvideo.partners.channels.sites.list
HTTP Method : GET
Parameter Order :
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `urlOrAppId` (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: `urlOrAppId desc`.
filter
Location : query
Type : string
Description : Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Location : query
Type : string
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 `ListSites` method. If not specified, the first page of results will be returned.
partnerId
Description : The ID of the partner that owns the parent channel.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
pageSize
Description : Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
Location : query
Type : integer
channelId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the parent channel to which the requested sites belong.
Location : path
Flat Path : v3/partners/{partnersId}/channels/{channelsId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/partners/{+partnerId}/channels/{+channelId}/sites
Description : Lists sites in a channel.
▼ ▲ displayvideo.partners.channels.sites.create
Flat Path : v3/partners/{partnerId}/channels/{channelsId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
channelId
Format : int64
Description : Required. The ID of the parent channel in which the site will be created.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that owns the parent channel.
Format : int64
partnerId
Location : path
Format : int64
Description : The ID of the partner that owns the parent channel.
Type : string
Required : Yes
Parameter Order :
HTTP Method : POST
Description : Creates a site in a channel.
Path : v3/partners/{partnerId}/channels/{+channelId}/sites
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
Parameter Order :
HTTP Method : POST
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the partner.
targetingType
Required : Yes
Enum :
Pattern : ^[^/]+$
Type : string
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Location : path
Enum Descriptions :
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Description : Deletes an assigned targeting option from a partner.
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameters :
partnerId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the partner.
Format : int64
targetingType
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Location : path
Enum Descriptions :
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
assignedTargetingOptionId
Location : path
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Type : string
Required : Yes
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameter Order :
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
Parameter Order :
HTTP Method : GET
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
targetingType
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Location : path
Enum Descriptions :
Required : Yes
Enum :
Pattern : ^[^/]+$
Type : string
partnerId
Description : Required. The ID of the partner.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
assignedTargetingOptionId
Location : path
Description : Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
Type : string
Required : Yes
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Gets a single targeting option assigned to a partner.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Description : Lists the targeting options assigned to a partner.
Path : v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Flat Path : v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by assigned targeting option fields. 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}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
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 `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
partnerId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the partner.
Location : path
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.
Format : int32
Location : query
Type : integer
targetingType
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Location : path
Enum Descriptions :
Required : Yes
Enum :
Pattern : ^[^/]+$
Type : string
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.uploadRules
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Location : path
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
Type : string
Parameter Order : customBiddingAlgorithmId
HTTP Method : GET
Description : Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
Parameter Order : customBiddingAlgorithmId
HTTP Method : GET
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
customBiddingAlgorithmId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the custom bidding algorithm owns the script.
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
Type : string
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript
Description : Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.
▼ ▲ displayvideo.customBiddingAlgorithms.get
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Format : int64
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Location : query
Type : string
customBiddingAlgorithmId
Format : int64
Description : Required. The ID of the custom bidding algorithm to fetch.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Format : int64
Location : query
Type : string
Parameter Order : customBiddingAlgorithmId
HTTP Method : GET
Description : Gets a custom bidding algorithm.
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}
▼ ▲ displayvideo.customBiddingAlgorithms.list
HTTP Method : GET
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `displayName` (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: `displayName desc`.
Location : query
Type : string
filter
Description : Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
advertiserId
Format : int64
Description : The ID of the DV360 advertiser that has access to the custom bidding algorithm.
Location : query
Type : string
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 `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
partnerId
Location : query
Type : string
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Format : int64
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.
Format : int32
Location : query
Type : integer
Flat Path : v3/customBiddingAlgorithms
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms
Description : Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.
▼ ▲ displayvideo.customBiddingAlgorithms.create
HTTP Method : POST
Flat Path : v3/customBiddingAlgorithms
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms
Description : Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
▼ ▲ displayvideo.customBiddingAlgorithms.patch
Description : Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Parameters :
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
customBiddingAlgorithmId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Format : int64
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.
Location : query
Type : string
customBiddingAlgorithmId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
Type : string
Parameter Order : customBiddingAlgorithmId
HTTP Method : POST
Description : Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error.
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
▼ ▲ displayvideo.customBiddingAlgorithms.rules.get
HTTP Method : GET
Parameter Order :
Parameters :
customBiddingAlgorithmId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Format : int64
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm.
customBiddingAlgorithmRulesId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the rules resource to fetch.
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
Description : Retrieves a rules resource.
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
Description : Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.
customBiddingAlgorithmId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Format : int64
Location : path
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
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 `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
Location : query
Type : string
partnerId
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm.
Location : query
Type : string
pageSize
Location : query
Type : integer
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.
Format : int32
Parameter Order : customBiddingAlgorithmId
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
Description : Gets a custom bidding script.
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
customBiddingAlgorithmId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the custom bidding algorithm owns the script.
customBiddingScriptId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the custom bidding script to fetch.
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
Type : string
Parameter Order :
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
HTTP Method : GET
Parameter Order : customBiddingAlgorithmId
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.
customBiddingAlgorithmId
Format : int64
Description : Required. The ID of the custom bidding algorithm owns the script.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Format : int64
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Location : query
Type : string
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 `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Format : int64
pageSize
Location : query
Type : integer
Format : int32
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.
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Description : Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.create
Parameter Order : customBiddingAlgorithmId
HTTP Method : POST
Flat Path : v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
customBiddingAlgorithmId
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the script.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Format : int64
Path : v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Description : Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error.
▼ ▲ displayvideo.googleAudiences.get
Description : Gets a Google audience.
Path : v3/googleAudiences/{+googleAudienceId}
Flat Path : v3/googleAudiences/{googleAudiencesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that has access to the fetched Google audience.
Format : int64
googleAudienceId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the Google audience to fetch.
Format : int64
Location : path
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched Google audience.
Format : int64
Parameter Order : googleAudienceId
HTTP Method : GET
▼ ▲ displayvideo.googleAudiences.list
HTTP Method : GET
Flat Path : v3/googleAudiences
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Format : int64
Description : The ID of the partner that has access to the fetched Google audiences.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
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.
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the fetched Google audiences.
Location : query
Type : string
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 `ListGoogleAudiences` method. If not specified, the first page of results will be returned.
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` 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
Location : query
Type : string
Description : Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Path : v3/googleAudiences
Description : Lists Google audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.floodlightGroups.get
Parameters :
floodlightGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the Floodlight group to fetch.
partnerId
Format : int64
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Type : string
Flat Path : v3/floodlightGroups/{floodlightGroupsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : floodlightGroupId
Description : Gets a Floodlight group.
Path : v3/floodlightGroups/{+floodlightGroupId}
▼ ▲ displayvideo.floodlightGroups.patch
Path : v3/floodlightGroups/{floodlightGroupId}
Description : Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
Parameter Order : floodlightGroupId
HTTP Method : PATCH
Flat Path : v3/floodlightGroups/{floodlightGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
floodlightGroupId
Required : Yes
Type : string
Description : Output only. The unique ID of the Floodlight group. Assigned by the system.
Format : int64
Location : path
partnerId
Format : int64
Description : Required. The partner context by which the Floodlight group is being accessed.
Location : query
Type : string
updateMask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.get
Path : v3/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}
Description : Gets a Floodlight activity.
Parameter Order :
HTTP Method : GET
Flat Path : v3/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
floodlightGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
Format : int64
partnerId
Location : query
Type : string
Description : Required. The ID of the partner through which the Floodlight activity is being accessed.
Format : int64
floodlightActivityId
Location : path
Description : Required. The ID of the Floodlight activity to fetch.
Format : int64
Pattern : ^[^/]+$
Type : string
Required : Yes
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.list
Description : Lists Floodlight activities in a Floodlight group.
Path : v3/floodlightGroups/{+floodlightGroupId}/floodlightActivities
Flat Path : v3/floodlightGroups/{floodlightGroupsId}/floodlightActivities
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Format : int64
Description : Required. The ID of the partner through which the Floodlight activities are being accessed.
Location : query
Type : string
pageSize
Description : Optional. 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.
Format : int32
Location : query
Type : integer
pageToken
Location : query
Type : string
Description : Optional. 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 `ListFloodlightActivities` method. If not specified, the first page of results will be returned.
orderBy
Location : query
Type : string
Description : Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `floodlightActivityId` 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`.
floodlightGroupId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Format : int64
Parameter Order : floodlightGroupId
HTTP Method : GET
▼ ▲ displayvideo.combinedAudiences.get
Flat Path : v3/combinedAudiences/{combinedAudiencesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
combinedAudienceId
Format : int64
Description : Required. The ID of the combined audience to fetch.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the fetched combined audience.
Location : query
Type : string
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched combined audience.
Format : int64
Parameter Order : combinedAudienceId
HTTP Method : GET
Description : Gets a combined audience.
Path : v3/combinedAudiences/{+combinedAudienceId}
▼ ▲ displayvideo.combinedAudiences.list
Flat Path : v3/combinedAudiences
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : The ID of the advertiser that has access to the fetched combined audiences.
Format : int64
Location : query
Type : string
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 `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched combined audiences.
Format : int64
pageSize
Location : query
Type : integer
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.
Format : int32
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` 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
Description : Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
HTTP Method : GET
Description : Lists combined audiences. The order is defined by the order_by parameter.
Path : v3/combinedAudiences
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Description : Gets a single targeting option.
Path : v3/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
Parameters :
targetingType
Required : Yes
Enum :
Pattern : ^[^/]+$
Type : string
Description : Required. The type of targeting option to retrieve. 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`
Location : path
Enum Descriptions :
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Format : int64
Location : query
Type : string
targetingOptionId
Description : Required. The ID of the of targeting option to retrieve.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order :
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Description : Lists targeting options of a given type.
Path : v3/targetingTypes/{+targetingType}/targetingOptions
Parameters :
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.
Format : int32
Location : query
Type : integer
advertiserId
Location : query
Type : string
Format : int64
Description : Required. The Advertiser this request is being made in the context of.
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 `ListTargetingOptions` method. If not specified, the first page of results will be returned.
orderBy
Description : 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`.
Location : query
Type : string
filter
Description : 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](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
targetingType
Location : path
Enum Descriptions :
Description : 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`
Pattern : ^[^/]+$
Type : string
Required : Yes
Enum :
Flat Path : v3/targetingTypes/{targetingTypesId}/targetingOptions
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : targetingType
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Description : Searches for targeting options of a given type based on the given search terms.
Path : v3/targetingTypes/{+targetingType}/targetingOptions:search
Parameters :
targetingType
Required : Yes
Enum :
Pattern : ^[^/]+$
Type : string
Description : Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`
Location : path
Enum Descriptions :
Flat Path : v3/targetingTypes/{targetingTypesId}/targetingOptions:search
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : targetingType
▼ ▲ displayvideo.firstAndThirdPartyAudiences.get
Description : Gets a first and third party audience.
Path : v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
Parameters :
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that has access to the fetched first and third party audience.
firstAndThirdPartyAudienceId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the first and third party audience to fetch.
Format : int64
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the fetched first and third party audience.
Location : query
Type : string
Flat Path : v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameter Order : firstAndThirdPartyAudienceId
▼ ▲ displayvideo.firstAndThirdPartyAudiences.list
Path : v3/firstAndThirdPartyAudiences
Description : Lists first and third party audiences. The order is defined by the order_by parameter.
HTTP Method : GET
Flat Path : v3/firstAndThirdPartyAudiences
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` 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
Location : query
Type : string
Description : Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched first and third party audiences.
Format : int64
pageSize
Location : query
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that has access to the fetched first and third party audiences.
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 `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.
▼ ▲ displayvideo.firstAndThirdPartyAudiences.create
Path : v3/firstAndThirdPartyAudiences
Description : Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
HTTP Method : POST
Flat Path : v3/firstAndThirdPartyAudiences
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : query
Type : string
Description : Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.
Format : int64
▼ ▲ displayvideo.firstAndThirdPartyAudiences.patch
Description : Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Path : v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
Flat Path : v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
firstAndThirdPartyAudienceId
Required : Yes
Pattern : ^[^/]+$
Type : string
Format : int64
Description : Output only. The unique ID of the first and third party audience. Assigned by the system.
Location : path
advertiserId
Format : int64
Description : Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.
Location : query
Type : string
Parameter Order : firstAndThirdPartyAudienceId
HTTP Method : PATCH
▼ ▲ displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers
Description : Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Path : v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers
Parameters :
firstAndThirdPartyAudienceId
Format : int64
Description : Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Flat Path : v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameter Order : firstAndThirdPartyAudienceId
▼ ▲ displayvideo.sdfdownloadtasks.create
HTTP Method : POST
Flat Path : v3/sdfdownloadtasks
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/sdfdownloadtasks
Description : Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty.
▼ ▲ displayvideo.sdfdownloadtasks.operations.get
Flat Path : v3/sdfdownloadtasks/operations/{operationsId}
Scopes :
Parameters :
name
Required : Yes
Pattern : ^sdfdownloadtasks/operations/[^/]+$
Type : string
Description : The name of the operation resource.
Location : path
Parameter Order : name
HTTP Method : GET
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
Path : v3/{+name}
▼ ▲ displayvideo.users.create
Flat Path : v3/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : POST
Description : Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Path : v3/users
▼ ▲ displayvideo.users.patch
HTTP Method : PATCH
Parameter Order : userId
Parameters :
userId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Output only. The unique ID of the user. Assigned by the system.
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Type : string
Flat Path : v3/users/{usersId}
Scopes : https://www.googleapis.com/auth/display-video-user-management
Path : v3/users/{+userId}
Description : Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
▼ ▲ displayvideo.users.get
Parameters :
userId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Format : int64
Description : Required. The ID of the user to fetch.
Flat Path : v3/users/{usersId}
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : GET
Parameter Order : userId
Description : Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Path : v3/users/{+userId}
▼ ▲ displayvideo.users.list
Description : Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Path : v3/users
Parameters :
orderBy
Location : query
Type : string
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
filter
Description : Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location : query
Type : string
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 `ListUsers` method. If not specified, the first page of results will be returned.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Flat Path : v3/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : GET
▼ ▲ displayvideo.users.delete
Description : Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Path : v3/users/{+userId}
Parameters :
userId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The ID of the user to delete.
Format : int64
Flat Path : v3/users/{usersId}
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : DELETE
Parameter Order : userId
▼ ▲ displayvideo.users.bulkEditAssignedUserRoles
Flat Path : v3/users/{usersId}:bulkEditAssignedUserRoles
Scopes : https://www.googleapis.com/auth/display-video-user-management
Parameters :
userId
Description : Required. The ID of the user to which the assigned user roles belong.
Format : int64
Location : path
Required : Yes
Pattern : ^[^/]+$
Type : string
Parameter Order : userId
HTTP Method : POST
Description : Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Path : v3/users/{+userId}:bulkEditAssignedUserRoles
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Parameter Order : guaranteedOrderId
HTTP Method : POST
Flat Path : v3/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
guaranteedOrderId
Required : Yes
Pattern : ^[^/]+$
Type : string
Description : Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Location : path
Path : v3/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
Description : Edits read advertisers of a guaranteed order.
▼ ▲ displayvideo.guaranteedOrders.create
Path : v3/guaranteedOrders
Description : Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
HTTP Method : POST
Flat Path : v3/guaranteedOrders
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : The ID of the advertiser that the request is being made within.
Format : int64
Location : query
Type : string
partnerId
Description : The ID of the partner that the request is being made within.
Format : int64
Location : query
Type : string
▼ ▲ displayvideo.guaranteedOrders.patch
HTTP Method : PATCH
Parameter Order : guaranteedOrderId
Parameters :
partnerId
Format : int64
Description : The ID of the partner that the request is being made within.
Location : query
Type : string
guaranteedOrderId
Location : path
Description : Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Pattern : ^[^/]+$
Type : string
Required : Yes
advertiserId
Location : query
Type : string
Format : int64
Description : The ID of the advertiser that the request is being made within.
updateMask
Format : google-fieldmask
Description : Required. The mask to control which fields to update.
Location : query
Type : string
Flat Path : v3/guaranteedOrders/{guaranteedOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/guaranteedOrders/{+guaranteedOrderId}
Description : Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
▼ ▲ displayvideo.guaranteedOrders.get
Parameter Order : guaranteedOrderId
HTTP Method : GET
Flat Path : v3/guaranteedOrders/{guaranteedOrdersId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
guaranteedOrderId
Location : path
Description : Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Pattern : ^[^/]+$
Type : string
Required : Yes
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that has access to the guaranteed order.
Format : int64
partnerId
Description : The ID of the partner that has access to the guaranteed order.
Format : int64
Location : query
Type : string
Path : v3/guaranteedOrders/{+guaranteedOrderId}
Description : Gets a guaranteed order.
▼ ▲ displayvideo.guaranteedOrders.list
HTTP Method : GET
Parameters :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
Location : query
Type : string
filter
Location : query
Type : string
Description : Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
advertiserId
Format : int64
Description : The ID of the advertiser that has access to the guaranteed order.
Location : query
Type : string
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 `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.
Location : query
Type : string
partnerId
Location : query
Type : string
Format : int64
Description : The ID of the partner that has access to the guaranteed order.
pageSize
Location : query
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Flat Path : v3/guaranteedOrders
Scopes : https://www.googleapis.com/auth/display-video
Path : v3/guaranteedOrders
Description : Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.