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

Scopes

You will need authorization for the https://www.googleapis.com/auth/androidpublisher scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/androidpublisher. You can set the scope for this method like this: androidpublisher3 --scope <scope> monetization subscriptions-base-plans-offers-create ...

Required Scalar Arguments

  • <package-name> (string)
    • 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> (string)
    • 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> (string)
    • 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.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

SubscriptionOffer:
  base-plan-id: string
  offer-id: string
  other-regions-config:
    other-regions-new-subscriber-availability: boolean
  package-name: string
  product-id: string
  state: string
  targeting:
    acquisition-rule:
      scope:
        specific-subscription-in-app: string
    upgrade-rule:
      billing-period-duration: string
      once-per-user: boolean
      scope:
        specific-subscription-in-app: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . base-plan-id=et
    • Required. Immutable. The ID of the base plan to which this offer is an extension.
  • offer-id=at
    • Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.

  • other-regions-config other-regions-new-subscriber-availability=false

    • Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.

  • .. package-name=eirmod

    • Required. Immutable. The package name of the app the parent subscription belongs to.
  • product-id=lorem
    • Required. Immutable. The ID of the parent subscription this offer belongs to.
  • state=accusam
    • Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active.

  • targeting.acquisition-rule.scope specific-subscription-in-app=amet

    • The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.

  • ...upgrade-rule billing-period-duration=erat

    • The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched.
  • once-per-user=true
    • Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer.
  • scope specific-subscription-in-app=erat
    • The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p offer-id=string

    • 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.

  • -p regions-version-version=string

    • 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.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • 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.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • 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.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").