Network.Google.Resource.AdSense.Accounts.Reports.Generate

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 Management API Reference for adsense.accounts.reports.generate.

REST Resource

type AccountsReportsGenerateResource = ("adsense" :> ("v1.4" :> ("accounts" :> (Capture "accountId" Text :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "metric" Text :> (QueryParam "currency" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Int32) :> (QueryParam "useTimezoneReporting" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdsenseReportsGenerateResponse))))))))))))))))) :<|> ("adsense" :> ("v1.4" :> ("accounts" :> (Capture "accountId" Text :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "metric" Text :> (QueryParam "currency" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Int32) :> (QueryParam "useTimezoneReporting" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream)))))))))))))))))

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

Creating a Request

accountsReportsGenerate

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:

• argDimension
• argLocale
• argEndDate
• argStartDate
• argAccountId
• argMetric
• argCurrency
• argSort
• argFilter
• argStartIndex
• argUseTimezoneReporting
• argMaxResults

data AccountsReportsGenerate

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

Methods

(==) :: AccountsReportsGenerate -> AccountsReportsGenerate -> Bool

(/=) :: AccountsReportsGenerate -> AccountsReportsGenerate -> Bool

Data AccountsReportsGenerate

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

Methods

showsPrec :: Int -> AccountsReportsGenerate -> ShowS

show :: AccountsReportsGenerate -> String

showList :: [AccountsReportsGenerate] -> ShowS

Generic AccountsReportsGenerate

Associated Types

type Rep AccountsReportsGenerate :: * -> *

Methods

from :: AccountsReportsGenerate -> Rep AccountsReportsGenerate x

to :: Rep AccountsReportsGenerate x -> AccountsReportsGenerate

GoogleRequest AccountsReportsGenerate

Associated Types

type Rs AccountsReportsGenerate :: *

type Scopes AccountsReportsGenerate :: [Symbol]

Methods

requestClient :: AccountsReportsGenerate -> Client (Rs AccountsReportsGenerate)

GoogleRequest (MediaDownload AccountsReportsGenerate)

Associated Types

type Rs (MediaDownload AccountsReportsGenerate) :: *

type Scopes (MediaDownload AccountsReportsGenerate) :: [Symbol]

Methods

requestClient :: MediaDownload AccountsReportsGenerate -> Client (Rs (MediaDownload AccountsReportsGenerate))

type Rep AccountsReportsGenerate

type Rep AccountsReportsGenerate = D1 (MetaData "AccountsReportsGenerate" "Network.Google.Resource.AdSense.Accounts.Reports.Generate" "gogol-adsense-0.2.0-60rIPXaPTef3Ly7deoiW4q" False) (C1 (MetaCons "AccountsReportsGenerate'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_argDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_argLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_argEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_argStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_argAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_argMetric") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_argCurrency") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_argSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_argFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) (S1 (MetaSel (Just Symbol "_argStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) ((:*:) (S1 (MetaSel (Just Symbol "_argUseTimezoneReporting") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_argMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))))

type Scopes AccountsReportsGenerate

type Scopes AccountsReportsGenerate = (:) Symbol "https://www.googleapis.com/auth/adsense" ((:) Symbol "https://www.googleapis.com/auth/adsense.readonly" ([] Symbol))

type Rs AccountsReportsGenerate

type Rs AccountsReportsGenerate = AdsenseReportsGenerateResponse

type Scopes (MediaDownload AccountsReportsGenerate)

type Scopes (MediaDownload AccountsReportsGenerate) = Scopes AccountsReportsGenerate

type Rs (MediaDownload AccountsReportsGenerate)

type Rs (MediaDownload AccountsReportsGenerate) = Stream

Request Lenses

argDimension :: Lens' AccountsReportsGenerate [Text]

Dimensions to base the report on.

argLocale :: Lens' AccountsReportsGenerate (Maybe Text)

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

argEndDate :: Lens' AccountsReportsGenerate Text

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

argStartDate :: Lens' AccountsReportsGenerate Text

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

argAccountId :: Lens' AccountsReportsGenerate Text

Account upon which to report.

argMetric :: Lens' AccountsReportsGenerate [Text]

Numeric columns to include in the report.

argCurrency :: Lens' AccountsReportsGenerate (Maybe Text)

Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

argSort :: Lens' AccountsReportsGenerate [Text]

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.

argFilter :: Lens' AccountsReportsGenerate [Text]

Filters to be run on the report.

argStartIndex :: Lens' AccountsReportsGenerate (Maybe Int32)

Index of the first row of report data to return.

argUseTimezoneReporting :: Lens' AccountsReportsGenerate (Maybe Bool)

Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

argMaxResults :: Lens' AccountsReportsGenerate (Maybe Int32)

The maximum number of rows of report data to return.