google_api_people v0.4.0 API Reference
Modules
API calls for all endpoints tagged ContactGroups
.
API calls for all endpoints tagged People
.
Handle Tesla connections for GoogleApi.People.V1.
Helper functions for deserializing responses into models.
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.
A Google contact group membership.
The read-only metadata about a contact group.
The response for a specific contact group.
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.
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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
An event related to the person.
Metadata about a field.
A person's gender.
A person's instant messaging client.
One of the person's interests.
Attributes
- connections ([Person]): The list of people that the requestor is connected to. Defaults to:
null
. - nextPageToken (String.t): The token that can be used to retrieve the next page of results. Defaults to:
null
. - nextSyncToken (String.t): The token that can be used to retrieve changes since the last request. Defaults to:
null
. - totalItems (integer()): The total number of items in the list without pagination. Defaults to:
null
. - totalPeople (integer()): DEPRECATED (Please use totalItems) The total number of people in the list without pagination. Defaults to:
null
.
The response to a list contact groups request.
A person's locale preference.
A person's read-only membership in a group.
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.
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.
Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
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: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
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.
Helper functions for building Tesla requests.