2026-05-26
▼ ▲ displayvideo.googleAudiences.list
Flat Path : v4/googleAudiences
Description : Lists Google audiences. The order is defined by the order_by parameter.
Parameters :
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 `ListGoogleAudiences` 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: * `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
Format : int64
Location : query
pageSize
Location : query
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
Format : int32
filter
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.
Type : string
Location : query
partnerId
Description : The ID of the partner that has access to the fetched Google audiences.
Type : string
Format : int64
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/googleAudiences
HTTP Method : GET
▼ ▲ displayvideo.googleAudiences.get
Description : Gets a Google audience.
Flat Path : v4/googleAudiences/{googleAudiencesId}
HTTP Method : GET
Path : v4/googleAudiences/{+googleAudienceId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : googleAudienceId
Parameters :
partnerId
Description : The ID of the partner that has access to the fetched Google audience.
Type : string
Format : int64
Location : query
googleAudienceId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the Google audience to fetch.
Pattern : ^[^/]+$
advertiserId
Description : The ID of the advertiser that has access to the fetched Google audience.
Type : string
Format : int64
Location : query
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.list
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : floodlightGroupId
Parameters :
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
orderBy
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`.
Type : string
Location : query
partnerId
Description : Required. The ID of the partner through which the Floodlight activities are being accessed.
Type : string
Format : int64
Location : query
pageSize
Location : query
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
Format : int32
floodlightGroupId
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
HTTP Method : GET
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities
Description : Lists Floodlight activities in a Floodlight group.
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.get
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}
Description : Gets a Floodlight activity.
Parameter Order :
Parameters :
floodlightActivityId
Required : Yes
Description : Required. The ID of the Floodlight activity to fetch.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
partnerId
Description : Required. The ID of the partner through which the Floodlight activity is being accessed.
Type : string
Format : int64
Location : query
floodlightGroupId
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}
HTTP Method : GET
▼ ▲ displayvideo.floodlightGroups.get
Parameters :
partnerId
Description : Required. The partner context by which the Floodlight group is being accessed.
Type : string
Format : int64
Location : query
floodlightGroupId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the Floodlight group to fetch.
Pattern : ^[^/]+$
Parameter Order : floodlightGroupId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/floodlightGroups/{+floodlightGroupId}
HTTP Method : GET
Flat Path : v4/floodlightGroups/{floodlightGroupsId}
Description : Gets a Floodlight group.
▼ ▲ displayvideo.floodlightGroups.patch
HTTP Method : PATCH
Path : v4/floodlightGroups/{floodlightGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Description : Required. The partner context by which the Floodlight group is being accessed.
Type : string
Format : int64
Location : query
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
floodlightGroupId
Description : Output only. The unique ID of the Floodlight group. Assigned by the system.
Required : Yes
Type : string
Format : int64
Location : path
Parameter Order : floodlightGroupId
Description : Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
Flat Path : v4/floodlightGroups/{floodlightGroupId}
▼ ▲ displayvideo.combinedAudiences.list
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : The ID of the advertiser that has access to the fetched combined audiences.
Type : string
Format : int64
Location : query
pageSize
Location : query
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
Format : int32
filter
Location : query
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.
Type : string
partnerId
Description : The ID of the partner that has access to the fetched combined audiences.
Type : string
Format : int64
Location : query
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 `ListCombinedAudiences` 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: * `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
HTTP Method : GET
Path : v4/combinedAudiences
Flat Path : v4/combinedAudiences
Description : Lists combined audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.combinedAudiences.get
HTTP Method : GET
Path : v4/combinedAudiences/{+combinedAudienceId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : combinedAudienceId
Parameters :
combinedAudienceId
Type : string
Format : int64
Location : path
Description : Required. The ID of the combined audience to fetch.
Pattern : ^[^/]+$
Required : Yes
partnerId
Location : query
Description : The ID of the partner that has access to the fetched combined audience.
Type : string
Format : int64
advertiserId
Location : query
Description : The ID of the advertiser that has access to the fetched combined audience.
Type : string
Format : int64
Description : Gets a combined audience.
Flat Path : v4/combinedAudiences/{combinedAudiencesId}
▼ ▲ displayvideo.sdfuploadtasks.operations.get
Parameter Order : name
Parameters :
name
Location : path
Type : string
Required : Yes
Description : The name of the operation resource.
Pattern : ^sdfuploadtasks/operations/[^/]+$
Scopes :
Path : v4/{+name}
HTTP Method : GET
Flat Path : v4/sdfuploadtasks/operations/{operationsId}
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.get
Description : Gets a first party or partner audience.
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
HTTP Method : GET
Parameter Order : firstPartyAndPartnerAudienceId
Parameters :
advertiserId
Description : The ID of the advertiser that has access to the fetched first party and partner audience.
Type : string
Format : int64
Location : query
firstPartyAndPartnerAudienceId
Description : Required. The ID of the first party and partner audience to fetch.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
partnerId
Location : query
Description : The ID of the partner that has access to the fetched first party and partner audience.
Type : string
Format : int64
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.editCustomerMatchMembers
Parameters :
firstPartyAndPartnerAudienceId
Location : path
Type : string
Format : int64
Description : Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.
Pattern : ^[^/]+$
Required : Yes
Parameter Order : firstPartyAndPartnerAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}:editCustomerMatchMembers
HTTP Method : POST
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}: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`
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.list
HTTP Method : GET
Path : v4/firstPartyAndPartnerAudiences
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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 `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned.
Type : string
Location : query
orderBy
Description : Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (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
partnerId
Description : The ID of the partner that has access to the fetched first party and partner audiences.
Type : string
Format : int64
Location : query
advertiserId
Description : The ID of the advertiser that has access to the fetched first party and partner audiences.
Type : string
Format : int64
Location : query
pageSize
Location : query
Description : Optional. 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.
Type : integer
Format : int32
filter
Location : query
Description : Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner 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 party and partner 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.
Type : string
Description : Lists first party and partner audiences. The order is defined by the order_by parameter.
Flat Path : v4/firstPartyAndPartnerAudiences
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.create
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : query
Description : Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.
Type : string
Format : int64
HTTP Method : POST
Path : v4/firstPartyAndPartnerAudiences
Flat Path : v4/firstPartyAndPartnerAudiences
Description : Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.patch
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
HTTP Method : PATCH
Parameters :
updateMask
Description : Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
Type : string
Format : google-fieldmask
Location : query
firstPartyAndPartnerAudienceId
Type : string
Format : int64
Location : path
Required : Yes
Description : Identifier. The unique ID of the first party and partner audience. Assigned by the system.
Pattern : ^[^/]+$
advertiserId
Description : Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.
Type : string
Format : int64
Location : query
Parameter Order : firstPartyAndPartnerAudienceId
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
▼ ▲ displayvideo.advertisers.adAssets.upload
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this ad asset belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Mediaupload :
Protocols :
Simple :
Multipart : Yes
Path : /upload/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Accept : */*
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/adAssets:uploadAdAsset
Supportsmediaupload : Yes
Description : Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.
▼ ▲ displayvideo.advertisers.adAssets.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser this ad asset belongs to.
Pattern : ^[^/]+$
adAssetId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`
Pattern : ^[^/]+$
Parameter Order :
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}
Flat Path : v4/advertisers/{advertisersId}/adAssets/{adAssetsId}
Description : Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
▼ ▲ displayvideo.advertisers.adAssets.list
Path : v4/advertisers/{+advertiserId}/adAssets
HTTP Method : GET
Parameter Order : advertiserId
Parameters :
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 `ListAdAssets` method. If not specified, the first page of results will be returned.
Type : string
Location : query
orderBy
Description : Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (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: `adAssetId desc`.
Type : string
Location : query
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the ad assets belong to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
pageSize
Location : query
Description : Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Type : integer
Format : int32
filter
Description : Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Flat Path : v4/advertisers/{advertisersId}/adAssets
▼ ▲ displayvideo.advertisers.adAssets.create
Description : Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Flat Path : v4/advertisers/{advertisersId}/adAssets
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/adAssets
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this ad asset belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.adAssets.bulkCreate
Description : Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Flat Path : v4/advertisers/{advertisersId}/adAssets:bulkCreate
Path : v4/advertisers/{+advertiserId}/adAssets:bulkCreate
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Description : Required. The ID of the advertiser these ad assets belong to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
▼ ▲ displayvideo.advertisers.assets.upload
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser this asset belongs to.
Pattern : ^[^/]+$
Parameter Order : advertiserId
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/assets
Mediaupload :
Protocols :
Simple :
Multipart : Yes
Path : /upload/v4/advertisers/{+advertiserId}/assets
Accept : */*
Flat Path : v4/advertisers/{advertisersId}/assets
Supportsmediaupload : Yes
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.locationLists.assignedLocations.list
Description : Lists locations assigned to a location list.
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : GET
Parameter Order :
Parameters :
locationListId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the location list to which these assignments are assigned.
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 `ListAssignedLocations` method. If not specified, the first page of results will be returned.
Type : string
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
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Type : string
Format : int64
Location : path
pageSize
Location : query
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
Format : int32
filter
Location : query
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
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
Description : Creates an assignment between a location and a location list.
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : POST
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Type : string
Format : int64
Location : path
locationListId
Description : Required. The ID of the location list for which the assignment will be created.
Required : Yes
Type : string
Format : int64
Location : path
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListsId}/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.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
locationListId
Required : Yes
Description : Required. The ID of the location list to which these assignments are assigned.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
HTTP Method : POST
Path : v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
Description : Deletes the assignment between a location and a location list.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
locationListId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the location list to which this assignment is assigned.
assignedLocationId
Location : path
Type : string
Format : int64
Description : Required. The ID of the assigned location to delete.
Pattern : ^[^/]+$
Required : Yes
HTTP Method : DELETE
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
▼ ▲ displayvideo.advertisers.locationLists.patch
Path : v4/advertisers/{+advertiserId}/locationLists/{locationListId}
HTTP Method : PATCH
Parameter Order :
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location lists belongs.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
locationListId
Description : Output only. The unique ID of the location list. Assigned by the system.
Required : Yes
Type : string
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Description : Updates a location list. Returns the updated location list if successful.
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListId}
▼ ▲ displayvideo.advertisers.locationLists.list
Description : Lists location lists based on a given advertiser id.
Flat Path : v4/advertisers/{advertisersId}/locationLists
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/locationLists
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
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.
Type : string
Location : query
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`.
Type : string
Location : query
advertiserId
Description : Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
pageSize
Location : query
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.
Type : integer
Format : int32
filter
Location : query
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.
Type : string
▼ ▲ displayvideo.advertisers.locationLists.create
Path : v4/advertisers/{+advertiserId}/locationLists
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates a new location list. Returns the newly created location list if successful.
Flat Path : v4/advertisers/{advertisersId}/locationLists
▼ ▲ displayvideo.advertisers.locationLists.get
Path : v4/advertisers/{+advertiserId}/locationLists/{+locationListId}
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
locationListId
Description : Required. The ID of the location list to fetch.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a location list.
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListsId}
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Path : v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
HTTP Method : GET
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser to lookup currency for.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
invoiceMonth
Location : query
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.
Type : string
Parameter Order : advertiserId
Scopes :
Description : Retrieves the invoice currency used by an advertiser in a given month.
Flat Path : v4/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
▼ ▲ displayvideo.advertisers.invoices.list
Flat Path : v4/advertisers/{advertisersId}/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
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser to list invoices for.
Pattern : ^[^/]+$
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.
Type : string
Location : query
pageSize
Location : query
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
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 `ListInvoices` method. If not specified, the first page of results will be returned.
Type : string
loiSapinInvoiceType
Type : string
Enum :
Location : query
Description : Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
Enum Descriptions :
Scopes :
Path : v4/advertisers/{+advertiserId}/invoices
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adGroupAds.patch
Parameter Order :
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the ad belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
adGroupAdId
Type : string
Format : int64
Location : path
Description : Output only. The unique ID of the ad. Assigned by the system.
Pattern : ^[^/]+$
Required : Yes
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
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
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the advertiser the ad belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
adGroupAdId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the ad to delete. Only Demand Gen ads are supported.
Pattern : ^[^/]+$
Parameter Order :
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
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.
▼ ▲ displayvideo.advertisers.adGroupAds.list
Parameter Order : advertiserId
Parameters :
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 `ListAdGroupAds` method. If not specified, the first page of results will be returned.
Type : string
Location : query
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`.
Type : string
Location : query
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the advertiser the ads belong to.
Pattern : ^[^/]+$
pageSize
Location : query
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.
Type : integer
Format : int32
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.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroupAds
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
Description : Lists ad group ads.
▼ ▲ displayvideo.advertisers.adGroupAds.create
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Description : Output only. The unique ID of the advertiser the ad belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/adGroupAds
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
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.
▼ ▲ displayvideo.advertisers.adGroupAds.get
Parameter Order :
Parameters :
advertiserId
Description : Required. The ID of the advertiser this ad group ad belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
adGroupAdId
Required : Yes
Description : Required. The ID of the ad to fetch.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Description : Gets an ad group ad.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
HTTP Method : GET
Parameters :
negativeKeywordListId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the negative keyword list to fetch.
Pattern : ^[^/]+$
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Pattern : ^[^/]+$
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Description : Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Description : Lists negative keyword lists based on a given advertiser id.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
HTTP Method : GET
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
Pattern : ^[^/]+$
pageSize
Location : query
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.
Type : integer
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
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Description : Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Description : Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Pattern : ^[^/]+$
Required : Yes
negativeKeywordListId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the negative keyword list to delete.
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Description : Updates a negative keyword list. Returns the updated negative keyword list if successful.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Pattern : ^[^/]+$
Required : Yes
negativeKeywordListId
Type : string
Format : int64
Location : path
Required : Yes
Description : Output only. The unique ID of the negative keyword list. Assigned by the system.
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
negativeKeywordListId
Required : Yes
Description : Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
advertiserId
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Type : string
Format : int64
Location : path
keywordValue
Type : string
Location : path
Description : Required. The keyword value of the negative keyword to delete.
Pattern : ^[^/]+$
Required : Yes
HTTP Method : DELETE
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
Description : Deletes a negative keyword from a negative keyword list.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Pattern : ^[^/]+$
pageSize
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.
Type : integer
Format : int32
Location : query
filter
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.
Type : string
Location : query
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 `ListNegativeKeywords` method. If not specified, the first page of results will be returned.
Type : string
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`.
Type : string
Location : query
negativeKeywordListId
Description : Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists negative keywords in a negative keyword list.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Description : Creates a negative keyword in a negative keyword list.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
negativeKeywordListId
Required : Yes
Description : Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
advertiserId
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
Type : string
Format : int64
HTTP Method : POST
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit
HTTP Method : POST
Parameter Order :
Parameters :
negativeKeywordListId
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
advertiserId
Required : Yes
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location : path
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/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.
Parameter Order :
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Location : path
Type : string
Format : int64
negativeKeywordListId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace
HTTP Method : POST
▼ ▲ displayvideo.advertisers.insertionOrders.delete
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
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.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Description : The ID of the advertiser this insertion order belongs to.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
insertionOrderId
Type : string
Format : int64
Location : path
Description : The ID of the insertion order to delete.
Pattern : ^[^/]+$
Required : Yes
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
▼ ▲ displayvideo.advertisers.insertionOrders.patch
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
insertionOrderId
Required : Yes
Description : Output only. The unique ID of the insertion order. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Location : query
advertiserId
Required : Yes
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Parameter Order :
Description : Updates an existing insertion order. Returns the updated insertion order if successful.
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
▼ ▲ displayvideo.advertisers.insertionOrders.get
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this insertion order belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
insertionOrderId
Required : Yes
Description : Required. The ID of the insertion order to fetch.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Description : Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
▼ ▲ displayvideo.advertisers.insertionOrders.list
Flat Path : v4/advertisers/{advertisersId}/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.
Parameters :
advertiserId
Description : Required. The ID of the advertiser to list insertion orders for.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
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.
Type : integer
Format : int32
Location : query
filter
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.
Type : string
Location : query
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
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
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/insertionOrders
HTTP Method : GET
▼ ▲ displayvideo.advertisers.insertionOrders.create
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/insertionOrders
Flat Path : v4/advertisers/{advertisersId}/insertionOrders
Description : Creates a new insertion order. Returns the newly created insertion order if successful.
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
assignedTargetingOptionId
Type : string
Location : path
Required : Yes
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
lineItemId
Description : Required. The ID of the line item the assigned targeting option belongs to.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
targetingType
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)
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
Type : string
Enum :
Location : path
Description : Gets a single targeting option assigned to a line item.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Required : Yes
targetingType
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)
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Enum :
Location : path
pageSize
Location : query
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.
Type : integer
Format : int32
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
Required : Yes
Description : Required. The ID of the line item to list assigned targeting options for.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
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 `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
orderBy
Description : Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
Type : string
Location : query
Parameter Order :
Description : Lists the targeting options assigned to a line item.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
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.
Parameter Order :
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
lineItemId
Description : Required. The ID of the line item the assigned targeting option will belong to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
targetingType
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`
Pattern : ^[^/]+$
Location : path
Type : string
Enum :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : POST
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
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.
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
lineItemId
Required : Yes
Description : Required. The ID of the line item the assigned targeting option belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
targetingType
Location : path
Type : string
Enum :
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`
Pattern : ^[^/]+$
assignedTargetingOptionId
Location : path
Type : string
Required : Yes
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
linkedEntity.adGroupId
Description : The ID of an ad group.
Type : string
Format : int64
Location : query
youtubeAssetType
Type : string
Enum :
Location : path
Required : Yes
Description : Required. The type of YouTube asset associated with the resource.
Pattern : ^[^/]+$
Enum Descriptions :
youtubeAssetAssociationId
Required : Yes
Description : Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
lineItemId
Type : string
Format : int64
Location : path
Description : The ID of a line item.
Pattern : ^[^/]+$
Required : Yes
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
Description : Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
youtubeAssetType
Location : path
Type : string
Enum :
Enum Descriptions :
Required : Yes
Description : Required. The type of YouTube asset being associated with the resource.
Pattern : ^[^/]+$
advertiserId
Required : Yes
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
linkedEntity.adGroupId
Location : query
Description : The ID of an ad group.
Type : string
Format : int64
pageSize
Location : query
Description : Optional. 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.
Type : integer
Format : int32
lineItemId
Required : Yes
Description : The ID of a line item.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
Type : string
orderBy
Location : query
Description : Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
Type : string
Parameter Order :
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Description : Lists the YouTube asset associations linked to the given resource.
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
lineItemId
Required : Yes
Description : The ID of a line item.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
linkedEntity.adGroupId
Description : The ID of an ad group.
Type : string
Format : int64
Location : query
youtubeAssetType
Location : path
Type : string
Enum :
Enum Descriptions :
Required : Yes
Description : Required. The type of YouTube asset associated with the resource.
Pattern : ^[^/]+$
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Description : Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
▼ ▲ displayvideo.advertisers.lineItems.list
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.
Flat Path : v4/advertisers/{advertisersId}/lineItems
Path : v4/advertisers/{+advertiserId}/lineItems
HTTP Method : GET
Parameters :
advertiserId
Description : Required. The ID of the advertiser to list line items for.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
pageSize
Location : query
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
Format : int32
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
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 `ListLineItems` method. If not specified, the first page of results will be returned.
Type : string
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
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.lineItems.get
Description : Gets a line item.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
Required : Yes
lineItemId
Type : string
Format : int64
Location : path
Description : Required. The ID of the line item to fetch.
Pattern : ^[^/]+$
Required : Yes
▼ ▲ displayvideo.advertisers.lineItems.duplicate
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Description : Required. The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
lineItemId
Location : path
Type : string
Format : int64
Description : Required. The ID of the line item to duplicate.
Pattern : ^[^/]+$
Required : Yes
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.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser the line items belongs to.
Pattern : ^[^/]+$
pageSize
Location : query
Description : Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Type : integer
Format : int32
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 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.
Type : string
pageToken
Location : query
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.
Type : string
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
lineItemIds
Type : string
Format : int64
Repeated : Yes
Location : query
Description : Required. The IDs of the line items to list assigned targeting options for.
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple line items across targeting types.
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/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.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the line items belong to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Parameter Order : advertiserId
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.create
Path : v4/advertisers/{+advertiserId}/lineItems
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : Output only. The unique ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/advertisers/{advertisersId}/lineItems
▼ ▲ displayvideo.advertisers.lineItems.bulkUpdate
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/lineItems:bulkUpdate
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
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.
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkUpdate
▼ ▲ displayvideo.advertisers.lineItems.patch
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
advertiserId
Description : Output only. The unique ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
lineItemId
Location : path
Type : string
Format : int64
Required : Yes
Description : Output only. The unique ID of the line item. Assigned by the system.
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.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
▼ ▲ displayvideo.advertisers.lineItems.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Description : The ID of the advertiser this line item belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
lineItemId
Description : The ID of the line item to delete.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
Parameter Order :
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
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.
▼ ▲ displayvideo.advertisers.creatives.list
Parameters :
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 `ListCreatives` 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: * `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
advertiserId
Description : Required. The ID of the advertiser to list creatives for.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
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.
Type : integer
Format : int32
Location : query
filter
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.
Type : string
Location : query
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/creatives
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/creatives
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.
▼ ▲ displayvideo.advertisers.creatives.create
Path : v4/advertisers/{+advertiserId}/creatives
HTTP Method : POST
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Output only. The unique ID of the advertiser the creative belongs to.
Pattern : ^[^/]+$
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/advertisers/{advertisersId}/creatives
▼ ▲ displayvideo.advertisers.creatives.get
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
Description : Gets a creative.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser this creative belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
creativeId
Required : Yes
Description : Required. The ID of the creative to fetch.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
▼ ▲ 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.
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Output only. The unique ID of the advertiser the creative belongs to.
Pattern : ^[^/]+$
creativeId
Required : Yes
Description : Output only. The unique ID of the creative. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.creatives.delete
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
HTTP Method : DELETE
Parameter Order :
Parameters :
advertiserId
Description : The ID of the advertiser this creative belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
creativeId
Required : Yes
Description : The ID of the creative to be deleted.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description : Lists the targeting options assigned to an advertiser.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : Required. The ID of the advertiser.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
targetingType
Type : string
Enum :
Location : path
Required : Yes
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 : ^[^/]+$
Enum Descriptions :
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.
Type : integer
Format : int32
Location : query
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 `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
Location : query
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
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
Parameter Order :
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description : Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser.
Pattern : ^[^/]+$
Required : Yes
targetingType
Location : path
Type : string
Enum :
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 : ^[^/]+$
Required : Yes
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : POST
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Description : Gets a single targeting option assigned to an advertiser.
Parameter Order :
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
targetingType
Required : Yes
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`
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Enum :
Location : path
assignedTargetingOptionId
Type : string
Location : path
Required : Yes
Description : Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Description : Deletes an assigned targeting option from an advertiser.
Parameter Order :
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the advertiser.
Pattern : ^[^/]+$
targetingType
Type : string
Enum :
Location : path
Required : Yes
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 : ^[^/]+$
Enum Descriptions :
assignedTargetingOptionId
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : DELETE
▼ ▲ displayvideo.advertisers.channels.get
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}
Description : Gets a channel for a partner or advertiser.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Required : Yes
Description : The ID of the advertiser that owns the fetched channel.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
partnerId
Location : query
Description : The ID of the partner that owns the fetched channel.
Type : string
Format : int64
channelId
Description : Required. The ID of the channel to fetch.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Parameter Order :
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}
▼ ▲ displayvideo.advertisers.channels.list
Description : Lists channels for a partner or advertiser.
Flat Path : v4/advertisers/{advertisersId}/channels
Path : v4/advertisers/{+advertiserId}/channels
HTTP Method : GET
Parameter Order : advertiserId
Parameters :
partnerId
Description : The ID of the partner that owns the channels.
Type : string
Format : int64
Location : query
advertiserId
Description : The ID of the advertiser that owns the channels.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
pageSize
Location : query
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
Format : int32
filter
Location : query
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
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.
Type : string
Location : query
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
▼ ▲ displayvideo.advertisers.channels.create
Description : Creates a new channel. Returns the newly created channel if successful.
Flat Path : v4/advertisers/{advertisersId}/channels
Path : v4/advertisers/{+advertiserId}/channels
HTTP Method : POST
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : The ID of the advertiser that owns the created channel.
Pattern : ^[^/]+$
Required : Yes
partnerId
Description : The ID of the partner that owns the created channel.
Type : string
Format : int64
Location : query
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.channels.patch
Flat Path : v4/advertisers/{advertisersId}/channels/{channelId}
Description : Updates a channel. Returns the updated channel if successful.
Parameters :
channelId
Location : path
Type : string
Format : int64
Required : Yes
Description : Output only. The unique ID of the channel. Assigned by the system.
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Location : query
partnerId
Description : The ID of the partner that owns the created channel.
Type : string
Format : int64
Location : query
advertiserId
Required : Yes
Description : The ID of the advertiser that owns the created channel.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/channels/{channelId}
HTTP Method : PATCH
▼ ▲ displayvideo.advertisers.channels.sites.list
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}/sites
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Pattern : ^[^/]+$
Required : Yes
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.
Type : integer
Format : int32
Location : query
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.
Type : string
Location : query
partnerId
Location : query
Description : The ID of the partner that owns the parent channel.
Type : string
Format : int64
channelId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the parent channel to which the requested sites belong.
Pattern : ^[^/]+$
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 `ListSites` method. If not specified, the first page of results will be returned.
Type : string
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
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists sites in a channel.
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}/sites
▼ ▲ displayvideo.advertisers.channels.sites.create
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites
Description : Creates a site in a channel.
Parameter Order :
Parameters :
partnerId
Location : query
Description : The ID of the partner that owns the parent channel.
Type : string
Format : int64
channelId
Type : string
Format : int64
Location : path
Description : Required. The ID of the parent channel in which the site will be created.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Required : Yes
Description : The ID of the advertiser that owns the parent channel.
Location : path
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites
HTTP Method : POST
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
HTTP Method : POST
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
channelId
Required : Yes
Description : Required. The ID of the parent channel to which the sites belong.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Type : string
Format : int64
Location : path
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.
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
▼ ▲ displayvideo.advertisers.channels.sites.replace
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
channelId
Description : Required. The ID of the parent channel whose sites will be replaced.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace
HTTP Method : POST
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/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.
▼ ▲ displayvideo.advertisers.channels.sites.delete
Description : Deletes a site from a channel.
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
HTTP Method : DELETE
Parameter Order :
Parameters :
urlOrAppId
Type : string
Location : path
Required : Yes
Description : Required. The URL or app ID of the site to delete.
Pattern : ^[^/]+$
partnerId
Location : query
Description : The ID of the partner that owns the parent channel.
Type : string
Format : int64
channelId
Location : path
Type : string
Format : int64
Description : Required. The ID of the parent channel to which the site belongs.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : The ID of the advertiser that owns the parent channel.
▼ ▲ displayvideo.advertisers.campaigns.list
Path : v4/advertisers/{+advertiserId}/campaigns
HTTP Method : GET
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : The ID of the advertiser to list campaigns for.
Pattern : ^[^/]+$
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
filter
Location : query
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.
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 `ListCampaigns` 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: * `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
Parameter Order : advertiserId
Scopes :
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.
Flat Path : v4/advertisers/{advertisersId}/campaigns
▼ ▲ displayvideo.advertisers.campaigns.create
Description : Creates a new campaign. Returns the newly created campaign if successful.
Flat Path : v4/advertisers/{advertisersId}/campaigns
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/campaigns
Scopes :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Pattern : ^[^/]+$
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.campaigns.get
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
HTTP Method : GET
Parameter Order :
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser this campaign belongs to.
Pattern : ^[^/]+$
Required : Yes
campaignId
Required : Yes
Description : Required. The ID of the campaign to fetch.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Scopes :
Description : Gets a campaign.
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.campaigns.patch
HTTP Method : PATCH
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Scopes :
Parameters :
campaignId
Description : Output only. The unique ID of the campaign. Assigned by the system.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
advertiserId
Type : string
Format : int64
Location : path
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Pattern : ^[^/]+$
Required : Yes
Parameter Order :
Description : Updates an existing campaign. Returns the updated campaign if successful.
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.campaigns.delete
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Scopes :
Parameter Order :
Parameters :
campaignId
Required : Yes
Description : The ID of the campaign we need to delete.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
advertiserId
Required : Yes
Description : The ID of the advertiser this campaign belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
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.
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
Flat Path : v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the line items belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
pageSize
Location : query
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.
Type : integer
Format : int32
filter
Location : query
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.
Type : string
adGroupIds
Description : Required. The IDs of the ad groups to list assigned targeting options for.
Repeated : Yes
Type : string
Format : int64
Location : query
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
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`.
Type : string
Location : query
▼ ▲ displayvideo.advertisers.adGroups.delete
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.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser this ad group belongs to.
Pattern : ^[^/]+$
adGroupId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the ad group to delete.
Pattern : ^[^/]+$
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.patch
Parameter Order :
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
adGroupId
Description : Output only. The unique ID of the ad group. Assigned by the system.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
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.
▼ ▲ displayvideo.advertisers.adGroups.get
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser this ad group belongs to.
Pattern : ^[^/]+$
adGroupId
Required : Yes
Description : Required. The ID of the ad group to fetch.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Parameter Order :
Description : Gets an ad group.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
▼ ▲ displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/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.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the ad groups belong to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.list
Parameters :
advertiserId
Required : Yes
Description : Required. The ID of the advertiser the ad groups belongs to.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
pageSize
Location : query
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
Format : int32
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
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
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`.
Type : string
Location : query
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroups
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}/adGroups
Description : Lists ad groups.
▼ ▲ displayvideo.advertisers.adGroups.create
Parameters :
advertiserId
Required : Yes
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroups
HTTP Method : POST
Flat Path : v4/advertisers/{advertisersId}/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.targetingTypes.assignedTargetingOptions.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Required : Yes
targetingType
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 : ^[^/]+$
Required : Yes
Enum Descriptions :
Type : string
Enum :
Location : path
adGroupId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Pattern : ^[^/]+$
assignedTargetingOptionId
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
HTTP Method : DELETE
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
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.
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
advertiserId
Description : Required. The ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
targetingType
Type : string
Enum :
Location : path
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 : ^[^/]+$
Required : Yes
Enum Descriptions :
pageSize
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.
Type : integer
Format : int32
Location : query
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.
Type : string
Location : query
adGroupId
Required : Yes
Description : Required. The ID of the ad group to list assigned targeting options for.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
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 `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
orderBy
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`.
Type : string
Location : query
Description : Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
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.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
adGroupId
Required : Yes
Description : Required. The ID of the ad group the assigned targeting option will belong to.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Required : Yes
targetingType
Type : string
Enum :
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`
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Description : Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
Parameter Order :
Parameters :
advertiserId
Description : Required. The ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
targetingType
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`
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Enum :
adGroupId
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
assignedTargetingOptionId
Required : Yes
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list
Description : Lists the YouTube asset associations linked to the given resource.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
HTTP Method : GET
Parameter Order :
Parameters :
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
Type : string
orderBy
Description : Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
Type : string
Location : query
linkedEntity.lineItemId
Description : The ID of a line item.
Type : string
Format : int64
Location : query
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Required : Yes
pageSize
Description : Optional. 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.
Type : integer
Format : int32
Location : query
adGroupId
Type : string
Format : int64
Location : path
Required : Yes
Description : The ID of an ad group.
Pattern : ^[^/]+$
youtubeAssetType
Type : string
Enum :
Location : path
Description : Required. The type of YouTube asset being associated with the resource.
Pattern : ^[^/]+$
Required : Yes
Enum Descriptions :
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create
Description : Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
HTTP Method : POST
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
linkedEntity.lineItemId
Description : The ID of a line item.
Type : string
Format : int64
Location : query
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Required : Yes
adGroupId
Type : string
Format : int64
Location : path
Required : Yes
Description : The ID of an ad group.
Pattern : ^[^/]+$
youtubeAssetType
Enum Descriptions :
Required : Yes
Description : Required. The type of YouTube asset associated with the resource.
Pattern : ^[^/]+$
Location : path
Type : string
Enum :
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
Description : Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
Parameter Order :
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Required : Yes
adGroupId
Location : path
Type : string
Format : int64
Required : Yes
Description : The ID of an ad group.
Pattern : ^[^/]+$
youtubeAssetType
Required : Yes
Description : Required. The type of YouTube asset associated with the resource.
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Enum :
Location : path
youtubeAssetAssociationId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.
Pattern : ^[^/]+$
linkedEntity.lineItemId
Description : The ID of a line item.
Type : string
Format : int64
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
HTTP Method : DELETE
▼ ▲ 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 .
Flat Path : v4/advertisers/{advertisersId}:editAssignedTargetingOptions
Path : v4/advertisers/{+advertiserId}:editAssignedTargetingOptions
HTTP Method : POST
Parameter Order : advertiserId
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser.
Pattern : ^[^/]+$
Required : Yes
▼ ▲ displayvideo.advertisers.patch
Parameter Order : advertiserId
Parameters :
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
advertiserId
Required : Yes
Description : Output only. The unique ID of the advertiser. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}
HTTP Method : PATCH
Flat Path : v4/advertisers/{advertisersId}
Description : Updates an existing advertiser. Returns the updated advertiser if successful.
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
pageToken
Location : query
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
orderBy
Location : query
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
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
Required : Yes
pageSize
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.
Type : integer
Format : int32
Location : query
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: * `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.
Type : string
Parameter Order : advertiserId
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}:listAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}:listAssignedTargetingOptions
Description : Lists assigned targeting options of an advertiser across targeting types.
▼ ▲ displayvideo.advertisers.delete
Path : v4/advertisers/{+advertiserId}
HTTP Method : DELETE
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Required : Yes
Description : The ID of the advertiser we need to delete.
Pattern : ^[^/]+$
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.list
Flat Path : v4/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.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : query
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.
Type : string
Format : int64
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
Location : query
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.
Type : string
Location : query
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 `ListAdvertisers` method. If not specified, the first page of results will be returned.
Type : string
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
HTTP Method : GET
Path : v4/advertisers
▼ ▲ 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.
Flat Path : v4/advertisers
HTTP Method : POST
Path : v4/advertisers
▼ ▲ displayvideo.advertisers.audit
Parameters :
advertiserId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the advertiser to audit.
Pattern : ^[^/]+$
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
Type : string
Format : google-fieldmask
Location : query
Parameter Order : advertiserId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}:audit
HTTP Method : GET
Flat Path : v4/advertisers/{advertisersId}: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.
▼ ▲ displayvideo.advertisers.get
Flat Path : v4/advertisers/{advertisersId}
Description : Gets an advertiser.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Location : path
Type : string
Format : int64
Description : Required. The ID of the advertiser to fetch.
Pattern : ^[^/]+$
Required : Yes
Parameter Order : advertiserId
HTTP Method : GET
Path : v4/advertisers/{+advertiserId}
▼ ▲ displayvideo.sdfdownloadtasks.operations.get
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
Flat Path : v4/sdfdownloadtasks/operations/{operationsId}
Path : v4/{+name}
HTTP Method : GET
Parameter Order : name
Parameters :
name
Location : path
Type : string
Required : Yes
Description : The name of the operation resource.
Pattern : ^sdfdownloadtasks/operations/[^/]+$
Scopes :
▼ ▲ displayvideo.sdfdownloadtasks.create
Flat Path : v4/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.
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Path : v4/sdfdownloadtasks
▼ ▲ displayvideo.guaranteedOrders.create
Parameters :
partnerId
Description : The ID of the partner that the request is being made within.
Type : string
Format : int64
Location : query
advertiserId
Location : query
Description : The ID of the advertiser that the request is being made within.
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/guaranteedOrders
HTTP Method : POST
Flat Path : v4/guaranteedOrders
Description : Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
▼ ▲ 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.
Flat Path : v4/guaranteedOrders
HTTP Method : GET
Path : v4/guaranteedOrders
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : query
Description : The ID of the partner that has access to the guaranteed order.
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that has access to the guaranteed order.
Type : string
Format : int64
Location : query
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
filter
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
Location : query
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
orderBy
Location : query
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`.
Type : string
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Description : Edits read advertisers of a guaranteed order.
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
HTTP Method : POST
Path : v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : guaranteedOrderId
Parameters :
guaranteedOrderId
Required : Yes
Description : Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Pattern : ^[^/]+$
Location : path
Type : string
▼ ▲ displayvideo.guaranteedOrders.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Description : The ID of the partner that has access to the guaranteed order.
Type : string
Format : int64
Location : query
advertiserId
Description : The ID of the advertiser that has access to the guaranteed order.
Type : string
Format : int64
Location : query
guaranteedOrderId
Description : Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Parameter Order : guaranteedOrderId
HTTP Method : GET
Path : v4/guaranteedOrders/{+guaranteedOrderId}
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
Description : Gets a guaranteed order.
▼ ▲ displayvideo.guaranteedOrders.patch
Parameter Order : guaranteedOrderId
Parameters :
partnerId
Location : query
Description : The ID of the partner that the request is being made within.
Type : string
Format : int64
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
advertiserId
Location : query
Description : The ID of the advertiser that the request is being made within.
Type : string
Format : int64
guaranteedOrderId
Description : Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/guaranteedOrders/{+guaranteedOrderId}
HTTP Method : PATCH
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
Description : Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
▼ ▲ displayvideo.inventorySources.patch
Flat Path : v4/inventorySources/{inventorySourcesId}
Description : Updates an existing inventory source. Returns the updated inventory source if successful.
Parameters :
inventorySourceId
Required : Yes
Description : Output only. The unique ID of the inventory source. Assigned by the system.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
advertiserId
Location : query
Description : The ID of the advertiser that the request is being made within.
Type : string
Format : int64
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
partnerId
Description : The ID of the partner that the request is being made within.
Type : string
Format : int64
Location : query
Parameter Order : inventorySourceId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySources/{+inventorySourceId}
HTTP Method : PATCH
▼ ▲ displayvideo.inventorySources.list
Description : Lists inventory sources 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, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Flat Path : v4/inventorySources
Path : v4/inventorySources
HTTP Method : GET
Parameters :
advertiserId
Location : query
Description : The ID of the advertiser that has access to the inventory source.
Type : string
Format : int64
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
filter
Location : query
Description : Allows filtering by inventory source 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: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources 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
partnerId
Location : query
Description : The ID of the partner that has access to the inventory source.
Type : string
Format : int64
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Type : string
orderBy
Location : query
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`.
Type : string
▼ ▲ displayvideo.inventorySources.create
Flat Path : v4/inventorySources
Description : Creates a new inventory source. Returns the newly created inventory source if successful.
Parameters :
partnerId
Description : The ID of the partner that the request is being made within.
Type : string
Format : int64
Location : query
advertiserId
Description : The ID of the advertiser that the request is being made within.
Type : string
Format : int64
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySources
HTTP Method : POST
▼ ▲ displayvideo.inventorySources.get
Description : Gets an inventory source.
Flat Path : v4/inventorySources/{inventorySourcesId}
HTTP Method : GET
Path : v4/inventorySources/{+inventorySourceId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
inventorySourceId
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the inventory source to fetch.
Pattern : ^[^/]+$
advertiserId
Location : query
Description : Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.
Type : string
Format : int64
partnerId
Location : query
Description : Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
Type : string
Format : int64
Parameter Order : inventorySourceId
▼ ▲ displayvideo.inventorySources.editInventorySourceReadWriteAccessors
HTTP Method : POST
Path : v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceId
Parameters :
inventorySourceId
Type : string
Format : int64
Location : path
Description : Required. The ID of inventory source to update.
Pattern : ^[^/]+$
Required : Yes
Description : Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Flat Path : v4/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors
▼ ▲ displayvideo.users.list
Flat Path : v4/users
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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
Parameters :
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
Location : query
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.
Type : string
Location : query
orderBy
Location : query
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`.
Type : string
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
HTTP Method : GET
Path : v4/users
▼ ▲ displayvideo.users.create
Scopes : https://www.googleapis.com/auth/display-video-user-management
HTTP Method : POST
Path : v4/users
Flat Path : v4/users
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.
▼ ▲ displayvideo.users.get
Flat Path : v4/users/{usersId}
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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
Parameter Order : userId
Parameters :
userId
Description : Required. The ID of the user to fetch.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
HTTP Method : GET
Path : v4/users/{+userId}
▼ ▲ displayvideo.users.bulkEditAssignedUserRoles
HTTP Method : POST
Path : v4/users/{+userId}:bulkEditAssignedUserRoles
Scopes : https://www.googleapis.com/auth/display-video-user-management
Parameters :
userId
Type : string
Format : int64
Location : path
Description : Required. The ID of the user to which the assigned user roles belong.
Pattern : ^[^/]+$
Required : Yes
Parameter Order : userId
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.
Flat Path : v4/users/{usersId}:bulkEditAssignedUserRoles
▼ ▲ displayvideo.users.patch
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.
Flat Path : v4/users/{usersId}
Path : v4/users/{+userId}
HTTP Method : PATCH
Parameters :
userId
Type : string
Format : int64
Location : path
Required : Yes
Description : Output only. The unique ID of the user. Assigned by the system.
Pattern : ^[^/]+$
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Parameter Order : userId
Scopes : https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.users.delete
Path : v4/users/{+userId}
HTTP Method : DELETE
Parameters :
userId
Type : string
Format : int64
Location : path
Description : Required. The ID of the user to delete.
Pattern : ^[^/]+$
Required : Yes
Parameter Order : userId
Scopes : https://www.googleapis.com/auth/display-video-user-management
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.
Flat Path : v4/users/{usersId}
▼ ▲ displayvideo.media.upload
Parameter Order : resourceName
Parameters :
resourceName
Required : Yes
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Pattern : ^.*$
Type : string
Location : path
Scopes :
Path : media/{+resourceName}
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/media/{+resourceName}
HTTP Method : POST
Flat Path : media/{mediaId}
Supportsmediaupload : Yes
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.
▼ ▲ displayvideo.media.download
Path : download/{+resourceName}
HTTP Method : GET
Parameters :
resourceName
Type : string
Location : path
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Pattern : ^.*$
Required : Yes
Parameter Order : resourceName
Scopes :
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.
Flat Path : download/{downloadId}
Supportsmediadownload : Yes
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Description : Lists targeting options of a given type.
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions
Path : v4/targetingTypes/{+targetingType}/targetingOptions
HTTP Method : GET
Parameters :
targetingType
Location : path
Type : string
Enum :
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 : ^[^/]+$
Required : Yes
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Type : string
Format : int64
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
Format : int32
Location : query
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.
Type : string
Location : query
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 `ListTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
Location : query
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`.
Type : string
Location : query
Parameter Order : targetingType
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
Description : Gets a single targeting option.
Parameters :
targetingType
Required : Yes
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`
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Enum :
Location : path
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Type : string
Format : int64
Location : query
targetingOptionId
Type : string
Location : path
Description : Required. The ID of the of targeting option to retrieve.
Pattern : ^[^/]+$
Required : Yes
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
HTTP Method : GET
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Path : v4/targetingTypes/{+targetingType}/targetingOptions:search
HTTP Method : POST
Parameters :
targetingType
Type : string
Enum :
Location : path
Required : Yes
Description : Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`
Pattern : ^[^/]+$
Enum Descriptions :
Parameter Order : targetingType
Scopes : https://www.googleapis.com/auth/display-video
Description : Searches for targeting options of a given type based on the given search terms.
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions:search
▼ ▲ displayvideo.inventorySourceGroups.get
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceGroupId
Parameters :
partnerId
Description : The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Type : string
Format : int64
Location : query
inventorySourceGroupId
Required : Yes
Description : Required. The ID of the inventory source group to fetch.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
advertiserId
Location : query
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
Format : int64
HTTP Method : GET
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
Description : Gets an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.list
Path : v4/inventorySourceGroups
HTTP Method : GET
Parameters :
partnerId
Location : query
Description : The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
Type : string
Format : int64
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
Format : int64
Location : query
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
Format : int32
filter
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
Location : query
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.
Type : string
Location : query
orderBy
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`.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
Flat Path : v4/inventorySourceGroups
▼ ▲ displayvideo.inventorySourceGroups.create
Path : v4/inventorySourceGroups
HTTP Method : POST
Parameters :
partnerId
Location : query
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
Format : int64
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
Format : int64
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Description : Creates a new inventory source group. Returns the newly created inventory source group if successful.
Flat Path : v4/inventorySourceGroups
▼ ▲ displayvideo.inventorySourceGroups.delete
Description : Deletes an inventory source group.
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
HTTP Method : DELETE
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Type : string
Format : int64
Location : query
inventorySourceGroupId
Type : string
Format : int64
Location : path
Description : Required. The ID of the inventory source group to delete.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Type : string
Format : int64
Location : query
Parameter Order : inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.patch
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : inventorySourceGroupId
Parameters :
inventorySourceGroupId
Required : Yes
Description : Output only. The unique ID of the inventory source group. Assigned by the system.
Location : path
Type : string
Format : int64
advertiserId
Location : query
Description : The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Type : string
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Location : query
partnerId
Location : query
Description : The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Type : string
Format : int64
HTTP Method : PATCH
Path : v4/inventorySourceGroups/{inventorySourceGroupId}
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupId}
Description : Updates an inventory source group. Returns the updated inventory source group if successful.
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
partnerId
Location : query
Description : The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source.
Type : string
Format : int64
inventorySourceGroupId
Required : Yes
Description : Required. The ID of the inventory source group to which this assignment is assigned.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
assignedInventorySourceId
Type : string
Format : int64
Location : path
Description : Required. The ID of the assigned inventory source to delete.
Pattern : ^[^/]+$
Required : Yes
advertiserId
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
Format : int64
Location : query
HTTP Method : DELETE
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
Description : Deletes the assignment between an inventory source and an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
Description : Lists inventory sources assigned to an inventory source group.
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
HTTP Method : GET
Parameter Order : inventorySourceGroupId
Parameters :
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
Format : int64
Location : query
pageSize
Location : query
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.
Type : integer
Format : int32
filter
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
Location : query
partnerId
Location : query
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
Format : int64
inventorySourceGroupId
Description : Required. The ID of the inventory source group to which these assignments are assigned.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
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 `ListAssignedInventorySources` 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: * `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`.
Type : string
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
Parameters :
partnerId
Location : query
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
Format : int64
inventorySourceGroupId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the inventory source group to which the assignment will be assigned.
Pattern : ^[^/]+$
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
Format : int64
Location : query
Parameter Order : inventorySourceGroupId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
HTTP Method : POST
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Description : Creates an assignment between an inventory source and an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/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.
Parameters :
inventorySourceGroupId
Description : Required. The ID of the inventory source group to which the assignments are assigned.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Parameter Order : inventorySourceGroupId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit
HTTP Method : POST
▼ ▲ displayvideo.customLists.list
Description : Lists custom lists. The order is defined by the order_by parameter.
Flat Path : v4/customLists
HTTP Method : GET
Path : v4/customLists
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
advertiserId
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Type : string
Format : int64
Location : query
pageSize
Location : query
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
Format : int32
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
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
orderBy
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`.
Type : string
Location : query
▼ ▲ displayvideo.customLists.get
Description : Gets a custom list.
Flat Path : v4/customLists/{customListsId}
Path : v4/customLists/{+customListId}
HTTP Method : GET
Parameters :
advertiserId
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Type : string
Format : int64
Location : query
customListId
Description : Required. The ID of the custom list to fetch.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Parameter Order : customListId
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
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.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
HTTP Method : POST
Parameter Order : customBiddingAlgorithmId
Parameters :
partnerId
Location : query
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
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Format : int64
Location : query
customBiddingAlgorithmId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern : ^[^/]+$
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Description : Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : customBiddingAlgorithmId
Parameters :
partnerId
Location : query
Description : The ID of the partner that owns the parent custom bidding algorithm.
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Format : int64
Location : query
pageSize
Location : query
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
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 `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
Type : string
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
Type : string
Format : int64
Location : path
Required : Yes
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern : ^[^/]+$
HTTP Method : GET
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
▼ ▲ displayvideo.customBiddingAlgorithms.rules.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
customBiddingAlgorithmRulesId
Description : Required. The ID of the rules resource to fetch.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
partnerId
Location : query
Description : The ID of the partner that owns the parent custom bidding algorithm.
Type : string
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Format : int64
Location : query
customBiddingAlgorithmId
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Parameter Order :
HTTP Method : GET
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
Description : Retrieves a rules resource.
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.create
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
HTTP Method : POST
Parameter Order : customBiddingAlgorithmId
Parameters :
partnerId
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
Format : int64
Location : query
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Format : int64
customBiddingAlgorithmId
Type : string
Format : int64
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the script.
Pattern : ^[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/display-video
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.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
Description : Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
HTTP Method : GET
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
customBiddingAlgorithmId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the custom bidding algorithm owns the script.
Pattern : ^[^/]+$
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
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
partnerId
Location : query
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
Format : int64
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
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.
Type : integer
Format : int32
Location : query
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
Parameter Order :
Parameters :
customBiddingAlgorithmId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the custom bidding algorithm owns the script.
Pattern : ^[^/]+$
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Format : int64
Location : query
customBiddingScriptId
Required : Yes
Description : Required. The ID of the custom bidding script to fetch.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
partnerId
Location : query
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
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
HTTP Method : GET
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
Description : Gets a custom bidding script.
▼ ▲ 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.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
HTTP Method : PATCH
Parameters :
customBiddingAlgorithmId
Description : Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Location : query
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}: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.
Parameter Order : customBiddingAlgorithmId
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Format : int64
Location : query
customBiddingAlgorithmId
Description : Required. The ID of the custom bidding algorithm owns the script.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
partnerId
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
Format : int64
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.list
Flat Path : v4/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.
Parameters :
advertiserId
Location : query
Description : The ID of the DV360 advertiser that has access to the custom bidding algorithm.
Type : string
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.
Type : integer
Format : int32
Location : query
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
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Type : string
Format : int64
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 `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
Type : string
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`.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms
HTTP Method : GET
▼ ▲ displayvideo.customBiddingAlgorithms.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms
HTTP Method : POST
Flat Path : v4/customBiddingAlgorithms
Description : Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
▼ ▲ displayvideo.customBiddingAlgorithms.get
Parameter Order : customBiddingAlgorithmId
Parameters :
partnerId
Location : query
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Type : string
Format : int64
customBiddingAlgorithmId
Type : string
Format : int64
Location : path
Description : Required. The ID of the custom bidding algorithm to fetch.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Location : query
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
HTTP Method : GET
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Description : Gets a custom bidding algorithm.
▼ ▲ displayvideo.customBiddingAlgorithms.uploadRules
Parameter Order : customBiddingAlgorithmId
Parameters :
partnerId
Location : query
Description : The ID of the partner that owns the parent custom bidding algorithm.
Type : string
Format : int64
customBiddingAlgorithmId
Type : string
Format : int64
Location : path
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Type : string
Format : int64
Location : query
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules
HTTP Method : GET
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
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.
▼ ▲ displayvideo.partners.list
Description : Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
Flat Path : v4/partners
Path : v4/partners
HTTP Method : GET
Parameters :
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type : integer
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 `ListPartners` method. If not specified, the first page of results will be returned.
Type : string
Location : query
orderBy
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`.
Type : string
Location : query
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.
Type : string
Location : query
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Required : Yes
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
Parameter Order : partnerId
HTTP Method : POST
Path : v4/partners/{+partnerId}:editAssignedTargetingOptions
Flat Path : v4/partners/{partnersId}: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 .
▼ ▲ displayvideo.partners.get
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Required : Yes
Description : Required. The ID of the partner to fetch.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
Parameter Order : partnerId
HTTP Method : GET
Path : v4/partners/{+partnerId}
Flat Path : v4/partners/{partnersId}
Description : Gets a partner.
▼ ▲ displayvideo.partners.channels.sites.list
HTTP Method : GET
Path : v4/partners/{+partnerId}/channels/{+channelId}/sites
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
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
orderBy
Location : query
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
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent channel.
Type : string
Format : int64
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.
Type : integer
Format : int32
Location : query
filter
Location : query
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.
Type : string
channelId
Description : Required. The ID of the parent channel to which the requested sites belong.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
partnerId
Description : The ID of the partner that owns the parent channel.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
Parameter Order :
Description : Lists sites in a channel.
Flat Path : v4/partners/{partnersId}/channels/{channelsId}/sites
▼ ▲ displayvideo.partners.channels.sites.create
Parameter Order :
Parameters :
partnerId
Description : The ID of the partner that owns the parent channel.
Required : Yes
Type : string
Format : int64
Location : path
channelId
Description : Required. The ID of the parent channel in which the site will be created.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent channel.
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{partnerId}/channels/{+channelId}/sites
HTTP Method : POST
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites
Description : Creates a site in a channel.
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/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.
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
channelId
Required : Yes
Description : Required. The ID of the parent channel to which the sites belong.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
partnerId
Type : string
Format : int64
Location : path
Description : The ID of the partner that owns the parent channel.
Required : Yes
HTTP Method : POST
Path : v4/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit
▼ ▲ displayvideo.partners.channels.sites.replace
HTTP Method : POST
Path : v4/partners/{partnerId}/channels/{+channelId}/sites:replace
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
channelId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the parent channel whose sites will be replaced.
Pattern : ^[^/]+$
partnerId
Required : Yes
Description : The ID of the partner that owns the parent channel.
Type : string
Format : int64
Location : path
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.
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites:replace
▼ ▲ displayvideo.partners.channels.sites.delete
HTTP Method : DELETE
Path : v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Parameters :
channelId
Required : Yes
Description : Required. The ID of the parent channel to which the site belongs.
Pattern : ^[^/]+$
Type : string
Format : int64
Location : path
partnerId
Location : path
Type : string
Format : int64
Required : Yes
Description : The ID of the partner that owns the parent channel.
urlOrAppId
Location : path
Type : string
Description : Required. The URL or app ID of the site to delete.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent channel.
Type : string
Format : int64
Description : Deletes a site from a channel.
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.partners.channels.get
Flat Path : v4/partners/{partnersId}/channels/{channelsId}
Description : Gets a channel for a partner or advertiser.
Parameter Order :
Parameters :
advertiserId
Description : The ID of the advertiser that owns the fetched channel.
Type : string
Format : int64
Location : query
partnerId
Description : The ID of the partner that owns the fetched channel.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
channelId
Description : Required. The ID of the channel to fetch.
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/channels/{+channelId}
HTTP Method : GET
▼ ▲ displayvideo.partners.channels.list
Flat Path : v4/partners/{partnersId}/channels
Description : Lists channels for a partner or advertiser.
Parameters :
partnerId
Type : string
Format : int64
Location : path
Description : The ID of the partner that owns the channels.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Description : The ID of the advertiser that owns the channels.
Type : string
Format : int64
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
Format : int32
Location : query
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
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
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
Parameter Order : partnerId
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/channels
HTTP Method : GET
▼ ▲ displayvideo.partners.channels.create
Flat Path : v4/partners/{partnersId}/channels
Description : Creates a new channel. Returns the newly created channel if successful.
Scopes : https://www.googleapis.com/auth/display-video
Parameters :
partnerId
Location : path
Type : string
Format : int64
Description : The ID of the partner that owns the created channel.
Pattern : ^[^/]+$
Required : Yes
advertiserId
Description : The ID of the advertiser that owns the created channel.
Type : string
Format : int64
Location : query
Parameter Order : partnerId
HTTP Method : POST
Path : v4/partners/{+partnerId}/channels
▼ ▲ displayvideo.partners.channels.patch
Flat Path : v4/partners/{partnersId}/channels/{channelId}
Description : Updates a channel. Returns the updated channel if successful.
Parameters :
partnerId
Location : path
Type : string
Format : int64
Description : The ID of the partner that owns the created channel.
Pattern : ^[^/]+$
Required : Yes
channelId
Location : path
Type : string
Format : int64
Required : Yes
Description : Output only. The unique ID of the channel. Assigned by the system.
updateMask
Description : Required. The mask to control which fields to update.
Type : string
Format : google-fieldmask
Location : query
advertiserId
Location : query
Description : The ID of the advertiser that owns the created channel.
Type : string
Format : int64
Parameter Order :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/channels/{channelId}
HTTP Method : PATCH
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : GET
Parameter Order :
Parameters :
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 `ListPartnerAssignedTargetingOptions` 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: * `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
partnerId
Type : string
Format : int64
Location : path
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
Required : Yes
targetingType
Enum Descriptions :
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Required : Yes
Location : path
Type : string
Enum :
pageSize
Location : query
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
Format : int32
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
Scopes : https://www.googleapis.com/auth/display-video
Description : Lists the targeting options assigned to a partner.
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
Parameter Order :
Parameters :
partnerId
Location : path
Type : string
Format : int64
Required : Yes
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
targetingType
Type : string
Enum :
Location : path
Required : Yes
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Enum Descriptions :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method : POST
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description : Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Description : Gets a single targeting option assigned to a partner.
Parameter Order :
Parameters :
partnerId
Required : Yes
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
Location : path
Type : string
Format : int64
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Pattern : ^[^/]+$
Required : Yes
Type : string
Location : path
targetingType
Type : string
Enum :
Location : path
Required : Yes
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Enum Descriptions :
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : GET
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Description : Deletes an assigned targeting option from a partner.
Parameter Order :
Parameters :
targetingType
Required : Yes
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Enum Descriptions :
Type : string
Enum :
Location : path
assignedTargetingOptionId
Required : Yes
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Type : string
Location : path
partnerId
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
Required : Yes
Type : string
Format : int64
Location : path
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method : DELETE
▼ ▲ displayvideo.partners.channels.get
Flat Path : v4/partners/{partnersId}/channels/{channelsId}
HTTP Method : GET
Parameters :
channelId
Required : Yes
Type : string
Description : Required. The ID of the channel to fetch.
Pattern : ^[^/]+$
Format : int64
Location : path
advertiserId
Description : The ID of the advertiser that owns the fetched channel.
Format : int64
Type : string
Location : query
partnerId
Description : The ID of the partner that owns the fetched channel.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Parameter Order :
Path : v4/partners/{+partnerId}/channels/{+channelId}
Description : Gets a channel for a partner or advertiser.
▼ ▲ displayvideo.partners.channels.create
Flat Path : v4/partners/{partnersId}/channels
Path : v4/partners/{+partnerId}/channels
Description : Creates a new channel. Returns the newly created channel if successful.
Parameter Order : partnerId
HTTP Method : POST
Parameters :
partnerId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
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
Type : string
Location : query
▼ ▲ displayvideo.partners.channels.list
HTTP Method : GET
Parameters :
partnerId
Description : The ID of the partner that owns the channels.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
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 `ListChannels` 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
advertiserId
Description : The ID of the advertiser that owns the channels.
Format : int64
Type : string
Location : query
orderBy
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`.
Location : query
filter
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.
Location : query
Parameter Order : partnerId
Path : v4/partners/{+partnerId}/channels
Description : Lists channels for a partner or advertiser.
Flat Path : v4/partners/{partnersId}/channels
▼ ▲ displayvideo.partners.channels.patch
Parameter Order :
Path : v4/partners/{+partnerId}/channels/{channelId}
Description : Updates a channel. Returns the updated channel if successful.
HTTP Method : PATCH
Parameters :
channelId
Format : int64
Location : path
Required : Yes
Type : string
Description : Output only. The unique ID of the channel. Assigned by the system.
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Location : query
advertiserId
Type : string
Description : The ID of the advertiser that owns the created channel.
Format : int64
Location : query
partnerId
Description : The ID of the partner that owns the created channel.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Flat Path : v4/partners/{partnersId}/channels/{channelId}
▼ ▲ displayvideo.partners.channels.sites.delete
HTTP Method : DELETE
Parameters :
channelId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the parent channel to which the site belongs.
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Type : string
partnerId
Description : The ID of the partner that owns the parent channel.
Required : Yes
Type : string
Location : path
Format : int64
urlOrAppId
Description : Required. The URL or app ID of the site to delete.
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Path : v4/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
Description : Deletes a site from a channel.
Parameter Order :
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
HTTP Method : POST
Parameters :
channelId
Description : Required. The ID of the parent channel to which the sites belong.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
partnerId
Required : Yes
Type : string
Description : The ID of the partner that owns the parent channel.
Location : path
Format : int64
Path : v4/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 :
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites:bulkEdit
▼ ▲ displayvideo.partners.channels.sites.list
HTTP Method : GET
Parameters :
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Type : string
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
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
partnerId
Description : The ID of the partner that owns the parent channel.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
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.
channelId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the parent channel to which the requested sites belong.
Required : Yes
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
Parameter Order :
Path : v4/partners/{+partnerId}/channels/{+channelId}/sites
Description : Lists sites in a channel.
Flat Path : v4/partners/{partnersId}/channels/{channelsId}/sites
▼ ▲ displayvideo.partners.channels.sites.replace
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites:replace
Parameter Order :
Path : v4/partners/{partnerId}/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
Parameters :
partnerId
Format : int64
Location : path
Required : Yes
Type : string
Description : The ID of the partner that owns the parent channel.
channelId
Required : Yes
Type : string
Description : Required. The ID of the parent channel whose sites will be replaced.
Pattern : ^[^/]+$
Format : int64
Location : path
▼ ▲ displayvideo.partners.channels.sites.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/partners/{partnerId}/channels/{channelsId}/sites
Path : v4/partners/{partnerId}/channels/{+channelId}/sites
Description : Creates a site in a channel.
Parameter Order :
HTTP Method : POST
Parameters :
partnerId
Required : Yes
Type : string
Description : The ID of the partner that owns the parent channel.
Location : path
Format : int64
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Type : string
Location : query
channelId
Pattern : ^[^/]+$
Description : Required. The ID of the parent channel in which the site will be created.
Required : Yes
Type : string
Location : path
Format : int64
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
Parameter Order :
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Gets a single targeting option assigned to a partner.
HTTP Method : GET
Parameters :
targetingType
Required : Yes
Type : string
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Location : path
Enum Descriptions :
Enum :
partnerId
Required : Yes
Type : string
Description : Required. The ID of the partner.
Pattern : ^[^/]+$
Format : int64
Location : path
assignedTargetingOptionId
Location : path
Description : Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Required : Yes
Type : string
Pattern : ^[^/]+$
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
HTTP Method : POST
Parameters :
partnerId
Description : Required. The ID of the partner.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
targetingType
Required : Yes
Type : string
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
Location : path
Enum Descriptions :
Enum :
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
Parameter Order :
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameter Order :
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Deletes an assigned targeting option from a partner.
HTTP Method : DELETE
Parameters :
targetingType
Location : path
Enum Descriptions :
Enum :
Required : Yes
Type : string
Description : Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Pattern : ^[^/]+$
partnerId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the partner.
Location : path
Format : int64
assignedTargetingOptionId
Location : path
Description : Required. The ID of the assigned targeting option to delete.
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Flat Path : v4/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
Parameters :
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
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.
Location : query
targetingType
Location : path
Enum Descriptions :
Enum :
Description : Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Required : Yes
Type : string
Pattern : ^[^/]+$
partnerId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the partner.
Required : Yes
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.
Format : int32
Type : integer
Location : query
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 `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
Parameter Order :
Path : v4/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to a partner.
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
HTTP Method : POST
Parameters :
partnerId
Description : Required. The ID of the partner.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Path : v4/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
Flat Path : v4/partners/{partnersId}:editAssignedTargetingOptions
▼ ▲ displayvideo.partners.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/partners/{partnersId}
Parameter Order : partnerId
Path : v4/partners/{+partnerId}
Description : Gets a partner.
HTTP Method : GET
Parameters :
partnerId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the partner to fetch.
▼ ▲ displayvideo.partners.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/partners
Description : Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
HTTP Method : GET
Parameters :
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 `ListPartners` method. If not specified, the first page of results will be returned.
Type : string
pageSize
Location : query
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
orderBy
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`.
Location : query
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.
Type : string
Location : query
Flat Path : v4/partners
▼ ▲ displayvideo.sdfuploadtasks.operations.get
Scopes :
Flat Path : v4/sdfuploadtasks/operations/{operationsId}
Parameter Order : name
Path : v4/{+name}
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Required : Yes
Type : string
Pattern : ^sdfuploadtasks/operations/[^/]+$
Location : path
▼ ▲ displayvideo.customLists.get
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : customListId
Path : v4/customLists/{+customListId}
Description : Gets a custom list.
HTTP Method : GET
Parameters :
customListId
Pattern : ^[^/]+$
Description : Required. The ID of the custom list to fetch.
Required : Yes
Type : string
Location : path
Format : int64
advertiserId
Type : string
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Format : int64
Location : query
Flat Path : v4/customLists/{customListsId}
▼ ▲ displayvideo.customLists.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customLists
HTTP Method : GET
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
Type : integer
Location : query
pageToken
Location : query
Type : string
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned.
orderBy
Location : query
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`.
Type : string
filter
Location : query
Type : string
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.
advertiserId
Type : string
Description : The ID of the DV360 advertiser that has access to the fetched custom lists.
Format : int64
Location : query
Path : v4/customLists
Description : Lists custom lists. The order is defined by the order_by parameter.
▼ ▲ displayvideo.advertisers.audit
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser to audit.
readMask
Type : string
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
Path : v4/advertisers/{+advertiserId}: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.
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}:audit
▼ ▲ displayvideo.advertisers.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}
HTTP Method : GET
Parameters :
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser to fetch.
Location : path
Format : int64
Path : v4/advertisers/{+advertiserId}
Description : Gets an advertiser.
Parameter Order : advertiserId
▼ ▲ displayvideo.advertisers.create
Flat Path : v4/advertisers
HTTP Method : POST
Path : v4/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.
▼ ▲ displayvideo.advertisers.list
Flat Path : v4/advertisers
Path : v4/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.
HTTP Method : GET
Parameters :
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 `ListAdvertisers` method. If not specified, the first page of results will be returned.
Location : query
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Type : integer
partnerId
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
Location : query
orderBy
Location : query
Type : string
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`.
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.
Type : string
Location : query
▼ ▲ displayvideo.advertisers.patch
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameters :
updateMask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
advertiserId
Format : int64
Location : path
Description : Output only. The unique ID of the advertiser. Assigned by the system.
Required : Yes
Type : string
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}
Description : Updates an existing advertiser. Returns the updated advertiser if successful.
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Path : v4/advertisers/{+advertiserId}:listAssignedTargetingOptions
Description : Lists assigned targeting options of an advertiser across targeting types.
Parameter Order : advertiserId
HTTP Method : GET
Parameters :
pageToken
Location : query
Type : string
Description : A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
pageSize
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
Type : integer
Location : query
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Type : string
orderBy
Location : query
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
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 `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.
Type : string
Location : query
Flat Path : v4/advertisers/{advertisersId}:listAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.delete
HTTP Method : DELETE
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : The ID of the advertiser we need to delete.
Required : Yes
Type : string
Path : v4/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
Flat Path : v4/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.editAssignedTargetingOptions
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser.
Required : Yes
Type : string
Path : v4/advertisers/{+advertiserId}: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 .
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}:editAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Scopes :
Path : v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
Description : Retrieves the invoice currency used by an advertiser in a given month.
Parameter Order : advertiserId
HTTP Method : GET
Parameters :
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the advertiser to lookup currency for.
Pattern : ^[^/]+$
Format : int64
Location : path
invoiceMonth
Location : query
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.
Type : string
Flat Path : v4/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
▼ ▲ displayvideo.advertisers.invoices.list
Scopes :
Path : v4/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
Parameters :
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.
Type : string
Location : query
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser to list invoices for.
Pattern : ^[^/]+$
loiSapinInvoiceType
Location : query
Enum Descriptions :
Enum :
Description : Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
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 `ListInvoices` method. If not specified, the first page of results will be returned.
Type : string
Location : query
pageSize
Location : query
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
Type : integer
Flat Path : v4/advertisers/{advertisersId}/invoices
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
HTTP Method : GET
Parameters :
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.
Type : string
Location : query
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
Type : integer
Location : query
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser the line item belongs to.
Location : path
Format : int64
targetingType
Pattern : ^[^/]+$
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)
Required : Yes
Type : string
Location : path
Enum Descriptions :
Enum :
orderBy
Description : Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
Type : string
Location : query
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
Required : Yes
Type : string
Description : Required. The ID of the line item to list assigned targeting options for.
Pattern : ^[^/]+$
Format : int64
Location : path
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to a line item.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameters :
advertiserId
Format : int64
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
targetingType
Location : path
Enum Descriptions :
Enum :
Required : Yes
Type : string
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 : ^[^/]+$
lineItemId
Description : Required. The ID of the line item the assigned targeting option belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
assignedTargetingOptionId
Pattern : ^[^/]+$
Description : Required. The ID of the assigned targeting option to delete.
Required : Yes
Type : string
Location : path
Path : v4/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 :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Gets a single targeting option assigned to a line item.
HTTP Method : GET
Parameters :
lineItemId
Required : Yes
Type : string
Description : Required. The ID of the line item the assigned targeting option belongs to.
Pattern : ^[^/]+$
Format : int64
Location : path
assignedTargetingOptionId
Location : path
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Required : Yes
Type : string
Pattern : ^[^/]+$
advertiserId
Format : int64
Location : path
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
targetingType
Pattern : ^[^/]+$
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)
Required : Yes
Type : string
Location : path
Enum Descriptions :
Enum :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
HTTP Method : POST
Parameters :
lineItemId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the line item the assigned targeting option will belong to.
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the line item belongs to.
Required : Yes
Type : string
targetingType
Location : path
Enum Descriptions :
Enum :
Pattern : ^[^/]+$
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`
Required : Yes
Type : string
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
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.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
linkedEntity.adGroupId
Description : The ID of an ad group.
Format : int64
Type : string
Location : query
youtubeAssetType
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The type of YouTube asset associated with the resource.
Location : path
Enum Descriptions :
Enum :
lineItemId
Format : int64
Location : path
Description : The ID of a line item.
Required : Yes
Type : string
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Description : Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
Description : Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
HTTP Method : DELETE
Parameters :
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Format : int64
Location : path
lineItemId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : The ID of a line item.
Required : Yes
Type : string
youtubeAssetAssociationId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.
Required : Yes
Type : string
linkedEntity.adGroupId
Location : query
Type : string
Description : The ID of an ad group.
Format : int64
youtubeAssetType
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The type of YouTube asset associated with the resource.
Location : path
Enum Descriptions :
Enum :
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
▼ ▲ displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Description : Lists the YouTube asset associations linked to the given resource.
Parameter Order :
HTTP Method : GET
Parameters :
orderBy
Location : query
Description : Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
Type : string
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
lineItemId
Description : The ID of a line item.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
pageSize
Type : integer
Description : Optional. 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
linkedEntity.adGroupId
Location : query
Description : The ID of an ad group.
Format : int64
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
youtubeAssetType
Location : path
Enum Descriptions :
Enum :
Required : Yes
Type : string
Description : Required. The type of YouTube asset being associated with the resource.
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
HTTP Method : GET
Parameters :
lineItemIds
Location : query
Format : int64
Description : Required. The IDs of the line items to list assigned targeting options for.
Repeated : Yes
Type : string
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser the line items belongs to.
Location : path
Format : int64
orderBy
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
Location : query
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 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
pageToken
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.
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.
Format : int32
Location : query
Path : v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple line items across targeting types.
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/lineItems
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/lineItems
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.
HTTP Method : GET
Parameters :
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser to list line items for.
Required : Yes
Type : string
Location : path
Format : int64
orderBy
Location : query
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`.
filter
Location : query
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
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 `ListLineItems` method. If not specified, the first page of results will be returned.
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.
Format : int32
Type : integer
Location : query
▼ ▲ displayvideo.advertisers.lineItems.patch
HTTP Method : PATCH
Parameters :
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Output only. The unique ID of the advertiser the line item belongs to.
Pattern : ^[^/]+$
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
lineItemId
Format : int64
Location : path
Required : Yes
Type : string
Description : Output only. The unique ID of the line item. Assigned by the system.
Pattern : ^[^/]+$
Parameter Order :
Path : v4/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.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
▼ ▲ displayvideo.advertisers.lineItems.get
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser this line item belongs to.
lineItemId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the line item to fetch.
Pattern : ^[^/]+$
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Description : Gets a line item.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
HTTP Method : POST
Parameters :
advertiserId
Description : Required. The ID of the advertiser the line items belong to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Path : v4/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.
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.duplicate
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}: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.
HTTP Method : POST
Parameters :
lineItemId
Description : Required. The ID of the line item to duplicate.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this line item belongs to.
Required : Yes
Type : string
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
▼ ▲ displayvideo.advertisers.lineItems.delete
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
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.
Parameter Order :
HTTP Method : DELETE
Parameters :
advertiserId
Format : int64
Location : path
Description : The ID of the advertiser this line item belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
lineItemId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : The ID of the line item to delete.
Flat Path : v4/advertisers/{advertisersId}/lineItems/{lineItemsId}
▼ ▲ displayvideo.advertisers.lineItems.bulkUpdate
Flat Path : v4/advertisers/{advertisersId}/lineItems:bulkUpdate
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/lineItems:bulkUpdate
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.
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser this line item belongs to.
▼ ▲ displayvideo.advertisers.lineItems.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/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
Parameters :
advertiserId
Description : Output only. The unique ID of the advertiser the line item belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Flat Path : v4/advertisers/{advertisersId}/lineItems
▼ ▲ displayvideo.advertisers.adAssets.list
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
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 `ListAdAssets` method. If not specified, the first page of results will be returned.
Type : string
Location : query
pageSize
Location : query
Type : integer
Description : Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
advertiserId
Format : int64
Location : path
Description : Required. The ID of the advertiser the ad assets belong to.
Required : Yes
Type : string
Pattern : ^[^/]+$
orderBy
Description : Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (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: `adAssetId desc`.
Type : string
Location : query
filter
Location : query
Description : Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`
Type : string
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/adAssets
Description : Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Flat Path : v4/advertisers/{advertisersId}/adAssets
▼ ▲ displayvideo.advertisers.adAssets.upload
Flat Path : v4/advertisers/{advertisersId}/adAssets:uploadAdAsset
Path : v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Description : Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.
Parameter Order : advertiserId
HTTP Method : POST
Parameters :
advertiserId
Description : Required. The ID of the advertiser this ad asset belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset
Multipart : Yes
Supportsmediaupload : Yes
▼ ▲ displayvideo.advertisers.adAssets.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adAssets/{adAssetsId}
Path : v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}
Description : Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Parameter Order :
HTTP Method : GET
Parameters :
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser this ad asset belongs to.
Pattern : ^[^/]+$
adAssetId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.adAssets.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adAssets
Description : Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Parameter Order : advertiserId
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad asset belongs to.
Required : Yes
Type : string
Flat Path : v4/advertisers/{advertisersId}/adAssets
▼ ▲ displayvideo.advertisers.adAssets.bulkCreate
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser these ad assets belong to.
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/adAssets:bulkCreate
Description : Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
Flat Path : v4/advertisers/{advertisersId}/adAssets:bulkCreate
▼ ▲ displayvideo.advertisers.creatives.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
Parameter Order :
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
Description : Gets a creative.
HTTP Method : GET
Parameters :
creativeId
Description : Required. The ID of the creative to fetch.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser this creative belongs to.
▼ ▲ displayvideo.advertisers.creatives.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/creatives
Parameter Order : advertiserId
Path : v4/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.
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the creative belongs to.
Required : Yes
Type : string
▼ ▲ displayvideo.advertisers.creatives.delete
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
Parameter Order :
Path : v4/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.
HTTP Method : DELETE
Parameters :
creativeId
Description : The ID of the creative to be deleted.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : The ID of the advertiser this creative belongs to.
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.creatives.list
Flat Path : v4/advertisers/{advertisersId}/creatives
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/creatives
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.
HTTP Method : GET
Parameters :
orderBy
Location : query
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
filter
Location : query
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.
Type : string
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser to list creatives for.
Location : path
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
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 `ListCreatives` method. If not specified, the first page of results will be returned.
Location : query
▼ ▲ displayvideo.advertisers.creatives.patch
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/creatives/{+creativeId}
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.
Parameter Order :
HTTP Method : PATCH
Parameters :
creativeId
Format : int64
Location : path
Description : Output only. The unique ID of the creative. Assigned by the system.
Required : Yes
Type : string
Pattern : ^[^/]+$
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the creative belongs to.
Required : Yes
Type : string
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Flat Path : v4/advertisers/{advertisersId}/creatives/{creativesId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
HTTP Method : GET
Parameters :
advertiserId
Description : Required. The ID of the advertiser.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
targetingType
Location : path
Enum Descriptions :
Enum :
Required : Yes
Type : string
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`
Pattern : ^[^/]+$
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Gets a single targeting option assigned to an advertiser.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Parameter Order :
HTTP Method : POST
Parameters :
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser.
Required : Yes
Type : string
Location : path
Format : int64
targetingType
Location : path
Enum Descriptions :
Enum :
Required : Yes
Type : string
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 : ^[^/]+$
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameters :
assignedTargetingOptionId
Required : Yes
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
Location : path
advertiserId
Description : Required. The ID of the advertiser.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
targetingType
Pattern : ^[^/]+$
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
Type : string
Location : path
Enum Descriptions :
Enum :
Parameter Order :
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Description : Deletes an assigned targeting option from an advertiser.
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
Parameters :
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.
Format : int32
Location : query
pageToken
Location : query
Type : string
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
orderBy
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`.
Location : query
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.
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser.
Required : Yes
Type : string
targetingType
Location : path
Enum Descriptions :
Enum :
Pattern : ^[^/]+$
Required : Yes
Type : string
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`
Parameter Order :
Path : v4/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to an advertiser.
▼ ▲ displayvideo.advertisers.insertionOrders.delete
Path : v4/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.
Parameter Order :
HTTP Method : DELETE
Parameters :
advertiserId
Description : The ID of the advertiser this insertion order belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
insertionOrderId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : The ID of the insertion order to delete.
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
▼ ▲ displayvideo.advertisers.insertionOrders.list
Flat Path : v4/advertisers/{advertisersId}/insertionOrders
HTTP Method : GET
Parameters :
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser to list insertion orders for.
Location : path
Format : int64
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
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.
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 `ListInsertionOrders` method. If not specified, the first page of results will be returned.
Type : string
Location : query
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
Location : query
Parameter Order : advertiserId
Path : v4/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.patch
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
HTTP Method : PATCH
Parameters :
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Location : query
advertiserId
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
insertionOrderId
Pattern : ^[^/]+$
Description : Output only. The unique ID of the insertion order. Assigned by the system.
Required : Yes
Type : string
Location : path
Format : int64
Parameter Order :
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Description : Updates an existing insertion order. Returns the updated insertion order if successful.
▼ ▲ displayvideo.advertisers.insertionOrders.get
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser this insertion order belongs to.
insertionOrderId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the insertion order to fetch.
Path : v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Description : Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
▼ ▲ displayvideo.advertisers.insertionOrders.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/insertionOrders
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/insertionOrders
Description : Creates a new insertion order. Returns the newly created insertion order if successful.
HTTP Method : POST
Parameters :
advertiserId
Format : int64
Location : path
Description : Output only. The unique ID of the advertiser the insertion order belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.channels.sites.create
HTTP Method : POST
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Type : string
Format : int64
Location : path
channelId
Pattern : ^[^/]+$
Description : Required. The ID of the parent channel in which the site will be created.
Required : Yes
Type : string
Location : path
Format : int64
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent channel.
Format : int64
Parameter Order :
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites
Description : Creates a site in a channel.
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites
▼ ▲ displayvideo.advertisers.channels.sites.replace
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites:replace
Parameter Order :
Path : v4/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
Parameters :
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : The ID of the advertiser that owns the parent channel.
channelId
Description : Required. The ID of the parent channel whose sites will be replaced.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.channels.sites.list
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}/sites
Parameter Order :
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}/sites
Description : Lists sites in a channel.
HTTP Method : GET
Parameters :
channelId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the parent channel to which the requested sites belong.
Location : path
Format : int64
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
Type : integer
Location : query
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
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent channel.
Format : int64
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
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.
Type : string
advertiserId
Format : int64
Location : path
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
HTTP Method : POST
Parameters :
advertiserId
Format : int64
Location : path
Description : The ID of the advertiser that owns the parent channel.
Required : Yes
Type : string
channelId
Format : int64
Location : path
Description : Required. The ID of the parent channel to which the sites belong.
Required : Yes
Type : string
Pattern : ^[^/]+$
Parameter Order :
Path : v4/advertisers/{advertiserId}/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.
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
▼ ▲ displayvideo.advertisers.channels.sites.delete
Path : v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
Description : Deletes a site from a channel.
Parameter Order :
HTTP Method : DELETE
Parameters :
advertiserId
Required : Yes
Type : string
Description : The ID of the advertiser that owns the parent channel.
Format : int64
Location : path
channelId
Required : Yes
Type : string
Description : Required. The ID of the parent channel to which the site belongs.
Pattern : ^[^/]+$
Format : int64
Location : path
urlOrAppId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The URL or app ID of the site to delete.
Location : path
partnerId
Type : string
Description : The ID of the partner that owns the parent channel.
Format : int64
Location : query
Flat Path : v4/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.advertisers.channels.get
Flat Path : v4/advertisers/{advertisersId}/channels/{channelsId}
HTTP Method : GET
Parameters :
partnerId
Description : The ID of the partner that owns the fetched channel.
Format : int64
Type : string
Location : query
channelId
Format : int64
Location : path
Description : Required. The ID of the channel to fetch.
Required : Yes
Type : string
Pattern : ^[^/]+$
advertiserId
Format : int64
Location : path
Description : The ID of the advertiser that owns the fetched channel.
Required : Yes
Type : string
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}/channels/{+channelId}
Description : Gets a channel for a partner or advertiser.
Parameter Order :
▼ ▲ displayvideo.advertisers.channels.create
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/channels
Description : Creates a new channel. Returns the newly created channel if successful.
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : The ID of the advertiser that owns the created channel.
Required : Yes
Type : string
partnerId
Location : query
Description : The ID of the partner that owns the created channel.
Format : int64
Type : string
Flat Path : v4/advertisers/{advertisersId}/channels
▼ ▲ displayvideo.advertisers.channels.list
Flat Path : v4/advertisers/{advertisersId}/channels
Path : v4/advertisers/{+advertiserId}/channels
Description : Lists channels for a partner or advertiser.
Parameter Order : advertiserId
HTTP Method : GET
Parameters :
pageSize
Location : query
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
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
partnerId
Location : query
Description : The ID of the partner that owns the channels.
Format : int64
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`.
filter
Location : query
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
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : The ID of the advertiser that owns the channels.
▼ ▲ displayvideo.advertisers.channels.patch
Flat Path : v4/advertisers/{advertisersId}/channels/{channelId}
HTTP Method : PATCH
Parameters :
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the created channel.
Format : int64
channelId
Description : Output only. The unique ID of the channel. Assigned by the system.
Required : Yes
Type : string
Format : int64
Location : path
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
advertiserId
Pattern : ^[^/]+$
Description : The ID of the advertiser that owns the created channel.
Required : Yes
Type : string
Location : path
Format : int64
Parameter Order :
Path : v4/advertisers/{+advertiserId}/channels/{channelId}
Description : Updates a channel. Returns the updated channel if successful.
▼ ▲ displayvideo.advertisers.assets.upload
Flat Path : v4/advertisers/{advertisersId}/assets
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser this asset belongs to.
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/v4/advertisers/{+advertiserId}/assets
Path : v4/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).
Parameter Order : advertiserId
Supportsmediaupload : Yes
▼ ▲ displayvideo.advertisers.adGroups.delete
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
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 :
HTTP Method : DELETE
Parameters :
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser this ad group belongs to.
Pattern : ^[^/]+$
adGroupId
Pattern : ^[^/]+$
Description : Required. The ID of the ad group to delete.
Required : Yes
Type : string
Location : path
Format : int64
▼ ▲ displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions
Flat Path : v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions
Path : v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions
Description : Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
Parameter Order : advertiserId
HTTP Method : GET
Parameters :
pageToken
Type : string
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
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.
Format : int32
Location : query
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser the line items belongs to.
Pattern : ^[^/]+$
adGroupIds
Description : Required. The IDs of the ad groups to list assigned targeting options for.
Repeated : Yes
Type : string
Location : query
Format : int64
orderBy
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`.
Location : query
filter
Location : query
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.
Type : string
▼ ▲ displayvideo.advertisers.adGroups.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups
HTTP Method : GET
Parameters :
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser the ad groups belongs to.
Pattern : ^[^/]+$
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
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
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.
Type : string
Location : query
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
Type : integer
Location : query
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/adGroups
Description : Lists ad groups.
▼ ▲ displayvideo.advertisers.adGroups.patch
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
Parameter Order :
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
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.
HTTP Method : PATCH
Parameters :
adGroupId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Output only. The unique ID of the ad group. Assigned by the system.
updateMask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
advertiserId
Required : Yes
Type : string
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Pattern : ^[^/]+$
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.adGroups.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}
HTTP Method : GET
Parameters :
adGroupId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the ad group to fetch.
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad group belongs to.
Required : Yes
Type : string
Location : path
Format : int64
Parameter Order :
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Description : Gets an ad group.
▼ ▲ displayvideo.advertisers.adGroups.create
Flat Path : v4/advertisers/{advertisersId}/adGroups
Parameter Order : advertiserId
Path : v4/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.
HTTP Method : POST
Parameters :
advertiserId
Format : int64
Location : path
Description : Output only. The unique ID of the advertiser the ad group belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/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.
HTTP Method : POST
Parameters :
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the advertiser the ad groups belong to.
Pattern : ^[^/]+$
Format : int64
Location : path
Flat Path : v4/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
HTTP Method : GET
Parameters :
advertiserId
Description : Required. The ID of the advertiser the ad group belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
targetingType
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
Type : string
Pattern : ^[^/]+$
Location : path
Enum Descriptions :
Enum :
adGroupId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the ad group to list assigned targeting options for.
orderBy
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`.
Type : string
Location : query
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.
Type : string
Location : query
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.
Type : string
Location : query
pageSize
Location : query
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.
Format : int32
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description : Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser the ad group belongs to.
Required : Yes
Type : string
targetingType
Location : path
Enum Descriptions :
Enum :
Required : Yes
Type : string
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`
Pattern : ^[^/]+$
adGroupId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Location : path
Format : int64
assignedTargetingOptionId
Description : Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Path : v4/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.
Parameter Order :
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameters :
adGroupId
Format : int64
Location : path
Description : Required. The ID of the ad group the assigned targeting option will belong to.
Required : Yes
Type : string
Pattern : ^[^/]+$
advertiserId
Format : int64
Location : path
Description : Required. The ID of the advertiser the ad group belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
targetingType
Location : path
Enum Descriptions :
Enum :
Pattern : ^[^/]+$
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`
Required : Yes
Type : string
Parameter Order :
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
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.
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameters :
assignedTargetingOptionId
Location : path
Required : Yes
Type : string
Description : Required. The ID of the assigned targeting option to delete.
Pattern : ^[^/]+$
advertiserId
Format : int64
Location : path
Description : Required. The ID of the advertiser the ad group belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
targetingType
Location : path
Enum Descriptions :
Enum :
Pattern : ^[^/]+$
Required : Yes
Type : string
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`
adGroupId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the ad group the assigned targeting option belongs to.
Required : Yes
Type : string
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
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.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create
Parameter Order :
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Description : Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
HTTP Method : POST
Parameters :
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
Pattern : ^[^/]+$
Format : int64
Location : path
adGroupId
Required : Yes
Type : string
Description : The ID of an ad group.
Pattern : ^[^/]+$
Format : int64
Location : path
youtubeAssetType
Location : path
Enum Descriptions :
Enum :
Description : Required. The type of YouTube asset associated with the resource.
Required : Yes
Type : string
Pattern : ^[^/]+$
linkedEntity.lineItemId
Description : The ID of a line item.
Format : int64
Type : string
Location : query
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : DELETE
Parameters :
youtubeAssetType
Location : path
Enum Descriptions :
Enum :
Required : Yes
Type : string
Description : Required. The type of YouTube asset associated with the resource.
Pattern : ^[^/]+$
linkedEntity.lineItemId
Location : query
Type : string
Description : The ID of a line item.
Format : int64
youtubeAssetAssociationId
Description : Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
adGroupId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : The ID of an ad group.
Location : path
Format : int64
advertiserId
Format : int64
Location : path
Description : Required. The ID of the advertiser that the linked entity belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}
Description : Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
Parameter Order :
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}
▼ ▲ displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list
Flat Path : v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser that the linked entity belongs to.
adGroupId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : The ID of an ad group.
Location : path
Format : int64
orderBy
Location : query
Description : Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
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 `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
pageSize
Location : query
Type : integer
Description : Optional. 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
youtubeAssetType
Description : Required. The type of YouTube asset being associated with the resource.
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
Enum Descriptions :
Enum :
linkedEntity.lineItemId
Type : string
Description : The ID of a line item.
Format : int64
Location : query
Path : v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations
Description : Lists the YouTube asset associations linked to the given resource.
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.get
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListsId}
Path : v4/advertisers/{+advertiserId}/locationLists/{+locationListId}
Description : Gets a location list.
Parameter Order :
HTTP Method : GET
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
locationListId
Format : int64
Location : path
Description : Required. The ID of the location list to fetch.
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ displayvideo.advertisers.locationLists.create
Flat Path : v4/advertisers/{advertisersId}/locationLists
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/locationLists
Description : Creates a new location list. Returns the newly created location list if successful.
HTTP Method : POST
Parameters :
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.locationLists.list
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
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
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.
Type : string
Location : query
orderBy
Type : string
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
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.
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}/locationLists
Description : Lists location lists based on a given advertiser id.
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/locationLists
▼ ▲ displayvideo.advertisers.locationLists.patch
Flat Path : v4/advertisers/{advertisersId}/locationLists/{locationListId}
Path : v4/advertisers/{+advertiserId}/locationLists/{locationListId}
Description : Updates a location list. Returns the updated location list if successful.
Parameter Order :
HTTP Method : PATCH
Parameters :
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the location lists belongs.
Pattern : ^[^/]+$
Format : int64
Location : path
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
locationListId
Required : Yes
Type : string
Description : Output only. The unique ID of the location list. Assigned by the system.
Format : int64
Location : path
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
Description : Deletes the assignment between a location and a location list.
HTTP Method : DELETE
Parameters :
locationListId
Required : Yes
Type : string
Description : Required. The ID of the location list to which this assignment is assigned.
Location : path
Format : int64
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
assignedLocationId
Format : int64
Location : path
Description : Required. The ID of the assigned location to delete.
Required : Yes
Type : string
Pattern : ^[^/]+$
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : POST
Parameters :
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Location : path
Format : int64
locationListId
Required : Yes
Type : string
Description : Required. The ID of the location list for which the assignment will be created.
Location : path
Format : int64
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Description : Creates an assignment between a location and a location list.
Parameter Order :
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
HTTP Method : POST
Parameters :
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
locationListId
Pattern : ^[^/]+$
Description : Required. The ID of the location list to which these assignments are assigned.
Required : Yes
Type : string
Location : path
Format : int64
Path : v4/advertisers/{advertiserId}/locationLists/{+locationListId}/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.
Parameter Order :
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method : GET
Parameters :
locationListId
Required : Yes
Type : string
Description : Required. The ID of the location list to which these assignments are assigned.
Location : path
Format : int64
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
filter
Location : query
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
advertiserId
Description : Required. The ID of the DV360 advertiser to which the location list belongs.
Required : Yes
Type : string
Location : path
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
Type : integer
Location : query
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 `ListAssignedLocations` method. If not specified, the first page of results will be returned.
Type : string
Path : v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Description : Lists locations assigned to a location list.
Parameter Order :
▼ ▲ displayvideo.advertisers.campaigns.get
Scopes :
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Description : Gets a campaign.
Parameter Order :
HTTP Method : GET
Parameters :
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the advertiser this campaign belongs to.
Pattern : ^[^/]+$
campaignId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the campaign to fetch.
Pattern : ^[^/]+$
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
▼ ▲ displayvideo.advertisers.campaigns.create
HTTP Method : POST
Parameters :
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Output only. The unique ID of the advertiser the campaign belongs to.
Location : path
Format : int64
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/campaigns
Description : Creates a new campaign. Returns the newly created campaign if successful.
Flat Path : v4/advertisers/{advertisersId}/campaigns
Scopes :
▼ ▲ displayvideo.advertisers.campaigns.delete
Parameter Order :
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
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.
HTTP Method : DELETE
Parameters :
advertiserId
Format : int64
Location : path
Description : The ID of the advertiser this campaign belongs to.
Required : Yes
Type : string
Pattern : ^[^/]+$
campaignId
Description : The ID of the campaign we need to delete.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
Scopes :
▼ ▲ displayvideo.advertisers.campaigns.list
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : The ID of the advertiser to list campaigns for.
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
filter
Location : query
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.
Type : string
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
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Type : integer
Path : v4/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.
Parameter Order : advertiserId
Flat Path : v4/advertisers/{advertisersId}/campaigns
Scopes :
▼ ▲ displayvideo.advertisers.campaigns.patch
Flat Path : v4/advertisers/{advertisersId}/campaigns/{campaignsId}
Parameter Order :
Path : v4/advertisers/{+advertiserId}/campaigns/{+campaignId}
Description : Updates an existing campaign. Returns the updated campaign if successful.
HTTP Method : PATCH
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Output only. The unique ID of the advertiser the campaign belongs to.
campaignId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Output only. The unique ID of the campaign. Assigned by the system.
Location : path
Format : int64
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Scopes :
▼ ▲ displayvideo.advertisers.adGroupAds.get
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Description : Gets an ad group ad.
Parameter Order :
HTTP Method : GET
Parameters :
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the advertiser this ad group ad belongs to.
Required : Yes
Type : string
Location : path
Format : int64
adGroupAdId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the ad to fetch.
Location : path
Format : int64
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
▼ ▲ displayvideo.advertisers.adGroupAds.create
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Output only. The unique ID of the advertiser the ad belongs to.
Required : Yes
Type : string
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/adGroupAds
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.
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
▼ ▲ displayvideo.advertisers.adGroupAds.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroupAds
Path : v4/advertisers/{+advertiserId}/adGroupAds
Description : Lists ad group ads.
Parameter Order : advertiserId
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser the ads belong to.
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`.
Type : string
Location : query
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.
Type : string
Location : query
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
pageSize
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.
Format : int32
Type : integer
Location : query
▼ ▲ displayvideo.advertisers.adGroupAds.patch
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Parameter Order :
Path : v4/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.
HTTP Method : PATCH
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Output only. The unique ID of the advertiser the ad belongs to.
adGroupAdId
Required : Yes
Type : string
Description : Output only. The unique ID of the ad. Assigned by the system.
Pattern : ^[^/]+$
Format : int64
Location : path
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
▼ ▲ displayvideo.advertisers.adGroupAds.delete
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
HTTP Method : DELETE
Parameters :
adGroupAdId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the ad to delete. Only Demand Gen ads are supported.
Required : Yes
Type : string
advertiserId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the advertiser the ad belongs to.
Location : path
Format : int64
Parameter Order :
Path : v4/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.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
HTTP Method : GET
Parameters :
negativeKeywordListId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the negative keyword list to fetch.
Required : Yes
Type : string
advertiserId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Pattern : ^[^/]+$
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Description : Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : advertiserId
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
Description : Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
HTTP Method : POST
Parameters :
advertiserId
Required : Yes
Type : string
Description : Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Pattern : ^[^/]+$
Format : int64
Location : path
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
HTTP Method : DELETE
Parameters :
negativeKeywordListId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the negative keyword list to delete.
advertiserId
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Parameter Order :
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Description : Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists
Description : Lists negative keyword lists based on a given advertiser id.
Parameter Order : advertiserId
HTTP Method : GET
Parameters :
advertiserId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
Required : Yes
Type : string
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 `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.
Type : string
pageSize
Location : query
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
Type : integer
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
HTTP Method : PATCH
Parameters :
negativeKeywordListId
Location : path
Format : int64
Required : Yes
Type : string
Description : Output only. The unique ID of the negative keyword list. Assigned by the system.
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
advertiserId
Description : Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
Description : Updates a negative keyword list. Returns the updated negative keyword list if successful.
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order :
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
Description : Deletes a negative keyword from a negative keyword list.
HTTP Method : DELETE
Parameters :
keywordValue
Location : path
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The keyword value of the negative keyword to delete.
advertiserId
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Type : string
negativeKeywordListId
Required : Yes
Type : string
Description : Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Pattern : ^[^/]+$
Format : int64
Location : path
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
HTTP Method : POST
Parameters :
negativeKeywordListId
Pattern : ^[^/]+$
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Required : Yes
Type : string
Location : path
Format : int64
advertiserId
Format : int64
Location : path
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Type : string
Parameter Order :
Path : v4/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.list
Flat Path : v4/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
HTTP Method : GET
Parameters :
negativeKeywordListId
Required : Yes
Type : string
Description : Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
Pattern : ^[^/]+$
Format : int64
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`.
Type : string
Location : query
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
advertiserId
Pattern : ^[^/]+$
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Type : string
Location : path
Format : int64
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.
Format : int32
Location : query
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
Parameter Order :
Path : v4/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
Description : Lists negative keywords in a negative keyword list.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace
HTTP Method : POST
Parameters :
negativeKeywordListId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the parent negative keyword list to which the negative keywords belong.
Required : Yes
Type : string
advertiserId
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Type : string
Location : path
Format : int64
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/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.
Parameter Order :
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Parameter Order :
Path : v4/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
Description : Creates a negative keyword in a negative keyword list.
HTTP Method : POST
Parameters :
negativeKeywordListId
Description : Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
advertiserId
Location : path
Format : int64
Description : Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required : Yes
Type : string
▼ ▲ displayvideo.combinedAudiences.get
Flat Path : v4/combinedAudiences/{combinedAudiencesId}
HTTP Method : GET
Parameters :
partnerId
Location : query
Description : The ID of the partner that has access to the fetched combined audience.
Format : int64
Type : string
advertiserId
Type : string
Description : The ID of the advertiser that has access to the fetched combined audience.
Format : int64
Location : query
combinedAudienceId
Required : Yes
Type : string
Description : Required. The ID of the combined audience to fetch.
Pattern : ^[^/]+$
Format : int64
Location : path
Path : v4/combinedAudiences/{+combinedAudienceId}
Description : Gets a combined audience.
Parameter Order : combinedAudienceId
▼ ▲ displayvideo.combinedAudiences.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/combinedAudiences
HTTP Method : GET
Parameters :
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.
Type : string
Location : query
advertiserId
Location : query
Description : The ID of the advertiser that has access to the fetched combined audiences.
Format : int64
Type : string
partnerId
Description : The ID of the partner that has access to the fetched combined audiences.
Format : int64
Type : string
Location : query
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
Type : integer
Location : query
pageToken
Location : query
Type : string
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
Path : v4/combinedAudiences
Description : Lists combined audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.guaranteedOrders.list
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/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.
HTTP Method : GET
Parameters :
pageSize
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Type : integer
Location : query
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.
Type : string
Location : query
partnerId
Location : query
Description : The ID of the partner that has access to the guaranteed order.
Format : int64
Type : string
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
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
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that has access to the guaranteed order.
Format : int64
Flat Path : v4/guaranteedOrders
▼ ▲ displayvideo.guaranteedOrders.patch
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
HTTP Method : PATCH
Parameters :
partnerId
Location : query
Type : string
Description : The ID of the partner that the request is being made within.
Format : int64
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Location : query
guaranteedOrderId
Pattern : ^[^/]+$
Description : Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
Required : Yes
Type : string
Location : path
advertiserId
Type : string
Description : The ID of the advertiser that the request is being made within.
Format : int64
Location : query
Parameter Order : guaranteedOrderId
Path : v4/guaranteedOrders/{+guaranteedOrderId}
Description : Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : POST
Parameters :
guaranteedOrderId
Location : path
Pattern : ^[^/]+$
Description : Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Required : Yes
Type : string
Parameter Order : guaranteedOrderId
Path : v4/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
Description : Edits read advertisers of a guaranteed order.
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
▼ ▲ displayvideo.guaranteedOrders.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/guaranteedOrders
Path : v4/guaranteedOrders
Description : Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
HTTP Method : POST
Parameters :
partnerId
Type : string
Description : The ID of the partner that the request is being made within.
Format : int64
Location : query
advertiserId
Location : query
Description : The ID of the advertiser that the request is being made within.
Format : int64
Type : string
▼ ▲ displayvideo.guaranteedOrders.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/guaranteedOrders/{guaranteedOrdersId}
HTTP Method : GET
Parameters :
guaranteedOrderId
Description : Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Required : Yes
Type : string
Pattern : ^[^/]+$
Location : path
advertiserId
Type : string
Description : The ID of the advertiser that has access to the guaranteed order.
Format : int64
Location : query
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the guaranteed order.
Format : int64
Path : v4/guaranteedOrders/{+guaranteedOrderId}
Description : Gets a guaranteed order.
Parameter Order : guaranteedOrderId
▼ ▲ displayvideo.media.upload
Supportsmediaupload : Yes
Scopes :
Flat Path : media/{mediaId}
Path : media/{+resourceName}
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.
Parameter Order : resourceName
HTTP Method : POST
Parameters :
resourceName
Pattern : ^.*$
Required : Yes
Type : string
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Location : path
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/media/{+resourceName}
Multipart : Yes
▼ ▲ displayvideo.media.download
Flat Path : download/{downloadId}
HTTP Method : GET
Parameters :
resourceName
Location : path
Pattern : ^.*$
Required : Yes
Type : string
Description : Name of the media that is being downloaded. See ReadRequest.resource_name.
Path : download/{+resourceName}
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
Scopes :
▼ ▲ displayvideo.floodlightGroups.get
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
floodlightGroupId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the Floodlight group to fetch.
partnerId
Location : query
Description : Required. The partner context by which the Floodlight group is being accessed.
Format : int64
Type : string
Path : v4/floodlightGroups/{+floodlightGroupId}
Description : Gets a Floodlight group.
Parameter Order : floodlightGroupId
Flat Path : v4/floodlightGroups/{floodlightGroupsId}
▼ ▲ displayvideo.floodlightGroups.patch
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : floodlightGroupId
Path : v4/floodlightGroups/{floodlightGroupId}
Description : Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
HTTP Method : PATCH
Parameters :
partnerId
Location : query
Description : Required. The partner context by which the Floodlight group is being accessed.
Format : int64
Type : string
floodlightGroupId
Format : int64
Location : path
Required : Yes
Type : string
Description : Output only. The unique ID of the Floodlight group. Assigned by the system.
updateMask
Location : query
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Flat Path : v4/floodlightGroups/{floodlightGroupId}
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.list
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities
Description : Lists Floodlight activities in a Floodlight group.
Parameter Order : floodlightGroupId
HTTP Method : GET
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.
Format : int32
Type : integer
Location : query
floodlightGroupId
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
pageToken
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.
Location : query
partnerId
Type : string
Description : Required. The ID of the partner through which the Floodlight activities are being accessed.
Format : int64
Location : query
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
▼ ▲ displayvideo.floodlightGroups.floodlightActivities.get
Parameter Order :
Path : v4/floodlightGroups/{+floodlightGroupId}/floodlightActivities/{+floodlightActivityId}
Description : Gets a Floodlight activity.
HTTP Method : GET
Parameters :
floodlightGroupId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
Pattern : ^[^/]+$
floodlightActivityId
Description : Required. The ID of the Floodlight activity to fetch.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
partnerId
Location : query
Description : Required. The ID of the partner through which the Floodlight activity is being accessed.
Format : int64
Type : string
Flat Path : v4/floodlightGroups/{floodlightGroupsId}/floodlightActivities/{floodlightActivitiesId}
▼ ▲ displayvideo.users.get
Flat Path : v4/users/{usersId}
HTTP Method : GET
Parameters :
userId
Format : int64
Location : path
Description : Required. The ID of the user to fetch.
Required : Yes
Type : string
Pattern : ^[^/]+$
Parameter Order : userId
Path : v4/users/{+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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.users.create
Flat Path : v4/users
HTTP Method : POST
Path : v4/users
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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.users.delete
Path : v4/users/{+userId}
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.
Parameter Order : userId
HTTP Method : DELETE
Parameters :
userId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the user to delete.
Pattern : ^[^/]+$
Flat Path : v4/users/{usersId}
Scopes : https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.users.bulkEditAssignedUserRoles
Scopes : https://www.googleapis.com/auth/display-video-user-management
Flat Path : v4/users/{usersId}:bulkEditAssignedUserRoles
Parameter Order : userId
Path : v4/users/{+userId}:bulkEditAssignedUserRoles
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.
HTTP Method : POST
Parameters :
userId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the user to which the assigned user roles belong.
Location : path
Format : int64
▼ ▲ displayvideo.users.list
HTTP Method : GET
Parameters :
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.
Type : string
Location : query
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Location : query
orderBy
Location : query
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`.
Type : string
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.
Type : string
Location : query
Path : v4/users
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.
Flat Path : v4/users
Scopes : https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.users.patch
Flat Path : v4/users/{usersId}
HTTP Method : PATCH
Parameters :
updateMask
Location : query
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
userId
Format : int64
Location : path
Required : Yes
Type : string
Description : Output only. The unique ID of the user. Assigned by the system.
Pattern : ^[^/]+$
Parameter Order : userId
Path : v4/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.
Scopes : https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript
Parameter Order : customBiddingAlgorithmId
Path : v4/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.
HTTP Method : GET
Parameters :
partnerId
Location : query
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
Type : string
customBiddingAlgorithmId
Format : int64
Location : path
Description : Required. The ID of the custom bidding algorithm owns the script.
Required : Yes
Type : string
Pattern : ^[^/]+$
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
▼ ▲ displayvideo.customBiddingAlgorithms.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
Description : Gets a custom bidding algorithm.
Parameter Order : customBiddingAlgorithmId
HTTP Method : GET
Parameters :
customBiddingAlgorithmId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the custom bidding algorithm to fetch.
Pattern : ^[^/]+$
partnerId
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Format : int64
Type : string
Location : query
advertiserId
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Format : int64
Type : string
Location : query
▼ ▲ displayvideo.customBiddingAlgorithms.create
Path : v4/customBiddingAlgorithms
Description : Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
HTTP Method : POST
Flat Path : v4/customBiddingAlgorithms
▼ ▲ displayvideo.customBiddingAlgorithms.uploadRules
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
HTTP Method : GET
Parameters :
partnerId
Location : query
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
Format : int64
customBiddingAlgorithmId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Required : Yes
Type : string
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
Location : query
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules
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
▼ ▲ displayvideo.customBiddingAlgorithms.list
Path : v4/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.
HTTP Method : GET
Parameters :
advertiserId
Location : query
Type : string
Description : The ID of the DV360 advertiser that has access to the custom bidding algorithm.
Format : int64
orderBy
Location : query
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`.
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
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 `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
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
partnerId
Type : string
Description : The ID of the DV360 partner that has access to the custom bidding algorithm.
Format : int64
Location : query
Flat Path : v4/customBiddingAlgorithms
▼ ▲ displayvideo.customBiddingAlgorithms.patch
Parameter Order : customBiddingAlgorithmId
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}
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.
HTTP Method : PATCH
Parameters :
customBiddingAlgorithmId
Required : Yes
Type : string
Description : Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Pattern : ^[^/]+$
Format : int64
Location : path
updateMask
Type : string
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Location : query
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
HTTP Method : GET
Parameters :
partnerId
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
Format : int64
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.
Format : int32
Location : query
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 `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.
Location : query
customBiddingAlgorithmId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Required : Yes
Type : string
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`.
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
Parameter Order : customBiddingAlgorithmId
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Description : Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
HTTP Method : POST
Parameters :
customBiddingAlgorithmId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Location : path
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 rules resource.
Format : int64
advertiserId
Type : string
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Location : query
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
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.
Parameter Order : customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.rules.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
Parameter Order :
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
Description : Retrieves a rules resource.
HTTP Method : GET
Parameters :
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
Location : query
customBiddingAlgorithmRulesId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the rules resource to fetch.
Pattern : ^[^/]+$
partnerId
Type : string
Description : The ID of the partner that owns the parent custom bidding algorithm.
Format : int64
Location : query
customBiddingAlgorithmId
Required : Yes
Type : string
Description : Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern : ^[^/]+$
Format : int64
Location : path
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
HTTP Method : GET
Parameters :
partnerId
Location : query
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
Type : string
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 `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
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.
Format : int32
Location : query
customBiddingAlgorithmId
Required : Yes
Type : string
Description : Required. The ID of the custom bidding algorithm owns the script.
Pattern : ^[^/]+$
Format : int64
Location : path
advertiserId
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
Location : query
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`.
Parameter Order : customBiddingAlgorithmId
Path : v4/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
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
Parameter Order : customBiddingAlgorithmId
Path : v4/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.
HTTP Method : POST
Parameters :
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
customBiddingAlgorithmId
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm that owns the script.
Required : Yes
Type : string
Location : path
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
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
HTTP Method : GET
Parameters :
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
customBiddingAlgorithmId
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding algorithm owns the script.
Required : Yes
Type : string
Location : path
Format : int64
advertiserId
Location : query
Description : The ID of the advertiser that owns the parent custom bidding algorithm.
Format : int64
Type : string
customBiddingScriptId
Location : path
Format : int64
Pattern : ^[^/]+$
Description : Required. The ID of the custom bidding script to fetch.
Required : Yes
Type : string
Parameter Order :
Path : v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
Description : Gets a custom bidding script.
Flat Path : v4/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
▼ ▲ displayvideo.inventorySources.get
Scopes : https://www.googleapis.com/auth/display-video
Path : v4/inventorySources/{+inventorySourceId}
Description : Gets an inventory source.
Parameter Order : inventorySourceId
HTTP Method : GET
Parameters :
inventorySourceId
Format : int64
Location : path
Description : Required. The ID of the inventory source to fetch.
Required : Yes
Type : string
Pattern : ^[^/]+$
partnerId
Location : query
Description : Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
Format : int64
Type : string
advertiserId
Location : query
Description : Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.
Format : int64
Type : string
Flat Path : v4/inventorySources/{inventorySourcesId}
▼ ▲ displayvideo.inventorySources.create
HTTP Method : POST
Parameters :
partnerId
Location : query
Description : The ID of the partner that the request is being made within.
Format : int64
Type : string
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that the request is being made within.
Format : int64
Path : v4/inventorySources
Description : Creates a new inventory source. Returns the newly created inventory source if successful.
Flat Path : v4/inventorySources
▼ ▲ displayvideo.inventorySources.list
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : GET
Parameters :
partnerId
Location : query
Description : The ID of the partner that has access to the inventory source.
Format : int64
Type : string
pageSize
Type : integer
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Location : query
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Type : string
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
Location : query
Type : string
Description : Allows filtering by inventory source 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: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources 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
Description : The ID of the advertiser that has access to the inventory source.
Format : int64
Type : string
Location : query
Path : v4/inventorySources
Description : Lists inventory sources 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, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Flat Path : v4/inventorySources
▼ ▲ displayvideo.inventorySources.patch
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameters :
advertiserId
Description : The ID of the advertiser that the request is being made within.
Format : int64
Type : string
Location : query
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Location : query
inventorySourceId
Format : int64
Location : path
Required : Yes
Type : string
Description : Output only. The unique ID of the inventory source. Assigned by the system.
Pattern : ^[^/]+$
partnerId
Location : query
Type : string
Description : The ID of the partner that the request is being made within.
Format : int64
Path : v4/inventorySources/{+inventorySourceId}
Description : Updates an existing inventory source. Returns the updated inventory source if successful.
Parameter Order : inventorySourceId
Flat Path : v4/inventorySources/{inventorySourcesId}
▼ ▲ displayvideo.inventorySources.editInventorySourceReadWriteAccessors
Flat Path : v4/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors
HTTP Method : POST
Parameters :
inventorySourceId
Pattern : ^[^/]+$
Description : Required. The ID of inventory source to update.
Required : Yes
Type : string
Location : path
Format : int64
Path : v4/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors
Description : Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Parameter Order : inventorySourceId
▼ ▲ displayvideo.sdfdownloadtasks.operations.get
Scopes :
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Type : string
Description : The name of the operation resource.
Pattern : ^sdfdownloadtasks/operations/[^/]+$
Parameter Order : name
Path : v4/{+name}
Description : Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
Flat Path : v4/sdfdownloadtasks/operations/{operationsId}
▼ ▲ displayvideo.sdfdownloadtasks.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/sdfdownloadtasks
Path : v4/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.
HTTP Method : POST
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.editCustomerMatchMembers
HTTP Method : POST
Parameters :
firstPartyAndPartnerAudienceId
Location : path
Format : int64
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}: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`
Parameter Order : firstPartyAndPartnerAudienceId
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}:editCustomerMatchMembers
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.get
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : firstPartyAndPartnerAudienceId
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
Description : Gets a first party or partner audience.
HTTP Method : GET
Parameters :
advertiserId
Location : query
Description : The ID of the advertiser that has access to the fetched first party and partner audience.
Format : int64
Type : string
firstPartyAndPartnerAudienceId
Required : Yes
Type : string
Description : Required. The ID of the first party and partner audience to fetch.
Pattern : ^[^/]+$
Format : int64
Location : path
partnerId
Location : query
Type : string
Description : The ID of the partner that has access to the fetched first party and partner audience.
Format : int64
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.create
Path : v4/firstPartyAndPartnerAudiences
Description : Creates a FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
HTTP Method : POST
Parameters :
advertiserId
Type : string
Description : Required. The ID of the advertiser under whom the FirstPartyAndPartnerAudience will be created.
Format : int64
Location : query
Flat Path : v4/firstPartyAndPartnerAudiences
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.list
HTTP Method : GET
Parameters :
orderBy
Location : query
Description : Optional. Field by which to sort the list. Acceptable values are: * `FirstPartyAndPartnerAudienceId` (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
filter
Location : query
Description : Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner 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 party and partner 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.
Type : string
advertiserId
Type : string
Description : The ID of the advertiser that has access to the fetched first party and partner audiences.
Format : int64
Location : query
pageSize
Type : integer
Description : Optional. 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.
Format : int32
Location : query
pageToken
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 `ListFirstPartyAndPartnerAudiences` method. If not specified, the first page of results will be returned.
Location : query
partnerId
Type : string
Description : The ID of the partner that has access to the fetched first party and partner audiences.
Format : int64
Location : query
Path : v4/firstPartyAndPartnerAudiences
Description : Lists first party and partner audiences. The order is defined by the order_by parameter.
Flat Path : v4/firstPartyAndPartnerAudiences
▼ ▲ displayvideo.firstPartyAndPartnerAudiences.patch
Scopes : https://www.googleapis.com/auth/display-video
HTTP Method : PATCH
Parameters :
firstPartyAndPartnerAudienceId
Format : int64
Location : path
Description : Identifier. The unique ID of the first party and partner audience. Assigned by the system.
Required : Yes
Type : string
Pattern : ^[^/]+$
updateMask
Type : string
Description : Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
Format : google-fieldmask
Location : query
advertiserId
Location : query
Description : Required. The ID of the owner advertiser of the updated FirstPartyAndPartnerAudience.
Format : int64
Type : string
Path : v4/firstPartyAndPartnerAudiences/{+firstPartyAndPartnerAudienceId}
Description : Updates an existing FirstPartyAndPartnerAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Parameter Order : firstPartyAndPartnerAudienceId
Flat Path : v4/firstPartyAndPartnerAudiences/{firstPartyAndPartnerAudiencesId}
▼ ▲ displayvideo.inventorySourceGroups.delete
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
HTTP Method : DELETE
Parameters :
advertiserId
Type : string
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
inventorySourceGroupId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the inventory source group to delete.
Pattern : ^[^/]+$
partnerId
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
Location : query
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
Description : Deletes an inventory source group.
Parameter Order : inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.list
Flat Path : v4/inventorySourceGroups
HTTP Method : GET
Parameters :
partnerId
Location : query
Description : The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
Format : int64
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Type : string
Location : query
pageSize
Location : query
Description : Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Format : int32
Type : integer
advertiserId
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
Location : query
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
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 : v4/inventorySourceGroups
Description : Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
▼ ▲ displayvideo.inventorySourceGroups.patch
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupId}
Path : v4/inventorySourceGroups/{inventorySourceGroupId}
Description : Updates an inventory source group. Returns the updated inventory source group if successful.
Parameter Order : inventorySourceGroupId
HTTP Method : PATCH
Parameters :
inventorySourceGroupId
Required : Yes
Type : string
Description : Output only. The unique ID of the inventory source group. Assigned by the system.
Format : int64
Location : path
updateMask
Description : Required. The mask to control which fields to update.
Format : google-fieldmask
Type : string
Location : query
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
Type : string
Location : query
partnerId
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
Location : query
▼ ▲ displayvideo.inventorySourceGroups.get
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}
Description : Gets an inventory source group.
Parameter Order : inventorySourceGroupId
HTTP Method : GET
Parameters :
advertiserId
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
Location : query
inventorySourceGroupId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the inventory source group to fetch.
Location : path
Format : int64
partnerId
Description : The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Format : int64
Type : string
Location : query
▼ ▲ displayvideo.inventorySourceGroups.create
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/inventorySourceGroups
Path : v4/inventorySourceGroups
Description : Creates a new inventory source group. Returns the newly created inventory source group if successful.
HTTP Method : POST
Parameters :
partnerId
Location : query
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
Type : string
advertiserId
Type : string
Description : The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group.
Format : int64
Location : query
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
HTTP Method : GET
Parameters :
pageSize
Location : query
Type : integer
Description : Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format : int32
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 `ListAssignedInventorySources` 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 assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.
Format : int64
inventorySourceGroupId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the inventory source group to which these assignments are assigned.
Location : path
Format : int64
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`.
Type : string
Location : query
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.
advertiserId
Location : query
Type : string
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
Parameter Order : inventorySourceGroupId
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Description : Lists inventory sources assigned to an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
HTTP Method : POST
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.
Format : int64
Type : string
Location : query
inventorySourceGroupId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the inventory source group to which the assignment will be assigned.
Location : path
Format : int64
partnerId
Location : query
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.
Format : int64
Type : string
Parameter Order : inventorySourceGroupId
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Description : Creates an assignment between an inventory source and an inventory source group.
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources:bulkEdit
HTTP Method : POST
Parameters :
inventorySourceGroupId
Format : int64
Location : path
Description : Required. The ID of the inventory source group to which the assignments are assigned.
Required : Yes
Type : string
Pattern : ^[^/]+$
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/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.
Parameter Order : inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
Parameter Order :
Path : v4/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Description : Deletes the assignment between an inventory source and an inventory source group.
HTTP Method : DELETE
Parameters :
partnerId
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.
Format : int64
Location : query
inventorySourceGroupId
Description : Required. The ID of the inventory source group to which this assignment is assigned.
Required : Yes
Type : string
Pattern : ^[^/]+$
Format : int64
Location : path
assignedInventorySourceId
Format : int64
Location : path
Required : Yes
Type : string
Description : Required. The ID of the assigned inventory source to delete.
Pattern : ^[^/]+$
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
Flat Path : v4/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
▼ ▲ displayvideo.googleAudiences.get
Scopes : https://www.googleapis.com/auth/display-video
Parameter Order : googleAudienceId
Path : v4/googleAudiences/{+googleAudienceId}
Description : Gets a Google audience.
HTTP Method : GET
Parameters :
partnerId
Description : The ID of the partner that has access to the fetched Google audience.
Format : int64
Type : string
Location : query
googleAudienceId
Pattern : ^[^/]+$
Description : Required. The ID of the Google audience to fetch.
Required : Yes
Type : string
Location : path
Format : int64
advertiserId
Description : The ID of the advertiser that has access to the fetched Google audience.
Format : int64
Type : string
Location : query
Flat Path : v4/googleAudiences/{googleAudiencesId}
▼ ▲ displayvideo.googleAudiences.list
Scopes : https://www.googleapis.com/auth/display-video
Flat Path : v4/googleAudiences
Path : v4/googleAudiences
Description : Lists Google audiences. The order is defined by the order_by parameter.
HTTP Method : GET
Parameters :
advertiserId
Location : query
Type : string
Description : The ID of the advertiser that has access to the fetched Google audiences.
Format : int64
orderBy
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`.
Location : query
filter
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.
Type : string
Location : query
partnerId
Description : The ID of the partner that has access to the fetched Google audiences.
Format : int64
Type : string
Location : query
pageToken
Location : query
Type : string
Description : A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` 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
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions:search
Path : v4/targetingTypes/{+targetingType}/targetingOptions:search
Description : Searches for targeting options of a given type based on the given search terms.
Parameter Order : targetingType
HTTP Method : POST
Parameters :
targetingType
Required : Yes
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`
Pattern : ^[^/]+$
Location : path
Enum Descriptions :
Enum :
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Parameter Order :
Path : v4/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
Description : Gets a single targeting option.
HTTP Method : GET
Parameters :
targetingType
Location : path
Enum Descriptions :
Enum :
Pattern : ^[^/]+$
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
Type : string
advertiserId
Location : query
Description : Required. The Advertiser this request is being made in the context of.
Format : int64
Type : string
targetingOptionId
Pattern : ^[^/]+$
Required : Yes
Type : string
Description : Required. The ID of the of targeting option to retrieve.
Location : path
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Path : v4/targetingTypes/{+targetingType}/targetingOptions
Description : Lists targeting options of a given type.
Parameter Order : targetingType
HTTP Method : GET
Parameters :
targetingType
Pattern : ^[^/]+$
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`
Required : Yes
Type : string
Location : path
Enum Descriptions :
Enum :
advertiserId
Description : Required. The Advertiser this request is being made in the context of.
Format : int64
Type : string
Location : query
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`.
Type : string
Location : query
filter
Location : query
Type : string
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.
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 `ListTargetingOptions` method. If not specified, the first page of results will be returned.
Type : string
Location : query
pageSize
Location : query
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
Type : integer
Flat Path : v4/targetingTypes/{targetingTypesId}/targetingOptions