Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.People.People.GetBatchGet

Contents

REST Resource
Creating a Request
Request Lenses

Description

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.

See: People API Reference for people.people.getBatchGet.

Synopsis

type PeopleGetBatchGetResource = "v1" :> ("people:batchGet" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "requestMask.includeField" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "personFields" GFieldMask :> (QueryParams "resourceNames" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GetPeopleResponse))))))))))
peopleGetBatchGet :: PeopleGetBatchGet
data PeopleGetBatchGet
pgbgXgafv :: Lens' PeopleGetBatchGet (Maybe Xgafv)
pgbgUploadProtocol :: Lens' PeopleGetBatchGet (Maybe Text)
pgbgRequestMaskIncludeField :: Lens' PeopleGetBatchGet (Maybe GFieldMask)
pgbgAccessToken :: Lens' PeopleGetBatchGet (Maybe Text)
pgbgUploadType :: Lens' PeopleGetBatchGet (Maybe Text)
pgbgPersonFields :: Lens' PeopleGetBatchGet (Maybe GFieldMask)
pgbgResourceNames :: Lens' PeopleGetBatchGet [Text]
pgbgCallback :: Lens' PeopleGetBatchGet (Maybe Text)

REST Resource

type PeopleGetBatchGetResource = "v1" :> ("people:batchGet" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "requestMask.includeField" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "personFields" GFieldMask :> (QueryParams "resourceNames" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GetPeopleResponse)))))))))) Source #

A resource alias for people.people.getBatchGet method which the PeopleGetBatchGet request conforms to.

Creating a Request

peopleGetBatchGet :: PeopleGetBatchGet Source #

Creates a value of PeopleGetBatchGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data PeopleGetBatchGet Source #

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.

See: peopleGetBatchGet smart constructor.

Instances

Eq PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet Methods (==) :: PeopleGetBatchGet -> PeopleGetBatchGet -> Bool # (/=) :: PeopleGetBatchGet -> PeopleGetBatchGet -> Bool #
Data PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PeopleGetBatchGet -> c PeopleGetBatchGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PeopleGetBatchGet # toConstr :: PeopleGetBatchGet -> Constr # dataTypeOf :: PeopleGetBatchGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PeopleGetBatchGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PeopleGetBatchGet) # gmapT :: (forall b. Data b => b -> b) -> PeopleGetBatchGet -> PeopleGetBatchGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PeopleGetBatchGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PeopleGetBatchGet -> r # gmapQ :: (forall d. Data d => d -> u) -> PeopleGetBatchGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PeopleGetBatchGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PeopleGetBatchGet -> m PeopleGetBatchGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleGetBatchGet -> m PeopleGetBatchGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleGetBatchGet -> m PeopleGetBatchGet #
Show PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet Methods showsPrec :: Int -> PeopleGetBatchGet -> ShowS # show :: PeopleGetBatchGet -> String # showList :: [PeopleGetBatchGet] -> ShowS #
Generic PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet Associated Types type Rep PeopleGetBatchGet :: Type -> Type # Methods from :: PeopleGetBatchGet -> Rep PeopleGetBatchGet x # to :: Rep PeopleGetBatchGet x -> PeopleGetBatchGet #
GoogleRequest PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet Associated Types type Rs PeopleGetBatchGet :: Type # type Scopes PeopleGetBatchGet :: [Symbol] # Methods requestClient :: PeopleGetBatchGet -> GClient (Rs PeopleGetBatchGet) #
type Rep PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet type Rep PeopleGetBatchGet = D1 (MetaData "PeopleGetBatchGet" "Network.Google.Resource.People.People.GetBatchGet" "gogol-people-0.4.0-E13x4gVqkHzANg1IJZFmJ4" False) (C1 (MetaCons "PeopleGetBatchGet'" PrefixI True) (((S1 (MetaSel (Just "_pgbgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_pgbgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pgbgRequestMaskIncludeField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :: S1 (MetaSel (Just "_pgbgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pgbgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pgbgPersonFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask))) :: (S1 (MetaSel (Just "_pgbgResourceNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_pgbgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet type Scopes PeopleGetBatchGet = "https://www.googleapis.com/auth/contacts" ': ("https://www.googleapis.com/auth/contacts.readonly" ': ("https://www.googleapis.com/auth/plus.login" ': ("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.phonenumbers.read" ': ("https://www.googleapis.com/auth/userinfo.email" ': ("https://www.googleapis.com/auth/userinfo.profile" ': ([] :: [Symbol])))))))))
type Rs PeopleGetBatchGet Source #
Instance details Defined in Network.Google.Resource.People.People.GetBatchGet type Rs PeopleGetBatchGet = GetPeopleResponse

Request Lenses

pgbgXgafv :: Lens' PeopleGetBatchGet (Maybe Xgafv) Source #

V1 error format.

pgbgUploadProtocol :: Lens' PeopleGetBatchGet (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

pgbgRequestMaskIncludeField :: Lens' PeopleGetBatchGet (Maybe GFieldMask) Source #

*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`.

pgbgAccessToken :: Lens' PeopleGetBatchGet (Maybe Text) Source #

OAuth access token.

pgbgUploadType :: Lens' PeopleGetBatchGet (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

pgbgPersonFields :: Lens' PeopleGetBatchGet (Maybe GFieldMask) Source #

*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

pgbgResourceNames :: Lens' PeopleGetBatchGet [Text] Source #

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.

pgbgCallback :: Lens' PeopleGetBatchGet (Maybe Text) Source #

JSONP