2023-10-10
▼ ▲ displayvideo.targetingTypes.targetingOptions.get
Path: v3/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Description: Gets a single targeting option.
Parameters:
targetingType
Type: string
Description: Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`
Required: Yes
Location: path
Pattern: ^[^/]+$
Enum Descriptions:
Enum:
targetingOptionId
Required: Yes
Type: string
Pattern: ^[^/]+$
Description: Required. The ID of the of targeting option to retrieve.
Location: path
advertiserId
Type: string
Description: Required. The Advertiser this request is being made in the context of.
Location: query
Format: int64
Flat Path: v3/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}
Parameter Order:
▼ ▲ displayvideo.targetingTypes.targetingOptions.search
Parameters:
targetingType
Enum Descriptions:
Description: Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`
Location: path
Pattern: ^[^/]+$
Enum:
Required: Yes
Type: string
Description: Searches for targeting options of a given type based on the given search terms.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: targetingType
Flat Path: v3/targetingTypes/{targetingTypesId}/targetingOptions:search
Path: v3/targetingTypes/{+targetingType}/targetingOptions:search
HTTP Method: POST
▼ ▲ displayvideo.targetingTypes.targetingOptions.list
Scopes: https://www.googleapis.com/auth/display-video
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 `ListTargetingOptions` method. If not specified, the first page of results will be returned.
Type: string
pageSize
Type: integer
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
orderBy
Location: query
Type: string
Description: Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`.
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.
targetingType
Pattern: ^[^/]+$
Enum Descriptions:
Type: string
Enum:
Required: Yes
Description: Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`
Location: path
advertiserId
Location: query
Description: Required. The Advertiser this request is being made in the context of.
Format: int64
Type: string
Path: v3/targetingTypes/{+targetingType}/targetingOptions
Description: Lists targeting options of a given type.
Flat Path: v3/targetingTypes/{targetingTypesId}/targetingOptions
HTTP Method: GET
Parameter Order: targetingType
▼ ▲ displayvideo.sdfdownloadtasks.create
Flat Path: v3/sdfdownloadtasks
Path: v3/sdfdownloadtasks
Description: Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.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
▼ ▲ displayvideo.sdfdownloadtasks.operations.get
Path: v3/{+name}
Flat Path: v3/sdfdownloadtasks/operations/{operationsId}
Description: Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
Scopes:
Parameters:
name
Pattern: ^sdfdownloadtasks/operations/[^/]+$
Required: Yes
Location: path
Description: The name of the operation resource.
Type: string
Parameter Order: name
HTTP Method: GET
▼ ▲ displayvideo.advertisers.create
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/display-video
Description: Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.
Flat Path: v3/advertisers
Path: v3/advertisers
▼ ▲ displayvideo.advertisers.get
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Description: Gets an advertiser.
Parameters:
advertiserId
Description: Required. The ID of the advertiser to fetch.
Format: int64
Type: string
Required: Yes
Location: path
Pattern: ^[^/]+$
Path: v3/advertisers/{+advertiserId}
Flat Path: v3/advertisers/{advertisersId}
Parameter Order: advertiserId
▼ ▲ displayvideo.advertisers.listAssignedTargetingOptions
Flat Path: v3/advertisers/{advertisersId}:listAssignedTargetingOptions
Parameters:
pageSize
Format: int32
Location: query
Type: integer
Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
advertiserId
Description: Required. The ID of the advertiser the line item belongs to.
Location: path
Type: string
Pattern: ^[^/]+$
Required: Yes
Format: int64
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 `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location: query
orderBy
Type: string
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`.
filter
Location: query
Type: string
Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Parameter Order: advertiserId
Description: Lists assigned targeting options of an advertiser across targeting types.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Path: v3/advertisers/{+advertiserId}:listAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.delete
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
Path: v3/advertisers/{+advertiserId}
Parameters:
advertiserId
Format: int64
Required: Yes
Description: The ID of the advertiser we need to delete.
Pattern: ^[^/]+$
Type: string
Location: path
Flat Path: v3/advertisers/{advertisersId}
HTTP Method: DELETE
Description: Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered.
▼ ▲ displayvideo.advertisers.audit
Path: v3/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.
Flat Path: v3/advertisers/{advertisersId}:audit
Parameters:
readMask
Format: google-fieldmask
Description: Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount * channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount
Location: query
Type: string
advertiserId
Pattern: ^[^/]+$
Description: Required. The ID of the advertiser to audit.
Location: path
Type: string
Format: int64
Required: Yes
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
▼ ▲ displayvideo.advertisers.patch
Description: Updates an existing advertiser. Returns the updated advertiser if successful.
Parameter Order: advertiserId
Path: v3/advertisers/{+advertiserId}
Parameters:
advertiserId
Location: path
Format: int64
Required: Yes
Description: Output only. The unique ID of the advertiser. Assigned by the system.
Type: string
Pattern: ^[^/]+$
updateMask
Format: google-fieldmask
Description: Required. The mask to control which fields to update.
Location: query
Type: string
HTTP Method: PATCH
Flat Path: v3/advertisers/{advertisersId}
▼ ▲ displayvideo.advertisers.editAssignedTargetingOptions
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}:editAssignedTargetingOptions
Parameters:
advertiserId
Pattern: ^[^/]+$
Format: int64
Location: path
Type: string
Required: Yes
Description: Required. The ID of the advertiser.
Parameter Order: advertiserId
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 .
HTTP Method: POST
Flat Path: v3/advertisers/{advertisersId}:editAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.list
Scopes: https://www.googleapis.com/auth/display-video
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:
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. For example, `displayName desc`.
Location: query
Type: string
filter
Description: Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location: query
Type: string
pageSize
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location: query
Type: integer
partnerId
Location: query
Format: int64
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
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned.
Location: query
Type: string
Path: v3/advertisers
Flat Path: v3/advertisers
▼ ▲ displayvideo.advertisers.locationLists.patch
Parameters:
advertiserId
Description: Required. The ID of the DV360 advertiser to which the location lists belongs.
Format: int64
Required: Yes
Location: path
Type: string
Pattern: ^[^/]+$
locationListId
Required: Yes
Type: string
Format: int64
Location: path
Description: Output only. The unique ID of the location list. Assigned by the system.
updateMask
Description: Required. The mask to control which fields to update.
Format: google-fieldmask
Type: string
Location: query
Flat Path: v3/advertisers/{advertisersId}/locationLists/{locationListId}
Path: v3/advertisers/{+advertiserId}/locationLists/{locationListId}
Parameter Order:
Description: Updates a location list. Returns the updated location list if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: PATCH
▼ ▲ displayvideo.advertisers.locationLists.get
Path: v3/advertisers/{+advertiserId}/locationLists/{+locationListId}
Description: Gets a location list.
Parameter Order:
Parameters:
locationListId
Pattern: ^[^/]+$
Description: Required. The ID of the location list to fetch.
Format: int64
Location: path
Required: Yes
Type: string
advertiserId
Pattern: ^[^/]+$
Required: Yes
Format: int64
Description: Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertisersId}/locationLists/{locationListsId}
HTTP Method: GET
▼ ▲ displayvideo.advertisers.locationLists.list
Flat Path: v3/advertisers/{advertisersId}/locationLists
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}/locationLists
HTTP Method: GET
Parameter Order: advertiserId
Description: Lists location lists based on a given advertiser id.
Parameters:
filter
Type: string
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.
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
Type: string
Location: path
Required: Yes
Pattern: ^[^/]+$
Description: Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Format: int64
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.
Type: string
Location: query
pageSize
Format: int32
Type: integer
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.
▼ ▲ displayvideo.advertisers.locationLists.create
Flat Path: v3/advertisers/{advertisersId}/locationLists
Path: v3/advertisers/{+advertiserId}/locationLists
Description: Creates a new location list. Returns the newly created location list if successful.
Parameters:
advertiserId
Format: int64
Location: path
Required: Yes
Pattern: ^[^/]+$
Description: Required. The ID of the DV360 advertiser to which the location list belongs.
Type: string
Parameter Order: advertiserId
HTTP Method: POST
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.list
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 `ListAssignedLocations` method. If not specified, the first page of results will be returned.
Type: string
pageSize
Location: query
Format: int32
Type: integer
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
advertiserId
Type: string
Location: path
Format: int64
Required: Yes
Description: Required. The ID of the DV360 advertiser to which the location list belongs.
locationListId
Format: int64
Required: Yes
Type: string
Location: path
Description: Required. The ID of the location list to which these assignments are assigned.
orderBy
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
Location: query
filter
Type: string
Description: Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location: query
Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
HTTP Method: GET
Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Description: Lists locations assigned to a location list.
Parameter Order:
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.bulkEdit
Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit
Parameters:
locationListId
Required: Yes
Description: Required. The ID of the location list to which these assignments are assigned.
Location: path
Pattern: ^[^/]+$
Format: int64
Type: string
advertiserId
Format: int64
Location: path
Type: string
Required: Yes
Description: Required. The ID of the DV360 advertiser to which the location list belongs.
Description: Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Path: v3/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit
HTTP Method: POST
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.create
HTTP Method: POST
Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
Description: Creates an assignment between a location and a location list.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Parameters:
locationListId
Description: Required. The ID of the location list for which the assignment will be created.
Location: path
Required: Yes
Type: string
Format: int64
advertiserId
Description: Required. The ID of the DV360 advertiser to which the location list belongs.
Required: Yes
Location: path
Type: string
Format: int64
Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations
▼ ▲ displayvideo.advertisers.locationLists.assignedLocations.delete
HTTP Method: DELETE
Description: Deletes the assignment between a location and a location list.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Parameters:
assignedLocationId
Location: path
Format: int64
Pattern: ^[^/]+$
Type: string
Required: Yes
Description: Required. The ID of the assigned location to delete.
advertiserId
Required: Yes
Format: int64
Type: string
Location: path
Description: Required. The ID of the DV360 advertiser to which the location list belongs.
locationListId
Required: Yes
Location: path
Description: Required. The ID of the location list to which this assignment is assigned.
Format: int64
Type: string
Flat Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{assignedLocationsId}
Path: v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list
Description: Lists the targeting options assigned to an advertiser.
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method: GET
Parameters:
advertiserId
Format: int64
Required: Yes
Type: string
Description: Required. The ID of the advertiser.
Location: path
Pattern: ^[^/]+$
orderBy
Location: query
Type: string
Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
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 `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location: query
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: * `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.
Location: query
Type: string
targetingType
Pattern: ^[^/]+$
Enum:
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`
Location: path
Required: Yes
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.
Format: int32
Location: query
Type: integer
Parameter Order:
Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.delete
Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters:
targetingType
Required: Yes
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`
Enum Descriptions:
Location: path
Enum:
Type: string
advertiserId
Pattern: ^[^/]+$
Location: path
Type: string
Format: int64
Required: Yes
Description: Required. The ID of the advertiser.
assignedTargetingOptionId
Description: Required. The ID of the assigned targeting option to delete.
Pattern: ^[^/]+$
Required: Yes
Location: path
Type: string
Description: Deletes an assigned targeting option from an advertiser.
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: DELETE
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.create
Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order:
Description: Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: POST
Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Parameters:
targetingType
Pattern: ^[^/]+$
Location: path
Enum Descriptions:
Enum:
Type: string
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`
advertiserId
Pattern: ^[^/]+$
Type: string
Required: Yes
Description: Required. The ID of the advertiser.
Format: int64
Location: path
▼ ▲ displayvideo.advertisers.targetingTypes.assignedTargetingOptions.get
Path: v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Description: Gets a single targeting option assigned to an advertiser.
Parameters:
advertiserId
Format: int64
Required: Yes
Description: Required. The ID of the advertiser.
Pattern: ^[^/]+$
Location: path
Type: string
assignedTargetingOptionId
Pattern: ^[^/]+$
Description: Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
Type: string
Location: path
Required: Yes
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`
Type: string
Location: path
Enum:
Enum Descriptions:
Pattern: ^[^/]+$
HTTP Method: GET
▼ ▲ displayvideo.advertisers.channels.sites.delete
Parameter Order:
Parameters:
partnerId
Format: int64
Description: The ID of the partner that owns the parent channel.
Type: string
Location: query
advertiserId
Type: string
Format: int64
Description: The ID of the advertiser that owns the parent channel.
Required: Yes
Location: path
urlOrAppId
Type: string
Location: path
Required: Yes
Description: Required. The URL or app ID of the site to delete.
Pattern: ^[^/]+$
channelId
Description: Required. The ID of the parent channel to which the site belongs.
Format: int64
Location: path
Type: string
Required: Yes
Pattern: ^[^/]+$
Path: v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}
Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites/{sitesId}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/display-video
Description: Deletes a site from a channel.
▼ ▲ displayvideo.advertisers.channels.sites.replace
Path: v3/advertisers/{advertiserId}/channels/{+channelId}/sites:replace
Description: Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites.
Parameters:
channelId
Description: Required. The ID of the parent channel whose sites will be replaced.
Type: string
Location: path
Required: Yes
Pattern: ^[^/]+$
Format: int64
advertiserId
Description: The ID of the advertiser that owns the parent channel.
Format: int64
Type: string
Required: Yes
Location: path
Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites:replace
HTTP Method: POST
Parameter Order:
▼ ▲ displayvideo.advertisers.channels.sites.list
Parameter Order:
Path: v3/advertisers/{+advertiserId}/channels/{+channelId}/sites
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertisersId}/channels/{channelsId}/sites
HTTP Method: GET
Parameters:
partnerId
Type: string
Format: int64
Description: The ID of the partner that owns the parent channel.
Location: query
advertiserId
Required: Yes
Pattern: ^[^/]+$
Type: string
Location: path
Format: int64
Description: The ID of the advertiser that owns the parent channel.
filter
Description: Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location: query
Type: string
orderBy
Type: string
Description: Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`.
Location: query
channelId
Description: Required. The ID of the parent channel to which the requested sites belong.
Pattern: ^[^/]+$
Type: string
Location: path
Required: Yes
Format: int64
pageSize
Format: int32
Type: integer
Description: Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
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 `ListSites` method. If not specified, the first page of results will be returned.
Type: string
Location: query
Description: Lists sites in a channel.
▼ ▲ displayvideo.advertisers.channels.sites.create
Parameter Order:
Description: Creates a site in a channel.
Parameters:
advertiserId
Required: Yes
Description: The ID of the advertiser that owns the parent channel.
Type: string
Location: path
Format: int64
channelId
Type: string
Location: path
Required: Yes
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the parent channel in which the site will be created.
partnerId
Type: string
Description: The ID of the partner that owns the parent channel.
Format: int64
Location: query
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites
Path: v3/advertisers/{advertiserId}/channels/{+channelId}/sites
HTTP Method: POST
▼ ▲ displayvideo.advertisers.channels.sites.bulkEdit
HTTP Method: POST
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertiserId}/channels/{channelsId}/sites:bulkEdit
Parameters:
channelId
Location: path
Type: string
Required: Yes
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the parent channel to which the sites belong.
advertiserId
Format: int64
Description: The ID of the advertiser that owns the parent channel.
Type: string
Required: Yes
Location: path
Path: v3/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.
▼ ▲ displayvideo.advertisers.channels.list
Parameter Order: advertiserId
Path: v3/advertisers/{+advertiserId}/channels
Description: Lists channels for a partner or advertiser.
Flat Path: v3/advertisers/{advertisersId}/channels
Parameters:
orderBy
Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`.
Location: query
Type: string
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.
Location: query
Type: string
pageSize
Location: query
Format: int32
Type: integer
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
partnerId
Type: string
Location: query
Description: The ID of the partner that owns the channels.
Format: int64
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
advertiserId
Description: The ID of the advertiser that owns the channels.
Pattern: ^[^/]+$
Location: path
Type: string
Required: Yes
Format: int64
HTTP Method: GET
▼ ▲ displayvideo.advertisers.channels.get
Parameters:
advertiserId
Location: path
Required: Yes
Description: The ID of the advertiser that owns the fetched channel.
Type: string
Format: int64
Pattern: ^[^/]+$
channelId
Description: Required. The ID of the channel to fetch.
Location: path
Format: int64
Required: Yes
Pattern: ^[^/]+$
Type: string
partnerId
Location: query
Format: int64
Description: The ID of the partner that owns the fetched channel.
Type: string
HTTP Method: GET
Description: Gets a channel for a partner or advertiser.
Flat Path: v3/advertisers/{advertisersId}/channels/{channelsId}
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}/channels/{+channelId}
Parameter Order:
▼ ▲ displayvideo.advertisers.channels.patch
Parameters:
updateMask
Description: Required. The mask to control which fields to update.
Location: query
Format: google-fieldmask
Type: string
partnerId
Format: int64
Description: The ID of the partner that owns the created channel.
Location: query
Type: string
channelId
Format: int64
Description: Output only. The unique ID of the channel. Assigned by the system.
Required: Yes
Type: string
Location: path
advertiserId
Pattern: ^[^/]+$
Required: Yes
Location: path
Description: The ID of the advertiser that owns the created channel.
Type: string
Format: int64
Path: v3/advertisers/{+advertiserId}/channels/{channelId}
Parameter Order:
Description: Updates a channel. Returns the updated channel if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: PATCH
Flat Path: v3/advertisers/{advertisersId}/channels/{channelId}
▼ ▲ displayvideo.advertisers.channels.create
Description: Creates a new channel. Returns the newly created channel if successful.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
HTTP Method: POST
Path: v3/advertisers/{+advertiserId}/channels
Parameters:
advertiserId
Required: Yes
Location: path
Format: int64
Description: The ID of the advertiser that owns the created channel.
Type: string
Pattern: ^[^/]+$
partnerId
Format: int64
Type: string
Description: The ID of the partner that owns the created channel.
Location: query
Flat Path: v3/advertisers/{advertisersId}/channels
▼ ▲ displayvideo.advertisers.invoices.list
Scopes:
Flat Path: v3/advertisers/{advertisersId}/invoices
Parameters:
pageSize
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format: int32
Location: query
Type: integer
loiSapinInvoiceType
Type: string
Enum:
Enum Descriptions:
Description: Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
Location: query
advertiserId
Location: path
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the advertiser to list invoices for.
Required: Yes
Type: string
issueMonth
Type: string
Location: query
Description: The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.
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
Path: v3/advertisers/{+advertiserId}/invoices
HTTP Method: GET
Parameter Order: advertiserId
Description: Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.
▼ ▲ displayvideo.advertisers.invoices.lookupInvoiceCurrency
Parameters:
advertiserId
Description: Required. The ID of the advertiser to lookup currency for.
Location: path
Pattern: ^[^/]+$
Format: int64
Type: string
Required: Yes
invoiceMonth
Description: Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
Location: query
Type: string
Path: v3/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency
Description: Retrieves the invoice currency used by an advertiser in a given month.
Flat Path: v3/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency
Parameter Order: advertiserId
HTTP Method: GET
Scopes:
▼ ▲ displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list
Parameters:
pageToken
Type: string
Location: query
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` 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: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
Type: string
filter
Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * 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.
Location: query
Type: string
pageSize
Location: query
Type: integer
Format: int32
Description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
campaignId
Description: Required. The ID of the campaign to list assigned targeting options for.
Pattern: ^[^/]+$
Required: Yes
Location: path
Format: int64
Type: string
targetingType
Pattern: ^[^/]+$
Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `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_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`
Location: path
Type: string
Enum Descriptions:
Required: Yes
Enum:
advertiserId
Format: int64
Type: string
Required: Yes
Description: Required. The ID of the advertiser the campaign belongs to.
Pattern: ^[^/]+$
Location: path
Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method: GET
Description: Lists the targeting options assigned to a campaign for a specified targeting type.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get
Parameters:
campaignId
Required: Yes
Format: int64
Location: path
Type: string
Pattern: ^[^/]+$
Description: Required. The ID of the campaign the assigned targeting option belongs to.
assignedTargetingOptionId
Pattern: ^[^/]+$
Description: Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested.
Type: string
Location: path
Required: Yes
targetingType
Required: Yes
Type: string
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `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_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`
Pattern: ^[^/]+$
Location: path
Enum:
Enum Descriptions:
advertiserId
Type: string
Required: Yes
Description: Required. The ID of the advertiser the campaign belongs to.
Location: path
Format: int64
Pattern: ^[^/]+$
Scopes: https://www.googleapis.com/auth/display-video
Description: Gets a single targeting option assigned to a campaign.
Parameter Order:
Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
HTTP Method: GET
Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.campaigns.create
HTTP Method: POST
Path: v3/advertisers/{+advertiserId}/campaigns
Parameters:
advertiserId
Description: Output only. The unique ID of the advertiser the campaign belongs to.
Required: Yes
Location: path
Pattern: ^[^/]+$
Type: string
Format: int64
Parameter Order: advertiserId
Flat Path: v3/advertisers/{advertisersId}/campaigns
Scopes:
Description: Creates a new campaign. Returns the newly created campaign if successful.
▼ ▲ displayvideo.advertisers.campaigns.patch
Description: Updates an existing campaign. Returns the updated campaign if successful.
Parameters:
campaignId
Location: path
Type: string
Description: Output only. The unique ID of the campaign. Assigned by the system.
Pattern: ^[^/]+$
Required: Yes
Format: int64
advertiserId
Description: Output only. The unique ID of the advertiser the campaign belongs to.
Location: path
Format: int64
Pattern: ^[^/]+$
Required: Yes
Type: string
updateMask
Type: string
Location: query
Format: google-fieldmask
Description: Required. The mask to control which fields to update.
Parameter Order:
Scopes:
Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}
HTTP Method: PATCH
▼ ▲ displayvideo.advertisers.campaigns.listAssignedTargetingOptions
Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}:listAssignedTargetingOptions
Parameter Order:
Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions
HTTP Method: GET
Parameters:
filter
Type: string
Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `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
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 `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
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
campaignId
Location: path
Required: Yes
Format: int64
Pattern: ^[^/]+$
Type: string
Description: Required. The ID of the campaign to list assigned targeting options for.
orderBy
Type: string
Description: Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
Location: query
advertiserId
Location: path
Required: Yes
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the advertiser the campaign belongs to.
Type: string
Scopes: https://www.googleapis.com/auth/display-video
Description: Lists assigned targeting options of a campaign across targeting types.
▼ ▲ displayvideo.advertisers.campaigns.delete
Path: v3/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.
Scopes:
Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}
Parameters:
advertiserId
Format: int64
Description: The ID of the advertiser this campaign belongs to.
Type: string
Pattern: ^[^/]+$
Required: Yes
Location: path
campaignId
Location: path
Format: int64
Description: The ID of the campaign we need to delete.
Required: Yes
Pattern: ^[^/]+$
Type: string
HTTP Method: DELETE
Parameter Order:
▼ ▲ displayvideo.advertisers.campaigns.get
Flat Path: v3/advertisers/{advertisersId}/campaigns/{campaignsId}
Description: Gets a campaign.
Path: v3/advertisers/{+advertiserId}/campaigns/{+campaignId}
Parameter Order:
Scopes:
Parameters:
campaignId
Pattern: ^[^/]+$
Required: Yes
Description: Required. The ID of the campaign to fetch.
Format: int64
Location: path
Type: string
advertiserId
Format: int64
Description: Required. The ID of the advertiser this campaign belongs to.
Location: path
Required: Yes
Pattern: ^[^/]+$
Type: string
HTTP Method: GET
▼ ▲ displayvideo.advertisers.campaigns.list
Path: v3/advertisers/{+advertiserId}/campaigns
Scopes:
Parameter Order: advertiserId
Flat Path: v3/advertisers/{advertisersId}/campaigns
Parameters:
filter
Type: string
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.
pageSize
Type: integer
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location: query
Format: int32
pageToken
Type: string
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.
Location: query
orderBy
Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location: query
Type: string
advertiserId
Pattern: ^[^/]+$
Format: int64
Description: The ID of the advertiser to list campaigns for.
Type: string
Location: path
Required: Yes
HTTP Method: GET
Description: Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get
Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Scopes: https://www.googleapis.com/auth/display-video
Description: Gets a single targeting option assigned to a line item.
Parameter Order:
Parameters:
targetingType
Pattern: ^[^/]+$
Enum:
Enum Descriptions:
Location: path
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` * `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
lineItemId
Pattern: ^[^/]+$
Location: path
Required: Yes
Format: int64
Type: string
Description: Required. The ID of the line item the assigned targeting option belongs to.
assignedTargetingOptionId
Description: Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Pattern: ^[^/]+$
Location: path
Required: Yes
Type: string
advertiserId
Description: Required. The ID of the advertiser the line item belongs to.
Format: int64
Type: string
Location: path
Required: Yes
Pattern: ^[^/]+$
HTTP Method: GET
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameters:
advertiserId
Location: path
Format: int64
Type: string
Description: Required. The ID of the advertiser the line item belongs to.
Required: Yes
Pattern: ^[^/]+$
targetingType
Required: Yes
Enum:
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`
Location: path
Type: string
Pattern: ^[^/]+$
Enum Descriptions:
lineItemId
Pattern: ^[^/]+$
Format: int64
Required: Yes
Location: path
Description: Required. The ID of the line item the assigned targeting option will belong to.
Type: string
HTTP Method: POST
Parameter Order:
Flat Path: v3/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
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
HTTP Method: GET
Parameters:
orderBy
Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
Location: query
Type: string
lineItemId
Type: string
Pattern: ^[^/]+$
Format: int64
Location: path
Description: Required. The ID of the line item to list assigned targeting options for.
Required: Yes
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` * `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.
Location: query
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_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)
Location: path
Enum:
Pattern: ^[^/]+$
Type: string
Required: Yes
Enum Descriptions:
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
Format: int32
Type: integer
Description: Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location: query
advertiserId
Format: int64
Pattern: ^[^/]+$
Type: string
Required: Yes
Description: Required. The ID of the advertiser the line item belongs to.
Location: path
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description: Lists the targeting options assigned to a line item.
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order:
▼ ▲ displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete
HTTP Method: DELETE
Flat Path: v3/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
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
lineItemId
Format: int64
Required: Yes
Description: Required. The ID of the line item the assigned targeting option belongs to.
Type: string
Pattern: ^[^/]+$
Location: path
advertiserId
Type: string
Location: path
Description: Required. The ID of the advertiser the line item belongs to.
Required: Yes
Pattern: ^[^/]+$
Format: int64
assignedTargetingOptionId
Pattern: ^[^/]+$
Location: path
Required: Yes
Description: Required. The ID of the assigned targeting option to delete.
Type: string
targetingType
Pattern: ^[^/]+$
Enum Descriptions:
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`
Required: Yes
Type: string
Enum:
Location: path
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order:
▼ ▲ displayvideo.advertisers.lineItems.delete
HTTP Method: DELETE
Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Description: Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
Parameters:
lineItemId
Location: path
Required: Yes
Pattern: ^[^/]+$
Type: string
Format: int64
Description: The ID of the line item to delete.
advertiserId
Pattern: ^[^/]+$
Format: int64
Type: string
Description: The ID of the advertiser this line item belongs to.
Location: path
Required: Yes
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
▼ ▲ displayvideo.advertisers.lineItems.patch
Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Parameter Order:
Parameters:
updateMask
Type: string
Format: google-fieldmask
Description: Required. The mask to control which fields to update.
Location: query
lineItemId
Required: Yes
Format: int64
Type: string
Description: Output only. The unique ID of the line item. Assigned by the system.
Pattern: ^[^/]+$
Location: path
advertiserId
Location: path
Format: int64
Type: string
Pattern: ^[^/]+$
Required: Yes
Description: Output only. The unique ID of the advertiser the line item belongs to.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: PATCH
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
▼ ▲ displayvideo.advertisers.lineItems.get
Parameter Order:
HTTP Method: GET
Parameters:
lineItemId
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the line item to fetch.
Location: path
Type: string
Required: Yes
advertiserId
Pattern: ^[^/]+$
Format: int64
Required: Yes
Type: string
Description: Required. The ID of the advertiser this line item belongs to.
Location: path
Description: Gets a line item.
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}
Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}
▼ ▲ displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions
Description: Lists assigned targeting options for multiple line items across targeting types.
HTTP Method: GET
Flat Path: v3/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions
Path: v3/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
lineItemIds
Type: string
Description: Required. The IDs of the line items to list assigned targeting options for.
Location: query
Repeated: Yes
Format: int64
pageToken
Location: query
Type: string
Description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
pageSize
Format: int32
Location: query
Type: integer
Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
filter
Location: query
Type: string
Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
advertiserId
Type: string
Format: int64
Pattern: ^[^/]+$
Required: Yes
Description: Required. The ID of the advertiser the line items belongs to.
Location: path
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
Parameter Order: advertiserId
▼ ▲ displayvideo.advertisers.lineItems.create
Parameters:
advertiserId
Location: path
Required: Yes
Description: Output only. The unique ID of the advertiser the line item belongs to.
Pattern: ^[^/]+$
Type: string
Format: int64
Description: Creates a new line item. Returns the newly created line item if successful.
HTTP Method: POST
Flat Path: v3/advertisers/{advertisersId}/lineItems
Parameter Order: advertiserId
Path: v3/advertisers/{+advertiserId}/lineItems
▼ ▲ displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions
HTTP Method: POST
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
Flat Path: v3/advertisers/{advertisersId}/lineItems:bulkEditAssignedTargetingOptions
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
Parameters:
advertiserId
Required: Yes
Location: path
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the advertiser the line items belong to.
Type: string
Path: v3/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.lineItems.list
Path: v3/advertisers/{+advertiserId}/lineItems
Parameters:
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
Type: string
Location: query
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned.
advertiserId
Type: string
Required: Yes
Pattern: ^[^/]+$
Description: Required. The ID of the advertiser to list line items for.
Location: path
Format: int64
orderBy
Type: string
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`.
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
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: v3/advertisers/{advertisersId}/lineItems
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
HTTP Method: GET
▼ ▲ displayvideo.advertisers.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
Parameter Order: advertiserId
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertisersId}/lineItems:bulkUpdate
Parameters:
advertiserId
Description: Required. The ID of the advertiser this line item belongs to.
Type: string
Pattern: ^[^/]+$
Location: path
Format: int64
Required: Yes
HTTP Method: POST
Path: v3/advertisers/{+advertiserId}/lineItems:bulkUpdate
▼ ▲ displayvideo.advertisers.lineItems.duplicate
Parameters:
advertiserId
Type: string
Required: Yes
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the advertiser this line item belongs to.
Location: path
lineItemId
Pattern: ^[^/]+$
Type: string
Required: Yes
Description: Required. The ID of the line item to duplicate.
Location: path
Format: int64
Path: v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate
Parameter Order:
Description: Duplicates a line item. Returns the ID of the created line item if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: POST
Flat Path: v3/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate
▼ ▲ displayvideo.advertisers.lineItems.generateDefault
Path: v3/advertisers/{+advertiserId}/lineItems:generateDefault
HTTP Method: POST
Parameters:
advertiserId
Description: Required. The ID of the advertiser this line item belongs to.
Location: path
Format: int64
Type: string
Required: Yes
Pattern: ^[^/]+$
Description: Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
Flat Path: v3/advertisers/{advertisersId}/lineItems:generateDefault
▼ ▲ displayvideo.advertisers.assets.upload
Path: v3/advertisers/{+advertiserId}/assets
Parameter Order: advertiserId
Flat Path: v3/advertisers/{advertisersId}/assets
Scopes: https://www.googleapis.com/auth/display-video
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).
Mediaupload:
Accept: */*
Protocols:
Simple:
Path: /upload/v3/advertisers/{+advertiserId}/assets
Multipart: Yes
Parameters:
advertiserId
Type: string
Description: Required. The ID of the advertiser this asset belongs to.
Location: path
Required: Yes
Pattern: ^[^/]+$
Format: int64
HTTP Method: POST
Supportsmediaupload: Yes
▼ ▲ displayvideo.advertisers.insertionOrders.create
Description: Creates a new insertion order. Returns the newly created insertion order if successful.
Flat Path: v3/advertisers/{advertisersId}/insertionOrders
Parameters:
advertiserId
Required: Yes
Type: string
Pattern: ^[^/]+$
Description: Output only. The unique ID of the advertiser the insertion order belongs to.
Location: path
Format: int64
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
Path: v3/advertisers/{+advertiserId}/insertionOrders
▼ ▲ displayvideo.advertisers.insertionOrders.get
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Parameter Order:
Description: Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
HTTP Method: GET
Parameters:
advertiserId
Pattern: ^[^/]+$
Required: Yes
Type: string
Format: int64
Description: Required. The ID of the advertiser this insertion order belongs to.
Location: path
insertionOrderId
Format: int64
Description: Required. The ID of the insertion order to fetch.
Required: Yes
Type: string
Location: path
Pattern: ^[^/]+$
▼ ▲ displayvideo.advertisers.insertionOrders.delete
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Description: Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
Parameters:
insertionOrderId
Pattern: ^[^/]+$
Description: The ID of the insertion order to delete.
Location: path
Format: int64
Required: Yes
Type: string
advertiserId
Description: The ID of the advertiser this insertion order belongs to.
Type: string
Location: path
Required: Yes
Pattern: ^[^/]+$
Format: int64
HTTP Method: DELETE
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Parameter Order:
▼ ▲ displayvideo.advertisers.insertionOrders.list
Parameters:
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`.
pageSize
Format: int32
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
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 `ListInsertionOrders` method. If not specified, the first page of results will be returned.
Location: query
advertiserId
Required: Yes
Format: int64
Location: path
Pattern: ^[^/]+$
Description: Required. The ID of the advertiser to list insertion orders for.
Type: string
filter
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.
Location: query
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Flat Path: v3/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.
Path: v3/advertisers/{+advertiserId}/insertionOrders
Parameter Order: advertiserId
▼ ▲ displayvideo.advertisers.insertionOrders.patch
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}
Parameters:
updateMask
Format: google-fieldmask
Type: string
Description: Required. The mask to control which fields to update.
Location: query
advertiserId
Description: Output only. The unique ID of the advertiser the insertion order belongs to.
Location: path
Format: int64
Type: string
Required: Yes
Pattern: ^[^/]+$
insertionOrderId
Type: string
Pattern: ^[^/]+$
Format: int64
Description: Output only. The unique ID of the insertion order. Assigned by the system.
Location: path
Required: Yes
Description: Updates an existing insertion order. Returns the updated insertion order if successful.
Parameter Order:
HTTP Method: PATCH
▼ ▲ displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions
Parameter Order:
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions
HTTP Method: GET
Description: Lists assigned targeting options of an insertion order across targeting types.
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}:listAssignedTargetingOptions
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
filter
Type: string
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`. * 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.
advertiserId
Format: int64
Type: string
Description: Required. The ID of the advertiser the insertion order belongs to.
Required: Yes
Location: path
Pattern: ^[^/]+$
pageToken
Description: A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Type: string
Location: query
pageSize
Type: integer
Description: Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location: query
Format: int32
orderBy
Type: string
Description: Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
Location: query
insertionOrderId
Type: string
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the insertion order to list assigned targeting options for.
Location: path
Required: Yes
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description: Lists the targeting options assigned to an insertion order.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
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 `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location: query
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`.
Location: query
Type: string
insertionOrderId
Description: Required. The ID of the insertion order to list assigned targeting options for.
Location: path
Pattern: ^[^/]+$
Type: string
Format: int64
Required: Yes
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`. * 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
advertiserId
Format: int64
Pattern: ^[^/]+$
Required: Yes
Description: Required. The ID of the advertiser the insertion order belongs to.
Location: path
Type: string
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
targetingType
Type: string
Location: path
Required: Yes
Pattern: ^[^/]+$
Enum:
Enum Descriptions:
Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Parameter Order:
Parameters:
insertionOrderId
Location: path
Format: int64
Required: Yes
Type: string
Pattern: ^[^/]+$
Description: Required. The ID of the insertion order the assigned targeting option will belong to.
advertiserId
Required: Yes
Description: Required. The ID of the advertiser the insertion order belongs to.
Type: string
Pattern: ^[^/]+$
Location: path
Format: int64
targetingType
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
Type: string
Location: path
Required: Yes
Enum:
Pattern: ^[^/]+$
Enum Descriptions:
Description: Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
HTTP Method: POST
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order:
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
HTTP Method: GET
Parameters:
insertionOrderId
Description: Required. The ID of the insertion order the assigned targeting option belongs to.
Location: path
Pattern: ^[^/]+$
Type: string
Required: Yes
Format: int64
targetingType
Required: Yes
Enum Descriptions:
Enum:
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`
Location: path
Type: string
Pattern: ^[^/]+$
advertiserId
Format: int64
Location: path
Type: string
Required: Yes
Pattern: ^[^/]+$
Description: Required. The ID of the advertiser the insertion order belongs to.
assignedTargetingOptionId
Pattern: ^[^/]+$
Type: string
Location: path
Description: Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested.
Required: Yes
Scopes: https://www.googleapis.com/auth/display-video
Description: Gets a single targeting option assigned to an insertion order.
▼ ▲ displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete
Parameters:
insertionOrderId
Pattern: ^[^/]+$
Description: Required. The ID of the insertion order the assigned targeting option belongs to.
Type: string
Format: int64
Required: Yes
Location: path
assignedTargetingOptionId
Required: Yes
Description: Required. The ID of the assigned targeting option to delete.
Pattern: ^[^/]+$
Type: string
Location: path
advertiserId
Format: int64
Required: Yes
Description: Required. The ID of the advertiser the insertion order belongs to.
Pattern: ^[^/]+$
Type: string
Location: path
targetingType
Enum Descriptions:
Pattern: ^[^/]+$
Location: path
Type: string
Enum:
Required: Yes
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
Flat Path: v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Path: v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order:
Description: Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`
HTTP Method: DELETE
▼ ▲ displayvideo.advertisers.creatives.get
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
HTTP Method: GET
Flat Path: v3/advertisers/{advertisersId}/creatives/{creativesId}
Parameters:
creativeId
Pattern: ^[^/]+$
Location: path
Format: int64
Required: Yes
Type: string
Description: Required. The ID of the creative to fetch.
advertiserId
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the advertiser this creative belongs to.
Required: Yes
Location: path
Type: string
Description: Gets a creative.
Path: v3/advertisers/{+advertiserId}/creatives/{+creativeId}
▼ ▲ displayvideo.advertisers.creatives.create
Path: v3/advertisers/{+advertiserId}/creatives
Parameter Order: advertiserId
HTTP Method: POST
Flat Path: v3/advertisers/{advertisersId}/creatives
Parameters:
advertiserId
Pattern: ^[^/]+$
Required: Yes
Description: Output only. The unique ID of the advertiser the creative belongs to.
Format: int64
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/display-video
Description: Creates a new creative. Returns the newly created creative if successful.
▼ ▲ displayvideo.advertisers.creatives.delete
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertisersId}/creatives/{creativesId}
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.
Parameters:
advertiserId
Description: The ID of the advertiser this creative belongs to.
Format: int64
Pattern: ^[^/]+$
Required: Yes
Type: string
Location: path
creativeId
Description: The ID of the creative to be deleted.
Location: path
Pattern: ^[^/]+$
Required: Yes
Type: string
Format: int64
HTTP Method: DELETE
Path: v3/advertisers/{+advertiserId}/creatives/{+creativeId}
▼ ▲ displayvideo.advertisers.creatives.list
Flat Path: v3/advertisers/{advertisersId}/creatives
Parameters:
advertiserId
Pattern: ^[^/]+$
Type: string
Description: Required. The ID of the advertiser to list creatives for.
Location: path
Required: Yes
Format: int64
orderBy
Type: string
Description: Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`.
Location: query
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
pageToken
Location: query
Type: string
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned.
pageSize
Type: integer
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location: query
Format: int32
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
Path: v3/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.
▼ ▲ displayvideo.advertisers.creatives.patch
Description: Updates an existing creative. Returns the updated creative if successful.
Parameter Order:
Path: v3/advertisers/{+advertiserId}/creatives/{+creativeId}
Parameters:
advertiserId
Location: path
Format: int64
Pattern: ^[^/]+$
Type: string
Description: Output only. The unique ID of the advertiser the creative belongs to.
Required: Yes
creativeId
Format: int64
Location: path
Required: Yes
Pattern: ^[^/]+$
Type: string
Description: Output only. The unique ID of the creative. Assigned by the system.
updateMask
Description: Required. The mask to control which fields to update.
Format: google-fieldmask
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: PATCH
Flat Path: v3/advertisers/{advertisersId}/creatives/{creativesId}
▼ ▲ displayvideo.advertisers.adGroupAds.list
Parameter Order: advertiserId
Scopes: https://www.googleapis.com/auth/display-video
Description: Lists ad group ads.
Flat Path: v3/advertisers/{advertisersId}/adGroupAds
HTTP Method: GET
Path: v3/advertisers/{+advertiserId}/adGroupAds
Parameters:
advertiserId
Required: Yes
Location: path
Type: string
Format: int64
Description: Required. The ID of the advertiser the ad groups belongs to.
Pattern: ^[^/]+$
orderBy
Description: Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Location: query
Type: string
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
filter
Type: string
Location: query
Description: Optional. Allows filtering by custom 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.
pageSize
Type: integer
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.
Format: int32
▼ ▲ displayvideo.advertisers.adGroupAds.get
HTTP Method: GET
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}
Flat Path: v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}
Description: Gets an ad group ad.
Parameters:
adGroupAdId
Pattern: ^[^/]+$
Type: string
Description: Required. The ID of the ad group ad to fetch.
Required: Yes
Format: int64
Location: path
advertiserId
Required: Yes
Format: int64
Type: string
Pattern: ^[^/]+$
Location: path
Description: Required. The ID of the advertiser this ad group ad belongs to.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.create
Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
HTTP Method: POST
Parameters:
negativeKeywordListId
Format: int64
Location: path
Required: Yes
Type: string
Pattern: ^[^/]+$
Description: Required. The ID of the parent negative keyword list in which the negative keyword will be created.
advertiserId
Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location: path
Required: Yes
Format: int64
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
Description: Creates a negative keyword in a negative keyword list.
Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.bulkEdit
HTTP Method: POST
Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit
Description: Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure.
Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:bulkEdit
Parameter Order:
Parameters:
advertiserId
Required: Yes
Location: path
Format: int64
Type: string
Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
negativeKeywordListId
Format: int64
Required: Yes
Location: path
Description: Required. The ID of the parent negative keyword list to which the negative keywords belong.
Pattern: ^[^/]+$
Type: string
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list
Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords
Scopes: https://www.googleapis.com/auth/display-video
Description: Lists negative keywords in a negative keyword list.
Parameter Order:
Parameters:
filter
Type: string
Location: query
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.
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 `ListNegativeKeywords` method. If not specified, the first page of results will be returned.
pageSize
Format: int32
Description: Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location: query
Type: integer
orderBy
Description: Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `keywordValue desc`.
Location: query
Type: string
advertiserId
Format: int64
Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location: path
Type: string
Pattern: ^[^/]+$
Required: Yes
negativeKeywordListId
Required: Yes
Pattern: ^[^/]+$
Description: Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
Format: int64
Type: string
Location: path
Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords
HTTP Method: GET
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.delete
Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}
Description: Deletes a negative keyword from a negative keyword list.
Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords/{negativeKeywordsId}
Parameter Order:
Parameters:
keywordValue
Required: Yes
Description: Required. The keyword value of the negative keyword to delete.
Location: path
Type: string
Pattern: ^[^/]+$
advertiserId
Location: path
Format: int64
Type: string
Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required: Yes
negativeKeywordListId
Required: Yes
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Location: path
Type: string
HTTP Method: DELETE
▼ ▲ displayvideo.advertisers.negativeKeywordLists.negativeKeywords.replace
HTTP Method: POST
Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
negativeKeywordListId
Location: path
Type: string
Required: Yes
Format: int64
Description: Required. The ID of the parent negative keyword list to which the negative keywords belong.
Pattern: ^[^/]+$
advertiserId
Type: string
Required: Yes
Format: int64
Description: Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Location: path
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:
Flat Path: v3/advertisers/{advertiserId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords:replace
▼ ▲ displayvideo.advertisers.negativeKeywordLists.create
Parameters:
advertiserId
Pattern: ^[^/]+$
Format: int64
Location: path
Description: Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Type: string
Required: Yes
Path: v3/advertisers/{+advertiserId}/negativeKeywordLists
Parameter Order: advertiserId
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: POST
Description: Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists
▼ ▲ displayvideo.advertisers.negativeKeywordLists.get
Parameters:
advertiserId
Description: Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Type: string
Location: path
Pattern: ^[^/]+$
Format: int64
Required: Yes
negativeKeywordListId
Type: string
Format: int64
Required: Yes
Description: Required. The ID of the negative keyword list to fetch.
Location: path
Pattern: ^[^/]+$
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Parameter Order:
Description: Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
▼ ▲ displayvideo.advertisers.negativeKeywordLists.delete
Parameters:
advertiserId
Pattern: ^[^/]+$
Format: int64
Description: Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Required: Yes
Type: string
Location: path
negativeKeywordListId
Description: Required. The ID of the negative keyword list to delete.
Pattern: ^[^/]+$
Location: path
Format: int64
Required: Yes
Type: string
Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}
Description: Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
Parameter Order:
HTTP Method: DELETE
▼ ▲ displayvideo.advertisers.negativeKeywordLists.list
Path: v3/advertisers/{+advertiserId}/negativeKeywordLists
Parameters:
pageSize
Format: int32
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.
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
advertiserId
Format: int64
Description: Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
Type: string
Pattern: ^[^/]+$
Location: path
Required: Yes
Description: Lists negative keyword lists based on a given advertiser id.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: advertiserId
Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists
HTTP Method: GET
▼ ▲ displayvideo.advertisers.negativeKeywordLists.patch
Parameter Order:
Flat Path: v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListId}
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Required. The mask to control which fields to update.
advertiserId
Required: Yes
Format: int64
Pattern: ^[^/]+$
Location: path
Description: Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Type: string
negativeKeywordListId
Type: string
Location: path
Description: Output only. The unique ID of the negative keyword list. Assigned by the system.
Required: Yes
Format: int64
Path: v3/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}
Description: Updates a negative keyword list. Returns the updated negative keyword list if successful.
▼ ▲ displayvideo.advertisers.adGroups.list
Path: v3/advertisers/{+advertiserId}/adGroups
Flat Path: v3/advertisers/{advertisersId}/adGroups
Parameter Order: advertiserId
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Parameters:
filter
Description: Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location: query
Type: string
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
orderBy
Type: string
Location: query
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`.
pageSize
Type: integer
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.
Format: int32
advertiserId
Format: int64
Required: Yes
Description: Required. The ID of the advertiser the ad groups belongs to.
Pattern: ^[^/]+$
Type: string
Location: path
Description: Lists ad groups.
▼ ▲ displayvideo.advertisers.adGroups.bulkListAdGroupAssignedTargetingOptions
Description: Lists assigned targeting options for multiple ad groups across targeting types. Inherieted assigned targeting options are not included.
Parameters:
pageSize
Location: query
Format: int32
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
filter
Description: Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location: query
Type: string
advertiserId
Location: path
Pattern: ^[^/]+$
Format: int64
Type: string
Description: Required. The ID of the advertiser the line items belongs to.
Required: Yes
pageToken
Description: Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location: query
Type: string
adGroupIds
Repeated: Yes
Format: int64
Location: query
Description: Required. The IDs of the ad groups to list assigned targeting options for.
Type: string
orderBy
Location: query
Description: Optional. Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (acceptable in v2) * `adGroupId` (acceptable in v3) * `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
Parameter Order: advertiserId
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Flat Path: v3/advertisers/{advertisersId}/adGroups:bulkListAdGroupAssignedTargetingOptions
Path: v3/advertisers/{+advertiserId}/adGroups:bulkListAdGroupAssignedTargetingOptions
▼ ▲ displayvideo.advertisers.adGroups.get
Description: Gets an ad group.
Flat Path: v3/advertisers/{advertisersId}/adGroups/{adGroupsId}
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Path: v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}
Parameters:
advertiserId
Pattern: ^[^/]+$
Location: path
Type: string
Required: Yes
Format: int64
Description: Required. The ID of the advertiser this ad group belongs to.
adGroupId
Pattern: ^[^/]+$
Description: Required. The ID of the ad group to fetch.
Type: string
Location: path
Required: Yes
Format: int64
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get
Description: Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Parameters:
advertiserId
Pattern: ^[^/]+$
Description: Required. The ID of the advertiser the ad group belongs to.
Location: path
Format: int64
Required: Yes
Type: string
assignedTargetingOptionId
Pattern: ^[^/]+$
Description: Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Required: Yes
Location: path
Type: string
adGroupId
Pattern: ^[^/]+$
Required: Yes
Location: path
Format: int64
Type: string
Description: Required. The ID of the ad group the assigned targeting option belongs to.
targetingType
Enum Descriptions:
Pattern: ^[^/]+$
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_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Location: path
Enum:
Path: v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Parameter Order:
Flat Path: v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
▼ ▲ displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list
Parameter Order:
HTTP Method: GET
Parameters:
filter
Type: string
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: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
targetingType
Enum Descriptions:
Type: string
Enum:
Required: Yes
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_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
Location: path
adGroupId
Format: int64
Location: path
Pattern: ^[^/]+$
Required: Yes
Type: string
Description: Required. The ID of the ad group to list assigned targeting options for.
pageToken
Description: Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
Location: query
Type: string
advertiserId
Location: path
Type: string
Pattern: ^[^/]+$
Required: Yes
Description: Required. The ID of the advertiser the ad group belongs to.
Format: int64
orderBy
Type: string
Description: Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
Location: query
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
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Flat Path: v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Description: Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
▼ ▲ displayvideo.partners.list
Description: Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
Parameters:
pageSize
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location: query
Type: integer
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 `ListPartners` method. If not specified, the first page of results will be returned.
filter
Type: string
Location: query
Description: Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy
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
Flat Path: v3/partners
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/partners
▼ ▲ displayvideo.partners.get
Parameter Order: partnerId
Parameters:
partnerId
Required: Yes
Description: Required. The ID of the partner to fetch.
Format: int64
Type: string
Location: path
Pattern: ^[^/]+$
HTTP Method: GET
Path: v3/partners/{+partnerId}
Flat Path: v3/partners/{partnersId}
Scopes: https://www.googleapis.com/auth/display-video
Description: Gets a partner.
▼ ▲ displayvideo.partners.editAssignedTargetingOptions
HTTP Method: POST
Path: v3/partners/{+partnerId}:editAssignedTargetingOptions
Flat Path: v3/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 .
Parameters:
partnerId
Description: Required. The ID of the partner.
Format: int64
Pattern: ^[^/]+$
Type: string
Location: path
Required: Yes
Parameter Order: partnerId
▼ ▲ displayvideo.partners.channels.patch
Parameters:
partnerId
Description: The ID of the partner that owns the created channel.
Location: path
Type: string
Pattern: ^[^/]+$
Format: int64
Required: Yes
advertiserId
Description: The ID of the advertiser that owns the created channel.
Type: string
Location: query
Format: int64
updateMask
Type: string
Format: google-fieldmask
Description: Required. The mask to control which fields to update.
Location: query
channelId
Description: Output only. The unique ID of the channel. Assigned by the system.
Format: int64
Location: path
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/partners/{+partnerId}/channels/{channelId}
HTTP Method: PATCH
Parameter Order:
Description: Updates a channel. Returns the updated channel if successful.
Flat Path: v3/partners/{partnersId}/channels/{channelId}
▼ ▲ displayvideo.partners.channels.get
HTTP Method: GET
Parameter Order:
Description: Gets a channel for a partner or advertiser.
Flat Path: v3/partners/{partnersId}/channels/{channelsId}
Path: v3/partners/{+partnerId}/channels/{+channelId}
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
partnerId
Type: string
Format: int64
Required: Yes
Description: The ID of the partner that owns the fetched channel.
Location: path
Pattern: ^[^/]+$
advertiserId
Type: string
Description: The ID of the advertiser that owns the fetched channel.
Location: query
Format: int64
channelId
Type: string
Pattern: ^[^/]+$
Required: Yes
Description: Required. The ID of the channel to fetch.
Format: int64
Location: path
▼ ▲ displayvideo.partners.channels.list
HTTP Method: GET
Parameters:
advertiserId
Type: string
Format: int64
Description: The ID of the advertiser that owns the channels.
Location: query
pageSize
Location: query
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Type: integer
partnerId
Format: int64
Type: string
Pattern: ^[^/]+$
Description: The ID of the partner that owns the channels.
Location: path
Required: Yes
filter
Type: string
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.
orderBy
Location: query
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
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
Flat Path: v3/partners/{partnersId}/channels
Scopes: https://www.googleapis.com/auth/display-video
Description: Lists channels for a partner or advertiser.
Parameter Order: partnerId
Path: v3/partners/{+partnerId}/channels
▼ ▲ displayvideo.partners.channels.create
HTTP Method: POST
Flat Path: v3/partners/{partnersId}/channels
Parameter Order: partnerId
Description: Creates a new channel. Returns the newly created channel if successful.
Path: v3/partners/{+partnerId}/channels
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
advertiserId
Location: query
Description: The ID of the advertiser that owns the created channel.
Type: string
Format: int64
partnerId
Description: The ID of the partner that owns the created channel.
Pattern: ^[^/]+$
Required: Yes
Type: string
Location: path
Format: int64
▼ ▲ displayvideo.partners.channels.sites.create
Path: v3/partners/{partnerId}/channels/{+channelId}/sites
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Flat Path: v3/partners/{partnerId}/channels/{channelsId}/sites
HTTP Method: POST
Parameters:
advertiserId
Description: The ID of the advertiser that owns the parent channel.
Location: query
Format: int64
Type: string
channelId
Location: path
Required: Yes
Format: int64
Description: Required. The ID of the parent channel in which the site will be created.
Type: string
Pattern: ^[^/]+$
partnerId
Format: int64
Description: The ID of the partner that owns the parent channel.
Type: string
Required: Yes
Location: path
Description: Creates a site in a channel.
▼ ▲ displayvideo.partners.channels.sites.replace
Parameters:
channelId
Type: string
Pattern: ^[^/]+$
Location: path
Format: int64
Required: Yes
Description: Required. The ID of the parent channel whose sites will be replaced.
partnerId
Location: path
Description: The ID of the partner that owns the parent channel.
Type: string
Required: Yes
Format: int64
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.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Flat Path: v3/partners/{partnerId}/channels/{channelsId}/sites:replace
HTTP Method: POST
Path: v3/partners/{partnerId}/channels/{+channelId}/sites:replace
▼ ▲ displayvideo.partners.channels.sites.delete
Parameters:
urlOrAppId
Type: string
Pattern: ^[^/]+$
Required: Yes
Description: Required. The URL or app ID of the site to delete.
Location: path
partnerId
Required: Yes
Type: string
Description: The ID of the partner that owns the parent channel.
Location: path
Format: int64
channelId
Description: Required. The ID of the parent channel to which the site belongs.
Pattern: ^[^/]+$
Location: path
Required: Yes
Type: string
Format: int64
advertiserId
Location: query
Format: int64
Type: string
Description: The ID of the advertiser that owns the parent channel.
Description: Deletes a site from a channel.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: DELETE
Path: v3/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}
Parameter Order:
Flat Path: v3/partners/{partnerId}/channels/{channelsId}/sites/{sitesId}
▼ ▲ displayvideo.partners.channels.sites.list
Path: v3/partners/{+partnerId}/channels/{+channelId}/sites
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Description: Lists sites in a channel.
Parameters:
orderBy
Type: string
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`.
pageToken
Type: string
Location: query
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.
channelId
Location: path
Required: Yes
Format: int64
Description: Required. The ID of the parent channel to which the requested sites belong.
Type: string
Pattern: ^[^/]+$
partnerId
Type: string
Description: The ID of the partner that owns the parent channel.
Required: Yes
Location: path
Pattern: ^[^/]+$
Format: int64
advertiserId
Format: int64
Description: The ID of the advertiser that owns the parent channel.
Type: string
Location: query
pageSize
Type: integer
Location: query
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
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
Flat Path: v3/partners/{partnersId}/channels/{channelsId}/sites
HTTP Method: GET
▼ ▲ displayvideo.partners.channels.sites.bulkEdit
Parameters:
partnerId
Required: Yes
Description: The ID of the partner that owns the parent channel.
Type: string
Format: int64
Location: path
channelId
Description: Required. The ID of the parent channel to which the sites belong.
Required: Yes
Type: string
Location: path
Format: int64
Pattern: ^[^/]+$
Flat Path: v3/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.
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit
HTTP Method: POST
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.delete
HTTP Method: DELETE
Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
Scopes: https://www.googleapis.com/auth/display-video
Description: Deletes an assigned targeting option from a partner.
Parameters:
assignedTargetingOptionId
Description: Required. The ID of the assigned targeting option to delete.
Pattern: ^[^/]+$
Required: Yes
Type: string
Location: path
partnerId
Pattern: ^[^/]+$
Required: Yes
Description: Required. The ID of the partner.
Type: string
Format: int64
Location: path
targetingType
Required: Yes
Pattern: ^[^/]+$
Enum Descriptions:
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Enum:
Type: string
Location: path
Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameter Order:
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.get
HTTP Method: GET
Description: Gets a single targeting option assigned to a partner.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order:
Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}
Parameters:
targetingType
Type: string
Enum Descriptions:
Pattern: ^[^/]+$
Enum:
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Required: Yes
Location: path
partnerId
Format: int64
Pattern: ^[^/]+$
Type: string
Description: Required. The ID of the partner.
Location: path
Required: Yes
assignedTargetingOptionId
Location: path
Type: string
Pattern: ^[^/]+$
Description: Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Required: Yes
Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.list
Description: Lists the targeting options assigned to a partner.
Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
HTTP Method: GET
Parameter Order:
Parameters:
filter
Location: query
Type: string
Description: Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
pageToken
Type: string
Location: query
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
targetingType
Enum:
Pattern: ^[^/]+$
Description: Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Enum Descriptions:
Required: Yes
Location: path
Type: string
partnerId
Pattern: ^[^/]+$
Required: Yes
Description: Required. The ID of the partner.
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.
Location: query
Type: integer
Format: int32
orderBy
Location: query
Type: string
Description: Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`.
▼ ▲ displayvideo.partners.targetingTypes.assignedTargetingOptions.create
Flat Path: v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions
Parameter Order:
HTTP Method: POST
Path: v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions
Description: Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
Parameters:
targetingType
Required: Yes
Pattern: ^[^/]+$
Description: Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`
Type: string
Enum:
Location: path
Enum Descriptions:
partnerId
Format: int64
Required: Yes
Description: Required. The ID of the partner.
Pattern: ^[^/]+$
Type: string
Location: path
▼ ▲ displayvideo.googleAudiences.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/googleAudiences
Description: Lists Google audiences. The order is defined by the order_by parameter.
Path: v3/googleAudiences
Parameters:
pageSize
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location: query
Type: integer
partnerId
Type: string
Location: query
Description: The ID of the partner that has access to the fetched Google audiences.
Format: int64
filter
Location: query
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
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.
advertiserId
Format: int64
Location: query
Description: The ID of the advertiser that has access to the fetched Google audiences.
Type: string
orderBy
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
Location: query
▼ ▲ displayvideo.googleAudiences.get
Parameters:
partnerId
Description: The ID of the partner that has access to the fetched Google audience.
Format: int64
Type: string
Location: query
googleAudienceId
Type: string
Description: Required. The ID of the Google audience to fetch.
Required: Yes
Location: path
Pattern: ^[^/]+$
Format: int64
advertiserId
Description: The ID of the advertiser that has access to the fetched Google audience.
Type: string
Location: query
Format: int64
HTTP Method: GET
Flat Path: v3/googleAudiences/{googleAudiencesId}
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: googleAudienceId
Description: Gets a Google audience.
Path: v3/googleAudiences/{+googleAudienceId}
▼ ▲ displayvideo.inventorySources.list
Path: v3/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: v3/inventorySources
Parameters:
partnerId
Format: int64
Type: string
Location: query
Description: The ID of the partner that has access to the inventory source.
pageSize
Type: integer
Location: query
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
advertiserId
Location: query
Description: The ID of the advertiser that has access to the inventory source.
Format: int64
Type: string
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.
orderBy
Type: string
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`.
pageToken
Location: query
Type: string
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.
HTTP Method: GET
▼ ▲ displayvideo.inventorySources.create
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/inventorySources
Description: Creates a new inventory source. Returns the newly created inventory source if successful.
HTTP Method: POST
Flat Path: v3/inventorySources
Parameters:
partnerId
Type: string
Location: query
Description: The ID of the partner that the request is being made within.
Format: int64
advertiserId
Location: query
Format: int64
Type: string
Description: The ID of the advertiser that the request is being made within.
▼ ▲ displayvideo.inventorySources.editInventorySourceReadWriteAccessors
HTTP Method: POST
Flat Path: v3/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors
Parameters:
inventorySourceId
Description: Required. The ID of inventory source to update.
Location: path
Required: Yes
Pattern: ^[^/]+$
Type: string
Format: int64
Parameter Order: inventorySourceId
Description: Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors
▼ ▲ displayvideo.inventorySources.patch
HTTP Method: PATCH
Description: Updates an existing inventory source. Returns the updated inventory source if successful.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: inventorySourceId
Flat Path: v3/inventorySources/{inventorySourcesId}
Path: v3/inventorySources/{+inventorySourceId}
Parameters:
updateMask
Location: query
Description: Required. The mask to control which fields to update.
Type: string
Format: google-fieldmask
partnerId
Format: int64
Location: query
Description: The ID of the partner that the request is being made within.
Type: string
inventorySourceId
Type: string
Pattern: ^[^/]+$
Required: Yes
Description: Output only. The unique ID of the inventory source. Assigned by the system.
Location: path
Format: int64
advertiserId
Description: The ID of the advertiser that the request is being made within.
Location: query
Format: int64
Type: string
▼ ▲ displayvideo.inventorySources.get
Path: v3/inventorySources/{+inventorySourceId}
Parameters:
partnerId
Location: query
Type: string
Format: int64
Description: Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
advertiserId
Type: string
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
Location: query
inventorySourceId
Required: Yes
Description: Required. The ID of the inventory source to fetch.
Location: path
Type: string
Pattern: ^[^/]+$
Format: int64
Parameter Order: inventorySourceId
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/inventorySources/{inventorySourcesId}
HTTP Method: GET
Description: Gets an inventory source.
▼ ▲ displayvideo.users.delete
Flat Path: v3/users/{usersId}
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
Path: v3/users/{+userId}
HTTP Method: DELETE
Parameters:
userId
Type: string
Required: Yes
Description: Required. The ID of the user to delete.
Pattern: ^[^/]+$
Format: int64
Location: path
Scopes: https://www.googleapis.com/auth/display-video-user-management
▼ ▲ displayvideo.users.create
Flat Path: v3/users
Path: v3/users
Scopes: https://www.googleapis.com/auth/display-video-user-management
HTTP Method: POST
Description: Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
▼ ▲ displayvideo.users.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.
Path: v3/users/{+userId}:bulkEditAssignedUserRoles
Flat Path: v3/users/{usersId}:bulkEditAssignedUserRoles
Scopes: https://www.googleapis.com/auth/display-video-user-management
HTTP Method: POST
Parameter Order: userId
Parameters:
userId
Required: Yes
Type: string
Location: path
Format: int64
Description: Required. The ID of the user to which the assigned user roles belong.
Pattern: ^[^/]+$
▼ ▲ displayvideo.users.patch
HTTP Method: PATCH
Parameters:
userId
Format: int64
Location: path
Type: string
Required: Yes
Pattern: ^[^/]+$
Description: Output only. The unique ID of the user. Assigned by the system.
updateMask
Description: Required. The mask to control which fields to update.
Format: google-fieldmask
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/display-video-user-management
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: v3/users/{usersId}
Parameter Order: userId
Path: v3/users/{+userId}
▼ ▲ displayvideo.users.list
Description: Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
HTTP Method: GET
Parameters:
filter
Location: query
Type: string
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 `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (<)` operator. * The `displayName and `email` field must use the `HAS (:)` 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` 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"` 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 `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
pageSize
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type: integer
Location: query
Path: v3/users
Scopes: https://www.googleapis.com/auth/display-video-user-management
Flat Path: v3/users
▼ ▲ displayvideo.users.get
Path: v3/users/{+userId}
Parameter Order: userId
Scopes: https://www.googleapis.com/auth/display-video-user-management
Parameters:
userId
Location: path
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the user to fetch.
Required: Yes
Type: string
Flat Path: v3/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.
HTTP Method: GET
▼ ▲ displayvideo.media.upload
HTTP Method: POST
Flat Path: media/{mediaId}
Supportsmediaupload: Yes
Parameters:
resourceName
Description: Name of the media that is being downloaded. See ReadRequest.resource_name.
Pattern: ^.*$
Location: path
Type: string
Required: 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.
Path: media/{+resourceName}
Parameter Order: resourceName
Scopes:
Mediaupload:
Protocols:
Simple:
Path: /upload/media/{+resourceName}
Multipart: Yes
Accept: */*
▼ ▲ displayvideo.media.download
Flat Path: download/{downloadId}
HTTP Method: GET
Supportsmediadownload: Yes
Scopes:
Parameter Order: resourceName
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.
Parameters:
resourceName
Required: Yes
Location: path
Pattern: ^.*$
Description: Name of the media that is being downloaded. See ReadRequest.resource_name.
Type: string
▼ ▲ displayvideo.firstAndThirdPartyAudiences.create
Path: v3/firstAndThirdPartyAudiences
Description: Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/firstAndThirdPartyAudiences
HTTP Method: POST
Parameters:
advertiserId
Description: Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.
Location: query
Type: string
Format: int64
▼ ▲ displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers
Parameter Order: firstAndThirdPartyAudienceId
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: POST
Flat Path: v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers
Parameters:
firstAndThirdPartyAudienceId
Description: Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.
Type: string
Location: path
Required: Yes
Format: int64
Pattern: ^[^/]+$
Description: Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Path: v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers
▼ ▲ displayvideo.firstAndThirdPartyAudiences.patch
Path: v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
Description: Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: firstAndThirdPartyAudienceId
Parameters:
updateMask
Format: google-fieldmask
Location: query
Description: Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
Type: string
firstAndThirdPartyAudienceId
Type: string
Pattern: ^[^/]+$
Format: int64
Required: Yes
Description: Output only. The unique ID of the first and third party audience. Assigned by the system.
Location: path
advertiserId
Type: string
Location: query
Format: int64
Description: Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.
Flat Path: v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
HTTP Method: PATCH
▼ ▲ displayvideo.firstAndThirdPartyAudiences.list
HTTP Method: GET
Parameters:
filter
Location: query
Description: Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type: string
pageToken
Location: query
Type: string
Description: A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.
advertiserId
Type: string
Location: query
Format: int64
Description: The ID of the advertiser that has access to the fetched first and third party audiences.
pageSize
Format: int32
Type: integer
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location: query
orderBy
Location: query
Description: Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
Type: string
partnerId
Format: int64
Description: The ID of the partner that has access to the fetched first and third party audiences.
Location: query
Type: string
Path: v3/firstAndThirdPartyAudiences
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/firstAndThirdPartyAudiences
Description: Lists first and third party audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.firstAndThirdPartyAudiences.get
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}
Parameters:
firstAndThirdPartyAudienceId
Description: Required. The ID of the first and third party audience to fetch.
Pattern: ^[^/]+$
Location: path
Format: int64
Type: string
Required: Yes
partnerId
Format: int64
Description: The ID of the partner that has access to the fetched first and third party audience.
Location: query
Type: string
advertiserId
Description: The ID of the advertiser that has access to the fetched first and third party audience.
Format: int64
Location: query
Type: string
Description: Gets a first and third party audience.
Parameter Order: firstAndThirdPartyAudienceId
HTTP Method: GET
Flat Path: v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}
▼ ▲ displayvideo.combinedAudiences.list
HTTP Method: GET
Flat Path: v3/combinedAudiences
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 `ListCombinedAudiences` method. If not specified, the first page of results will be returned.
Location: query
Type: string
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
partnerId
Description: The ID of the partner that has access to the fetched combined audiences.
Format: int64
Type: string
Location: query
pageSize
Type: integer
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
advertiserId
Format: int64
Description: The ID of the advertiser that has access to the fetched combined audiences.
Type: string
Location: query
filter
Type: string
Description: Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Location: query
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/combinedAudiences
Description: Lists combined audiences. The order is defined by the order_by parameter.
▼ ▲ displayvideo.combinedAudiences.get
Path: v3/combinedAudiences/{+combinedAudienceId}
Flat Path: v3/combinedAudiences/{combinedAudiencesId}
Parameters:
partnerId
Description: The ID of the partner that has access to the fetched combined audience.
Type: string
Format: int64
Location: query
combinedAudienceId
Required: Yes
Description: Required. The ID of the combined audience to fetch.
Location: path
Pattern: ^[^/]+$
Format: int64
Type: string
advertiserId
Format: int64
Location: query
Type: string
Description: The ID of the advertiser that has access to the fetched combined audience.
HTTP Method: GET
Parameter Order: combinedAudienceId
Description: Gets a combined audience.
▼ ▲ displayvideo.inventorySourceGroups.patch
Description: Updates an inventory source group. Returns the updated inventory source group if successful.
Path: v3/inventorySourceGroups/{inventorySourceGroupId}
Flat Path: v3/inventorySourceGroups/{inventorySourceGroupId}
Parameters:
partnerId
Description: The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Location: query
Format: int64
Type: string
inventorySourceGroupId
Format: int64
Required: Yes
Location: path
Type: string
Description: Output only. The unique ID of the inventory source group. Assigned by the system.
advertiserId
Location: query
Format: int64
Description: The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
Type: string
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: Required. The mask to control which fields to update.
HTTP Method: PATCH
Parameter Order: inventorySourceGroupId
▼ ▲ displayvideo.inventorySourceGroups.list
Parameters:
pageSize
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Location: query
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 `ListInventorySources` method. If not specified, the first page of results will be returned.
Type: string
advertiserId
Format: int64
Description: The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Location: query
Type: string
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
filter
Type: string
Location: query
Description: Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
partnerId
Description: The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.
Location: query
Format: int64
Type: string
Description: Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
Path: v3/inventorySourceGroups
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Flat Path: v3/inventorySourceGroups
▼ ▲ displayvideo.inventorySourceGroups.get
Parameters:
advertiserId
Description: The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.
Location: query
Type: string
Format: int64
inventorySourceGroupId
Type: string
Required: Yes
Description: Required. The ID of the inventory source group to fetch.
Location: path
Pattern: ^[^/]+$
Format: int64
partnerId
Type: string
Format: int64
Description: The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group.
Location: query
Description: Gets an inventory source group.
Parameter Order: inventorySourceGroupId
HTTP Method: GET
Flat Path: v3/inventorySourceGroups/{inventorySourceGroupsId}
Path: v3/inventorySourceGroups/{+inventorySourceGroupId}
▼ ▲ displayvideo.inventorySourceGroups.create
Description: Creates a new inventory source group. Returns the newly created inventory source group if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: POST
Flat Path: v3/inventorySourceGroups
Path: v3/inventorySourceGroups
Parameters:
partnerId
Location: query
Type: string
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
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.
Location: query
Format: int64
▼ ▲ displayvideo.inventorySourceGroups.delete
Description: Deletes an inventory source group.
Parameters:
partnerId
Location: query
Type: string
Description: The ID of the partner that owns the inventory source group. Only this partner has write access to this group.
Format: int64
advertiserId
Format: int64
Location: query
Type: string
Description: The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group.
inventorySourceGroupId
Format: int64
Description: Required. The ID of the inventory source group to delete.
Type: string
Required: Yes
Pattern: ^[^/]+$
Location: path
HTTP Method: DELETE
Path: v3/inventorySourceGroups/{+inventorySourceGroupId}
Parameter Order: inventorySourceGroupId
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/inventorySourceGroups/{inventorySourceGroupsId}
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.list
Flat Path: v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Path: v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
Parameter Order: inventorySourceGroupId
Description: Lists inventory sources assigned to an inventory source group.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Parameters:
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.
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
Type: string
Location: query
Format: int64
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.
pageSize
Description: Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Format: int32
Type: integer
Location: query
inventorySourceGroupId
Type: string
Description: Required. The ID of the inventory source group to which these assignments are assigned.
Pattern: ^[^/]+$
Location: path
Required: Yes
Format: int64
orderBy
Type: string
Description: Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedInventorySourceId desc`.
Location: query
advertiserId
Location: query
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
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.create
Scopes: https://www.googleapis.com/auth/display-video
Description: Creates an assignment between an inventory source and an inventory source group.
Path: v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources
HTTP Method: POST
Flat Path: v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources
Parameter Order: inventorySourceGroupId
Parameters:
advertiserId
Type: string
Format: int64
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.
Location: query
partnerId
Location: query
Type: string
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
inventorySourceGroupId
Required: Yes
Pattern: ^[^/]+$
Format: int64
Type: string
Description: Required. The ID of the inventory source group to which the assignment will be assigned.
Location: path
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.delete
Flat Path: v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources/{assignedInventorySourcesId}
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: DELETE
Path: v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}
Parameters:
advertiserId
Format: int64
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.
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.
Format: int64
Type: string
assignedInventorySourceId
Required: Yes
Location: path
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the assigned inventory source to delete.
Type: string
inventorySourceGroupId
Location: path
Required: Yes
Format: int64
Description: Required. The ID of the inventory source group to which this assignment is assigned.
Type: string
Pattern: ^[^/]+$
Description: Deletes the assignment between an inventory source and an inventory source group.
▼ ▲ displayvideo.inventorySourceGroups.assignedInventorySources.bulkEdit
Path: v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit
Parameter Order: inventorySourceGroupId
Parameters:
inventorySourceGroupId
Location: path
Type: string
Pattern: ^[^/]+$
Description: Required. The ID of the inventory source group to which the assignments are assigned.
Required: Yes
Format: int64
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/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.
HTTP Method: POST
▼ ▲ displayvideo.customLists.list
Flat Path: v3/customLists
Parameters:
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`.
Location: query
Type: string
filter
Description: Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Type: string
Location: query
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.
Location: query
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.
Location: query
Format: int32
Type: integer
advertiserId
Location: query
Type: string
Description: The ID of the DV360 advertiser that has access to the fetched custom lists.
Format: int64
Description: Lists custom lists. The order is defined by the order_by parameter.
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/customLists
HTTP Method: GET
▼ ▲ displayvideo.customLists.get
Parameters:
advertiserId
Type: string
Location: query
Format: int64
Description: The ID of the DV360 advertiser that has access to the fetched custom lists.
customListId
Location: path
Required: Yes
Format: int64
Pattern: ^[^/]+$
Type: string
Description: Required. The ID of the custom list to fetch.
Path: v3/customLists/{+customListId}
HTTP Method: GET
Flat Path: v3/customLists/{customListsId}
Description: Gets a custom list.
Parameter Order: customListId
▼ ▲ displayvideo.customBiddingAlgorithms.rules.create
Parameter Order: customBiddingAlgorithmId
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Description: Creates a new rules resource. Returns the newly created rules resource if successful.
HTTP Method: POST
Parameters:
advertiserId
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
Location: query
Type: string
Format: int64
partnerId
Type: string
Format: int64
Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.
Location: query
customBiddingAlgorithmId
Format: int64
Type: string
Description: Required. The ID of the custom bidding algorithm that owns the rules resource.
Pattern: ^[^/]+$
Required: Yes
Location: path
▼ ▲ displayvideo.customBiddingAlgorithms.rules.list
Parameter Order: customBiddingAlgorithmId
HTTP Method: GET
Parameters:
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
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
customBiddingAlgorithmId
Location: path
Type: string
Format: int64
Required: Yes
Description: Required. The ID of the custom bidding algorithm that owns the rules resource.
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 `ListCustomBiddingAlgorithmRules` 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 parent custom bidding algorithm.
Format: int64
Type: string
advertiserId
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
Format: int64
Type: string
Location: query
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules
Path: v3/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.get
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}
Description: Retrieves a rules resource.
Parameter Order:
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Parameters:
partnerId
Format: int64
Description: The ID of the partner that owns the parent custom bidding algorithm.
Location: query
Type: string
customBiddingAlgorithmId
Required: Yes
Type: string
Format: int64
Description: Required. The ID of the custom bidding algorithm that owns the rules resource.
Location: path
Pattern: ^[^/]+$
advertiserId
Format: int64
Location: query
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
Type: string
customBiddingAlgorithmRulesId
Description: Required. The ID of the rules resource to fetch.
Location: path
Format: int64
Type: string
Pattern: ^[^/]+$
Required: Yes
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.get
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts/{scriptsId}
HTTP Method: GET
Parameter Order:
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}
Parameters:
advertiserId
Type: string
Location: query
Format: int64
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
customBiddingAlgorithmId
Pattern: ^[^/]+$
Format: int64
Required: Yes
Location: path
Type: string
Description: Required. The ID of the custom bidding algorithm owns the script.
customBiddingScriptId
Required: Yes
Type: string
Pattern: ^[^/]+$
Description: Required. The ID of the custom bidding script to fetch.
Location: path
Format: int64
partnerId
Format: int64
Type: string
Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Location: query
Description: Gets a custom bidding script.
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.create
Parameter Order: customBiddingAlgorithmId
Description: Creates a new custom bidding script. Returns the newly created script if successful.
Parameters:
customBiddingAlgorithmId
Type: string
Location: path
Pattern: ^[^/]+$
Format: int64
Required: Yes
Description: Required. The ID of the custom bidding algorithm that owns the script.
partnerId
Format: int64
Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Location: query
Type: string
advertiserId
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
Format: int64
Location: query
Type: string
HTTP Method: POST
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
▼ ▲ displayvideo.customBiddingAlgorithms.scripts.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/display-video
Description: Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
Parameters:
orderBy
Type: string
Description: Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: `createTime`.
Location: query
partnerId
Type: string
Format: int64
Description: The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.
Location: query
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 `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.
Location: query
advertiserId
Format: int64
Location: query
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
Type: string
customBiddingAlgorithmId
Required: Yes
Type: string
Description: Required. The ID of the custom bidding algorithm owns the script.
Format: int64
Location: path
Pattern: ^[^/]+$
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts
Parameter Order: customBiddingAlgorithmId
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts
▼ ▲ displayvideo.customBiddingAlgorithms.uploadRules
HTTP Method: GET
Description: Creates a rules reference object. The resulting reference object provides a resource path where the rules file should be uploaded. This reference object should be included when creating a new rules resource.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: customBiddingAlgorithmId
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules
Parameters:
advertiserId
Format: int64
Location: query
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
Type: string
partnerId
Description: The ID of the partner that owns the parent custom bidding algorithm.
Type: string
Location: query
Format: int64
customBiddingAlgorithmId
Description: Required. The ID of the custom bidding algorithm that owns the rules resource.
Type: string
Required: Yes
Location: path
Pattern: ^[^/]+$
Format: int64
▼ ▲ displayvideo.customBiddingAlgorithms.create
Path: v3/customBiddingAlgorithms
Description: Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: POST
Flat Path: v3/customBiddingAlgorithms
▼ ▲ displayvideo.customBiddingAlgorithms.list
Flat Path: v3/customBiddingAlgorithms
Scopes: https://www.googleapis.com/auth/display-video
HTTP Method: GET
Path: v3/customBiddingAlgorithms
Description: Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.
Parameters:
partnerId
Format: int64
Description: The ID of the DV360 partner that has access to the custom bidding algorithm.
Type: string
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
orderBy
Location: query
Type: string
Description: Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
pageSize
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Location: query
Type: integer
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 `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
Type: string
Location: query
advertiserId
Type: string
Format: int64
Location: query
Description: The ID of the DV360 advertiser that has access to the custom bidding algorithm.
▼ ▲ displayvideo.customBiddingAlgorithms.patch
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}
HTTP Method: PATCH
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Parameters:
customBiddingAlgorithmId
Required: Yes
Location: path
Format: int64
Pattern: ^[^/]+$
Type: string
Description: Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
updateMask
Format: google-fieldmask
Description: Required. The mask to control which fields to update.
Location: query
Type: string
Description: Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: customBiddingAlgorithmId
▼ ▲ displayvideo.customBiddingAlgorithms.get
Scopes: https://www.googleapis.com/auth/display-video
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}
Description: Gets a custom bidding algorithm.
Parameters:
advertiserId
Location: query
Type: string
Description: The ID of the DV360 partner that has access to the custom bidding algorithm.
Format: int64
partnerId
Location: query
Description: The ID of the DV360 partner that has access to the custom bidding algorithm.
Type: string
Format: int64
customBiddingAlgorithmId
Location: path
Type: string
Required: Yes
Format: int64
Pattern: ^[^/]+$
Description: Required. The ID of the custom bidding algorithm to fetch.
Parameter Order: customBiddingAlgorithmId
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}
HTTP Method: GET
▼ ▲ displayvideo.customBiddingAlgorithms.uploadScript
Path: v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript
Scopes: https://www.googleapis.com/auth/display-video
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.
Flat Path: v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadScript
Parameter Order: customBiddingAlgorithmId
Parameters:
customBiddingAlgorithmId
Format: int64
Description: Required. The ID of the custom bidding algorithm owns the script.
Pattern: ^[^/]+$
Type: string
Location: path
Required: Yes
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
Location: query
Format: int64
advertiserId
Type: string
Format: int64
Location: query
Description: The ID of the advertiser that owns the parent custom bidding algorithm.
HTTP Method: GET
▼ ▲ displayvideo.guaranteedOrders.create
Parameters:
advertiserId
Format: int64
Description: The ID of the advertiser that the request is being made within.
Location: query
Type: string
partnerId
Format: int64
Description: The ID of the partner that the request is being made within.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/guaranteedOrders
Flat Path: v3/guaranteedOrders
Description: Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
HTTP Method: POST
▼ ▲ displayvideo.guaranteedOrders.patch
Flat Path: v3/guaranteedOrders/{guaranteedOrdersId}
Description: Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Path: v3/guaranteedOrders/{+guaranteedOrderId}
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: guaranteedOrderId
Parameters:
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. The mask to control which fields to update.
advertiserId
Type: string
Description: The ID of the advertiser that the request is being made within.
Format: int64
Location: query
partnerId
Format: int64
Location: query
Type: string
Description: The ID of the partner that the request is being made within.
guaranteedOrderId
Pattern: ^[^/]+$
Type: string
Required: Yes
Location: path
Description: Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.
▼ ▲ displayvideo.guaranteedOrders.list
Parameters:
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
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 `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.
Location: query
orderBy
Location: query
Description: Field by which to sort the list. Acceptable values are: * `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
advertiserId
Location: query
Description: The ID of the advertiser that has access to the guaranteed order.
Type: string
Format: int64
partnerId
Type: string
Format: int64
Location: query
Description: The ID of the partner that has access to the guaranteed order.
pageSize
Format: int32
Description: Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
Type: integer
Location: query
Scopes: https://www.googleapis.com/auth/display-video
Path: v3/guaranteedOrders
Description: Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Flat Path: v3/guaranteedOrders
HTTP Method: GET
▼ ▲ displayvideo.guaranteedOrders.editGuaranteedOrderReadAccessors
Flat Path: v3/guaranteedOrders/{guaranteedOrdersId}:editGuaranteedOrderReadAccessors
Path: v3/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors
HTTP Method: POST
Description: Edits read advertisers of a guaranteed order.
Parameters:
guaranteedOrderId
Pattern: ^[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
Parameter Order: guaranteedOrderId
▼ ▲ displayvideo.guaranteedOrders.get
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: guaranteedOrderId
Path: v3/guaranteedOrders/{+guaranteedOrderId}
Parameters:
guaranteedOrderId
Required: Yes
Location: path
Pattern: ^[^/]+$
Type: string
Description: Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacy_guaranteed_order_id}`
partnerId
Description: The ID of the partner that has access to the guaranteed order.
Location: query
Type: string
Format: int64
advertiserId
Type: string
Format: int64
Location: query
Description: The ID of the advertiser that has access to the guaranteed order.
Flat Path: v3/guaranteedOrders/{guaranteedOrdersId}
Description: Gets a guaranteed order.
HTTP Method: GET
▼ ▲ displayvideo.floodlightGroups.patch
HTTP Method: PATCH
Description: Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
Scopes: https://www.googleapis.com/auth/display-video
Parameter Order: floodlightGroupId
Path: v3/floodlightGroups/{floodlightGroupId}
Parameters:
updateMask
Format: google-fieldmask
Type: string
Description: Required. The mask to control which fields to update.
Location: query
partnerId
Description: Required. The partner context by which the Floodlight group is being accessed.
Location: query
Type: string
Format: int64
floodlightGroupId
Format: int64
Description: Output only. The unique ID of the Floodlight group. Assigned by the system.
Type: string
Required: Yes
Location: path
Flat Path: v3/floodlightGroups/{floodlightGroupId}
▼ ▲ displayvideo.floodlightGroups.get
HTTP Method: GET
Description: Gets a Floodlight group.
Parameters:
partnerId
Type: string
Format: int64
Location: query
Description: Required. The partner context by which the Floodlight group is being accessed.
floodlightGroupId
Location: path
Required: Yes
Type: string
Format: int64
Description: Required. The ID of the Floodlight group to fetch.
Pattern: ^[^/]+$
Parameter Order: floodlightGroupId
Path: v3/floodlightGroups/{+floodlightGroupId}
Flat Path: v3/floodlightGroups/{floodlightGroupsId}