mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 20:30:52 +01:00
318 lines
13 KiB
HTML
318 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-adsensehost4d1-cli/reports_generate/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Generate - AdSense Host v5.0.4+20200930</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Generate";
|
|
var mkdocs_page_input_path = "reports_generate.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-adsensehost4d1-cli/reports_generate/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> AdSense Host v5.0.4+20200930
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Accounts</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-get/">Adclients Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-list/">Adclients List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adunits-delete/">Adunits Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adunits-get/">Adunits Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adunits-get-ad-code/">Adunits Get Ad Code</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adunits-insert/">Adunits Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adunits-list/">Adunits List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adunits-patch/">Adunits Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adunits-update/">Adunits Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-generate/">Reports Generate</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Adclients</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../adclients_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../adclients_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Associationsessions</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../associationsessions_start/">Start</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../associationsessions_verify/">Verify</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Customchannels</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customchannels_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customchannels_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customchannels_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customchannels_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customchannels_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../customchannels_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Reports</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Generate</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Urlchannels</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../urlchannels_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../urlchannels_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../urlchannels_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">AdSense Host v5.0.4+20200930</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Reports »</li>
|
|
<li>Generate</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/adsensehost4d1-cli/edit/master/docs/reports_generate.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>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>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/adsensehost</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/adsensehost</em>.
|
|
You can set the scope for this method like this: <code>adsensehost4d1 --scope <scope> reports generate ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><start-date></strong> <em>(string)</em><ul>
|
|
<li>Start of the date range to report on in "YYYY-MM-DD" format, inclusive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><end-date></strong> <em>(string)</em><ul>
|
|
<li>End of the date range to report on in "YYYY-MM-DD" format, inclusive.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p dimension=string</strong></p>
|
|
<ul>
|
|
<li>Dimensions to base the report on.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p filter=string</strong></p>
|
|
<ul>
|
|
<li>Filters to be run on the report.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p locale=string</strong></p>
|
|
<ul>
|
|
<li>Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p max-results=integer</strong></p>
|
|
<ul>
|
|
<li>The maximum number of rows of report data to return.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p metric=string</strong></p>
|
|
<ul>
|
|
<li>Numeric columns to include in the report.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p sort=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p start-index=integer</strong></p>
|
|
<ul>
|
|
<li>Index of the first row of report data to return.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for the response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p user-ip=string</strong></p>
|
|
<ul>
|
|
<li>Deprecated. Please use quotaUser instead.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../customchannels_update/" class="btn btn-neutral float-left" title="Update"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../urlchannels_delete/" class="btn btn-neutral float-right" title="Delete">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/adsensehost4d1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../customchannels_update/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../urlchannels_delete/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|