REST Resource: partners.promotions

Resource: Promotion

A Promotion resource that defines a promotion for a subscription that can be resold.

JSON representation
{
  "name": string,
  "titles": [
    {
      object (LocalizedText)
    }
  ],
  "freeTrialDuration": {
    object (Duration)
  },
  "regionCodes": [
    string
  ],
  "applicableProducts": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "introductoryPricingDetails": {
    object (IntroductoryPricingDetails)
  },
  "promotionType": enum (PromotionType)
}
Fields
name

string

Output only. Response only. Resource name of the subscription promotion. It will have the format of "partners/{partner_id}/promotion/{promotion_id}"

titles[]

object (LocalizedText)

Output only. Localized human readable name of the promotion.

freeTrialDuration

object (Duration)

Optional. Specifies the duration of the free trial of the subscription when promotionType is PROMOTION_TYPE_FREE_TRIAL

regionCodes[]

string

Output only. 2-letter ISO region code where the promotion is available in. Ex. "US" Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1

applicableProducts[]

string

Output only. The product ids this promotion can be applied to.

startTime

string (Timestamp format)

Optional. Specifies the start time (inclusive) of the period that the promotion is available in.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

introductoryPricingDetails

object (IntroductoryPricingDetails)

Optional. Specifies the introductory pricing details when the promotionType is PROMOTION_TYPE_INTRODUCTORY_PRICING.

promotionType

enum (PromotionType)

Output only. Output Only. Specifies the type of the promotion.

Methods

findEligible

To find eligible promotions for the current user.

list

To retrieve the promotions, such as free trial, that can be used by the partner.