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

API calls for all endpoints tagged Monetization.

Summary

Functions

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

Calculates the region prices, using today's exchange rate and country-specific pricing patterns, based on the price in the request for a set of regions.

androidpublisher_monetization_subscriptions_archive(connection, package_name, product_id, optional_params \\ [], opts \\ [])

Deprecated: subscription archiving is not supported.

androidpublisher_monetization_subscriptions_base_plans_activate(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Activates a base plan. Once activated, base plans will be available to new subscribers.

androidpublisher_monetization_subscriptions_base_plans_batch_migrate_prices(connection, package_name, product_id, optional_params \\ [], opts \\ [])

Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

androidpublisher_monetization_subscriptions_base_plans_batch_update_states(connection, package_name, product_id, optional_params \\ [], opts \\ [])

Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

androidpublisher_monetization_subscriptions_base_plans_deactivate(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription

androidpublisher_monetization_subscriptions_base_plans_delete(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Deletes a base plan. Can only be done for draft base plans. This action is irreversible.

androidpublisher_monetization_subscriptions_base_plans_migrate_prices(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Migrates subscribers who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.

androidpublisher_monetization_subscriptions_base_plans_offers_activate(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.

androidpublisher_monetization_subscriptions_base_plans_offers_batch_get(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Reads one or more subscription offers.

androidpublisher_monetization_subscriptions_base_plans_offers_batch_update(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Updates a batch of subscription offers. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

androidpublisher_monetization_subscriptions_base_plans_offers_batch_update_states(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Updates a batch of subscription offer states. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

androidpublisher_monetization_subscriptions_base_plans_offers_create(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.

androidpublisher_monetization_subscriptions_base_plans_offers_deactivate(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.

androidpublisher_monetization_subscriptions_base_plans_offers_delete(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

Deletes a subscription offer. Can only be done for draft offers. This action is irreversible.

androidpublisher_monetization_subscriptions_base_plans_offers_get(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

Reads a single offer

androidpublisher_monetization_subscriptions_base_plans_offers_list(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

Lists all offers under a given subscription.

androidpublisher_monetization_subscriptions_base_plans_offers_patch(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

Updates an existing subscription offer.

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

Reads one or more subscriptions.

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

Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

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

Creates a new subscription. Newly added base plans will remain in draft state until activated.

androidpublisher_monetization_subscriptions_delete(connection, package_name, product_id, optional_params \\ [], opts \\ [])

Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.

androidpublisher_monetization_subscriptions_get(connection, package_name, product_id, optional_params \\ [], opts \\ [])

Reads a single subscription.

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

Lists all subscriptions under a given app.

androidpublisher_monetization_subscriptions_patch(connection, package_name, product_id, optional_params \\ [], opts \\ [])

Updates an existing subscription.

Functions

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

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

Calculates the region prices, using today's exchange rate and country-specific pricing patterns, based on the price in the request for a set of regions.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The app package name.
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.ConvertRegionPricesRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_archive(connection, package_name, product_id, optional_params \\ [], opts \\ [])

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

Deprecated: subscription archiving is not supported.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the app of the subscription to delete.
product_id (type: String.t) - Required. The unique product ID of the subscription to delete.
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.ArchiveSubscriptionRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_activate(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Activates a base plan. Once activated, base plans will be available to new subscribers.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the base plan to activate.
product_id (type: String.t) - Required. The parent subscription (ID) of the base plan to activate.
base_plan_id (type: String.t) - Required. The unique base plan ID of the base plan to activate.
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.ActivateBasePlanRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_batch_migrate_prices(connection, package_name, product_id, optional_params \\ [], opts \\ [])

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

Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the Subscription resources.
product_id (type: String.t) - Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.
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.BatchMigrateBasePlanPricesRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_batch_update_states(connection, package_name, product_id, optional_params \\ [], opts \\ [])

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

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the updated base plans.
product_id (type: String.t) - Required. The product ID of the parent subscription, if all updated base plans belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.
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.BatchUpdateBasePlanStatesRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_deactivate(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the base plan to deactivate.
product_id (type: String.t) - Required. The parent subscription (ID) of the base plan to deactivate.
base_plan_id (type: String.t) - Required. The unique base plan ID of the base plan to deactivate.
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.DeactivateBasePlanRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_delete(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Deletes a base plan. Can only be done for draft base plans. This action is irreversible.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the base plan to delete.
product_id (type: String.t) - Required. The parent subscription (ID) of the base plan to delete.
base_plan_id (type: String.t) - Required. The unique offer ID of the base plan to delete.
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

androidpublisher_monetization_subscriptions_base_plans_migrate_prices(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.
product_id (type: String.t) - Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.
base_plan_id (type: String.t) - Required. The unique base plan ID of the base plan to update prices on.
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.MigrateBasePlanPricesRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_activate(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

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

Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the offer to activate.
product_id (type: String.t) - Required. The parent subscription (ID) of the offer to activate.
base_plan_id (type: String.t) - Required. The parent base plan (ID) of the offer to activate.
offer_id (type: String.t) - Required. The unique offer ID of the offer to activate.
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.ActivateSubscriptionOfferRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_batch_get(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Reads one or more subscription offers.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the requests.
product_id (type: String.t) - Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.
base_plan_id (type: String.t) - Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans.
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.BatchGetSubscriptionOffersRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_batch_update(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Updates a batch of subscription offers. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.
product_id (type: String.t) - Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.
base_plan_id (type: String.t) - Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.
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.BatchUpdateSubscriptionOffersRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_batch_update_states(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Updates a batch of subscription offer states. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.
product_id (type: String.t) - Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.
base_plan_id (type: String.t) - Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.
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.BatchUpdateSubscriptionOfferStatesRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_create(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the offer should be created. Must be equal to the package_name field on the Subscription resource.
product_id (type: String.t) - Required. The parent subscription (ID) for which the offer should be created. Must be equal to the product_id field on the SubscriptionOffer resource.
base_plan_id (type: String.t) - Required. The parent base plan (ID) for which the offer should be created. Must be equal to the base_plan_id field on the SubscriptionOffer resource.
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").
- :offerId (type: String.t) - Required. The ID to use for the offer. For the requirements on this format, see the documentation of the offer_id field on the SubscriptionOffer resource.
- :"regionsVersion.version" (type: String.t) - Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
- :body (type: GoogleApi.AndroidPublisher.V3.Model.SubscriptionOffer.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_deactivate(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

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

Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the offer to deactivate.
product_id (type: String.t) - Required. The parent subscription (ID) of the offer to deactivate.
base_plan_id (type: String.t) - Required. The parent base plan (ID) of the offer to deactivate.
offer_id (type: String.t) - Required. The unique offer ID of the offer to deactivate.
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.DeactivateSubscriptionOfferRequest.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_delete(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

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

Deletes a subscription offer. Can only be done for draft offers. This action is irreversible.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the offer to delete.
product_id (type: String.t) - Required. The parent subscription (ID) of the offer to delete.
base_plan_id (type: String.t) - Required. The parent base plan (ID) of the offer to delete.
offer_id (type: String.t) - Required. The unique offer ID of the offer to delete.
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

androidpublisher_monetization_subscriptions_base_plans_offers_get(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

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

Reads a single offer

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the offer to get.
product_id (type: String.t) - Required. The parent subscription (ID) of the offer to get.
base_plan_id (type: String.t) - Required. The parent base plan (ID) of the offer to get.
offer_id (type: String.t) - Required. The unique offer ID of the offer to get.
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.SubscriptionOffer{}} on success
{:error, info} on failure

androidpublisher_monetization_subscriptions_base_plans_offers_list(connection, package_name, product_id, base_plan_id, optional_params \\ [], opts \\ [])

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

Lists all offers under a given subscription.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the subscriptions should be read.
product_id (type: String.t) - Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.
base_plan_id (type: String.t) - Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'.
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()) - The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- :pageToken (type: String.t) - A page token, received from a previous ListSubscriptionsOffers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptionOffers must match the call that provided the page token.
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_base_plans_offers_patch(connection, package_name, product_id, base_plan_id, offer_id, optional_params \\ [], opts \\ [])

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

Updates an existing subscription offer.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. Immutable. The package name of the app the parent subscription belongs to.
product_id (type: String.t) - Required. Immutable. The ID of the parent subscription this offer belongs to.
base_plan_id (type: String.t) - Required. Immutable. The ID of the base plan to which this offer is an extension.
offer_id (type: String.t) - Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
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()) - Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored.
- :latencyTolerance (type: String.t) - Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
- :"regionsVersion.version" (type: String.t) - Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
- :updateMask (type: String.t) - Required. The list of fields to be updated.
- :body (type: GoogleApi.AndroidPublisher.V3.Model.SubscriptionOffer.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Reads one or more subscriptions.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the subscriptions should be retrieved. Must be equal to the package_name field on all the requests.
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").
- :productIds (type: list(String.t)) - Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different.
opts (type: keyword()) - Call options

Returns

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

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

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

Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the subscriptions should be updated. Must be equal to the package_name field on all the Subscription resources.
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.BatchUpdateSubscriptionsRequest.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Creates a new subscription. Newly added base plans will remain in draft state until activated.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the subscription should be created. Must be equal to the package_name field on the Subscription resource.
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").
- :productId (type: String.t) - Required. The ID to use for the subscription. For the requirements on this format, see the documentation of the product_id field on the Subscription resource.
- :"regionsVersion.version" (type: String.t) - Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
- :body (type: GoogleApi.AndroidPublisher.V3.Model.Subscription.t) -
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_delete(connection, package_name, product_id, optional_params \\ [], opts \\ [])

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

Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the app of the subscription to delete.
product_id (type: String.t) - Required. The unique product ID of the subscription to delete.
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

androidpublisher_monetization_subscriptions_get(connection, package_name, product_id, optional_params \\ [], opts \\ [])

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

Reads a single subscription.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) of the subscription to get.
product_id (type: String.t) - Required. The unique product ID of the subscription to get.
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.Subscription{}} on success
{:error, info} on failure

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

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

Lists all subscriptions under a given app.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Required. The parent app (package name) for which the subscriptions should be read.
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()) - The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
- :pageToken (type: String.t) - A page token, received from a previous ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions must match the call that provided the page token.
- :showArchived (type: boolean()) - Deprecated: subscription archiving is not supported.
opts (type: keyword()) - Call options

Returns

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

androidpublisher_monetization_subscriptions_patch(connection, package_name, product_id, optional_params \\ [], opts \\ [])

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

Updates an existing subscription.

Parameters

connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
package_name (type: String.t) - Immutable. Package name of the parent app.
product_id (type: String.t) - Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.
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()) - Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored.
- :latencyTolerance (type: String.t) - Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
- :"regionsVersion.version" (type: String.t) - Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
- :updateMask (type: String.t) - Required. The list of fields to be updated.
- :body (type: GoogleApi.AndroidPublisher.V3.Model.Subscription.t) -
opts (type: keyword()) - Call options

Returns

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