View Source GoogleApi.AdSenseHost.V41.Api.Reports (google_api_ad_sense_host v0.14.0)
API calls for all endpoints tagged Reports
.
Summary
Functions
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.
Functions
Link to this function
adsensehost_reports_generate(connection, start_date, end_date, optional_params \\ [], opts \\ [])
View Source@spec adsensehost_reports_generate( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSenseHost.V41.Model.Report.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AdSenseHost.V41.Connection.t
) - Connection to server -
start_date
(type:String.t
) - Start of the date range to report on in "YYYY-MM-DD" format, inclusive. -
end_date
(type:String.t
) - End of the date range to report on in "YYYY-MM-DD" format, inclusive. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:dimension
(type:list(String.t)
) - Dimensions to base the report on. -
:filter
(type:list(String.t)
) - Filters to be run on the report. -
:locale
(type:String.t
) - Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. -
:maxResults
(type:integer()
) - The maximum number of rows of report data to return. -
:metric
(type:list(String.t)
) - Numeric columns to include in the report. -
:sort
(type:list(String.t)
) - 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. -
:startIndex
(type:integer()
) - Index of the first row of report data to return.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSenseHost.V41.Model.Report{}}
on success -
{:error, info}
on failure