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.Partners.Users.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Gets a user.

See: Google Partners API Reference for partners.users.get.

Synopsis

type UsersGetResource = "v2" :> ("users" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "userView" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] User))))))))))))))))
usersGet :: Text -> UsersGet
data UsersGet
ugXgafv :: Lens' UsersGet (Maybe Xgafv)
ugUploadProtocol :: Lens' UsersGet (Maybe Text)
ugAccessToken :: Lens' UsersGet (Maybe Text)
ugUploadType :: Lens' UsersGet (Maybe Text)
ugUserId :: Lens' UsersGet Text
ugRequestMetadataPartnersSessionId :: Lens' UsersGet (Maybe Text)
ugUserView :: Lens' UsersGet (Maybe Text)
ugRequestMetadataLocale :: Lens' UsersGet (Maybe Text)
ugRequestMetadataExperimentIds :: Lens' UsersGet [Text]
ugRequestMetadataUserOverridesIPAddress :: Lens' UsersGet (Maybe Text)
ugRequestMetadataTrafficSourceTrafficSubId :: Lens' UsersGet (Maybe Text)
ugRequestMetadataUserOverridesUserId :: Lens' UsersGet (Maybe Text)
ugRequestMetadataTrafficSourceTrafficSourceId :: Lens' UsersGet (Maybe Text)
ugCallback :: Lens' UsersGet (Maybe Text)

REST Resource

type UsersGetResource = "v2" :> ("users" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "userView" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] User)))))))))))))))) Source #

A resource alias for partners.users.get method which the UsersGet request conforms to.

Creating a Request

usersGet Source #

Arguments

:: Text	`ugUserId`
-> UsersGet

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

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

data UsersGet Source #

Gets a user.

See: usersGet smart constructor.

Instances

Eq UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get Methods (==) :: UsersGet -> UsersGet -> Bool # (/=) :: UsersGet -> UsersGet -> Bool #
Data UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsersGet -> c UsersGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsersGet # toConstr :: UsersGet -> Constr # dataTypeOf :: UsersGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UsersGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsersGet) # gmapT :: (forall b. Data b => b -> b) -> UsersGet -> UsersGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsersGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsersGet -> r # gmapQ :: (forall d. Data d => d -> u) -> UsersGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UsersGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsersGet -> m UsersGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersGet -> m UsersGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersGet -> m UsersGet #
Show UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get Methods showsPrec :: Int -> UsersGet -> ShowS # show :: UsersGet -> String # showList :: [UsersGet] -> ShowS #
Generic UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get Associated Types type Rep UsersGet :: Type -> Type # Methods from :: UsersGet -> Rep UsersGet x # to :: Rep UsersGet x -> UsersGet #
GoogleRequest UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get Associated Types type Rs UsersGet :: Type # type Scopes UsersGet :: [Symbol] # Methods requestClient :: UsersGet -> GClient (Rs UsersGet) #
type Rep UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get type Rep UsersGet = D1 (MetaData "UsersGet" "Network.Google.Resource.Partners.Users.Get" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "UsersGet'" PrefixI True) (((S1 (MetaSel (Just "_ugXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_ugUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ugAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ugUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ugUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_ugRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ugUserView") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 (MetaSel (Just "_ugRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_ugRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_ugRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ugRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ugRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ugRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ugCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get type Scopes UsersGet = ([] :: [Symbol])
type Rs UsersGet Source #
Instance details Defined in Network.Google.Resource.Partners.Users.Get type Rs UsersGet = User

Request Lenses

ugXgafv :: Lens' UsersGet (Maybe Xgafv) Source #

V1 error format.

ugUploadProtocol :: Lens' UsersGet (Maybe Text) Source #

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

ugAccessToken :: Lens' UsersGet (Maybe Text) Source #

OAuth access token.

ugUploadType :: Lens' UsersGet (Maybe Text) Source #

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

ugUserId :: Lens' UsersGet Text Source #

Identifier of the user. Can be set to me to mean the currently authenticated user.

ugRequestMetadataPartnersSessionId :: Lens' UsersGet (Maybe Text) Source #

Google Partners session ID.

ugUserView :: Lens' UsersGet (Maybe Text) Source #

Specifies what parts of the user information to return.

ugRequestMetadataLocale :: Lens' UsersGet (Maybe Text) Source #

Locale to use for the current request.

ugRequestMetadataExperimentIds :: Lens' UsersGet [Text] Source #

Experiment IDs the current request belongs to.

ugRequestMetadataUserOverridesIPAddress :: Lens' UsersGet (Maybe Text) Source #

IP address to use instead of the user's geo-located IP address.

ugRequestMetadataTrafficSourceTrafficSubId :: Lens' UsersGet (Maybe Text) Source #

Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

ugRequestMetadataUserOverridesUserId :: Lens' UsersGet (Maybe Text) Source #

Logged-in user ID to impersonate instead of the user's ID.

ugRequestMetadataTrafficSourceTrafficSourceId :: Lens' UsersGet (Maybe Text) Source #

Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

ugCallback :: Lens' UsersGet (Maybe Text) Source #

JSONP