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 returns a 400 error if 'personFields' is not specified.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GetPeopleResponse>
PeopleServiceBaseServiceRequest<GetPeopleResponse>
PeopleResource.GetBatchGetRequest
Implements
Inherited Members
Namespace: Google.Apis.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class PeopleResource.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
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
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 * 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
Declaration
[RequestParameter("personFields", RequestParameterType.Query)]
public virtual object PersonFields { get; set; }
Property Value
Type Description
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
object

ResourceNames

Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=&lt;name1&gt;&amp;resourceNames=&lt;name2&gt;&amp;... - 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. There is a maximum of 200 resource names.

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

RestPath

Gets the REST path.

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

Sources

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual PeopleResource.GetBatchGetRequest.SourcesEnum? Sources { get; set; }
Property Value
Type Description
PeopleResource.GetBatchGetRequest.SourcesEnum?
Remarks

Use this property to set a single value for the parameter, or SourcesList to set multiple values. Do not set both properties.

SourcesList

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual Repeatable<PeopleResource.GetBatchGetRequest.SourcesEnum> SourcesList { get; set; }
Property Value
Type Description
Repeatable<PeopleResource.GetBatchGetRequest.SourcesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Sources.

Methods

InitParameters()

Initializes GetBatchGet parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements