[−][src]Crate google_displayvideo1

This documentation was generated from Display Video crate version 1.0.14+20200707, where 20200707 is the exact revision of the displayvideo:v1 schema built by the mako code generator v1.0.14.

Everything else about the Display Video v1 API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

advertisers
assets upload, bulk edit advertiser assigned targeting options, bulk list advertiser assigned targeting options, campaigns create, campaigns delete, campaigns get, campaigns list, campaigns patch, channels create, channels get, channels list, channels patch, channels sites bulk edit, channels sites create, channels sites delete, channels sites list, create, creatives create, creatives delete, creatives get, creatives list, creatives patch, delete, get, insertion orders create, insertion orders delete, insertion orders get, insertion orders list, insertion orders patch, line items bulk edit line item assigned targeting options, line items bulk list line item assigned targeting options, line items create, line items delete, line items get, line items list, line items patch, line items targeting types assigned targeting options create, line items targeting types assigned targeting options delete, line items targeting types assigned targeting options get, line items targeting types assigned targeting options list, list, location lists assigned locations bulk edit, location lists assigned locations create, location lists assigned locations delete, location lists assigned locations list, location lists create, location lists get, location lists list, location lists patch, negative keyword lists create, negative keyword lists delete, negative keyword lists get, negative keyword lists list, negative keyword lists negative keywords bulk edit, negative keyword lists negative keywords create, negative keyword lists negative keywords delete, negative keyword lists negative keywords list, negative keyword lists patch, patch, targeting types assigned targeting options create, targeting types assigned targeting options delete, targeting types assigned targeting options get and targeting types assigned targeting options list
combined audiences
get and list
custom lists
get and list
first and third party audiences
get and list
floodlight groups
get and patch
google audiences
get and list
inventory source groups
assigned inventory sources bulk edit, assigned inventory sources create, assigned inventory sources delete, assigned inventory sources list, create, delete, get, list and patch
inventory sources
get and list
media
download
partners
channels create, channels get, channels list, channels patch, channels sites bulk edit, channels sites create, channels sites delete and channels sites list
sdfdownloadtasks
create and operations get
targeting types
targeting options get and targeting options list

Upload supported by ...

assets upload advertisers

Download supported by ...

download media

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
  - a collection of properties
  - never directly used in Activities
Activities
- operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit()

Or specifically ...

