Payments Reseller Subscription API . partners . products

close()

Close httplib2 connections.

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

To retrieve the products that can be resold by the partner. It should be autenticated with a service account.

Args:
  parent: string, Required. The parent, the partner that can resell. Format: partners/{partner} (required)
  filter: string, Optional. Specifies the filters for the product results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`
  pageSize: integer, Optional. The maximum number of products 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 `ListProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProducts` 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:

    { # Response that contains the products.
  "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.
  "products": [ # The products for the specified partner.
    { # A Product resource that defines a subscription service that can be resold.
      "bundleDetails": { # Details for a bundle product. # Output only. Output Only. Specifies the details for a bundle product.
        "bundleElements": [ # The individual products that are included in the bundle.
          { # The individual product that is included in the bundle.
            "product": "A String", # Required. Output only. Product resource name that identifies the bundle element. The format is 'partners/{partner_id}/products/{product_id}'.
          },
        ],
        "entitlementMode": "A String", # The entitlement mode of the bundle product.
      },
      "finiteBillingCycleDetails": { # Details for a subscriptiin line item with finite billing cycles. # Optional. Details for a subscription line item with finite billing cycles. If unset, the line item will be charged indefinitely.
        "billingCycleCountLimit": "A String", # Required. The number of a subscription line item billing cycles after which billing will stop automatically.
      },
      "name": "A String", # Identifier. Response only. Resource name of the product. It will have the format of "partners/{partner_id}/products/{product_id}"
      "priceConfigs": [ # Output only. Price configs for the product in the available regions.
        { # Configs the prices in an available region.
          "amount": { # Describes the amount unit including the currency code. # Output only. The price in the region.
            "amountMicros": "A String", # Required. Amount in micros (1_000_000 micros = 1 currency unit)
            "currencyCode": "A String", # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
          },
          "regionCode": "A String", # Output only. 2-letter ISO region code where the product is available in. Ex. "US".
        },
      ],
      "productType": "A String", # Output only. Output Only. Specifies the type of the product.
      "regionCodes": [ # Output only. 2-letter ISO region code where the product is available in. Ex. "US" Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1
        "A String",
      ],
      "subscriptionBillingCycleDuration": { # Describes the length of a period of a time. # Output only. Specifies the length of the billing cycle of the subscription.
        "count": 42, # number of duration units to be included.
        "unit": "A String", # The unit used for the duration
      },
      "titles": [ # Output only. Localized human readable name of the product.
        { # 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()

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.