1. class
  2. Google
  3. \
  4. Service
  5. \
  6. AndroidPublisher
  7. \
  8. Resource
  9. \
  10. MonetizationSubscriptionsBasePlansOffers

MonetizationSubscriptionsBasePlansOffers

class MonetizationSubscriptionsBasePlansOffers extends Resource (View source)

The "offers" collection of methods.

Typical usage is:

 $androidpublisherService = new Google\Service\AndroidPublisher(...);
 $offers = $androidpublisherService->monetization_subscriptions_basePlans_offers;

Methods

SubscriptionOffer
activate(string $packageName, string $productId, string $basePlanId, string $offerId, ActivateSubscriptionOfferRequest $postBody, array $optParams = [])

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

BatchGetSubscriptionOffersResponse
batchGet(string $packageName, string $productId, string $basePlanId, BatchGetSubscriptionOffersRequest $postBody, array $optParams = [])

Reads one or more subscription offers. (offers.batchGet)

BatchUpdateSubscriptionOffersResponse
batchUpdate(string $packageName, string $productId, string $basePlanId, BatchUpdateSubscriptionOffersRequest $postBody, array $optParams = [])

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. (offers.batchUpdate)

BatchUpdateSubscriptionOfferStatesResponse
batchUpdateStates(string $packageName, string $productId, string $basePlanId, BatchUpdateSubscriptionOfferStatesRequest $postBody, array $optParams = [])

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. (offers.batchUpdateStates)

SubscriptionOffer
create(string $packageName, string $productId, string $basePlanId, SubscriptionOffer $postBody, array $optParams = [])

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

SubscriptionOffer
deactivate(string $packageName, string $productId, string $basePlanId, string $offerId, DeactivateSubscriptionOfferRequest $postBody, array $optParams = [])

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

delete(string $packageName, string $productId, string $basePlanId, string $offerId, array $optParams = [])

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

SubscriptionOffer
get(string $packageName, string $productId, string $basePlanId, string $offerId, array $optParams = [])

Reads a single offer (offers.get)

ListSubscriptionOffersResponse
listMonetizationSubscriptionsBasePlansOffers(string $packageName, string $productId, string $basePlanId, array $optParams = [])

Lists all offers under a given subscription.

SubscriptionOffer
patch(string $packageName, string $productId, string $basePlanId, string $offerId, SubscriptionOffer $postBody, array $optParams = [])

Updates an existing subscription offer. (offers.patch)

Details

at line 58
SubscriptionOffer activate(string $packageName, string $productId, string $basePlanId, string $offerId, ActivateSubscriptionOfferRequest $postBody, array $optParams = [])

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

Parameters

string $packageName

Required. The parent app (package name) of the offer to activate.
string $productId

Required. The parent subscription (ID) of the offer to activate.
string $basePlanId

Required. The parent base plan (ID) of the offer to activate.
string $offerId

Required. The unique offer ID of the offer to activate.
ActivateSubscriptionOfferRequest $postBody
array $optParams

Optional parameters.

Return Value

SubscriptionOffer

Exceptions

Exception

at line 81
BatchGetSubscriptionOffersResponse batchGet(string $packageName, string $productId, string $basePlanId, BatchGetSubscriptionOffersRequest $postBody, array $optParams = [])

Reads one or more subscription offers. (offers.batchGet)

Parameters

string $packageName

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.
string $productId

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.
string $basePlanId

Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans.
BatchGetSubscriptionOffersRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchGetSubscriptionOffersResponse

Exceptions

Exception

at line 106
BatchUpdateSubscriptionOffersResponse batchUpdate(string $packageName, string $productId, string $basePlanId, BatchUpdateSubscriptionOffersRequest $postBody, array $optParams = [])

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. (offers.batchUpdate)

Parameters

string $packageName

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.
string $productId

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.
string $basePlanId

Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.
BatchUpdateSubscriptionOffersRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchUpdateSubscriptionOffersResponse

