1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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="#generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p> 84 <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> 85 <p class="toc_element"> 86 <code><a href="#generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=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 <h3>Method Details</h3> 89 <div class="method"> 90 <code class="details" id="generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code> 91 <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. 92 93 Args: 94 startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 95 endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 96 locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. 97 metric: string, Numeric columns to include in the report. (repeated) 98 currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. 99 startIndex: integer, Index of the first row of report data to return. 100 accountId: string, Accounts upon which to report. (repeated) 101 useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. 102 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) 103 maxResults: integer, The maximum number of rows of report data to return. 104 filter: string, Filters to be run on the report. (repeated) 105 dimension: string, Dimensions to base the report on. (repeated) 106 107 Returns: 108 An object of the form: 109 110 { 111 "startDate": "A String", # The requested start date in yyyy-mm-dd format. 112 "kind": "adsense#report", # Kind this is, in this case adsense#report. 113 "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. 114 [ 115 "A String", 116 ], 117 ], 118 "endDate": "A String", # The requested end date in yyyy-mm-dd format. 119 "warnings": [ # Any warnings associated with generation of the report. 120 "A String", 121 ], 122 "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. 123 "A String", 124 ], 125 "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. 126 { 127 "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY. 128 "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY. 129 "name": "A String", # The name of the header. 130 }, 131 ], 132 "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. 133 "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. 134 "A String", 135 ], 136 }</pre> 137 </div> 138 139 <div class="method"> 140 <code class="details" id="generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code> 141 <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. 142 143 Args: 144 startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 145 endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 146 locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. 147 metric: string, Numeric columns to include in the report. (repeated) 148 currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. 149 startIndex: integer, Index of the first row of report data to return. 150 accountId: string, Accounts upon which to report. (repeated) 151 useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. 152 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) 153 maxResults: integer, The maximum number of rows of report data to return. 154 filter: string, Filters to be run on the report. (repeated) 155 dimension: string, Dimensions to base the report on. (repeated) 156 157 Returns: 158 The media object as a string. 159 160 </pre> 161 </div> 162 163 </body></html>
