| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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. |
| 99 | Intended for use by a job search auto-complete search box. |
| 100 | |
| 101 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | name: string, Required. Resource name of project the completion is performed within. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | |
| 104 | The format is "projects/{project_id}", for example, |
| 105 | "projects/api-test-project". (required) |
| 106 | languageCode: string, Deprecated. Use language_codes instead. |
| 107 | |
| 108 | Optional. |
| 109 | |
| 110 | The language of the query. This is |
| 111 | the BCP-47 language code, such as "en-US" or "sr-Latn". |
| 112 | For more information, see |
| 113 | [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 114 | |
| 115 | For CompletionType.JOB_TITLE type, only open jobs with the same |
| 116 | language_code are returned. |
| 117 | |
| 118 | For CompletionType.COMPANY_NAME type, |
| 119 | only companies having open jobs with the same language_code are |
| 120 | returned. |
| 121 | |
| 122 | For CompletionType.COMBINED type, only open jobs with the same |
| 123 | language_code or companies having open jobs with the same |
| 124 | language_code are returned. |
| 125 | |
| 126 | The maximum number of allowed characters is 255. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 127 | pageSize: integer, Required. Completion result count. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 128 | |
| 129 | The maximum allowed page size is 10. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 130 | languageCodes: string, Optional. The list of languages of the query. This is |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | the BCP-47 language code, such as "en-US" or "sr-Latn". |
| 132 | For more information, see |
| 133 | [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). |
| 134 | |
| 135 | For CompletionType.JOB_TITLE type, only open jobs with the same |
| 136 | language_codes are returned. |
| 137 | |
| 138 | For CompletionType.COMPANY_NAME type, |
| 139 | only companies having open jobs with the same language_codes are |
| 140 | returned. |
| 141 | |
| 142 | For CompletionType.COMBINED type, only open jobs with the same |
| 143 | language_codes or companies having open jobs with the same |
| 144 | language_codes are returned. |
| 145 | |
| 146 | The maximum number of allowed characters is 255. (repeated) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 147 | query: string, Required. The query used to generate suggestions. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 148 | |
| 149 | The maximum number of allowed characters is 255. |
| 150 | x__xgafv: string, V1 error format. |
| 151 | Allowed values |
| 152 | 1 - v1 error format |
| 153 | 2 - v2 error format |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 154 | scope: string, Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. |
| 155 | type: string, Optional. The completion topic. The default is CompletionType.COMBINED. |
| 156 | companyName: string, Optional. If provided, restricts completion to specified company. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 157 | |
| 158 | The format is "projects/{project_id}/companies/{company_id}", for example, |
| 159 | "projects/api-test-project/companies/foo". |
| 160 | |
| 161 | Returns: |
| 162 | An object of the form: |
| 163 | |
| 164 | { # Output only. |
| 165 | # |
| 166 | # Response of auto-complete query. |
| 167 | "completionResults": [ # Results of the matching job/company candidates. |
| 168 | { # Output only. |
| 169 | # |
| 170 | # Resource that represents completion results. |
| 171 | "type": "A String", # The completion topic. |
| 172 | "suggestion": "A String", # The suggestion for the query. |
| 173 | "imageUri": "A String", # The URI of the company image for CompletionType.COMPANY_NAME. |
| 174 | }, |
| 175 | ], |
| 176 | "metadata": { # Output only. # Additional information for the API invocation, such as the request |
| 177 | # tracking id. |
| 178 | # |
| 179 | # Additional information returned to client, such as debugging information. |
| 180 | "requestId": "A String", # A unique id associated with this call. |
| 181 | # This id is logged for tracking purposes. |
| 182 | }, |
| 183 | }</pre> |
| 184 | </div> |
| 185 | |
| 186 | </body></html> |