View Source GoogleApi.MyBusinessVerifications.V1.Api.Locations (google_api_my_business_verifications v0.5.0)

API calls for all endpoints tagged Locations.

Summary

Functions

Reports all eligible verification options for a location in a specific language.

Completes a PENDING verification. It is only necessary for non AUTO verification methods. AUTO verification request is instantly VERIFIED upon creation.

Functions

mybusinessverifications_locations_fetch_verification_options(connection, location, optional_params \\ [], opts \\ [])

@spec mybusinessverifications_locations_fetch_verification_options(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.MyBusinessVerifications.V1.Model.FetchVerificationOptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Reports all eligible verification options for a location in a specific language.

Parameters

  • connection (type: GoogleApi.MyBusinessVerifications.V1.Connection.t) - Connection to server
  • location (type: String.t) - Required. The location to verify.
  • 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").
    • :body (type: GoogleApi.MyBusinessVerifications.V1.Model.FetchVerificationOptionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessVerifications.V1.Model.FetchVerificationOptionsResponse{}} on success
  • {:error, info} on failure

mybusinessverifications_locations_get_voice_of_merchant_state(connection, name, optional_params \\ [], opts \\ [])

@spec mybusinessverifications_locations_get_voice_of_merchant_state(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessVerifications.V1.Model.VoiceOfMerchantState.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the VoiceOfMerchant state.

Parameters

  • connection (type: GoogleApi.MyBusinessVerifications.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the location.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessVerifications.V1.Model.VoiceOfMerchantState{}} on success
  • {:error, info} on failure

mybusinessverifications_locations_verifications_complete(connection, name, optional_params \\ [], opts \\ [])

@spec mybusinessverifications_locations_verifications_complete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.MyBusinessVerifications.V1.Model.CompleteVerificationResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Completes a PENDING verification. It is only necessary for non AUTO verification methods. AUTO verification request is instantly VERIFIED upon creation.

Parameters

  • connection (type: GoogleApi.MyBusinessVerifications.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the verification to complete.
  • 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").
    • :body (type: GoogleApi.MyBusinessVerifications.V1.Model.CompleteVerificationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessVerifications.V1.Model.CompleteVerificationResponse{}} on success
  • {:error, info} on failure

mybusinessverifications_locations_verifications_list(connection, parent, optional_params \\ [], opts \\ [])

@spec mybusinessverifications_locations_verifications_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.MyBusinessVerifications.V1.Model.ListVerificationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List verifications of a location, ordered by create time.

Parameters

  • connection (type: GoogleApi.MyBusinessVerifications.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the location that verification requests belong to.
  • 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").
    • :pageSize (type: integer()) - How many verification to include per page. Minimum is 1, and the default and maximum page size is 100.
    • :pageToken (type: String.t) - If specified, returns the next page of verifications.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessVerifications.V1.Model.ListVerificationsResponse{}} on success
  • {:error, info} on failure

mybusinessverifications_locations_verify(connection, name, optional_params \\ [], opts \\ [])

@spec mybusinessverifications_locations_verify(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessVerifications.V1.Model.VerifyLocationResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Starts the verification process for a location.

Parameters

  • connection (type: GoogleApi.MyBusinessVerifications.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the location to verify.
  • 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").
    • :body (type: GoogleApi.MyBusinessVerifications.V1.Model.VerifyLocationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessVerifications.V1.Model.VerifyLocationResponse{}} on success
  • {:error, info} on failure