Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1066)

Unified Diff: discovery/googleapis/people__v1.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/partners__v2.json ('k') | discovery/googleapis/playmoviespartner__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/people__v1.json
diff --git a/discovery/googleapis/people__v1.json b/discovery/googleapis/people__v1.json
index e40f555c9f1ae712b033ac36a3f5d1b9e4fe40b9..d7dd1caa86fd13339adfd8cdd5966b86296fd21d 100644
--- a/discovery/googleapis/people__v1.json
+++ b/discovery/googleapis/people__v1.json
@@ -17,12 +17,12 @@
"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/userinfo.email": {
+ "description": "View your email address"
+ },
"https://www.googleapis.com/auth/user.birthday.read": {
"description": "View your complete date of birth"
},
@@ -49,6 +49,27 @@
"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",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
@@ -93,13 +114,13 @@
"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"
},
- "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"
},
@@ -113,27 +134,6 @@
"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",
@@ -204,17 +204,17 @@
"id": "people.contactGroups.batchGet",
"parameterOrder": [],
"parameters": {
- "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"
+ },
+ "resourceNames": {
+ "description": "The resource names of the contact groups to get.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
}
},
"path": "v1/contactGroups:batchGet",
@@ -234,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}",
@@ -261,6 +261,11 @@
"id": "people.contactGroups.list",
"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.",
+ "location": "query",
+ "type": "string"
+ },
"pageSize": {
"description": "The maximum number of resources to return.",
"format": "int32",
@@ -271,11 +276,6 @@
"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",
@@ -371,12 +371,6 @@
"id": "people.people.getBatchGet",
"parameterOrder": [],
"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"
- },
"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",
@@ -388,6 +382,12 @@
"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",
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/people:batchGet",
@@ -414,6 +414,12 @@
"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",
@@ -426,12 +432,6 @@
"pattern": "^people/[^/]+$",
"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"
}
},
"path": "v1/{+resourceName}",
@@ -551,18 +551,18 @@
"required": true,
"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"
},
+ "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",
@@ -583,614 +583,477 @@
}
}
},
- "revision": "20170727",
+ "revision": "20170817",
"rootUrl": "https://people.googleapis.com/",
"schemas": {
- "Biography": {
- "description": "A person's short biography.",
- "id": "Biography",
+ "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"
+ },
+ "BatchGetContactGroupsResponse": {
+ "description": "The response to a batch get contact groups request.",
+ "id": "BatchGetContactGroupsResponse",
+ "properties": {
+ "responses": {
+ "description": "The list of responses for each requested contact group resource.",
+ "items": {
+ "$ref": "ContactGroupResponse"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Membership": {
+ "description": "A person's read-only membership in a group.",
+ "id": "Membership",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the biography."
+ "description": "Metadata about the membership."
},
- "value": {
- "description": "The short biography.",
- "type": "string"
+ "domainMembership": {
+ "$ref": "DomainMembership",
+ "description": "The domain membership."
},
- "contentType": {
- "description": "The content type of the biography.",
- "enum": [
- "CONTENT_TYPE_UNSPECIFIED",
- "TEXT_PLAIN",
- "TEXT_HTML"
- ],
- "enumDescriptions": [
- "Unspecified.",
- "Plain text.",
- "HTML text."
- ],
- "type": "string"
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
}
},
"type": "object"
},
- "FieldMetadata": {
- "description": "Metadata about a field.",
- "id": "FieldMetadata",
+ "RelationshipStatus": {
+ "description": "A person's read-only relationship status.",
+ "id": "RelationshipStatus",
"properties": {
- "primary": {
- "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
- "type": "boolean"
+ "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"
},
- "source": {
- "$ref": "Source",
- "description": "The source of the field."
+ "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"
},
- "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": "FieldMetadata",
+ "description": "Metadata about the relationship status."
}
},
"type": "object"
},
- "RelationshipInterest": {
- "description": "A person's read-only relationship interest .",
- "id": "RelationshipInterest",
+ "BraggingRights": {
+ "description": "A person's bragging rights.",
+ "id": "BraggingRights",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the relationship interest."
+ "description": "Metadata about the bragging rights."
},
"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"
- },
- "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.",
+ "description": "The bragging rights; for example, `climbed mount everest`.",
"type": "string"
}
},
"type": "object"
},
- "Source": {
- "description": "The source of a field.",
- "id": "Source",
+ "Organization": {
+ "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
+ "id": "Organization",
"properties": {
- "updateTime": {
- "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
- "format": "google-datetime",
- "type": "string"
- },
- "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"
+ "endDate": {
+ "$ref": "Date",
+ "description": "The end date when the person left the organization."
},
- "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.",
+ "symbol": {
+ "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
"type": "string"
},
- "id": {
- "description": "The unique identifier within the source type generated by the server.",
- "type": "string"
- },
- "profileMetadata": {
- "$ref": "ProfileMetadata",
- "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE."
- }
- },
- "type": "object"
- },
- "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 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`",
+ "name": {
+ "description": "The name of the organization.",
"type": "string"
},
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the phone number."
+ "description": "Metadata about the organization."
},
- "value": {
- "description": "The phone number.",
+ "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"
+ },
"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.",
+ "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"
},
- "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.",
+ "startDate": {
+ "$ref": "Date",
+ "description": "The start date when the person joined the organization."
+ },
+ "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": {
+ "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"
+ },
+ "phoneticName": {
+ "description": "The phonetic name of the organization.",
+ "type": "string"
+ },
+ "jobDescription": {
+ "description": "The person's job description at the organization.",
"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",
+ "AgeRangeType": {
+ "description": "A person's age range.",
+ "id": "AgeRangeType",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the photo."
+ "description": "Metadata about the age range."
},
- "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`",
+ "ageRange": {
+ "description": "The age range.",
+ "enum": [
+ "AGE_RANGE_UNSPECIFIED",
+ "LESS_THAN_EIGHTEEN",
+ "EIGHTEEN_TO_TWENTY",
+ "TWENTY_ONE_OR_OLDER"
+ ],
+ "enumDescriptions": [
+ "Unspecified.",
+ "Younger than eighteen.",
+ "Between eighteen and twenty.",
+ "Twenty-one and older."
+ ],
"type": "string"
}
},
"type": "object"
},
- "ListConnectionsResponse": {
- "id": "ListConnectionsResponse",
+ "ListContactGroupsResponse": {
+ "description": "The response to a list contact groups request.",
+ "id": "ListContactGroupsResponse",
"properties": {
- "totalPeople": {
- "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
- "format": "int32",
- "type": "integer"
+ "contactGroups": {
+ "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
+ "items": {
+ "$ref": "ContactGroup"
+ },
+ "type": "array"
},
"nextPageToken": {
"description": "The token that can be used to retrieve the next page of results.",
"type": "string"
},
+ "nextSyncToken": {
+ "description": "The token that can be used to retrieve changes since the last request.",
+ "type": "string"
+ },
"totalItems": {
"description": "The total number of items in the list without pagination.",
"format": "int32",
"type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PersonResponse": {
+ "description": "The response for a single person",
+ "id": "PersonResponse",
+ "properties": {
+ "person": {
+ "$ref": "Person",
+ "description": "The person."
},
- "nextSyncToken": {
- "description": "The token that can be used to retrieve changes since the last request.",
- "type": "string"
+ "status": {
+ "$ref": "Status",
+ "description": "The status of the response."
},
- "connections": {
- "description": "The list of people that the requestor is connected to.",
- "items": {
- "$ref": "Person"
- },
- "type": "array"
+ "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"
},
- "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",
+ "Relation": {
+ "description": "A person's relation to another person.",
+ "id": "Relation",
"properties": {
- "date": {
- "$ref": "Date",
- "description": "The date of the birthday."
- },
- "text": {
- "description": "A free-form string representing the user's birthday.",
+ "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 birthday."
+ "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.",
+ "type": "string"
}
},
"type": "object"
},
- "CreateContactGroupRequest": {
- "description": "A request to create a new contact group.",
- "id": "CreateContactGroupRequest",
+ "Occupation": {
+ "description": "A person's occupation.",
+ "id": "Occupation",
"properties": {
- "contactGroup": {
- "$ref": "ContactGroup",
- "description": "The contact group to create."
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the occupation."
+ },
+ "value": {
+ "description": "The occupation; for example, `carpenter`.",
+ "type": "string"
}
},
"type": "object"
},
- "Address": {
- "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
- "id": "Address",
+ "ContactGroup": {
+ "description": "A contact group.",
+ "id": "ContactGroup",
"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"
- },
- "city": {
- "description": "The city of the address.",
- "type": "string"
- },
- "formattedValue": {
- "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
- "type": "string"
- },
- "country": {
- "description": "The country of the address.",
- "type": "string"
- },
- "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"
+ "memberCount": {
+ "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
+ "format": "int32",
+ "type": "integer"
},
- "extendedAddress": {
- "description": "The extended address of the address; for example, the apartment number.",
- "type": "string"
+ "metadata": {
+ "$ref": "ContactGroupMetadata",
+ "description": "Metadata about the contact group."
},
- "poBox": {
- "description": "The P.O. box of the address.",
+ "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"
},
- "postalCode": {
- "description": "The postal code of the address.",
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
"type": "string"
},
- "region": {
- "description": "The region of the address; for example, the state or province.",
+ "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"
},
- "streetAddress": {
- "description": "The street address.",
+ "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"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the address."
+ "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"
},
- "countryCode": {
- "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
+ "name": {
+ "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
"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",
+ "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": {
- "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"
+ "coverPhotos": {
+ "description": "The person's read-only cover photos.",
+ "items": {
+ "$ref": "CoverPhoto"
+ },
+ "type": "array"
},
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "imClients": {
+ "description": "The person's instant messaging clients.",
"items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
+ "$ref": "ImClient"
},
"type": "array"
},
- "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": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ],
- "type": "string"
+ "birthdays": {
+ "description": "The person's birthdays.",
+ "items": {
+ "$ref": "Birthday"
+ },
+ "type": "array"
},
- "linkedPeopleResourceNames": {
- "description": "Resource names of people linked to this resource.",
+ "locales": {
+ "description": "The person's locale preferences.",
"items": {
- "type": "string"
+ "$ref": "Locale"
},
"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.",
+ "relationshipInterests": {
+ "description": "The person's read-only relationship interests.",
"items": {
- "type": "string"
+ "$ref": "RelationshipInterest"
},
"type": "array"
},
- "sources": {
- "description": "The sources of data for the person.",
+ "urls": {
+ "description": "The person's associated URLs.",
"items": {
- "$ref": "Source"
+ "$ref": "Url"
},
"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"
- }
- },
- "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>.",
+ "nicknames": {
+ "description": "The person's nicknames.",
"items": {
- "type": "string"
+ "$ref": "Nickname"
},
"type": "array"
},
- "resourceNamesToRemove": {
- "description": "The resource names of the contact people to remove in the form of in the\nform of `people/`<var>person_id</var>.",
+ "names": {
+ "description": "The person's names.",
"items": {
- "type": "string"
+ "$ref": "Name"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "ContactGroupResponse": {
- "description": "The response for a specific contact group.",
- "id": "ContactGroupResponse",
- "properties": {
- "contactGroup": {
- "$ref": "ContactGroup",
- "description": "The contact group."
},
- "status": {
- "$ref": "Status",
- "description": "The status of the response."
+ "relations": {
+ "description": "The person's relations.",
+ "items": {
+ "$ref": "Relation"
+ },
+ "type": "array"
},
- "requestedResourceName": {
- "description": "The original requested resource name.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Url": {
- "description": "A person's associated URLs.",
- "id": "Url",
- "properties": {
- "formattedType": {
- "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
+ "occupations": {
+ "description": "The person's occupations.",
+ "items": {
+ "$ref": "Occupation"
+ },
+ "type": "array"
},
- "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"
+ "emailAddresses": {
+ "description": "The person's email addresses.",
+ "items": {
+ "$ref": "EmailAddress"
+ },
+ "type": "array"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the URL."
+ "organizations": {
+ "description": "The person's past or current organizations.",
+ "items": {
+ "$ref": "Organization"
+ },
+ "type": "array"
},
- "value": {
- "description": "The URL.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ImClient": {
- "description": "A person's instant messaging client.",
- "id": "ImClient",
- "properties": {
- "formattedProtocol": {
- "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
"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"
+ "braggingRights": {
+ "description": "The person's bragging rights.",
+ "items": {
+ "$ref": "BraggingRights"
+ },
+ "type": "array"
},
"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"
+ "$ref": "PersonMetadata",
+ "description": "Read-only metadata about the person."
},
- "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"
+ "residences": {
+ "description": "The person's residences.",
+ "items": {
+ "$ref": "Residence"
+ },
+ "type": "array"
},
- "username": {
- "description": "The user name used in the IM client.",
- "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"
- },
- "BatchGetContactGroupsResponse": {
- "description": "The response to a batch get contact groups request.",
- "id": "BatchGetContactGroupsResponse",
- "properties": {
- "responses": {
- "description": "The list of responses for each requested contact group resource.",
+ "genders": {
+ "description": "The person's genders.",
"items": {
- "$ref": "ContactGroupResponse"
+ "$ref": "Gender"
},
"type": "array"
- }
- },
- "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."
+ "interests": {
+ "description": "The person's interests.",
+ "items": {
+ "$ref": "Interest"
+ },
+ "type": "array"
},
- "contactGroupMembership": {
- "$ref": "ContactGroupMembership",
- "description": "The contact group membership."
- }
- },
- "type": "object"
- },
- "RelationshipStatus": {
- "description": "A person's read-only relationship status.",
- "id": "RelationshipStatus",
- "properties": {
- "formattedValue": {
- "description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relationship status."
- },
- "value": {
- "description": "The relationship status. The value can be custom or 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"
- },
- "BraggingRights": {
- "description": "A person's bragging rights.",
- "id": "BraggingRights",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the bragging rights."
- },
- "value": {
- "description": "The bragging rights; for example, `climbed mount everest`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Organization": {
- "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
- "id": "Organization",
- "properties": {
- "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"
- },
- "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 organization."
- },
- "location": {
- "description": "The location of the organization office the person works at.",
- "type": "string"
- },
- "title": {
- "description": "The person's job title at the organization.",
+ "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"
},
- "current": {
- "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
- "type": "boolean"
+ "biographies": {
+ "description": "The person's biographies.",
+ "items": {
+ "$ref": "Biography"
+ },
+ "type": "array"
},
- "startDate": {
- "$ref": "Date",
- "description": "The start date when the person joined the organization."
+ "skills": {
+ "description": "The person's skills.",
+ "items": {
+ "$ref": "Skill"
+ },
+ "type": "array"
},
- "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"
+ "relationshipStatuses": {
+ "description": "The person's read-only relationship statuses.",
+ "items": {
+ "$ref": "RelationshipStatus"
+ },
+ "type": "array"
},
- "domain": {
- "description": "The domain name associated with the organization; for example, `google.com`.",
- "type": "string"
+ "photos": {
+ "description": "The person's read-only photos.",
+ "items": {
+ "$ref": "Photo"
+ },
+ "type": "array"
},
- "department": {
- "description": "The person's department at the organization.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgeRangeType": {
- "description": "A person's age range.",
- "id": "AgeRangeType",
- "properties": {
"ageRange": {
- "description": "The age range.",
+ "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only age range.",
"enum": [
"AGE_RANGE_UNSPECIFIED",
"LESS_THAN_EIGHTEEN",
@@ -1205,743 +1068,880 @@
],
"type": "string"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the age range."
- }
- },
- "type": "object"
- },
- "ListContactGroupsResponse": {
- "description": "The response to a list contact groups request.",
- "id": "ListContactGroupsResponse",
- "properties": {
- "contactGroups": {
- "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
+ "taglines": {
+ "description": "The person's read-only taglines.",
"items": {
- "$ref": "ContactGroup"
+ "$ref": "Tagline"
},
"type": "array"
},
- "nextPageToken": {
- "description": "The token that can be used to retrieve the next page of results.",
- "type": "string"
+ "ageRanges": {
+ "description": "The person's read-only age ranges.",
+ "items": {
+ "$ref": "AgeRangeType"
+ },
+ "type": "array"
},
- "nextSyncToken": {
- "description": "The token that can be used to retrieve changes since the last request.",
- "type": "string"
+ "addresses": {
+ "description": "The person's street addresses.",
+ "items": {
+ "$ref": "Address"
+ },
+ "type": "array"
},
- "totalItems": {
- "description": "The total number of items in the list without pagination.",
- "format": "int32",
- "type": "integer"
+ "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"
}
},
"type": "object"
},
- "PersonResponse": {
- "description": "The response for a single person",
- "id": "PersonResponse",
+ "UpdateContactGroupRequest": {
+ "description": "A request to update an existing contact group. Only the name can be updated.",
+ "id": "UpdateContactGroupRequest",
"properties": {
- "person": {
- "$ref": "Person",
- "description": "The person."
- },
- "status": {
- "$ref": "Status",
- "description": "The status of the response."
- },
- "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"
+ "contactGroup": {
+ "$ref": "ContactGroup",
+ "description": "The contact group to update."
}
},
"type": "object"
},
- "Relation": {
- "description": "A person's relation to another person.",
- "id": "Relation",
+ "ContactGroupMetadata": {
+ "description": "The read-only metadata about a contact group.",
+ "id": "ContactGroupMetadata",
"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`",
- "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.",
+ "updateTime": {
+ "description": "The time the group was last updated.",
+ "format": "google-datetime",
"type": "string"
},
- "person": {
- "description": "The name of the other person this relation refers to.",
- "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"
},
- "Occupation": {
- "description": "A person's occupation.",
- "id": "Occupation",
+ "Residence": {
+ "description": "A person's past or current residence.",
+ "id": "Residence",
"properties": {
+ "current": {
+ "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
+ "type": "boolean"
+ },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the occupation."
+ "description": "Metadata about the residence."
},
"value": {
- "description": "The occupation; for example, `carpenter`.",
+ "description": "The address of the residence.",
"type": "string"
}
},
"type": "object"
},
- "ContactGroup": {
- "description": "A contact group.",
- "id": "ContactGroup",
- "properties": {
- "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>.",
+ "Event": {
+ "description": "An event related to the person.",
+ "id": "Event",
+ "properties": {
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the event."
+ },
+ "formattedType": {
+ "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
+ "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"
},
- "groupType": {
- "description": "The read-only contact group type.",
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the event."
+ }
+ },
+ "type": "object"
+ },
+ "ModifyContactGroupMembersResponse": {
+ "description": "The response to a modify contact group members request.",
+ "id": "ModifyContactGroupMembersResponse",
+ "properties": {
+ "notFoundResourceNames": {
+ "description": "The contact people resource names that were not found.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProfileMetadata": {
+ "description": "The read-only metadata about a profile.",
+ "id": "ProfileMetadata",
+ "properties": {
+ "objectType": {
+ "description": "The profile object type.",
"enum": [
- "GROUP_TYPE_UNSPECIFIED",
- "USER_CONTACT_GROUP",
- "SYSTEM_CONTACT_GROUP"
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
],
"enumDescriptions": [
"Unspecified.",
- "User defined contact group.",
- "System defined contact group."
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
],
"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"
- },
- "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).",
+ "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": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the gender."
},
- "name": {
- "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
+ "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"
+ },
+ "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": {
+ "url": {
+ "description": "The URL of the cover photo.",
"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": "ContactGroupMetadata",
- "description": "Metadata about the contact group."
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the cover photo."
+ }
+ },
+ "type": "object"
+ },
+ "Interest": {
+ "description": "One of the person's interests.",
+ "id": "Interest",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the interest."
},
- "memberCount": {
- "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
- "format": "int32",
- "type": "integer"
+ "value": {
+ "description": "The interest; for example, `stargazing`.",
+ "type": "string"
}
},
"type": "object"
},
- "Person": {
- "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fields can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.primary` set to true.",
- "id": "Person",
+ "EmailAddress": {
+ "description": "A person's email address.",
+ "id": "EmailAddress",
"properties": {
- "relationshipStatuses": {
- "description": "The person's read-only relationship statuses.",
- "items": {
- "$ref": "RelationshipStatus"
- },
- "type": "array"
+ "value": {
+ "description": "The email address.",
+ "type": "string"
},
- "photos": {
- "description": "The person's read-only photos.",
- "items": {
- "$ref": "Photo"
- },
- "type": "array"
+ "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"
},
- "ageRange": {
- "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only age range.",
+ "displayName": {
+ "description": "The display name of the email.",
+ "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`",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the email address."
+ }
+ },
+ "type": "object"
+ },
+ "Nickname": {
+ "description": "A person's nickname.",
+ "id": "Nickname",
+ "properties": {
+ "type": {
+ "description": "The type of the nickname.",
"enum": [
- "AGE_RANGE_UNSPECIFIED",
- "LESS_THAN_EIGHTEEN",
- "EIGHTEEN_TO_TWENTY",
- "TWENTY_ONE_OR_OLDER"
+ "DEFAULT",
+ "MAIDEN_NAME",
+ "INITIALS",
+ "GPLUS",
+ "OTHER_NAME"
],
"enumDescriptions": [
- "Unspecified.",
- "Younger than eighteen.",
- "Between eighteen and twenty.",
- "Twenty-one and older."
+ "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"
},
- "taglines": {
- "description": "The person's read-only taglines.",
- "items": {
- "$ref": "Tagline"
- },
- "type": "array"
- },
- "ageRanges": {
- "description": "The person's read-only age ranges.",
- "items": {
- "$ref": "AgeRangeType"
- },
- "type": "array"
- },
- "addresses": {
- "description": "The person's street addresses.",
- "items": {
- "$ref": "Address"
- },
- "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"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the nickname."
},
- "phoneNumbers": {
- "description": "The person's phone numbers.",
- "items": {
- "$ref": "PhoneNumber"
- },
- "type": "array"
+ "value": {
+ "description": "The nickname.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Skill": {
+ "description": "A skill that the person has.",
+ "id": "Skill",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the skill."
},
- "coverPhotos": {
- "description": "The person's read-only cover photos.",
- "items": {
- "$ref": "CoverPhoto"
- },
- "type": "array"
+ "value": {
+ "description": "The skill; for example, `underwater basket weaving`.",
+ "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."
},
- "imClients": {
- "description": "The person's instant messaging clients.",
- "items": {
- "$ref": "ImClient"
- },
- "type": "array"
+ "value": {
+ "description": "The tagline.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
+ "id": "Date",
+ "properties": {
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
},
- "birthdays": {
- "description": "The person's birthdays.",
- "items": {
- "$ref": "Birthday"
- },
- "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"
},
- "locales": {
- "description": "The person's locale preferences.",
- "items": {
- "$ref": "Locale"
- },
- "type": "array"
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Name": {
+ "description": "A person's name. If the name is a mononym, the family name is empty.",
+ "id": "Name",
+ "properties": {
+ "displayName": {
+ "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
+ "type": "string"
},
- "relationshipInterests": {
- "description": "The person's read-only relationship interests.",
- "items": {
- "$ref": "RelationshipInterest"
- },
- "type": "array"
+ "honorificSuffix": {
+ "description": "The honorific suffixes, such as `Jr.`",
+ "type": "string"
},
- "urls": {
- "description": "The person's associated URLs.",
- "items": {
- "$ref": "Url"
- },
- "type": "array"
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "type": "string"
},
- "nicknames": {
- "description": "The person's nicknames.",
- "items": {
- "$ref": "Nickname"
- },
- "type": "array"
+ "phoneticHonorificSuffix": {
+ "description": "The honorific suffixes spelled as they sound.",
+ "type": "string"
},
- "relations": {
- "description": "The person's relations.",
- "items": {
- "$ref": "Relation"
- },
- "type": "array"
+ "givenName": {
+ "description": "The given name.",
+ "type": "string"
},
- "names": {
- "description": "The person's names.",
- "items": {
- "$ref": "Name"
- },
- "type": "array"
+ "middleName": {
+ "description": "The middle name(s).",
+ "type": "string"
},
- "occupations": {
- "description": "The person's occupations.",
- "items": {
- "$ref": "Occupation"
- },
- "type": "array"
+ "phoneticHonorificPrefix": {
+ "description": "The honorific prefixes spelled as they sound.",
+ "type": "string"
},
- "emailAddresses": {
- "description": "The person's email addresses.",
- "items": {
- "$ref": "EmailAddress"
- },
- "type": "array"
+ "phoneticGivenName": {
+ "description": "The given name spelled as it sounds.",
+ "type": "string"
},
- "organizations": {
- "description": "The person's past or current organizations.",
- "items": {
- "$ref": "Organization"
- },
- "type": "array"
+ "phoneticFamilyName": {
+ "description": "The family name spelled as it sounds.",
+ "type": "string"
},
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
+ "familyName": {
+ "description": "The family name.",
"type": "string"
},
- "braggingRights": {
- "description": "The person's bragging rights.",
- "items": {
- "$ref": "BraggingRights"
- },
- "type": "array"
+ "phoneticMiddleName": {
+ "description": "The middle name(s) spelled as they sound.",
+ "type": "string"
},
"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"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the name."
},
- "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>.",
+ "phoneticFullName": {
+ "description": "The full name spelled as it sounds.",
"type": "string"
},
- "interests": {
- "description": "The person's interests.",
- "items": {
- "$ref": "Interest"
- },
- "type": "array"
- },
- "biographies": {
- "description": "The person's biographies.",
- "items": {
- "$ref": "Biography"
- },
- "type": "array"
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "Locale": {
+ "description": "A person's locale preference.",
+ "id": "Locale",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the locale."
},
- "skills": {
- "description": "The person's skills.",
- "items": {
- "$ref": "Skill"
- },
- "type": "array"
+ "value": {
+ "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
+ "type": "string"
}
},
"type": "object"
},
- "UpdateContactGroupRequest": {
- "description": "A request to update an existing contact group. Only the name can be updated.",
- "id": "UpdateContactGroupRequest",
+ "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",
"properties": {
- "contactGroup": {
- "$ref": "ContactGroup",
- "description": "The contact group to update."
+ "contentType": {
+ "description": "The content type of the biography.",
+ "enum": [
+ "CONTENT_TYPE_UNSPECIFIED",
+ "TEXT_PLAIN",
+ "TEXT_HTML"
+ ],
+ "enumDescriptions": [
+ "Unspecified.",
+ "Plain text.",
+ "HTML text."
+ ],
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the biography."
+ },
+ "value": {
+ "description": "The short biography.",
+ "type": "string"
}
},
"type": "object"
},
- "ContactGroupMetadata": {
- "description": "The read-only metadata about a contact group.",
- "id": "ContactGroupMetadata",
+ "FieldMetadata": {
+ "description": "Metadata about a field.",
+ "id": "FieldMetadata",
"properties": {
- "deleted": {
- "description": "True if the contact group resource has been deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests\nthat include a sync token.",
+ "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"
},
- "updateTime": {
- "description": "The time the group was last updated.",
- "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"
},
- "Residence": {
- "description": "A person's past or current residence.",
- "id": "Residence",
+ "Source": {
+ "description": "The source of a field.",
+ "id": "Source",
"properties": {
- "current": {
- "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
- "type": "boolean"
+ "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"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the residence."
+ "id": {
+ "description": "The unique identifier within the source type generated by the server.",
+ "type": "string"
},
- "value": {
- "description": "The address of the residence.",
+ "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": {
+ "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"
}
},
"type": "object"
},
- "Event": {
- "description": "An event related to the person.",
- "id": "Event",
+ "RelationshipInterest": {
+ "description": "A person's read-only relationship interest .",
+ "id": "RelationshipInterest",
"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`",
+ "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 event."
- },
- "date": {
- "$ref": "Date",
- "description": "The date of the event."
+ "description": "Metadata about the relationship interest."
},
- "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.",
+ "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"
},
- "ModifyContactGroupMembersResponse": {
- "description": "The response to a modify contact group members request.",
- "id": "ModifyContactGroupMembersResponse",
+ "GetPeopleResponse": {
+ "id": "GetPeopleResponse",
"properties": {
- "notFoundResourceNames": {
- "description": "The contact people resource names that were not found.",
+ "responses": {
+ "description": "The response for each requested resource name.",
"items": {
- "type": "string"
+ "$ref": "PersonResponse"
},
"type": "array"
}
},
"type": "object"
},
- "ProfileMetadata": {
- "description": "The read-only metadata about a profile.",
- "id": "ProfileMetadata",
+ "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": {
- "objectType": {
- "description": "The profile object type.",
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ],
- "type": "string"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the photo."
},
- "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"
+ "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"
},
- "Gender": {
- "description": "A person's gender.",
- "id": "Gender",
+ "PhoneNumber": {
+ "description": "A person's phone number.",
+ "id": "PhoneNumber",
"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.",
+ "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"
+ },
+ "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": {
+ "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 gender."
+ "description": "Metadata about the phone number."
},
"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`",
+ "description": "The phone number.",
"type": "string"
}
},
"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",
+ "ListConnectionsResponse": {
+ "id": "ListConnectionsResponse",
"properties": {
- "default": {
- "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
- "type": "boolean"
+ "nextPageToken": {
+ "description": "The token that can be used to retrieve the next page of results.",
+ "type": "string"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the cover photo."
+ "totalItems": {
+ "description": "The total number of items in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
},
- "url": {
- "description": "The URL of the cover photo.",
+ "nextSyncToken": {
+ "description": "The token that can be used to retrieve changes since the last request.",
"type": "string"
+ },
+ "connections": {
+ "description": "The list of people that the requestor is connected to.",
+ "items": {
+ "$ref": "Person"
+ },
+ "type": "array"
+ },
+ "totalPeople": {
+ "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "Interest": {
- "description": "One of the person's interests.",
- "id": "Interest",
+ "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": {
+ "text": {
+ "description": "A free-form string representing the user's birthday.",
+ "type": "string"
+ },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the interest."
+ "description": "Metadata about the birthday."
},
- "value": {
- "description": "The interest; for example, `stargazing`.",
- "type": "string"
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the birthday."
}
},
"type": "object"
},
- "Nickname": {
- "description": "A person's nickname.",
- "id": "Nickname",
+ "CreateContactGroupRequest": {
+ "description": "A request to create a new contact group.",
+ "id": "CreateContactGroupRequest",
"properties": {
- "value": {
- "description": "The nickname.",
+ "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": {
+ "extendedAddress": {
+ "description": "The extended address of the address; for example, the apartment number.",
"type": "string"
},
- "type": {
- "description": "The type of the nickname.",
- "enum": [
- "DEFAULT",
- "MAIDEN_NAME",
- "INITIALS",
- "GPLUS",
- "OTHER_NAME"
- ],
- "enumDescriptions": [
- "Generic nickname.",
- "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
- "Initials.",
- "Google+ profile nickname.",
- "A professional affiliation or other name; for example, `Dr. Smith.`"
- ],
+ "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 nickname."
- }
- },
- "type": "object"
- },
- "EmailAddress": {
- "description": "A person's email address.",
- "id": "EmailAddress",
- "properties": {
+ "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"
+ },
"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 address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
- "displayName": {
- "description": "The display name of the email.",
+ "city": {
+ "description": "The city of the address.",
"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`",
+ "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 email address."
+ "country": {
+ "description": "The country of the address.",
+ "type": "string"
},
- "value": {
- "description": "The email address.",
+ "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"
},
- "Skill": {
- "description": "A skill that the person has.",
- "id": "Skill",
+ "ContactGroupMembership": {
+ "description": "A Google contact group membership.",
+ "id": "ContactGroupMembership",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the skill."
- },
- "value": {
- "description": "The skill; for example, `underwater basket weaving`.",
+ "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"
},
- "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",
+ "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": {
- "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.",
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
"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"
+ "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"
},
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "Tagline": {
- "description": "A read-only brief one-line description of the person.",
- "id": "Tagline",
+ "PersonMetadata": {
+ "description": "The read-only metadata about a person.",
+ "id": "PersonMetadata",
"properties": {
- "value": {
- "description": "The tagline.",
+ "previousResourceNames": {
+ "description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sources": {
+ "description": "The sources of data for the person.",
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "objectType": {
+ "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
+ "enum": [
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
+ ],
+ "enumDescriptions": [
+ "Unspecified.",
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
+ ],
"type": "string"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the tagline."
+ "linkedPeopleResourceNames": {
+ "description": "Resource names of people linked to this resource.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "Name": {
- "description": "A person's name. If the name is a mononym, the family name is empty.",
- "id": "Name",
+ "ModifyContactGroupMembersRequest": {
+ "description": "A request to modify an existing contact group's members.",
+ "id": "ModifyContactGroupMembersRequest",
"properties": {
- "phoneticHonorificPrefix": {
- "description": "The honorific prefixes spelled as they sound.",
- "type": "string"
+ "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"
+ },
+ "type": "array"
},
- "phoneticGivenName": {
- "description": "The given name spelled as it sounds.",
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "ContactGroupResponse": {
+ "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"
},
- "phoneticFamilyName": {
- "description": "The family name spelled as it sounds.",
+ "contactGroup": {
+ "$ref": "ContactGroup",
+ "description": "The contact group."
+ }
+ },
+ "type": "object"
+ },
+ "Url": {
+ "description": "A person's associated URLs.",
+ "id": "Url",
+ "properties": {
+ "formattedType": {
+ "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
- "familyName": {
- "description": "The family name.",
+ "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 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`Accept-Language` HTTP header.",
- "type": "string"
+ "description": "Metadata about the URL."
},
- "displayName": {
- "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
+ "value": {
+ "description": "The URL.",
"type": "string"
- },
- "honorificSuffix": {
- "description": "The honorific suffixes, such as `Jr.`",
+ }
+ },
+ "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"
},
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
- "type": "string"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the IM client."
},
- "phoneticHonorificSuffix": {
- "description": "The honorific suffixes spelled as they sound.",
+ "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"
},
- "middleName": {
- "description": "The middle name(s).",
+ "username": {
+ "description": "The user name used in the IM client.",
"type": "string"
},
- "givenName": {
- "description": "The given name.",
+ "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"
- }
- },
- "type": "object"
- },
- "Locale": {
- "description": "A person's locale preference.",
- "id": "Locale",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the locale."
},
- "value": {
- "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
+ "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"
}
},
"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": "",
« no previous file with comments | « discovery/googleapis/partners__v2.json ('k') | discovery/googleapis/playmoviespartner__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698