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