Provides information about a person by specifying a resource name. Use people/me
to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.
Scopes
You will need authorization for at least one of the following scopes to make a valid call:
- https://www.googleapis.com/auth/contacts
- https://www.googleapis.com/auth/contacts.readonly
- https://www.googleapis.com/auth/directory.readonly
- https://www.googleapis.com/auth/user.addresses.read
- https://www.googleapis.com/auth/user.birthday.read
- https://www.googleapis.com/auth/user.emails.read
- https://www.googleapis.com/auth/user.gender.read
- https://www.googleapis.com/auth/user.organization.read
- https://www.googleapis.com/auth/user.phonenumbers.read
- https://www.googleapis.com/auth/userinfo.email
- https://www.googleapis.com/auth/userinfo.profile
If unset, the scope for this method defaults to https://www.googleapis.com/auth/contacts.readonly.
You can set the scope for this method like this: people1 --scope <scope> people get ...
Required Scalar Argument
- <resource-name> (string)
- Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify
people/me
. - To get information about a google account, specifypeople/{account_id}
. - To get information about a contact, specify the resource name that identifies the contact as returned bypeople.connections.list
.
- Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p person-fields=string
- Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
-
-p request-mask-include-field=string
- Required. Comma-separated list of person fields to be included in the response. Each path should start with
person.
: for example,person.names
orperson.photos
.
- Required. Comma-separated list of person fields to be included in the response. Each path should start with
-
-p sources=string
- Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- 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.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- 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.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").