Exceptions

Exception

at line 131
BatchUpdateSubscriptionOfferStatesResponse batchUpdateStates(string $packageName, string $productId, string $basePlanId, BatchUpdateSubscriptionOfferStatesRequest $postBody, array $optParams = [])

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. (offers.batchUpdateStates)

Parameters

string $packageName

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.
string $productId

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.
string $basePlanId

Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.
BatchUpdateSubscriptionOfferStatesRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchUpdateSubscriptionOfferStatesResponse

Exceptions

Exception

at line 169
SubscriptionOffer create(string $packageName, string $productId, string $basePlanId, SubscriptionOffer $postBody, array $optParams = [])

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

(offers.create)

Parameters

string $packageName

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.
string $productId

Required. The parent subscription (ID) for which the offer should be created. Must be equal to the product_id field on the SubscriptionOffer resource.
string $basePlanId

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.
SubscriptionOffer $postBody
array $optParams

Optional parameters.

Return Value

SubscriptionOffer

Exceptions

Exception

at line 193
SubscriptionOffer deactivate(string $packageName, string $productId, string $basePlanId, string $offerId, DeactivateSubscriptionOfferRequest $postBody, array $optParams = [])

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

Parameters

string $packageName

Required. The parent app (package name) of the offer to deactivate.
string $productId

Required. The parent subscription (ID) of the offer to deactivate.
string $basePlanId

Required. The parent base plan (ID) of the offer to deactivate.
string $offerId

Required. The unique offer ID of the offer to deactivate.
DeactivateSubscriptionOfferRequest $postBody
array $optParams

Optional parameters.

Return Value

SubscriptionOffer

Exceptions

Exception

at line 213
delete(string $packageName, string $productId, string $basePlanId, string $offerId, array $optParams = [])

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

Parameters

string $packageName

Required. The parent app (package name) of the offer to delete.
string $productId

Required. The parent subscription (ID) of the offer to delete.
string $basePlanId

Required. The parent base plan (ID) of the offer to delete.
string $offerId

Required. The unique offer ID of the offer to delete.
array $optParams

Optional parameters.

Exceptions

Exception

at line 233
SubscriptionOffer get(string $packageName, string $productId, string $basePlanId, string $offerId, array $optParams = [])

Reads a single offer (offers.get)

Parameters

string $packageName

Required. The parent app (package name) of the offer to get.
string $productId

Required. The parent subscription (ID) of the offer to get.
string $basePlanId

Required. The parent base plan (ID) of the offer to get.
string $offerId

Required. The unique offer ID of the offer to get.
array $optParams

Optional parameters.

Return Value

SubscriptionOffer

Exceptions

Exception

at line 265
ListSubscriptionOffersResponse listMonetizationSubscriptionsBasePlansOffers(string $packageName, string $productId, string $basePlanId, array $optParams = [])

Lists all offers under a given subscription.

(offers.listMonetizationSubscriptionsBasePlansOffers)

Parameters

string $packageName

Required. The parent app (package name) for which the subscriptions should be read.
string $productId

Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.
string $basePlanId

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 '-'.
array $optParams

Optional parameters.

Return Value

ListSubscriptionOffersResponse

Exceptions

Exception

at line 304
SubscriptionOffer patch(string $packageName, string $productId, string $basePlanId, string $offerId, SubscriptionOffer $postBody, array $optParams = [])

Updates an existing subscription offer. (offers.patch)

Parameters

string $packageName

Required. Immutable. The package name of the app the parent subscription belongs to.
string $productId

Required. Immutable. The ID of the parent subscription this offer belongs to.
string $basePlanId

Required. Immutable. The ID of the base plan to which this offer is an extension.
string $offerId

Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.
SubscriptionOffer $postBody
array $optParams

Optional parameters.

Return Value

SubscriptionOffer

Exceptions

Exception