mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
375 lines
10 KiB
HTML
375 lines
10 KiB
HTML
<!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>List - gan v2.0.0+20130205</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"> gan v2.0.0+20130205</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Advertisers</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../advertisers_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../advertisers_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Cc Offers</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../cc-offers_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Events</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../events_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Links</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../links_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../links_insert">Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">List</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</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>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Publishers</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../publishers_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../publishers_list">List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Reports</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../reports_get">Get</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</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> »</li>
|
|
<li>List</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/gan1_beta1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Retrieves all links that match the query parameters.</p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><role></strong> <em>(string)</em><ul>
|
|
<li>The role of the requester. Valid values: 'advertisers' or 'publishers'.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><role-id></strong> <em>(string)</em><ul>
|
|
<li>The ID of the requesting advertiser or publisher.</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 advertiser-id=string</strong></p>
|
|
<ul>
|
|
<li>Limits the resulting links to the ones belonging to the listed advertisers.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p asset-size=string</strong></p>
|
|
<ul>
|
|
<li>The size of the given asset.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p authorship=string</strong></p>
|
|
<ul>
|
|
<li>The role of the author of the link.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p create-date-max=string</strong></p>
|
|
<ul>
|
|
<li>The end of the create date range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p create-date-min=string</strong></p>
|
|
<ul>
|
|
<li>The beginning of the create date range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p link-type=string</strong></p>
|
|
<ul>
|
|
<li>The type of the link.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p max-results=integer</strong></p>
|
|
<ul>
|
|
<li>Max number of items to return in this page. Optional. Defaults to 20.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-token=string</strong></p>
|
|
<ul>
|
|
<li>The value of 'nextPageToken' from the previous page. Optional.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p promotion-type=string</strong></p>
|
|
<ul>
|
|
<li>The promotion type.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p relationship-status=string</strong></p>
|
|
<ul>
|
|
<li>The status of the relationship.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p search-text=string</strong></p>
|
|
<ul>
|
|
<li>Field for full text search across title and merchandising text, supports link id search.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p start-date-max=string</strong></p>
|
|
<ul>
|
|
<li>The end of the start date range.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p start-date-min=string</strong></p>
|
|
<ul>
|
|
<li>The beginning of the start date range.</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>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. Overrides userIp if both are provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p user-ip=string</strong></p>
|
|
<ul>
|
|
<li>IP address of the site where the request originates. Use this if you want to enforce per-user limits.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../publishers_get" class="btn btn-neutral float-right" title="Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../links_insert" class="btn btn-neutral" title="Insert"><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="../links_insert" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../publishers_get" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |