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="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.reports.html">reports</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="adexchangeseller_v1.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, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p> 84 <p class="firstline">Generate an Ad Exchange 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, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p> 87 <p class="firstline">Generate an Ad Exchange 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, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code> 91 <pre>Generate an Ad Exchange 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 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) 97 locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. 98 metric: string, Numeric columns to include in the report. (repeated) 99 maxResults: integer, The maximum number of rows of report data to return. 100 dimension: string, Dimensions to base the report on. (repeated) 101 startIndex: integer, Index of the first row of report data to return. 102 filter: string, Filters to be run on the report. (repeated) 103 104 Returns: 105 An object of the form: 106 107 { 108 "kind": "adexchangeseller#report", # Kind this is, in this case adexchangeseller#report. 109 "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. 110 [ 111 "A String", 112 ], 113 ], 114 "warnings": [ # Any warnings associated with generation of the report. 115 "A String", 116 ], 117 "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. 118 "A String", 119 ], 120 "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. 121 { 122 "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY. 123 "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY. 124 "name": "A String", # The name of the header. 125 }, 126 ], 127 "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. 128 "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. 129 "A String", 130 ], 131 }</pre> 132 </div> 133 134 <div class="method"> 135 <code class="details" id="generate_media">generate_media(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code> 136 <pre>Generate an Ad Exchange 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. 137 138 Args: 139 startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 140 endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) 141 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) 142 locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. 143 metric: string, Numeric columns to include in the report. (repeated) 144 maxResults: integer, The maximum number of rows of report data to return. 145 dimension: string, Dimensions to base the report on. (repeated) 146 startIndex: integer, Index of the first row of report data to return. 147 filter: string, Filters to be run on the report. (repeated) 148 149 Returns: 150 The media object as a string. 151 152 </pre> 153 </div> 154 155 </body></html>
