DisplayVideo
import { DisplayVideo } from "https://googleapis.deno.dev/v1/displayvideo:v4.ts";
Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.
§Methods
Lists ad group ads.
Required. The ID of the advertiser the ad groups belongs to.
Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
Required. The ID of the advertiser the line items belongs to.
Lists ad groups.
Required. The ID of the advertiser the ad groups belongs to.
Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.
Required. The ID of the ad group the assigned targeting option belongs to.
Required. The ID of the advertiser the ad group belongs to.
Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
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
Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.
Required. The ID of the ad group to list assigned targeting options for.
Required. The ID of the advertiser the ad group belongs to.
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
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. Examples using provided client libraries can be found in our Creating Creatives guide.
Required. The ID of the advertiser this asset belongs to.
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.
Required. The ID of the advertiser to audit.
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
to avoid errors.
The ID of the advertiser this campaign belongs to.
The ID of the campaign we need to delete.
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.
The ID of the advertiser to list campaigns for.
Updates an existing campaign. Returns the updated campaign if successful.
Output only. The unique ID of the advertiser the campaign belongs to.
Output only. The unique ID of the campaign. Assigned by the system.
Creates a new channel. Returns the newly created channel if successful.
The ID of the advertiser that owns the created channel.
Gets a channel for a partner or advertiser.
The ID of the advertiser that owns the fetched channel.
Required. The ID of the channel to fetch.
Lists channels for a partner or advertiser.
The ID of the advertiser that owns the channels.
Updates a channel. Returns the updated channel if successful.
The ID of the advertiser that owns the created channel.
Output only. The unique ID of the channel. Assigned by the system.
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.
The ID of the advertiser that owns the parent channel.
Required. The ID of the parent channel to which the sites belong.
Creates a site in a channel.
The ID of the advertiser that owns the parent channel.
Required. The ID of the parent channel in which the site will be created.
Deletes a site from a channel.
The ID of the advertiser that owns the parent channel.
Required. The ID of the parent channel to which the site belongs.
Required. The URL or app ID of the site to delete.
Lists sites in a channel.
The ID of the advertiser that owns the parent channel.
Required. The ID of the parent channel to which the requested sites belong.
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 to avoid errors.
The ID of the advertiser that owns the parent channel.
Required. The ID of the parent channel whose sites will be replaced.
Creates a new advertiser. Returns the newly created advertiser if successful. This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.
Creates a new creative. Returns the newly created creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.
Output only. The unique ID of the advertiser the creative belongs to.
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 or greater for the
parent advertiser or partner is required to make this request.
The ID of the advertiser this creative belongs to.
The ID of the creative to be deleted.
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.
Required. The ID of the advertiser to list creatives for.
Updates an existing creative. Returns the updated creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.
Output only. The unique ID of the advertiser the creative belongs to.
Output only. The unique ID of the creative. Assigned by the system.
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.
The ID of the advertiser we need to delete.
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 .
Required. The ID of the advertiser.
Gets an advertiser.
Required. The ID of the advertiser to fetch.
Creates a new insertion order. Returns the newly created insertion order if successful.
Output only. The unique ID of the advertiser the insertion order belongs to.
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.
The ID of the advertiser this insertion order belongs to.
The ID of the insertion order to delete.
Gets an insertion order. Returns error code NOT_FOUND
if the insertion
order does not exist.
Required. The ID of the advertiser this insertion order belongs to.
Required. The ID of the insertion order to fetch.
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.
Required. The ID of the advertiser to list insertion orders for.
Updates an existing insertion order. Returns the updated insertion order if successful.
Output only. The unique ID of the advertiser the insertion order belongs to.
Output only. The unique ID of the insertion order. Assigned by the system.
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.
Required. The ID of the advertiser to list invoices for.
Retrieves the invoice currency used by an advertiser in a given month.
Required. The ID of the advertiser to lookup currency for.
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.
Required. The ID of the advertiser the line items belong to.
Lists assigned targeting options for multiple line items across targeting types.
Required. The ID of the advertiser the line items belongs to.
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.
Required. The ID of the advertiser this line item belongs to.
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.
Output only. The unique ID of the advertiser the line item belongs to.
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.
The ID of the advertiser this line item belongs to.
The ID of the line item to delete.
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 to avoid errors.
Required. The ID of the advertiser this line item belongs to.
Required. The ID of the line item to duplicate.
Creates a new line item with settings (including targeting) inherited from
the insertion order and an ENTITY_STATUS_DRAFT
entity_status. Returns the
newly created line item if successful. There are default values based on
the three fields: * The insertion order's insertion_order_type * The
insertion order's automation_type * The given line_item_type YouTube &
Partners line items cannot be created or updated using the API.
Required. The ID of the advertiser this line item belongs to.
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.
Required. The ID of the advertiser to list line items for.
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 to avoid errors.
Output only. The unique ID of the advertiser the line item belongs to.
Output only. The unique ID of the line item. Assigned by the system.
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.
Required. The ID of the advertiser the line item belongs to.
Required. The ID of the line item the assigned targeting option will belong to.
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
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.
Required. The ID of the advertiser the line item belongs to.
Required. The ID of the assigned targeting option to delete.
Required. The ID of the line item the assigned targeting option belongs to.
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
Gets a single targeting option assigned to a line item.
Required. The ID of the advertiser the line item belongs to.
Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.
Required. The ID of the line item the assigned targeting option belongs to.
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)
Lists the targeting options assigned to a line item.
Required. The ID of the advertiser the line item belongs to.
Required. The ID of the line item to list assigned targeting options for.
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)
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.
Lists assigned targeting options of an advertiser across targeting types.
Required. The ID of the advertiser the line item belongs to.
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.
Required. The ID of the DV360 advertiser to which the location list belongs.
Required. The ID of the location list to which these assignments are assigned.
Creates an assignment between a location and a location list.
Required. The ID of the DV360 advertiser to which the location list belongs.
Required. The ID of the location list for which the assignment will be created.
Deletes the assignment between a location and a location list.
Required. The ID of the DV360 advertiser to which the location list belongs.
Required. The ID of the assigned location to delete.
Required. The ID of the location list to which this assignment is assigned.
Lists locations assigned to a location list.
Required. The ID of the DV360 advertiser to which the location list belongs.
Required. The ID of the location list to which these assignments are assigned.
Creates a new location list. Returns the newly created location list if successful.
Required. The ID of the DV360 advertiser to which the location list belongs.
Gets a location list.
Required. The ID of the DV360 advertiser to which the fetched location list belongs.
Required. The ID of the location list to fetch.
Lists location lists based on a given advertiser id.
Required. The ID of the DV360 advertiser to which the fetched location lists belong.
Updates a location list. Returns the updated location list if successful.
Required. The ID of the DV360 advertiser to which the location lists belongs.
Output only. The unique ID of the location list. Assigned by the system.
Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
Required. The ID of the DV360 advertiser to which the negative keyword list will belong.
Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Required. The ID of the negative keyword list to delete.
Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs.
Required. The ID of the negative keyword list to fetch.
Lists negative keyword lists based on a given advertiser id.
Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.
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.
Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required. The ID of the parent negative keyword list to which the negative keywords belong.
Creates a negative keyword in a negative keyword list.
Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required. The ID of the parent negative keyword list in which the negative keyword will be created.
Deletes a negative keyword from a negative keyword list.
Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required. The keyword value of the negative keyword to delete.
Required. The ID of the parent negative keyword list to which the negative keyword belongs.
Lists negative keywords in a negative keyword list.
Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required. The ID of the parent negative keyword list to which the requested negative keywords belong.
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.
Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.
Required. The ID of the parent negative keyword list to which the negative keywords belong.
Updates a negative keyword list. Returns the updated negative keyword list if successful.
Required. The ID of the DV360 advertiser to which the negative keyword list belongs.
Output only. The unique ID of the negative keyword list. Assigned by the system.
Updates an existing advertiser. Returns the updated advertiser if successful.
Output only. The unique ID of the advertiser. Assigned by the system.
Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
Required. The ID of the advertiser.
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
Deletes an assigned targeting option from an advertiser.
Required. The ID of the advertiser.
Required. The ID of the assigned targeting option to delete.
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
Gets a single targeting option assigned to an advertiser.
Required. The ID of the advertiser.
Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested.
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
Lists the targeting options assigned to an advertiser.
Required. The ID of the advertiser.
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
Gets a combined audience.
Required. The ID of the combined audience to fetch.
Lists combined audiences. The order is defined by the order_by parameter.
Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
Gets a custom bidding algorithm.
Required. The ID of the custom bidding algorithm to fetch.
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.
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Warning: Starting April 1, 2025, requests updating custom bidding algorithms that are assigned to line items will return an error. Read more about this announced change.
Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
Creates a new rules resource. Returns the newly created rules resource if successful. Warning: Starting April 1, 2025, requests updating custom bidding algorithms that are assigned to line items will return an error. Read more about this announced change.
Required. The ID of the custom bidding algorithm that owns the rules resource.
Retrieves a rules resource.
Required. The ID of the custom bidding algorithm that owns the rules resource.
Required. The ID of the rules resource to fetch.
Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.
Required. The ID of the custom bidding algorithm that owns the rules resource.
Creates a new custom bidding script. Returns the newly created script if successful. Warning: Starting April 1, 2025, requests updating custom bidding algorithms that are assigned to line items will return an error. Read more about this announced change.
Required. The ID of the custom bidding algorithm that owns the script.
Gets a custom bidding script.
Required. The ID of the custom bidding algorithm owns the script.
Required. The ID of the custom bidding script to fetch.
Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter.
Required. The ID of the custom bidding algorithm owns the script.
Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.
Required. The ID of the custom bidding algorithm that owns the rules resource.
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.
Required. The ID of the custom bidding algorithm owns the script.
Lists custom lists. The order is defined by the order_by parameter.
Creates a FirstPartyAndPartnerAudience. Only supported for the following
audience_type: * CUSTOMER_MATCH_CONTACT_INFO
* CUSTOMER_MATCH_DEVICE_ID
Updates the member list of a Customer Match audience. Only supported for
the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO
*
CUSTOMER_MATCH_DEVICE_ID
Required. The ID of the Customer Match FirstPartyAndPartnerAudience whose members will be edited.
Gets a first party or partner audience.
Required. The ID of the first party and partner audience to fetch.
Lists first party and partner audiences. The order is defined by the order_by parameter.
Updates an existing FirstPartyAndPartnerAudience. Only supported for the
following audience_type: * CUSTOMER_MATCH_CONTACT_INFO
*
CUSTOMER_MATCH_DEVICE_ID
Identifier. The unique ID of the first party and partner audience. Assigned by the system.
Gets a Floodlight activity.
Required. The ID of the Floodlight activity to fetch.
Required. The ID of the parent Floodlight group to which the requested Floodlight activity belongs.
Lists Floodlight activities in a Floodlight group.
Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.
Gets a Floodlight group.
Required. The ID of the Floodlight group to fetch.
Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
Output only. The unique ID of the Floodlight group. Assigned by the system.
Gets a Google audience.
Required. The ID of the Google audience to fetch.
Lists Google audiences. The order is defined by the order_by parameter.
Creates a new guaranteed order. Returns the newly created guaranteed order if successful.
Edits read advertisers of a guaranteed order.
Required. The ID of the guaranteed order to edit. The ID is of the format {exchange}-{legacy_guaranteed_order_id}
Gets a guaranteed order.
Required. The ID of the guaranteed order to fetch. The ID is of the format {exchange}-{legacy_guaranteed_order_id}
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.
Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacy_guaranteed_order_id}
.
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.
Required. The ID of the inventory source group to which the assignments are assigned.
Creates an assignment between an inventory source and an inventory source group.
Required. The ID of the inventory source group to which the assignment will be assigned.
Deletes the assignment between an inventory source and an inventory source group.
Required. The ID of the assigned inventory source to delete.
Required. The ID of the inventory source group to which this assignment is assigned.
Lists inventory sources assigned to an inventory source group.
Required. The ID of the inventory source group to which these assignments are assigned.
Creates a new inventory source group. Returns the newly created inventory source group if successful.
Deletes an inventory source group.
Required. The ID of the inventory source group to delete.
Gets an inventory source group.
Required. The ID of the inventory source group to fetch.
Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter.
Updates an inventory source group. Returns the updated inventory source group if successful.
Output only. The unique ID of the inventory source group. Assigned by the system.
Creates a new inventory source. Returns the newly created inventory source if successful.
Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Required. The ID of inventory source to update.
Gets an inventory source.
Required. The ID of the inventory source to fetch.
Lists inventory sources that are accessible to the current user. The order
is defined by the order_by parameter. If a filter by entity_status is not
specified, inventory sources with entity status ENTITY_STATUS_ARCHIVED
will not be included in the results.
Updates an existing inventory source. Returns the updated inventory source if successful.
Output only. The unique ID of the inventory source. Assigned by the system.
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.
Name of the media that is being downloaded. See ReadRequest.resource_name.
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.
Name of the media that is being downloaded. See ReadRequest.resource_name.
Creates a new channel. Returns the newly created channel if successful.
The ID of the partner that owns the created channel.
Gets a channel for a partner or advertiser.
Required. The ID of the channel to fetch.
The ID of the partner that owns the fetched channel.
Lists channels for a partner or advertiser.
The ID of the partner that owns the channels.
Updates a channel. Returns the updated channel if successful.
Output only. The unique ID of the channel. Assigned by the system.
The ID of the partner that owns the created channel.
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.
Required. The ID of the parent channel to which the sites belong.
The ID of the partner that owns the parent channel.
Creates a site in a channel.
Required. The ID of the parent channel in which the site will be created.
The ID of the partner that owns the parent channel.
Deletes a site from a channel.
Required. The ID of the parent channel to which the site belongs.
The ID of the partner that owns the parent channel.
Required. The URL or app ID of the site to delete.
Lists sites in a channel.
Required. The ID of the parent channel to which the requested sites belong.
The ID of the partner that owns the parent channel.
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 to avoid errors.
Required. The ID of the parent channel whose sites will be replaced.
The ID of the partner that owns the parent channel.
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 .
Required. The ID of the partner.
Lists partners that are accessible to the current user. The order is defined by the order_by parameter.
Assigns a targeting option to a partner. Returns the assigned targeting option if successful.
Required. The ID of the partner.
Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL
Deletes an assigned targeting option from a partner.
Required. The ID of the assigned targeting option to delete.
Required. The ID of the partner.
Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL
Gets a single targeting option assigned to a partner.
Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.
Required. The ID of the partner.
Required. Identifies the type of this assigned targeting option. Supported targeting types: * TARGETING_TYPE_CHANNEL
Lists the targeting options assigned to a partner.
Required. The ID of the partner.
Required. Identifies the type of assigned targeting options to list. Supported targeting types: * TARGETING_TYPE_CHANNEL
Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.
Gets a single targeting option.
Required. The ID of the of targeting option to retrieve.
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
Lists targeting options of a given type.
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
Searches for targeting options of a given type based on the given search terms.
Required. The type of targeting options to retrieve. Accepted values are: * TARGETING_TYPE_GEO_REGION
* TARGETING_TYPE_POI
* TARGETING_TYPE_BUSINESS_CHAIN
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 before using this method. The "Try this method" feature does not work for this method.
Required. The ID of the user to which the assigned user roles belong.
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 before using this method. The "Try this method" feature does not work for this method.
Deletes a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.
Required. The ID of the user to delete.
Gets a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.
Required. The ID of the user to fetch.
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 before using this method. The "Try this method" feature does not work for this method.
Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.
Output only. The unique ID of the user. Assigned by the system.