Crate google_partners2

This documentation was generated from Partners crate version 1.0.4+20170503, where 20170503 is the exact revision of the partners:v2 schema built by the mako code generator v1.0.4.

Everything else about the Partners v2 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 …

• analytics
• list
• client messages
• log
• companies
• get, leads create and list
• exams
• get token
• leads
• list
• offers
• history list and list
• user events
• log
• user states
• list
• users
• create company relation, delete company relation, get and update profile

Other activities are …

• get partnersstatus
• update companies
• update leads

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.users().create_company_relation(...).doit()
let r = hub.users().get(...).doit()
let r = hub.users().update_profile(...).doit()
let r = hub.users().delete_company_relation(...).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-partners2 = "*"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_partners2 as partners2;
use partners2::CompanyRelation;
use partners2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use partners2::Partners;
 
// 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 = Partners::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 = CompanyRelation::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.users().create_company_relation(req, "userId")
             .request_metadata_user_overrides_user_id("justo")
             .request_metadata_user_overrides_ip_address("amet.")
             .request_metadata_traffic_source_traffic_sub_id("erat")
             .request_metadata_traffic_source_traffic_source_id("labore")
             .request_metadata_partners_session_id("sea")
             .request_metadata_locale("nonumy")
             .add_request_metadata_experiment_ids("dolores")
             .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

• AdWordsManagerAccountInfo
  Information about a particular AdWords Manager Account. Read more at https://support.google.com/adwords/answer/6139186
• AnalyticListCall
  Lists analytics data for a user’s associated company. Should only be called within the context of an authorized logged in user.
• AnalyticMethods
  A builder providing access to all methods supported on analytic resources. It is not used directly, but through the Partners hub.
• Analytics
  Analytics data for a Company within a single day.
• AnalyticsDataPoint
  Details of the analytics events for a Company within a single day.
• AnalyticsSummary
  Analytics aggregated data for a Company for a given date range.
• AvailableOffer
  Available Offers to be distributed.
• Certification
  A user’s information on a specific certification.
• CertificationExamStatus
  Status for a Google Partners certification exam.
• CertificationStatus
  Google Partners certification status.
• ClientMessageLogCall
  Logs a generic message from the client, such as Failed to render component, Profile page is running slow, More than 500 users have accessed this result., etc.
• ClientMessageMethods
  A builder providing access to all methods supported on clientMessage resources. It is not used directly, but through the Partners hub.
• Company
  A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers.
• CompanyGetCall
  Gets a company.
• CompanyLeadCreateCall
  Creates an advertiser lead for the given company ID.
• CompanyListCall
  Lists companies.
• CompanyMethods
  A builder providing access to all methods supported on company resources. It is not used directly, but through the Partners hub.
• CompanyRelation
  A CompanyRelation resource representing information about a user’s affiliation and standing with a company in Partners.
• CountryOfferInfo
  Offer info by country.
• CreateLeadRequest
  Request message for CreateLead.
• CreateLeadResponse
  Response message for CreateLead.
• 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 google.protobuf.Timestamp.
• DebugInfo
  Debug information about this request.
• DefaultDelegate
  A delegate with a conservative default implementation, which is used if no other delegate is set.
• 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
• EventData
  Key value data pair for an event.
• ExamGetTokenCall
  Gets an Exam Token for a Partner’s user to take an exam in the Exams System
• ExamMethods
  A builder providing access to all methods supported on exam resources. It is not used directly, but through the Partners hub.
• ExamStatus
  A user’s information on a specific exam.
• ExamToken
  A token that allows a user to take an exam.
• GetCompanyResponse
  Response message for GetCompany.
• GetPartnersStatusResponse
  Response message for GetPartnersStatus.
• HistoricalOffer
  Historical information about a Google Partners Offer.
• LatLng
  An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.
• Lead
  A lead resource that represents an advertiser contact for a Company. These are usually generated via Google Partner Search (the advertiser portal).
• LeadListCall
  Lists advertiser leads for a user’s associated company. Should only be called within the context of an authorized logged in user.
• LeadMethods
  A builder providing access to all methods supported on lead resources. It is not used directly, but through the Partners hub.
• ListAnalyticsResponse
  Response message for ListAnalytics.
• ListCompaniesResponse
  Response message for ListCompanies.
• ListLeadsResponse
  Response message for ListLeads.
• ListOffersHistoryResponse
  Response for ListOfferHistory.
• ListOffersResponse
  Response for ListOffer.
• ListUserStatesResponse
  Response message for ListUserStates.
• LocalizedCompanyInfo
  The localized company information.
• Location
  A location with address and geographic coordinates. May optionally contain a detailed (multi-field) version of the address.
• LogMessageRequest
  Request message for LogClientMessage.
• LogMessageResponse
  Response message for LogClientMessage.
• LogUserEventRequest
  Request message for LogUserEvent.
• LogUserEventResponse
  Response message for LogUserEvent.
• MethodGetPartnersstatuCall
  Gets Partners Status of the logged in user’s agency. Should only be called if the logged in user is the admin of the agency.
• MethodInfo
  Contains information about an API request.
• MethodMethods
  A builder providing access to all free methods, which are not associated with a particular resource. It is not used directly, but through the Partners hub.
• MethodUpdateCompanyCall
  Update company. Should only be called within the context of an authorized logged in user.
• MethodUpdateLeadCall
  Updates the specified lead.
• 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.
• OfferCustomer
  Customers qualified for an offer.
• OfferHistoryListCall
  Lists the Historical Offers for the current user (or user’s entire company)
• OfferListCall
  Lists the Offers available for the current user
• OfferMethods
  A builder providing access to all methods supported on offer resources. It is not used directly, but through the Partners hub.
• OptIns
  A set of opt-ins for a user.
• Partners
  Central instance to access all Partners related resource activities
• PublicProfile
  Basic information from a public profile.
• Rank
  Information related to ranking of results.
• RecaptchaChallenge
  reCaptcha challenge info.
• RequestMetadata
  Common data that is in each API request.
• ResponseMetadata
  Common data that is in each API response.
• SpecializationStatus
  Agency specialization status
• TrafficSource
  Source of traffic for the current request.
• User
  A resource representing a user of the Partners platform.
• UserCreateCompanyRelationCall
  Creates a user’s company relation. Affiliates the user to a company.
• UserDeleteCompanyRelationCall
  Deletes a user’s company relation. Unaffiliaites the user from a company.
• UserEventLogCall
  Logs a user event.
• UserEventMethods
  A builder providing access to all methods supported on userEvent resources. It is not used directly, but through the Partners hub.
• UserGetCall
  Gets a user.
• UserMethods
  A builder providing access to all methods supported on user resources. It is not used directly, but through the Partners hub.
• UserOverrides
  Values to use instead of the user’s respective defaults. These are only honored by whitelisted products.
• UserProfile
  The profile information of a Partners user.
• UserStateListCall
  Lists states for current user.
• UserStateMethods
  A builder providing access to all methods supported on userState resources. It is not used directly, but through the Partners hub.
• UserUpdateProfileCall
  Updates a user’s profile. A user can only update their own profile and should only be called within the context of a logged in user.

Enums

• Error

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

Functions

• remove_json_null_values

Type Aliases

• Result
  A universal result type used as return for all calls.