View Source GoogleApi.Content.V21.Api.Recommendations (google_api_content v0.67.1)

API calls for all endpoints tagged Recommendations.

Summary

Functions

content_recommendations_generate(connection, merchant_id, optional_params \\ [], opts \\ [])

Generates recommendations for a merchant.

content_recommendations_report_interaction(connection, merchant_id, optional_params \\ [], opts \\ [])

Reports an interaction on a recommendation for a merchant.

Functions

Link to this function

content_recommendations_generate(connection, merchant_id, optional_params \\ [], opts \\ [])

View Source 
@spec content_recommendations_generate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.GenerateRecommendationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates recommendations for a merchant.

Parameters

  • connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
  • merchant_id (type: String.t) - Required. The ID of the account to fetch recommendations for.
  • 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").
    • :allowedTag (type: list(String.t)) - Optional. List of allowed tags. Tags are a set of predefined strings that describe the category that individual recommendation types belong to. User can specify zero or more tags in this field to indicate what categories of recommendations they want to receive. Current list of supported tags: - TREND
    • :languageCode (type: String.t) - Optional. Language code of the client. If not set, the result will be in default language (English). This language code affects all fields prefixed with "localized". This should be set to ISO 639-1 country code. List of currently verified supported language code: en, fr, cs, da, de, es, it, nl, no, pl, pt, pt, fi, sv, vi, tr, th, ko, zh-CN, zh-TW, ja, id, hi
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V21.Model.GenerateRecommendationsResponse{}} on success
  • {:error, info} on failure
Link to this function

content_recommendations_report_interaction(connection, merchant_id, optional_params \\ [], opts \\ [])

View Source 
@spec content_recommendations_report_interaction(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Reports an interaction on a recommendation for a merchant.

Parameters

  • connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
  • merchant_id (type: String.t) - Required. The ID of the account that wants to report an interaction.
  • 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.Content.V21.Model.ReportInteractionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure