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
ClientServiceRequest
ClientServiceRequest<GetPeopleResponse>
PeopleServiceBaseServiceRequest<GetPeopleResponse>
PeopleResource.GetBatchGetRequest
Inherited Members
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
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
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