GoogleApi.Jobs.V2.Api.V2 (google_api_jobs v0.15.0) View Source

API calls for all endpoints tagged V2.

Link to this section Summary

Functions

Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.

Link to this section Functions

Link to this function

jobs_complete(connection, optional_params \\ [], opts \\ [])

View Source

Specs

jobs_complete(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Jobs.V2.Model.CompleteQueryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.

Parameters

  • connection (type: GoogleApi.Jobs.V2.Connection.t) - Connection to server

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.

    • :access_token (type: String.t) - OAuth access token.

    • :alt (type: String.t) - Data format for response.

    • :callback (type: String.t) - JSONP

    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.

    • :key (type: String.t) - 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.

    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.

    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.

    • :quotaUser (type: String.t) - 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.

    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").

    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").

    • :companyName (type: String.t) - Optional. If provided, restricts completion to the specified company.

    • :languageCode (type: String.t) - Required. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

      For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned.

    • :pageSize (type: integer()) - Required. Completion result count. The maximum allowed page size is 10.

    • :query (type: String.t) - Required. The query used to generate suggestions.

    • :scope (type: String.t) - Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.

    • :type (type: String.t) - Optional. The completion topic. The default is CompletionType.COMBINED.

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Jobs.V2.Model.CompleteQueryResponse{}} on success
  • {:error, info} on failure