is.google-api-services-people.v1-rev20210330-1.31.0.source-code.people.v1.json Maven / Gradle / Ivy
{
"mtlsRootUrl": "https://people.mtls.googleapis.com/",
"id": "people:v1",
"canonicalName": "People Service",
"name": "people",
"schemas": {
"Empty": {
"id": "Empty",
"properties": {},
"type": "object",
"description": "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 `{}`."
},
"RelationshipStatus": {
"description": "**DEPRECATED**: No data will be returned A person's relationship status.",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the relationship status."
},
"value": {
"type": "string",
"description": "The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`"
},
"formattedValue": {
"type": "string",
"description": "Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"readOnly": true
}
},
"type": "object",
"id": "RelationshipStatus"
},
"ExternalId": {
"id": "ExternalId",
"type": "object",
"description": "An identifier from an external entity related to the person.",
"properties": {
"value": {
"type": "string",
"description": "The value of the external ID."
},
"type": {
"type": "string",
"description": "The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`"
},
"formattedType": {
"type": "string",
"description": "Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"readOnly": true
},
"metadata": {
"description": "Metadata about the external ID.",
"$ref": "FieldMetadata"
}
}
},
"Person": {
"id": "Person",
"properties": {
"urls": {
"type": "array",
"description": "The person's associated URLs.",
"items": {
"$ref": "Url"
}
},
"externalIds": {
"description": "The person's external IDs.",
"type": "array",
"items": {
"$ref": "ExternalId"
}
},
"photos": {
"description": "Output only. The person's photos.",
"items": {
"$ref": "Photo"
},
"readOnly": true,
"type": "array"
},
"names": {
"items": {
"$ref": "Name"
},
"type": "array",
"description": "The person's names. This field is a singleton for contact sources."
},
"locales": {
"items": {
"$ref": "Locale"
},
"description": "The person's locale preferences.",
"type": "array"
},
"genders": {
"description": "The person's genders. This field is a singleton for contact sources.",
"items": {
"$ref": "Gender"
},
"type": "array"
},
"miscKeywords": {
"type": "array",
"description": "The person's miscellaneous keywords.",
"items": {
"$ref": "MiscKeyword"
}
},
"organizations": {
"description": "The person's past or current organizations.",
"items": {
"$ref": "Organization"
},
"type": "array"
},
"sipAddresses": {
"description": "The person's SIP addresses.",
"items": {
"$ref": "SipAddress"
},
"type": "array"
},
"imClients": {
"items": {
"$ref": "ImClient"
},
"description": "The person's instant messaging clients.",
"type": "array"
},
"skills": {
"type": "array",
"items": {
"$ref": "Skill"
},
"description": "The person's skills."
},
"braggingRights": {
"type": "array",
"description": "**DEPRECATED**: No data will be returned The person's bragging rights.",
"items": {
"$ref": "BraggingRights"
}
},
"ageRange": {
"enum": [
"AGE_RANGE_UNSPECIFIED",
"LESS_THAN_EIGHTEEN",
"EIGHTEEN_TO_TWENTY",
"TWENTY_ONE_OR_OLDER"
],
"enumDescriptions": [
"Unspecified.",
"Younger than eighteen.",
"Between eighteen and twenty.",
"Twenty-one and older."
],
"readOnly": true,
"description": "Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.",
"type": "string"
},
"phoneNumbers": {
"items": {
"$ref": "PhoneNumber"
},
"description": "The person's phone numbers.",
"type": "array"
},
"nicknames": {
"items": {
"$ref": "Nickname"
},
"description": "The person's nicknames.",
"type": "array"
},
"fileAses": {
"description": "The person's file-ases.",
"type": "array",
"items": {
"$ref": "FileAs"
}
},
"events": {
"items": {
"$ref": "Event"
},
"description": "The person's events.",
"type": "array"
},
"clientData": {
"description": "The person's client data.",
"type": "array",
"items": {
"$ref": "ClientData"
}
},
"birthdays": {
"items": {
"$ref": "Birthday"
},
"description": "The person's birthdays. This field is a singleton for contact sources.",
"type": "array"
},
"userDefined": {
"type": "array",
"items": {
"$ref": "UserDefined"
},
"description": "The person's user defined data."
},
"resourceName": {
"description": "The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.",
"type": "string"
},
"calendarUrls": {
"type": "array",
"items": {
"$ref": "CalendarUrl"
},
"description": "The person's calendar URLs."
},
"biographies": {
"items": {
"$ref": "Biography"
},
"description": "The person's biographies. This field is a singleton for contact sources.",
"type": "array"
},
"addresses": {
"type": "array",
"items": {
"$ref": "Address"
},
"description": "The person's street addresses."
},
"metadata": {
"readOnly": true,
"description": "Output only. Metadata about the person.",
"$ref": "PersonMetadata"
},
"occupations": {
"items": {
"$ref": "Occupation"
},
"description": "The person's occupations.",
"type": "array"
},
"ageRanges": {
"items": {
"$ref": "AgeRangeType"
},
"readOnly": true,
"type": "array",
"description": "Output only. The person's age ranges."
},
"memberships": {
"items": {
"$ref": "Membership"
},
"description": "The person's group memberships.",
"type": "array"
},
"relationshipStatuses": {
"items": {
"$ref": "RelationshipStatus"
},
"description": "Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.",
"type": "array",
"readOnly": true
},
"emailAddresses": {
"description": "The person's email addresses.",
"type": "array",
"items": {
"$ref": "EmailAddress"
}
},
"locations": {
"items": {
"$ref": "Location"
},
"description": "The person's locations.",
"type": "array"
},
"taglines": {
"type": "array",
"items": {
"$ref": "Tagline"
},
"description": "Output only. **DEPRECATED**: No data will be returned The person's taglines.",
"readOnly": true
},
"residences": {
"type": "array",
"items": {
"$ref": "Residence"
},
"description": "**DEPRECATED**: (Please use `person.locations` instead) The person's residences."
},
"relationshipInterests": {
"readOnly": true,
"items": {
"$ref": "RelationshipInterest"
},
"description": "Output only. **DEPRECATED**: No data will be returned The person's relationship interests.",
"type": "array"
},
"relations": {
"items": {
"$ref": "Relation"
},
"type": "array",
"description": "The person's relations."
},
"interests": {
"items": {
"$ref": "Interest"
},
"type": "array",
"description": "The person's interests."
},
"coverPhotos": {
"description": "Output only. The person's cover photos.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "CoverPhoto"
}
},
"etag": {
"type": "string",
"description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation."
}
},
"description": "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.",
"type": "object"
},
"UserDefined": {
"id": "UserDefined",
"type": "object",
"description": "Arbitrary user data that is populated by the end users.",
"properties": {
"key": {
"description": "The end user specified key of the user defined data.",
"type": "string"
},
"value": {
"description": "The end user specified value of the user defined data.",
"type": "string"
},
"metadata": {
"description": "Metadata about the user defined data.",
"$ref": "FieldMetadata"
}
}
},
"Address": {
"type": "object",
"description": "A person's physical address. May be a P.O. box or street address. All fields are optional.",
"properties": {
"formattedType": {
"description": "Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"readOnly": true,
"type": "string"
},
"streetAddress": {
"type": "string",
"description": "The street address."
},
"countryCode": {
"description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the address."
},
"city": {
"type": "string",
"description": "The city of the address."
},
"extendedAddress": {
"description": "The extended address of the address; for example, the apartment number.",
"type": "string"
},
"country": {
"type": "string",
"description": "The country of the address."
},
"postalCode": {
"type": "string",
"description": "The postal code of the address."
},
"poBox": {
"type": "string",
"description": "The P.O. box of the address."
},
"type": {
"description": "The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`",
"type": "string"
},
"region": {
"description": "The region of the address; for example, the state or province.",
"type": "string"
},
"formattedValue": {
"description": "The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.",
"type": "string"
}
},
"id": "Address"
},
"ContactGroupResponse": {
"type": "object",
"description": "The response for a specific contact group.",
"properties": {
"requestedResourceName": {
"type": "string",
"description": "The original requested resource name."
},
"contactGroup": {
"$ref": "ContactGroup",
"description": "The contact group."
},
"status": {
"description": "The status of the response.",
"$ref": "Status"
}
},
"id": "ContactGroupResponse"
},
"Organization": {
"description": "A person's past or current organization. Overlapping date ranges are permitted.",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the organization."
},
"current": {
"description": "True if the organization is the person's current organization; false if the organization is a past organization.",
"type": "boolean"
},
"jobDescription": {
"type": "string",
"description": "The person's job description at the organization."
},
"location": {
"description": "The location of the organization office the person works at.",
"type": "string"
},
"department": {
"description": "The person's department at the organization.",
"type": "string"
},
"title": {
"type": "string",
"description": "The person's job title at the organization."
},
"formattedType": {
"type": "string",
"description": "Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"readOnly": true
},
"phoneticName": {
"description": "The phonetic name of the organization.",
"type": "string"
},
"name": {
"description": "The name of the organization.",
"type": "string"
},
"symbol": {
"type": "string",
"description": "The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym."
},
"endDate": {
"description": "The end date when the person left the organization.",
"$ref": "Date"
},
"startDate": {
"$ref": "Date",
"description": "The start date when the person joined the organization."
},
"type": {
"type": "string",
"description": "The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`"
},
"domain": {
"type": "string",
"description": "The domain name associated with the organization; for example, `google.com`."
}
},
"type": "object",
"id": "Organization"
},
"CalendarUrl": {
"properties": {
"url": {
"type": "string",
"description": "The calendar URL."
},
"type": {
"description": "The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the calendar URL."
},
"formattedType": {
"readOnly": true,
"description": "Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
}
},
"id": "CalendarUrl",
"description": "A person's calendar URL.",
"type": "object"
},
"Name": {
"properties": {
"unstructuredName": {
"description": "The free form name value.",
"type": "string"
},
"displayName": {
"type": "string",
"description": "Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.",
"readOnly": true
},
"givenName": {
"description": "The given name.",
"type": "string"
},
"metadata": {
"description": "Metadata about the name.",
"$ref": "FieldMetadata"
},
"phoneticHonorificPrefix": {
"type": "string",
"description": "The honorific prefixes spelled as they sound."
},
"honorificSuffix": {
"description": "The honorific suffixes, such as `Jr.`",
"type": "string"
},
"phoneticGivenName": {
"description": "The given name spelled as it sounds.",
"type": "string"
},
"phoneticFullName": {
"description": "The full name spelled as it sounds.",
"type": "string"
},
"honorificPrefix": {
"type": "string",
"description": "The honorific prefixes, such as `Mrs.` or `Dr.`"
},
"displayNameLastFirst": {
"description": "Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.",
"type": "string",
"readOnly": true
},
"phoneticHonorificSuffix": {
"description": "The honorific suffixes spelled as they sound.",
"type": "string"
},
"phoneticFamilyName": {
"description": "The family name spelled as it sounds.",
"type": "string"
},
"phoneticMiddleName": {
"description": "The middle name(s) spelled as they sound.",
"type": "string"
},
"middleName": {
"type": "string",
"description": "The middle name(s)."
},
"familyName": {
"description": "The family name.",
"type": "string"
}
},
"id": "Name",
"description": "A person's name. If the name is a mononym, the family name is empty.",
"type": "object"
},
"ListContactGroupsResponse": {
"properties": {
"nextSyncToken": {
"type": "string",
"description": "The token that can be used to retrieve changes since the last request."
},
"nextPageToken": {
"type": "string",
"description": "The token that can be used to retrieve the next page of results."
},
"totalItems": {
"format": "int32",
"description": "The total number of items in the list without pagination.",
"type": "integer"
},
"contactGroups": {
"description": "The list of contact groups. Members of the contact groups are not populated.",
"items": {
"$ref": "ContactGroup"
},
"type": "array"
}
},
"type": "object",
"description": "The response to a list contact groups request.",
"id": "ListContactGroupsResponse"
},
"SipAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the SIP address. The type can be custom or or one of these predefined values: * `home` * `work` * `mobile` * `other`"
},
"formattedType": {
"readOnly": true,
"type": "string",
"description": "Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale."
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the SIP address."
},
"value": {
"description": "The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.",
"type": "string"
}
},
"id": "SipAddress",
"description": "A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet."
},
"FieldMetadata": {
"properties": {
"primary": {
"description": "True if the field is the primary field; false if the field is a secondary field.",
"type": "boolean"
},
"verified": {
"description": "Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.",
"readOnly": true,
"type": "boolean"
},
"source": {
"description": "The source of the field.",
"$ref": "Source"
}
},
"description": "Metadata about a field.",
"id": "FieldMetadata",
"type": "object"
},
"DomainMembership": {
"id": "DomainMembership",
"properties": {
"inViewerDomain": {
"description": "True if the person is in the viewer's G Suite domain.",
"type": "boolean"
}
},
"description": "A G Suite Domain membership.",
"type": "object"
},
"Skill": {
"type": "object",
"properties": {
"metadata": {
"description": "Metadata about the skill.",
"$ref": "FieldMetadata"
},
"value": {
"description": "The skill; for example, `underwater basket weaving`.",
"type": "string"
}
},
"id": "Skill",
"description": "A skill that the person has."
},
"GroupClientData": {
"id": "GroupClientData",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The client specified key of the client data."
},
"value": {
"description": "The client specified value of the client data.",
"type": "string"
}
},
"description": "Arbitrary client data that is populated by clients. Duplicate keys and values are allowed."
},
"Biography": {
"properties": {
"contentType": {
"enumDescriptions": [
"Unspecified.",
"Plain text.",
"HTML text."
],
"type": "string",
"description": "The content type of the biography.",
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"TEXT_PLAIN",
"TEXT_HTML"
]
},
"value": {
"type": "string",
"description": "The short biography."
},
"metadata": {
"description": "Metadata about the biography.",
"$ref": "FieldMetadata"
}
},
"type": "object",
"id": "Biography",
"description": "A person's short biography."
},
"CopyOtherContactToMyContactsGroupRequest": {
"id": "CopyOtherContactToMyContactsGroupRequest",
"description": "A request to copy an \"Other contact\" to my contacts group.",
"type": "object",
"properties": {
"sources": {
"items": {
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
]
},
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"type": "array"
},
"copyMask": {
"type": "string",
"description": "Required. A field mask to restrict which fields are copied into the new contact. Valid values are: * emailAddresses * names * phoneNumbers",
"format": "google-fieldmask"
},
"readMask": {
"type": "string",
"description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to the copy mask with metadata and membership fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"format": "google-fieldmask"
}
}
},
"BraggingRights": {
"properties": {
"metadata": {
"description": "Metadata about the bragging rights.",
"$ref": "FieldMetadata"
},
"value": {
"description": "The bragging rights; for example, `climbed mount everest`.",
"type": "string"
}
},
"id": "BraggingRights",
"type": "object",
"description": "**DEPRECATED**: No data will be returned A person's bragging rights."
},
"Birthday": {
"type": "object",
"properties": {
"metadata": {
"description": "Metadata about the birthday.",
"$ref": "FieldMetadata"
},
"text": {
"description": "A free-form string representing the user's birthday.",
"type": "string"
},
"date": {
"description": "The date of the birthday.",
"$ref": "Date"
}
},
"description": "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.",
"id": "Birthday"
},
"FileAs": {
"description": "The name that should be used to sort the person in a list.",
"id": "FileAs",
"type": "object",
"properties": {
"value": {
"description": "The file-as value",
"type": "string"
},
"metadata": {
"description": "Metadata about the file-as.",
"$ref": "FieldMetadata"
}
}
},
"Occupation": {
"description": "A person's occupation.",
"id": "Occupation",
"type": "object",
"properties": {
"value": {
"description": "The occupation; for example, `carpenter`.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the occupation."
}
}
},
"Status": {
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
}
},
"code": {
"type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32"
},
"message": {
"type": "string",
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."
}
},
"type": "object",
"id": "Status",
"description": "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](https://github.com/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](https://cloud.google.com/apis/design/errors)."
},
"MiscKeyword": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the miscellaneous keyword."
},
"formattedType": {
"type": "string",
"readOnly": true,
"description": "Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale."
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the miscellaneous keyword."
},
"type": {
"enum": [
"TYPE_UNSPECIFIED",
"OUTLOOK_BILLING_INFORMATION",
"OUTLOOK_DIRECTORY_SERVER",
"OUTLOOK_KEYWORD",
"OUTLOOK_MILEAGE",
"OUTLOOK_PRIORITY",
"OUTLOOK_SENSITIVITY",
"OUTLOOK_SUBJECT",
"OUTLOOK_USER",
"HOME",
"WORK",
"OTHER"
],
"enumDescriptions": [
"Unspecified.",
"Outlook field for billing information.",
"Outlook field for directory server.",
"Outlook field for keyword.",
"Outlook field for mileage.",
"Outlook field for priority.",
"Outlook field for sensitivity.",
"Outlook field for subject.",
"Outlook field for user.",
"Home.",
"Work.",
"Other."
],
"description": "The miscellaneous keyword type.",
"type": "string"
}
},
"id": "MiscKeyword",
"description": "A person's miscellaneous keyword."
},
"CreateContactGroupRequest": {
"properties": {
"contactGroup": {
"description": "Required. The contact group to create.",
"$ref": "ContactGroup"
},
"readGroupFields": {
"description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name",
"type": "string",
"format": "google-fieldmask"
}
},
"id": "CreateContactGroupRequest",
"description": "A request to create a new contact group.",
"type": "object"
},
"PhoneNumber": {
"type": "object",
"description": "A person's phone number.",
"properties": {
"canonicalForm": {
"description": "Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.",
"readOnly": true,
"type": "string"
},
"formattedType": {
"readOnly": true,
"description": "Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"type": {
"description": "The type of the phone number. The type can be custom or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`",
"type": "string"
},
"value": {
"description": "The phone number.",
"type": "string"
},
"metadata": {
"description": "Metadata about the phone number.",
"$ref": "FieldMetadata"
}
},
"id": "PhoneNumber"
},
"BatchUpdateContactsRequest": {
"properties": {
"contacts": {
"type": "object",
"description": "Required. A map of resource names to the person data to be updated. Allows up to 200 contacts in a single request.",
"additionalProperties": {
"$ref": "Person"
}
},
"updateMask": {
"type": "string",
"description": "Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All specified fields will be replaced, or cleared if left empty for each person. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined",
"format": "google-fieldmask"
},
"readMask": {
"type": "string",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"format": "google-fieldmask"
},
"sources": {
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"items": {
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
]
},
"type": "array"
}
},
"id": "BatchUpdateContactsRequest",
"description": "A request to update a batch of contacts.",
"type": "object"
},
"EmailAddress": {
"description": "A person's email address.",
"properties": {
"value": {
"description": "The email address.",
"type": "string"
},
"type": {
"description": "The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`",
"type": "string"
},
"metadata": {
"description": "Metadata about the email address.",
"$ref": "FieldMetadata"
},
"formattedType": {
"description": "Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string",
"readOnly": true
},
"displayName": {
"type": "string",
"description": "The display name of the email."
}
},
"type": "object",
"id": "EmailAddress"
},
"UpdateContactPhotoResponse": {
"id": "UpdateContactPhotoResponse",
"properties": {
"person": {
"description": "The updated person, if person_fields is set in the UpdateContactPhotoRequest; otherwise this will be unset.",
"$ref": "Person"
}
},
"type": "object",
"description": "The response for updating a contact's photo."
},
"ListDirectoryPeopleResponse": {
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"nextSyncToken": {
"description": "A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.",
"type": "string"
},
"people": {
"items": {
"$ref": "Person"
},
"description": "The list of people in the domain directory.",
"type": "array"
}
},
"id": "ListDirectoryPeopleResponse",
"description": "The response to a request for the authenticated user's domain directory.",
"type": "object"
},
"PersonMetadata": {
"properties": {
"deleted": {
"readOnly": true,
"type": "boolean",
"description": "Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token."
},
"linkedPeopleResourceNames": {
"items": {
"type": "string"
},
"description": "Output only. Resource names of people linked to this resource.",
"readOnly": true,
"type": "array"
},
"objectType": {
"description": "Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.",
"enumDescriptions": [
"Unspecified.",
"Person.",
"[Currents Page.](https://gsuite.google.com/products/currents/)"
],
"readOnly": true,
"type": "string",
"enum": [
"OBJECT_TYPE_UNSPECIFIED",
"PERSON",
"PAGE"
]
},
"previousResourceNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.",
"readOnly": true
},
"sources": {
"type": "array",
"description": "The sources of data for the person.",
"items": {
"$ref": "Source"
}
}
},
"id": "PersonMetadata",
"type": "object",
"description": "The metadata about a person."
},
"Source": {
"type": "object",
"description": "The source of a field.",
"properties": {
"etag": {
"description": "**Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.",
"type": "string"
},
"id": {
"description": "The unique identifier within the source type generated by the server.",
"type": "string"
},
"profileMetadata": {
"$ref": "ProfileMetadata",
"readOnly": true,
"description": "Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE."
},
"updateTime": {
"type": "string",
"format": "google-datetime",
"readOnly": true,
"description": "Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source."
},
"type": {
"enum": [
"SOURCE_TYPE_UNSPECIFIED",
"ACCOUNT",
"PROFILE",
"DOMAIN_PROFILE",
"CONTACT",
"OTHER_CONTACT",
"DOMAIN_CONTACT"
],
"type": "string",
"description": "The source type.",
"enumDescriptions": [
"Unspecified.",
"[Google Account](https://accounts.google.com).",
"[Google profile](https://profiles.google.com). You can view the profile at [https://profiles.google.com/](https://profiles.google.com/){id}, where {id} is the source id.",
"[G Suite domain profile](https://support.google.com/a/answer/1628008).",
"[Google contact](https://contacts.google.com). You can view the contact at [https://contact.google.com/](https://contact.google.com/){id}, where {id} is the source id.",
"[Google \"Other contact\"](https://contacts.google.com/other).",
"[G Suite domain shared contact](https://support.google.com/a/answer/9281635)."
]
}
},
"id": "Source"
},
"Url": {
"description": "A person's associated URLs.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other`"
},
"formattedType": {
"readOnly": true,
"type": "string",
"description": "Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale."
},
"metadata": {
"description": "Metadata about the URL.",
"$ref": "FieldMetadata"
},
"value": {
"description": "The URL.",
"type": "string"
}
},
"id": "Url"
},
"ContactGroupMetadata": {
"description": "The metadata about a contact group.",
"id": "ContactGroupMetadata",
"type": "object",
"properties": {
"deleted": {
"description": "Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.",
"type": "boolean",
"readOnly": true
},
"updateTime": {
"readOnly": true,
"description": "Output only. The time the group was last updated.",
"format": "google-datetime",
"type": "string"
}
}
},
"Gender": {
"description": "A person's gender.",
"id": "Gender",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the gender."
},
"formattedValue": {
"type": "string",
"readOnly": true,
"description": "Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized."
},
"addressMeAs": {
"description": "The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`",
"type": "string"
},
"value": {
"type": "string",
"description": "The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`"
}
},
"type": "object"
},
"ImClient": {
"properties": {
"formattedProtocol": {
"description": "Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string",
"readOnly": true
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the IM client."
},
"protocol": {
"type": "string",
"description": "The protocol of the IM client. The protocol can be custom or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`"
},
"type": {
"description": "The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`",
"type": "string"
},
"formattedType": {
"type": "string",
"description": "Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
"readOnly": true
},
"username": {
"type": "string",
"description": "The user name used in the IM client."
}
},
"description": "A person's instant messaging client.",
"id": "ImClient",
"type": "object"
},
"Nickname": {
"properties": {
"value": {
"description": "The nickname.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the nickname."
},
"type": {
"enumDescriptions": [
"Generic nickname.",
"Maiden name or birth family name. Used when the person's family name has changed as a result of marriage.",
"Initials.",
"Google+ profile nickname.",
"A professional affiliation or other name; for example, `Dr. Smith.`",
"Alternate name person is known by.",
"A shorter version of the person's name."
],
"type": "string",
"enum": [
"DEFAULT",
"MAIDEN_NAME",
"INITIALS",
"GPLUS",
"OTHER_NAME",
"ALTERNATE_NAME",
"SHORT_NAME"
],
"description": "The type of the nickname."
}
},
"description": "A person's nickname.",
"type": "object",
"id": "Nickname"
},
"BatchUpdateContactsResponse": {
"id": "BatchUpdateContactsResponse",
"description": "The response to a request to create a batch of contacts.",
"type": "object",
"properties": {
"updateResult": {
"description": "A map of resource names to the contacts that were updated, unless the request `read_mask` is empty.",
"type": "object",
"additionalProperties": {
"$ref": "PersonResponse"
}
}
}
},
"Photo": {
"description": "A person's photo. A picture shown next to the person's name to help others recognize the person.",
"type": "object",
"properties": {
"url": {
"description": "The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the photo."
},
"default": {
"type": "boolean",
"description": "True if the photo is a default photo; false if the photo is a user-provided photo."
}
},
"id": "Photo"
},
"Membership": {
"type": "object",
"description": "A person's membership in a group. Only contact group memberships can be modified.",
"id": "Membership",
"properties": {
"contactGroupMembership": {
"$ref": "ContactGroupMembership",
"description": "The contact group membership."
},
"domainMembership": {
"readOnly": true,
"description": "Output only. The domain membership.",
"$ref": "DomainMembership"
},
"metadata": {
"description": "Metadata about the membership.",
"$ref": "FieldMetadata"
}
}
},
"RelationshipInterest": {
"id": "RelationshipInterest",
"description": "**DEPRECATED**: No data will be returned A person's relationship interest .",
"type": "object",
"properties": {
"metadata": {
"description": "Metadata about the relationship interest.",
"$ref": "FieldMetadata"
},
"value": {
"description": "The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`",
"type": "string"
},
"formattedValue": {
"readOnly": true,
"description": "Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.",
"type": "string"
}
}
},
"ContactGroupMembership": {
"id": "ContactGroupMembership",
"type": "object",
"description": "A Google contact group membership.",
"properties": {
"contactGroupId": {
"readOnly": true,
"description": "Output only. The contact group ID for the contact group membership.",
"type": "string"
},
"contactGroupResourceName": {
"description": "The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or \"myContacts\" or \"starred\" system groups memberships can be added. A contact must always have at least one contact group membership.",
"type": "string"
}
}
},
"BatchGetContactGroupsResponse": {
"description": "The response to a batch get contact groups request.",
"type": "object",
"properties": {
"responses": {
"items": {
"$ref": "ContactGroupResponse"
},
"description": "The list of responses for each requested contact group resource.",
"type": "array"
}
},
"id": "BatchGetContactGroupsResponse"
},
"UpdateContactGroupRequest": {
"id": "UpdateContactGroupRequest",
"type": "object",
"description": "A request to update an existing user contact group. All updated fields will be replaced.",
"properties": {
"readGroupFields": {
"type": "string",
"description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name",
"format": "google-fieldmask"
},
"contactGroup": {
"description": "Required. The contact group to update.",
"$ref": "ContactGroup"
},
"updateGroupFields": {
"format": "google-fieldmask",
"type": "string",
"description": "Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name"
}
}
},
"Tagline": {
"description": "**DEPRECATED**: No data will be returned A brief one-line description of the person.",
"id": "Tagline",
"type": "object",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the tagline."
},
"value": {
"description": "The tagline.",
"type": "string"
}
}
},
"SearchResponse": {
"type": "object",
"description": "The response to a search request for the authenticated user, given a query.",
"id": "SearchResponse",
"properties": {
"results": {
"description": "The results of the request.",
"items": {
"$ref": "SearchResult"
},
"type": "array"
}
}
},
"SearchDirectoryPeopleResponse": {
"properties": {
"people": {
"items": {
"$ref": "Person"
},
"type": "array",
"description": "The list of people in the domain directory that match the query."
},
"nextPageToken": {
"type": "string",
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."
},
"totalSize": {
"description": "The total number of items in the list without pagination.",
"type": "integer",
"format": "int32"
}
},
"description": "The response to a request for people in the authenticated user's domain directory that match the specified query.",
"id": "SearchDirectoryPeopleResponse",
"type": "object"
},
"PersonResponse": {
"type": "object",
"id": "PersonResponse",
"description": "The response for a single person",
"properties": {
"status": {
"description": "The status of the response.",
"$ref": "Status"
},
"person": {
"description": "The person.",
"$ref": "Person"
},
"requestedResourceName": {
"type": "string",
"description": "The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL."
},
"httpStatusCode": {
"type": "integer",
"description": "**DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
"format": "int32"
}
}
},
"ContactToCreate": {
"id": "ContactToCreate",
"description": "A wrapper that contains the person data to populate a newly created source.",
"properties": {
"contactPerson": {
"description": "Required. The person data to populate a newly created source.",
"$ref": "Person"
}
},
"type": "object"
},
"ContactGroup": {
"description": "A contact group.",
"id": "ContactGroup",
"properties": {
"groupType": {
"enumDescriptions": [
"Unspecified.",
"User defined contact group.",
"System defined contact group."
],
"description": "Output only. The contact group type.",
"type": "string",
"readOnly": true,
"enum": [
"GROUP_TYPE_UNSPECIFIED",
"USER_CONTACT_GROUP",
"SYSTEM_CONTACT_GROUP"
]
},
"formattedName": {
"readOnly": true,
"type": "string",
"description": "Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name."
},
"metadata": {
"$ref": "ContactGroupMetadata",
"description": "Output only. Metadata about the contact group.",
"readOnly": true
},
"clientData": {
"type": "array",
"items": {
"$ref": "GroupClientData"
},
"description": "The group's client data."
},
"etag": {
"type": "string",
"description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation."
},
"resourceName": {
"description": "The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.",
"type": "string"
},
"memberCount": {
"format": "int32",
"description": "Output only. The total number of contacts in the group irrespective of max members in specified in the request.",
"type": "integer",
"readOnly": true
},
"name": {
"description": "The contact group name set by the group owner or a system provided name for system groups.",
"type": "string"
},
"memberResourceNames": {
"readOnly": true,
"items": {
"type": "string"
},
"description": "Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.",
"type": "array"
}
},
"type": "object"
},
"ListOtherContactsResponse": {
"properties": {
"nextSyncToken": {
"type": "string",
"description": "A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token."
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"otherContacts": {
"items": {
"$ref": "Person"
},
"type": "array",
"description": "The list of \"Other contacts\" returned as Person resources. \"Other contacts\" support a limited subset of fields. See ListOtherContactsRequest.request_mask for more detailed information."
}
},
"type": "object",
"description": "The response to a request for the authenticated user's \"Other contacts\".",
"id": "ListOtherContactsResponse"
},
"ClientData": {
"id": "ClientData",
"properties": {
"value": {
"type": "string",
"description": "The client specified value of the client data."
},
"metadata": {
"description": "Metadata about the client data.",
"$ref": "FieldMetadata"
},
"key": {
"description": "The client specified key of the client data.",
"type": "string"
}
},
"type": "object",
"description": "Arbitrary client data that is populated by clients. Duplicate keys and values are allowed."
},
"Event": {
"id": "Event",
"type": "object",
"properties": {
"date": {
"$ref": "Date",
"description": "The date of the event."
},
"type": {
"description": "The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`",
"type": "string"
},
"formattedType": {
"type": "string",
"readOnly": true,
"description": "Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale."
},
"metadata": {
"description": "Metadata about the event.",
"$ref": "FieldMetadata"
}
},
"description": "An event related to the person."
},
"BatchDeleteContactsRequest": {
"type": "object",
"id": "BatchDeleteContactsRequest",
"description": "A request to delete a batch of existing contacts.",
"properties": {
"resourceNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "Required. The resource names of the contact to delete. It's repeatable. Allows up to 500 resource names in a single request."
}
}
},
"AgeRangeType": {
"description": "A person's age range.",
"id": "AgeRangeType",
"type": "object",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the age range."
},
"ageRange": {
"type": "string",
"enumDescriptions": [
"Unspecified.",
"Younger than eighteen.",
"Between eighteen and twenty.",
"Twenty-one and older."
],
"description": "The age range.",
"enum": [
"AGE_RANGE_UNSPECIFIED",
"LESS_THAN_EIGHTEEN",
"EIGHTEEN_TO_TWENTY",
"TWENTY_ONE_OR_OLDER"
]
}
}
},
"Interest": {
"type": "object",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the interest."
},
"value": {
"type": "string",
"description": "The interest; for example, `stargazing`."
}
},
"id": "Interest",
"description": "One of the person's interests."
},
"GetPeopleResponse": {
"description": "The response to a get request for a list of people by resource name.",
"type": "object",
"properties": {
"responses": {
"items": {
"$ref": "PersonResponse"
},
"type": "array",
"description": "The response for each requested resource name."
}
},
"id": "GetPeopleResponse"
},
"Relation": {
"type": "object",
"properties": {
"type": {
"description": "The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`",
"type": "string"
},
"metadata": {
"description": "Metadata about the relation.",
"$ref": "FieldMetadata"
},
"person": {
"description": "The name of the other person this relation refers to.",
"type": "string"
},
"formattedType": {
"description": "Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.",
"type": "string",
"readOnly": true
}
},
"description": "A person's relation to another person.",
"id": "Relation"
},
"Date": {
"properties": {
"month": {
"type": "integer",
"format": "int32",
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day."
},
"year": {
"type": "integer",
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32"
},
"day": {
"type": "integer",
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32"
}
},
"type": "object",
"description": "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"id": "Date"
},
"BatchCreateContactsRequest": {
"type": "object",
"id": "BatchCreateContactsRequest",
"description": "A request to create a batch of contacts.",
"properties": {
"readMask": {
"description": "Required. A field mask to restrict which fields on each person are returned in the response. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"type": "string",
"format": "google-fieldmask"
},
"sources": {
"type": "array",
"items": {
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
]
},
"description": "Optional. A mask of what source types to return in the post mutate read. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set."
},
"contacts": {
"type": "array",
"description": "Required. The contact to create. Allows up to 200 contacts in a single request.",
"items": {
"$ref": "ContactToCreate"
}
}
}
},
"Residence": {
"type": "object",
"id": "Residence",
"description": "**DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.",
"properties": {
"value": {
"type": "string",
"description": "The address of the residence."
},
"current": {
"description": "True if the residence is the person's current residence; false if the residence is a past residence.",
"type": "boolean"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the residence."
}
}
},
"SearchResult": {
"properties": {
"person": {
"description": "The matched Person.",
"$ref": "Person"
}
},
"id": "SearchResult",
"description": "A result of a search query.",
"type": "object"
},
"ListConnectionsResponse": {
"id": "ListConnectionsResponse",
"type": "object",
"properties": {
"totalPeople": {
"format": "int32",
"type": "integer",
"description": "**DEPRECATED** (Please use totalItems) The total number of people in the list without pagination."
},
"nextSyncToken": {
"type": "string",
"description": "A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token. When the response is paginated, only the last page will contain `nextSyncToken`."
},
"connections": {
"type": "array",
"description": "The list of people that the requestor is connected to.",
"items": {
"$ref": "Person"
}
},
"nextPageToken": {
"type": "string",
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."
},
"totalItems": {
"description": "The total number of items in the list without pagination.",
"type": "integer",
"format": "int32"
}
},
"description": "The response to a request for the authenticated user's connections."
},
"ProfileMetadata": {
"properties": {
"userTypes": {
"readOnly": true,
"description": "Output only. The user types.",
"items": {
"type": "string",
"enum": [
"USER_TYPE_UNKNOWN",
"GOOGLE_USER",
"GPLUS_USER",
"GOOGLE_APPS_USER"
],
"enumDescriptions": [
"The user type is not known.",
"The user is a Google user.",
"The user is a Currents user.",
"The user is a G Suite user."
]
},
"type": "array"
},
"objectType": {
"readOnly": true,
"enumDescriptions": [
"Unspecified.",
"Person.",
"[Currents Page.](https://gsuite.google.com/products/currents/)"
],
"description": "Output only. The profile object type.",
"type": "string",
"enum": [
"OBJECT_TYPE_UNSPECIFIED",
"PERSON",
"PAGE"
]
}
},
"id": "ProfileMetadata",
"type": "object",
"description": "The metadata about a profile."
},
"Location": {
"properties": {
"buildingId": {
"type": "string",
"description": "The building identifier."
},
"floorSection": {
"description": "The floor section in `floor_name`.",
"type": "string"
},
"current": {
"description": "Whether the location is the current location.",
"type": "boolean"
},
"floor": {
"description": "The floor name or number.",
"type": "string"
},
"value": {
"description": "The free-form value of the location.",
"type": "string"
},
"type": {
"description": "The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`",
"type": "string"
},
"deskCode": {
"type": "string",
"description": "The individual desk location."
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the location."
}
},
"id": "Location",
"description": "A person's location.",
"type": "object"
},
"CoverPhoto": {
"id": "CoverPhoto",
"type": "object",
"properties": {
"default": {
"description": "True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.",
"type": "boolean"
},
"url": {
"description": "The URL of the cover photo.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the cover photo."
}
},
"description": "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."
},
"ModifyContactGroupMembersRequest": {
"description": "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.",
"properties": {
"resourceNamesToAdd": {
"description": "Optional. The resource names of the contact people to add in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.",
"type": "array",
"items": {
"type": "string"
}
},
"resourceNamesToRemove": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. The resource names of the contact people to remove in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000."
}
},
"id": "ModifyContactGroupMembersRequest",
"type": "object"
},
"ModifyContactGroupMembersResponse": {
"type": "object",
"properties": {
"notFoundResourceNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The contact people resource names that were not found."
},
"canNotRemoveLastContactGroupResourceNames": {
"type": "array",
"description": "The contact people resource names that cannot be removed from their last contact group.",
"items": {
"type": "string"
}
}
},
"description": "The response to a modify contact group members request.",
"id": "ModifyContactGroupMembersResponse"
},
"Locale": {
"id": "Locale",
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale."
},
"metadata": {
"description": "Metadata about the locale.",
"$ref": "FieldMetadata"
}
},
"description": "A person's locale preference."
},
"UpdateContactPhotoRequest": {
"id": "UpdateContactPhotoRequest",
"type": "object",
"properties": {
"sources": {
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"type": "array",
"items": {
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
],
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string"
}
},
"photoBytes": {
"format": "byte",
"type": "string",
"description": "Required. Raw photo bytes"
},
"personFields": {
"description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"type": "string",
"format": "google-fieldmask"
}
},
"description": "A request to update an existing contact's photo. All requests must have a valid photo format: JPEG or PNG."
},
"DeleteContactPhotoResponse": {
"properties": {
"person": {
"$ref": "Person",
"description": "The updated person, if person_fields is set in the DeleteContactPhotoRequest; otherwise this will be unset."
}
},
"id": "DeleteContactPhotoResponse",
"type": "object",
"description": "The response for deleting a contact's photo."
},
"BatchCreateContactsResponse": {
"description": "The response to a request to create a batch of contacts.",
"properties": {
"createdPeople": {
"type": "array",
"items": {
"$ref": "PersonResponse"
},
"description": "The contacts that were created, unless the request `read_mask` is empty."
}
},
"id": "BatchCreateContactsResponse",
"type": "object"
}
},
"rootUrl": "https://people.googleapis.com/",
"batchPath": "batch",
"basePath": "",
"description": "Provides access to information about profiles and contacts.",
"documentationLink": "https://developers.google.com/people/",
"protocol": "rest",
"revision": "20210330",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/user.birthday.read": {
"description": "See and download your exact date of birth"
},
"https://www.googleapis.com/auth/userinfo.email": {
"description": "See your primary Google Account email address"
},
"https://www.googleapis.com/auth/user.emails.read": {
"description": "See and download all of your Google Account email addresses"
},
"https://www.googleapis.com/auth/user.gender.read": {
"description": "See your gender"
},
"https://www.googleapis.com/auth/directory.readonly": {
"description": "See and download your organization's GSuite directory"
},
"https://www.googleapis.com/auth/user.phonenumbers.read": {
"description": "See and download your personal phone numbers"
},
"https://www.googleapis.com/auth/contacts.other.readonly": {
"description": "See and download contact info automatically saved in your \"Other contacts\""
},
"https://www.googleapis.com/auth/userinfo.profile": {
"description": "See your personal info, including any personal info you've made publicly available"
},
"https://www.googleapis.com/auth/contacts": {
"description": "See, edit, download, and permanently delete your contacts"
},
"https://www.googleapis.com/auth/user.addresses.read": {
"description": "View your street addresses"
},
"https://www.googleapis.com/auth/contacts.readonly": {
"description": "See and download your contacts"
},
"https://www.googleapis.com/auth/user.organization.read": {
"description": "See your education, work history and org info"
}
}
}
},
"title": "People API",
"ownerDomain": "google.com",
"kind": "discovery#restDescription",
"discoveryVersion": "v1",
"servicePath": "",
"version": "v1",
"resources": {
"contactGroups": {
"methods": {
"delete": {
"response": {
"$ref": "Empty"
},
"description": "Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.",
"path": "v1/{+resourceName}",
"parameterOrder": [
"resourceName"
],
"parameters": {
"deleteContacts": {
"location": "query",
"type": "boolean",
"description": "Optional. Set to true to also delete the contacts in the specified group."
},
"resourceName": {
"pattern": "^contactGroups/[^/]+$",
"type": "string",
"description": "Required. The resource name of the contact group to delete.",
"location": "path",
"required": true
}
},
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"flatPath": "v1/contactGroups/{contactGroupsId}",
"id": "people.contactGroups.delete"
},
"list": {
"description": "List all contact groups owned by the authenticated user. Members of the contact groups are not populated.",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.",
"location": "query",
"format": "int32",
"type": "integer"
},
"groupFields": {
"type": "string",
"format": "google-fieldmask",
"description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name",
"location": "query"
},
"syncToken": {
"type": "string",
"location": "query",
"description": "Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned."
},
"pageToken": {
"type": "string",
"description": "Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.",
"location": "query"
}
},
"parameterOrder": [],
"httpMethod": "GET",
"id": "people.contactGroups.list",
"flatPath": "v1/contactGroups",
"response": {
"$ref": "ListContactGroupsResponse"
},
"path": "v1/contactGroups"
},
"get": {
"id": "people.contactGroups.get",
"response": {
"$ref": "ContactGroup"
},
"parameters": {
"resourceName": {
"location": "path",
"type": "string",
"description": "Required. The resource name of the contact group to get.",
"pattern": "^contactGroups/[^/]+$",
"required": true
},
"groupFields": {
"location": "query",
"format": "google-fieldmask",
"description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name",
"type": "string"
},
"maxMembers": {
"format": "int32",
"type": "integer",
"description": "Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.",
"location": "query"
}
},
"flatPath": "v1/contactGroups/{contactGroupsId}",
"description": "Get a specific contact group owned by the authenticated user by specifying a contact group resource name.",
"parameterOrder": [
"resourceName"
],
"path": "v1/{+resourceName}",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
],
"httpMethod": "GET"
},
"update": {
"parameters": {
"resourceName": {
"type": "string",
"description": "The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.",
"pattern": "^contactGroups/[^/]+$",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"flatPath": "v1/contactGroups/{contactGroupsId}",
"request": {
"$ref": "UpdateContactGroupRequest"
},
"id": "people.contactGroups.update",
"response": {
"$ref": "ContactGroup"
},
"parameterOrder": [
"resourceName"
],
"httpMethod": "PUT",
"description": "Update the name of an existing contact group owned by the authenticated user.",
"path": "v1/{+resourceName}"
},
"batchGet": {
"flatPath": "v1/contactGroups:batchGet",
"parameters": {
"groupFields": {
"location": "query",
"type": "string",
"description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name",
"format": "google-fieldmask"
},
"maxMembers": {
"location": "query",
"description": "Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.",
"type": "integer",
"format": "int32"
},
"resourceNames": {
"type": "string",
"repeated": true,
"location": "query",
"description": "Required. The resource names of the contact groups to get."
}
},
"response": {
"$ref": "BatchGetContactGroupsResponse"
},
"path": "v1/contactGroups:batchGet",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
],
"httpMethod": "GET",
"description": "Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.",
"id": "people.contactGroups.batchGet",
"parameterOrder": []
},
"create": {
"description": "Create a new contact group owned by the authenticated user.",
"id": "people.contactGroups.create",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"parameterOrder": [],
"request": {
"$ref": "CreateContactGroupRequest"
},
"flatPath": "v1/contactGroups",
"path": "v1/contactGroups",
"parameters": {},
"response": {
"$ref": "ContactGroup"
},
"httpMethod": "POST"
}
},
"resources": {
"members": {
"methods": {
"modify": {
"path": "v1/{+resourceName}/members:modify",
"id": "people.contactGroups.members.modify",
"httpMethod": "POST",
"response": {
"$ref": "ModifyContactGroupMembersResponse"
},
"description": "Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed.",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"pattern": "^contactGroups/[^/]+$",
"location": "path",
"required": true,
"type": "string",
"description": "Required. The resource name of the contact group to modify."
}
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"request": {
"$ref": "ModifyContactGroupMembersRequest"
},
"flatPath": "v1/contactGroups/{contactGroupsId}/members:modify"
}
}
}
}
},
"people": {
"resources": {
"connections": {
"methods": {
"list": {
"parameters": {
"sources": {
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"location": "query",
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string",
"repeated": true,
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
]
},
"pageToken": {
"location": "query",
"type": "string",
"description": "Optional. A page token, received from a previous `ListConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnections` must match the call that provided the page token."
},
"pageSize": {
"format": "int32",
"description": "Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.",
"location": "query",
"type": "integer"
},
"requestMask.includeField": {
"format": "google-fieldmask",
"location": "query",
"type": "string",
"description": "Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`."
},
"syncToken": {
"description": "Optional. A sync token, received from a previous `ListConnections` call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `ListConnections` except `page_size` and `page_token` must match the initial call that provided the sync token. Sync tokens expire after seven days, after which a full sync request without a `sync_token` should be made.",
"type": "string",
"location": "query"
},
"personFields": {
"location": "query",
"type": "string",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"format": "google-fieldmask"
},
"resourceName": {
"required": true,
"description": "Required. The resource name to return connections for. Only `people/me` is valid.",
"type": "string",
"pattern": "^people/[^/]+$",
"location": "path"
},
"sortOrder": {
"enumDescriptions": [
"Sort people by when they were changed; older entries first.",
"Sort people by when they were changed; newer entries first.",
"Sort people by first name.",
"Sort people by last name."
],
"location": "query",
"description": "Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.",
"enum": [
"LAST_MODIFIED_ASCENDING",
"LAST_MODIFIED_DESCENDING",
"FIRST_NAME_ASCENDING",
"LAST_NAME_ASCENDING"
],
"type": "string"
},
"requestSyncToken": {
"location": "query",
"description": "Optional. Whether the response should include `next_sync_token` on the last page, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial full sync requests that specify `request_sync_token` and do not specify `sync_token` have an additional rate limit per user. Each client should generally only be doing a full sync once every few days per user and so should not hit this limit.",
"type": "boolean"
}
},
"parameterOrder": [
"resourceName"
],
"httpMethod": "GET",
"response": {
"$ref": "ListConnectionsResponse"
},
"flatPath": "v1/people/{peopleId}/connections",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
],
"description": "Provides a list of the authenticated user's contacts. The request returns a 400 error if `personFields` is not specified. The request returns a 410 error if `sync_token` is specified and is expired. Sync tokens expire after 7 days to prevent data drift between clients and the server. To handle a sync token expired error, a request should be sent without `sync_token` to get all contacts.",
"id": "people.people.connections.list",
"path": "v1/{+resourceName}/connections"
}
}
}
},
"methods": {
"listDirectoryPeople": {
"id": "people.people.listDirectoryPeople",
"parameters": {
"requestSyncToken": {
"type": "boolean",
"location": "query",
"description": "Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead."
},
"pageToken": {
"location": "query",
"description": "Optional. A page token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDirectoryPeople` must match the call that provided the page token.",
"type": "string"
},
"readMask": {
"location": "query",
"type": "string",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"format": "google-fieldmask"
},
"mergeSources": {
"repeated": true,
"location": "query",
"description": "Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.",
"enum": [
"DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED",
"DIRECTORY_MERGE_SOURCE_TYPE_CONTACT"
],
"enumDescriptions": [
"Unspecified.",
"User owned contact."
],
"type": "string"
},
"sources": {
"location": "query",
"description": "Required. Directory sources to return.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
"G Suite domain shared contact.",
"G Suite domain profile."
],
"repeated": true,
"enum": [
"DIRECTORY_SOURCE_TYPE_UNSPECIFIED",
"DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT",
"DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE"
]
},
"syncToken": {
"description": "Optional. A sync token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `ListDirectoryPeople` must match the call that provided the sync token.",
"location": "query",
"type": "string"
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0."
}
},
"path": "v1/people:listDirectoryPeople",
"response": {
"$ref": "ListDirectoryPeopleResponse"
},
"description": "Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.",
"flatPath": "v1/people:listDirectoryPeople",
"parameterOrder": [],
"scopes": [
"https://www.googleapis.com/auth/directory.readonly"
],
"httpMethod": "GET"
},
"batchCreateContacts": {
"httpMethod": "POST",
"parameterOrder": [],
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"flatPath": "v1/people:batchCreateContacts",
"id": "people.people.batchCreateContacts",
"request": {
"$ref": "BatchCreateContactsRequest"
},
"response": {
"$ref": "BatchCreateContactsResponse"
},
"description": "Create a batch of new contacts and return the PersonResponses for the newly created contacts. Limited to 10 parallel requests per user.",
"path": "v1/people:batchCreateContacts"
},
"updateContact": {
"request": {
"$ref": "Person"
},
"httpMethod": "PATCH",
"parameterOrder": [
"resourceName"
],
"id": "people.people.updateContact",
"description": "Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `\"failedPrecondition\"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names",
"response": {
"$ref": "Person"
},
"path": "v1/{+resourceName}:updateContact",
"flatPath": "v1/people/{peopleId}:updateContact",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"parameters": {
"sources": {
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"location": "query",
"repeated": true,
"type": "string",
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
]
},
"personFields": {
"format": "google-fieldmask",
"location": "query",
"description": "Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"type": "string"
},
"resourceName": {
"required": true,
"location": "path",
"description": "The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.",
"pattern": "^people/[^/]+$",
"type": "string"
},
"updatePersonFields": {
"description": "Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined",
"type": "string",
"location": "query",
"format": "google-fieldmask"
}
}
},
"batchDeleteContacts": {
"response": {
"$ref": "Empty"
},
"description": "Delete a batch of contacts. Any non-contact data will not be deleted. Limited to 10 parallel requests per user.",
"httpMethod": "POST",
"path": "v1/people:batchDeleteContacts",
"parameterOrder": [],
"flatPath": "v1/people:batchDeleteContacts",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"request": {
"$ref": "BatchDeleteContactsRequest"
},
"id": "people.people.batchDeleteContacts",
"parameters": {}
},
"searchDirectoryPeople": {
"flatPath": "v1/people:searchDirectoryPeople",
"description": "Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.",
"parameterOrder": [],
"id": "people.people.searchDirectoryPeople",
"path": "v1/people:searchDirectoryPeople",
"response": {
"$ref": "SearchDirectoryPeopleResponse"
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/directory.readonly"
],
"parameters": {
"sources": {
"description": "Required. Directory sources to return.",
"enumDescriptions": [
"Unspecified.",
"G Suite domain shared contact.",
"G Suite domain profile."
],
"repeated": true,
"location": "query",
"enum": [
"DIRECTORY_SOURCE_TYPE_UNSPECIFIED",
"DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT",
"DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE"
],
"type": "string"
},
"mergeSources": {
"enum": [
"DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED",
"DIRECTORY_MERGE_SOURCE_TYPE_CONTACT"
],
"location": "query",
"enumDescriptions": [
"Unspecified.",
"User owned contact."
],
"description": "Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.",
"type": "string",
"repeated": true
},
"pageToken": {
"description": "Optional. A page token, received from a previous `SearchDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the call that provided the page token.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"type": "integer",
"description": "Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.",
"format": "int32"
},
"readMask": {
"location": "query",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"type": "string",
"format": "google-fieldmask"
},
"query": {
"type": "string",
"location": "query",
"description": "Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match."
}
}
},
"searchContacts": {
"httpMethod": "GET",
"parameterOrder": [],
"flatPath": "v1/people:searchContacts",
"parameters": {
"readMask": {
"type": "string",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"format": "google-fieldmask",
"location": "query"
},
"pageSize": {
"format": "int32",
"location": "query",
"description": "Optional. The number of results to return.",
"type": "integer"
},
"query": {
"location": "query",
"description": "Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\".",
"type": "string"
}
},
"description": "Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT\" source.",
"id": "people.people.searchContacts",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
],
"response": {
"$ref": "SearchResponse"
},
"path": "v1/people:searchContacts"
},
"updateContactPhoto": {
"flatPath": "v1/people/{peopleId}:updateContactPhoto",
"parameterOrder": [
"resourceName"
],
"id": "people.people.updateContactPhoto",
"response": {
"$ref": "UpdateContactPhotoResponse"
},
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"parameters": {
"resourceName": {
"required": true,
"type": "string",
"pattern": "^people/[^/]+$",
"location": "path",
"description": "Required. Person resource name"
}
},
"description": "Update a contact's photo.",
"path": "v1/{+resourceName}:updateContactPhoto",
"request": {
"$ref": "UpdateContactPhotoRequest"
}
},
"batchUpdateContacts": {
"parameters": {},
"id": "people.people.batchUpdateContacts",
"description": "Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Limited to 10 parallel requests per user.",
"path": "v1/people:batchUpdateContacts",
"parameterOrder": [],
"httpMethod": "POST",
"request": {
"$ref": "BatchUpdateContactsRequest"
},
"flatPath": "v1/people:batchUpdateContacts",
"response": {
"$ref": "BatchUpdateContactsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
},
"deleteContactPhoto": {
"response": {
"$ref": "DeleteContactPhotoResponse"
},
"httpMethod": "DELETE",
"flatPath": "v1/people/{peopleId}:deleteContactPhoto",
"id": "people.people.deleteContactPhoto",
"description": "Delete a contact's photo.",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"parameters": {
"resourceName": {
"location": "path",
"required": true,
"type": "string",
"description": "Required. The resource name of the contact whose photo will be deleted.",
"pattern": "^people/[^/]+$"
},
"sources": {
"repeated": true,
"location": "query",
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
],
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string"
},
"personFields": {
"location": "query",
"type": "string",
"description": "Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"format": "google-fieldmask"
}
},
"path": "v1/{+resourceName}:deleteContactPhoto",
"parameterOrder": [
"resourceName"
]
},
"createContact": {
"path": "v1/people:createContact",
"parameterOrder": [],
"request": {
"$ref": "Person"
},
"flatPath": "v1/people:createContact",
"parameters": {
"sources": {
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"location": "query",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
],
"repeated": true,
"type": "string"
},
"personFields": {
"type": "string",
"format": "google-fieldmask",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"location": "query"
}
},
"response": {
"$ref": "Person"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"id": "people.people.createContact",
"description": "Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names"
},
"get": {
"id": "people.people.get",
"parameterOrder": [
"resourceName"
],
"description": "Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.",
"flatPath": "v1/people/{peopleId}",
"response": {
"$ref": "Person"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly",
"https://www.googleapis.com/auth/directory.readonly",
"https://www.googleapis.com/auth/user.addresses.read",
"https://www.googleapis.com/auth/user.birthday.read",
"https://www.googleapis.com/auth/user.emails.read",
"https://www.googleapis.com/auth/user.gender.read",
"https://www.googleapis.com/auth/user.organization.read",
"https://www.googleapis.com/auth/user.phonenumbers.read",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
],
"httpMethod": "GET",
"parameters": {
"sources": {
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
],
"repeated": true,
"location": "query",
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string"
},
"requestMask.includeField": {
"type": "string",
"format": "google-fieldmask",
"location": "query",
"description": "Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`."
},
"personFields": {
"format": "google-fieldmask",
"description": "Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"type": "string",
"location": "query"
},
"resourceName": {
"type": "string",
"required": true,
"pattern": "^people/[^/]+$",
"location": "path",
"description": "Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list)."
}
},
"path": "v1/{+resourceName}"
},
"getBatchGet": {
"flatPath": "v1/people:batchGet",
"parameters": {
"personFields": {
"location": "query",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined",
"type": "string",
"format": "google-fieldmask"
},
"sources": {
"location": "query",
"enumDescriptions": [
"Unspecified.",
"Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.",
"Returns SourceType.CONTACT.",
"Returns SourceType.DOMAIN_CONTACT."
],
"type": "string",
"description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.",
"enum": [
"READ_SOURCE_TYPE_UNSPECIFIED",
"READ_SOURCE_TYPE_PROFILE",
"READ_SOURCE_TYPE_CONTACT",
"READ_SOURCE_TYPE_DOMAIN_CONTACT"
],
"repeated": true
},
"resourceNames": {
"location": "query",
"type": "string",
"repeated": true,
"description": "Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=\u003cname1\u003e&resourceNames=\u003cname2\u003e&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request."
},
"requestMask.includeField": {
"type": "string",
"location": "query",
"format": "google-fieldmask",
"description": "Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`."
}
},
"path": "v1/people:batchGet",
"description": "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 returns a 400 error if 'personFields' is not specified.",
"parameterOrder": [],
"id": "people.people.getBatchGet",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly",
"https://www.googleapis.com/auth/directory.readonly",
"https://www.googleapis.com/auth/user.addresses.read",
"https://www.googleapis.com/auth/user.birthday.read",
"https://www.googleapis.com/auth/user.emails.read",
"https://www.googleapis.com/auth/user.gender.read",
"https://www.googleapis.com/auth/user.organization.read",
"https://www.googleapis.com/auth/user.phonenumbers.read",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
],
"response": {
"$ref": "GetPeopleResponse"
},
"httpMethod": "GET"
},
"deleteContact": {
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
"description": "Delete a contact person. Any non-contact data will not be deleted.",
"flatPath": "v1/people/{peopleId}:deleteContact",
"httpMethod": "DELETE",
"parameterOrder": [
"resourceName"
],
"path": "v1/{+resourceName}:deleteContact",
"response": {
"$ref": "Empty"
},
"id": "people.people.deleteContact",
"parameters": {
"resourceName": {
"pattern": "^people/[^/]+$",
"required": true,
"description": "Required. The resource name of the contact to delete.",
"type": "string",
"location": "path"
}
}
}
}
},
"otherContacts": {
"methods": {
"search": {
"id": "people.otherContacts.search",
"flatPath": "v1/otherContacts:search",
"parameterOrder": [],
"path": "v1/otherContacts:search",
"parameters": {
"readMask": {
"type": "string",
"location": "query",
"format": "google-fieldmask",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * names * phoneNumbers"
},
"query": {
"location": "query",
"type": "string",
"description": "Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name \"foo name\" matches queries such as \"f\", \"fo\", \"foo\", \"foo n\", \"nam\", etc., but not \"oo n\"."
},
"pageSize": {
"type": "integer",
"location": "query",
"description": "Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0.",
"format": "int32"
}
},
"httpMethod": "GET",
"description": "Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`, and `phoneNumbers` fields that are from the OTHER_CONTACT source.",
"response": {
"$ref": "SearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts.other.readonly"
]
},
"list": {
"httpMethod": "GET",
"flatPath": "v1/otherContacts",
"path": "v1/otherContacts",
"parameterOrder": [],
"scopes": [
"https://www.googleapis.com/auth/contacts.other.readonly"
],
"parameters": {
"readMask": {
"format": "google-fieldmask",
"location": "query",
"type": "string",
"description": "Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * emailAddresses * names * phoneNumbers"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Optional. A page token, received from a previous `ListOtherContacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOtherContacts` must match the call that provided the page token."
},
"requestSyncToken": {
"location": "query",
"type": "boolean",
"description": "Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit."
},
"syncToken": {
"type": "string",
"location": "query",
"description": "Optional. A sync token, received from a previous `ListOtherContacts` call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify `sync_token` have an additional rate limit. When syncing, all other parameters provided to `ListOtherContacts` must match the call that provided the sync token."
},
"pageSize": {
"description": "Optional. The number of \"Other contacts\" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"id": "people.otherContacts.list",
"description": "List all \"Other contacts\", that is contacts that are not in a contact group. \"Other contacts\" are typically auto created contacts from interactions.",
"response": {
"$ref": "ListOtherContactsResponse"
}
},
"copyOtherContactToMyContactsGroup": {
"request": {
"$ref": "CopyOtherContactToMyContactsGroupRequest"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.other.readonly"
],
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"required": true,
"description": "Required. The resource name of the \"Other contact\" to copy.",
"pattern": "^otherContacts/[^/]+$",
"location": "path",
"type": "string"
}
},
"description": "Copies an \"Other contact\" to a new contact in the user's \"myContacts\" group",
"flatPath": "v1/otherContacts/{otherContactsId}:copyOtherContactToMyContactsGroup",
"response": {
"$ref": "Person"
},
"httpMethod": "POST",
"path": "v1/{+resourceName}:copyOtherContactToMyContactsGroup",
"id": "people.otherContacts.copyOtherContactToMyContactsGroup"
}
}
}
},
"ownerName": "Google",
"parameters": {
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"uploadType": {
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"prettyPrint": {
"type": "boolean",
"default": "true",
"location": "query",
"description": "Returns response with indentations and line breaks."
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"type": "string",
"description": "V1 error format.",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"description": "Data format for response.",
"type": "string",
"default": "json",
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
]
}
},
"version_module": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"baseUrl": "https://people.googleapis.com/"
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy