GoogleApi.PlayableLocations.V3.Api.V3 (google_api_playable_locations v0.3.0) View Source

API calls for all endpoints tagged V3.

Link to this section Summary

Functions

Logs new events when playable locations are displayed, and when they are interacted with. Impressions are not partially saved; either all impressions are saved and this request succeeds, or no impressions are saved, and this request fails.

Logs bad playable location reports submitted by players. Reports are not partially saved; either all reports are saved and this request succeeds, or no reports are saved, and this request fails.

Returns a set of playable locations that lie within a specified area, that satisfy optional filter criteria. Note: Identical SamplePlayableLocations requests can return different results as the state of the world changes over time.

Link to this section Functions

Link to this function

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

View Source

Specs

playablelocations_log_impressions(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3LogImpressionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Logs new events when playable locations are displayed, and when they are interacted with. Impressions are not partially saved; either all impressions are saved and this request succeeds, or no impressions are saved, and this request fails.

Parameters

  • connection (type: GoogleApi.PlayableLocations.V3.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").
    • :body (type: GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3LogImpressionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3LogImpressionsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

playablelocations_log_player_reports(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3LogPlayerReportsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Logs bad playable location reports submitted by players. Reports are not partially saved; either all reports are saved and this request succeeds, or no reports are saved, and this request fails.

Parameters

  • connection (type: GoogleApi.PlayableLocations.V3.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").
    • :body (type: GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3LogPlayerReportsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3LogPlayerReportsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

playablelocations_sample_playable_locations(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a set of playable locations that lie within a specified area, that satisfy optional filter criteria. Note: Identical SamplePlayableLocations requests can return different results as the state of the world changes over time.

Parameters

  • connection (type: GoogleApi.PlayableLocations.V3.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").
    • :body (type: GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.PlayableLocations.V3.Model.GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse{}} on success
  • {:error, info} on failure