mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
372 lines
15 KiB
HTML
372 lines
15 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-doubleclicksearch2-cli/reports_request/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Request - Doubleclicksearch v5.0.4+20240227</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 = "Request";
|
|
var mkdocs_page_input_path = "reports_request.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-doubleclicksearch2-cli/reports_request/";
|
|
</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"> Doubleclicksearch v5.0.4+20240227
|
|
</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">Conversion</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../conversion_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../conversion_get-by-customer-id/">Get By Customer Id</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../conversion_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../conversion_update/">Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../conversion_update-availability/">Update Availability</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Reports</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../reports_generate/">Generate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../reports_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../reports_get-file/">Get File</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../reports_get-id-mapping-file/">Get Id Mapping File</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Request</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Saved Columns</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../saved-columns_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="..">Doubleclicksearch v5.0.4+20240227</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>Request</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/doubleclicksearch2-cli/edit/master/docs/reports_request.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>Inserts a report request into the reporting system.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/doubleclicksearch</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/doubleclicksearch</em>.
|
|
You can set the scope for this method like this: <code>doubleclicksearch2 --scope <scope> reports request ...</code></p>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>ReportRequest:
|
|
download-format: string
|
|
include-deleted-entities: boolean
|
|
include-removed-entities: boolean
|
|
max-rows-per-file: integer
|
|
report-scope:
|
|
ad-group-id: string
|
|
ad-id: string
|
|
advertiser-id: string
|
|
agency-id: string
|
|
campaign-id: string
|
|
engine-account-id: string
|
|
keyword-id: string
|
|
report-type: string
|
|
row-count: integer
|
|
start-row: integer
|
|
statistics-currency: string
|
|
time-range:
|
|
changed-attributes-since-timestamp: string
|
|
changed-metrics-since-timestamp: string
|
|
end-date: string
|
|
start-date: string
|
|
verify-single-time-zone: boolean
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . download-format=ut</code><ul>
|
|
<li>Format that the report should be returned in. Currently <code>csv</code> or <code>tsv</code> is supported.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>include-deleted-entities=true</code><ul>
|
|
<li>Determines if removed entities should be included in the report. Defaults to <code>false</code>. Deprecated, please use <code>includeRemovedEntities</code> instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>include-removed-entities=true</code><ul>
|
|
<li>Determines if removed entities should be included in the report. Defaults to <code>false</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>max-rows-per-file=51</code><ul>
|
|
<li>Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are <code>1000000</code> to <code>100000000</code>, inclusive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>report-scope ad-group-id=est</code><ul>
|
|
<li>DS ad group ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ad-id=gubergren</code><ul>
|
|
<li>DS ad ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>advertiser-id=ea</code><ul>
|
|
<li>DS advertiser ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>agency-id=dolor</code><ul>
|
|
<li>DS agency ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>campaign-id=lorem</code><ul>
|
|
<li>DS campaign ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>engine-account-id=eos</code><ul>
|
|
<li>DS engine account ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>keyword-id=labore</code></p>
|
|
<ul>
|
|
<li>DS keyword ID.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. report-type=sed</code></p>
|
|
<ul>
|
|
<li>Determines the type of rows that are returned in the report. For example, if you specify <code>reportType: keyword</code>, each row in the report will contain data about a keyword. See the <a href="/search-ads/v2/report-types/">Types of Reports</a> reference for the columns that are available for each type.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>row-count=31</code><ul>
|
|
<li>Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are <code>0</code> to <code>10000</code>, inclusive. Defaults to <code>10000</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-row=21</code><ul>
|
|
<li>Synchronous report only. Zero-based index of the first row to return. Acceptable values are <code>0</code> to <code>50000</code>, inclusive. Defaults to <code>0</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>statistics-currency=no</code><ul>
|
|
<li>Specifies the currency in which monetary will be returned. Possible values are: <code>usd</code>, <code>agency</code> (valid if the report is scoped to agency or lower), <code>advertiser</code> (valid if the report is scoped to * advertiser or lower), or <code>account</code> (valid if the report is scoped to engine account or lower).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>time-range changed-attributes-since-timestamp=stet</code><ul>
|
|
<li>Inclusive UTC timestamp in RFC format, e.g., <code>2013-07-16T10:16:23.555Z</code>. See additional references on how changed attribute reports work.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>changed-metrics-since-timestamp=kasd</code><ul>
|
|
<li>Inclusive UTC timestamp in RFC format, e.g., <code>2013-07-16T10:16:23.555Z</code>. See additional references on how changed metrics reports work.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-date=et</code><ul>
|
|
<li>Inclusive date in YYYY-MM-DD format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-date=sed</code></p>
|
|
<ul>
|
|
<li>Inclusive date in YYYY-MM-DD format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. verify-single-time-zone=true</code></p>
|
|
<ul>
|
|
<li>If <code>true</code>, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to <code>false</code>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</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-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="../reports_get-id-mapping-file/" class="btn btn-neutral float-left" title="Get Id Mapping File"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../saved-columns_list/" class="btn btn-neutral float-right" title="List">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/doubleclicksearch2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../reports_get-id-mapping-file/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../saved-columns_list/" 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>
|