• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_v3.html">Cloud Talent Solution API</a> . <a href="jobs_v3.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="jobs_v3.projects.clientEvents.html">clientEvents()</a></code>
79</p>
80<p class="firstline">Returns the clientEvents Resource.</p>
81
82<p class="toc_element">
83  <code><a href="jobs_v3.projects.companies.html">companies()</a></code>
84</p>
85<p class="firstline">Returns the companies Resource.</p>
86
87<p class="toc_element">
88  <code><a href="jobs_v3.projects.jobs.html">jobs()</a></code>
89</p>
90<p class="firstline">Returns the jobs Resource.</p>
91
92<p class="toc_element">
93  <code><a href="#complete">complete(name, languageCode=None, pageSize=None, languageCodes=None, query=None, x__xgafv=None, scope=None, type=None, companyName=None)</a></code></p>
94<p class="firstline">Completes the specified prefix with keyword suggestions.</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="complete">complete(name, languageCode=None, pageSize=None, languageCodes=None, query=None, x__xgafv=None, scope=None, type=None, companyName=None)</code>
98  <pre>Completes the specified prefix with keyword suggestions.
99Intended for use by a job search auto-complete search box.
100
101Args:
102  name: string, Required.
103
104Resource name of project the completion is performed within.
105
106The format is "projects/{project_id}", for example,
107"projects/api-test-project". (required)
108  languageCode: string, Deprecated. Use language_codes instead.
109
110Optional.
111
112The language of the query. This is
113the BCP-47 language code, such as "en-US" or "sr-Latn".
114For more information, see
115[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
116
117For CompletionType.JOB_TITLE type, only open jobs with the same
118language_code are returned.
119
120For CompletionType.COMPANY_NAME type,
121only companies having open jobs with the same language_code are
122returned.
123
124For CompletionType.COMBINED type, only open jobs with the same
125language_code or companies having open jobs with the same
126language_code are returned.
127
128The maximum number of allowed characters is 255.
129  pageSize: integer, Required.
130
131Completion result count.
132
133The maximum allowed page size is 10.
134  languageCodes: string, Optional.
135
136The list of languages of the query. This is
137the BCP-47 language code, such as "en-US" or "sr-Latn".
138For more information, see
139[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
140
141For CompletionType.JOB_TITLE type, only open jobs with the same
142language_codes are returned.
143
144For CompletionType.COMPANY_NAME type,
145only companies having open jobs with the same language_codes are
146returned.
147
148For CompletionType.COMBINED type, only open jobs with the same
149language_codes or companies having open jobs with the same
150language_codes are returned.
151
152The maximum number of allowed characters is 255. (repeated)
153  query: string, Required.
154
155The query used to generate suggestions.
156
157The maximum number of allowed characters is 255.
158  x__xgafv: string, V1 error format.
159    Allowed values
160      1 - v1 error format
161      2 - v2 error format
162  scope: string, Optional.
163
164The scope of the completion. The defaults is CompletionScope.PUBLIC.
165  type: string, Optional.
166
167The completion topic. The default is CompletionType.COMBINED.
168  companyName: string, Optional.
169
170If provided, restricts completion to specified company.
171
172The format is "projects/{project_id}/companies/{company_id}", for example,
173"projects/api-test-project/companies/foo".
174
175Returns:
176  An object of the form:
177
178    { # Output only.
179      #
180      # Response of auto-complete query.
181    "completionResults": [ # Results of the matching job/company candidates.
182      { # Output only.
183          #
184          # Resource that represents completion results.
185        "type": "A String", # The completion topic.
186        "suggestion": "A String", # The suggestion for the query.
187        "imageUri": "A String", # The URI of the company image for CompletionType.COMPANY_NAME.
188      },
189    ],
190    "metadata": { # Output only. # Additional information for the API invocation, such as the request
191        # tracking id.
192        #
193        # Additional information returned to client, such as debugging information.
194      "requestId": "A String", # A unique id associated with this call.
195          # This id is logged for tracking purposes.
196    },
197  }</pre>
198</div>
199
200</body></html>