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