View Source GoogleApi.AndroidPublisher.V3.Api.Inappproducts (google_api_android_publisher v0.34.1)

API calls for all endpoints tagged Inappproducts.

Summary

Functions

androidpublisher_inappproducts_batch_delete(connection, package_name, optional_params \\ [], opts \\ [])

Deletes in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should not be used to delete subscriptions. See this article for more information.

androidpublisher_inappproducts_batch_get(connection, package_name, optional_params \\ [], opts \\ [])

Reads multiple in-app products, which can be managed products or subscriptions. This method should not be used to retrieve subscriptions. See this article for more information.

androidpublisher_inappproducts_batch_update(connection, package_name, optional_params \\ [], opts \\ [])

Updates or inserts one or more in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should no longer be used to update subscriptions. See this article for more information.

androidpublisher_inappproducts_delete(connection, package_name, sku, optional_params \\ [], opts \\ [])

Deletes an in-app product (a managed product or a subscription). This method should no longer be used to delete subscriptions. See this article for more information.

androidpublisher_inappproducts_get(connection, package_name, sku, optional_params \\ [], opts \\ [])

Gets an in-app product, which can be a managed product or a subscription. This method should no longer be used to retrieve subscriptions. See this article for more information.

androidpublisher_inappproducts_insert(connection, package_name, optional_params \\ [], opts \\ [])

Creates an in-app product (a managed product or a subscription). This method should no longer be used to create subscriptions. See this article for more information.

androidpublisher_inappproducts_list(connection, package_name, optional_params \\ [], opts \\ [])

Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field tokenPagination.nextPageToken will be set and the caller should provide its value as a token request parameter to retrieve the next page. This method should no longer be used to retrieve subscriptions. See this article for more information.

androidpublisher_inappproducts_patch(connection, package_name, sku, optional_params \\ [], opts \\ [])

Patches an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See this article for more information.

androidpublisher_inappproducts_update(connection, package_name, sku, optional_params \\ [], opts \\ [])

Updates an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See this article for more information.

Functions

Link to this function

androidpublisher_inappproducts_batch_delete(connection, package_name, optional_params \\ [], opts \\ [])

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

Deletes in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should not be used to delete subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • 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.AndroidPublisher.V3.Model.InappproductsBatchDeleteRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

androidpublisher_inappproducts_batch_get(connection, package_name, optional_params \\ [], opts \\ [])

View Source 
@spec androidpublisher_inappproducts_batch_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V3.Model.InappproductsBatchGetResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Reads multiple in-app products, which can be managed products or subscriptions. This method should not be used to retrieve subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • 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").
    • :sku (type: list(String.t)) - Unique identifier for the in-app products.
  • opts (type: keyword()) - Call options

Returns

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

androidpublisher_inappproducts_batch_update(connection, package_name, optional_params \\ [], opts \\ [])

View Source 
@spec androidpublisher_inappproducts_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AndroidPublisher.V3.Model.InappproductsBatchUpdateResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates or inserts one or more in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should no longer be used to update subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • 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.AndroidPublisher.V3.Model.InappproductsBatchUpdateRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

androidpublisher_inappproducts_delete(connection, package_name, sku, optional_params \\ [], opts \\ [])

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

Deletes an in-app product (a managed product or a subscription). This method should no longer be used to delete subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • sku (type: String.t) - Unique identifier for the in-app product.
  • 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").
    • :latencyTolerance (type: String.t) - Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

androidpublisher_inappproducts_get(connection, package_name, sku, optional_params \\ [], opts \\ [])

View Source 
@spec androidpublisher_inappproducts_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V3.Model.InAppProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an in-app product, which can be a managed product or a subscription. This method should no longer be used to retrieve subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • sku (type: String.t) - Unique identifier for the in-app product.
  • 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.AndroidPublisher.V3.Model.InAppProduct{}} on success
  • {:error, info} on failure
Link to this function

androidpublisher_inappproducts_insert(connection, package_name, optional_params \\ [], opts \\ [])

View Source 
@spec androidpublisher_inappproducts_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V3.Model.InAppProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an in-app product (a managed product or a subscription). This method should no longer be used to create subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • 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").
    • :autoConvertMissingPrices (type: boolean()) - If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
    • :body (type: GoogleApi.AndroidPublisher.V3.Model.InAppProduct.t) -
  • opts (type: keyword()) - Call options

Returns

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

androidpublisher_inappproducts_list(connection, package_name, optional_params \\ [], opts \\ [])

View Source 
@spec androidpublisher_inappproducts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V3.Model.InappproductsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field tokenPagination.nextPageToken will be set and the caller should provide its value as a token request parameter to retrieve the next page. This method should no longer be used to retrieve subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • 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").
    • :maxResults (type: integer()) - Deprecated and ignored. The page size is determined by the server.
    • :startIndex (type: integer()) - Deprecated and ignored. Set the token parameter to retrieve the next page.
    • :token (type: String.t) - Pagination token. If empty, list starts at the first product.
  • opts (type: keyword()) - Call options

Returns

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

androidpublisher_inappproducts_patch(connection, package_name, sku, optional_params \\ [], opts \\ [])

View Source 
@spec androidpublisher_inappproducts_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V3.Model.InAppProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patches an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • sku (type: String.t) - Unique identifier for the in-app product.
  • 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").
    • :autoConvertMissingPrices (type: boolean()) - If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
    • :latencyTolerance (type: String.t) - Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
    • :body (type: GoogleApi.AndroidPublisher.V3.Model.InAppProduct.t) -
  • opts (type: keyword()) - Call options

Returns

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

androidpublisher_inappproducts_update(connection, package_name, sku, optional_params \\ [], opts \\ [])

View Source 
@spec androidpublisher_inappproducts_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V3.Model.InAppProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See this article for more information.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - Package name of the app.
  • sku (type: String.t) - Unique identifier for the in-app product.
  • 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").
    • :allowMissing (type: boolean()) - If set to true, and the in-app product with the given package_name and sku doesn't exist, the in-app product will be created.
    • :autoConvertMissingPrices (type: boolean()) - If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.
    • :latencyTolerance (type: String.t) - Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
    • :body (type: GoogleApi.AndroidPublisher.V3.Model.InAppProduct.t) -
  • opts (type: keyword()) - Call options

Returns

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