REST Resource: partners.promotions

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

  • It includes details such as name, free trial duration, applicable regions and products, validity period, pricing details, and promotion type.

  • Partners can find eligible promotions and retrieve a list of available promotions, including free trials, using the provided methods.

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

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

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
introductoryPricingDetails

object (IntroductoryPricingDetails)

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

enum (PromotionType)

Output only. Specifies the type of the promotion.

Methods

findEligible

 Currently, it is only enabeld for YouTube.

list

 Currently, it doesn't support YouTube promotions.