Files
2024-03-05 21:06:01 +01:00

327 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-jobs4-cli/projects_tenants-client-events-create/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Tenants Client Events Create - Cloud Talent Solution v5.0.4+20240202</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 = "Tenants Client Events Create";
var mkdocs_page_input_path = "projects_tenants-client-events-create.md";
var mkdocs_page_url = "/google-apis-rs/google-jobs4-cli/projects_tenants-client-events-create/";
</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"> Cloud Talent Solution v5.0.4+20240202
</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">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-get/">Operations Get</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Tenants Client Events Create</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-companies-create/">Tenants Companies Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-companies-delete/">Tenants Companies Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-companies-get/">Tenants Companies Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-companies-list/">Tenants Companies List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-companies-patch/">Tenants Companies Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-complete-query/">Tenants Complete Query</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-create/">Tenants Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-delete/">Tenants Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-get/">Tenants Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-batch-create/">Tenants Jobs Batch Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-batch-delete/">Tenants Jobs Batch Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-batch-update/">Tenants Jobs Batch Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-create/">Tenants Jobs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-delete/">Tenants Jobs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-get/">Tenants Jobs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-list/">Tenants Jobs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-patch/">Tenants Jobs Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-search/">Tenants Jobs Search</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-jobs-search-for-alert/">Tenants Jobs Search For Alert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-list/">Tenants List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_tenants-patch/">Tenants Patch</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="..">Cloud Talent Solution v5.0.4+20240202</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> &raquo;</li>
<li>Projects &raquo;</li>
<li>Tenants Client Events Create</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/jobs4-cli/edit/master/docs/projects_tenants-client-events-create.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>Report events issued when end user interacts with customer&#39;s application that uses Cloud Talent Solution. You may inspect the created events in <a href="https://console.cloud.google.com/talent-solution/overview">self service tools</a>. <a href="https://cloud.google.com/talent-solution/docs/management-tools">Learn more</a> about self service tools.</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/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/jobs</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>jobs4 --scope &lt;scope&gt; projects tenants-client-events-create ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;parent&gt;</strong> <em>(string)</em><ul>
<li>Required. Resource name of the tenant under which the event is created. The format is &#34;projects/{project_id}/tenants/{tenant_id}&#34;, for example, &#34;projects/foo/tenants/bar&#34;.</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>ClientEvent:
create-time: string
event-id: string
event-notes: string
job-event:
jobs: [string]
type: string
request-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><code>-r . create-time=et</code><ul>
<li>Required. The timestamp of the event.</li>
</ul>
</li>
<li><code>event-id=magna</code><ul>
<li>Required. A unique identifier, generated by the client application.</li>
</ul>
</li>
<li><code>event-notes=no</code><ul>
<li>Notes about the event provided by recruiters or other users, for example, feedback on why a job was bookmarked.</li>
</ul>
</li>
<li><code>job-event jobs=ipsum</code><ul>
<li>Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. The format is &#34;projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}&#34;, for example, &#34;projects/foo/tenants/bar/jobs/baz&#34;.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>type=voluptua.</code></p>
<ul>
<li>Required. The type of the event (see JobEventType).</li>
</ul>
</li>
<li>
<p><code>.. request-id=at</code></p>
<ul>
<li>Strongly recommended for the best service experience. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_operations-get/" class="btn btn-neutral float-left" title="Operations Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_tenants-companies-create/" class="btn btn-neutral float-right" title="Tenants Companies Create">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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/jobs4-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_operations-get/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_tenants-companies-create/" style="color: #fcfcfc">Next &raquo;</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>