let r = hub.advertisers().channels_patch(...).doit()
let r = hub.advertisers().campaigns_patch(...).doit()
let r = hub.advertisers().negative_keyword_lists_negative_keywords_list(...).doit()
let r = hub.advertisers().assets_upload(...).doit()
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_create(...).doit()
let r = hub.advertisers().insertion_orders_create(...).doit()
let r = hub.advertisers().delete(...).doit()
let r = hub.advertisers().campaigns_create(...).doit()
let r = hub.advertisers().channels_get(...).doit()
let r = hub.advertisers().location_lists_assigned_locations_list(...).doit()
let r = hub.advertisers().negative_keyword_lists_delete(...).doit()
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_delete(...).doit()
let r = hub.advertisers().negative_keyword_lists_get(...).doit()
let r = hub.advertisers().bulk_edit_advertiser_assigned_targeting_options(...).doit()
let r = hub.advertisers().line_items_get(...).doit()
let r = hub.advertisers().line_items_list(...).doit()
let r = hub.advertisers().line_items_patch(...).doit()
let r = hub.advertisers().creatives_delete(...).doit()
let r = hub.advertisers().create(...).doit()
let r = hub.advertisers().channels_sites_create(...).doit()
let r = hub.advertisers().location_lists_list(...).doit()
let r = hub.advertisers().campaigns_list(...).doit()
let r = hub.advertisers().get(...).doit()
let r = hub.advertisers().channels_sites_delete(...).doit()
let r = hub.advertisers().targeting_types_assigned_targeting_options_create(...).doit()
let r = hub.advertisers().negative_keyword_lists_create(...).doit()
let r = hub.advertisers().negative_keyword_lists_patch(...).doit()
let r = hub.advertisers().line_items_bulk_list_line_item_assigned_targeting_options(...).doit()
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_list(...).doit()
let r = hub.advertisers().channels_sites_list(...).doit()
let r = hub.advertisers().creatives_patch(...).doit()
let r = hub.advertisers().negative_keyword_lists_negative_keywords_create(...).doit()
let r = hub.advertisers().bulk_list_advertiser_assigned_targeting_options(...).doit()
let r = hub.advertisers().location_lists_create(...).doit()
let r = hub.advertisers().channels_list(...).doit()
let r = hub.advertisers().location_lists_assigned_locations_bulk_edit(...).doit()
let r = hub.advertisers().targeting_types_assigned_targeting_options_get(...).doit()
let r = hub.advertisers().list(...).doit()
let r = hub.advertisers().location_lists_get(...).doit()
let r = hub.advertisers().location_lists_assigned_locations_create(...).doit()
let r = hub.advertisers().location_lists_assigned_locations_delete(...).doit()
let r = hub.advertisers().insertion_orders_patch(...).doit()
let r = hub.advertisers().campaigns_delete(...).doit()
let r = hub.advertisers().negative_keyword_lists_negative_keywords_bulk_edit(...).doit()
let r = hub.advertisers().creatives_get(...).doit()
let r = hub.advertisers().insertion_orders_list(...).doit()
let r = hub.advertisers().creatives_create(...).doit()
let r = hub.advertisers().line_items_create(...).doit()
let r = hub.advertisers().creatives_list(...).doit()
let r = hub.advertisers().insertion_orders_get(...).doit()
let r = hub.advertisers().patch(...).doit()
let r = hub.advertisers().line_items_bulk_edit_line_item_assigned_targeting_options(...).doit()
let r = hub.advertisers().channels_sites_bulk_edit(...).doit()
let r = hub.advertisers().campaigns_get(...).doit()
let r = hub.advertisers().targeting_types_assigned_targeting_options_list(...).doit()
let r = hub.advertisers().negative_keyword_lists_list(...).doit()
let r = hub.advertisers().insertion_orders_delete(...).doit()
let r = hub.advertisers().channels_create(...).doit()
let r = hub.advertisers().negative_keyword_lists_negative_keywords_delete(...).doit()
let r = hub.advertisers().line_items_delete(...).doit()
let r = hub.advertisers().line_items_targeting_types_assigned_targeting_options_get(...).doit()
let r = hub.advertisers().targeting_types_assigned_targeting_options_delete(...).doit()
let r = hub.advertisers().location_lists_patch(...).doit()

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-displayvideo1 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_displayvideo1 as displayvideo1;
use displayvideo1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use displayvideo1::DisplayVideo;
 
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = DisplayVideo::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.advertisers().line_items_targeting_types_assigned_targeting_options_list("advertiserId", "lineItemId", "targetingType")
             .page_token("amet.")
             .page_size(-81)
             .order_by("labore")
             .filter("sea")
             .doit();
 
match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

PODs are handed by copy
strings are passed as &str
request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

ActiveViewVideoViewabilityMetricConfig	Configuration for custom Active View video viewability metrics.
Adloox	Details of Adloox settings.
Advertiser	A single advertiser in Display & Video 360 (DV360).
AdvertiserAdServerConfig	Ad server related settings of an advertiser.
AdvertiserAssetUploadCall	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.
AdvertiserBulkEditAdvertiserAssignedTargetingOptionCall	Bulk 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 .
AdvertiserBulkListAdvertiserAssignedTargetingOptionCall	Lists assigned targeting options of an advertiser across targeting types.
AdvertiserCampaignCreateCall	Creates a new campaign. Returns the newly created campaign if successful.
AdvertiserCampaignDeleteCall	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.
AdvertiserCampaignGetCall	Gets a campaign.
AdvertiserCampaignListCall	Lists campaigns in an advertiser.
AdvertiserCampaignPatchCall	Updates an existing campaign. Returns the updated campaign if successful.
AdvertiserChannelCreateCall	Creates a new channel. Returns the newly created channel if successful.
AdvertiserChannelGetCall	Gets a channel for a partner or advertiser.
AdvertiserChannelListCall	Lists channels for a partner or advertiser.
AdvertiserChannelPatchCall	Updates a channel. Returns the updated channel if successful.
AdvertiserChannelSiteBulkEditCall	Bulk edits sites under a single channel.
AdvertiserChannelSiteCreateCall	Creates a site in a channel.
AdvertiserChannelSiteDeleteCall	Deletes a site from a channel.
AdvertiserChannelSiteListCall	Lists sites in a channel.
AdvertiserCreateCall	Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete.
AdvertiserCreativeConfig	Creatives related settings of an advertiser.
AdvertiserCreativeCreateCall	Creates a new creative. Returns the newly created creative if successful.
AdvertiserCreativeDeleteCall	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.
AdvertiserCreativeGetCall	Gets a creative.
AdvertiserCreativeListCall	Lists creatives in an advertiser.
AdvertiserCreativePatchCall	Updates an existing creative. Returns the updated creative if successful.
AdvertiserDataAccessConfig	Settings that control how advertiser related data may be accessed.
AdvertiserDeleteCall	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.
AdvertiserGeneralConfig	General settings of an advertiser.
AdvertiserGetCall	Gets an advertiser.
AdvertiserInsertionOrderCreateCall	Creates a new insertion order. Returns the newly created insertion order if successful.
AdvertiserInsertionOrderDeleteCall	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.
AdvertiserInsertionOrderGetCall	Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.
AdvertiserInsertionOrderListCall	Lists insertion orders in an advertiser.
AdvertiserInsertionOrderPatchCall	Updates an existing insertion order. Returns the updated insertion order if successful.
AdvertiserLineItemBulkEditLineItemAssignedTargetingOptionCall	Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests .
AdvertiserLineItemBulkListLineItemAssignedTargetingOptionCall	Lists assigned targeting options of a line item across targeting types.
AdvertiserLineItemCreateCall	Creates a new line item. Returns the newly created line item if successful.
AdvertiserLineItemDeleteCall	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.
AdvertiserLineItemGetCall	Gets a line item.
AdvertiserLineItemListCall	Lists line items in an advertiser.
AdvertiserLineItemPatchCall	Updates an existing line item. Returns the updated line item if successful.
AdvertiserLineItemTargetingTypeAssignedTargetingOptionCreateCall	Assigns a targeting option to a line item. Returns the assigned targeting option if successful.
AdvertiserLineItemTargetingTypeAssignedTargetingOptionDeleteCall	Deletes an assigned targeting option from a line item.
AdvertiserLineItemTargetingTypeAssignedTargetingOptionGetCall	Gets a single targeting option assigned to a line item.
AdvertiserLineItemTargetingTypeAssignedTargetingOptionListCall	Lists the targeting options assigned to a line item.
AdvertiserListCall	Lists advertisers that are accessible to the current user.
AdvertiserLocationListAssignedLocationBulkEditCall	Bulk edits multiple assignments between locations and a single location list.
AdvertiserLocationListAssignedLocationCreateCall	Creates an assignment between a location and a location list.
AdvertiserLocationListAssignedLocationDeleteCall	Deletes the assignment between a location and a location list.
AdvertiserLocationListAssignedLocationListCall	Lists locations assigned to a location list.
AdvertiserLocationListCreateCall	Creates a new location list. Returns the newly created location list if successful.
AdvertiserLocationListGetCall	Gets a location list.
AdvertiserLocationListListCall	Lists location lists based on a given advertiser id.
AdvertiserLocationListPatchCall	Updates a location list. Returns the updated location list if successful.
AdvertiserMethods	A builder providing access to all methods supported on advertiser resources. It is not used directly, but through the `DisplayVideo` hub.
AdvertiserNegativeKeywordListCreateCall	Creates a new negative keyword list. Returns the newly created negative keyword list if successful.
AdvertiserNegativeKeywordListDeleteCall	Deletes a negative keyword list given an advertiser ID and a negative keyword list ID.
AdvertiserNegativeKeywordListGetCall	Gets a negative keyword list given an advertiser ID and a negative keyword list ID.
AdvertiserNegativeKeywordListListCall	Lists negative keyword lists based on a given advertiser id.
AdvertiserNegativeKeywordListNegativeKeywordBulkEditCall	Bulk edits negative keywords in a single negative keyword list.
AdvertiserNegativeKeywordListNegativeKeywordCreateCall	Creates a negative keyword in a negative keyword list.
AdvertiserNegativeKeywordListNegativeKeywordDeleteCall	Deletes a negative keyword from a negative keyword list.
AdvertiserNegativeKeywordListNegativeKeywordListCall	Lists negative keywords in a negative keyword list.
AdvertiserNegativeKeywordListPatchCall	Updates a negative keyword list. Returns the updated negative keyword list if successful.
AdvertiserPatchCall	Updates an existing advertiser. Returns the updated advertiser if successful.
AdvertiserSdfConfig	Structured Data Files (SDF) settings of an advertiser.
AdvertiserTargetingConfig	Targeting settings related to ad serving of an advertiser.
AdvertiserTargetingTypeAssignedTargetingOptionCreateCall	Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful.
AdvertiserTargetingTypeAssignedTargetingOptionDeleteCall	Deletes an assigned targeting option from an advertiser.
AdvertiserTargetingTypeAssignedTargetingOptionGetCall	Gets a single targeting option assigned to an advertiser.
AdvertiserTargetingTypeAssignedTargetingOptionListCall	Lists the targeting options assigned to an advertiser.
AgeRangeAssignedTargetingOptionDetails	Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`.
AgeRangeTargetingOptionDetails	Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`.
AppAssignedTargetingOptionDetails	Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`.
AppCategoryAssignedTargetingOptionDetails	Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
AppCategoryTargetingOptionDetails	Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
Asset	A single asset.
AssetAssociation	Asset association for the creative.
AssignedInventorySource	An assignment between a targetable inventory source and an inventory source group.
AssignedLocation	An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
AssignedTargetingOption	A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
AudienceGroupAssignedTargetingOptionDetails	Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other groups.
AudioVideoOffset	The length an audio or a video has been played.
AuthorizedSellerStatusAssignedTargetingOptionDetails	Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
AuthorizedSellerStatusTargetingOptionDetails	Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
BiddingStrategy	Settings that control the bid strategy. Bid strategy determines the bid price.
BrowserAssignedTargetingOptionDetails	Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`.
BrowserTargetingOptionDetails	Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`.
BulkEditAdvertiserAssignedTargetingOptionsRequest	Request message for BulkEditAdvertiserAssignedTargetingOptions.
BulkEditAdvertiserAssignedTargetingOptionsResponse	There is no detailed description.
BulkEditAssignedInventorySourcesRequest	Request message for AssignedInventorySourceService.BulkEdit.
BulkEditAssignedInventorySourcesResponse	Response message for AssignedInventorySourceService.BulkEdit.
BulkEditAssignedLocationsRequest	Request message for AssignedLocationService.BulkEditAssignedLocations.
BulkEditAssignedLocationsResponse	Response message for AssignedLocationService.BulkEditAssignedLocations.
BulkEditLineItemAssignedTargetingOptionsRequest	Request message for BulkEditLineItemAssignedTargetingOptions.
BulkEditLineItemAssignedTargetingOptionsResponse	There is no detailed description.
BulkEditNegativeKeywordsRequest	Request message for NegativeKeywordService.BulkEditNegativeKeywords.
BulkEditNegativeKeywordsResponse	Response message for NegativeKeywordService.BulkEditNegativeKeywords.
BulkEditSitesRequest	Request message for SiteService.BulkEditSites.
BulkEditSitesResponse	Response message for SiteService.BulkEditSites.
BulkListAdvertiserAssignedTargetingOptionsResponse	There is no detailed description.
BulkListLineItemAssignedTargetingOptionsResponse	There is no detailed description.
Campaign	A single campaign.
CampaignFlight	Settings that track the planned spend and duration of a campaign.
CampaignGoal	Settings that control the goal of a campaign.
CarrierAndIspAssignedTargetingOptionDetails	Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
CarrierAndIspTargetingOptionDetails	Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
CategoryAssignedTargetingOptionDetails	Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`.
CategoryTargetingOptionDetails	Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`.
Channel	A single channel. Channels are custom groups of related websites and apps.
ChannelAssignedTargetingOptionDetails	Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`.
Chunk
CmHybridConfig	Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers.
CmTrackingAd	A Campaign Manager tracking ad.
CombinedAudience	Describes a combined audience resource.
CombinedAudienceGetCall	Gets a combined audience.
CombinedAudienceGroup	Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other.
CombinedAudienceListCall	Lists combined audiences.
CombinedAudienceMethods	A builder providing access to all methods supported on combinedAudience resources. It is not used directly, but through the `DisplayVideo` hub.
CombinedAudienceTargetingSetting	Details of combined audience targeting setting.
ContentInstreamPositionAssignedTargetingOptionDetails	Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
ContentInstreamPositionTargetingOptionDetails	Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
ContentOutstreamPositionAssignedTargetingOptionDetails	Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
ContentOutstreamPositionTargetingOptionDetails	Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
ContentRange	Implements the Content-Range header, for serialization only
ConversionCountingConfig	Settings that control how conversions are counted.
CounterEvent	Counter event of the creative.
CreateAssetRequest	A request message for CreateAsset.
CreateAssetResponse	A response message for CreateAsset.
CreateAssignedTargetingOptionsRequest	A request listing which assigned targeting options of a given targeting type should be created and added.
CreateSdfDownloadTaskRequest	Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].
Creative	A single Creative.
CreativeConfig	Creative requirements configuration for the inventory source.
CustomList	Describes a custom list entity, such as a custom affinity or custom intent audience list.
CustomListGetCall	Gets a custom list.
CustomListGroup	Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other.
CustomListListCall	Lists custom lists.
CustomListMethods	A builder providing access to all methods supported on customList resources. It is not used directly, but through the `DisplayVideo` hub.
CustomListTargetingSetting	Details of custom list targeting setting.
Date	Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:
DateRange	A date range.
DayAndTimeAssignedTargetingOptionDetails	Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
DeleteAssignedTargetingOptionsRequest	A request listing which assigned targeting options of a given targeting type should be deleted.
DeviceMakeModelAssignedTargetingOptionDetails	Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
DeviceMakeModelTargetingOptionDetails	Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
DeviceTypeAssignedTargetingOptionDetails	Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
DeviceTypeTargetingOptionDetails	Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
DigitalContentLabelAssignedTargetingOptionDetails	Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
DigitalContentLabelTargetingOptionDetails	Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`.
Dimensions	Dimensions.
DisplayVideo	Central instance to access all DisplayVideo related resource activities
DoubleVerify	Details of DoubleVerify settings.
DoubleVerifyAppStarRating	Details of DoubleVerify star ratings settings.
DoubleVerifyBrandSafetyCategories	Settings for brand safety controls.
DoubleVerifyDisplayViewability	Details of DoubleVerify display viewability settings.
DoubleVerifyFraudInvalidTraffic	DoubleVerify Fraud & Invalid Traffic settings.
DoubleVerifyVideoViewability	Details of DoubleVerify video viewability settings.
DummyNetworkStream
Empty	A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
EnvironmentAssignedTargetingOptionDetails	Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
EnvironmentTargetingOptionDetails	Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
ErrorResponse	A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound
ExchangeAssignedTargetingOptionDetails	Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.
ExchangeReviewStatus	Exchange review status for the creative.
ExchangeTargetingOptionDetails	Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.
ExitEvent	Exit event of the creative.
FirstAndThirdPartyAudience	Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
FirstAndThirdPartyAudienceGetCall	Gets a first and third party audience.
FirstAndThirdPartyAudienceGroup	Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
FirstAndThirdPartyAudienceListCall	Lists first and third party audiences.
FirstAndThirdPartyAudienceMethods	A builder providing access to all methods supported on firstAndThirdPartyAudience resources. It is not used directly, but through the `DisplayVideo` hub.
FirstAndThirdPartyAudienceTargetingSetting	Details of first and third party audience targeting setting.
FixedBidStrategy	A strategy that uses a fixed bidding price.
FloodlightGroup	A single Floodlight group.
FloodlightGroupGetCall	Gets a Floodlight group.
FloodlightGroupMethods	A builder providing access to all methods supported on floodlightGroup resources. It is not used directly, but through the `DisplayVideo` hub.
FloodlightGroupPatchCall	Updates an existing Floodlight group. Returns the updated Floodlight group if successful.
FrequencyCap	Settings that control the number of times a user may be shown with the same ad during a given time period.
GenderAssignedTargetingOptionDetails	Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_GENDER`.
GenderTargetingOptionDetails	Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`.
GeoRegionAssignedTargetingOptionDetails	Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`.
GeoRegionTargetingOptionDetails	Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`.
GoogleAudience	Describes a Google audience resource. Includes Google audience lists.
GoogleAudienceGetCall	Gets a Google audience.
GoogleAudienceGroup	Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other.
GoogleAudienceListCall	Lists Google audiences.
GoogleAudienceMethods	A builder providing access to all methods supported on googleAudience resources. It is not used directly, but through the `DisplayVideo` hub.
GoogleAudienceTargetingSetting	Details of Google audience targeting setting.
GoogleBytestreamMedia	Media resource.
HouseholdIncomeAssignedTargetingOptionDetails	Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
HouseholdIncomeTargetingOptionDetails	Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
IdFilter	A filtering option that filters entities by their entity IDs.
InsertionOrder	A single insertion order.
InsertionOrderBudget	Settings that control how insertion order budget is allocated.
InsertionOrderBudgetSegment	Settings that control the budget of a single budget segment.
IntegralAdScience	Details of Integral Ad Science settings.
IntegrationDetails	Integration details of an entry.
InventorySource	An inventory source.
InventorySourceAssignedTargetingOptionDetails	Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
InventorySourceDisplayCreativeConfig	The configuration for display creatives.
InventorySourceFilter	A filtering option for filtering on Inventory Source entities.
InventorySourceGetCall	Gets an inventory source.
InventorySourceGroup	A collection of targetable inventory sources.
InventorySourceGroupAssignedInventorySourceBulkEditCall	Bulk edits multiple assignments between inventory sources and a single inventory source group.
InventorySourceGroupAssignedInventorySourceCreateCall	Creates an assignment between an inventory source and an inventory source group.
InventorySourceGroupAssignedInventorySourceDeleteCall	Deletes the assignment between an inventory source and an inventory source group.
InventorySourceGroupAssignedInventorySourceListCall	Lists inventory sources assigned to an inventory source group.
InventorySourceGroupAssignedTargetingOptionDetails	Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
InventorySourceGroupCreateCall	Creates a new inventory source group. Returns the newly created inventory source group if successful.
InventorySourceGroupDeleteCall	Deletes an inventory source group.
InventorySourceGroupGetCall	Gets an inventory source group.
InventorySourceGroupListCall	Lists inventory source groups that are accessible to the current user.
InventorySourceGroupMethods	A builder providing access to all methods supported on inventorySourceGroup resources. It is not used directly, but through the `DisplayVideo` hub.
InventorySourceGroupPatchCall	Updates an inventory source group. Returns the updated inventory source group if successful.
InventorySourceListCall	Lists inventory sources that are accessible to the current user.
InventorySourceMethods	A builder providing access to all methods supported on inventorySource resources. It is not used directly, but through the `DisplayVideo` hub.
InventorySourceStatus	The status related settings of the inventory source.
InventorySourceVideoCreativeConfig	The configuration for video creatives.
JsonServerError	A utility type which can decode a server response that indicates error
KeywordAssignedTargetingOptionDetails	Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.
LanguageAssignedTargetingOptionDetails	Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`.
LanguageTargetingOptionDetails	Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`.
LineItem	A single line item.
LineItemBudget	Settings that control how budget is allocated.
LineItemFlight	Settings that control the active duration of a line item.
ListAdvertiserAssignedTargetingOptionsResponse	Response message for ListAdvertiserAssignedTargetingOptions.
ListAdvertisersResponse	There is no detailed description.
ListAssignedInventorySourcesResponse	Response message for AssignedInventorySourceService.ListAssignedInventorySources.
ListAssignedLocationsResponse	Response message for AssignedLocationService.ListAssignedLocations.
ListCampaignsResponse	There is no detailed description.
ListChannelsResponse	There is no detailed description.
ListCombinedAudiencesResponse	There is no detailed description.
ListCreativesResponse	There is no detailed description.
ListCustomListsResponse	There is no detailed description.
ListFirstAndThirdPartyAudiencesResponse	There is no detailed description.
ListGoogleAudiencesResponse	There is no detailed description.
ListInsertionOrdersResponse	There is no detailed description.
ListInventorySourceGroupsResponse	Response message for InventorySourceGroupService.ListInventorySourceGroups.
ListInventorySourcesResponse	There is no detailed description.
ListLineItemAssignedTargetingOptionsResponse	Response message for ListLineItemAssignedTargetingOptions.
ListLineItemsResponse	There is no detailed description.
ListLocationListsResponse	There is no detailed description.
ListNegativeKeywordListsResponse	Response message for NegativeKeywordListService.ListNegativeKeywordLists.
ListNegativeKeywordsResponse	Response message for NegativeKeywordService.ListNegativeKeywords.
ListSitesResponse	Response message for SiteService.ListSites.
ListTargetingOptionsResponse	Response message for ListTargetingOptions.
LocationList	A list of locations used for targeting.
LookbackWindow	Specifies how many days into the past to look when determining whether to record a conversion.
MaximizeSpendBidStrategy	A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget.
MediaDownloadCall	Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.`
MediaMethods	A builder providing access to all methods supported on media resources. It is not used directly, but through the `DisplayVideo` hub.
MethodInfo	Contains information about an API request.
Money	Represents an amount of money with its currency type.
MultiPartReader	Provides a `Read` interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.
NegativeKeyword	A negatively targeted keyword that belongs to a negative keyword list.
NegativeKeywordList	A list of negative keywords used for targeting.
NegativeKeywordListAssignedTargetingOptionDetails	Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.
ObaIcon	OBA Icon for a Creative
OnScreenPositionAssignedTargetingOptionDetails	On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
OnScreenPositionTargetingOptionDetails	Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
OperatingSystemAssignedTargetingOptionDetails	Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
OperatingSystemTargetingOptionDetails	Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
Operation	This resource represents a long-running operation that is the result of a network API call.
Pacing	Settings that control the rate at which a budget is spent.
ParentEntityFilter	A filtering option that filters on selected file types belonging to a chosen set of filter entities.
ParentalStatusAssignedTargetingOptionDetails	Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_PARENTAL_STATUS`.
ParentalStatusTargetingOptionDetails	Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
PartnerChannelCreateCall	Creates a new channel. Returns the newly created channel if successful.
PartnerChannelGetCall	Gets a channel for a partner or advertiser.
PartnerChannelListCall	Lists channels for a partner or advertiser.
PartnerChannelPatchCall	Updates a channel. Returns the updated channel if successful.
PartnerChannelSiteBulkEditCall	Bulk edits sites under a single channel.
PartnerChannelSiteCreateCall	Creates a site in a channel.
PartnerChannelSiteDeleteCall	Deletes a site from a channel.
PartnerChannelSiteListCall	Lists sites in a channel.
PartnerCost	Settings that control a partner cost.
PartnerMethods	A builder providing access to all methods supported on partner resources. It is not used directly, but through the `DisplayVideo` hub.
PartnerRevenueModel	Settings that control how partner revenue is calculated.
PerformanceGoal	Settings that control the performance goal of a campaign or insertion order.
PerformanceGoalBidStrategy	A strategy that automatically adjusts the bid to meet or beat a specified performance goal.
ProximityLocationListAssignedTargetingOptionDetails	Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
PublisherReviewStatus	Publisher review status for the creative.
RangeResponseHeader
RateDetails	The rate related settings of the inventory source.
RegionalLocationListAssignedTargetingOptionDetails	Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
ResumableUploadHelper	A utility type to perform a resumable upload from start to end.
ReviewStatusInfo	Review statuses for the creative.
SdfConfig	Structured Data File (SDF) related settings.
SdfdownloadtaskCreateCall	Creates an SDF Download Task. Returns an Operation.
SdfdownloadtaskMethods	A builder providing access to all methods supported on sdfdownloadtask resources. It is not used directly, but through the `DisplayVideo` hub.
SdfdownloadtaskOperationGetCall	Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.
SensitiveCategoryAssignedTargetingOptionDetails	Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
SensitiveCategoryTargetingOptionDetails	Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
ServerError
ServerMessage
Site	A single site. Sites are apps or websites belonging to a channel.
Status	The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each `Status` message contains three pieces of data: error code, error message, and error details.
SubExchangeAssignedTargetingOptionDetails	Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
SubExchangeTargetingOptionDetails	Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
TargetingOption	Represents a single targeting option, which is a targetable concept in DV360.
TargetingTypeMethods	A builder providing access to all methods supported on targetingType resources. It is not used directly, but through the `DisplayVideo` hub.
TargetingTypeTargetingOptionGetCall	Gets a single targeting option.
TargetingTypeTargetingOptionListCall	Lists targeting options of a given type.
ThirdPartyOnlyConfig	Settings for advertisers that use third-party ad servers only.
ThirdPartyUrl	Tracking URLs from third parties to track interactions with an audio or a video creative.
ThirdPartyVerifierAssignedTargetingOptionDetails	Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
TimeRange	A time range.
TimerEvent	Timer event of the creative.
TrackingFloodlightActivityConfig	Settings that control the behavior of a single Floodlight activity config.
Transcode	Represents information about the transcoded audio or video file.
UniversalAdId	A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard.
UrlAssignedTargetingOptionDetails	Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`.
UserRewardedContentAssignedTargetingOptionDetails	User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
UserRewardedContentTargetingOptionDetails	Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
VideoPlayerSizeAssignedTargetingOptionDetails	Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect.
VideoPlayerSizeTargetingOptionDetails	Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
ViewabilityAssignedTargetingOptionDetails	Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.
ViewabilityTargetingOptionDetails	Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.
XUploadContentType	The `X-Upload-Content-Type` header.

Enums

Error
Scope	Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

Traits

CallBuilder	Identifies types which represent builders for a particular resource method
Delegate	A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.
Hub	Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.
MethodsBuilder	Identifies types for building methods of a particular resource type
NestedType	Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.
Part	Identifies types which are only used as part of other types, which usually are carrying the `Resource` trait.
ReadSeek	A utility to specify reader types which provide seeking capabilities too
RequestValue	Identifies types which are used in API requests.
Resource	Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.
ResponseResult	Identifies types which are used in API responses.
ToParts	A trait for all types that can convert themselves into a parts string
UnusedType	Identifies types which are not actually used by the API This might be a bug within the google API schema.

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.