Namespace Google.Apis.PeopleService.v1.Data

Classes

Address

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

BatchCreateContactsRequest

A request to create a batch of contacts.

BatchCreateContactsResponse

If not successful, returns BatchCreateContactsErrorDetails which contains a list of errors for each invalid contact. The response to a request to create a batch of contacts.

BatchDeleteContactsRequest

A request to delete a batch of existing contacts.

BatchGetContactGroupsResponse

The response to a batch get contact groups request.

BatchUpdateContactsRequest

A request to update a batch of contacts.

BatchUpdateContactsResponse

If not successful, returns BatchUpdateContactsErrorDetails, a list of errors corresponding to each contact. The response to a request to update a batch of contacts.

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. Clients should always set the date field when mutating birthdays.

BraggingRights

DEPRECATED: No data will be returned A person's bragging rights.

CalendarUrl

A person's calendar URL.

ClientData

Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

ContactGroup

A contact group.

ContactGroupMembership

A Google contact group membership.

ContactGroupMetadata

The metadata about a contact group.

ContactGroupResponse

The response for a specific contact group.

ContactToCreate

A wrapper that contains the person data to populate a newly created source.

CopyOtherContactToMyContactsGroupRequest

A request to copy an "Other contact" to my contacts group.

CoverPhoto

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

CreateContactGroupRequest

A request to create a new contact group.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

DeleteContactPhotoResponse

The response for deleting a contact's photo.

DomainMembership

A Google Workspace Domain membership.

EmailAddress

A person's email address.

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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Event

An event related to the person.

ExternalId

An identifier from an external entity related to the person.

FieldMetadata

Metadata about a field.

FileAs

The name that should be used to sort the person in a list.

Gender

A person's gender.

GetPeopleResponse

The response to a get request for a list of people by resource name.

GroupClientData

Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

ImClient

A person's instant messaging client.

Interest

One of the person's interests.

ListConnectionsResponse

The response to a request for the authenticated user's connections.

ListContactGroupsResponse

The response to a list contact groups request.

ListDirectoryPeopleResponse

The response to a request for the authenticated user's domain directory.

ListOtherContactsResponse

The response to a request for the authenticated user's "Other contacts".

Locale

A person's locale preference.

Location

A person's location.

Membership

A person's membership in a group. Only contact group memberships can be modified.

MiscKeyword

A person's miscellaneous keyword.

ModifyContactGroupMembersRequest

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.

ModifyContactGroupMembersResponse

The response to a modify contact group members request.

Name

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

Nickname

A person's nickname.

Occupation

A person's occupation.

Organization

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

Person

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.

PersonMetadata

The metadata about a person.

PersonResponse

The response for a single person

PhoneNumber

A person's phone number.

Photo

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

ProfileMetadata

The metadata about a profile.

Relation

A person's relation to another person.

RelationshipInterest

DEPRECATED: No data will be returned A person's relationship interest .

RelationshipStatus

DEPRECATED: No data will be returned A person's relationship status.

Residence

DEPRECATED: Please use person.locations instead. A person's past or current residence.

SearchDirectoryPeopleResponse

The response to a request for people in the authenticated user's domain directory that match the specified query.

SearchResponse

The response to a search request for the authenticated user, given a query.

SearchResult

A result of a search query.

SipAddress

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

Skill

A skill that the person has.

Source

The source of a field.

Status

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. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.