Blame - docs/dyn/cloudchannel_v1.accounts.offers.html - platform/external/python/google-api-python-client

<h1><a href="cloudchannel_v1.html">Cloud Channel API</a> . <a href="cloudchannel_v1.accounts.html">accounts</a> . <a href="cloudchannel_v1.accounts.offers.html">offers</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#list">list(parent, filter=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

<h3>Method Details</h3>

87

88

<code class="details" id="close">close()</code>

89

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="list">list(parent, filter=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

94

<pre>Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

95

96

Args:

97

parent: string, Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}. (required)

98

filter: string, Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

99

languageCode: string, Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".

100

pageSize: integer, Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

101

pageToken: string, Optional. A token for a page of results other than the first page.

102

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

109

110

{ # Response message for ListOffers.

111

"nextPageToken": "A String", # A token to retrieve the next page of results.

112

"offers": [ # The list of Offers requested.

113

{ # Represents an offer made to resellers for purchase. An offer is associated with a Sku, has a plan for payment, a price, and defines the constraints for buying.

114

"constraints": { # Represents the constraints for buying the Offer. # Constraints on transacting the Offer.

115

"customerConstraints": { # Represents constraints required to purchase the Offer for a customer. # Represents constraints required to purchase the Offer for a customer.

116

"allowedCustomerTypes": [ # Allowed Customer Type.

117

"A String",

118

],

119

"allowedRegions": [ # Allowed geographical regions of the customer.

120

"A String",

121

],

122

"promotionalOrderTypes": [ # Allowed Promotional Order Type. Present for Promotional offers.

"A String",

],

},

},

"endTime": "A String", # Output only. End of the Offer validity time.

128

"marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the Offer.

129

"defaultLogo": { # Represents media information. # Default logo.

130

"content": "A String", # URL of the media.

131

"title": "A String", # Title of the media.

132

"type": "A String", # Type of the media.

133

},

134

"description": "A String", # Human readable description. Description can contain HTML.

135

"displayName": "A String", # Human readable name.

136

},

137

"name": "A String", # Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id}

138

"parameterDefinitions": [ # Parameters required to use current Offer to purchase.

139

{ # Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.

140

"allowedValues": [ # If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.

141

{ # Data type and value of a parameter.

142

"boolValue": True or False, # Represents a boolean value.

143

"doubleValue": 3.14, # Represents a double value.

144

"int64Value": "A String", # Represents an int64 value.

145

"protoValue": { # Represents an 'Any' proto value.

146

"a_key": "", # Properties of the object. Contains field @type with type URL.

147

},

148

"stringValue": "A String", # Represents a string value.

149

},

150

],

151

"maxValue": { # Data type and value of a parameter. # Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.

152

"boolValue": True or False, # Represents a boolean value.

153

"doubleValue": 3.14, # Represents a double value.

154

"int64Value": "A String", # Represents an int64 value.

155

"protoValue": { # Represents an 'Any' proto value.

156

"a_key": "", # Properties of the object. Contains field @type with type URL.

157

},

158

"stringValue": "A String", # Represents a string value.

159

},

160

"minValue": { # Data type and value of a parameter. # Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.

161

"boolValue": True or False, # Represents a boolean value.

162

"doubleValue": 3.14, # Represents a double value.

163

"int64Value": "A String", # Represents an int64 value.

164

"protoValue": { # Represents an 'Any' proto value.

165

"a_key": "", # Properties of the object. Contains field @type with type URL.

166

},

167

"stringValue": "A String", # Represents a string value.

168

},

169

"name": "A String", # Name of the parameter.

170

"optional": True or False, # If set to true, parameter is optional to purchase this Offer.

171

"parameterType": "A String", # Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.

172

},

173

],

174

"plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer.

175

"billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers.

176

"paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month.

177

"duration": 42, # Total duration of Period Type defined.

178

"periodType": "A String", # Period Type.

179

},

180

"paymentPlan": "A String", # Describes how a reseller will be billed.

181

"paymentType": "A String", # Specifies when the payment needs to happen.

182

"trialPeriod": { # Represents period in days/months/years. # Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period.

183

"duration": 42, # Total duration of Period Type defined.

184

"periodType": "A String", # Period Type.

185

},

186

},

187

"priceByResources": [ # Price for each monetizable resource type.

188

{ # Represents price by resource type.

189

"price": { # Represents the price of the Offer. # Price of the Offer. Present if there are no price phases.

190

"basePrice": { # Represents an amount of money with its currency type. # Base price.

191

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

192

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

193

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

194

},

195

"discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.

196

"effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts.

197

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

198

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

199

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

200

},

201

"externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card.

202

},

203

"pricePhases": [ # Specifies the price by time range.

204

{ # Specifies the price by the duration of months. For example, a 20% discount for the first six months, then a 10% discount starting on the seventh month.

205

"firstPeriod": 42, # Defines first period for the phase.

206

"lastPeriod": 42, # Defines first period for the phase.

207

"periodType": "A String", # Defines the phase period type.

208

"price": { # Represents the price of the Offer. # Price of the phase. Present if there are no price tiers.

209

"basePrice": { # Represents an amount of money with its currency type. # Base price.

210

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

211

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

212

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

213

},

214

"discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.

215

"effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts.

216

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

217

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

218

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

219

},

220

"externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card.

221

},

222

"priceTiers": [ # Price by the resource tiers.

223

{ # Defines price at resource tier level. For example, an offer with following definition : * Tier 1: Provide 25% discount for all seats between 1 and 25. * Tier 2: Provide 10% discount for all seats between 26 and 100. * Tier 3: Provide flat 15% discount for all seats above 100. Each of these tiers is represented as a PriceTier.

224

"firstResource": 42, # First resource for which the tier price applies.

225

"lastResource": 42, # Last resource for which the tier price applies.

226

"price": { # Represents the price of the Offer. # Price of the tier.

227

"basePrice": { # Represents an amount of money with its currency type. # Base price.

228

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

229

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

230

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

231

},

232

"discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2.

233

"effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts.

234

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

235

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

236

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

237

},

238

"externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card.

},

},

],

},

],

"resourceType": "A String", # Resource Type. Example: SEAT

245

},

246

],

247

"sku": { # Represents a product's purchasable Stock Keeping Unit (SKU). SKUs represent the different variations of the product. For example, Google Workspace Business Standard and Google Workspace Business Plus are Google Workspace product SKUs. # SKU the offer is associated with.

248

"marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the SKU.

249

"defaultLogo": { # Represents media information. # Default logo.

250

"content": "A String", # URL of the media.

251

"title": "A String", # Title of the media.

252

"type": "A String", # Type of the media.

253

},

254

"description": "A String", # Human readable description. Description can contain HTML.

255

"displayName": "A String", # Human readable name.

256

},

257

"name": "A String", # Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id}

258

"product": { # A Product is the entity a customer uses when placing an order. For example, Google Workspace, Google Voice, etc. # Product the SKU is associated with.

259

"marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the product.

260

"defaultLogo": { # Represents media information. # Default logo.

261

"content": "A String", # URL of the media.

262

"title": "A String", # Title of the media.

263

"type": "A String", # Type of the media.

264

},