Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / jobs_v2.v2.html
blob: 084c2299ce44baba46096f07a5cedf95656bca6b [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="jobs_v2.html">Cloud Talent Solution API</a> . <a href="jobs_v2.v2.html">v2</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#complete">complete(companyName=None, scope=None, pageSize=None, query=None, languageCode=None, type=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Completes the specified prefix with job keyword suggestions.</p>
80<h3>Method Details</h3>
81<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]82 <code class="details" id="complete">complete(companyName=None, scope=None, pageSize=None, query=None, languageCode=None, type=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <pre>Completes the specified prefix with job keyword suggestions.
84Intended for use by a job search auto-complete search box.
85
86Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 companyName: string, Optional. If provided, restricts completion to the specified company.
88 scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
89 pageSize: integer, Required. Completion result count.
90The maximum allowed page size is 10.
91 query: string, Required. The query used to generate suggestions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]92 languageCode: string, Required. The language of the query. This is
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94For more information, see
95[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
96
97For CompletionType.JOB_TITLE type, only open jobs with same
98language_code are returned.
99
100For CompletionType.COMPANY_NAME type,
101only companies having open jobs with same language_code are
102returned.
103
104For CompletionType.COMBINED type, only open jobs with same
105language_code or companies having open jobs with same
106language_code are returned.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107 type: string, Optional. The completion topic. The default is CompletionType.COMBINED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # Output only.
117 #
118 # Response of auto-complete query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;metadata&quot;: { # Output only. # Additional information for the API invocation, such as the request
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 # tracking id.
121 #
122 # Additional information returned to client, such as debugging
123 # information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 &quot;requestId&quot;: &quot;A String&quot;, # A unique id associated with this call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 # This id is logged for tracking purposes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 &quot;mode&quot;: &quot;A String&quot;, # For search response only. Indicates the mode of a performed search.
127 &quot;experimentIdList&quot;: [ # Identifiers for the versions of the search algorithm used during
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 # this API invocation if multiple algorithms are used.
129 # The default value is empty.
130 # For search response only.
131 42,
132 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;completionResults&quot;: [ # Results of the matching job/company candidates.
135 { # Output only.
136 #
137 # Resource that represents completion results.
138 &quot;type&quot;: &quot;A String&quot;, # The completion topic.
139 &quot;imageUrl&quot;: &quot;A String&quot;, # The URL for the company logo if `type=COMPANY_NAME`.
140 &quot;suggestion&quot;: &quot;A String&quot;, # The suggestion for the query.
141 },
142 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 }</pre>
144</div>
145
146</body></html>