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.Analytics.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists analytics data for a user's associated company. Should only be called within the context of an authorized logged in user.

See: Google Partners API Reference for partners.analytics.list.

Synopsis

type AnalyticsListResource = "v2" :> ("analytics" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "pageToken" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListAnalyticsResponse))))))))))))))))
analyticsList :: AnalyticsList
data AnalyticsList
alXgafv :: Lens' AnalyticsList (Maybe Xgafv)
alUploadProtocol :: Lens' AnalyticsList (Maybe Text)
alAccessToken :: Lens' AnalyticsList (Maybe Text)
alUploadType :: Lens' AnalyticsList (Maybe Text)
alRequestMetadataPartnersSessionId :: Lens' AnalyticsList (Maybe Text)
alRequestMetadataLocale :: Lens' AnalyticsList (Maybe Text)
alRequestMetadataExperimentIds :: Lens' AnalyticsList [Text]
alRequestMetadataUserOverridesIPAddress :: Lens' AnalyticsList (Maybe Text)
alPageToken :: Lens' AnalyticsList (Maybe Text)
alRequestMetadataTrafficSourceTrafficSubId :: Lens' AnalyticsList (Maybe Text)
alPageSize :: Lens' AnalyticsList (Maybe Int32)
alRequestMetadataUserOverridesUserId :: Lens' AnalyticsList (Maybe Text)
alRequestMetadataTrafficSourceTrafficSourceId :: Lens' AnalyticsList (Maybe Text)
alCallback :: Lens' AnalyticsList (Maybe Text)

REST Resource

type AnalyticsListResource = "v2" :> ("analytics" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "pageToken" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListAnalyticsResponse)))))))))))))))) Source #

A resource alias for partners.analytics.list method which the AnalyticsList request conforms to.

Creating a Request

analyticsList :: AnalyticsList Source #

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

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

data AnalyticsList Source #

Lists analytics data for a user's associated company. Should only be called within the context of an authorized logged in user.

See: analyticsList smart constructor.

Instances

Eq AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List Methods (==) :: AnalyticsList -> AnalyticsList -> Bool # (/=) :: AnalyticsList -> AnalyticsList -> Bool #
Data AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AnalyticsList -> c AnalyticsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AnalyticsList # toConstr :: AnalyticsList -> Constr # dataTypeOf :: AnalyticsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AnalyticsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AnalyticsList) # gmapT :: (forall b. Data b => b -> b) -> AnalyticsList -> AnalyticsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AnalyticsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AnalyticsList -> r # gmapQ :: (forall d. Data d => d -> u) -> AnalyticsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AnalyticsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AnalyticsList -> m AnalyticsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AnalyticsList -> m AnalyticsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AnalyticsList -> m AnalyticsList #
Show AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List Methods showsPrec :: Int -> AnalyticsList -> ShowS # show :: AnalyticsList -> String # showList :: [AnalyticsList] -> ShowS #
Generic AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List Associated Types type Rep AnalyticsList :: Type -> Type # Methods from :: AnalyticsList -> Rep AnalyticsList x # to :: Rep AnalyticsList x -> AnalyticsList #
GoogleRequest AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List Associated Types type Rs AnalyticsList :: Type # type Scopes AnalyticsList :: [Symbol] # Methods requestClient :: AnalyticsList -> GClient (Rs AnalyticsList) #
type Rep AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List type Rep AnalyticsList = D1 (MetaData "AnalyticsList" "Network.Google.Resource.Partners.Analytics.List" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "AnalyticsList'" PrefixI True) (((S1 (MetaSel (Just "_alXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_alUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_alAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_alUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_alRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_alRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_alRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 (MetaSel (Just "_alRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_alPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_alRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_alPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_alRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_alRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_alCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List type Scopes AnalyticsList = ([] :: [Symbol])
type Rs AnalyticsList Source #
Instance details Defined in Network.Google.Resource.Partners.Analytics.List type Rs AnalyticsList = ListAnalyticsResponse

Request Lenses

alXgafv :: Lens' AnalyticsList (Maybe Xgafv) Source #

V1 error format.

alUploadProtocol :: Lens' AnalyticsList (Maybe Text) Source #

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

alAccessToken :: Lens' AnalyticsList (Maybe Text) Source #

OAuth access token.

alUploadType :: Lens' AnalyticsList (Maybe Text) Source #

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

alRequestMetadataPartnersSessionId :: Lens' AnalyticsList (Maybe Text) Source #

Google Partners session ID.

alRequestMetadataLocale :: Lens' AnalyticsList (Maybe Text) Source #

Locale to use for the current request.

alRequestMetadataExperimentIds :: Lens' AnalyticsList [Text] Source #

Experiment IDs the current request belongs to.

alRequestMetadataUserOverridesIPAddress :: Lens' AnalyticsList (Maybe Text) Source #

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

alPageToken :: Lens' AnalyticsList (Maybe Text) Source #

A token identifying a page of results that the server returns. Typically, this is the value of `ListAnalyticsResponse.next_page_token` returned from the previous call to ListAnalytics. Will be a date string in `YYYY-MM-DD` format representing the end date of the date range of results to return. If unspecified or set to "", default value is the current date.

alRequestMetadataTrafficSourceTrafficSubId :: Lens' AnalyticsList (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.

alPageSize :: Lens' AnalyticsList (Maybe Int32) Source #

Requested page size. Server may return fewer analytics than requested. If unspecified or set to 0, default value is 30. Specifies the number of days in the date range when querying analytics. The `page_token` represents the end date of the date range and the start date is calculated using the `page_size` as the number of days BEFORE the end date. Must be a non-negative integer.

alRequestMetadataUserOverridesUserId :: Lens' AnalyticsList (Maybe Text) Source #

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

alRequestMetadataTrafficSourceTrafficSourceId :: Lens' AnalyticsList (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.

alCallback :: Lens' AnalyticsList (Maybe Text) Source #

JSONP