luzifer/nginx-sso
1
0
Fork 0
mirror of https://github.com/Luzifer/nginx-sso.git synced 2024-12-25 15:21:16 +00:00
Code Issues Releases Wiki Activity
nginx-sso/vendor/google.golang.org/api/people/v1/people-api.json

2008 lines
77 KiB
JSON
Raw Normal View History

Update dependencies Signed-off-by: Knut Ahlers <knut@ahlers.me>
2019-04-21 17:58:15 +00:00
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/contacts": {
"description": "See, edit, download, and permanently delete your contacts"
},
"https://www.googleapis.com/auth/contacts.readonly": {
"description": "See and download your contacts"
},
"https://www.googleapis.com/auth/user.addresses.read": {
"description": "View your street addresses"
},
"https://www.googleapis.com/auth/user.birthday.read": {
"description": "View your complete date of birth"
},
"https://www.googleapis.com/auth/user.emails.read": {
"description": "View your email addresses"
},
"https://www.googleapis.com/auth/user.phonenumbers.read": {
"description": "View your phone numbers"
},
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
},
"https://www.googleapis.com/auth/userinfo.profile": {
"description": "See your personal info, including any personal info you've made publicly available"
}
}
}
},
"basePath": "",
"baseUrl": "https://people.googleapis.com/",
"batchPath": "batch",
"canonicalName": "People Service",
"description": "Provides access to information about profiles and contacts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/people/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "people:v1",
"kind": "discovery#restDescription",
"name": "people",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"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"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"contactGroups": {
"methods": {
"batchGet": {
"description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.",
"flatPath": "v1/contactGroups:batchGet",
"httpMethod": "GET",
"id": "people.contactGroups.batchGet",
"parameterOrder": [],
"parameters": {
"maxMembers": {
"description": "Specifies the maximum number of members to return for each group.",
"format": "int32",
"location": "query",
"type": "integer"
},
"resourceNames": {
"description": "The resource names of the contact groups to get.",
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "v1/contactGroups:batchGet",
"response": {
"$ref": "BatchGetContactGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
]
},
"create": {
"description": "Create a new contact group owned by the authenticated user.",
"flatPath": "v1/contactGroups",
"httpMethod": "POST",
"id": "people.contactGroups.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/contactGroups",
"request": {
"$ref": "CreateContactGroupRequest"
},
"response": {
"$ref": "ContactGroup"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
},
"delete": {
"description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
"flatPath": "v1/contactGroups/{contactGroupsId}",
"httpMethod": "DELETE",
"id": "people.contactGroups.delete",
"parameterOrder": [
"resourceName"
],
"parameters": {
"deleteContacts": {
"description": "Set to true to also delete the contacts in the specified group.",
"location": "query",
"type": "boolean"
},
"resourceName": {
"description": "The resource name of the contact group to delete.",
"location": "path",
"pattern": "^contactGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resourceName}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
},
"get": {
"description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
"flatPath": "v1/contactGroups/{contactGroupsId}",
"httpMethod": "GET",
"id": "people.contactGroups.get",
"parameterOrder": [
"resourceName"
],
"parameters": {
"maxMembers": {
"description": "Specifies the maximum number of members to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"resourceName": {
"description": "The resource name of the contact group to get.",
"location": "path",
"pattern": "^contactGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resourceName}",
"response": {
"$ref": "ContactGroup"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
]
},
"list": {
"description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
"flatPath": "v1/contactGroups",
"httpMethod": "GET",
"id": "people.contactGroups.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of resources to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.",
"location": "query",
"type": "string"
},
"syncToken": {
"description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v1/contactGroups",
"response": {
"$ref": "ListContactGroupsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
]
},
"update": {
"description": "Update the name of an existing contact group owned by the authenticated\nuser.",
"flatPath": "v1/contactGroups/{contactGroupsId}",
"httpMethod": "PUT",
"id": "people.contactGroups.update",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
"location": "path",
"pattern": "^contactGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resourceName}",
"request": {
"$ref": "UpdateContactGroupRequest"
},
"response": {
"$ref": "ContactGroup"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
}
},
"resources": {
"members": {
"methods": {
"modify": {
"description": "Modify the members of a contact group owned by the authenticated user.\n\u003cbr\u003e\nThe only system contact groups that can have members added are\n`contactGroups/myContacts` and `contactGroups/starred`. Other system\ncontact groups are deprecated and can only have contacts removed.",
"flatPath": "v1/contactGroups/{contactGroupsId}/members:modify",
"httpMethod": "POST",
"id": "people.contactGroups.members.modify",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "The resource name of the contact group to modify.",
"location": "path",
"pattern": "^contactGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resourceName}/members:modify",
"request": {
"$ref": "ModifyContactGroupMembersRequest"
},
"response": {
"$ref": "ModifyContactGroupMembersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
}
}
}
}
},
"people": {
"methods": {
"createContact": {
"description": "Create a new contact and return the person resource for that contact.",
"flatPath": "v1/people:createContact",
"httpMethod": "POST",
"id": "people.people.createContact",
"parameterOrder": [],
"parameters": {
"parent": {
"description": "The resource name of the owning person resource.",
"location": "query",
"type": "string"
}
},
"path": "v1/people:createContact",
"request": {
"$ref": "Person"
},
"response": {
"$ref": "Person"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
},
"deleteContact": {
"description": "Delete a contact person. Any non-contact data will not be deleted.",
"flatPath": "v1/people/{peopleId}:deleteContact",
"httpMethod": "DELETE",
"id": "people.people.deleteContact",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "The resource name of the contact to delete.",
"location": "path",
"pattern": "^people/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resourceName}:deleteContact",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
},
"get": {
"description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
"flatPath": "v1/people/{peopleId}",
"httpMethod": "GET",
"id": "people.people.get",
"parameterOrder": [
"resourceName"
],
"parameters": {
"personFields": {
"description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Multiple fields can be specified by separating them with commas.\nValid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* sipAddresses\n* skills\n* taglines\n* urls\n* userDefined",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"requestMask.includeField": {
"description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"resourceName": {
"description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).",
"location": "path",
"pattern": "^people/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resourceName}",
"response": {
"$ref": "Person"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.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.phonenumbers.read",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
]
},
"getBatchGet": {
"description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
"flatPath": "v1/people:batchGet",
"httpMethod": "GET",
"id": "people.people.getBatchGet",
"parameterOrder": [],
"parameters": {
"personFields": {
"description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Multiple fields can be specified by separating them with commas.\nValid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* sipAddresses\n* skills\n* taglines\n* urls\n* userDefined",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"requestMask.includeField": {
"description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"resourceNames": {
"description": "The resource names of the people to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up to 50 resource names in one request.",
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "v1/people:batchGet",
"response": {
"$ref": "GetPeopleResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.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.phonenumbers.read",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
]
},
"updateContact": {
"description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
"flatPath": "v1/people/{peopleId}:updateContact",
"httpMethod": "PATCH",
"id": "people.people.updateContact",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
"location": "path",
"pattern": "^people/[^/]+$",
"required": true,
"type": "string"
},
"updatePersonFields": {
"description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Multiple fields can be specified by separating them with commas.\nAll updated fields will be replaced. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* sipAddresses\n* urls\n* userDefined",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+resourceName}:updateContact",
"request": {
"$ref": "Person"
},
"response": {
"$ref": "Person"
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
]
}
},
"resources": {
"connections": {
"methods": {
"list": {
"description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
"flatPath": "v1/people/{peopleId}/connections",
"httpMethod": "GET",
"id": "people.people.connections.list",
"parameterOrder": [
"resourceName"
],
"parameters": {
"pageSize": {
"description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The token of the page to be returned.",
"location": "query",
"type": "string"
},
"personFields": {
"description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Multiple fields can be specified by separating them with commas.\nValid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* sipAddresses\n* skills\n* taglines\n* urls\n* userDefined",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"requestMask.includeField": {
"description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"requestSyncToken": {
"description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request. For subsequent sync requests use the\n`sync_token` param instead. Initial sync requests that specify\n`request_sync_token` have an additional rate limit.",
"location": "query",
"type": "boolean"
},
"resourceName": {
"description": "The resource name to return connections for. Only `people/me` is valid.",
"location": "path",
"pattern": "^people/[^/]+$",
"required": true,
"type": "string"
},
"sortOrder": {
"description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
"enum": [
"LAST_MODIFIED_ASCENDING",
"FIRST_NAME_ASCENDING",
"LAST_NAME_ASCENDING"
],
"location": "query",
"type": "string"
},
"syncToken": {
"description": "A sync token returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.\nSync requests that specify `sync_token` have an additional rate limit.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+resourceName}/connections",
"response": {
"$ref": "ListConnectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly"
]
}
}
}
}
}
},
"revision": "20190403",
"rootUrl": "https://people.googleapis.com/",
"schemas": {
"Address": {
"description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
"id": "Address",
"properties": {
"city": {
"description": "The city of the address.",
"type": "string"
},
"country": {
"description": "The country of the address.",
"type": "string"
},
"countryCode": {
"description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
"type": "string"
},
"extendedAddress": {
"description": "The extended address of the address; for example, the apartment number.",
"type": "string"
},
"formattedType": {
"description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"formattedValue": {
"description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the address."
},
"poBox": {
"description": "The P.O. box of the address.",
"type": "string"
},
"postalCode": {
"description": "The postal code of the address.",
"type": "string"
},
"region": {
"description": "The region of the address; for example, the state or province.",
"type": "string"
},
"streetAddress": {
"description": "The street address.",
"type": "string"
},
"type": {
"description": "The type of the address. The type can be custom or one of these predefined\nvalues:\n\n* `home`\n* `work`\n* `other`",
"type": "string"
}
},
"type": "object"
},
"AgeRangeType": {
"description": "A person's age range.",
"id": "AgeRangeType",
"properties": {
"ageRange": {
"description": "The age range.",
"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."
],
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the age range."
}
},
"type": "object"
},
"BatchGetContactGroupsResponse": {
"description": "The response to a batch get contact groups request.",
"id": "BatchGetContactGroupsResponse",
"properties": {
"responses": {
"description": "The list of responses for each requested contact group resource.",
"items": {
"$ref": "ContactGroupResponse"
},
"type": "array"
}
},
"type": "object"
},
"Biography": {
"description": "A person's short biography.",
"id": "Biography",
"properties": {
"contentType": {
"description": "The content type of the biography.",
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"TEXT_PLAIN",
"TEXT_HTML"
],
"enumDescriptions": [
"Unspecified.",
"Plain text.",
"HTML text."
],
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the biography."
},
"value": {
"description": "The short biography.",
"type": "string"
}
},
"type": "object"
},
"Birthday": {
"description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
"id": "Birthday",
"properties": {
"date": {
"$ref": "Date",
"description": "The date of the birthday."
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the birthday."
},
"text": {
"description": "A free-form string representing the user's birthday.",
"type": "string"
}
},
"type": "object"
},
"BraggingRights": {
"description": "A person's bragging rights.",
"id": "BraggingRights",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the bragging rights."
},
"value": {
"description": "The bragging rights; for example, `climbed mount everest`.",
"type": "string"
}
},
"type": "object"
},
"ContactGroup": {
"description": "A contact group.",
"id": "ContactGroup",
"properties": {
"etag": {
"description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
"type": "string"
},
"formattedName": {
"description": "The read-only name translated and formatted in the viewer's account locale\nor the `Accept-Language` HTTP header locale for system groups names.\nGroup names set by the owner are the same as name.",
"type": "string"
},
"groupType": {
"description": "The read-only contact group type.",
"enum": [
"GROUP_TYPE_UNSPECIFIED",
"USER_CONTACT_GROUP",
"SYSTEM_CONTACT_GROUP"
],
"enumDescriptions": [
"Unspecified.",
"User defined contact group.",
"System defined contact group."
],
"type": "string"
},
"memberCount": {
"description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
"format": "int32",
"type": "integer"
},
"memberResourceNames": {
"description": "The list of contact person resource names that are members of the contact\ngroup. The field is not populated for LIST requests and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).",
"items": {
"type": "string"
},
"type": "array"
},
"metadata": {
"$ref": "ContactGroupMetadata",
"description": "Metadata about the contact group."
},
"name": {
"description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
"type": "string"
},
"resourceName": {
"description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
"type": "string"
}
},
"type": "object"
},
"ContactGroupMembership": {
"description": "A Google contact group membership.",
"id": "ContactGroupMembership",
"properties": {
"contactGroupId": {
"description": "The contact group ID for the contact group membership. The contact group\nID can be custom or one of these predefined values:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
"type": "string"
}
},
"type": "object"
},
"ContactGroupMetadata": {
"description": "The read-only metadata about a contact group.",
"id": "ContactGroupMetadata",
"properties": {
"deleted": {
"description": "True if the contact group resource has been deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests\nthat include a sync token.",
"type": "boolean"
},
"updateTime": {
"description": "The time the group was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ContactGroupResponse": {
"description": "The response for a specific contact group.",
"id": "ContactGroupResponse",
"properties": {
"contactGroup": {
"$ref": "ContactGroup",
"description": "The contact group."
},
"requestedResourceName": {
"description": "The original requested resource name.",
"type": "string"
},
"status": {
"$ref": "Status",
"description": "The status of the response."
}
},
"type": "object"
},
"CoverPhoto": {
"description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.",
"id": "CoverPhoto",
"properties": {
"default": {
"description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
"type": "boolean"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the cover photo."
},
"url": {
"description": "The URL of the cover photo.",
"type": "string"
}
},
"type": "object"
},
"CreateContactGroupRequest": {
"description": "A request to create a new contact group.",
"id": "CreateContactGroupRequest",
"properties": {
"contactGroup": {
"$ref": "ContactGroup",
"description": "The contact group to create."
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
"id": "Date",
"properties": {
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DomainMembership": {
"description": "A G Suite Domain membership.",
"id": "DomainMembership",
"properties": {
"inViewerDomain": {
"description": "True if the person is in the viewer's G Suite domain.",
"type": "boolean"
}
},
"type": "object"
},
"EmailAddress": {
"description": "A person's email address.",
"id": "EmailAddress",
"properties": {
"displayName": {
"description": "The display name of the email.",
"type": "string"
},
"formattedType": {
"description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the email address."
},
"type": {
"description": "The type of the email address. The type can be custom or one of these\npredefined values:\n\n* `home`\n* `work`\n* `other`",
"type": "string"
},
"value": {
"description": "The email address.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"Event": {
"description": "An event related to the person.",
"id": "Event",
"properties": {
"date": {
"$ref": "Date",
"description": "The date of the event."
},
"formattedType": {
"description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the event."
},
"type": {
"description": "The type of the event. The type can be custom or one of these predefined\nvalues:\n\n* `anniversary`\n* `other`",
"type": "string"
}
},
"type": "object"
},
"FieldMetadata": {
"description": "Metadata about a field.",
"id": "FieldMetadata",
"properties": {
"primary": {
"description": "True if the field is the primary field; false if the field is a secondary\nfield.",
"type": "boolean"
},
"source": {
"$ref": "Source",
"description": "The source of the field."
},
"verified": {
"description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
"type": "boolean"
}
},
"type": "object"
},
"Gender": {
"description": "A person's gender.",
"id": "Gender",
"properties": {
"formattedValue": {
"description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the gender."
},
"value": {
"description": "The gender for the person. The gender can be custom or one of these\npredefined values:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
"type": "string"
}
},
"type": "object"
},
"GetPeopleResponse": {
"id": "GetPeopleResponse",
"properties": {
"responses": {
"description": "The response for each requested resource name.",
"items": {
"$ref": "PersonResponse"
},
"type": "array"
}
},
"type": "object"
},
"ImClient": {
"description": "A person's instant messaging client.",
"id": "ImClient",
"properties": {
"formattedProtocol": {
"description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"formattedType": {
"description": "The read-only type of the IM client translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the IM client."
},
"protocol": {
"description": "The protocol of the IM client. The protocol can be custom or one of these\npredefined values:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
"type": "string"
},
"type": {
"description": "The type of the IM client. The type can be custom or one of these\npredefined values:\n\n* `home`\n* `work`\n* `other`",
"type": "string"
},
"username": {
"description": "The user name used in the IM client.",
"type": "string"
}
},
"type": "object"
},
"Interest": {
"description": "One of the person's interests.",
"id": "Interest",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the interest."
},
"value": {
"description": "The interest; for example, `stargazing`.",
"type": "string"
}
},
"type": "object"
},
"ListConnectionsResponse": {
"id": "ListConnectionsResponse",
"properties": {
"connections": {
"description": "The list of people that the requestor is connected to.",
"items": {
"$ref": "Person"
},
"type": "array"
},
"nextPageToken": {
"description": "The token that can be used to retrieve the next page of results.",
"type": "string"
},
"nextSyncToken": {
"description": "The token that can be used to retrieve changes since the last request.",
"type": "string"
},
"totalItems": {
"description": "The total number of items in the list without pagination.",
"format": "int32",
"type": "integer"
},
"totalPeople": {
"description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ListContactGroupsResponse": {
"description": "The response to a list contact groups request.",
"id": "ListContactGroupsResponse",
"properties": {
"contactGroups": {
"description": "The list of contact groups. Members of the contact groups are not\npopulated.",
"items": {
"$ref": "ContactGroup"
},
"type": "array"
},
"nextPageToken": {
"description": "The token that can be used to retrieve the next page of results.",
"type": "string"
},
"nextSyncToken": {
"description": "The token that can be used to retrieve changes since the last request.",
"type": "string"
},
"totalItems": {
"description": "The total number of items in the list without pagination.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Locale": {
"description": "A person's locale preference.",
"id": "Locale",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the locale."
},
"value": {
"description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
"type": "string"
}
},
"type": "object"
},
"Membership": {
"description": "A person's read-only membership in a group.",
"id": "Membership",
"properties": {
"contactGroupMembership": {
"$ref": "ContactGroupMembership",
"description": "The contact group membership."
},
"domainMembership": {
"$ref": "DomainMembership",
"description": "The domain membership."
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the membership."
}
},
"type": "object"
},
"ModifyContactGroupMembersRequest": {
"description": "A request to modify an existing contact group's members. Contacts can be\nremoved from any group but they can only be added to a user group or\nmyContacts or starred system groups.",
"id": "ModifyContactGroupMembersRequest",
"properties": {
"resourceNamesToAdd": {
"description": "The resource names of the contact people to add in the form of in the form\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceNamesToRemove": {
"description": "The resource names of the contact people to remove in the form of in the\nform of `people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ModifyContactGroupMembersResponse": {
"description": "The response to a modify contact group members request.",
"id": "ModifyContactGroupMembersResponse",
"properties": {
"notFoundResourceNames": {
"description": "The contact people resource names that were not found.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Name": {
"description": "A person's name. If the name is a mononym, the family name is empty.",
"id": "Name",
"properties": {
"displayName": {
"description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
"type": "string"
},
"displayNameLastFirst": {
"description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.",
"type": "string"
},
"familyName": {
"description": "The family name.",
"type": "string"
},
"givenName": {
"description": "The given name.",
"type": "string"
},
"honorificPrefix": {
"description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
"type": "string"
},
"honorificSuffix": {
"description": "The honorific suffixes, such as `Jr.`",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the name."
},
"middleName": {
"description": "The middle name(s).",
"type": "string"
},
"phoneticFamilyName": {
"description": "The family name spelled as it sounds.",
"type": "string"
},
"phoneticFullName": {
"description": "The full name spelled as it sounds.",
"type": "string"
},
"phoneticGivenName": {
"description": "The given name spelled as it sounds.",
"type": "string"
},
"phoneticHonorificPrefix": {
"description": "The honorific prefixes spelled as they sound.",
"type": "string"
},
"phoneticHonorificSuffix": {
"description": "The honorific suffixes spelled as they sound.",
"type": "string"
},
"phoneticMiddleName": {
"description": "The middle name(s) spelled as they sound.",
"type": "string"
}
},
"type": "object"
},
"Nickname": {
"description": "A person's nickname.",
"id": "Nickname",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the nickname."
},
"type": {
"description": "The type of the nickname.",
"enum": [
"DEFAULT",
"MAIDEN_NAME",
"INITIALS",
"GPLUS",
"OTHER_NAME"
],
"enumDescriptions": [
"Generic nickname.",
"Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
"Initials.",
"Google+ profile nickname.",
"A professional affiliation or other name; for example, `Dr. Smith.`"
],
"type": "string"
},
"value": {
"description": "The nickname.",
"type": "string"
}
},
"type": "object"
},
"Occupation": {
"description": "A person's occupation.",
"id": "Occupation",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the occupation."
},
"value": {
"description": "The occupation; for example, `carpenter`.",
"type": "string"
}
},
"type": "object"
},
"Organization": {
"description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
"id": "Organization",
"properties": {
"current": {
"description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
"type": "boolean"
},
"department": {
"description": "The person's department at the organization.",
"type": "string"
},
"domain": {
"description": "The domain name associated with the organization; for example,\n`google.com`.",
"type": "string"
},
"endDate": {
"$ref": "Date",
"description": "The end date when the person left the organization."
},
"formattedType": {
"description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"jobDescription": {
"description": "The person's job description at the organization.",
"type": "string"
},
"location": {
"description": "The location of the organization office the person works at.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the organization."
},
"name": {
"description": "The name of the organization.",
"type": "string"
},
"phoneticName": {
"description": "The phonetic name of the organization.",
"type": "string"
},
"startDate": {
"$ref": "Date",
"description": "The start date when the person joined the organization."
},
"symbol": {
"description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
"type": "string"
},
"title": {
"description": "The person's job title at the organization.",
"type": "string"
},
"type": {
"description": "The type of the organization. The type can be custom or one of these\npredefined values:\n\n* `work`\n* `school`",
"type": "string"
}
},
"type": "object"
},
"Person": {
"description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fields can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.primary` set to true.",
"id": "Person",
"properties": {
"addresses": {
"description": "The person's street addresses.",
"items": {
"$ref": "Address"
},
"type": "array"
},
"ageRange": {
"description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only age range.",
"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."
],
"type": "string"
},
"ageRanges": {
"description": "The person's read-only age ranges.",
"items": {
"$ref": "AgeRangeType"
},
"type": "array"
},
"biographies": {
"description": "The person's biographies.",
"items": {
"$ref": "Biography"
},
"type": "array"
},
"birthdays": {
"description": "The person's birthdays.",
"items": {
"$ref": "Birthday"
},
"type": "array"
},
"braggingRights": {
"description": "The person's bragging rights.",
"items": {
"$ref": "BraggingRights"
},
"type": "array"
},
"coverPhotos": {
"description": "The person's read-only cover photos.",
"items": {
"$ref": "CoverPhoto"
},
"type": "array"
},
"emailAddresses": {
"description": "The person's email addresses.",
"items": {
"$ref": "EmailAddress"
},
"type": "array"
},
"etag": {
"description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
"type": "string"
},
"events": {
"description": "The person's events.",
"items": {
"$ref": "Event"
},
"type": "array"
},
"genders": {
"description": "The person's genders.",
"items": {
"$ref": "Gender"
},
"type": "array"
},
"imClients": {
"description": "The person's instant messaging clients.",
"items": {
"$ref": "ImClient"
},
"type": "array"
},
"interests": {
"description": "The person's interests.",
"items": {
"$ref": "Interest"
},
"type": "array"
},
"locales": {
"description": "The person's locale preferences.",
"items": {
"$ref": "Locale"
},
"type": "array"
},
"memberships": {
"description": "The person's read-only group memberships.",
"items": {
"$ref": "Membership"
},
"type": "array"
},
"metadata": {
"$ref": "PersonMetadata",
"description": "Read-only metadata about the person."
},
"names": {
"description": "The person's names.",
"items": {
"$ref": "Name"
},
"type": "array"
},
"nicknames": {
"description": "The person's nicknames.",
"items": {
"$ref": "Nickname"
},
"type": "array"
},
"occupations": {
"description": "The person's occupations.",
"items": {
"$ref": "Occupation"
},
"type": "array"
},
"organizations": {
"description": "The person's past or current organizations.",
"items": {
"$ref": "Organization"
},
"type": "array"
},
"phoneNumbers": {
"description": "The person's phone numbers.",
"items": {
"$ref": "PhoneNumber"
},
"type": "array"
},
"photos": {
"description": "The person's read-only photos.",
"items": {
"$ref": "Photo"
},
"type": "array"
},
"relations": {
"description": "The person's relations.",
"items": {
"$ref": "Relation"
},
"type": "array"
},
"relationshipInterests": {
"description": "The person's read-only relationship interests.",
"items": {
"$ref": "RelationshipInterest"
},
"type": "array"
},
"relationshipStatuses": {
"description": "The person's read-only relationship statuses.",
"items": {
"$ref": "RelationshipStatus"
},
"type": "array"
},
"residences": {
"description": "The person's residences.",
"items": {
"$ref": "Residence"
},
"type": "array"
},
"resourceName": {
"description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
"type": "string"
},
"sipAddresses": {
"description": "The person's SIP addresses.",
"items": {
"$ref": "SipAddress"
},
"type": "array"
},
"skills": {
"description": "The person's skills.",
"items": {
"$ref": "Skill"
},
"type": "array"
},
"taglines": {
"description": "The person's read-only taglines.",
"items": {
"$ref": "Tagline"
},
"type": "array"
},
"urls": {
"description": "The person's associated URLs.",
"items": {
"$ref": "Url"
},
"type": "array"
},
"userDefined": {
"description": "The person's user defined data.",
"items": {
"$ref": "UserDefined"
},
"type": "array"
}
},
"type": "object"
},
"PersonMetadata": {
"description": "The read-only metadata about a person.",
"id": "PersonMetadata",
"properties": {
"deleted": {
"description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
"type": "boolean"
},
"linkedPeopleResourceNames": {
"description": "Resource names of people linked to this resource.",
"items": {
"type": "string"
},
"type": "array"
},
"objectType": {
"description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
"enum": [
"OBJECT_TYPE_UNSPECIFIED",
"PERSON",
"PAGE"
],
"enumDescriptions": [
"Unspecified.",
"Person.",
"[Google+ Page.](http://www.google.com/+/brands/)"
],
"type": "string"
},
"previousResourceNames": {
"description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
"items": {
"type": "string"
},
"type": "array"
},
"sources": {
"description": "The sources of data for the person.",
"items": {
"$ref": "Source"
},
"type": "array"
}
},
"type": "object"
},
"PersonResponse": {
"description": "The response for a single person",
"id": "PersonResponse",
"properties": {
"httpStatusCode": {
"description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
"format": "int32",
"type": "integer"
},
"person": {
"$ref": "Person",
"description": "The person."
},
"requestedResourceName": {
"description": "The original requested resource name. May be different than the resource\nname on the returned person.\n\nThe resource name can change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or a\nprofile URL.",
"type": "string"
},
"status": {
"$ref": "Status",
"description": "The status of the response."
}
},
"type": "object"
},
"PhoneNumber": {
"description": "A person's phone number.",
"id": "PhoneNumber",
"properties": {
"canonicalForm": {
"description": "The read-only canonicalized [ITU-T\nE.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
"type": "string"
},
"formattedType": {
"description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the phone number."
},
"type": {
"description": "The type of the phone number. The type can be custom or one of these\npredefined values:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
"type": "string"
},
"value": {
"description": "The phone number.",
"type": "string"
}
},
"type": "object"
},
"Photo": {
"description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
"id": "Photo",
"properties": {
"default": {
"description": "True if the photo is a default photo;\nfalse if the photo is a user-provided photo.",
"type": "boolean"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the photo."
},
"url": {
"description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
"type": "string"
}
},
"type": "object"
},
"ProfileMetadata": {
"description": "The read-only metadata about a profile.",
"id": "ProfileMetadata",
"properties": {
"objectType": {
"description": "The profile object type.",
"enum": [
"OBJECT_TYPE_UNSPECIFIED",
"PERSON",
"PAGE"
],
"enumDescriptions": [
"Unspecified.",
"Person.",
"[Google+ Page.](http://www.google.com/+/brands/)"
],
"type": "string"
},
"userTypes": {
"description": "The user types.",
"enumDescriptions": [
"The user type is not known.",
"The user is a Google user.",
"The user is a Google+ user.",
"The user is a G Suite user."
],
"items": {
"enum": [
"USER_TYPE_UNKNOWN",
"GOOGLE_USER",
"GPLUS_USER",
"GOOGLE_APPS_USER"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Relation": {
"description": "A person's relation to another person.",
"id": "Relation",
"properties": {
"formattedType": {
"description": "The type of the relation translated and formatted in the viewer's account\nlocale or the locale specified in the Accept-Language HTTP header.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the relation."
},
"person": {
"description": "The name of the other person this relation refers to.",
"type": "string"
},
"type": {
"description": "The person's relation to the other person. The type can be custom or one of\nthese predefined values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
"type": "string"
}
},
"type": "object"
},
"RelationshipInterest": {
"description": "A person's read-only relationship interest .",
"id": "RelationshipInterest",
"properties": {
"formattedValue": {
"description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the relationship interest."
},
"value": {
"description": "The kind of relationship the person is looking for. The value can be custom\nor one of these predefined values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
"type": "string"
}
},
"type": "object"
},
"RelationshipStatus": {
"description": "A person's read-only relationship status.",
"id": "RelationshipStatus",
"properties": {
"formattedValue": {
"description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the relationship status."
},
"value": {
"description": "The relationship status. The value can be custom or one of these\npredefined values:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
"type": "string"
}
},
"type": "object"
},
"Residence": {
"description": "A person's past or current residence.",
"id": "Residence",
"properties": {
"current": {
"description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
"type": "boolean"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the residence."
},
"value": {
"description": "The address of the residence.",
"type": "string"
}
},
"type": "object"
},
"SipAddress": {
"description": "A person's SIP address. Session Initial Protocol addresses are used for VoIP\ncommunications to make voice or video calls over the internet.",
"id": "SipAddress",
"properties": {
"formattedType": {
"description": "The read-only type of the SIP address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the SIP address."
},
"type": {
"description": "The type of the SIP address. The type can be custom or or one of these\npredefined values:\n\n* `home`\n* `work`\n* `mobile`\n* `other`",
"type": "string"
},
"value": {
"description": "The SIP address in the\n[RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI\nformat.",
"type": "string"
}
},
"type": "object"
},
"Skill": {
"description": "A skill that the person has.",
"id": "Skill",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the skill."
},
"value": {
"description": "The skill; for example, `underwater basket weaving`.",
"type": "string"
}
},
"type": "object"
},
"Source": {
"description": "The source of a field.",
"id": "Source",
"properties": {
"etag": {
"description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. 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",
"description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE."
},
"type": {
"description": "The source type.",
"enum": [
"SOURCE_TYPE_UNSPECIFIED",
"ACCOUNT",
"PROFILE",
"DOMAIN_PROFILE",
"CONTACT"
],
"enumDescriptions": [
"Unspecified.",
"[Google Account](https://accounts.google.com).",
"[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cvar\u003eid\u003c/var\u003e where\n\u003cvar\u003eid\u003c/var\u003e 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\ncontact at https://contact.google.com/\u003cvar\u003eid\u003c/var\u003e where \u003cvar\u003eid\u003c/var\u003e\nis the source id."
],
"type": "string"
},
"updateTime": {
"description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"Tagline": {
"description": "A read-only brief one-line description of the person.",
"id": "Tagline",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the tagline."
},
"value": {
"description": "The tagline.",
"type": "string"
}
},
"type": "object"
},
"UpdateContactGroupRequest": {
"description": "A request to update an existing user contact group. All updated fields will\nbe replaced.",
"id": "UpdateContactGroupRequest",
"properties": {
"contactGroup": {
"$ref": "ContactGroup",
"description": "The contact group to update."
}
},
"type": "object"
},
"Url": {
"description": "A person's associated URLs.",
"id": "Url",
"properties": {
"formattedType": {
"description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the URL."
},
"type": {
"description": "The type of the URL. The type can be custom or one of these predefined\nvalues:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
"type": "string"
},
"value": {
"description": "The URL.",
"type": "string"
}
},
"type": "object"
},
"UserDefined": {
"description": "Arbitrary user data that is populated by the end users.",
"id": "UserDefined",
"properties": {
"key": {
"description": "The end user specified key of the user defined data.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the user defined data."
},
"value": {
"description": "The end user specified value of the user defined data.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "People API",
"version": "v1",
"version_module": true
}
Reference in a new issue Copy permalink