mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
385 lines
17 KiB
HTML
385 lines
17 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-adsense2-cli/accounts_reports-generate-csv/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Reports Generate Csv - adsense v5.0.4+20240305</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 = "Reports Generate Csv";
|
|
var mkdocs_page_input_path = "accounts_reports-generate-csv.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-adsense2-cli/accounts_reports-generate-csv/";
|
|
</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 v5.0.4+20240305
|
|
</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 class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-adunits-create/">Adclients Adunits Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-adunits-get/">Adclients Adunits Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-adunits-get-adcode/">Adclients Adunits Get Adcode</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-adunits-list/">Adclients Adunits List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-adunits-list-linked-custom-channels/">Adclients Adunits List Linked Custom Channels</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-adunits-patch/">Adclients Adunits Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-customchannels-create/">Adclients Customchannels Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-customchannels-delete/">Adclients Customchannels Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-customchannels-get/">Adclients Customchannels Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-customchannels-list/">Adclients Customchannels List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-customchannels-list-linked-ad-units/">Adclients Customchannels List Linked Ad Units</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-customchannels-patch/">Adclients Customchannels Patch</a>
|
|
</li>
|
|
<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-get-adcode/">Adclients Get Adcode</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_adclients-urlchannels-get/">Adclients Urlchannels Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_adclients-urlchannels-list/">Adclients Urlchannels List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_alerts-list/">Alerts List</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_get-ad-blocking-recovery-tag/">Get Ad Blocking Recovery Tag</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_list-child-accounts/">List Child Accounts</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_payments-list/">Payments List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-generate/">Reports Generate</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Reports Generate Csv</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-get-saved/">Reports Get Saved</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-saved-generate/">Reports Saved Generate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-saved-generate-csv/">Reports Saved Generate Csv</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-saved-list/">Reports Saved List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_sites-get/">Sites Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_sites-list/">Sites 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 v5.0.4+20240305</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>Accounts »</li>
|
|
<li>Reports Generate Csv</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/adsense2-cli/edit/master/docs/accounts_reports-generate-csv.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>Generates a csv formatted ad hoc 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 <scope> accounts reports-generate-csv ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><account></strong> <em>(string)</em><ul>
|
|
<li>Required. The account which owns the collection of reports. Format: accounts/{account}</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'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 dimensions=string</strong></p>
|
|
<ul>
|
|
<li>Dimensions to base the report on.</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'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 filters=string</strong></p>
|
|
<ul>
|
|
<li>A list of <a href="/adsense/management/reporting/filtering">filters</a> to apply to the report. All provided filters must match in order for the data to be included in the report.</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 ("en"). 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 limit=integer</strong></p>
|
|
<ul>
|
|
<li>The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for <code>Reports.GenerateReport</code> and 1,000,000 rows for <code>Reports.GenerateCsvReport</code>, which are also the maximum values permitted here. Report truncation can be identified (for <code>Reports.GenerateReport</code> only) by comparing the number of rows returned to the value returned in <code>total_matched_rows</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p metrics=string</strong></p>
|
|
<ul>
|
|
<li>Required. Reporting metrics.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p order-by=string</strong></p>
|
|
<ul>
|
|
<li>The name of a dimension or metric to sort the resulting report on, can be 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 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'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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../accounts_reports-generate/" class="btn btn-neutral float-left" title="Reports Generate"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../accounts_reports-get-saved/" class="btn btn-neutral float-right" title="Reports Get Saved">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/adsense2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../accounts_reports-generate/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../accounts_reports-get-saved/" 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>
|