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

API calls for all endpoints tagged Freelistingsprogram.

Summary

Functions

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

Deletes Checkout settings and unenrolls merchant from Checkout program.

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

Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.

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

Enrolls merchant in Checkout program.

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

Retrieves the status and review eligibility for the free listing program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use accountstatuses to view all issues for an account.

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

Requests a review of free listings in a specific region. This method deprecated. Use the MerchantSupportService to view product and account issues and request a review.

Functions

Link to this function

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

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

Deletes Checkout settings and unenrolls merchant from Checkout program.

Parameters

  • connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
  • merchant_id (type: String.t) - Required. The ID of the account.
  • 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, %{}} on success
  • {:error, info} on failure
Link to this function

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

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

Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.

Parameters

  • connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
  • merchant_id (type: String.t) - Required. The ID of the account.
  • 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.Content.V21.Model.CheckoutSettings{}} on success
  • {:error, info} on failure
Link to this function

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

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

Enrolls merchant in Checkout program.

Parameters

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

Returns

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

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

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

Retrieves the status and review eligibility for the free listing program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use accountstatuses to view all issues for an account.

Parameters

  • connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
  • merchant_id (type: String.t) - Required. The ID of the account.
  • 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.Content.V21.Model.FreeListingsProgramStatus{}} on success
  • {:error, info} on failure
Link to this function

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

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

Requests a review of free listings in a specific region. This method deprecated. Use the MerchantSupportService to view product and account issues and request a review.

Parameters

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

Returns

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