OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_adsense2_cli/accounts_reports-saved-generate/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

418 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Reports Saved Generate - adsense v3.0.0+20220304</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> adsense v3.0.0+20220304</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Accounts</span>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-adunits-get">Adclients Adunits Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-adunits-get-adcode">Adclients Adunits Get Adcode</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-adunits-list">Adclients Adunits List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-adunits-list-linked-custom-channels">Adclients Adunits List Linked Custom Channels</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-customchannels-get">Adclients Customchannels Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-customchannels-list">Adclients Customchannels List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-customchannels-list-linked-ad-units">Adclients Customchannels List Linked Ad Units</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-get-adcode">Adclients Get Adcode</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-list">Adclients List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_adclients-urlchannels-list">Adclients Urlchannels List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_alerts-list">Alerts List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_list-child-accounts">List Child Accounts</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_payments-list">Payments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_reports-generate">Reports Generate</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_reports-generate-csv">Reports Generate Csv</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Reports Saved Generate</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_reports-saved-generate-csv">Reports Saved Generate Csv</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_reports-saved-list">Reports Saved List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_sites-get">Sites Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../accounts_sites-list">Sites List</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Reports Saved Generate</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/adsense2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Generates a saved report.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/adsense</em></li>
<li><em>https://www.googleapis.com/auth/adsense.readonly</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/adsense.readonly</em>.
You can set the scope for this method like this: <code>adsense2 --scope &lt;scope&gt; accounts reports-saved-generate ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Required. Name of the saved report. Format: accounts/{account}/reports/{report}</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 currency-code=string</strong></p>
<ul>
<li>The <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO-4217 currency code</a> to use when reporting on monetary metrics. Defaults to the account&#39;s currency if not set.</li>
</ul>
</li>
<li>
<p><strong>-p date-range=string</strong></p>
<ul>
<li>Date range of the report, if unset the range will be considered CUSTOM.</li>
</ul>
</li>
<li>
<p><strong>-p end-date-day=integer</strong></p>
<ul>
<li>Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#39;t significant.</li>
</ul>
</li>
<li>
<p><strong>-p end-date-month=integer</strong></p>
<ul>
<li>Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.</li>
</ul>
</li>
<li>
<p><strong>-p end-date-year=integer</strong></p>
<ul>
<li>Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.</li>
</ul>
</li>
<li>
<p><strong>-p language-code=string</strong></p>
<ul>
<li>The language to use for translating report output. If unspecified, this defaults to English (&#34;en&#34;). If the given language is not supported, report output will be returned in English. The language is specified as an <a href="https://en.wikipedia.org/wiki/IETF_language_tag">IETF BCP-47 language code</a>.</li>
</ul>
</li>
<li>
<p><strong>-p reporting-time-zone=string</strong></p>
<ul>
<li>Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see <a href="https://support.google.com/adsense/answer/9830725">changing the time zone of your reports</a>.</li>
</ul>
</li>
<li>
<p><strong>-p start-date-day=integer</strong></p>
<ul>
<li>Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#39;t significant.</li>
</ul>
</li>
<li>
<p><strong>-p start-date-month=integer</strong></p>
<ul>
<li>Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.</li>
</ul>
</li>
<li>
<p><strong>-p start-date-year=integer</strong></p>
<ul>
<li>Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.</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 $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</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>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../accounts_reports-saved-generate-csv" class="btn btn-neutral float-right" title="Reports Saved Generate Csv"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../accounts_reports-generate-csv" class="btn btn-neutral" title="Reports Generate Csv"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../accounts_reports-generate-csv" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../accounts_reports-saved-generate-csv" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink