File: paymentsresellersubscription_v1.partners.products.html

package info (click to toggle)
python-googleapi 2.186.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 553,432 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (167 lines) | stat: -rw-r--r-- 7,838 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="paymentsresellersubscription_v1.html">Payments Reseller Subscription API</a> . <a href="paymentsresellersubscription_v1.partners.html">partners</a> . <a href="paymentsresellersubscription_v1.partners.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Currently, it doesn't support **YouTube** products. Retrieves the products that can be resold by the partner. It should be autenticated with a service account.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Currently, it doesn&#x27;t support **YouTube** products. Retrieves 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.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
  &quot;products&quot;: [ # The products for the specified partner.
    { # A Product resource that defines a subscription service that can be resold.
      &quot;bundleDetails&quot;: { # Details for a bundle product. # Output only. Specifies the details for a bundle product.
        &quot;bundleElements&quot;: [ # The individual products that are included in the bundle.
          { # The individual product that is included in the bundle.
            &quot;product&quot;: &quot;A String&quot;, # Required. Output only. Product resource name that identifies the bundle element. The format is &#x27;partners/{partner_id}/products/{product_id}&#x27;.
          },
        ],
        &quot;entitlementMode&quot;: &quot;A String&quot;, # The entitlement mode of the bundle product.
      },
      &quot;finiteBillingCycleDetails&quot;: { # 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.
        &quot;billingCycleCountLimit&quot;: &quot;A String&quot;, # Required. The number of a subscription line item billing cycles after which billing will stop automatically.
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Response only. Resource name of the product. It will have the format of &quot;partners/{partner_id}/products/{product_id}&quot;
      &quot;priceConfigs&quot;: [ # Output only. Price configs for the product in the available regions.
        { # Configs the prices in an available region.
          &quot;amount&quot;: { # Describes the amount unit including the currency code. # Output only. The price in the region.
            &quot;amountMicros&quot;: &quot;A String&quot;, # Required. Amount in micros (1_000_000 micros = 1 currency unit)
            &quot;currencyCode&quot;: &quot;A String&quot;, # Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
          },
          &quot;regionCode&quot;: &quot;A String&quot;, # Output only. 2-letter ISO region code where the product is available in. Ex. &quot;US&quot;.
        },
      ],
      &quot;productType&quot;: &quot;A String&quot;, # Output only. Specifies the type of the product.
      &quot;regionCodes&quot;: [ # Output only. 2-letter ISO region code where the product is available in. Ex. &quot;US&quot; Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1
        &quot;A String&quot;,
      ],
      &quot;subscriptionBillingCycleDuration&quot;: { # Describes the length of a period of a time. # Output only. Specifies the length of the billing cycle of the subscription.
        &quot;count&quot;: 42, # number of duration units to be included.
        &quot;unit&quot;: &quot;A String&quot;, # The unit used for the duration
      },
      &quot;titles&quot;: [ # Output only. Localized human readable name of the product.
        { # Localized variant of a text in a particular language.
          &quot;languageCode&quot;: &quot;A String&quot;, # The text&#x27;s BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
          &quot;text&quot;: &quot;A String&quot;, # Localized string in the language corresponding to language_code below.
        },
      ],
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>