1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="adsense_v1_4.html">AdSense Management API</a> . <a href="adsense_v1_4.reports.html">reports</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="adsense_v1_4.reports.saved.html">saved()</a></code> 79</p> 80<p class="firstline">Returns the saved Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#generate">generate(startDate, endDate, accountId=None, currency=None, dimension=None, filter=None, locale=None, maxResults=None, metric=None, sort=None, startIndex=None, useTimezoneReporting=None)</a></code></p> 87<p class="firstline">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.</p> 88<p class="toc_element"> 89 <code><a href="#generate_media">generate_media(startDate, endDate, accountId=None, currency=None, dimension=None, filter=None, locale=None, maxResults=None, metric=None, sort=None, startIndex=None, useTimezoneReporting=None)</a></code></p> 90<p class="firstline">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.</p> 91<h3>Method Details</h3> 92<div class="method"> 93 <code class="details" id="close">close()</code> 94 <pre>Close httplib2 connections.</pre> 95</div> 96 97<div class="method"> 98 <code class="details" id="generate">generate(startDate, endDate, accountId=None, currency=None, dimension=None, filter=None, locale=None, maxResults=None, metric=None, sort=None, startIndex=None, useTimezoneReporting=None)</code> 99 <pre>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. 100 101Args: 102 startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 103 endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 104 accountId: string, Accounts upon which to report. (repeated) 105 currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. 106 dimension: string, Dimensions to base the report on. (repeated) 107 filter: string, Filters to be run on the report. (repeated) 108 locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. 109 maxResults: integer, The maximum number of rows of report data to return. 110 metric: string, Numeric columns to include in the report. (repeated) 111 sort: string, 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. (repeated) 112 startIndex: integer, Index of the first row of report data to return. 113 useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. 114 115Returns: 116 An object of the form: 117 118 { 119 "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. 120 "A String", 121 ], 122 "endDate": "A String", # The requested end date in yyyy-mm-dd format. 123 "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. 124 { 125 "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY. 126 "name": "A String", # The name of the header. 127 "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY. 128 }, 129 ], 130 "kind": "adsense#report", # Kind this is, in this case adsense#report. 131 "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers. 132 [ 133 "A String", 134 ], 135 ], 136 "startDate": "A String", # The requested start date in yyyy-mm-dd format. 137 "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit. 138 "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. 139 "A String", 140 ], 141 "warnings": [ # Any warnings associated with generation of the report. 142 "A String", 143 ], 144}</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="generate_media">generate_media(startDate, endDate, accountId=None, currency=None, dimension=None, filter=None, locale=None, maxResults=None, metric=None, sort=None, startIndex=None, useTimezoneReporting=None)</code> 149 <pre>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. 150 151Args: 152 startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 153 endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 154 accountId: string, Accounts upon which to report. (repeated) 155 currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. 156 dimension: string, Dimensions to base the report on. (repeated) 157 filter: string, Filters to be run on the report. (repeated) 158 locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. 159 maxResults: integer, The maximum number of rows of report data to return. 160 metric: string, Numeric columns to include in the report. (repeated) 161 sort: string, 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. (repeated) 162 startIndex: integer, Index of the first row of report data to return. 163 useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. 164 165Returns: 166 The media object as a string. 167 168 </pre> 169</div> 170 171</body></html>