Class PeopleResource.GetRequest

Provides information about a person by specifying a resource name. Use people/me to indicate the authenticated user.

The request throws a 400 error if 'personFields' is not specified.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<Person>
PeopleServiceBaseServiceRequest<Person>
PeopleResource.GetRequest
Implements
Google.Apis.Requests.IClientServiceRequest<Person>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class GetRequest : PeopleServiceBaseServiceRequest<Person>, IClientServiceRequest<Person>, IClientServiceRequest

Constructors

GetRequest(IClientService, String)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string resourceName)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
System.String resourceName

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.MethodName

PersonFields

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 * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
Declaration
[RequestParameter("personFields", RequestParameterType.Query)]
public virtual object PersonFields { get; set; }
Property Value
Type Description
System.Object

RequestMaskIncludeField

Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person.photos.

Declaration
[RequestParameter("requestMask.includeField", RequestParameterType.Query)]
public virtual object RequestMaskIncludeField { get; set; }
Property Value
Type Description
System.Object

ResourceName

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, specify people/{account_id}. - To get information about a contact, specify the resource name that identifies the contact as returned by people.connections.list.
Declaration
[RequestParameter("resourceName", RequestParameterType.Path)]
public virtual string ResourceName { get; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.RestPath

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.PeopleService.v1.PeopleServiceBaseServiceRequest<Google.Apis.PeopleService.v1.Data.Person>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest