1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudchannel_v1.html">Cloud Channel API</a> . <a href="cloudchannel_v1.accounts.html">accounts</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="cloudchannel_v1.accounts.channelPartnerLinks.html">channelPartnerLinks()</a></code> 79</p> 80<p class="firstline">Returns the channelPartnerLinks Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="cloudchannel_v1.accounts.customers.html">customers()</a></code> 84</p> 85<p class="firstline">Returns the customers Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="cloudchannel_v1.accounts.offers.html">offers()</a></code> 89</p> 90<p class="firstline">Returns the offers Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="#checkCloudIdentityAccountsExist">checkCloudIdentityAccountsExist(parent, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.</p> 95<p class="toc_element"> 96 <code><a href="#close">close()</a></code></p> 97<p class="firstline">Close httplib2 connections.</p> 98<p class="toc_element"> 99 <code><a href="#listSubscribers">listSubscribers(account, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.</p> 101<p class="toc_element"> 102 <code><a href="#listSubscribers_next">listSubscribers_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#listTransferableOffers">listTransferableOffers(parent, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU.</p> 107<p class="toc_element"> 108 <code><a href="#listTransferableOffers_next">listTransferableOffers_next(previous_request, previous_response)</a></code></p> 109<p class="firstline">Retrieves the next page of results.</p> 110<p class="toc_element"> 111 <code><a href="#listTransferableSkus">listTransferableSkus(parent, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's TransferableSku.</p> 113<p class="toc_element"> 114 <code><a href="#listTransferableSkus_next">listTransferableSkus_next(previous_request, previous_response)</a></code></p> 115<p class="firstline">Retrieves the next page of results.</p> 116<p class="toc_element"> 117 <code><a href="#register">register(account, body=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.</p> 119<p class="toc_element"> 120 <code><a href="#unregister">unregister(account, body=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.</p> 122<h3>Method Details</h3> 123<div class="method"> 124 <code class="details" id="checkCloudIdentityAccountsExist">checkCloudIdentityAccountsExist(parent, body=None, x__xgafv=None)</code> 125 <pre>Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain. 126 127Args: 128 parent: string, Required. The reseller account's resource name. Parent uses the format: accounts/{account_id} (required) 129 body: object, The request body. 130 The object takes the form of: 131 132{ # Request message for CloudChannelService.CheckCloudIdentityAccountsExist. 133 "domain": "A String", # Required. Domain to fetch for Cloud Identity account customer. 134} 135 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # Response message for CloudChannelService.CheckCloudIdentityAccountsExist. 145 "cloudIdentityAccounts": [ # The Cloud Identity accounts associated with the domain. 146 { # Entity representing a Cloud Identity account that may be associated with a Channel Services API partner. 147 "customerCloudIdentityId": "A String", # If existing = true, the Cloud Identity ID of the customer. 148 "customerName": "A String", # If owned = true, the name of the customer that owns the Cloud Identity account. Customer_name uses the format: accounts/{account_id}/customers/{customer_id} 149 "existing": True or False, # Returns true if a Cloud Identity account exists for a specific domain. 150 "owned": True or False, # Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner. 151 }, 152 ], 153}</pre> 154</div> 155 156<div class="method"> 157 <code class="details" id="close">close()</code> 158 <pre>Close httplib2 connections.</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="listSubscribers">listSubscribers(account, pageSize=None, pageToken=None, x__xgafv=None)</code> 163 <pre>Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses. 164 165Args: 166 account: string, Required. Resource name of the account. (required) 167 pageSize: integer, Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000. 168 pageToken: string, Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token. 169 x__xgafv: string, V1 error format. 170 Allowed values 171 1 - v1 error format 172 2 - v2 error format 173 174Returns: 175 An object of the form: 176 177 { # Response Message for ListSubscribers. 178 "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 179 "serviceAccounts": [ # List of service accounts which have subscriber access to the topic. 180 "A String", 181 ], 182 "topic": "A String", # Name of the topic registered with the reseller. 183}</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="listSubscribers_next">listSubscribers_next(previous_request, previous_response)</code> 188 <pre>Retrieves the next page of results. 189 190Args: 191 previous_request: The request for the previous page. (required) 192 previous_response: The response from the request for the previous page. (required) 193 194Returns: 195 A request object that you can call 'execute()' on to request the next 196 page. Returns None if there are no more items in the collection. 197 </pre> 198</div> 199 200<div class="method"> 201 <code class="details" id="listTransferableOffers">listTransferableOffers(parent, body=None, x__xgafv=None)</code> 202 <pre>List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of TransferableOffer for the given customer and SKU. 203 204Args: 205 parent: string, Required. The resource name of the reseller's account. (required) 206 body: object, The request body. 207 The object takes the form of: 208 209{ # Request message for CloudChannelService.ListTransferableOffers 210 "cloudIdentityId": "A String", # Customer's Cloud Identity ID 211 "customerName": "A String", # A reseller should create a customer and use the resource name of that customer here. 212 "languageCode": "A String", # 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". 213 "pageSize": 42, # Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 offers. The maximum value is 1000; the server will coerce values above 1000. 214 "pageToken": "A String", # A token for a page of results other than the first page. Obtained using ListTransferableOffersResponse.next_page_token of the previous CloudChannelService.ListTransferableOffers call. 215 "sku": "A String", # Required. The SKU to look up Offers for. 216} 217 218 x__xgafv: string, V1 error format. 219 Allowed values 220 1 - v1 error format 221 2 - v2 error format 222 223Returns: 224 An object of the form: 225 226 { # Response message for CloudChannelService.ListTransferableOffers. 227 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListTransferableOffersRequest.page_token to obtain that page. 228 "transferableOffers": [ # Information about Offers for a customer that can be used for transfer. 229 { # TransferableOffer represents an Offer that can be used in Transfer. Read-only. 230 "offer": { # 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. # Offer with parameter constraints updated to allow the Transfer. 231 "constraints": { # Represents the constraints for buying the Offer. # Constraints on transacting the Offer. 232 "customerConstraints": { # Represents constraints required to purchase the Offer for a customer. # Represents constraints required to purchase the Offer for a customer. 233 "allowedCustomerTypes": [ # Allowed Customer Type. 234 "A String", 235 ], 236 "allowedRegions": [ # Allowed geographical regions of the customer. 237 "A String", 238 ], 239 "promotionalOrderTypes": [ # Allowed Promotional Order Type. Present for Promotional offers. 240 "A String", 241 ], 242 }, 243 }, 244 "endTime": "A String", # Output only. End of the Offer validity time. 245 "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the Offer. 246 "defaultLogo": { # Represents media information. # Default logo. 247 "content": "A String", # URL of the media. 248 "title": "A String", # Title of the media. 249 "type": "A String", # Type of the media. 250 }, 251 "description": "A String", # Human readable description. Description can contain HTML. 252 "displayName": "A String", # Human readable name. 253 }, 254 "name": "A String", # Resource Name of the Offer. Format: accounts/{account_id}/offers/{offer_id} 255 "parameterDefinitions": [ # Parameters required to use current Offer to purchase. 256 { # Parameter's definition. Specifies what parameter is required to use the current Offer to purchase. 257 "allowedValues": [ # If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type. 258 { # Data type and value of a parameter. 259 "boolValue": True or False, # Represents a boolean value. 260 "doubleValue": 3.14, # Represents a double value. 261 "int64Value": "A String", # Represents an int64 value. 262 "protoValue": { # Represents an 'Any' proto value. 263 "a_key": "", # Properties of the object. Contains field @type with type URL. 264 }, 265 "stringValue": "A String", # Represents a string value. 266 }, 267 ], 268 "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. 269 "boolValue": True or False, # Represents a boolean value. 270 "doubleValue": 3.14, # Represents a double value. 271 "int64Value": "A String", # Represents an int64 value. 272 "protoValue": { # Represents an 'Any' proto value. 273 "a_key": "", # Properties of the object. Contains field @type with type URL. 274 }, 275 "stringValue": "A String", # Represents a string value. 276 }, 277 "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. 278 "boolValue": True or False, # Represents a boolean value. 279 "doubleValue": 3.14, # Represents a double value. 280 "int64Value": "A String", # Represents an int64 value. 281 "protoValue": { # Represents an 'Any' proto value. 282 "a_key": "", # Properties of the object. Contains field @type with type URL. 283 }, 284 "stringValue": "A String", # Represents a string value. 285 }, 286 "name": "A String", # Name of the parameter. 287 "optional": True or False, # If set to true, parameter is optional to purchase this Offer. 288 "parameterType": "A String", # Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here. 289 }, 290 ], 291 "plan": { # The payment plan for the Offer. Describes how to make a payment. # Describes the payment plan for the Offer. 292 "billingAccount": "A String", # Reseller Billing account to charge after an offer transaction. Only present for Google Cloud Platform offers. 293 "paymentCycle": { # Represents period in days/months/years. # Describes how frequently the reseller will be billed, such as once per month. 294 "duration": 42, # Total duration of Period Type defined. 295 "periodType": "A String", # Period Type. 296 }, 297 "paymentPlan": "A String", # Describes how a reseller will be billed. 298 "paymentType": "A String", # Specifies when the payment needs to happen. 299 "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. 300 "duration": 42, # Total duration of Period Type defined. 301 "periodType": "A String", # Period Type. 302 }, 303 }, 304 "priceByResources": [ # Price for each monetizable resource type. 305 { # Represents price by resource type. 306 "price": { # Represents the price of the Offer. # Price of the Offer. Present if there are no price phases. 307 "basePrice": { # Represents an amount of money with its currency type. # Base price. 308 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 309 "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. 310 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 311 }, 312 "discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2. 313 "effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts. 314 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 315 "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. 316 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 317 }, 318 "externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card. 319 }, 320 "pricePhases": [ # Specifies the price by time range. 321 { # 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. 322 "firstPeriod": 42, # Defines first period for the phase. 323 "lastPeriod": 42, # Defines first period for the phase. 324 "periodType": "A String", # Defines the phase period type. 325 "price": { # Represents the price of the Offer. # Price of the phase. Present if there are no price tiers. 326 "basePrice": { # Represents an amount of money with its currency type. # Base price. 327 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 328 "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. 329 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 330 }, 331 "discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2. 332 "effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts. 333 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 334 "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. 335 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 336 }, 337 "externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card. 338 }, 339 "priceTiers": [ # Price by the resource tiers. 340 { # 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. 341 "firstResource": 42, # First resource for which the tier price applies. 342 "lastResource": 42, # Last resource for which the tier price applies. 343 "price": { # Represents the price of the Offer. # Price of the tier. 344 "basePrice": { # Represents an amount of money with its currency type. # Base price. 345 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 346 "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. 347 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 348 }, 349 "discount": 3.14, # Discount percentage, represented as decimal. For example, a 20% discount will be represent as 0.2. 350 "effectivePrice": { # Represents an amount of money with its currency type. # Effective Price after applying the discounts. 351 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 352 "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. 353 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 354 }, 355 "externalPriceUri": "A String", # Link to external price list, such as link to Google Voice rate card. 356 }, 357 }, 358 ], 359 }, 360 ], 361 "resourceType": "A String", # Resource Type. Example: SEAT 362 }, 363 ], 364 "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. 365 "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the SKU. 366 "defaultLogo": { # Represents media information. # Default logo. 367 "content": "A String", # URL of the media. 368 "title": "A String", # Title of the media. 369 "type": "A String", # Type of the media. 370 }, 371 "description": "A String", # Human readable description. Description can contain HTML. 372 "displayName": "A String", # Human readable name. 373 }, 374 "name": "A String", # Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id} 375 "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. 376 "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the product. 377 "defaultLogo": { # Represents media information. # Default logo. 378 "content": "A String", # URL of the media. 379 "title": "A String", # Title of the media. 380 "type": "A String", # Type of the media. 381 }, 382 "description": "A String", # Human readable description. Description can contain HTML. 383 "displayName": "A String", # Human readable name. 384 }, 385 "name": "A String", # Resource Name of the Product. Format: products/{product_id} 386 }, 387 }, 388 "startTime": "A String", # Start of the Offer validity time. 389 }, 390 }, 391 ], 392}</pre> 393</div> 394 395<div class="method"> 396 <code class="details" id="listTransferableOffers_next">listTransferableOffers_next(previous_request, previous_response)</code> 397 <pre>Retrieves the next page of results. 398 399Args: 400 previous_request: The request for the previous page. (required) 401 previous_response: The response from the request for the previous page. (required) 402 403Returns: 404 A request object that you can call 'execute()' on to request the next 405 page. Returns None if there are no more items in the collection. 406 </pre> 407</div> 408 409<div class="method"> 410 <code class="details" id="listTransferableSkus">listTransferableSkus(parent, body=None, x__xgafv=None)</code> 411 <pre>List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's TransferableSku. 412 413Args: 414 parent: string, Required. The reseller account's resource name. Parent uses the format: accounts/{account_id} (required) 415 body: object, The request body. 416 The object takes the form of: 417 418{ # Request message for CloudChannelService.ListTransferableSkus 419 "authToken": "A String", # The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details. 420 "cloudIdentityId": "A String", # Customer's Cloud Identity ID 421 "customerName": "A String", # A reseller is required to create a customer and use the resource name of the created customer here. Customer_name uses the format: accounts/{account_id}/customers/{customer_id} 422 "languageCode": "A String", # 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". Optional. 423 "pageSize": 42, # The requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000. Optional. 424 "pageToken": "A String", # A token for a page of results other than the first page. Obtained using ListTransferableSkusResponse.next_page_token of the previous CloudChannelService.ListTransferableSkus call. Optional. 425} 426 427 x__xgafv: string, V1 error format. 428 Allowed values 429 1 - v1 error format 430 2 - v2 error format 431 432Returns: 433 An object of the form: 434 435 { # Response message for CloudChannelService.ListTransferableSkus. 436 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListTransferableSkusRequest.page_token to obtain that page. 437 "transferableSkus": [ # Information about existing SKUs for a customer that needs a transfer. 438 { # TransferableSku represents information a reseller needs to view existing provisioned services for a customer that they do not own. Read-only. 439 "legacySku": { # 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. # Optional. The customer to transfer has an entitlement with the populated legacy SKU. 440 "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the SKU. 441 "defaultLogo": { # Represents media information. # Default logo. 442 "content": "A String", # URL of the media. 443 "title": "A String", # Title of the media. 444 "type": "A String", # Type of the media. 445 }, 446 "description": "A String", # Human readable description. Description can contain HTML. 447 "displayName": "A String", # Human readable name. 448 }, 449 "name": "A String", # Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id} 450 "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. 451 "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the product. 452 "defaultLogo": { # Represents media information. # Default logo. 453 "content": "A String", # URL of the media. 454 "title": "A String", # Title of the media. 455 "type": "A String", # Type of the media. 456 }, 457 "description": "A String", # Human readable description. Description can contain HTML. 458 "displayName": "A String", # Human readable name. 459 }, 460 "name": "A String", # Resource Name of the Product. Format: products/{product_id} 461 }, 462 }, 463 "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. # The SKU pertaining to the provisioning resource as specified in the Offer. 464 "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the SKU. 465 "defaultLogo": { # Represents media information. # Default logo. 466 "content": "A String", # URL of the media. 467 "title": "A String", # Title of the media. 468 "type": "A String", # Type of the media. 469 }, 470 "description": "A String", # Human readable description. Description can contain HTML. 471 "displayName": "A String", # Human readable name. 472 }, 473 "name": "A String", # Resource Name of the SKU. Format: products/{product_id}/skus/{sku_id} 474 "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. 475 "marketingInfo": { # Represents the marketing information for a Product, SKU or Offer. # Marketing information for the product. 476 "defaultLogo": { # Represents media information. # Default logo. 477 "content": "A String", # URL of the media. 478 "title": "A String", # Title of the media. 479 "type": "A String", # Type of the media. 480 }, 481 "description": "A String", # Human readable description. Description can contain HTML. 482 "displayName": "A String", # Human readable name. 483 }, 484 "name": "A String", # Resource Name of the Product. Format: products/{product_id} 485 }, 486 }, 487 "transferEligibility": { # Specifies transfer eligibility of a SKU. # Describes the transfer eligibility of a SKU. 488 "description": "A String", # Localized description if reseller is not eligible to transfer the SKU. 489 "ineligibilityReason": "A String", # Specified the reason for ineligibility. 490 "isEligible": True or False, # Whether reseller is eligible to transfer the SKU. 491 }, 492 }, 493 ], 494}</pre> 495</div> 496 497<div class="method"> 498 <code class="details" id="listTransferableSkus_next">listTransferableSkus_next(previous_request, previous_response)</code> 499 <pre>Retrieves the next page of results. 500 501Args: 502 previous_request: The request for the previous page. (required) 503 previous_response: The response from the request for the previous page. (required) 504 505Returns: 506 A request object that you can call 'execute()' on to request the next 507 page. Returns None if there are no more items in the collection. 508 </pre> 509</div> 510 511<div class="method"> 512 <code class="details" id="register">register(account, body=None, x__xgafv=None)</code> 513 <pre>Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address. 514 515Args: 516 account: string, Required. Resource name of the account. (required) 517 body: object, The request body. 518 The object takes the form of: 519 520{ # Request Message for RegisterSubscriber. 521 "serviceAccount": "A String", # Required. Service account that provides subscriber access to the registered topic. 522} 523 524 x__xgafv: string, V1 error format. 525 Allowed values 526 1 - v1 error format 527 2 - v2 error format 528 529Returns: 530 An object of the form: 531 532 { # Response Message for RegisterSubscriber. 533 "topic": "A String", # Name of the topic the subscriber will listen to. 534}</pre> 535</div> 536 537<div class="method"> 538 <code class="details" id="unregister">unregister(account, body=None, x__xgafv=None)</code> 539 <pre>Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic. 540 541Args: 542 account: string, Required. Resource name of the account. (required) 543 body: object, The request body. 544 The object takes the form of: 545 546{ # Request Message for UnregisterSubscriber. 547 "serviceAccount": "A String", # Required. Service account to unregister from subscriber access to the topic. 548} 549 550 x__xgafv: string, V1 error format. 551 Allowed values 552 1 - v1 error format 553 2 - v2 error format 554 555Returns: 556 An object of the form: 557 558 { # Response Message for UnregisterSubscriber. 559 "topic": "A String", # Name of the topic the service account subscriber access was removed from. 560}</pre> 561</div> 562 563</body></html>