| <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="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> |
| <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, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</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, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid. |
| |
| Args: |
| parent: string, Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}. (required) |
| 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 |
| 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". |
| 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. |
| pageToken: string, Optional. A token for a page of results other than the first page. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListOffers. |
| "nextPageToken": "A String", # A token to retrieve the next page of results. |
| "offers": [ # The list of Offers requested. |
| { # 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. |
| "constraints": { # Represents the constraints for buying the Offer. # Constraints on transacting the Offer. |
| "customerConstraints": { # Represents constraints required to purchase the Offer for a customer. # Represents constraints required to purchase the Offer for a customer. |
| "allowedCustomerTypes": [ # Allowed Customer Type. |
| "A String", |
| ], |
| "allowedRegions": [ # Allowed geographical regions of the customer. |
| "A String", |
| ], |
| "promotionalOrderTypes": [ # Allowed Promotional Order Type. Present for Promotional offers. |
| "A String", |
| ], |
| }, |
| }, |
| "endTime": "A String", # Output only. End of the Offer validity time. |
| "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the Offer. |
| "defaultLogo": { # Represents media information. # Default logo. |
| "content": "A String", # URL of the media. |
| "title": "A String", # Title of the media. |
| "type": "A String", # Type of the media. |
| }, |
| "description": "A String", # Human readable description. Description can contain HTML. |
| "displayName": "A String", # Human readable name. |
| }, |
| "name": "A String", # Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id} |
| "parameterDefinitions": [ # Parameters required to use current Offer to purchase. |
| { # Parameter's definition. Specifies what parameter is required to use the current Offer to purchase. |
| "allowedValues": [ # If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type. |
| { # Data type and value of a parameter. |
| "boolValue": True or False, # Represents a boolean value. |
| "doubleValue": 3.14, # Represents a double value. |
| "int64Value": "A String", # Represents an int64 value. |
| "protoValue": { # Represents an 'Any' proto value. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "stringValue": "A String", # Represents a string value. |
| }, |
| ], |
| "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. |
| "boolValue": True or False, # Represents a boolean value. |
| "doubleValue": 3.14, # Represents a double value. |
| "int64Value": "A String", # Represents an int64 value. |
| "protoValue": { # Represents an 'Any' proto value. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "stringValue": "A String", # Represents a string value. |
| }, |
| "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. |
| "boolValue": True or False, # Represents a boolean value. |
| "doubleValue": 3.14, # Represents a double value. |
| "int64Value": "A String", # Represents an int64 value. |
| "protoValue": { # Represents an 'Any' proto value. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "stringValue": "A String", # Represents a string value. |
| }, |
| "name": "A String", # Name of the parameter. |
| "optional": True or False, # If set to true, parameter is optional to purchase this Offer. |
| "parameterType": "A String", # Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here. |
| }, |
| ], |
| "plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer. |
| "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers. |
| "paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month. |
| "duration": 42, # Total duration of Period Type defined. |
| "periodType": "A String", # Period Type. |
| }, |
| "paymentPlan": "A String", # Describes how a reseller will be billed. |
| "paymentType": "A String", # Specifies when the payment needs to happen. |
| "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. |
| "duration": 42, # Total duration of Period Type defined. |
| "periodType": "A String", # Period Type. |
| }, |
| }, |
| "priceByResources": [ # Price for each monetizable resource type. |
| { # Represents price by resource type. |
| "price": { # Represents the price of the Offer. # Price of the Offer. Present if there are no price phases. |
| "basePrice": { # Represents an amount of money with its currency type. # Base price. |
| "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. |
| "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. |
| "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| }, |
| "discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2. |
| "effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts. |
| "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. |
| "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. |
| "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| }, |
| "externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card. |
| }, |
| "pricePhases": [ # Specifies the price by time range. |
| { # 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. |
| "firstPeriod": 42, # Defines first period for the phase. |
| "lastPeriod": 42, # Defines first period for the phase. |
| "periodType": "A String", # Defines the phase period type. |
| "price": { # Represents the price of the Offer. # Price of the phase. Present if there are no price tiers. |
| "basePrice": { # Represents an amount of money with its currency type. # Base price. |
| "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. |
| "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. |
| "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| }, |
| "discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2. |
| "effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts. |
| "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. |
| "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. |
| "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| }, |
| "externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card. |
| }, |
| "priceTiers": [ # Price by the resource tiers. |
| { # 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. |
| "firstResource": 42, # First resource for which the tier price applies. |
| "lastResource": 42, # Last resource for which the tier price applies. |
| "price": { # Represents the price of the Offer. # Price of the tier. |
| "basePrice": { # Represents an amount of money with its currency type. # Base price. |
| "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. |
| "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. |
| "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| }, |
| "discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2. |
| "effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts. |
| "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. |
| "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. |
| "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| }, |
| "externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card. |
| }, |
| }, |
| ], |
| }, |
| ], |
| "resourceType": "A String", # Resource Type. Example: SEAT |
| }, |
| ], |
| "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. |
| "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the SKU. |
| "defaultLogo": { # Represents media information. # Default logo. |
| "content": "A String", # URL of the media. |
| "title": "A String", # Title of the media. |
| "type": "A String", # Type of the media. |
| }, |
| "description": "A String", # Human readable description. Description can contain HTML. |
| "displayName": "A String", # Human readable name. |
| }, |
| "name": "A String", # Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id} |
| "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. |
| "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the product. |
| "defaultLogo": { # Represents media information. # Default logo. |
| "content": "A String", # URL of the media. |
| "title": "A String", # Title of the media. |
| "type": "A String", # Type of the media. |
| }, |
| "description": "A String", # Human readable description. Description can contain HTML. |
| "displayName": "A String", # Human readable name. |
| }, |
| "name": "A String", # Resource Name of the Product. Format: products/{product_id} |
| }, |
| }, |
| "startTime": "A String", # Start of the Offer validity time. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</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 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |