Crate google_adexchangebuyer2_v2_beta1[−][src]
This documentation was generated from AdExchangeBuyerII crate version 1.0.7+20171208, where 20171208 is the exact revision of the adexchangebuyer2:v2beta1 schema built by the mako code generator v1.0.7.
Everything else about the AdExchangeBuyerII v2_beta1 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 ...
- accounts
- clients create, clients get, clients invitations create, clients invitations get, clients invitations list, clients list, clients update, clients users get, clients users list, clients users update, creatives create, creatives deal associations add, creatives deal associations list, creatives deal associations remove, creatives get, creatives list, creatives stop watching, creatives update and creatives watch
- bidders
- accounts filter sets bid metrics list, accounts filter sets bid response errors list, accounts filter sets bid responses without bids list, accounts filter sets create, accounts filter sets delete, accounts filter sets filtered bid requests list, accounts filter sets filtered bids creatives list, accounts filter sets filtered bids details list, accounts filter sets filtered bids list, accounts filter sets get, accounts filter sets impression metrics list, accounts filter sets list, accounts filter sets losing bids list, accounts filter sets non billable winning bids list, filter sets bid metrics list, filter sets bid response errors list, filter sets bid responses without bids list, filter sets create, filter sets delete, filter sets filtered bid requests list, filter sets filtered bids creatives list, filter sets filtered bids details list, filter sets filtered bids list, filter sets get, filter sets impression metrics list, filter sets list, filter sets losing bids list and filter sets non billable winning bids list
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.bidders().accounts_filter_sets_delete(...).doit() let r = hub.accounts().creatives_deal_associations_add(...).doit() let r = hub.accounts().creatives_deal_associations_remove(...).doit() let r = hub.accounts().creatives_watch(...).doit() let r = hub.bidders().filter_sets_delete(...).doit() let r = hub.accounts().creatives_stop_watching(...).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-adexchangebuyer2_v2_beta1 = "*"
A complete example
extern crate hyper; extern crate hyper_rustls; extern crate yup_oauth2 as oauth2; extern crate google_adexchangebuyer2_v2_beta1 as adexchangebuyer2_v2_beta1; use adexchangebuyer2_v2_beta1::AddDealAssociationRequest; use adexchangebuyer2_v2_beta1::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use adexchangebuyer2_v2_beta1::AdExchangeBuyerII; // 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 = AdExchangeBuyerII::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); // As the method needs a request, you would usually fill it with the desired information // into the respective structure. Some of the parts shown here might not be applicable ! // Values shown here are possibly random and not representative ! let mut req = AddDealAssociationRequest::default(); // 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.accounts().creatives_deal_associations_add(req, "accountId", "creativeId") .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 enocodable 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
AbsoluteDateRange |
An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. |
AccountClientCreateCall |
Creates a new client buyer. |
AccountClientGetCall |
Gets a client buyer with a given client account ID. |
AccountClientInvitationCreateCall |
Creates and sends out an email invitation to access an Ad Exchange client buyer account. |
AccountClientInvitationGetCall |
Retrieves an existing client user invitation. |
AccountClientInvitationListCall |
Lists all the client users invitations for a client with a given account ID. |
AccountClientListCall |
Lists all the clients for the current sponsor buyer. |
AccountClientUpdateCall |
Updates an existing client buyer. |
AccountClientUserGetCall |
Retrieves an existing client user. |
AccountClientUserListCall |
Lists all the known client users for a specified sponsor buyer account ID. |
AccountClientUserUpdateCall |
Updates an existing client user. Only the user status can be changed on update. |
AccountCreativeCreateCall |
Creates a creative. |
AccountCreativeDealAssociationAddCall |
Associate an existing deal with a creative. |
AccountCreativeDealAssociationListCall |
List all creative-deal associations. |
AccountCreativeDealAssociationRemoveCall |
Remove the association between a deal and a creative. |
AccountCreativeGetCall |
Gets a creative. |
AccountCreativeListCall |
Lists creatives. |
AccountCreativeStopWatchingCall |
Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status. |
AccountCreativeUpdateCall |
Updates a creative. |
AccountCreativeWatchCall |
Watches a creative. Will result in push notifications being sent to the topic when the creative changes status. |
AccountMethods |
A builder providing access to all methods supported on account resources.
It is not used directly, but through the |
AdExchangeBuyerII |
Central instance to access all AdExchangeBuyerII related resource activities |
AddDealAssociationRequest |
A request for associating a deal and a creative. |
AppContext |
@OutputOnly The app type the restriction applies to for mobile device. |
AuctionContext |
@OutputOnly The auction type the restriction applies to. |
BidMetricsRow |
The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel; |
BidResponseWithoutBidsStatusRow |
The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status. |
BidderAccountFilterSetBidMetricListCall |
Lists all metrics that are measured in terms of number of bids. |
BidderAccountFilterSetBidResponseErrorListCall |
List all errors that occurred in bid responses, with the number of bid responses affected for each reason. |
BidderAccountFilterSetBidResponsesWithoutBidListCall |
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason. |
BidderAccountFilterSetCreateCall |
Creates the specified filter set for the account with the given account ID. |
BidderAccountFilterSetDeleteCall |
Deletes the requested filter set from the account with the given account ID. |
BidderAccountFilterSetFilteredBidCreativeListCall |
List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative. |
BidderAccountFilterSetFilteredBidDetailListCall |
List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail. |
BidderAccountFilterSetFilteredBidListCall |
List all reasons for which bids were filtered, with the number of bids filtered for each reason. |
BidderAccountFilterSetFilteredBidRequestListCall |
List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason. |
BidderAccountFilterSetGetCall |
Retrieves the requested filter set for the account with the given account ID. |
BidderAccountFilterSetImpressionMetricListCall |
Lists all metrics that are measured in terms of number of impressions. |
BidderAccountFilterSetListCall |
Lists all filter sets for the account with the given account ID. |
BidderAccountFilterSetLosingBidListCall |
List all reasons for which bids lost in the auction, with the number of bids that lost for each reason. |
BidderAccountFilterSetNonBillableWinningBidListCall |
List all reasons for which winning bids were not billable, with the number of bids not billed for each reason. |
BidderFilterSetBidMetricListCall |
Lists all metrics that are measured in terms of number of bids. |
BidderFilterSetBidResponseErrorListCall |
List all errors that occurred in bid responses, with the number of bid responses affected for each reason. |
BidderFilterSetBidResponsesWithoutBidListCall |
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason. |
BidderFilterSetCreateCall |
Creates the specified filter set for the account with the given account ID. |
BidderFilterSetDeleteCall |
Deletes the requested filter set from the account with the given account ID. |
BidderFilterSetFilteredBidCreativeListCall |
List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative. |
BidderFilterSetFilteredBidDetailListCall |
List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail. |
BidderFilterSetFilteredBidListCall |
List all reasons for which bids were filtered, with the number of bids filtered for each reason. |
BidderFilterSetFilteredBidRequestListCall |
List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason. |
BidderFilterSetGetCall |
Retrieves the requested filter set for the account with the given account ID. |
BidderFilterSetImpressionMetricListCall |
Lists all metrics that are measured in terms of number of impressions. |
BidderFilterSetListCall |
Lists all filter sets for the account with the given account ID. |
BidderFilterSetLosingBidListCall |
List all reasons for which bids lost in the auction, with the number of bids that lost for each reason. |
BidderFilterSetNonBillableWinningBidListCall |
List all reasons for which winning bids were not billable, with the number of bids not billed for each reason. |
BidderMethods |
A builder providing access to all methods supported on bidder resources.
It is not used directly, but through the |
CalloutStatusRow |
The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status. |
Client |
A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Ad Exchange Marketplace and certain other sections of the Ad Exchange Buyer UI based on the role granted to the client buyer. All fields are required unless otherwise specified. |
ClientUser |
A client user is created under a client buyer and has restricted access to the Ad Exchange Marketplace and certain other sections of the Ad Exchange Buyer UI based on the role granted to the associated client buyer. |
ClientUserInvitation |
An invitation for a new client user to get access to the Ad Exchange Buyer UI. All fields are required unless otherwise specified. |
Correction |
@OutputOnly Shows any corrections that were applied to this creative. |
Creative |
A creative and its classification data. |
CreativeDealAssociation |
The association between a creative and a deal. |
CreativeStatusRow |
The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status. |
Date |
Represents a whole calendar date, e.g. date of birth. The time of day and
time zone are either specified elsewhere or are not significant. The date
is relative to the Proleptic Gregorian Calendar. The day may be 0 to
represent a year and month where the day is not significant, e.g. credit card
expiration date. The year may be 0 to represent a month and day independent
of year, e.g. anniversary date. Related types are google.type.TimeOfDay
and |
DefaultDelegate |
A delegate with a conservative default implementation, which is used if no other delegate is set. |
Disapproval |
@OutputOnly The reason and details for a disapproval. |
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: |
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 |
FilterSet |
A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field. E.g. "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)" |
FilteredBidCreativeRow |
The number of filtered bids with the specified dimension values that have the specified creative. |
FilteredBidDetailRow |
The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail. |
FilteringStats |
@OutputOnly Filtering reasons for this creative during a period of a single day (from midnight to midnight Pacific). |
HtmlContent |
HTML content for a creative. |
Image |
An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. |
ImpressionMetricsRow |
The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel. |
ListBidMetricsResponse |
Response message for listing the metrics that are measured in number of bids. |
ListBidResponseErrorsResponse |
Response message for listing all reasons that bid responses resulted in an error. |
ListBidResponsesWithoutBidsResponse |
Response message for listing all reasons that bid responses were considered to have no applicable bids. |
ListClientUserInvitationsResponse |
There is no detailed description. |
ListClientUsersResponse |
There is no detailed description. |
ListClientsResponse |
There is no detailed description. |
ListCreativeStatusBreakdownByCreativeResponse |
Response message for listing all creatives associated with a given filtered bid reason. |
ListCreativeStatusBreakdownByDetailResponse |
Response message for listing all details associated with a given filtered bid reason. |
ListCreativesResponse |
A response for listing creatives. |
ListDealAssociationsResponse |
A response for listing creative and deal associations |
ListFilterSetsResponse |
Response message for listing filter sets. |
ListFilteredBidRequestsResponse |
Response message for listing all reasons that bid requests were filtered and not sent to the buyer. |
ListFilteredBidsResponse |
Response message for listing all reasons that bids were filtered from the auction. |
ListImpressionMetricsResponse |
Response message for listing the metrics that are measured in number of impressions. |
ListLosingBidsResponse |
Response message for listing all reasons that bids lost in the auction. |
ListNonBillableWinningBidsResponse |
Response message for listing all reasons for which a buyer was not billed for a winning bid. |
LocationContext |
@OutputOnly The Geo criteria the restriction applies to. |
MethodInfo |
Contains information about an API request. |
MetricValue |
A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled). |
MultiPartReader |
Provides a |
NativeContent |
Native content for a creative. |
NonBillableWinningBidStatusRow |
The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status. |
PlatformContext |
@OutputOnly The type of platform the restriction applies to. |
RealtimeTimeRange |
An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. |
Reason |
A specific filtering status and how many times it occurred. |
RelativeDateRange |
A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today. I.e. the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 |
RemoveDealAssociationRequest |
A request for removing the association between a deal and a creative. |
RowDimensions |
A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row. |
SecurityContext |
@OutputOnly A security context. |
ServingContext |
The serving context for this restriction. |
ServingRestriction |
@OutputOnly A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). |
StopWatchingCreativeRequest |
A request for stopping notifications for changes to creative Status. |
TimeInterval |
An interval of time, with an absolute start and end. |
VideoContent |
Video content for a creative. |
WatchCreativeRequest |
A request for watching changes to creative Status. |
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 |
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 |
Functions
remove_json_null_values |
Type Definitions
Result |
A universal result type used as return for all calls. |