Payments Reseller Subscription API . partners . promotions

close()

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Used by partners to list promotions, such as free trial, that can be applied on subscriptions. It should be called directly by the partner using service accounts.

Args:
  parent: string, Required. The parent, the partner that can resell. Format: partners/{partner} (required)
  filter: string, Optional. Specifies the filters for the promotion results. The syntax defined in the EBNF grammar: https://google.aip.dev/assets/misc/ebnf-filtering.txt. Examples: - applicable_products: "sku1" - region_codes: "US" - applicable_products: "sku1" AND region_codes: "US"
  pageSize: integer, Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListPromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotions` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
  "promotions": [ # The promotions for the specified partner.
    { # A Promotion resource that defines a promotion for a subscription that can be resold.
      "applicableProducts": [ # Output only. The product ids this promotion can be applied to.
        "A String",
      ],
      "endTime": "A String", # Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely.
      "freeTrialDuration": { # Describes the length of a period of a time. # Optional. Specifies the duration of the free trial of the subscription when promotion_type is PROMOTION_TYPE_FREE_TRIAL
        "count": 42, # number of duration units to be included.
        "unit": "A String", # The unit used for the duration
      },
      "introductoryPricingDetails": { # The details of a introductory pricing promotion. # Optional. Specifies the introductory pricing details when the promotion_type is PROMOTION_TYPE_INTRODUCTORY_PRICING.
        "introductoryPricingSpecs": [ # Specifies the introductory pricing periods.
          { # The duration of an introductory pricing promotion.
            "recurrenceCount": 42, # Output only. Output Only. The duration of an introductory offer in billing cycles.
          },
        ],
      },
      "name": "A String", # Output only. Response only. Resource name of the subscription promotion. It will have the format of "partners/{partner_id}/promotion/{promotion_id}"
      "promotionType": "A String", # Output only. Output Only. Specifies the type of the promotion.
      "regionCodes": [ # 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
        "A String",
      ],
      "startTime": "A String", # Optional. Specifies the start time (inclusive) of the period that the promotion is available in.
      "titles": [ # Output only. Localized human readable name of the promotion.
        { # Localized variant of a text in a particular language.
          "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
          "text": "A String", # Localized string in the language corresponding to `language_code' below.
        },
      ],
    },
  ],
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.