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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/people__v1.json

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)
Patch Set: Created 3 years, 9 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/monitoring__v3.json ('k') | discovery/googleapis/plusDomains__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 6b57ab1ca944875454798145ddc73b1ff5670021..b7ab28a2aa2e79f5a73bd9d29f210e702b8d3061 100644
--- a/discovery/googleapis/people__v1.json
+++ b/discovery/googleapis/people__v1.json
@@ -17,12 +17,12 @@
"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.phonenumbers.read": {
+ "description": "View your phone numbers"
+ },
"https://www.googleapis.com/auth/user.birthday.read": {
"description": "View your complete date of birth"
},
@@ -69,6 +69,11 @@
"location": "query",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
"$.xgafv": {
"description": "V1 error format.",
"enum": [
@@ -82,11 +87,6 @@
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -124,13 +124,13 @@
"location": "query",
"type": "boolean"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
}
@@ -214,616 +214,875 @@
}
},
"resources": {
- "me": {
- "resources": {
- "connections": {
- "methods": {
- "list": {
- "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles.",
- "httpMethod": "GET",
- "id": "people.people.me.connections.list",
- "parameterOrder": [],
- "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"
- },
- "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"
- },
- "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 500, inclusive. Defaults to 100.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "requestMask.includeField": {
- "description": "Comma-separated list of fields to be included in the response. Omitting\nthis field will include all fields except for connections.list requests,\nwhich have a default mask that includes common fields like metadata, name,\nphoto, and profile url.\nEach path should start with `person.`: for example, `person.names` or\n`person.photos`.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/people/me/connections",
- "response": {
- "$ref": "ListConnectionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ]
+ "connections": {
+ "methods": {
+ "list": {
+ "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles.",
+ "httpMethod": "GET",
+ "id": "people.people.connections.list",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "parameters": {
+ "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 to return connections for. Only `people/me` is valid.",
+ "location": "path",
+ "pattern": "^people/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token of the page to be returned.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMask.includeField": {
+ "description": "Comma-separated list of fields to be included in the response. Omitting\nthis field will include all fields except for connections.list requests,\nwhich have a default mask that includes common fields like metadata, name,\nphoto, and profile url.\nEach path should start with `person.`: for example, `person.names` or\n`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 500, 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"
+ },
+ "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"
}
- }
+ },
+ "path": "v1/{+resourceName}/connections",
+ "response": {
+ "$ref": "ListConnectionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ]
}
}
}
}
}
},
- "revision": "20170209",
+ "revision": "20170302",
"rootUrl": "https://people.googleapis.com/",
"schemas": {
- "PhoneNumber": {
- "description": "A person's phone number.",
- "id": "PhoneNumber",
+ "Relation": {
+ "description": "A person's relation to another person.",
+ "id": "Relation",
"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 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"
- },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the phone number."
+ "description": "Metadata about the relation."
},
"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 photo."
- },
- "url": {
- "description": "The URL of the photo.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListConnectionsResponse": {
- "id": "ListConnectionsResponse",
- "properties": {
- "nextPageToken": {
- "description": "The token that can be used to retrieve the next page of results.",
+ "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"
},
- "connections": {
- "description": "The list of people that the requestor is connected to.",
- "items": {
- "$ref": "Person"
- },
- "type": "array"
- },
- "nextSyncToken": {
- "description": "The token that can be used to retrieve changes since the last request.",
+ "person": {
+ "description": "The name of the other person this relation refers to.",
"type": "string"
- }
- },
- "type": "object"
- },
- "Birthday": {
- "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
- "id": "Birthday",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the birthday."
},
- "text": {
- "description": "A free-form string representing the user's birthday.",
+ "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"
- },
- "date": {
- "$ref": "Date",
- "description": "The date of the birthday."
}
},
"type": "object"
},
- "Residence": {
- "description": "A person's past or current residence.",
- "id": "Residence",
+ "Occupation": {
+ "description": "A person's occupation.",
+ "id": "Occupation",
"properties": {
"value": {
- "description": "The address of the residence.",
+ "description": "The occupation; for example, `carpenter`.",
"type": "string"
},
"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"
+ "description": "Metadata about the occupation."
}
},
"type": "object"
},
- "Address": {
- "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
- "id": "Address",
+ "Person": {
+ "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data. Fields other than IDs,\nmetadata, and group memberships are user-edited.\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.\nNEXT_ID: 31",
+ "id": "Person",
"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"
+ "nicknames": {
+ "description": "The person's nicknames.",
+ "items": {
+ "$ref": "Nickname"
+ },
+ "type": "array"
},
- "streetAddress": {
- "description": "The street address.",
- "type": "string"
+ "names": {
+ "description": "The person's names.",
+ "items": {
+ "$ref": "Name"
+ },
+ "type": "array"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the address."
+ "relations": {
+ "description": "The person's relations.",
+ "items": {
+ "$ref": "Relation"
+ },
+ "type": "array"
},
- "countryCode": {
- "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
- "type": "string"
+ "occupations": {
+ "description": "The person's occupations.",
+ "items": {
+ "$ref": "Occupation"
+ },
+ "type": "array"
},
- "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"
+ "emailAddresses": {
+ "description": "The person's email addresses.",
+ "items": {
+ "$ref": "EmailAddress"
+ },
+ "type": "array"
},
- "city": {
- "description": "The city of the address.",
- "type": "string"
+ "organizations": {
+ "description": "The person's past or current organizations.",
+ "items": {
+ "$ref": "Organization"
+ },
+ "type": "array"
},
- "formattedValue": {
- "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
"type": "string"
},
- "country": {
- "description": "The country of the address.",
- "type": "string"
+ "braggingRights": {
+ "description": "The person's bragging rights.",
+ "items": {
+ "$ref": "BraggingRights"
+ },
+ "type": "array"
},
- "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.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PersonMetadata": {
- "description": "The read-only metadata about a person.",
- "id": "PersonMetadata",
- "properties": {
- "objectType": {
- "description": "The 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": "PersonMetadata",
+ "description": "Metadata about the person."
},
- "linkedPeopleResourceNames": {
- "description": "Resource names of people linked to this resource.",
+ "residences": {
+ "description": "The person's residences.",
"items": {
- "type": "string"
+ "$ref": "Residence"
},
"type": "array"
},
- "sources": {
- "description": "The sources of data for the person.",
+ "genders": {
+ "description": "The person's genders.",
"items": {
- "$ref": "Source"
+ "$ref": "Gender"
},
"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.",
+ "interests": {
+ "description": "The person's interests.",
"items": {
- "type": "string"
+ "$ref": "Interest"
},
"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"
+ "resourceName": {
+ "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters. Always starts with `people/`.",
+ "type": "string"
+ },
+ "biographies": {
+ "description": "The person's biographies.",
+ "items": {
+ "$ref": "Biography"
+ },
+ "type": "array"
+ },
+ "skills": {
+ "description": "The person's skills.",
+ "items": {
+ "$ref": "Skill"
+ },
+ "type": "array"
+ },
+ "relationshipStatuses": {
+ "description": "The person's relationship statuses.",
+ "items": {
+ "$ref": "RelationshipStatus"
+ },
+ "type": "array"
+ },
+ "photos": {
+ "description": "The person's photos.",
+ "items": {
+ "$ref": "Photo"
+ },
+ "type": "array"
+ },
+ "ageRange": {
+ "description": "DEPRECATED(Please read person.age_ranges instead). The person's 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"
+ },
+ "taglines": {
+ "description": "The person's taglines.",
+ "items": {
+ "$ref": "Tagline"
+ },
+ "type": "array"
+ },
+ "ageRanges": {
+ "description": "The person's 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 group memberships.",
+ "items": {
+ "$ref": "Membership"
+ },
+ "type": "array"
+ },
+ "phoneNumbers": {
+ "description": "The person's phone numbers.",
+ "items": {
+ "$ref": "PhoneNumber"
+ },
+ "type": "array"
+ },
+ "coverPhotos": {
+ "description": "The person's cover photos.",
+ "items": {
+ "$ref": "CoverPhoto"
+ },
+ "type": "array"
+ },
+ "imClients": {
+ "description": "The person's instant messaging clients.",
+ "items": {
+ "$ref": "ImClient"
+ },
+ "type": "array"
+ },
+ "birthdays": {
+ "description": "The person's birthdays.",
+ "items": {
+ "$ref": "Birthday"
+ },
+ "type": "array"
+ },
+ "locales": {
+ "description": "The person's locale preferences.",
+ "items": {
+ "$ref": "Locale"
+ },
+ "type": "array"
+ },
+ "relationshipInterests": {
+ "description": "The kind of relationship the person is looking for.",
+ "items": {
+ "$ref": "RelationshipInterest"
+ },
+ "type": "array"
+ },
+ "urls": {
+ "description": "The person's associated URLs.",
+ "items": {
+ "$ref": "Url"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "Event": {
- "description": "An event related to the person.",
- "id": "Event",
+ "GetPeopleResponse": {
+ "id": "GetPeopleResponse",
"properties": {
- "date": {
- "$ref": "Date",
- "description": "The date of the event."
- },
- "formattedType": {
- "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the event."
- },
- "type": {
- "description": "The type of the event. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `anniversary`\n* `other`",
- "type": "string"
+ "responses": {
+ "description": "The response for each requested resource name.",
+ "items": {
+ "$ref": "PersonResponse"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "Url": {
- "description": "A person's associated URLs.",
- "id": "Url",
+ "PhoneNumber": {
+ "description": "A person's phone number.",
+ "id": "PhoneNumber",
"properties": {
- "value": {
- "description": "The URL.",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the URL."
+ "description": "Metadata about the phone number."
},
"type": {
- "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
+ "description": "The type of the 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"
- },
- "Gender": {
- "description": "A person's gender.",
- "id": "Gender",
- "properties": {
+ },
"value": {
- "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
+ "description": "The phone number.",
"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.",
+ "formattedType": {
+ "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the the `Accept-Language` HTTP header locale.",
"type": "string"
},
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the gender."
+ "canonicalForm": {
+ "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
+ "type": "string"
}
},
"type": "object"
},
- "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",
+ "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": {
- "url": {
- "description": "The URL of the cover photo.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the cover photo."
+ "description": "Metadata about the 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"
+ "url": {
+ "description": "The URL of the photo.",
+ "type": "string"
}
},
"type": "object"
},
- "ImClient": {
- "description": "A person's instant messaging client.",
- "id": "ImClient",
+ "ListConnectionsResponse": {
+ "id": "ListConnectionsResponse",
"properties": {
- "username": {
- "description": "The user name used in the IM client.",
+ "nextPageToken": {
+ "description": "The token that can be used to retrieve the next page of results.",
"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.",
- "type": "string"
+ "connections": {
+ "description": "The list of people that the requestor is connected to.",
+ "items": {
+ "$ref": "Person"
+ },
+ "type": "array"
},
- "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.",
+ "nextSyncToken": {
+ "description": "The token that can be used to retrieve changes since the last request.",
"type": "string"
- },
+ }
+ },
+ "type": "object"
+ },
+ "Birthday": {
+ "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
+ "id": "Birthday",
+ "properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the IM client."
+ "description": "Metadata about the birthday."
},
- "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`",
+ "text": {
+ "description": "A free-form string representing the user's birthday.",
"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"
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the birthday."
}
},
"type": "object"
},
- "Interest": {
- "description": "One of the person's interests.",
- "id": "Interest",
+ "Residence": {
+ "description": "A person's past or current residence.",
+ "id": "Residence",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the interest."
+ "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 interest; for example, `stargazing`.",
+ "description": "The address of the residence.",
"type": "string"
}
},
"type": "object"
},
- "EmailAddress": {
- "description": "A person's email address.",
- "id": "EmailAddress",
+ "Address": {
+ "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
+ "id": "Address",
"properties": {
- "displayName": {
- "description": "The display name of the email.",
+ "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 email address."
+ "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 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 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`",
+ "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"
},
- "value": {
- "description": "The email address.",
+ "extendedAddress": {
+ "description": "The extended address of the address; for example, the apartment number.",
"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.",
+ "poBox": {
+ "description": "The P.O. box of the address.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code of the address.",
"type": "string"
}
},
"type": "object"
},
- "Nickname": {
- "description": "A person's nickname.",
- "id": "Nickname",
+ "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"
+ },
+ "Event": {
+ "description": "An event related to the person.",
+ "id": "Event",
"properties": {
+ "formattedType": {
+ "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the nickname."
+ "description": "Metadata about the event."
},
"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.`"
- ],
+ "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"
},
- "value": {
- "description": "The nickname.",
- "type": "string"
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the event."
}
},
"type": "object"
},
- "Skill": {
- "description": "A skill that the person has.",
- "id": "Skill",
+ "PersonMetadata": {
+ "description": "The read-only metadata about a person.",
+ "id": "PersonMetadata",
"properties": {
- "value": {
- "description": "The skill; for example, `underwater basket weaving`.",
+ "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 read person.metadata.sources.profile_metadata instead).\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 skill."
+ "linkedPeopleResourceNames": {
+ "description": "Resource names of people linked to this resource.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sources": {
+ "description": "The sources of data for the person.",
+ "items": {
+ "$ref": "Source"
+ },
+ "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"
}
},
"type": "object"
},
- "DomainMembership": {
- "description": "A Google Apps Domain membership.",
- "id": "DomainMembership",
+ "ProfileMetadata": {
+ "description": "The read-only metadata about a profile.",
+ "id": "ProfileMetadata",
"properties": {
- "inViewerDomain": {
- "description": "True if the person is in the viewer's Google Apps domain.",
- "type": "boolean"
+ "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"
},
- "Membership": {
- "description": "A person's read-only membership in a group.",
- "id": "Membership",
+ "Url": {
+ "description": "A person's associated URLs.",
+ "id": "Url",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the membership."
+ "description": "Metadata about the URL."
},
- "contactGroupMembership": {
- "$ref": "ContactGroupMembership",
- "description": "The contact group membership."
+ "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"
},
- "domainMembership": {
- "$ref": "DomainMembership",
- "description": "The domain membership."
+ "value": {
+ "description": "The URL.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
}
},
"type": "object"
},
- "RelationshipStatus": {
- "description": "A person's read-only relationship status.",
- "id": "RelationshipStatus",
+ "Gender": {
+ "description": "A person's gender.",
+ "id": "Gender",
"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.",
+ "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 relationship status."
+ "description": "Metadata about the gender."
},
"value": {
- "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
+ "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
"type": "string"
}
},
"type": "object"
},
- "Tagline": {
- "description": "A read-only brief one-line description of the person.",
- "id": "Tagline",
+ "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": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the tagline."
+ "description": "Metadata about the cover photo."
},
- "value": {
- "description": "The tagline.",
+ "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"
+ },
+ "url": {
+ "description": "The URL of the cover photo.",
"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",
+ "Interest": {
+ "description": "One of the person's interests.",
+ "id": "Interest",
"properties": {
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "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"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the interest."
},
- "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"
+ "value": {
+ "description": "The interest; for example, `stargazing`.",
+ "type": "string"
}
},
"type": "object"
},
- "Name": {
- "description": "A person's name. If the name is a mononym, the family name is empty.",
- "id": "Name",
+ "ImClient": {
+ "description": "A person's instant messaging client.",
+ "id": "ImClient",
"properties": {
- "phoneticHonorificPrefix": {
- "description": "The honorific prefixes spelled as they sound.",
+ "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"
},
- "phoneticGivenName": {
- "description": "The given name spelled as it sounds.",
+ "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"
},
- "phoneticFamilyName": {
- "description": "The family name spelled as it sounds.",
+ "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"
},
- "familyName": {
- "description": "The family name.",
+ "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"
+ },
+ "Nickname": {
+ "description": "A person's nickname.",
+ "id": "Nickname",
+ "properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the name."
+ "description": "Metadata about the nickname."
},
- "phoneticMiddleName": {
- "description": "The middle name(s) spelled as they sound.",
+ "type": {
+ "description": "The type of the nickname.",
+ "enum": [
+ "DEFAULT",
+ "MAIDEN_NAME",
+ "INITIALS",
+ "GPLUS",
+ "OTHER_NAME"
+ ],
+ "enumDescriptions": [
+ "Generic nickname.",
+ "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
+ "Initials.",
+ "Google+ profile nickname.",
+ "A professional affiliation or other name; for example, `Dr. Smith.`"
+ ],
"type": "string"
},
- "phoneticFullName": {
- "description": "The full name spelled as it sounds.",
+ "value": {
+ "description": "The nickname.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EmailAddress": {
+ "description": "A person's email address.",
+ "id": "EmailAddress",
+ "properties": {
+ "value": {
+ "description": "The email address.",
"type": "string"
},
- "displayNameLastFirst": {
- "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n<code>Accept-Language</code> HTTP header.",
+ "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 read-only display name formatted according to the locale specified by\nthe viewer's account or the <code>Accept-Language</code> HTTP header.",
+ "description": "The display name of the email.",
"type": "string"
},
- "honorificSuffix": {
- "description": "The honorific suffixes, such as `Jr.`",
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "Skill": {
+ "description": "A skill that the person has.",
+ "id": "Skill",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the skill."
+ },
+ "value": {
+ "description": "The skill; for example, `underwater basket weaving`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DomainMembership": {
+ "description": "A Google Apps Domain membership.",
+ "id": "DomainMembership",
+ "properties": {
+ "inViewerDomain": {
+ "description": "True if the person is in the viewer's Google Apps domain.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Membership": {
+ "description": "A person's read-only membership in a group.",
+ "id": "Membership",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the membership."
+ },
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
+ },
+ "domainMembership": {
+ "$ref": "DomainMembership",
+ "description": "The domain 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"
+ },
+ "Tagline": {
+ "description": "A read-only brief one-line description of the person.",
+ "id": "Tagline",
+ "properties": {
+ "value": {
+ "description": "The tagline.",
"type": "string"
},
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the tagline."
+ }
+ },
+ "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": {
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "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": {
"honorificPrefix": {
"description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
"type": "string"
@@ -832,12 +1091,52 @@
"description": "The honorific suffixes spelled as they sound.",
"type": "string"
},
+ "middleName": {
+ "description": "The middle name(s).",
+ "type": "string"
+ },
"givenName": {
"description": "The given name.",
"type": "string"
},
- "middleName": {
- "description": "The middle name(s).",
+ "phoneticHonorificPrefix": {
+ "description": "The honorific prefixes spelled as they sound.",
+ "type": "string"
+ },
+ "phoneticGivenName": {
+ "description": "The given name spelled as it sounds.",
+ "type": "string"
+ },
+ "phoneticFamilyName": {
+ "description": "The family name spelled as it sounds.",
+ "type": "string"
+ },
+ "familyName": {
+ "description": "The family name.",
+ "type": "string"
+ },
+ "phoneticMiddleName": {
+ "description": "The middle name(s) spelled as they sound.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the name."
+ },
+ "phoneticFullName": {
+ "description": "The full name spelled as it sounds.",
+ "type": "string"
+ },
+ "displayNameLastFirst": {
+ "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n<code>Accept-Language</code> HTTP header.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the <code>Accept-Language</code> HTTP header.",
+ "type": "string"
+ },
+ "honorificSuffix": {
+ "description": "The honorific suffixes, such as `Jr.`",
"type": "string"
}
},
@@ -862,13 +1161,13 @@
"description": "A person's locale preference.",
"id": "Locale",
"properties": {
- "value": {
- "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the locale."
+ },
+ "value": {
+ "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
+ "type": "string"
}
},
"type": "object"
@@ -877,18 +1176,26 @@
"description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
"id": "Organization",
"properties": {
+ "title": {
+ "description": "The person's job title at the organization.",
+ "type": "string"
+ },
+ "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"
},
- "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"
- },
"startDate": {
"$ref": "Date",
"description": "The start date when the person joined the organization."
},
+ "formattedType": {
+ "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
"domain": {
"description": "The domain name associated with the organization; for example, `google.com`.",
"type": "string"
@@ -897,14 +1204,14 @@
"description": "The person's department at the organization.",
"type": "string"
},
- "phoneticName": {
- "description": "The phonetic 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"
},
+ "phoneticName": {
+ "description": "The phonetic name of the organization.",
+ "type": "string"
+ },
"jobDescription": {
"description": "The person's job description at the organization.",
"type": "string"
@@ -924,14 +1231,6 @@
"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.",
- "type": "string"
}
},
"type": "object"
@@ -965,10 +1264,41 @@
},
"type": "object"
},
+ "AgeRangeType": {
+ "description": "A person's age range.",
+ "id": "AgeRangeType",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the age range."
+ },
+ "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"
+ },
"FieldMetadata": {
"description": "Metadata about a field.",
"id": "FieldMetadata",
"properties": {
+ "source": {
+ "$ref": "Source",
+ "description": "The source of the field."
+ },
"verified": {
"description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
"type": "boolean"
@@ -976,10 +1306,26 @@
"primary": {
"description": "True if the field is the primary field; false if the field is a secondary\nfield.",
"type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PersonResponse": {
+ "description": "The response for a single person",
+ "id": "PersonResponse",
+ "properties": {
+ "person": {
+ "$ref": "Person",
+ "description": "The person."
},
- "source": {
- "$ref": "Source",
- "description": "The source of the field."
+ "httpStatusCode": {
+ "description": "[HTTP 1.1 status code](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"
@@ -988,10 +1334,6 @@
"description": "The source of a field.",
"id": "Source",
"properties": {
- "resourceName": {
- "description": "The resource name of the source. Only set if there is a separate\nresource endpoint.",
- "type": "string"
- },
"type": {
"description": "The source type.",
"enum": [
@@ -1017,6 +1359,10 @@
"id": {
"description": "The unique identifier within the source type generated by the server.",
"type": "string"
+ },
+ "profileMetadata": {
+ "$ref": "ProfileMetadata",
+ "description": "Metadata about a source of type PROFILE."
}
},
"type": "object"
@@ -1025,298 +1371,17 @@
"description": "A person's read-only relationship interest .",
"id": "RelationshipInterest",
"properties": {
- "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.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the relationship interest."
- }
- },
- "type": "object"
- },
- "PersonResponse": {
- "description": "The response for a single person",
- "id": "PersonResponse",
- "properties": {
- "person": {
- "$ref": "Person",
- "description": "The person."
- },
- "httpStatusCode": {
- "description": "[HTTP 1.1 status code](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"
- },
- "Relation": {
- "description": "A person's relation to another person.",
- "id": "Relation",
- "properties": {
- "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"
- },
- "person": {
- "description": "The name of the other person this relation refers to.",
- "type": "string"
- },
- "formattedType": {
- "description": "The type of the relation translated and formatted in the viewer's account\nlocale or the locale specified in the Accept-Language HTTP header.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Occupation": {
- "description": "A person's occupation.",
- "id": "Occupation",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the occupation."
},
"value": {
- "description": "The occupation; for example, `carpenter`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Person": {
- "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data. Fields other than IDs,\nmetadata, and group memberships are user-edited.\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": {
- "birthdays": {
- "description": "The person's birthdays.",
- "items": {
- "$ref": "Birthday"
- },
- "type": "array"
- },
- "locales": {
- "description": "The person's locale preferences.",
- "items": {
- "$ref": "Locale"
- },
- "type": "array"
- },
- "relationshipInterests": {
- "description": "The kind of relationship the person is looking for.",
- "items": {
- "$ref": "RelationshipInterest"
- },
- "type": "array"
- },
- "urls": {
- "description": "The person's associated URLs.",
- "items": {
- "$ref": "Url"
- },
- "type": "array"
- },
- "nicknames": {
- "description": "The person's nicknames.",
- "items": {
- "$ref": "Nickname"
- },
- "type": "array"
- },
- "names": {
- "description": "The person's names.",
- "items": {
- "$ref": "Name"
- },
- "type": "array"
- },
- "relations": {
- "description": "The person's relations.",
- "items": {
- "$ref": "Relation"
- },
- "type": "array"
- },
- "occupations": {
- "description": "The person's occupations.",
- "items": {
- "$ref": "Occupation"
- },
- "type": "array"
- },
- "emailAddresses": {
- "description": "The person's email addresses.",
- "items": {
- "$ref": "EmailAddress"
- },
- "type": "array"
- },
- "organizations": {
- "description": "The person's past or current organizations.",
- "items": {
- "$ref": "Organization"
- },
- "type": "array"
- },
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
- "type": "string"
- },
- "braggingRights": {
- "description": "The person's bragging rights.",
- "items": {
- "$ref": "BraggingRights"
- },
- "type": "array"
- },
- "metadata": {
- "$ref": "PersonMetadata",
- "description": "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"
- },
- "interests": {
- "description": "The person's interests.",
- "items": {
- "$ref": "Interest"
- },
- "type": "array"
- },
- "resourceName": {
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters. Always starts with `people/`.",
+ "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"
},
- "biographies": {
- "description": "The person's biographies.",
- "items": {
- "$ref": "Biography"
- },
- "type": "array"
- },
- "skills": {
- "description": "The person's skills.",
- "items": {
- "$ref": "Skill"
- },
- "type": "array"
- },
- "relationshipStatuses": {
- "description": "The person's relationship statuses.",
- "items": {
- "$ref": "RelationshipStatus"
- },
- "type": "array"
- },
- "photos": {
- "description": "The person's photos.",
- "items": {
- "$ref": "Photo"
- },
- "type": "array"
- },
- "ageRange": {
- "description": "The person's 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."
- ],
+ "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"
- },
- "taglines": {
- "description": "The person's taglines.",
- "items": {
- "$ref": "Tagline"
- },
- "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 group memberships.",
- "items": {
- "$ref": "Membership"
- },
- "type": "array"
- },
- "phoneNumbers": {
- "description": "The person's phone numbers.",
- "items": {
- "$ref": "PhoneNumber"
- },
- "type": "array"
- },
- "coverPhotos": {
- "description": "The person's cover photos.",
- "items": {
- "$ref": "CoverPhoto"
- },
- "type": "array"
- },
- "imClients": {
- "description": "The person's instant messaging clients.",
- "items": {
- "$ref": "ImClient"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GetPeopleResponse": {
- "id": "GetPeopleResponse",
- "properties": {
- "responses": {
- "description": "The response for each requested resource name.",
- "items": {
- "$ref": "PersonResponse"
- },
- "type": "array"
}
},
"type": "object"
« no previous file with comments | « discovery/googleapis/monitoring__v3.json ('k') | discovery/googleapis/plusDomains__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698