| Index: discovery/googleapis/people__v1.json
|
| diff --git a/discovery/googleapis/people__v1.json b/discovery/googleapis/people__v1.json
|
| index d7dd1caa86fd13339adfd8cdd5966b86296fd21d..95691947cb64847a266ada06b867634a4e52f0c7 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.birthday.read": {
|
| + "description": "View your complete date of birth"
|
| + },
|
| + "https://www.googleapis.com/auth/contacts.readonly": {
|
| + "description": "View your contacts"
|
| + },
|
| "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.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/contacts": {
|
| "description": "Manage your contacts"
|
| },
|
| - "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/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/user.birthday.read": {
|
| - "description": "View your complete date of birth"
|
| - },
|
| - "https://www.googleapis.com/auth/contacts.readonly": {
|
| - "description": "View your contacts"
|
| }
|
| }
|
| }
|
| @@ -49,16 +49,6 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "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",
|
| @@ -70,13 +60,18 @@
|
| "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"
|
| },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "callback": {
|
| + "description": "JSONP",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -93,11 +88,6 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "callback": {
|
| - "description": "JSONP",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| @@ -114,13 +104,13 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -134,120 +124,95 @@
|
| "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"
|
| }
|
| },
|
| "protocol": "rest",
|
| "resources": {
|
| - "contactGroups": {
|
| + "people": {
|
| "methods": {
|
| - "get": {
|
| - "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
|
| - "httpMethod": "GET",
|
| - "id": "people.contactGroups.get",
|
| + "updateContact": {
|
| + "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n<br>\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n<br>\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
|
| + "httpMethod": "PATCH",
|
| + "id": "people.people.updateContact",
|
| "parameterOrder": [
|
| "resourceName"
|
| ],
|
| "parameters": {
|
| - "maxMembers": {
|
| - "description": "Specifies the maximum number of members to return.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| "resourceName": {
|
| - "description": "The resource name of the contact group to get.",
|
| + "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": "^contactGroups/[^/]+$",
|
| + "pattern": "^people/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+resourceName}",
|
| - "response": {
|
| - "$ref": "ContactGroup"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/contacts",
|
| - "https://www.googleapis.com/auth/contacts.readonly"
|
| - ]
|
| - },
|
| - "update": {
|
| - "description": "Update the name of an existing contact group owned by the authenticated\nuser.",
|
| - "httpMethod": "PUT",
|
| - "id": "people.contactGroups.update",
|
| - "parameterOrder": [
|
| - "resourceName"
|
| - ],
|
| - "parameters": {
|
| - "resourceName": {
|
| - "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`<var>contact_group_id</var>.",
|
| - "location": "path",
|
| - "pattern": "^contactGroups/[^/]+$",
|
| - "required": true,
|
| + },
|
| + "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"
|
| }
|
| },
|
| - "path": "v1/{+resourceName}",
|
| + "path": "v1/{+resourceName}:updateContact",
|
| "request": {
|
| - "$ref": "UpdateContactGroupRequest"
|
| + "$ref": "Person"
|
| },
|
| "response": {
|
| - "$ref": "ContactGroup"
|
| + "$ref": "Person"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/contacts"
|
| ]
|
| },
|
| - "batchGet": {
|
| - "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.",
|
| - "httpMethod": "GET",
|
| - "id": "people.contactGroups.batchGet",
|
| + "createContact": {
|
| + "description": "Create a new contact and return the person resource for that contact.",
|
| + "httpMethod": "POST",
|
| + "id": "people.people.createContact",
|
| "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.",
|
| + "parent": {
|
| + "description": "The resource name of the owning person resource.",
|
| "location": "query",
|
| - "repeated": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/contactGroups:batchGet",
|
| + "path": "v1/people:createContact",
|
| + "request": {
|
| + "$ref": "Person"
|
| + },
|
| "response": {
|
| - "$ref": "BatchGetContactGroupsResponse"
|
| + "$ref": "Person"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/contacts",
|
| - "https://www.googleapis.com/auth/contacts.readonly"
|
| + "https://www.googleapis.com/auth/contacts"
|
| ]
|
| },
|
| - "delete": {
|
| - "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
|
| + "deleteContact": {
|
| + "description": "Delete a contact person. Any non-contact data will not be deleted.",
|
| "httpMethod": "DELETE",
|
| - "id": "people.contactGroups.delete",
|
| + "id": "people.people.deleteContact",
|
| "parameterOrder": [
|
| "resourceName"
|
| ],
|
| "parameters": {
|
| - "deleteContacts": {
|
| - "description": "Set to true to also delete the contacts in the specified group.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| "resourceName": {
|
| - "description": "The resource name of the contact group to delete.",
|
| + "description": "The resource name of the contact to delete.",
|
| "location": "path",
|
| - "pattern": "^contactGroups/[^/]+$",
|
| + "pattern": "^people/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resourceName}",
|
| + "path": "v1/{+resourceName}:deleteContact",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| @@ -255,109 +220,219 @@
|
| "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.",
|
| + "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.contactGroups.list",
|
| + "id": "people.people.getBatchGet",
|
| "parameterOrder": [],
|
| "parameters": {
|
| - "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.",
|
| + "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"
|
| },
|
| - "pageSize": {
|
| - "description": "The maximum number of resources to return.",
|
| - "format": "int32",
|
| + "requestMask.includeField": {
|
| + "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
|
| + "format": "google-fieldmask",
|
| "location": "query",
|
| - "type": "integer"
|
| + "type": "string"
|
| },
|
| - "syncToken": {
|
| - "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
|
| + "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"
|
| }
|
| },
|
| - "path": "v1/contactGroups",
|
| + "path": "v1/people:batchGet",
|
| "response": {
|
| - "$ref": "ListContactGroupsResponse"
|
| + "$ref": "GetPeopleResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/contacts",
|
| - "https://www.googleapis.com/auth/contacts.readonly"
|
| + "https://www.googleapis.com/auth/contacts.readonly",
|
| + "https://www.googleapis.com/auth/plus.login",
|
| + "https://www.googleapis.com/auth/user.addresses.read",
|
| + "https://www.googleapis.com/auth/user.birthday.read",
|
| + "https://www.googleapis.com/auth/user.emails.read",
|
| + "https://www.googleapis.com/auth/user.phonenumbers.read",
|
| + "https://www.googleapis.com/auth/userinfo.email",
|
| + "https://www.googleapis.com/auth/userinfo.profile"
|
| ]
|
| },
|
| - "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"
|
| + "get": {
|
| + "description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n<br>\nThe request throws a 400 error if 'personFields' is not specified.",
|
| + "httpMethod": "GET",
|
| + "id": "people.people.get",
|
| + "parameterOrder": [
|
| + "resourceName"
|
| + ],
|
| + "parameters": {
|
| + "resourceName": {
|
| + "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`<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,
|
| + "type": "string"
|
| + },
|
| + "personFields": {
|
| + "description": "**Required.** A field mask to restrict which fields on the 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"
|
| + },
|
| + "requestMask.includeField": {
|
| + "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| },
|
| + "path": "v1/{+resourceName}",
|
| "response": {
|
| - "$ref": "ContactGroup"
|
| + "$ref": "Person"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/contacts"
|
| + "https://www.googleapis.com/auth/contacts",
|
| + "https://www.googleapis.com/auth/contacts.readonly",
|
| + "https://www.googleapis.com/auth/plus.login",
|
| + "https://www.googleapis.com/auth/user.addresses.read",
|
| + "https://www.googleapis.com/auth/user.birthday.read",
|
| + "https://www.googleapis.com/auth/user.emails.read",
|
| + "https://www.googleapis.com/auth/user.phonenumbers.read",
|
| + "https://www.googleapis.com/auth/userinfo.email",
|
| + "https://www.googleapis.com/auth/userinfo.profile"
|
| ]
|
| }
|
| },
|
| "resources": {
|
| - "members": {
|
| + "connections": {
|
| "methods": {
|
| - "modify": {
|
| - "description": "Modify the members of a contact group owned by the authenticated user.",
|
| - "httpMethod": "POST",
|
| - "id": "people.contactGroups.members.modify",
|
| + "list": {
|
| + "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n<br>\nThe request throws a 400 error if 'personFields' is not specified.",
|
| + "httpMethod": "GET",
|
| + "id": "people.people.connections.list",
|
| "parameterOrder": [
|
| "resourceName"
|
| ],
|
| "parameters": {
|
| + "sortOrder": {
|
| + "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
|
| + "enum": [
|
| + "LAST_MODIFIED_ASCENDING",
|
| + "FIRST_NAME_ASCENDING",
|
| + "LAST_NAME_ASCENDING"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "requestSyncToken": {
|
| + "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| "resourceName": {
|
| - "description": "The resource name of the contact group to modify.",
|
| + "description": "The resource name to return connections for. Only `people/me` is valid.",
|
| "location": "path",
|
| - "pattern": "^contactGroups/[^/]+$",
|
| + "pattern": "^people/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "The token of the page to be returned.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "requestMask.includeField": {
|
| + "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "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",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resourceName}/members:modify",
|
| - "request": {
|
| - "$ref": "ModifyContactGroupMembersRequest"
|
| - },
|
| + "path": "v1/{+resourceName}/connections",
|
| "response": {
|
| - "$ref": "ModifyContactGroupMembersResponse"
|
| + "$ref": "ListConnectionsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/contacts"
|
| + "https://www.googleapis.com/auth/contacts",
|
| + "https://www.googleapis.com/auth/contacts.readonly"
|
| ]
|
| }
|
| }
|
| }
|
| }
|
| },
|
| - "people": {
|
| + "contactGroups": {
|
| "methods": {
|
| - "deleteContact": {
|
| - "description": "Delete a contact person. Any non-contact data will not be deleted.",
|
| + "batchGet": {
|
| + "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.",
|
| + "httpMethod": "GET",
|
| + "id": "people.contactGroups.batchGet",
|
| + "parameterOrder": [],
|
| + "parameters": {
|
| + "maxMembers": {
|
| + "description": "Specifies the maximum number of members to return for each group.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "resourceNames": {
|
| + "description": "The resource names of the contact groups to get.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/contactGroups:batchGet",
|
| + "response": {
|
| + "$ref": "BatchGetContactGroupsResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/contacts",
|
| + "https://www.googleapis.com/auth/contacts.readonly"
|
| + ]
|
| + },
|
| + "delete": {
|
| + "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
|
| "httpMethod": "DELETE",
|
| - "id": "people.people.deleteContact",
|
| + "id": "people.contactGroups.delete",
|
| "parameterOrder": [
|
| "resourceName"
|
| ],
|
| "parameters": {
|
| "resourceName": {
|
| - "description": "The resource name of the contact to delete.",
|
| + "description": "The resource name of the contact group to delete.",
|
| "location": "path",
|
| - "pattern": "^people/[^/]+$",
|
| + "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}:deleteContact",
|
| + "path": "v1/{+resourceName}",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| @@ -365,142 +440,108 @@
|
| "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.",
|
| + "list": {
|
| + "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
|
| "httpMethod": "GET",
|
| - "id": "people.people.getBatchGet",
|
| + "id": "people.contactGroups.list",
|
| "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`.",
|
| - "format": "google-fieldmask",
|
| + "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"
|
| },
|
| - "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.",
|
| + "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",
|
| - "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",
|
| + "pageSize": {
|
| + "description": "The maximum number of resources to return.",
|
| + "format": "int32",
|
| "location": "query",
|
| - "type": "string"
|
| + "type": "integer"
|
| }
|
| },
|
| - "path": "v1/people:batchGet",
|
| + "path": "v1/contactGroups",
|
| "response": {
|
| - "$ref": "GetPeopleResponse"
|
| + "$ref": "ListContactGroupsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/contacts",
|
| - "https://www.googleapis.com/auth/contacts.readonly",
|
| - "https://www.googleapis.com/auth/plus.login",
|
| - "https://www.googleapis.com/auth/user.addresses.read",
|
| - "https://www.googleapis.com/auth/user.birthday.read",
|
| - "https://www.googleapis.com/auth/user.emails.read",
|
| - "https://www.googleapis.com/auth/user.phonenumbers.read",
|
| - "https://www.googleapis.com/auth/userinfo.email",
|
| - "https://www.googleapis.com/auth/userinfo.profile"
|
| + "https://www.googleapis.com/auth/contacts.readonly"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n<br>\nThe request throws a 400 error if 'personFields' is not specified.",
|
| - "httpMethod": "GET",
|
| - "id": "people.people.get",
|
| - "parameterOrder": [
|
| - "resourceName"
|
| - ],
|
| - "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`.",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "personFields": {
|
| - "description": "**Required.** A field mask to restrict which fields on the 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"
|
| - },
|
| - "resourceName": {
|
| - "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`<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,
|
| - "type": "string"
|
| - }
|
| + "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"
|
| },
|
| - "path": "v1/{+resourceName}",
|
| "response": {
|
| - "$ref": "Person"
|
| + "$ref": "ContactGroup"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/contacts",
|
| - "https://www.googleapis.com/auth/contacts.readonly",
|
| - "https://www.googleapis.com/auth/plus.login",
|
| - "https://www.googleapis.com/auth/user.addresses.read",
|
| - "https://www.googleapis.com/auth/user.birthday.read",
|
| - "https://www.googleapis.com/auth/user.emails.read",
|
| - "https://www.googleapis.com/auth/user.phonenumbers.read",
|
| - "https://www.googleapis.com/auth/userinfo.email",
|
| - "https://www.googleapis.com/auth/userinfo.profile"
|
| + "https://www.googleapis.com/auth/contacts"
|
| ]
|
| },
|
| - "updateContact": {
|
| - "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n<br>\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n<br>\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
|
| - "httpMethod": "PATCH",
|
| - "id": "people.people.updateContact",
|
| + "get": {
|
| + "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
|
| + "httpMethod": "GET",
|
| + "id": "people.contactGroups.get",
|
| "parameterOrder": [
|
| "resourceName"
|
| ],
|
| "parameters": {
|
| - "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",
|
| + "maxMembers": {
|
| + "description": "Specifies the maximum number of members to return.",
|
| + "format": "int32",
|
| "location": "query",
|
| - "type": "string"
|
| + "type": "integer"
|
| },
|
| "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>.",
|
| + "description": "The resource name of the contact group to get.",
|
| "location": "path",
|
| - "pattern": "^people/[^/]+$",
|
| + "pattern": "^contactGroups/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resourceName}:updateContact",
|
| - "request": {
|
| - "$ref": "Person"
|
| - },
|
| + "path": "v1/{+resourceName}",
|
| "response": {
|
| - "$ref": "Person"
|
| + "$ref": "ContactGroup"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/contacts"
|
| + "https://www.googleapis.com/auth/contacts",
|
| + "https://www.googleapis.com/auth/contacts.readonly"
|
| ]
|
| },
|
| - "createContact": {
|
| - "description": "Create a new contact and return the person resource for that contact.",
|
| - "httpMethod": "POST",
|
| - "id": "people.people.createContact",
|
| - "parameterOrder": [],
|
| + "update": {
|
| + "description": "Update the name of an existing contact group owned by the authenticated\nuser.",
|
| + "httpMethod": "PUT",
|
| + "id": "people.contactGroups.update",
|
| + "parameterOrder": [
|
| + "resourceName"
|
| + ],
|
| "parameters": {
|
| - "parent": {
|
| - "description": "The resource name of the owning person resource.",
|
| - "location": "query",
|
| + "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>.",
|
| + "location": "path",
|
| + "pattern": "^contactGroups/[^/]+$",
|
| + "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/people:createContact",
|
| + "path": "v1/{+resourceName}",
|
| "request": {
|
| - "$ref": "Person"
|
| + "$ref": "UpdateContactGroupRequest"
|
| },
|
| "response": {
|
| - "$ref": "Person"
|
| + "$ref": "ContactGroup"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/contacts"
|
| @@ -508,74 +549,33 @@
|
| }
|
| },
|
| "resources": {
|
| - "connections": {
|
| + "members": {
|
| "methods": {
|
| - "list": {
|
| - "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n<br>\nThe request throws a 400 error if 'personFields' is not specified.",
|
| - "httpMethod": "GET",
|
| - "id": "people.people.connections.list",
|
| + "modify": {
|
| + "description": "Modify the members of a contact group owned by the authenticated user.",
|
| + "httpMethod": "POST",
|
| + "id": "people.contactGroups.members.modify",
|
| "parameterOrder": [
|
| "resourceName"
|
| ],
|
| "parameters": {
|
| - "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"
|
| - },
|
| - "sortOrder": {
|
| - "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
|
| - "enum": [
|
| - "LAST_MODIFIED_ASCENDING",
|
| - "FIRST_NAME_ASCENDING",
|
| - "LAST_NAME_ASCENDING"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "requestSyncToken": {
|
| - "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "pageToken": {
|
| - "description": "The token of the page to be returned.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "resourceName": {
|
| - "description": "The resource name to return connections for. Only `people/me` is valid.",
|
| + "description": "The resource name of the contact group to modify.",
|
| "location": "path",
|
| - "pattern": "^people/[^/]+$",
|
| + "pattern": "^contactGroups/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "requestMask.includeField": {
|
| - "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "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",
|
| + "path": "v1/{+resourceName}/members:modify",
|
| + "request": {
|
| + "$ref": "ModifyContactGroupMembersRequest"
|
| + },
|
| "response": {
|
| - "$ref": "ListConnectionsResponse"
|
| + "$ref": "ModifyContactGroupMembersResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/contacts",
|
| - "https://www.googleapis.com/auth/contacts.readonly"
|
| + "https://www.googleapis.com/auth/contacts"
|
| ]
|
| }
|
| }
|
| @@ -583,9 +583,40 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170817",
|
| + "revision": "20170907",
|
| "rootUrl": "https://people.googleapis.com/",
|
| "schemas": {
|
| + "ImClient": {
|
| + "description": "A person's instant messaging client.",
|
| + "id": "ImClient",
|
| + "properties": {
|
| + "formattedProtocol": {
|
| + "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
|
| + "type": "string"
|
| + },
|
| + "formattedType": {
|
| + "description": "The read-only type of the IM client translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
|
| + "type": "string"
|
| + },
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the IM client."
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| "DomainMembership": {
|
| "description": "A Google Apps Domain membership.",
|
| "id": "DomainMembership",
|
| @@ -597,6 +628,25 @@
|
| },
|
| "type": "object"
|
| },
|
| + "Membership": {
|
| + "description": "A person's read-only membership in a group.",
|
| + "id": "Membership",
|
| + "properties": {
|
| + "contactGroupMembership": {
|
| + "$ref": "ContactGroupMembership",
|
| + "description": "The contact group membership."
|
| + },
|
| + "domainMembership": {
|
| + "$ref": "DomainMembership",
|
| + "description": "The domain membership."
|
| + },
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the membership."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "BatchGetContactGroupsResponse": {
|
| "description": "The response to a batch get contact groups request.",
|
| "id": "BatchGetContactGroupsResponse",
|
| @@ -611,33 +661,10 @@
|
| },
|
| "type": "object"
|
| },
|
| - "Membership": {
|
| - "description": "A person's read-only membership in a group.",
|
| - "id": "Membership",
|
| - "properties": {
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the membership."
|
| - },
|
| - "domainMembership": {
|
| - "$ref": "DomainMembership",
|
| - "description": "The domain membership."
|
| - },
|
| - "contactGroupMembership": {
|
| - "$ref": "ContactGroupMembership",
|
| - "description": "The contact group membership."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "RelationshipStatus": {
|
| "description": "A person's read-only relationship status.",
|
| "id": "RelationshipStatus",
|
| "properties": {
|
| - "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"
|
| - },
|
| "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"
|
| @@ -645,6 +672,10 @@
|
| "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`",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -668,61 +699,61 @@
|
| "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
|
| "id": "Organization",
|
| "properties": {
|
| - "endDate": {
|
| + "startDate": {
|
| "$ref": "Date",
|
| - "description": "The end date when the person left the organization."
|
| + "description": "The start date when the person joined the organization."
|
| },
|
| - "symbol": {
|
| - "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
|
| + "formattedType": {
|
| + "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
|
| "type": "string"
|
| },
|
| - "name": {
|
| - "description": "The name of the organization.",
|
| + "domain": {
|
| + "description": "The domain name associated with the organization; for example, `google.com`.",
|
| "type": "string"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the organization."
|
| - },
|
| - "location": {
|
| - "description": "The location of the organization office the person works at.",
|
| + "department": {
|
| + "description": "The person's department at the organization.",
|
| "type": "string"
|
| },
|
| - "title": {
|
| - "description": "The person's job title at the organization.",
|
| + "phoneticName": {
|
| + "description": "The phonetic name of 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"
|
| + "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"
|
| },
|
| - "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.",
|
| + "jobDescription": {
|
| + "description": "The person's job description at the organization.",
|
| "type": "string"
|
| },
|
| - "startDate": {
|
| + "endDate": {
|
| "$ref": "Date",
|
| - "description": "The start date when the person joined the organization."
|
| + "description": "The end date when the person left the organization."
|
| },
|
| - "domain": {
|
| - "description": "The domain name associated with the organization; for example, `google.com`.",
|
| + "symbol": {
|
| + "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
|
| "type": "string"
|
| },
|
| - "department": {
|
| - "description": "The person's department at the organization.",
|
| + "name": {
|
| + "description": "The name of the organization.",
|
| "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`",
|
| - "type": "string"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the organization."
|
| },
|
| - "phoneticName": {
|
| - "description": "The phonetic name of the organization.",
|
| + "title": {
|
| + "description": "The person's job title at the organization.",
|
| "type": "string"
|
| },
|
| - "jobDescription": {
|
| - "description": "The person's job description at the organization.",
|
| + "location": {
|
| + "description": "The location of the organization office the person works at.",
|
| "type": "string"
|
| + },
|
| + "current": {
|
| + "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -769,14 +800,14 @@
|
| "description": "The token that can be used to retrieve the next page of results.",
|
| "type": "string"
|
| },
|
| - "nextSyncToken": {
|
| - "description": "The token that can be used to retrieve changes since the last request.",
|
| - "type": "string"
|
| - },
|
| "totalItems": {
|
| "description": "The total number of items in the list without pagination.",
|
| "format": "int32",
|
| "type": "integer"
|
| + },
|
| + "nextSyncToken": {
|
| + "description": "The token that can be used to retrieve changes since the last request.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -809,20 +840,20 @@
|
| "description": "A person's relation to another person.",
|
| "id": "Relation",
|
| "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`",
|
| + "person": {
|
| + "description": "The name of the other person this relation refers to.",
|
| "type": "string"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the relation."
|
| - },
|
| "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"
|
| },
|
| - "person": {
|
| - "description": "The name of the other person this relation refers to.",
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the relation."
|
| + },
|
| + "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"
|
| }
|
| },
|
| @@ -847,15 +878,6 @@
|
| "description": "A contact group.",
|
| "id": "ContactGroup",
|
| "properties": {
|
| - "memberCount": {
|
| - "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
|
| - "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/`<var>contact_group_id</var>.",
|
| "type": "string"
|
| @@ -882,6 +904,10 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "name": {
|
| + "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
|
| + "type": "string"
|
| + },
|
| "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": {
|
| @@ -889,9 +915,14 @@
|
| },
|
| "type": "array"
|
| },
|
| - "name": {
|
| - "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
|
| - "type": "string"
|
| + "metadata": {
|
| + "$ref": "ContactGroupMetadata",
|
| + "description": "Metadata about the contact group."
|
| + },
|
| + "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"
|
| @@ -900,24 +931,17 @@
|
| "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": {
|
| - "coverPhotos": {
|
| - "description": "The person's read-only cover photos.",
|
| - "items": {
|
| - "$ref": "CoverPhoto"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "imClients": {
|
| - "description": "The person's instant messaging clients.",
|
| + "birthdays": {
|
| + "description": "The person's birthdays.",
|
| "items": {
|
| - "$ref": "ImClient"
|
| + "$ref": "Birthday"
|
| },
|
| "type": "array"
|
| },
|
| - "birthdays": {
|
| - "description": "The person's birthdays.",
|
| + "userDefined": {
|
| + "description": "The person's user defined data.",
|
| "items": {
|
| - "$ref": "Birthday"
|
| + "$ref": "UserDefined"
|
| },
|
| "type": "array"
|
| },
|
| @@ -1013,6 +1037,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "resourceName": {
|
| + "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`<var>person_id</var>.",
|
| + "type": "string"
|
| + },
|
| "interests": {
|
| "description": "The person's interests.",
|
| "items": {
|
| @@ -1020,10 +1048,6 @@
|
| },
|
| "type": "array"
|
| },
|
| - "resourceName": {
|
| - "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`<var>person_id</var>.",
|
| - "type": "string"
|
| - },
|
| "biographies": {
|
| "description": "The person's biographies.",
|
| "items": {
|
| @@ -1109,6 +1133,20 @@
|
| "$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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1144,14 +1182,14 @@
|
| "description": "A person's past or current residence.",
|
| "id": "Residence",
|
| "properties": {
|
| - "current": {
|
| - "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
|
| - "type": "boolean"
|
| - },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| "description": "Metadata about the residence."
|
| },
|
| + "current": {
|
| + "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
|
| + "type": "boolean"
|
| + },
|
| "value": {
|
| "description": "The address of the residence.",
|
| "type": "string"
|
| @@ -1163,6 +1201,14 @@
|
| "description": "An event related to the person.",
|
| "id": "Event",
|
| "properties": {
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the event."
|
| + },
|
| + "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`",
|
| + "type": "string"
|
| + },
|
| "date": {
|
| "$ref": "Date",
|
| "description": "The date of the event."
|
| @@ -1170,14 +1216,6 @@
|
| "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"
|
| - },
|
| - "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`",
|
| - "type": "string"
|
| - },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the event."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1200,20 +1238,6 @@
|
| "description": "The read-only metadata about a profile.",
|
| "id": "ProfileMetadata",
|
| "properties": {
|
| - "objectType": {
|
| - "description": "The profile object type.",
|
| - "enum": [
|
| - "OBJECT_TYPE_UNSPECIFIED",
|
| - "PERSON",
|
| - "PAGE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unspecified.",
|
| - "Person.",
|
| - "[Google+ Page.](http://www.google.com/+/brands/)"
|
| - ],
|
| - "type": "string"
|
| - },
|
| "userTypes": {
|
| "description": "The user types.",
|
| "enumDescriptions": [
|
| @@ -1232,6 +1256,20 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "objectType": {
|
| + "description": "The profile object type.",
|
| + "enum": [
|
| + "OBJECT_TYPE_UNSPECIFIED",
|
| + "PERSON",
|
| + "PAGE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unspecified.",
|
| + "Person.",
|
| + "[Google+ Page.](http://www.google.com/+/brands/)"
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1240,6 +1278,10 @@
|
| "description": "A person's gender.",
|
| "id": "Gender",
|
| "properties": {
|
| + "formattedValue": {
|
| + "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
|
| + "type": "string"
|
| + },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| "description": "Metadata about the gender."
|
| @@ -1247,10 +1289,6 @@
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1259,17 +1297,17 @@
|
| "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": {
|
| - "url": {
|
| - "description": "The URL of the cover photo.",
|
| - "type": "string"
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the cover photo."
|
| },
|
| "default": {
|
| "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
|
| "type": "boolean"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the cover photo."
|
| + "url": {
|
| + "description": "The URL of the cover photo.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1293,25 +1331,25 @@
|
| "description": "A person's email address.",
|
| "id": "EmailAddress",
|
| "properties": {
|
| - "value": {
|
| - "description": "The email address.",
|
| - "type": "string"
|
| - },
|
| - "formattedType": {
|
| - "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
|
| - "type": "string"
|
| - },
|
| "displayName": {
|
| "description": "The display name of the email.",
|
| "type": "string"
|
| },
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the email address."
|
| + },
|
| "type": {
|
| "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
|
| "type": "string"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the email address."
|
| + "value": {
|
| + "description": "The email address.",
|
| + "type": "string"
|
| + },
|
| + "formattedType": {
|
| + "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1320,6 +1358,10 @@
|
| "description": "A person's nickname.",
|
| "id": "Nickname",
|
| "properties": {
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the nickname."
|
| + },
|
| "type": {
|
| "description": "The type of the nickname.",
|
| "enum": [
|
| @@ -1338,10 +1380,6 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the nickname."
|
| - },
|
| "value": {
|
| "description": "The nickname.",
|
| "type": "string"
|
| @@ -1383,8 +1421,8 @@
|
| "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": {
|
| - "month": {
|
| - "description": "Month of year. Must be from 1 to 12.",
|
| + "year": {
|
| + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| @@ -1393,8 +1431,8 @@
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "year": {
|
| - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| + "month": {
|
| + "description": "Month of year. Must be from 1 to 12.",
|
| "format": "int32",
|
| "type": "integer"
|
| }
|
| @@ -1405,30 +1443,14 @@
|
| "description": "A person's name. If the name is a mononym, the family name is empty.",
|
| "id": "Name",
|
| "properties": {
|
| - "displayName": {
|
| - "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
|
| - "type": "string"
|
| - },
|
| - "honorificSuffix": {
|
| - "description": "The honorific suffixes, such as `Jr.`",
|
| - "type": "string"
|
| - },
|
| - "honorificPrefix": {
|
| - "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
|
| - "type": "string"
|
| - },
|
| - "phoneticHonorificSuffix": {
|
| - "description": "The honorific suffixes spelled as they sound.",
|
| + "middleName": {
|
| + "description": "The middle name(s).",
|
| "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"
|
| @@ -1460,6 +1482,22 @@
|
| "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"
|
| + },
|
| + "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"
|
| + },
|
| + "honorificSuffix": {
|
| + "description": "The honorific suffixes, such as `Jr.`",
|
| + "type": "string"
|
| + },
|
| + "honorificPrefix": {
|
| + "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
|
| + "type": "string"
|
| + },
|
| + "phoneticHonorificSuffix": {
|
| + "description": "The honorific suffixes spelled as they sound.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1485,6 +1523,25 @@
|
| "properties": {},
|
| "type": "object"
|
| },
|
| + "UserDefined": {
|
| + "description": "Arbitrary user data that is populated by the end users.",
|
| + "id": "UserDefined",
|
| + "properties": {
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the user defined data."
|
| + },
|
| + "value": {
|
| + "description": "The end user specified value of the user defined data.",
|
| + "type": "string"
|
| + },
|
| + "key": {
|
| + "description": "The end user specified key of the user defined data.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Biography": {
|
| "description": "A person's short biography.",
|
| "id": "Biography",
|
| @@ -1522,38 +1579,21 @@
|
| "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"
|
| },
|
| - "primary": {
|
| - "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
|
| - "type": "boolean"
|
| - },
|
| - "source": {
|
| - "$ref": "Source",
|
| - "description": "The source of the field."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Source": {
|
| - "description": "The source of a field.",
|
| - "id": "Source",
|
| - "properties": {
|
| - "etag": {
|
| - "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "The unique identifier within the source type generated by the server.",
|
| - "type": "string"
|
| - },
|
| - "profileMetadata": {
|
| - "$ref": "ProfileMetadata",
|
| - "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE."
|
| - },
|
| - "updateTime": {
|
| - "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "primary": {
|
| + "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
|
| + "type": "boolean"
|
| },
|
| + "source": {
|
| + "$ref": "Source",
|
| + "description": "The source of the field."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Source": {
|
| + "description": "The source of a field.",
|
| + "id": "Source",
|
| + "properties": {
|
| "type": {
|
| "description": "The source type.",
|
| "enum": [
|
| @@ -1571,6 +1611,23 @@
|
| "[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"
|
| + },
|
| + "etag": {
|
| + "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "The unique identifier within the source type generated by the server.",
|
| + "type": "string"
|
| + },
|
| + "profileMetadata": {
|
| + "$ref": "ProfileMetadata",
|
| + "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE."
|
| + },
|
| + "updateTime": {
|
| + "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1607,25 +1664,14 @@
|
| },
|
| "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=`<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"
|
| - },
|
| "PhoneNumber": {
|
| "description": "A person's phone number.",
|
| "id": "PhoneNumber",
|
| "properties": {
|
| + "value": {
|
| + "description": "The phone number.",
|
| + "type": "string"
|
| + },
|
| "formattedType": {
|
| "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
|
| "type": "string"
|
| @@ -1634,16 +1680,27 @@
|
| "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"
|
| },
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the phone number."
|
| + },
|
| "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"
|
| - },
|
| + }
|
| + },
|
| + "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 phone number."
|
| + "description": "Metadata about the photo."
|
| },
|
| - "value": {
|
| - "description": "The phone number.",
|
| + "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"
|
| }
|
| },
|
| @@ -1652,17 +1709,13 @@
|
| "ListConnectionsResponse": {
|
| "id": "ListConnectionsResponse",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "The token that can be used to retrieve the next page of results.",
|
| - "type": "string"
|
| - },
|
| - "totalItems": {
|
| - "description": "The total number of items in the list without pagination.",
|
| + "totalPeople": {
|
| + "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "nextSyncToken": {
|
| - "description": "The token that can be used to retrieve changes since the last request.",
|
| + "nextPageToken": {
|
| + "description": "The token that can be used to retrieve the next page of results.",
|
| "type": "string"
|
| },
|
| "connections": {
|
| @@ -1672,8 +1725,12 @@
|
| },
|
| "type": "array"
|
| },
|
| - "totalPeople": {
|
| - "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
|
| + "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"
|
| }
|
| @@ -1684,14 +1741,14 @@
|
| "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": {
|
| - "text": {
|
| - "description": "A free-form string representing the user's birthday.",
|
| - "type": "string"
|
| - },
|
| "metadata": {
|
| "$ref": "FieldMetadata",
|
| "description": "Metadata about the birthday."
|
| },
|
| + "text": {
|
| + "description": "A free-form string representing the user's birthday.",
|
| + "type": "string"
|
| + },
|
| "date": {
|
| "$ref": "Date",
|
| "description": "The date of the birthday."
|
| @@ -1714,30 +1771,6 @@
|
| "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
|
| "id": "Address",
|
| "properties": {
|
| - "extendedAddress": {
|
| - "description": "The extended address of the address; for example, the apartment number.",
|
| - "type": "string"
|
| - },
|
| - "poBox": {
|
| - "description": "The P.O. box of the address.",
|
| - "type": "string"
|
| - },
|
| - "postalCode": {
|
| - "description": "The postal code of the address.",
|
| - "type": "string"
|
| - },
|
| - "region": {
|
| - "description": "The region of the address; for example, the state or province.",
|
| - "type": "string"
|
| - },
|
| - "streetAddress": {
|
| - "description": "The street address.",
|
| - "type": "string"
|
| - },
|
| - "metadata": {
|
| - "$ref": "FieldMetadata",
|
| - "description": "Metadata about the address."
|
| - },
|
| "countryCode": {
|
| "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
|
| "type": "string"
|
| @@ -1761,17 +1794,30 @@
|
| "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"
|
| - }
|
| - },
|
| - "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.",
|
| + },
|
| + "extendedAddress": {
|
| + "description": "The extended address of the address; for example, the apartment number.",
|
| + "type": "string"
|
| + },
|
| + "poBox": {
|
| + "description": "The P.O. box of the address.",
|
| + "type": "string"
|
| + },
|
| + "postalCode": {
|
| + "description": "The postal code of the address.",
|
| + "type": "string"
|
| + },
|
| + "region": {
|
| + "description": "The region of the address; for example, the state or province.",
|
| + "type": "string"
|
| + },
|
| + "streetAddress": {
|
| + "description": "The street address.",
|
| "type": "string"
|
| + },
|
| + "metadata": {
|
| + "$ref": "FieldMetadata",
|
| + "description": "Metadata about the address."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1780,15 +1826,6 @@
|
| "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": {
|
| - "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.",
|
| "items": {
|
| @@ -1799,6 +1836,26 @@
|
| "type": "object"
|
| },
|
| "type": "array"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "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"
|
| @@ -1807,8 +1864,8 @@
|
| "description": "The read-only metadata about a person.",
|
| "id": "PersonMetadata",
|
| "properties": {
|
| - "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.",
|
| + "linkedPeopleResourceNames": {
|
| + "description": "Resource names of people linked to this resource.",
|
| "items": {
|
| "type": "string"
|
| },
|
| @@ -1821,6 +1878,13 @@
|
| },
|
| "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.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| "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"
|
| @@ -1838,13 +1902,6 @@
|
| "[Google+ Page.](http://www.google.com/+/brands/)"
|
| ],
|
| "type": "string"
|
| - },
|
| - "linkedPeopleResourceNames": {
|
| - "description": "Resource names of people linked to this resource.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1853,15 +1910,15 @@
|
| "description": "A request to modify an existing contact group's members.",
|
| "id": "ModifyContactGroupMembersRequest",
|
| "properties": {
|
| - "resourceNamesToRemove": {
|
| - "description": "The resource names of the contact people to remove in the form of in the\nform of `people/`<var>person_id</var>.",
|
| + "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": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "resourceNamesToAdd": {
|
| - "description": "The resource names of the contact people to add in the form of in the form\n`people/`<var>person_id</var>.",
|
| + "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": {
|
| "type": "string"
|
| },
|
| @@ -1874,10 +1931,6 @@
|
| "description": "The response for a specific contact group.",
|
| "id": "ContactGroupResponse",
|
| "properties": {
|
| - "status": {
|
| - "$ref": "Status",
|
| - "description": "The status of the response."
|
| - },
|
| "requestedResourceName": {
|
| "description": "The original requested resource name.",
|
| "type": "string"
|
| @@ -1885,6 +1938,10 @@
|
| "contactGroup": {
|
| "$ref": "ContactGroup",
|
| "description": "The contact group."
|
| + },
|
| + "status": {
|
| + "$ref": "Status",
|
| + "description": "The status of the response."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1893,51 +1950,20 @@
|
| "description": "A person's associated URLs.",
|
| "id": "Url",
|
| "properties": {
|
| - "formattedType": {
|
| - "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
|
| - "type": "string"
|
| - },
|
| - "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 URL."
|
| },
|
| - "value": {
|
| - "description": "The URL.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ImClient": {
|
| - "description": "A person's instant messaging client.",
|
| - "id": "ImClient",
|
| - "properties": {
|
| - "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 IM client."
|
| - },
|
| "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"
|
| - },
|
| - "username": {
|
| - "description": "The user name used in the IM client.",
|
| + "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"
|
| },
|
| - "formattedProtocol": {
|
| - "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
|
| + "value": {
|
| + "description": "The URL.",
|
| "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 URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
|
| "type": "string"
|
| }
|
| },
|
|
|
Chromium Code Reviews
Issue 3006323002:
Api-Roll 54: 2017-09-11 (Closed)
