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.AdSenseHost.Accounts.Reports.Generate

Contents

REST Resource
Creating a Request
Request Lenses

Description

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

See: AdSense Host API Reference for adsensehost.accounts.reports.generate.

Synopsis

type AccountsReportsGenerateResource = "adsensehost" :> ("v4.1" :> ("accounts" :> (Capture "accountId" Text :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "metric" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Report))))))))))))))
accountsReportsGenerate :: Text -> Text -> Text -> AccountsReportsGenerate
data AccountsReportsGenerate
argDimension :: Lens' AccountsReportsGenerate [Text]
argLocale :: Lens' AccountsReportsGenerate (Maybe Text)
argEndDate :: Lens' AccountsReportsGenerate Text
argStartDate :: Lens' AccountsReportsGenerate Text
argAccountId :: Lens' AccountsReportsGenerate Text
argMetric :: Lens' AccountsReportsGenerate [Text]
argSort :: Lens' AccountsReportsGenerate [Text]
argFilter :: Lens' AccountsReportsGenerate [Text]
argStartIndex :: Lens' AccountsReportsGenerate (Maybe Word32)
argMaxResults :: Lens' AccountsReportsGenerate (Maybe Word32)

REST Resource

type AccountsReportsGenerateResource = "adsensehost" :> ("v4.1" :> ("accounts" :> (Capture "accountId" Text :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "metric" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Report)))))))))))))) Source #

A resource alias for adsensehost.accounts.reports.generate method which the AccountsReportsGenerate request conforms to.

Creating a Request

accountsReportsGenerate Source #

Arguments

:: Text	`argEndDate`
-> Text	`argStartDate`
-> Text	`argAccountId`
-> AccountsReportsGenerate

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

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

data AccountsReportsGenerate Source #

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

See: accountsReportsGenerate smart constructor.

Instances

Eq AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate Methods (==) :: AccountsReportsGenerate -> AccountsReportsGenerate -> Bool # (/=) :: AccountsReportsGenerate -> AccountsReportsGenerate -> Bool #
Data AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AccountsReportsGenerate -> c AccountsReportsGenerate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AccountsReportsGenerate # toConstr :: AccountsReportsGenerate -> Constr # dataTypeOf :: AccountsReportsGenerate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AccountsReportsGenerate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AccountsReportsGenerate) # gmapT :: (forall b. Data b => b -> b) -> AccountsReportsGenerate -> AccountsReportsGenerate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AccountsReportsGenerate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AccountsReportsGenerate -> r # gmapQ :: (forall d. Data d => d -> u) -> AccountsReportsGenerate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AccountsReportsGenerate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AccountsReportsGenerate -> m AccountsReportsGenerate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountsReportsGenerate -> m AccountsReportsGenerate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountsReportsGenerate -> m AccountsReportsGenerate #
Show AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate Methods showsPrec :: Int -> AccountsReportsGenerate -> ShowS # show :: AccountsReportsGenerate -> String # showList :: [AccountsReportsGenerate] -> ShowS #
Generic AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate Associated Types type Rep AccountsReportsGenerate :: Type -> Type # Methods from :: AccountsReportsGenerate -> Rep AccountsReportsGenerate x # to :: Rep AccountsReportsGenerate x -> AccountsReportsGenerate #
GoogleRequest AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate Associated Types type Rs AccountsReportsGenerate :: Type # type Scopes AccountsReportsGenerate :: [Symbol] # Methods requestClient :: AccountsReportsGenerate -> GClient (Rs AccountsReportsGenerate) #
type Rep AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate type Rep AccountsReportsGenerate = D1 (MetaData "AccountsReportsGenerate" "Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate" "gogol-adsense-host-0.4.0-9ZqQWUle4m2HKOQnxH9pTD" False) (C1 (MetaCons "AccountsReportsGenerate'" PrefixI True) (((S1 (MetaSel (Just "_argDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_argLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_argEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_argStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_argAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :: ((S1 (MetaSel (Just "_argMetric") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_argSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 (MetaSel (Just "_argFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 (MetaSel (Just "_argStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: S1 (MetaSel (Just "_argMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))))))))
type Scopes AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate type Scopes AccountsReportsGenerate = "https://www.googleapis.com/auth/adsensehost" ': ([] :: [Symbol])
type Rs AccountsReportsGenerate Source #
Instance details Defined in Network.Google.Resource.AdSenseHost.Accounts.Reports.Generate type Rs AccountsReportsGenerate = Report

Request Lenses

argDimension :: Lens' AccountsReportsGenerate [Text] Source #

Dimensions to base the report on.

argLocale :: Lens' AccountsReportsGenerate (Maybe Text) Source #

Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

argEndDate :: Lens' AccountsReportsGenerate Text Source #

End of the date range to report on in "YYYY-MM-DD" format, inclusive.

argStartDate :: Lens' AccountsReportsGenerate Text Source #

Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

argAccountId :: Lens' AccountsReportsGenerate Text Source #

Hosted account upon which to report.

argMetric :: Lens' AccountsReportsGenerate [Text] Source #

Numeric columns to include in the report.

argSort :: Lens' AccountsReportsGenerate [Text] Source #

The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.