[−][src]Crate google_realtimebidding1

This documentation was generated from Real-time Bidding crate version 1.0.14+20200709, where 20200709 is the exact revision of the realtimebidding:v1 schema built by the mako code generator v1.0.14.

Everything else about the Real-time Bidding 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 ...

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 ...

ⓘThis example is not tested
let r = hub.buyers().user_lists_open(...).doit()
let r = hub.buyers().user_lists_close(...).doit()
let r = hub.buyers().user_lists_create(...).doit()
let r = hub.buyers().user_lists_get(...).doit()
let r = hub.buyers().user_lists_update(...).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-realtimebidding1 = "*"
# 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_realtimebidding1 as realtimebidding1;
use realtimebidding1::OpenUserListRequest;
use realtimebidding1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use realtimebidding1::RealTimeBidding;
 
// 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 = RealTimeBidding::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 = OpenUserListRequest::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.buyers().user_lists_open(req, "name")
             .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.

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

Structs

AdTechnologyProviders

Detected ad technology provider information.

AdvertiserAndBrand

Detected advertiser and brand information.

BidderCreativeListCall

Lists creatives.

BidderCreativeWatchCall

Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.

BidderMethods

A builder providing access to all methods supported on bidder resources. It is not used directly, but through the RealTimeBidding hub.

BuyerCreativeCreateCall

Creates a creative.

BuyerCreativeGetCall

Gets a creative.

BuyerCreativeListCall

Lists creatives.

BuyerCreativePatchCall

Updates a creative.

BuyerGetRemarketingTagCall

Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

BuyerMethods

A builder providing access to all methods supported on buyer resources. It is not used directly, but through the RealTimeBidding hub.

BuyerUserListCloseCall

Change the status of a user list to CLOSED. This prevents new users from being added to the user list.

BuyerUserListCreateCall

Create a new user list.

BuyerUserListGetCall

Gets a user list by its name.

BuyerUserListGetRemarketingTagCall

Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

BuyerUserListListCall

Lists the user lists visible to the current user.

BuyerUserListOpenCall

Change the status of a user list to OPEN. This allows new users to be added to the user list.

BuyerUserListUpdateCall

Update the given user list. Only user lists with URLRestrictions can be updated.

Chunk
CloseUserListRequest

A request to close a specified user list.

ContentRange

Implements the Content-Range header, for serialization only

Creative

A creative and its classification data.

CreativeServingDecision

Top level status and detected attributes of a creative.

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:

DefaultDelegate

A delegate with a conservative default implementation, which is used if no other delegate is set.

DestinationNotCrawlableEvidence

Evidence that the creative's destination URL was not crawlable by Google.

DestinationNotWorkingEvidence

Evidence of the creative's destination URL not functioning properly or having been incorrectly set up.

DestinationUrlEvidence

The full landing page URL of the destination.

DomainCallEvidence

Number of HTTP calls made by a creative, broken down by domain.

DomainCalls

The number of HTTP calls made to the given domain.

DownloadSizeEvidence

Total download size and URL-level download size breakdown for resources in a creative.

DummyNetworkStream
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

GetRemarketingTagResponse

Response for a request to get remarketing tag.

HtmlContent

HTML content for a creative.

HttpCallEvidence

HTTP calls made by a creative that resulted in policy violations.

HttpCookieEvidence

Evidence for HTTP cookie-related policy violations.

Image

An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.

JsonServerError

A utility type which can decode a server response that indicates error

ListCreativesResponse

A response for listing creatives.

ListUserListsResponse

The list user list response.

MediaFile

Information about each media file in the VAST.

MethodInfo

Contains information about an API request.

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.

NativeContent

Native content for a creative.

OpenUserListRequest

A request to open a specified user list.

PolicyTopicEntry

Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.

PolicyTopicEvidence

Evidence associated with a policy topic entry.

RangeResponseHeader
RealTimeBidding

Central instance to access all RealTimeBidding related resource activities

ResumableUploadHelper

A utility type to perform a resumable upload from start to end.

ServerError
ServerMessage
ServingStatus

Serving status of the creative for a transaction type or a region.

UrlDownloadSize

The URL-level breakdown for the download size.

UrlRestriction

Represents the URL restriction (for the URL captured by the pixel callback) for a user list.

UserList

Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page.

VideoContent

Video content for a creative.

VideoMetadata

Video metadata for a creative.

WatchCreativesRequest

A request to receive push notifications when any of the creatives belonging to the bidder changes status.

WatchCreativesResponse

A response for the request to receive push notification when a bidder's creatives change status.

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.