mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
461 lines
22 KiB
HTML
461 lines
22 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/pretargeting-config_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 = "pretargeting-config_patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-adexchangebuyer1d4-cli/pretargeting-config_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 class="current">
|
|
<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 current"><a class="reference internal current" href="./">Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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>
|
|
<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"><a class="reference internal" href="../proposals_patch/">Patch</a>
|
|
</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>Pretargeting Config »</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/pretargeting-config_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>Updates an existing pretargeting config. 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> pretargeting-config patch ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><account-id></strong> <em>(string)</em><ul>
|
|
<li>The account id to update the pretargeting config for.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><config-id></strong> <em>(string)</em><ul>
|
|
<li>The specific id of the configuration to update.</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>PretargetingConfig:
|
|
billing-id: string
|
|
config-id: string
|
|
config-name: string
|
|
creative-type: [string]
|
|
excluded-content-labels: [string]
|
|
excluded-geo-criteria-ids: [string]
|
|
excluded-user-lists: [string]
|
|
excluded-verticals: [string]
|
|
geo-criteria-ids: [string]
|
|
is-active: boolean
|
|
kind: string
|
|
languages: [string]
|
|
maximum-qps: string
|
|
minimum-viewability-decile: integer
|
|
mobile-carriers: [string]
|
|
mobile-devices: [string]
|
|
mobile-operating-system-versions: [string]
|
|
platforms: [string]
|
|
supported-creative-attributes: [string]
|
|
user-identifier-data-required: [string]
|
|
user-lists: [string]
|
|
vendor-types: [string]
|
|
verticals: [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><code>-r . billing-id=eos</code><ul>
|
|
<li>The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>config-id=et</code><ul>
|
|
<li>The config id; generated automatically. Leave this field blank for insert requests.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>config-name=sea</code><ul>
|
|
<li>The name of the config. Must be unique. Required for all requests.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>creative-type=et</code><ul>
|
|
<li>List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>excluded-content-labels=at</code><ul>
|
|
<li>Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>excluded-geo-criteria-ids=dolore</code><ul>
|
|
<li>Requests containing any of these geo criteria ids will not match.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>excluded-user-lists=eirmod</code><ul>
|
|
<li>Requests containing any of these users list ids will not match.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>excluded-verticals=lorem</code><ul>
|
|
<li>Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>geo-criteria-ids=accusam</code><ul>
|
|
<li>Requests containing any of these geo criteria ids will match.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-active=true</code><ul>
|
|
<li>Whether this config is active. Required for all requests.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=erat</code><ul>
|
|
<li>The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>languages=dolores</code><ul>
|
|
<li>Request containing any of these language codes will match.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>maximum-qps=erat</code><ul>
|
|
<li>The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>minimum-viewability-decile=28</code><ul>
|
|
<li>Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>mobile-carriers=sea</code><ul>
|
|
<li>Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>mobile-devices=takimata</code><ul>
|
|
<li>Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>mobile-operating-system-versions=lorem</code><ul>
|
|
<li>Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>platforms=et</code><ul>
|
|
<li>Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>supported-creative-attributes=at</code><ul>
|
|
<li>Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user-identifier-data-required=dolor</code><ul>
|
|
<li>Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user-lists=et</code><ul>
|
|
<li>Requests containing any of these user list ids will match.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>vendor-types=sit</code><ul>
|
|
<li>Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>verticals=erat</code><ul>
|
|
<li>Requests containing any of these vertical ids will match.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</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="../pretargeting-config_list/" class="btn btn-neutral float-left" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../pretargeting-config_update/" class="btn btn-neutral float-right" title="Update">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="../pretargeting-config_list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../pretargeting-config_update/" 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>
|