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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/people__v1.json

Issue 2695743002: Api-roll 45: 2017-02-13 (Closed)
Patch Set: reverted local changes to pubspec file Created 3 years, 10 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 64194ae44b4316a3007611c85436e06f95dd75b4..6b57ab1ca944875454798145ddc73b1ff5670021 100644
--- a/discovery/googleapis/people__v1.json
+++ b/discovery/googleapis/people__v1.json
@@ -2,32 +2,32 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/contacts": {
- "description": "Manage your contacts"
- },
- "https://www.googleapis.com/auth/contacts.readonly": {
- "description": "View your contacts"
- },
"https://www.googleapis.com/auth/plus.login": {
- "description": "Know your basic profile info and list of people in your circles."
- },
- "https://www.googleapis.com/auth/user.addresses.read": {
- "description": "View your street addresses"
+ "description": "Know the list of people in your circles, your age range, and language"
},
- "https://www.googleapis.com/auth/user.birthday.read": {
- "description": "View your complete date of birth"
+ "https://www.googleapis.com/auth/userinfo.profile": {
+ "description": "View your basic profile info"
},
"https://www.googleapis.com/auth/user.emails.read": {
"description": "View your email addresses"
},
+ "https://www.googleapis.com/auth/contacts": {
+ "description": "Manage your contacts"
+ },
+ "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/userinfo.profile": {
- "description": "View your basic profile info"
+ "https://www.googleapis.com/auth/user.birthday.read": {
+ "description": "View your complete date of birth"
+ },
+ "https://www.googleapis.com/auth/contacts.readonly": {
+ "description": "View your contacts"
}
}
}
@@ -35,10 +35,9 @@
"basePath": "",
"baseUrl": "https://people.googleapis.com/",
"batchPath": "batch",
- "description": "The Google People API service gives access to information about profiles and contacts.",
+ "description": "Provides access to information about profiles and contacts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/people/",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/tzwJjoO4XDFgwNQjmiM8lPsFMzA\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -49,80 +48,89 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "access_token": {
- "description": "OAuth access token.",
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
},
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
"location": "query",
- "type": "string"
+ "type": "boolean"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"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.",
+ "callback": {
+ "description": "JSONP",
"location": "query",
"type": "string"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
"location": "query",
"type": "string"
},
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
+ "access_token": {
+ "description": "OAuth access token.",
"location": "query",
- "type": "boolean"
+ "type": "string"
},
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
+ "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": "boolean"
+ "type": "string"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
"location": "query",
- "type": "string"
+ "type": "boolean"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
- "$.xgafv": {
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
}
@@ -131,30 +139,28 @@
"resources": {
"people": {
"methods": {
- "get": {
- "description": "Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.",
+ "getBatchGet": {
+ "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.",
"httpMethod": "GET",
- "id": "people.people.get",
- "parameterOrder": [
- "resourceName"
- ],
+ "id": "people.people.getBatchGet",
+ "parameterOrder": [],
"parameters": {
- "resourceName": {
- "description": "The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about any user, specify the resource name that identifies the user, such as the resource names returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list).",
- "location": "path",
- "pattern": "^people/[^/]*$",
- "required": true,
+ "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"
},
- "requestMask.includeField": {
- "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.",
+ "resourceNames": {
+ "description": "The resource name, such as one returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list),\nof one of the people to provide information about. You can include this\nparameter up to 50 times in one request.",
"location": "query",
+ "repeated": true,
"type": "string"
}
},
- "path": "v1/{+resourceName}",
+ "path": "v1/people:batchGet",
"response": {
- "$ref": "Person"
+ "$ref": "GetPeopleResponse"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
@@ -168,26 +174,31 @@
"https://www.googleapis.com/auth/userinfo.profile"
]
},
- "getBatchGet": {
- "description": "Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.",
+ "get": {
+ "description": "Provides information about a person resource for a resource name. Use\n`people/me` to indicate the authenticated user.",
"httpMethod": "GET",
- "id": "people.people.getBatchGet",
+ "id": "people.people.get",
+ "parameterOrder": [
+ "resourceName"
+ ],
"parameters": {
- "resourceNames": {
- "description": "The resource name, such as one returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list), of one of the people to provide information about. You can include this parameter up to 50 times in one request.",
- "location": "query",
- "repeated": true,
+ "resourceName": {
+ "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about any user, specify the resource name that\n identifies the user, such as the resource names returned by\n [`people.connections.list`](/people/api/rest/v1/people.connections/list).",
+ "location": "path",
+ "pattern": "^people/[^/]+$",
+ "required": true,
"type": "string"
},
"requestMask.includeField": {
- "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.",
+ "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:batchGet",
+ "path": "v1/{+resourceName}",
"response": {
- "$ref": "GetPeopleResponse"
+ "$ref": "Person"
},
"scopes": [
"https://www.googleapis.com/auth/contacts",
@@ -203,280 +214,260 @@
}
},
"resources": {
- "connections": {
- "methods": {
- "list": {
- "description": "Provides a list of the authenticated user's contacts merged with any linked profiles.",
- "httpMethod": "GET",
- "id": "people.people.connections.list",
- "parameterOrder": [
- "resourceName"
- ],
- "parameters": {
- "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"
- },
- "pageSize": {
- "description": "The number of connections to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "sortOrder": {
- "description": "The order in which the connections should be sorted. Defaults to `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`. Only resources changed since the sync token was created are returned.",
- "location": "query",
- "type": "string"
- },
- "requestMask.includeField": {
- "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.",
- "location": "query",
- "type": "string"
+ "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"
+ ]
}
- },
- "path": "v1/{+resourceName}/connections",
- "response": {
- "$ref": "ListConnectionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ]
+ }
}
}
}
}
}
},
- "revision": "20160210",
+ "revision": "20170209",
"rootUrl": "https://people.googleapis.com/",
"schemas": {
- "Person": {
- "description": "Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.",
- "id": "Person",
+ "PhoneNumber": {
+ "description": "A person's phone number.",
+ "id": "PhoneNumber",
"properties": {
- "resourceName": {
- "description": "The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.",
+ "value": {
+ "description": "The phone number.",
"type": "string"
},
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.",
+ "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": "PersonMetadata",
- "description": "Metadata about the person."
- },
- "locales": {
- "description": "The person's locale preferences.",
- "items": {
- "$ref": "Locale"
- },
- "type": "array"
- },
- "names": {
- "description": "The person's names.",
- "items": {
- "$ref": "Name"
- },
- "type": "array"
+ "canonicalForm": {
+ "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
+ "type": "string"
},
- "nicknames": {
- "description": "The person's nicknames.",
- "items": {
- "$ref": "Nickname"
- },
- "type": "array"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the phone number."
},
- "coverPhotos": {
- "description": "The person's cover photos.",
- "items": {
- "$ref": "CoverPhoto"
- },
- "type": "array"
+ "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."
},
- "photos": {
- "description": "The person's photos.",
- "items": {
- "$ref": "Photo"
- },
- "type": "array"
+ "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.",
+ "type": "string"
},
- "genders": {
- "description": "The person's genders.",
+ "connections": {
+ "description": "The list of people that the requestor is connected to.",
"items": {
- "$ref": "Gender"
+ "$ref": "Person"
},
"type": "array"
},
- "ageRange": {
- "description": "The person's age range.",
- "enum": [
- "AGE_RANGE_UNSPECIFIED",
- "LESS_THAN_EIGHTEEN",
- "EIGHTEEN_TO_TWENTY",
- "TWENTY_ONE_OR_OLDER"
- ],
+ "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 birthday."
},
- "birthdays": {
- "description": "The person's birthdays.",
- "items": {
- "$ref": "Birthday"
- },
- "type": "array"
+ "text": {
+ "description": "A free-form string representing the user's birthday.",
+ "type": "string"
},
- "events": {
- "description": "The person's events.",
- "items": {
- "$ref": "Event"
- },
- "type": "array"
- },
- "addresses": {
- "description": "The person's street addresses.",
- "items": {
- "$ref": "Address"
- },
- "type": "array"
- },
- "residences": {
- "description": "The person's residences.",
- "items": {
- "$ref": "Residence"
- },
- "type": "array"
- },
- "emailAddresses": {
- "description": "The person's email addresses.",
- "items": {
- "$ref": "EmailAddress"
- },
- "type": "array"
- },
- "phoneNumbers": {
- "description": "The person's phone numbers.",
- "items": {
- "$ref": "PhoneNumber"
- },
- "type": "array"
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the birthday."
+ }
+ },
+ "type": "object"
+ },
+ "Residence": {
+ "description": "A person's past or current residence.",
+ "id": "Residence",
+ "properties": {
+ "value": {
+ "description": "The address of the residence.",
+ "type": "string"
},
- "imClients": {
- "description": "The person's instant messaging clients.",
- "items": {
- "$ref": "ImClient"
- },
- "type": "array"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the residence."
},
- "taglines": {
- "description": "The person's taglines.",
- "items": {
- "$ref": "Tagline"
- },
- "type": "array"
+ "current": {
+ "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
+ "type": "boolean"
+ }
+ },
+ "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"
},
- "biographies": {
- "description": "The person's biographies.",
- "items": {
- "$ref": "Biography"
- },
- "type": "array"
+ "poBox": {
+ "description": "The P.O. box of the address.",
+ "type": "string"
},
- "urls": {
- "description": "The person's associated URLs.",
- "items": {
- "$ref": "Url"
- },
- "type": "array"
+ "postalCode": {
+ "description": "The postal code of the address.",
+ "type": "string"
},
- "organizations": {
- "description": "The person's past or current organizations.",
- "items": {
- "$ref": "Organization"
- },
- "type": "array"
+ "region": {
+ "description": "The region of the address; for example, the state or province.",
+ "type": "string"
},
- "occupations": {
- "description": "The person's occupations.",
- "items": {
- "$ref": "Occupation"
- },
- "type": "array"
+ "streetAddress": {
+ "description": "The street address.",
+ "type": "string"
},
- "interests": {
- "description": "The person's interests.",
- "items": {
- "$ref": "Interest"
- },
- "type": "array"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the address."
},
- "skills": {
- "description": "The person's skills.",
- "items": {
- "$ref": "Skill"
- },
- "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"
},
- "braggingRights": {
- "description": "The person's bragging rights.",
- "items": {
- "$ref": "BraggingRights"
- },
- "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"
},
- "relations": {
- "description": "The person's relations.",
- "items": {
- "$ref": "Relation"
- },
- "type": "array"
+ "city": {
+ "description": "The city of the address.",
+ "type": "string"
},
- "relationshipInterests": {
- "description": "The kind of relationship the person is looking for.",
- "items": {
- "$ref": "RelationshipInterest"
- },
- "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.",
+ "type": "string"
},
- "relationshipStatuses": {
- "description": "The person's relationship statuses.",
- "items": {
- "$ref": "RelationshipStatus"
- },
- "type": "array"
+ "country": {
+ "description": "The country of the address.",
+ "type": "string"
},
- "memberships": {
- "description": "The person's group memberships.",
- "items": {
- "$ref": "Membership"
- },
- "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": "Metadata about a person.",
+ "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"
+ },
+ "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": {
@@ -485,134 +476,171 @@
"type": "array"
},
"previousResourceNames": {
- "description": "Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.",
+ "description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
"items": {
"type": "string"
},
"type": "array"
},
"deleted": {
- "description": "True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.",
+ "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": "The type of the person object.",
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "type": "string"
}
},
"type": "object"
},
- "Source": {
- "description": "The source of a field.",
- "id": "Source",
+ "Event": {
+ "description": "An event related to the person.",
+ "id": "Event",
"properties": {
- "type": {
- "description": "The source type.",
- "enum": [
- "OTHER",
- "ACCOUNT",
- "PROFILE",
- "DOMAIN_PROFILE",
- "CONTACT"
- ],
+ "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"
},
- "id": {
- "description": "A unique identifier within the source type generated by the server.",
+ "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"
}
},
"type": "object"
},
- "Locale": {
- "description": "A person's locale preference.",
- "id": "Locale",
+ "Url": {
+ "description": "A person's associated URLs.",
+ "id": "Url",
"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 locale."
+ "description": "Metadata about the URL."
},
- "value": {
- "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.",
+ "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"
}
},
"type": "object"
},
- "FieldMetadata": {
- "description": "Metadata about a field.",
- "id": "FieldMetadata",
+ "Gender": {
+ "description": "A person's gender.",
+ "id": "Gender",
"properties": {
- "primary": {
- "description": "True if the field is the primary field; false if the field is a secondary field.",
- "type": "boolean"
+ "value": {
+ "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
+ "type": "string"
},
- "verified": {
- "description": "True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.",
- "type": "boolean"
+ "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"
},
- "source": {
- "$ref": "Source",
- "description": "The source of the field."
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the gender."
}
},
"type": "object"
},
- "Name": {
- "description": "A person's name. If the name is a mononym, the family name is empty.",
- "id": "Name",
+ "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"
+ },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the name."
+ "description": "Metadata about the cover photo."
},
- "displayName": {
- "description": "The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.",
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "ImClient": {
+ "description": "A person's instant messaging client.",
+ "id": "ImClient",
+ "properties": {
+ "username": {
+ "description": "The user name used in the IM client.",
"type": "string"
},
- "familyName": {
- "description": "The family 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"
},
- "givenName": {
- "description": "The given name.",
+ "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"
},
- "middleName": {
- "description": "The middle name(s).",
- "type": "string"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the IM client."
},
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "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"
},
- "honorificSuffix": {
- "description": "The honorific suffixes, such as `Jr.`",
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "Interest": {
+ "description": "One of the person's interests.",
+ "id": "Interest",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the interest."
},
- "phoneticFamilyName": {
- "description": "The family name spelled as it sounds.",
+ "value": {
+ "description": "The interest; for example, `stargazing`.",
"type": "string"
- },
- "phoneticGivenName": {
- "description": "The given name spelled as it sounds.",
+ }
+ },
+ "type": "object"
+ },
+ "EmailAddress": {
+ "description": "A person's email address.",
+ "id": "EmailAddress",
+ "properties": {
+ "displayName": {
+ "description": "The display name of the email.",
"type": "string"
},
- "phoneticMiddleName": {
- "description": "The middle name(s) spelled as they sound.",
+ "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"
},
- "phoneticHonorificPrefix": {
- "description": "The honorific prefixes spelled as they sound.",
+ "value": {
+ "description": "The email address.",
"type": "string"
},
- "phoneticHonorificSuffix": {
- "description": "The honorific suffixes spelled as they sound.",
+ "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"
}
},
@@ -626,10 +654,6 @@
"$ref": "FieldMetadata",
"description": "Metadata about the nickname."
},
- "value": {
- "description": "The nickname.",
- "type": "string"
- },
"type": {
"description": "The type of the nickname.",
"enum": [
@@ -639,293 +663,274 @@
"GPLUS",
"OTHER_NAME"
],
+ "enumDescriptions": [
+ "Generic nickname.",
+ "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
+ "Initials.",
+ "Google+ profile nickname.",
+ "A professional affiliation or other name; for example, `Dr. Smith.`"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The nickname.",
"type": "string"
}
},
"type": "object"
},
- "CoverPhoto": {
- "description": "A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.",
- "id": "CoverPhoto",
+ "Skill": {
+ "description": "A skill that the person has.",
+ "id": "Skill",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the cover photo."
- },
- "url": {
- "description": "The URL of the cover photo.",
+ "value": {
+ "description": "The skill; for example, `underwater basket weaving`.",
"type": "string"
},
- "default": {
- "description": "True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.",
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the skill."
+ }
+ },
+ "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"
},
- "Photo": {
- "description": "A person's photo. A picture shown next to the person's name to help others recognize the person.",
- "id": "Photo",
+ "Membership": {
+ "description": "A person's read-only membership in a group.",
+ "id": "Membership",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the photo."
+ "description": "Metadata about the membership."
},
- "url": {
- "description": "The URL of the photo.",
- "type": "string"
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
+ },
+ "domainMembership": {
+ "$ref": "DomainMembership",
+ "description": "The domain membership."
}
},
"type": "object"
},
- "Gender": {
- "description": "A person's gender.",
- "id": "Gender",
+ "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 gender."
+ "description": "Metadata about the relationship status."
},
"value": {
- "description": "The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`",
- "type": "string"
- },
- "formattedValue": {
- "description": "The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "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"
},
- "Birthday": {
- "description": "A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.",
- "id": "Birthday",
+ "Tagline": {
+ "description": "A read-only brief one-line description of the person.",
+ "id": "Tagline",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the birthday."
- },
- "date": {
- "$ref": "Date",
- "description": "The date of the birthday."
+ "description": "Metadata about the tagline."
},
- "text": {
- "description": "A free-form string representing the user's birthday.",
+ "value": {
+ "description": "The tagline.",
"type": "string"
}
},
"type": "object"
},
"Date": {
- "description": "Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary 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 a year.",
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
"format": "int32",
"type": "integer"
},
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
"type": "integer"
},
"day": {
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.",
+ "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"
}
},
"type": "object"
},
- "Event": {
- "description": "An event related to the person.",
- "id": "Event",
+ "Name": {
+ "description": "A person's name. If the name is a mononym, the family name is empty.",
+ "id": "Name",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the event."
- },
- "date": {
- "$ref": "Date",
- "description": "The date of the event."
- },
- "type": {
- "description": "The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`",
+ "phoneticHonorificPrefix": {
+ "description": "The honorific prefixes spelled as they sound.",
"type": "string"
},
- "formattedType": {
- "description": "The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "phoneticGivenName": {
+ "description": "The given name spelled as it sounds.",
"type": "string"
- }
- },
- "type": "object"
- },
- "Address": {
- "description": "A person's physical address. May be a P.O. box or street address. All fields are optional.",
- "id": "Address",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the address."
},
- "formattedValue": {
- "description": "The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "phoneticFamilyName": {
+ "description": "The family name spelled as it sounds.",
"type": "string"
},
- "type": {
- "description": "The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`",
+ "familyName": {
+ "description": "The family name.",
"type": "string"
},
- "formattedType": {
- "description": "The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the name."
+ },
+ "phoneticMiddleName": {
+ "description": "The middle name(s) spelled as they sound.",
"type": "string"
},
- "poBox": {
- "description": "The P.O. box of the address.",
+ "phoneticFullName": {
+ "description": "The full name spelled as it sounds.",
"type": "string"
},
- "streetAddress": {
- "description": "The street address.",
+ "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"
},
- "extendedAddress": {
- "description": "The extended address of the address; for example, the apartment number.",
+ "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"
},
- "city": {
- "description": "The city of the address.",
+ "honorificSuffix": {
+ "description": "The honorific suffixes, such as `Jr.`",
"type": "string"
},
- "region": {
- "description": "The region of the address; for example, the state or province.",
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
"type": "string"
},
- "postalCode": {
- "description": "The postal code of the address.",
+ "phoneticHonorificSuffix": {
+ "description": "The honorific suffixes spelled as they sound.",
"type": "string"
},
- "country": {
- "description": "The country of the address.",
+ "givenName": {
+ "description": "The given name.",
"type": "string"
},
- "countryCode": {
- "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.",
+ "middleName": {
+ "description": "The middle name(s).",
"type": "string"
}
},
"type": "object"
},
- "Residence": {
- "description": "A person's past or current residence.",
- "id": "Residence",
+ "BraggingRights": {
+ "description": "A person's bragging rights.",
+ "id": "BraggingRights",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the residence."
+ "description": "Metadata about the bragging rights."
},
"value": {
- "description": "The address of the residence.",
+ "description": "The bragging rights; for example, `climbed mount everest`.",
"type": "string"
- },
- "current": {
- "description": "True if the residence is the person's current residence; false if the residence is a past residence.",
- "type": "boolean"
}
},
"type": "object"
},
- "EmailAddress": {
- "description": "A person's email address.",
- "id": "EmailAddress",
+ "Locale": {
+ "description": "A person's locale preference.",
+ "id": "Locale",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the email address."
- },
"value": {
- "description": "The email address.",
- "type": "string"
- },
- "type": {
- "description": "The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`",
+ "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
"type": "string"
},
- "formattedType": {
- "description": "The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the locale."
}
},
"type": "object"
},
- "PhoneNumber": {
- "description": "A person's phone number.",
- "id": "PhoneNumber",
+ "Organization": {
+ "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
+ "id": "Organization",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the phone number."
+ "current": {
+ "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
+ "type": "boolean"
},
- "value": {
- "description": "The phone number.",
+ "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"
},
- "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) form of the phone number.",
- "type": "string"
+ "startDate": {
+ "$ref": "Date",
+ "description": "The start date when the person joined the organization."
},
- "type": {
- "description": "The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`",
+ "domain": {
+ "description": "The domain name associated with the organization; for example, `google.com`.",
"type": "string"
},
- "formattedType": {
- "description": "The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.",
+ "department": {
+ "description": "The person's department at the organization.",
"type": "string"
- }
- },
- "type": "object"
- },
- "ImClient": {
- "description": "A person's instant messaging client.",
- "id": "ImClient",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the IM client."
},
- "username": {
- "description": "The user name used in the IM client.",
+ "phoneticName": {
+ "description": "The phonetic name of the organization.",
"type": "string"
},
"type": {
- "description": "The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`",
+ "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
"type": "string"
},
- "formattedType": {
- "description": "The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "jobDescription": {
+ "description": "The person's job description at the organization.",
"type": "string"
},
- "protocol": {
- "description": "The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`",
+ "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"
},
- "formattedProtocol": {
- "description": "The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "name": {
+ "description": "The name of the organization.",
"type": "string"
- }
- },
- "type": "object"
- },
- "Tagline": {
- "description": "A brief one-line description of the person.",
- "id": "Tagline",
- "properties": {
+ },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the tagline."
+ "description": "Metadata about the organization."
},
- "value": {
- "description": "The tagline.",
+ "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"
}
},
@@ -935,6 +940,20 @@
"description": "A person's short biography.",
"id": "Biography",
"properties": {
+ "contentType": {
+ "description": "The content type of the biography.",
+ "enum": [
+ "CONTENT_TYPE_UNSPECIFIED",
+ "TEXT_PLAIN",
+ "TEXT_HTML"
+ ],
+ "enumDescriptions": [
+ "Unspecified.",
+ "Plain text.",
+ "HTML text."
+ ],
+ "type": "string"
+ },
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the biography."
@@ -946,147 +965,96 @@
},
"type": "object"
},
- "Url": {
- "description": "A person's associated URLs.",
- "id": "Url",
+ "FieldMetadata": {
+ "description": "Metadata about a field.",
+ "id": "FieldMetadata",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the URL."
- },
- "value": {
- "description": "The URL.",
- "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"
},
- "type": {
- "description": "The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`",
- "type": "string"
+ "primary": {
+ "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
+ "type": "boolean"
},
- "formattedType": {
- "description": "The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
+ "source": {
+ "$ref": "Source",
+ "description": "The source of the field."
}
},
"type": "object"
},
- "Organization": {
- "description": "A person's past or current organization. Overlapping date ranges are permitted.",
- "id": "Organization",
+ "Source": {
+ "description": "The source of a field.",
+ "id": "Source",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the organization."
- },
- "type": {
- "description": "The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the organization translated and formatted in the viewer'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."
- },
- "endDate": {
- "$ref": "Date",
- "description": "The end date when the person left the organization."
- },
- "current": {
- "description": "True if the organization is the person's current organization; false if the organization is a past organization.",
- "type": "boolean"
- },
- "name": {
- "description": "The name of the organization.",
- "type": "string"
- },
- "phoneticName": {
- "description": "The phonetic name of the organization.",
- "type": "string"
- },
- "department": {
- "description": "The person's department at the organization.",
- "type": "string"
- },
- "title": {
- "description": "The person's job title at the organization.",
- "type": "string"
- },
- "jobDescription": {
- "description": "The person's job description at the organization.",
+ "resourceName": {
+ "description": "The resource name of the source. Only set if there is a separate\nresource endpoint.",
"type": "string"
},
- "symbol": {
- "description": "The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.",
+ "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/<id> where <id> is the source\nid.",
+ "[Google Apps domain profile](https://admin.google.com).",
+ "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/<id> where <id> is the source\nid."
+ ],
"type": "string"
},
- "domain": {
- "description": "The domain name associated with the organization; for example, `google.com`.",
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.",
"type": "string"
},
- "location": {
- "description": "The location of the organization office the person works at.",
+ "id": {
+ "description": "The unique identifier within the source type generated by the server.",
"type": "string"
}
},
"type": "object"
},
- "Occupation": {
- "description": "A person's occupation.",
- "id": "Occupation",
+ "RelationshipInterest": {
+ "description": "A person's read-only relationship interest .",
+ "id": "RelationshipInterest",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the occupation."
- },
"value": {
- "description": "The occupation; for example, `carpenter`.",
+ "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"
- },
- "Interest": {
- "description": "One of the person's interests.",
- "id": "Interest",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the interest."
},
- "value": {
- "description": "The interest; for example, `stargazing`.",
+ "formattedValue": {
+ "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
"type": "string"
- }
- },
- "type": "object"
- },
- "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"
+ "description": "Metadata about the relationship interest."
}
},
"type": "object"
},
- "BraggingRights": {
- "description": "A person's bragging rights.",
- "id": "BraggingRights",
+ "PersonResponse": {
+ "description": "The response for a single person",
+ "id": "PersonResponse",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the bragging rights."
+ "person": {
+ "$ref": "Person",
+ "description": "The person."
},
- "value": {
- "description": "The bragging rights; for example, `climbed mount everest`.",
+ "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"
}
},
@@ -1100,150 +1068,255 @@
"$ref": "FieldMetadata",
"description": "Metadata about the relation."
},
- "person": {
- "description": "The name of the other person this relation refers to.",
+ "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"
},
- "type": {
- "description": "The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`",
+ "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 locale or the locale specified in the Accept-Language HTTP header.",
+ "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"
},
- "RelationshipInterest": {
- "description": "The kind of relationship the person is looking for.",
- "id": "RelationshipInterest",
+ "Occupation": {
+ "description": "A person's occupation.",
+ "id": "Occupation",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the relationship interest."
+ "description": "Metadata about the occupation."
},
"value": {
- "description": "The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`",
- "type": "string"
- },
- "formattedValue": {
- "description": "The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.",
+ "description": "The occupation; for example, `carpenter`.",
"type": "string"
}
},
"type": "object"
},
- "RelationshipStatus": {
- "description": "A person's relationship status.",
- "id": "RelationshipStatus",
+ "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": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relationship status."
+ "birthdays": {
+ "description": "The person's birthdays.",
+ "items": {
+ "$ref": "Birthday"
+ },
+ "type": "array"
},
- "value": {
- "description": "The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`",
- "type": "string"
+ "locales": {
+ "description": "The person's locale preferences.",
+ "items": {
+ "$ref": "Locale"
+ },
+ "type": "array"
},
- "formattedValue": {
- "description": "The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "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"
- }
- },
- "type": "object"
- },
- "Membership": {
- "description": "A person's membership in a group.",
- "id": "Membership",
- "properties": {
+ },
+ "braggingRights": {
+ "description": "The person's bragging rights.",
+ "items": {
+ "$ref": "BraggingRights"
+ },
+ "type": "array"
+ },
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the membership."
+ "$ref": "PersonMetadata",
+ "description": "Metadata about the person."
},
- "contactGroupMembership": {
- "$ref": "ContactGroupMembership",
- "description": "The contact group membership."
+ "residences": {
+ "description": "The person's residences.",
+ "items": {
+ "$ref": "Residence"
+ },
+ "type": "array"
},
- "domainMembership": {
- "$ref": "DomainMembership",
- "description": "The domain membership."
- }
- },
- "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 ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.",
+ "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/`.",
"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"
- },
- "GetPeopleResponse": {
- "id": "GetPeopleResponse",
- "properties": {
- "responses": {
- "description": "The response for each requested resource name.",
+ },
+ "biographies": {
+ "description": "The person's biographies.",
"items": {
- "$ref": "PersonResponse"
+ "$ref": "Biography"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "PersonResponse": {
- "description": "The response for a single person",
- "id": "PersonResponse",
- "properties": {
- "httpStatusCode": {
- "description": "[HTTP 1.1 status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
- "format": "int32",
- "type": "integer"
},
- "person": {
- "$ref": "Person",
- "description": "The person."
+ "skills": {
+ "description": "The person's skills.",
+ "items": {
+ "$ref": "Skill"
+ },
+ "type": "array"
},
- "requestedResourceName": {
- "description": "The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.",
+ "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."
+ ],
"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"
},
- "ListConnectionsResponse": {
- "id": "ListConnectionsResponse",
+ "GetPeopleResponse": {
+ "id": "GetPeopleResponse",
"properties": {
- "connections": {
- "description": "The list of people that the requestor is connected to.",
+ "responses": {
+ "description": "The response for each requested resource name.",
"items": {
- "$ref": "Person"
+ "$ref": "PersonResponse"
},
"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"
}
},
"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