Crate google_people1[][src]

This documentation was generated from People Service crate version 1.0.8+20181010, where 20181010 is the exact revision of the people:v1 schema built by the mako code generator v1.0.8.

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


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.contact_groups().batch_get(...).doit()
let r = hub.contact_groups().list(...).doit()
let r = hub.contact_groups().create(...).doit()
let r = hub.contact_groups().update(...).doit()
let r = hub.contact_groups().delete(...).doit()
let r = hub.contact_groups().members_modify(...).doit()
let r = hub.contact_groups().get(...).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.


Setting up your Project

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

google-people1 = "*"
# This project intentionally uses an old version of Hyper. See
# 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_people1 as people1;
use people1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use people1::PeopleService;
// 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,
                              <MemoryStorage as Default>::default(), None);
let mut hub = PeopleService::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.contact_groups().list()
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::UploadSizeLimitExceeded(_, _)
        |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.

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



A person's physical address. May be a P.O. box or street address. All fields are optional.


A person's age range.


The response to a batch get contact groups request.


A person's short biography.


A person's birthday. At least one of the date and text fields are specified. The date and text fields typically represent the same date, but are not guaranteed to.


A person's bragging rights.


A contact group.


Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.


Create a new contact group owned by the authenticated user.


Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.


Get a specific contact group owned by the authenticated user by specifying a contact group resource name.


List all contact groups owned by the authenticated user. Members of the contact groups are not populated.


Modify the members of a contact group owned by the authenticated user.


A Google contact group membership.


The read-only metadata about a contact group.


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


The response for a specific contact group.


Update the name of an existing contact group owned by the authenticated user.


A person's read-only cover photo. A large image shown on the person's profile page that represents who they are or what they care about.


A request to create a new contact group.


Represents a whole calendar date, for example a 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. The year may be 0 to represent a month and day independent of year; for example, anniversary date.


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


A Google Apps Domain membership.


A person's email address.


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:


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


An event related to the person.


Metadata about a field.


A person's gender.


There is no detailed description.


A person's instant messaging client.


One of the person's interests.


There is no detailed description.


The response to a list contact groups request.


A person's locale preference.


A person's read-only membership in a group.


Contains information about an API request.


A request to modify an existing contact group's members. Contacts can be removed from any group but they can only be added to a user group or myContacts or starred system groups.


The response to a modify contact group members request.


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.


A person's name. If the name is a mononym, the family name is empty.


A person's nickname.


A person's occupation.


A person's past or current organization. Overlapping date ranges are permitted.


Provides a list of the authenticated user's contacts merged with any connected profiles.
The request throws a 400 error if 'personFields' is not specified.


Create a new contact and return the person resource for that contact.


Delete a contact person. Any non-contact data will not be deleted.


Provides information about a list of specific people by specifying a list of requested resource names. Use people/me to indicate the authenticated user.
The request throws a 400 error if 'personFields' is not specified.


Provides information about a person by specifying a resource name. Use people/me to indicate the authenticated user.
The request throws a 400 error if 'personFields' is not specified.


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


Central instance to access all PeopleService related resource activities


Update contact data for an existing contact person. Any non-contact data will not be modified.


Information about a person merged from various data sources such as the authenticated user's contacts and profile data.


The read-only metadata about a person.


The response for a single person


A person's phone number.


A person's read-only photo. A picture shown next to the person's name to help others recognize the person.


The read-only metadata about a profile.


A person's relation to another person.


A person's read-only relationship interest .


A person's read-only relationship status.


A person's past or current residence.


A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.


A skill that the person has.


The source of a field.


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. The error model is designed to be:


A read-only brief one-line description of the person.


A request to update an existing user contact group. All updated fields will be replaced.


A person's associated URLs.


Arbitrary user data that is populated by the end users.



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



Identifies types which represent builders for a particular resource method


A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.


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.


Identifies types for building methods of a particular resource type


Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.


Identifies types which are only used as part of other types, which usually are carrying the Resource trait.


A utility to specify reader types which provide seeking capabilities too


Identifies types which are used in API requests.


Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.


Identifies types which are used in API responses.


A trait for all types that can convert themselves into a parts string



Type Definitions


A universal result type used as return for all calls.