| Index: discovery/googleapis/people__v1.json
|
| diff --git a/discovery/googleapis/people__v1.json b/discovery/googleapis/people__v1.json
|
| index 774861352918d3c4123f6e91046ed1fa43891ff3..e40f555c9f1ae712b033ac36a3f5d1b9e4fe40b9 100644
|
| --- a/discovery/googleapis/people__v1.json
|
| +++ b/discovery/googleapis/people__v1.json
|
| @@ -2,32 +2,32 @@
|
| "auth": {
|
| "oauth2": {
|
| "scopes": {
|
| - "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/contacts.readonly": {
|
| - "description": "View your contacts"
|
| - },
|
| - "https://www.googleapis.com/auth/user.birthday.read": {
|
| - "description": "View your complete date of birth"
|
| - },
|
| "https://www.googleapis.com/auth/plus.login": {
|
| "description": "Know the list of people in your circles, your age range, and language"
|
| },
|
| "https://www.googleapis.com/auth/userinfo.profile": {
|
| "description": "View your basic profile info"
|
| },
|
| - "https://www.googleapis.com/auth/user.emails.read": {
|
| - "description": "View your email addresses"
|
| + "https://www.googleapis.com/auth/user.addresses.read": {
|
| + "description": "View your street addresses"
|
| },
|
| "https://www.googleapis.com/auth/contacts": {
|
| "description": "Manage your contacts"
|
| },
|
| - "https://www.googleapis.com/auth/user.addresses.read": {
|
| - "description": "View your street addresses"
|
| + "https://www.googleapis.com/auth/user.emails.read": {
|
| + "description": "View your email addresses"
|
| + },
|
| + "https://www.googleapis.com/auth/userinfo.email": {
|
| + "description": "View your email address"
|
| + },
|
| + "https://www.googleapis.com/auth/user.phonenumbers.read": {
|
| + "description": "View your phone numbers"
|
| + },
|
| + "https://www.googleapis.com/auth/user.birthday.read": {
|
| + "description": "View your complete date of birth"
|
| + },
|
| + "https://www.googleapis.com/auth/contacts.readonly": {
|
| + "description": "View your contacts"
|
| }
|
| }
|
| }
|
| @@ -49,50 +49,13 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "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"
|
| - },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "upload_protocol": {
|
| - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "prettyPrint": {
|
| - "default": "true",
|
| - "description": "Returns response with indentations and line breaks.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "fields": {
|
| "description": "Selector specifying which fields to include in a partial response.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "callback": {
|
| - "description": "JSONP",
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -109,6 +72,11 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "callback": {
|
| + "description": "JSONP",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| @@ -134,61 +102,44 @@
|
| "description": "OAuth access token.",
|
| "location": "query",
|
| "type": "string"
|
| + },
|
| + "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"
|
| + },
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "upload_protocol": {
|
| + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "prettyPrint": {
|
| + "default": "true",
|
| + "description": "Returns response with indentations and line breaks.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| }
|
| },
|
| "protocol": "rest",
|
| "resources": {
|
| "contactGroups": {
|
| "methods": {
|
| - "list": {
|
| - "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
|
| - "httpMethod": "GET",
|
| - "id": "people.contactGroups.list",
|
| - "parameterOrder": [],
|
| - "parameters": {
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "pageSize": {
|
| - "description": "The maximum number of resources to return.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "path": "v1/contactGroups",
|
| - "response": {
|
| - "$ref": "ListContactGroupsResponse"
|
| - },
|
| - "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.",
|
| - "httpMethod": "POST",
|
| - "id": "people.contactGroups.create",
|
| - "parameterOrder": [],
|
| - "parameters": {},
|
| - "path": "v1/contactGroups",
|
| - "request": {
|
| - "$ref": "CreateContactGroupRequest"
|
| - },
|
| - "response": {
|
| - "$ref": "ContactGroup"
|
| - },
|
| - "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.",
|
| "httpMethod": "GET",
|
| @@ -229,7 +180,7 @@
|
| ],
|
| "parameters": {
|
| "resourceName": {
|
| - "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/<contact_group_id>`.",
|
| + "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`<var>contact_group_id</var>.",
|
| "location": "path",
|
| "pattern": "^contactGroups/[^/]+$",
|
| "required": true,
|
| @@ -253,17 +204,17 @@
|
| "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"
|
| + },
|
| + "maxMembers": {
|
| + "description": "Specifies the maximum number of members to return for each group.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| }
|
| },
|
| "path": "v1/contactGroups:batchGet",
|
| @@ -283,17 +234,17 @@
|
| "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"
|
| + },
|
| + "deleteContacts": {
|
| + "description": "Set to true to also delete the contacts in the specified group.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| }
|
| },
|
| "path": "v1/{+resourceName}",
|
| @@ -303,6 +254,55 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/contacts"
|
| ]
|
| + },
|
| + "list": {
|
| + "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
|
| + "httpMethod": "GET",
|
| + "id": "people.contactGroups.list",
|
| + "parameterOrder": [],
|
| + "parameters": {
|
| + "pageSize": {
|
| + "description": "The maximum number of resources to return.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "path": "v1/contactGroups",
|
| + "response": {
|
| + "$ref": "ListContactGroupsResponse"
|
| + },
|
| + "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.",
|
| + "httpMethod": "POST",
|
| + "id": "people.contactGroups.create",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v1/contactGroups",
|
| + "request": {
|
| + "$ref": "CreateContactGroupRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "ContactGroup"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/contacts"
|
| + ]
|
| }
|
| },
|
| "resources": {
|
| @@ -341,28 +341,52 @@
|
| },
|
| "people": {
|
| "methods": {
|
| + "deleteContact": {
|
| + "description": "Delete a contact person. Any non-contact data will not be deleted.",
|
| + "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"
|
| + ]
|
| + },
|
| "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<br>\nThe request throws a 400 error if 'personFields' is not specified.",
|
| "httpMethod": "GET",
|
| "id": "people.people.getBatchGet",
|
| "parameterOrder": [],
|
| "parameters": {
|
| - "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`.",
|
| + "personFields": {
|
| + "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid 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* skills\n* taglines\n* urls",
|
| "format": "google-fieldmask",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "resourceNames": {
|
| - "description": "The resource name, such as one returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list),\nof one of the people to provide information about. You can include this\nparameter up to 50 times in one request.",
|
| + "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",
|
| - "repeated": true,
|
| "type": "string"
|
| },
|
| - "personFields": {
|
| - "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid 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* skills\n* taglines\n* urls",
|
| - "format": "google-fieldmask",
|
| + "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/`<var>account_id</var>.\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"
|
| }
|
| },
|
| @@ -397,7 +421,7 @@
|
| "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 `people/<account_id>`.\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).",
|
| + "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/`<var>account_id</var>.\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,
|
| @@ -434,18 +458,18 @@
|
| "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 `people/<person_id>`.",
|
| - "location": "path",
|
| - "pattern": "^people/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "updatePersonFields": {
|
| "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\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* skills\n* urls",
|
| "format": "google-fieldmask",
|
| "location": "query",
|
| "type": "string"
|
| + },
|
| + "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/`<var>person_id</var>.",
|
| + "location": "path",
|
| + "pattern": "^people/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/{+resourceName}:updateContact",
|
| @@ -481,30 +505,6 @@
|
| "scopes": [
|
| "https://www.googleapis.com/auth/contacts"
|
| ]
|
| - },
|
| - "deleteContact": {
|
| - "description": "Delete a contact person. Any non-contact data will not be deleted.",
|
| - "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"
|
| - ]
|
| }
|
| },
|
| "resources": {
|
| @@ -518,11 +518,6 @@
|
| "resourceName"
|
| ],
|
| "parameters": {
|
| - "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.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "personFields": {
|
| "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid 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* skills\n* taglines\n* urls",
|
| "format": "google-fieldmask",
|
| @@ -567,6 +562,11 @@
|
| "format": "google-fieldmask",
|
| "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.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/{+resourceName}/connections",
|
| @@ -583,1091 +583,1083 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170706",
|
| + "revision": "20170727",
|
| "rootUrl": "https://people.googleapis.com/",
|
| "schemas": {
|
| - "AgeRangeType": {
|
| - "description": "A person's age range.",
|
| - "id": "AgeRangeType",
|
| + "Biography": {
|
| + "description": "A person's short biography.",
|
| + "id": "Biography",
|
| "properties": {
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the age range."
|
| + "description": "Metadata about the biography."
|
| },
|
| - "ageRange": {
|
| - "description": "The age range.",
|
| + "value": {
|
| + "description": "The short biography.",
|
| + "type": "string"
|
| + },
|
| + "contentType": {
|
| + "description": "The content type of the biography.",
|
| "enum": [
|
| - "AGE_RANGE_UNSPECIFIED",
|
| - "LESS_THAN_EIGHTEEN",
|
| - "EIGHTEEN_TO_TWENTY",
|
| - "TWENTY_ONE_OR_OLDER"
|
| + "CONTENT_TYPE_UNSPECIFIED",
|
| + "TEXT_PLAIN",
|
| + "TEXT_HTML"
|
| ],
|
| "enumDescriptions": [
|
| "Unspecified.",
|
| - "Younger than eighteen.",
|
| - "Between eighteen and twenty.",
|
| - "Twenty-one and older."
|
| + "Plain text.",
|
| + "HTML text."
|
| ],
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListContactGroupsResponse": {
|
| - "description": "The response to a list contact groups request.",
|
| - "id": "ListContactGroupsResponse",
|
| + "FieldMetadata": {
|
| + "description": "Metadata about a field.",
|
| + "id": "FieldMetadata",
|
| "properties": {
|
| - "contactGroups": {
|
| - "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
|
| - "items": {
|
| - "$ref": "ContactGroup"
|
| - },
|
| - "type": "array"
|
| + "primary": {
|
| + "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
|
| + "type": "boolean"
|
| },
|
| - "nextPageToken": {
|
| - "description": "The token that can be used to retrieve the next page of results.",
|
| - "type": "string"
|
| + "source": {
|
| + "$ref": "Source",
|
| + "description": "The source of the field."
|
| },
|
| - "nextSyncToken": {
|
| - "description": "The token that can be used to retrieve changes since the last request.",
|
| + "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"
|
| + },
|
| + "RelationshipInterest": {
|
| + "description": "A person's read-only relationship interest .",
|
| + "id": "RelationshipInterest",
|
| + "properties": {
|
| + "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 predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
|
| "type": "string"
|
| },
|
| - "totalItems": {
|
| - "description": "The total number of items in the list without pagination.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "PersonResponse": {
|
| - "description": "The response for a single person",
|
| - "id": "PersonResponse",
|
| + "Source": {
|
| + "description": "The source of a field.",
|
| + "id": "Source",
|
| "properties": {
|
| - "person": {
|
| - "$ref": "Person",
|
| - "description": "The person."
|
| + "updateTime": {
|
| + "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| },
|
| - "status": {
|
| - "$ref": "Status",
|
| - "description": "The status of the response."
|
| + "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/<var>id</var> where\n<var>id</var> is the source id.",
|
| + "[Google Apps domain profile](https://admin.google.com).",
|
| + "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/<var>id</var> where <var>id</var>\nis the source id."
|
| + ],
|
| + "type": "string"
|
| },
|
| - "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"
|
| + "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"
|
| },
|
| - "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.",
|
| + "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": "object"
|
| },
|
| - "Relation": {
|
| - "description": "A person's relation to another person.",
|
| - "id": "Relation",
|
| + "GetPeopleResponse": {
|
| + "id": "GetPeopleResponse",
|
| + "properties": {
|
| + "responses": {
|
| + "description": "The response for each requested resource name.",
|
| + "items": {
|
| + "$ref": "PersonResponse"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "PhoneNumber": {
|
| + "description": "A person's phone number.",
|
| + "id": "PhoneNumber",
|
| "properties": {
|
| "type": {
|
| - "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following 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`",
|
| + "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\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"
|
| },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the relation."
|
| + "description": "Metadata about the phone number."
|
| + },
|
| + "value": {
|
| + "description": "The phone number.",
|
| + "type": "string"
|
| },
|
| "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.",
|
| + "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"
|
| },
|
| - "person": {
|
| - "description": "The name of the other person this relation refers to.",
|
| + "canonicalForm": {
|
| + "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Occupation": {
|
| - "description": "A person's occupation.",
|
| - "id": "Occupation",
|
| + "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": {
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the occupation."
|
| + "description": "Metadata about the photo."
|
| },
|
| - "value": {
|
| - "description": "The occupation; for example, `carpenter`.",
|
| + "url": {
|
| + "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`<var>size</var> 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"
|
| },
|
| - "ContactGroup": {
|
| - "description": "A contact group.",
|
| - "id": "ContactGroup",
|
| + "ListConnectionsResponse": {
|
| + "id": "ListConnectionsResponse",
|
| "properties": {
|
| - "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"
|
| + "totalPeople": {
|
| + "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "name": {
|
| - "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
|
| + "nextPageToken": {
|
| + "description": "The token that can be used to retrieve the next page of results.",
|
| "type": "string"
|
| },
|
| - "memberCount": {
|
| - "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
|
| + "totalItems": {
|
| + "description": "The total number of items in the list without pagination.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "metadata": {
|
| - "$ref": "ContactGroupMetadata",
|
| - "description": "Metadata about the contact group."
|
| - },
|
| - "resourceName": {
|
| - "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/<contact_group_id>`.",
|
| - "type": "string"
|
| - },
|
| - "etag": {
|
| - "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
|
| + "nextSyncToken": {
|
| + "description": "The token that can be used to retrieve changes since the last request.",
|
| "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"
|
| + "connections": {
|
| + "description": "The list of people that the requestor is connected to.",
|
| + "items": {
|
| + "$ref": "Person"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "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",
|
| + "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": {
|
| - "nicknames": {
|
| - "description": "The person's nicknames.",
|
| - "items": {
|
| - "$ref": "Nickname"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "names": {
|
| - "description": "The person's names.",
|
| - "items": {
|
| - "$ref": "Name"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "relations": {
|
| - "description": "The person's relations.",
|
| - "items": {
|
| - "$ref": "Relation"
|
| - },
|
| - "type": "array"
|
| + "date": {
|
| + "$ref": "Date",
|
| + "description": "The date of the birthday."
|
| },
|
| - "occupations": {
|
| - "description": "The person's occupations.",
|
| - "items": {
|
| - "$ref": "Occupation"
|
| - },
|
| - "type": "array"
|
| + "text": {
|
| + "description": "A free-form string representing the user's birthday.",
|
| + "type": "string"
|
| },
|
| - "emailAddresses": {
|
| - "description": "The person's email addresses.",
|
| - "items": {
|
| - "$ref": "EmailAddress"
|
| - },
|
| - "type": "array"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the birthday."
|
| + }
|
| + },
|
| + "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"
|
| + },
|
| + "Address": {
|
| + "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
|
| + "id": "Address",
|
| + "properties": {
|
| + "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"
|
| },
|
| - "organizations": {
|
| - "description": "The person's past or current organizations.",
|
| - "items": {
|
| - "$ref": "Organization"
|
| - },
|
| - "type": "array"
|
| + "city": {
|
| + "description": "The city of the address.",
|
| + "type": "string"
|
| },
|
| - "etag": {
|
| - "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
|
| + "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"
|
| },
|
| - "braggingRights": {
|
| - "description": "The person's bragging rights.",
|
| - "items": {
|
| - "$ref": "BraggingRights"
|
| - },
|
| - "type": "array"
|
| + "country": {
|
| + "description": "The country of the address.",
|
| + "type": "string"
|
| },
|
| - "metadata": {
|
| - "$ref": "PersonMetadata",
|
| - "description": "Read-only metadata about the person."
|
| + "type": {
|
| + "description": "The type of the address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
|
| + "type": "string"
|
| },
|
| - "residences": {
|
| - "description": "The person's residences.",
|
| - "items": {
|
| - "$ref": "Residence"
|
| - },
|
| - "type": "array"
|
| + "extendedAddress": {
|
| + "description": "The extended address of the address; for example, the apartment number.",
|
| + "type": "string"
|
| },
|
| - "genders": {
|
| - "description": "The person's genders.",
|
| - "items": {
|
| - "$ref": "Gender"
|
| - },
|
| - "type": "array"
|
| + "poBox": {
|
| + "description": "The P.O. box of the address.",
|
| + "type": "string"
|
| },
|
| - "interests": {
|
| - "description": "The person's interests.",
|
| - "items": {
|
| - "$ref": "Interest"
|
| - },
|
| - "type": "array"
|
| + "postalCode": {
|
| + "description": "The postal code of the address.",
|
| + "type": "string"
|
| },
|
| - "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 `people/<person_id>`.",
|
| + "region": {
|
| + "description": "The region of the address; for example, the state or province.",
|
| "type": "string"
|
| },
|
| - "biographies": {
|
| - "description": "The person's biographies.",
|
| - "items": {
|
| - "$ref": "Biography"
|
| - },
|
| - "type": "array"
|
| + "streetAddress": {
|
| + "description": "The street address.",
|
| + "type": "string"
|
| },
|
| - "skills": {
|
| - "description": "The person's skills.",
|
| - "items": {
|
| - "$ref": "Skill"
|
| - },
|
| - "type": "array"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the address."
|
| },
|
| - "relationshipStatuses": {
|
| - "description": "The person's read-only relationship statuses.",
|
| - "items": {
|
| - "$ref": "RelationshipStatus"
|
| - },
|
| - "type": "array"
|
| + "countryCode": {
|
| + "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Status": {
|
| + "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[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 message,\nand 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": {
|
| + "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"
|
| },
|
| - "photos": {
|
| - "description": "The person's read-only photos.",
|
| + "details": {
|
| + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
|
| "items": {
|
| - "$ref": "Photo"
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "type": "object"
|
| },
|
| "type": "array"
|
| },
|
| - "ageRange": {
|
| - "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only age range.",
|
| + "code": {
|
| + "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "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 predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "PersonMetadata": {
|
| + "description": "The read-only metadata about a person.",
|
| + "id": "PersonMetadata",
|
| + "properties": {
|
| + "objectType": {
|
| + "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
|
| "enum": [
|
| - "AGE_RANGE_UNSPECIFIED",
|
| - "LESS_THAN_EIGHTEEN",
|
| - "EIGHTEEN_TO_TWENTY",
|
| - "TWENTY_ONE_OR_OLDER"
|
| + "OBJECT_TYPE_UNSPECIFIED",
|
| + "PERSON",
|
| + "PAGE"
|
| ],
|
| "enumDescriptions": [
|
| "Unspecified.",
|
| - "Younger than eighteen.",
|
| - "Between eighteen and twenty.",
|
| - "Twenty-one and older."
|
| + "Person.",
|
| + "[Google+ Page.](http://www.google.com/+/brands/)"
|
| ],
|
| "type": "string"
|
| },
|
| - "taglines": {
|
| - "description": "The person's read-only taglines.",
|
| + "linkedPeopleResourceNames": {
|
| + "description": "Resource names of people linked to this resource.",
|
| "items": {
|
| - "$ref": "Tagline"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "ageRanges": {
|
| - "description": "The person's read-only age ranges.",
|
| + "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": {
|
| - "$ref": "AgeRangeType"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "addresses": {
|
| - "description": "The person's street addresses.",
|
| + "sources": {
|
| + "description": "The sources of data for the person.",
|
| "items": {
|
| - "$ref": "Address"
|
| + "$ref": "Source"
|
| },
|
| "type": "array"
|
| },
|
| - "events": {
|
| - "description": "The person's events.",
|
| - "items": {
|
| - "$ref": "Event"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "memberships": {
|
| - "description": "The person's read-only group memberships.",
|
| - "items": {
|
| - "$ref": "Membership"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "phoneNumbers": {
|
| - "description": "The person's phone numbers.",
|
| - "items": {
|
| - "$ref": "PhoneNumber"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "coverPhotos": {
|
| - "description": "The person's read-only cover photos.",
|
| - "items": {
|
| - "$ref": "CoverPhoto"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "imClients": {
|
| - "description": "The person's instant messaging clients.",
|
| - "items": {
|
| - "$ref": "ImClient"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "birthdays": {
|
| - "description": "The person's birthdays.",
|
| - "items": {
|
| - "$ref": "Birthday"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "locales": {
|
| - "description": "The person's locale preferences.",
|
| - "items": {
|
| - "$ref": "Locale"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "relationshipInterests": {
|
| - "description": "The person's read-only relationship interests.",
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ModifyContactGroupMembersRequest": {
|
| + "description": "A request to modify an existing contact group's members.",
|
| + "id": "ModifyContactGroupMembersRequest",
|
| + "properties": {
|
| + "resourceNamesToAdd": {
|
| + "description": "The resource names of the contact people to add in the form of in the form\n`people/`<var>person_id</var>.",
|
| "items": {
|
| - "$ref": "RelationshipInterest"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "urls": {
|
| - "description": "The person's associated URLs.",
|
| + "resourceNamesToRemove": {
|
| + "description": "The resource names of the contact people to remove in the form of in the\nform of `people/`<var>person_id</var>.",
|
| "items": {
|
| - "$ref": "Url"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "UpdateContactGroupRequest": {
|
| - "description": "A request to update an existing contact group. Only the name can be updated.",
|
| - "id": "UpdateContactGroupRequest",
|
| + "ContactGroupResponse": {
|
| + "description": "The response for a specific contact group.",
|
| + "id": "ContactGroupResponse",
|
| "properties": {
|
| "contactGroup": {
|
| "$ref": "ContactGroup",
|
| - "description": "The contact group to update."
|
| + "description": "The contact group."
|
| + },
|
| + "status": {
|
| + "$ref": "Status",
|
| + "description": "The status of the response."
|
| + },
|
| + "requestedResourceName": {
|
| + "description": "The original requested resource name.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ContactGroupMetadata": {
|
| - "description": "The read-only metadata about a contact group.",
|
| - "id": "ContactGroupMetadata",
|
| + "Url": {
|
| + "description": "A person's associated URLs.",
|
| + "id": "Url",
|
| "properties": {
|
| - "updateTime": {
|
| - "description": "The time the group was last updated.",
|
| - "format": "google-datetime",
|
| + "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"
|
| },
|
| - "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"
|
| - }
|
| - },
|
| - "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"
|
| + "type": {
|
| + "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\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"
|
| },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the residence."
|
| + "description": "Metadata about the URL."
|
| },
|
| "value": {
|
| - "description": "The address of the residence.",
|
| + "description": "The URL.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Event": {
|
| - "description": "An event related to the person.",
|
| - "id": "Event",
|
| + "ImClient": {
|
| + "description": "A person's instant messaging client.",
|
| + "id": "ImClient",
|
| "properties": {
|
| - "type": {
|
| - "description": "The type of the event. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `anniversary`\n* `other`",
|
| + "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 event."
|
| + "description": "Metadata about the IM client."
|
| },
|
| - "date": {
|
| - "$ref": "Date",
|
| - "description": "The date of the event."
|
| + "type": {
|
| + "description": "The type of the IM client. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
|
| + "type": "string"
|
| },
|
| - "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.",
|
| + "protocol": {
|
| + "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
|
| + "type": "string"
|
| + },
|
| + "username": {
|
| + "description": "The user name used in the IM client.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ModifyContactGroupMembersResponse": {
|
| - "description": "The response to a modify contact group members request.",
|
| - "id": "ModifyContactGroupMembersResponse",
|
| + "DomainMembership": {
|
| + "description": "A Google Apps Domain membership.",
|
| + "id": "DomainMembership",
|
| "properties": {
|
| - "notFoundResourceNames": {
|
| - "description": "The contact people resource names that were not found.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "inViewerDomain": {
|
| + "description": "True if the person is in the viewer's Google Apps domain.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ProfileMetadata": {
|
| - "description": "The read-only metadata about a profile.",
|
| - "id": "ProfileMetadata",
|
| + "BatchGetContactGroupsResponse": {
|
| + "description": "The response to a batch get contact groups request.",
|
| + "id": "BatchGetContactGroupsResponse",
|
| "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 Google Apps for Work user."
|
| - ],
|
| + "responses": {
|
| + "description": "The list of responses for each requested contact group resource.",
|
| "items": {
|
| - "enum": [
|
| - "USER_TYPE_UNKNOWN",
|
| - "GOOGLE_USER",
|
| - "GPLUS_USER",
|
| - "GOOGLE_APPS_USER"
|
| - ],
|
| - "type": "string"
|
| + "$ref": "ContactGroupResponse"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Gender": {
|
| - "description": "A person's gender.",
|
| - "id": "Gender",
|
| + "Membership": {
|
| + "description": "A person's read-only membership in a group.",
|
| + "id": "Membership",
|
| "properties": {
|
| - "value": {
|
| - "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
|
| - "type": "string"
|
| - },
|
| - "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."
|
| + "description": "Metadata about the membership."
|
| + },
|
| + "domainMembership": {
|
| + "$ref": "DomainMembership",
|
| + "description": "The domain membership."
|
| + },
|
| + "contactGroupMembership": {
|
| + "$ref": "ContactGroupMembership",
|
| + "description": "The contact group membership."
|
| }
|
| },
|
| "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",
|
| + "RelationshipStatus": {
|
| + "description": "A person's read-only relationship status.",
|
| + "id": "RelationshipStatus",
|
| "properties": {
|
| - "url": {
|
| - "description": "The URL of the cover photo.",
|
| + "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"
|
| },
|
| - "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."
|
| + "description": "Metadata about the relationship status."
|
| + },
|
| + "value": {
|
| + "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Interest": {
|
| - "description": "One of the person's interests.",
|
| - "id": "Interest",
|
| + "BraggingRights": {
|
| + "description": "A person's bragging rights.",
|
| + "id": "BraggingRights",
|
| "properties": {
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the interest."
|
| + "description": "Metadata about the bragging rights."
|
| },
|
| "value": {
|
| - "description": "The interest; for example, `stargazing`.",
|
| + "description": "The bragging rights; for example, `climbed mount everest`.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "EmailAddress": {
|
| - "description": "A person's email address.",
|
| - "id": "EmailAddress",
|
| + "Organization": {
|
| + "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
|
| + "id": "Organization",
|
| "properties": {
|
| - "displayName": {
|
| - "description": "The display name of the email.",
|
| + "type": {
|
| + "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
|
| "type": "string"
|
| },
|
| - "type": {
|
| - "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
|
| + "phoneticName": {
|
| + "description": "The phonetic name of the organization.",
|
| + "type": "string"
|
| + },
|
| + "jobDescription": {
|
| + "description": "The person's job description at the organization.",
|
| + "type": "string"
|
| + },
|
| + "endDate": {
|
| + "$ref": "Date",
|
| + "description": "The end date when the person left the organization."
|
| + },
|
| + "symbol": {
|
| + "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
|
| + "type": "string"
|
| + },
|
| + "name": {
|
| + "description": "The name of the organization.",
|
| "type": "string"
|
| },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the email address."
|
| + "description": "Metadata about the organization."
|
| },
|
| - "value": {
|
| - "description": "The email address.",
|
| + "location": {
|
| + "description": "The location of the organization office the person works at.",
|
| + "type": "string"
|
| + },
|
| + "title": {
|
| + "description": "The person's job title at the organization.",
|
| "type": "string"
|
| },
|
| + "current": {
|
| + "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
|
| + "type": "boolean"
|
| + },
|
| + "startDate": {
|
| + "$ref": "Date",
|
| + "description": "The start date when the person joined the organization."
|
| + },
|
| "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.",
|
| + "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"
|
| + },
|
| + "domain": {
|
| + "description": "The domain name associated with the organization; for example, `google.com`.",
|
| + "type": "string"
|
| + },
|
| + "department": {
|
| + "description": "The person's department at the organization.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Nickname": {
|
| - "description": "A person's nickname.",
|
| - "id": "Nickname",
|
| + "AgeRangeType": {
|
| + "description": "A person's age range.",
|
| + "id": "AgeRangeType",
|
| "properties": {
|
| - "type": {
|
| - "description": "The type of the nickname.",
|
| + "ageRange": {
|
| + "description": "The age range.",
|
| "enum": [
|
| - "DEFAULT",
|
| - "MAIDEN_NAME",
|
| - "INITIALS",
|
| - "GPLUS",
|
| - "OTHER_NAME"
|
| + "AGE_RANGE_UNSPECIFIED",
|
| + "LESS_THAN_EIGHTEEN",
|
| + "EIGHTEEN_TO_TWENTY",
|
| + "TWENTY_ONE_OR_OLDER"
|
| ],
|
| "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.`"
|
| + "Unspecified.",
|
| + "Younger than eighteen.",
|
| + "Between eighteen and twenty.",
|
| + "Twenty-one and older."
|
| ],
|
| "type": "string"
|
| },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the nickname."
|
| - },
|
| - "value": {
|
| - "description": "The nickname.",
|
| - "type": "string"
|
| + "description": "Metadata about the age range."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Skill": {
|
| - "description": "A skill that the person has.",
|
| - "id": "Skill",
|
| + "ListContactGroupsResponse": {
|
| + "description": "The response to a list contact groups request.",
|
| + "id": "ListContactGroupsResponse",
|
| "properties": {
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the skill."
|
| + "contactGroups": {
|
| + "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
|
| + "items": {
|
| + "$ref": "ContactGroup"
|
| + },
|
| + "type": "array"
|
| },
|
| - "value": {
|
| - "description": "The skill; for example, `underwater basket weaving`.",
|
| + "nextPageToken": {
|
| + "description": "The token that can be used to retrieve the next page of results.",
|
| "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.",
|
| + "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"
|
| },
|
| - "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",
|
| + "PersonResponse": {
|
| + "description": "The response for a single person",
|
| + "id": "PersonResponse",
|
| "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/month where the day is not significant.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "person": {
|
| + "$ref": "Person",
|
| + "description": "The person."
|
| },
|
| - "year": {
|
| - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "status": {
|
| + "$ref": "Status",
|
| + "description": "The status of the response."
|
| },
|
| - "month": {
|
| - "description": "Month of year. Must be from 1 to 12.",
|
| + "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"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Name": {
|
| - "description": "A person's name. If the name is a mononym, the family name is empty.",
|
| - "id": "Name",
|
| + "Relation": {
|
| + "description": "A person's relation to another person.",
|
| + "id": "Relation",
|
| "properties": {
|
| - "honorificPrefix": {
|
| - "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
|
| - "type": "string"
|
| - },
|
| - "phoneticHonorificSuffix": {
|
| - "description": "The honorific suffixes spelled as they sound.",
|
| - "type": "string"
|
| - },
|
| - "givenName": {
|
| - "description": "The given name.",
|
| - "type": "string"
|
| - },
|
| - "middleName": {
|
| - "description": "The middle name(s).",
|
| - "type": "string"
|
| - },
|
| - "phoneticHonorificPrefix": {
|
| - "description": "The honorific prefixes spelled as they sound.",
|
| - "type": "string"
|
| - },
|
| - "phoneticGivenName": {
|
| - "description": "The given name spelled as it sounds.",
|
| - "type": "string"
|
| - },
|
| - "phoneticFamilyName": {
|
| - "description": "The family name spelled as it sounds.",
|
| - "type": "string"
|
| - },
|
| - "familyName": {
|
| - "description": "The family name.",
|
| + "type": {
|
| + "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following 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"
|
| },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the name."
|
| - },
|
| - "phoneticMiddleName": {
|
| - "description": "The middle name(s) spelled as they sound.",
|
| - "type": "string"
|
| - },
|
| - "phoneticFullName": {
|
| - "description": "The full name spelled as it sounds.",
|
| - "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<code>Accept-Language</code> HTTP header.",
|
| - "type": "string"
|
| + "description": "Metadata about the relation."
|
| },
|
| - "displayName": {
|
| - "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the <code>Accept-Language</code> HTTP header.",
|
| + "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"
|
| },
|
| - "honorificSuffix": {
|
| - "description": "The honorific suffixes, such as `Jr.`",
|
| + "person": {
|
| + "description": "The name of the other person this relation refers to.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Locale": {
|
| - "description": "A person's locale preference.",
|
| - "id": "Locale",
|
| + "Occupation": {
|
| + "description": "A person's occupation.",
|
| + "id": "Occupation",
|
| "properties": {
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the locale."
|
| + "description": "Metadata about the occupation."
|
| },
|
| "value": {
|
| - "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
|
| + "description": "The occupation; for example, `carpenter`.",
|
| "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"
|
| - },
|
| - "Biography": {
|
| - "description": "A person's short biography.",
|
| - "id": "Biography",
|
| + "ContactGroup": {
|
| + "description": "A contact group.",
|
| + "id": "ContactGroup",
|
| "properties": {
|
| - "contentType": {
|
| - "description": "The content type of the biography.",
|
| + "resourceName": {
|
| + "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`<var>contact_group_id</var>.",
|
| + "type": "string"
|
| + },
|
| + "etag": {
|
| + "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
|
| + "type": "string"
|
| + },
|
| + "groupType": {
|
| + "description": "The read-only contact group type.",
|
| "enum": [
|
| - "CONTENT_TYPE_UNSPECIFIED",
|
| - "TEXT_PLAIN",
|
| - "TEXT_HTML"
|
| + "GROUP_TYPE_UNSPECIFIED",
|
| + "USER_CONTACT_GROUP",
|
| + "SYSTEM_CONTACT_GROUP"
|
| ],
|
| "enumDescriptions": [
|
| "Unspecified.",
|
| - "Plain text.",
|
| - "HTML text."
|
| + "User defined contact group.",
|
| + "System defined contact group."
|
| ],
|
| "type": "string"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the biography."
|
| + "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"
|
| },
|
| - "value": {
|
| - "description": "The short biography.",
|
| + "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"
|
| + },
|
| + "name": {
|
| + "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "FieldMetadata": {
|
| - "description": "Metadata about a field.",
|
| - "id": "FieldMetadata",
|
| - "properties": {
|
| - "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"
|
| + "metadata": {
|
| + "$ref": "ContactGroupMetadata",
|
| + "description": "Metadata about the contact group."
|
| },
|
| - "primary": {
|
| - "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
|
| - "type": "boolean"
|
| + "memberCount": {
|
| + "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Source": {
|
| - "description": "The source of a field.",
|
| - "id": "Source",
|
| + "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": {
|
| - "etag": {
|
| - "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "The unique identifier within the source type generated by the server.",
|
| - "type": "string"
|
| - },
|
| - "profileMetadata": {
|
| - "$ref": "ProfileMetadata",
|
| - "description": "Metadata about a source of type PROFILE."
|
| + "relationshipStatuses": {
|
| + "description": "The person's read-only relationship statuses.",
|
| + "items": {
|
| + "$ref": "RelationshipStatus"
|
| + },
|
| + "type": "array"
|
| },
|
| - "updateTime": {
|
| - "description": "Last update timestamp of this source.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "photos": {
|
| + "description": "The person's read-only photos.",
|
| + "items": {
|
| + "$ref": "Photo"
|
| + },
|
| + "type": "array"
|
| },
|
| - "type": {
|
| - "description": "The source type.",
|
| + "ageRange": {
|
| + "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only age range.",
|
| "enum": [
|
| - "SOURCE_TYPE_UNSPECIFIED",
|
| - "ACCOUNT",
|
| - "PROFILE",
|
| - "DOMAIN_PROFILE",
|
| - "CONTACT"
|
| + "AGE_RANGE_UNSPECIFIED",
|
| + "LESS_THAN_EIGHTEEN",
|
| + "EIGHTEEN_TO_TWENTY",
|
| + "TWENTY_ONE_OR_OLDER"
|
| ],
|
| "enumDescriptions": [
|
| "Unspecified.",
|
| - "[Google Account](https://accounts.google.com).",
|
| - "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/<var>id</var> where\n<var>id</var> is the source id.",
|
| - "[Google Apps domain profile](https://admin.google.com).",
|
| - "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/<var>id</var> where <var>id</var>\nis the source id."
|
| + "Younger than eighteen.",
|
| + "Between eighteen and twenty.",
|
| + "Twenty-one and older."
|
| ],
|
| "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."
|
| + "taglines": {
|
| + "description": "The person's read-only taglines.",
|
| + "items": {
|
| + "$ref": "Tagline"
|
| + },
|
| + "type": "array"
|
| },
|
| - "value": {
|
| - "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "GetPeopleResponse": {
|
| - "id": "GetPeopleResponse",
|
| - "properties": {
|
| - "responses": {
|
| - "description": "The response for each requested resource name.",
|
| + "ageRanges": {
|
| + "description": "The person's read-only age ranges.",
|
| "items": {
|
| - "$ref": "PersonResponse"
|
| + "$ref": "AgeRangeType"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "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": {
|
| - "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=<size>` 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"
|
| - },
|
| - "PhoneNumber": {
|
| - "description": "A person's phone number.",
|
| - "id": "PhoneNumber",
|
| - "properties": {
|
| - "type": {
|
| - "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\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"
|
| + "addresses": {
|
| + "description": "The person's street addresses.",
|
| + "items": {
|
| + "$ref": "Address"
|
| + },
|
| + "type": "array"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the phone number."
|
| + "events": {
|
| + "description": "The person's events.",
|
| + "items": {
|
| + "$ref": "Event"
|
| + },
|
| + "type": "array"
|
| },
|
| - "value": {
|
| - "description": "The phone number.",
|
| - "type": "string"
|
| + "memberships": {
|
| + "description": "The person's read-only group memberships.",
|
| + "items": {
|
| + "$ref": "Membership"
|
| + },
|
| + "type": "array"
|
| },
|
| - "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"
|
| + "phoneNumbers": {
|
| + "description": "The person's phone numbers.",
|
| + "items": {
|
| + "$ref": "PhoneNumber"
|
| + },
|
| + "type": "array"
|
| },
|
| - "canonicalForm": {
|
| - "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListConnectionsResponse": {
|
| - "id": "ListConnectionsResponse",
|
| - "properties": {
|
| - "nextPageToken": {
|
| - "description": "The token that can be used to retrieve the next page of results.",
|
| + "coverPhotos": {
|
| + "description": "The person's read-only cover photos.",
|
| + "items": {
|
| + "$ref": "CoverPhoto"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "imClients": {
|
| + "description": "The person's instant messaging clients.",
|
| + "items": {
|
| + "$ref": "ImClient"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "birthdays": {
|
| + "description": "The person's birthdays.",
|
| + "items": {
|
| + "$ref": "Birthday"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "locales": {
|
| + "description": "The person's locale preferences.",
|
| + "items": {
|
| + "$ref": "Locale"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "relationshipInterests": {
|
| + "description": "The person's read-only relationship interests.",
|
| + "items": {
|
| + "$ref": "RelationshipInterest"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "urls": {
|
| + "description": "The person's associated URLs.",
|
| + "items": {
|
| + "$ref": "Url"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "nicknames": {
|
| + "description": "The person's nicknames.",
|
| + "items": {
|
| + "$ref": "Nickname"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "relations": {
|
| + "description": "The person's relations.",
|
| + "items": {
|
| + "$ref": "Relation"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "names": {
|
| + "description": "The person's names.",
|
| + "items": {
|
| + "$ref": "Name"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "occupations": {
|
| + "description": "The person's occupations.",
|
| + "items": {
|
| + "$ref": "Occupation"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "emailAddresses": {
|
| + "description": "The person's email addresses.",
|
| + "items": {
|
| + "$ref": "EmailAddress"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "organizations": {
|
| + "description": "The person's past or current organizations.",
|
| + "items": {
|
| + "$ref": "Organization"
|
| + },
|
| + "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"
|
| },
|
| - "totalItems": {
|
| - "description": "The total number of items in the list without pagination.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "braggingRights": {
|
| + "description": "The person's bragging rights.",
|
| + "items": {
|
| + "$ref": "BraggingRights"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "metadata": {
|
| + "$ref": "PersonMetadata",
|
| + "description": "Read-only metadata about the person."
|
| + },
|
| + "residences": {
|
| + "description": "The person's residences.",
|
| + "items": {
|
| + "$ref": "Residence"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "genders": {
|
| + "description": "The person's genders.",
|
| + "items": {
|
| + "$ref": "Gender"
|
| + },
|
| + "type": "array"
|
| },
|
| - "nextSyncToken": {
|
| - "description": "The token that can be used to retrieve changes since the last request.",
|
| + "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/`<var>person_id</var>.",
|
| "type": "string"
|
| },
|
| - "connections": {
|
| - "description": "The list of people that the requestor is connected to.",
|
| + "interests": {
|
| + "description": "The person's interests.",
|
| "items": {
|
| - "$ref": "Person"
|
| + "$ref": "Interest"
|
| },
|
| "type": "array"
|
| },
|
| - "totalPeople": {
|
| - "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "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."
|
| - },
|
| - "text": {
|
| - "description": "A free-form string representing the user's birthday.",
|
| - "type": "string"
|
| + "biographies": {
|
| + "description": "The person's biographies.",
|
| + "items": {
|
| + "$ref": "Biography"
|
| + },
|
| + "type": "array"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the birthday."
|
| + "skills": {
|
| + "description": "The person's skills.",
|
| + "items": {
|
| + "$ref": "Skill"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CreateContactGroupRequest": {
|
| - "description": "A request to create a new contact group.",
|
| - "id": "CreateContactGroupRequest",
|
| + "UpdateContactGroupRequest": {
|
| + "description": "A request to update an existing contact group. Only the name can be updated.",
|
| + "id": "UpdateContactGroupRequest",
|
| "properties": {
|
| "contactGroup": {
|
| "$ref": "ContactGroup",
|
| - "description": "The contact group to create."
|
| + "description": "The contact group to update."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Address": {
|
| - "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
|
| - "id": "Address",
|
| + "ContactGroupMetadata": {
|
| + "description": "The read-only metadata about a contact group.",
|
| + "id": "ContactGroupMetadata",
|
| "properties": {
|
| - "countryCode": {
|
| - "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
|
| - "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"
|
| + "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"
|
| },
|
| - "city": {
|
| - "description": "The city of the address.",
|
| + "updateTime": {
|
| + "description": "The time the group was last updated.",
|
| + "format": "google-datetime",
|
| "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"
|
| },
|
| - "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 residence."
|
| },
|
| - "country": {
|
| - "description": "The country of the address.",
|
| + "value": {
|
| + "description": "The address of the residence.",
|
| "type": "string"
|
| - },
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Event": {
|
| + "description": "An event related to the person.",
|
| + "id": "Event",
|
| + "properties": {
|
| "type": {
|
| - "description": "The type of the address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
|
| - "type": "string"
|
| - },
|
| - "extendedAddress": {
|
| - "description": "The extended address of the address; for example, the apartment number.",
|
| - "type": "string"
|
| - },
|
| - "poBox": {
|
| - "description": "The P.O. box of the address.",
|
| + "description": "The type of the event. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `anniversary`\n* `other`",
|
| "type": "string"
|
| },
|
| - "postalCode": {
|
| - "description": "The postal code of the address.",
|
| - "type": "string"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the event."
|
| },
|
| - "region": {
|
| - "description": "The region of the address; for example, the state or province.",
|
| - "type": "string"
|
| + "date": {
|
| + "$ref": "Date",
|
| + "description": "The date of the event."
|
| },
|
| - "streetAddress": {
|
| - "description": "The street address.",
|
| + "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 address."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Status": {
|
| - "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[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 message,\nand 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",
|
| + "ModifyContactGroupMembersResponse": {
|
| + "description": "The response to a modify contact group members request.",
|
| + "id": "ModifyContactGroupMembersResponse",
|
| "properties": {
|
| - "code": {
|
| - "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "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"
|
| - },
|
| - "details": {
|
| - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
|
| + "notFoundResourceNames": {
|
| + "description": "The contact people resource names that were not found.",
|
| "items": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "type": "object"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "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 predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "PersonMetadata": {
|
| - "description": "The read-only metadata about a person.",
|
| - "id": "PersonMetadata",
|
| + "ProfileMetadata": {
|
| + "description": "The read-only metadata about a profile.",
|
| + "id": "ProfileMetadata",
|
| "properties": {
|
| "objectType": {
|
| - "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
|
| + "description": "The profile object type.",
|
| "enum": [
|
| "OBJECT_TYPE_UNSPECIFIED",
|
| "PERSON",
|
| @@ -1680,268 +1672,276 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "linkedPeopleResourceNames": {
|
| - "description": "Resource names of people linked to this resource.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "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.",
|
| + "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 Google Apps for Work user."
|
| + ],
|
| "items": {
|
| + "enum": [
|
| + "USER_TYPE_UNKNOWN",
|
| + "GOOGLE_USER",
|
| + "GPLUS_USER",
|
| + "GOOGLE_APPS_USER"
|
| + ],
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "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"
|
| },
|
| - "sources": {
|
| - "description": "The sources of data for the person.",
|
| - "items": {
|
| - "$ref": "Source"
|
| - },
|
| - "type": "array"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the gender."
|
| },
|
| - "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"
|
| + "value": {
|
| + "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ModifyContactGroupMembersRequest": {
|
| - "description": "A request to modify an existing contact group's members.",
|
| - "id": "ModifyContactGroupMembersRequest",
|
| + "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": {
|
| - "resourceNamesToRemove": {
|
| - "description": "The resource names of the contact people to remove in the form of in the\nform of `people/<person_id>`.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "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"
|
| },
|
| - "resourceNamesToAdd": {
|
| - "description": "The resource names of the contact people to add in the form of in the form\n`people/<person_id>`.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the cover photo."
|
| + },
|
| + "url": {
|
| + "description": "The URL of the cover photo.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ContactGroupResponse": {
|
| - "description": "The response for a specific contact group.",
|
| - "id": "ContactGroupResponse",
|
| + "Interest": {
|
| + "description": "One of the person's interests.",
|
| + "id": "Interest",
|
| "properties": {
|
| - "contactGroup": {
|
| - "$ref": "ContactGroup",
|
| - "description": "The contact group."
|
| - },
|
| - "status": {
|
| - "$ref": "Status",
|
| - "description": "The status of the response."
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the interest."
|
| },
|
| - "requestedResourceName": {
|
| - "description": "The original requested resource name.",
|
| + "value": {
|
| + "description": "The interest; for example, `stargazing`.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Url": {
|
| - "description": "A person's associated URLs.",
|
| - "id": "Url",
|
| + "Nickname": {
|
| + "description": "A person's nickname.",
|
| + "id": "Nickname",
|
| "properties": {
|
| + "value": {
|
| + "description": "The nickname.",
|
| + "type": "string"
|
| + },
|
| "type": {
|
| - "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
|
| + "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"
|
| },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the URL."
|
| - },
|
| - "value": {
|
| - "description": "The URL.",
|
| - "type": "string"
|
| - },
|
| - "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"
|
| + "description": "Metadata about the nickname."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ImClient": {
|
| - "description": "A person's instant messaging client.",
|
| - "id": "ImClient",
|
| + "EmailAddress": {
|
| + "description": "A person's email address.",
|
| + "id": "EmailAddress",
|
| "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.",
|
| + "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 IM client."
|
| + "displayName": {
|
| + "description": "The display name of the email.",
|
| + "type": "string"
|
| },
|
| "type": {
|
| - "description": "The type of the IM client. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
|
| + "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
|
| "type": "string"
|
| },
|
| - "protocol": {
|
| - "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
|
| - "type": "string"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the email address."
|
| },
|
| - "username": {
|
| - "description": "The user name used in the IM client.",
|
| + "value": {
|
| + "description": "The email address.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DomainMembership": {
|
| - "description": "A Google Apps Domain membership.",
|
| - "id": "DomainMembership",
|
| - "properties": {
|
| - "inViewerDomain": {
|
| - "description": "True if the person is in the viewer's Google Apps domain.",
|
| - "type": "boolean"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Membership": {
|
| - "description": "A person's read-only membership in a group.",
|
| - "id": "Membership",
|
| + "Skill": {
|
| + "description": "A skill that the person has.",
|
| + "id": "Skill",
|
| "properties": {
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the membership."
|
| - },
|
| - "domainMembership": {
|
| - "$ref": "DomainMembership",
|
| - "description": "The domain membership."
|
| + "description": "Metadata about the skill."
|
| },
|
| - "contactGroupMembership": {
|
| - "$ref": "ContactGroupMembership",
|
| - "description": "The contact group membership."
|
| + "value": {
|
| + "description": "The skill; for example, `underwater basket weaving`.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "BatchGetContactGroupsResponse": {
|
| - "description": "The response to a batch get contact groups request.",
|
| - "id": "BatchGetContactGroupsResponse",
|
| + "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": {
|
| - "responses": {
|
| - "description": "The list of responses for each requested contact group resource.",
|
| - "items": {
|
| - "$ref": "ContactGroupResponse"
|
| - },
|
| - "type": "array"
|
| + "day": {
|
| + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
|
| + "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"
|
| + },
|
| + "month": {
|
| + "description": "Month of year. Must be from 1 to 12.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "RelationshipStatus": {
|
| - "description": "A person's read-only relationship status.",
|
| - "id": "RelationshipStatus",
|
| + "Tagline": {
|
| + "description": "A read-only brief one-line description of the person.",
|
| + "id": "Tagline",
|
| "properties": {
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the relationship status."
|
| - },
|
| "value": {
|
| - "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
|
| + "description": "The tagline.",
|
| "type": "string"
|
| },
|
| - "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"
|
| - }
|
| - },
|
| - "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"
|
| + "description": "Metadata about the tagline."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Organization": {
|
| - "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
|
| - "id": "Organization",
|
| + "Name": {
|
| + "description": "A person's name. If the name is a mononym, the family name is empty.",
|
| + "id": "Name",
|
| "properties": {
|
| - "endDate": {
|
| - "$ref": "Date",
|
| - "description": "The end date when the person left the organization."
|
| + "phoneticHonorificPrefix": {
|
| + "description": "The honorific prefixes spelled as they sound.",
|
| + "type": "string"
|
| },
|
| - "symbol": {
|
| - "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
|
| + "phoneticGivenName": {
|
| + "description": "The given name spelled as it sounds.",
|
| "type": "string"
|
| },
|
| - "name": {
|
| - "description": "The name of the organization.",
|
| + "phoneticFamilyName": {
|
| + "description": "The family name spelled as it sounds.",
|
| + "type": "string"
|
| + },
|
| + "familyName": {
|
| + "description": "The family name.",
|
| "type": "string"
|
| },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| - "description": "Metadata about the organization."
|
| + "description": "Metadata about the name."
|
| },
|
| - "location": {
|
| - "description": "The location of the organization office the person works at.",
|
| + "phoneticMiddleName": {
|
| + "description": "The middle name(s) spelled as they sound.",
|
| "type": "string"
|
| },
|
| - "title": {
|
| - "description": "The person's job title at the organization.",
|
| + "phoneticFullName": {
|
| + "description": "The full name spelled as it sounds.",
|
| "type": "string"
|
| },
|
| - "current": {
|
| - "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
|
| - "type": "boolean"
|
| + "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"
|
| },
|
| - "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.",
|
| + "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"
|
| },
|
| - "startDate": {
|
| - "$ref": "Date",
|
| - "description": "The start date when the person joined the organization."
|
| + "honorificSuffix": {
|
| + "description": "The honorific suffixes, such as `Jr.`",
|
| + "type": "string"
|
| },
|
| - "domain": {
|
| - "description": "The domain name associated with the organization; for example, `google.com`.",
|
| + "honorificPrefix": {
|
| + "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
|
| "type": "string"
|
| },
|
| - "department": {
|
| - "description": "The person's department at the organization.",
|
| + "phoneticHonorificSuffix": {
|
| + "description": "The honorific suffixes spelled as they sound.",
|
| "type": "string"
|
| },
|
| - "type": {
|
| - "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
|
| + "middleName": {
|
| + "description": "The middle name(s).",
|
| "type": "string"
|
| },
|
| - "phoneticName": {
|
| - "description": "The phonetic name of the organization.",
|
| + "givenName": {
|
| + "description": "The given name.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Locale": {
|
| + "description": "A person's locale preference.",
|
| + "id": "Locale",
|
| + "properties": {
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the locale."
|
| },
|
| - "jobDescription": {
|
| - "description": "The person's job description at the organization.",
|
| + "value": {
|
| + "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
|
| "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"
|
| }
|
| },
|
| "servicePath": "",
|
|
|
Chromium Code Reviews
Issue 2987103002:
Api-Roll 52: 2017-07-31 (Closed)
