package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Saved : sig ... end
val generate : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_download:GapiMediaResource.download -> ?currency:string -> ?dimension:string list -> ?filter:string list -> ?locale:string -> ?maxResults:int -> ?metric:string list -> ?sort:string list -> ?startIndex:int -> ?useTimezoneReporting:bool -> accountId:string -> startDate:string -> endDate:string -> GapiConversation.Session.t -> GapiAdsenseV1_4Model.AdsenseReportsGenerateResponse.t * GapiConversation.Session.t

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.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/adsense/v1.4/").

  • parameter std_params

    Optional standard parameters.

  • parameter currency

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

  • parameter dimension

    Dimensions to base the report on.

  • parameter filter

    Filters to be run on the report.

  • parameter locale

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

  • parameter maxResults

    The maximum number of rows of report data to return.

  • parameter metric

    Numeric columns to include in the report.

  • parameter sort

    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.

  • parameter startIndex

    Index of the first row of report data to return.

  • parameter useTimezoneReporting

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

  • parameter accountId

    Account upon which to report.

  • parameter startDate

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

  • parameter endDate

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