mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
459 lines
20 KiB
HTML
459 lines
20 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-adexchangebuyer1d4-cli/proposals_patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Patch - Ad Exchange Buyer v5.0.4+20210330</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 = "Patch";
|
|
var mkdocs_page_input_path = "proposals_patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-adexchangebuyer1d4-cli/proposals_patch/";
|
|
</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"> Ad Exchange Buyer v5.0.4+20210330
|
|
</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_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_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Billing Info</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-info_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../billing-info_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Budget</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../budget_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../budget_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../budget_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Creatives</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../creatives_add-deal/">Add Deal</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../creatives_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../creatives_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../creatives_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../creatives_list-deals/">List Deals</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../creatives_remove-deal/">Remove Deal</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Marketplacedeals</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../marketplacedeals_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../marketplacedeals_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../marketplacedeals_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../marketplacedeals_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Marketplacenotes</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../marketplacenotes_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../marketplacenotes_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Marketplaceprivateauction</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../marketplaceprivateauction_updateproposal/">Updateproposal</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Performance Report</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../performance-report_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Pretargeting Config</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pretargeting-config_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pretargeting-config_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pretargeting-config_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pretargeting-config_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pretargeting-config_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pretargeting-config_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Products</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_search/">Search</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Proposals</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../proposals_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../proposals_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../proposals_search/">Search</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../proposals_setupcomplete/">Setupcomplete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../proposals_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Pubprofiles</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../pubprofiles_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="..">Ad Exchange Buyer v5.0.4+20210330</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>Proposals »</li>
|
|
<li>Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/adexchangebuyer1d4-cli/edit/master/docs/proposals_patch.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>Update the given proposal. This method supports patch semantics.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/adexchange.buyer</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/adexchange.buyer</em>.
|
|
You can set the scope for this method like this: <code>adexchangebuyer1d4 --scope <scope> proposals patch ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><proposal-id></strong> <em>(string)</em><ul>
|
|
<li>The proposal id to update.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><revision-number></strong> <em>(string)</em><ul>
|
|
<li>The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><update-action></strong> <em>(string)</em><ul>
|
|
<li>The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<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>Proposal:
|
|
billed-buyer:
|
|
account-id: string
|
|
buyer:
|
|
account-id: string
|
|
buyer-private-data:
|
|
reference-id: string
|
|
reference-payload: string
|
|
dbm-advertiser-ids: [string]
|
|
has-buyer-signed-off: boolean
|
|
has-seller-signed-off: boolean
|
|
inventory-source: string
|
|
is-renegotiating: boolean
|
|
is-setup-complete: boolean
|
|
kind: string
|
|
last-updater-or-commentor-role: string
|
|
name: string
|
|
negotiation-id: string
|
|
originator-role: string
|
|
private-auction-id: string
|
|
proposal-id: string
|
|
proposal-state: string
|
|
revision-number: string
|
|
revision-time-ms: string
|
|
seller:
|
|
account-id: string
|
|
sub-account-id: string
|
|
|
|
</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>
|
|
<p><code>-r .billed-buyer account-id=duo</code></p>
|
|
<ul>
|
|
<li>Adx account id of the buyer.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..buyer account-id=sit</code></p>
|
|
<ul>
|
|
<li>Adx account id of the buyer.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..buyer-private-data reference-id=magna</code></p>
|
|
<ul>
|
|
<li>No description provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>reference-payload=et</code></p>
|
|
<ul>
|
|
<li>No description provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. dbm-advertiser-ids=rebum.</code></p>
|
|
<ul>
|
|
<li>IDs of DBM advertisers permission to this proposal.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>has-buyer-signed-off=false</code><ul>
|
|
<li>When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>has-seller-signed-off=true</code><ul>
|
|
<li>When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>inventory-source=no</code><ul>
|
|
<li>What exchange will provide this inventory (readonly, except on create).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-renegotiating=false</code><ul>
|
|
<li>True if the proposal is being renegotiated (readonly).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-setup-complete=true</code><ul>
|
|
<li>True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=kasd</code><ul>
|
|
<li>Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-updater-or-commentor-role=lorem</code><ul>
|
|
<li>The role of the last user that either updated the proposal or left a comment. (readonly)</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=sanctus</code><ul>
|
|
<li>The name for the proposal (updatable)</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>negotiation-id=nonumy</code><ul>
|
|
<li>Optional negotiation id if this proposal is a preferred deal proposal.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>originator-role=rebum.</code><ul>
|
|
<li>Indicates whether the buyer/seller created the proposal.(readonly)</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>private-auction-id=tempor</code><ul>
|
|
<li>Optional private auction id if this proposal is a private auction proposal.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>proposal-id=dolore</code><ul>
|
|
<li>The unique id of the proposal. (readonly).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>proposal-state=eos</code><ul>
|
|
<li>The current state of the proposal. (readonly)</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>revision-number=amet.</code><ul>
|
|
<li>The revision number for the proposal (readonly).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>revision-time-ms=dolore</code><ul>
|
|
<li>The time (ms since epoch) when the proposal was last revised (readonly).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>seller account-id=amet</code><ul>
|
|
<li>The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sub-account-id=ut</code><ul>
|
|
<li>Optional sub-account id for the seller.</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 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="../proposals_insert/" class="btn btn-neutral float-left" title="Insert"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../proposals_search/" class="btn btn-neutral float-right" title="Search">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/adexchangebuyer1d4-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../proposals_insert/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../proposals_search/" 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>
|