Class PeopleResource.GetBatchGetRequest

Provides information about a list of specific people by specifying a list of requested resource names. 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<GetPeopleResponse>

PeopleServiceBaseServiceRequest<GetPeopleResponse>

PeopleResource.GetBatchGetRequest

Implements

Google.Apis.Requests.IClientServiceRequest<GetPeopleResponse>

Google.Apis.Requests.IClientServiceRequest

Inherited Members

PeopleServiceBaseServiceRequest<GetPeopleResponse>.Xgafv

PeopleServiceBaseServiceRequest<GetPeopleResponse>.AccessToken

PeopleServiceBaseServiceRequest<GetPeopleResponse>.Alt

PeopleServiceBaseServiceRequest<GetPeopleResponse>.Callback

PeopleServiceBaseServiceRequest<GetPeopleResponse>.Fields

PeopleServiceBaseServiceRequest<GetPeopleResponse>.Key

PeopleServiceBaseServiceRequest<GetPeopleResponse>.OauthToken

PeopleServiceBaseServiceRequest<GetPeopleResponse>.PrettyPrint

PeopleServiceBaseServiceRequest<GetPeopleResponse>.QuotaUser

PeopleServiceBaseServiceRequest<GetPeopleResponse>.UploadType

PeopleServiceBaseServiceRequest<GetPeopleResponse>.UploadProtocol

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.Execute()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.ExecuteAsStream()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.ExecuteAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.ExecuteAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.ExecuteAsStreamAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.CreateRequest(System.Nullable<System.Boolean>)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.GenerateRequestUri()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.GetBody()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.GetDefaultETagAction(System.String)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.ETagAction

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.ModifyRequest

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.RequestParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.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 GetBatchGetRequest : PeopleServiceBaseServiceRequest<GetPeopleResponse>, IClientServiceRequest<GetPeopleResponse>, IClientServiceRequest

Constructors

GetBatchGetRequest(IClientService)

Constructs a new GetBatchGet request.

Declaration

public GetBatchGetRequest(IClientService service)

Parameters

Type	Name	Description
Google.Apis.Services.IClientService	service

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.GetPeopleResponse>.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.GetPeopleResponse>.MethodName

PersonFields

Required. A field mask to restrict which fields on each 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

ResourceNames

Required. The resource names of the people 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.

You can include up to 50 resource names in one request.

Declaration

[RequestParameter("resourceNames", RequestParameterType.Query)]
public virtual Repeatable<string> ResourceNames { get; set; }

Property Value

Type	Description
Google.Apis.Util.Repeatable<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.GetPeopleResponse>.RestPath

Methods

InitParameters()

Initializes GetBatchGet parameter list.

Declaration

protected override void InitParameters()

Overrides

Google.Apis.PeopleService.v1.PeopleServiceBaseServiceRequest<Google.Apis.PeopleService.v1.Data.GetPeopleResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>

Google.Apis.Requests.IClientServiceRequest