|
|
|
|
@@ -5,36 +5,36 @@ DO NOT EDIT !
|
|
|
|
|
-->
|
|
|
|
|
The `google-partners2` library allows access to all features of the *Google Partners* service.
|
|
|
|
|
|
|
|
|
|
This documentation was generated from *Partners* crate version *1.0.8+20180925*, where *20180925* is the exact revision of the *partners:v2* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.8*.
|
|
|
|
|
This documentation was generated from *Partners* crate version *1.0.9+20180925*, where *20180925* is the exact revision of the *partners:v2* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.9*.
|
|
|
|
|
|
|
|
|
|
Everything else about the *Partners* *v2* API can be found at the
|
|
|
|
|
[official documentation site](https://developers.google.com/partners/).
|
|
|
|
|
# Features
|
|
|
|
|
|
|
|
|
|
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.Partners.html) ...
|
|
|
|
|
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.Partners.html) ...
|
|
|
|
|
|
|
|
|
|
* analytics
|
|
|
|
|
* [*list*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.AnalyticListCall.html)
|
|
|
|
|
* [*list*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.AnalyticListCall.html)
|
|
|
|
|
* client messages
|
|
|
|
|
* [*log*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.ClientMessageLogCall.html)
|
|
|
|
|
* [companies](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.Company.html)
|
|
|
|
|
* [*get*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.CompanyGetCall.html), [*leads create*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.CompanyLeadCreateCall.html) and [*list*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.CompanyListCall.html)
|
|
|
|
|
* [leads](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.Lead.html)
|
|
|
|
|
* [*list*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.LeadListCall.html)
|
|
|
|
|
* [*log*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.ClientMessageLogCall.html)
|
|
|
|
|
* [companies](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.Company.html)
|
|
|
|
|
* [*get*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.CompanyGetCall.html), [*leads create*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.CompanyLeadCreateCall.html) and [*list*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.CompanyListCall.html)
|
|
|
|
|
* [leads](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.Lead.html)
|
|
|
|
|
* [*list*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.LeadListCall.html)
|
|
|
|
|
* offers
|
|
|
|
|
* [*history list*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.OfferHistoryListCall.html) and [*list*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.OfferListCall.html)
|
|
|
|
|
* [*history list*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.OfferHistoryListCall.html) and [*list*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.OfferListCall.html)
|
|
|
|
|
* user events
|
|
|
|
|
* [*log*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.UserEventLogCall.html)
|
|
|
|
|
* [*log*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.UserEventLogCall.html)
|
|
|
|
|
* user states
|
|
|
|
|
* [*list*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.UserStateListCall.html)
|
|
|
|
|
* [users](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.User.html)
|
|
|
|
|
* [*create company relation*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.UserCreateCompanyRelationCall.html), [*delete company relation*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.UserDeleteCompanyRelationCall.html), [*get*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.UserGetCall.html) and [*update profile*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.UserUpdateProfileCall.html)
|
|
|
|
|
* [*list*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.UserStateListCall.html)
|
|
|
|
|
* [users](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.User.html)
|
|
|
|
|
* [*create company relation*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.UserCreateCompanyRelationCall.html), [*delete company relation*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.UserDeleteCompanyRelationCall.html), [*get*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.UserGetCall.html) and [*update profile*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.UserUpdateProfileCall.html)
|
|
|
|
|
|
|
|
|
|
Other activities are ...
|
|
|
|
|
|
|
|
|
|
* [get partnersstatus](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.MethodGetPartnersstatuCall.html)
|
|
|
|
|
* [update companies](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.MethodUpdateCompanyCall.html)
|
|
|
|
|
* [update leads](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.MethodUpdateLeadCall.html)
|
|
|
|
|
* [get partnersstatus](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.MethodGetPartnersstatuCall.html)
|
|
|
|
|
* [update companies](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.MethodUpdateCompanyCall.html)
|
|
|
|
|
* [update leads](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.MethodUpdateLeadCall.html)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -42,17 +42,17 @@ Other activities are ...
|
|
|
|
|
|
|
|
|
|
The API is structured into the following primary items:
|
|
|
|
|
|
|
|
|
|
* **[Hub](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/struct.Partners.html)**
|
|
|
|
|
* **[Hub](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/struct.Partners.html)**
|
|
|
|
|
* a central object to maintain state and allow accessing all *Activities*
|
|
|
|
|
* creates [*Method Builders*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.MethodsBuilder.html) which in turn
|
|
|
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.CallBuilder.html)
|
|
|
|
|
* **[Resources](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.Resource.html)**
|
|
|
|
|
* creates [*Method Builders*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.MethodsBuilder.html) which in turn
|
|
|
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.CallBuilder.html)
|
|
|
|
|
* **[Resources](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.Resource.html)**
|
|
|
|
|
* primary types that you can apply *Activities* to
|
|
|
|
|
* a collection of properties and *Parts*
|
|
|
|
|
* **[Parts](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.Part.html)**
|
|
|
|
|
* **[Parts](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.Part.html)**
|
|
|
|
|
* a collection of properties
|
|
|
|
|
* never directly used in *Activities*
|
|
|
|
|
* **[Activities](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.CallBuilder.html)**
|
|
|
|
|
* **[Activities](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.CallBuilder.html)**
|
|
|
|
|
* operations to apply to *Resources*
|
|
|
|
|
|
|
|
|
|
All *structures* are marked with applicable traits to further categorize them and ease browsing.
|
|
|
|
|
@@ -159,17 +159,17 @@ match result {
|
|
|
|
|
```
|
|
|
|
|
## Handling Errors
|
|
|
|
|
|
|
|
|
|
All errors produced by the system are provided either as [Result](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/enum.Result.html) enumeration as return value of
|
|
|
|
|
All errors produced by the system are provided either as [Result](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/enum.Result.html) enumeration as return value of
|
|
|
|
|
the doit() methods, or handed as possibly intermediate results to either the
|
|
|
|
|
[Hub Delegate](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
|
|
|
|
[Hub Delegate](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
|
|
|
|
|
|
|
|
|
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](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/enum.Result.html), should be
|
|
|
|
|
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/enum.Result.html), should be
|
|
|
|
|
read by you to obtain the media.
|
|
|
|
|
If such a method also supports a [Response Result](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.ResponseResult.html), it will return that by default.
|
|
|
|
|
If such a method also supports a [Response Result](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.ResponseResult.html), 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")`.
|
|
|
|
|
|
|
|
|
|
@@ -179,29 +179,29 @@ Methods supporting uploads can do so using up to 2 different protocols:
|
|
|
|
|
|
|
|
|
|
## Customization and Callbacks
|
|
|
|
|
|
|
|
|
|
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.Delegate.html) to the
|
|
|
|
|
[Method Builder](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.CallBuilder.html) before making the final `doit()` call.
|
|
|
|
|
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.Delegate.html) to the
|
|
|
|
|
[Method Builder](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.CallBuilder.html) 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](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
|
|
|
|
|
The [delegate trait](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.Delegate.html) 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](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.RequestValue.html) and
|
|
|
|
|
[decodable](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses
|
|
|
|
|
All structures provided by this library are made to be [enocodable](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.RequestValue.html) and
|
|
|
|
|
[decodable](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses
|
|
|
|
|
are valid.
|
|
|
|
|
Most optionals are are considered [Parts](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.Part.html) which are identifiable by name, which will be sent to
|
|
|
|
|
Most optionals are are considered [Parts](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.Part.html) 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](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
|
|
|
|
|
Using [method builders](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy
|
|
|
|
|
* strings are passed as `&str`
|
|
|
|
|
* [request values](https://docs.rs/google-partners2/1.0.8+20180925/google_partners2/trait.RequestValue.html) are moved
|
|
|
|
|
* [request values](https://docs.rs/google-partners2/1.0.9+20180925/google_partners2/trait.RequestValue.html) are moved
|
|
|
|
|
|
|
|
|
|
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
|
|
|
|
|
|
|
|
|
|
|