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 |
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
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:
ugXgafv
ugUploadProtocol
ugAccessToken
ugUploadType
ugUserId
ugRequestMetadataPartnersSessionId
ugUserView
ugRequestMetadataLocale
ugRequestMetadataExperimentIds
ugRequestMetadataUserOverridesIPAddress
ugRequestMetadataTrafficSourceTrafficSubId
ugRequestMetadataUserOverridesUserId
ugRequestMetadataTrafficSourceTrafficSourceId
ugCallback
Gets a user.
See: usersGet
smart constructor.
Instances
Request Lenses
ugUploadProtocol :: Lens' UsersGet (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
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.