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> . <a href="cloudchannel_v1.accounts.channelPartnerLinks.html">channelPartnerLinks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="cloudchannel_v1.accounts.channelPartnerLinks.customers.html">customers()</a></code> 79</p> 80<p class="firstline">Returns the customers Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. 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. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * 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 new ChannelPartnerLink resource.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. 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. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 93<p class="firstline">List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. 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. Return value: The list of the distributor account's ChannelPartnerLink resources.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<p class="toc_element"> 98 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. 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. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * 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 updated ChannelPartnerLink resource.</p> 100<h3>Method Details</h3> 101<div class="method"> 102 <code class="details" id="close">close()</code> 103 <pre>Close httplib2 connections.</pre> 104</div> 105 106<div class="method"> 107 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 108 <pre>Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. 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. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * 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 new ChannelPartnerLink resource. 109 110Args: 111 parent: string, Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id} (required) 112 body: object, The request body. 113 The object takes the form of: 114 115{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. 116 "channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR). 117 "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. 118 "alternateEmail": "A String", # The alternate email. 119 "customerType": "A String", # CustomerType indicates verification type needed for using services. 120 "eduData": { # Required Edu Attributes # Edu information about the customer. 121 "instituteSize": "A String", # Size of the institute. 122 "instituteType": "A String", # Designated institute type of customer. 123 "website": "A String", # Web address for the edu customer's institution. 124 }, 125 "isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. 126 "languageCode": "A String", # Language code. 127 "phoneNumber": "A String", # Phone number associated with the Cloud Identity. 128 "primaryDomain": "A String", # Output only. The primary domain name. 129 }, 130 "createTime": "A String", # Output only. Timestamp of when the channel partner link is created. 131 "inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation. 132 "linkState": "A String", # Required. State of the channel partner link. 133 "name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. 134 "publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. 135 "resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller. 136 "updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated. 137} 138 139 x__xgafv: string, V1 error format. 140 Allowed values 141 1 - v1 error format 142 2 - v2 error format 143 144Returns: 145 An object of the form: 146 147 { # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. 148 "channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR). 149 "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. 150 "alternateEmail": "A String", # The alternate email. 151 "customerType": "A String", # CustomerType indicates verification type needed for using services. 152 "eduData": { # Required Edu Attributes # Edu information about the customer. 153 "instituteSize": "A String", # Size of the institute. 154 "instituteType": "A String", # Designated institute type of customer. 155 "website": "A String", # Web address for the edu customer's institution. 156 }, 157 "isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. 158 "languageCode": "A String", # Language code. 159 "phoneNumber": "A String", # Phone number associated with the Cloud Identity. 160 "primaryDomain": "A String", # Output only. The primary domain name. 161 }, 162 "createTime": "A String", # Output only. Timestamp of when the channel partner link is created. 163 "inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation. 164 "linkState": "A String", # Required. State of the channel partner link. 165 "name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. 166 "publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. 167 "resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller. 168 "updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated. 169}</pre> 170</div> 171 172<div class="method"> 173 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> 174 <pre>Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. 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. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource. 175 176Args: 177 name: string, Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner. (required) 178 view: string, Optional. The level of granularity the ChannelPartnerLink will display. 179 Allowed values 180 UNSPECIFIED - The default / unset value. The API will default to the BASIC view. 181 BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info. 182 FULL - Includes all fields. 183 x__xgafv: string, V1 error format. 184 Allowed values 185 1 - v1 error format 186 2 - v2 error format 187 188Returns: 189 An object of the form: 190 191 { # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. 192 "channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR). 193 "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. 194 "alternateEmail": "A String", # The alternate email. 195 "customerType": "A String", # CustomerType indicates verification type needed for using services. 196 "eduData": { # Required Edu Attributes # Edu information about the customer. 197 "instituteSize": "A String", # Size of the institute. 198 "instituteType": "A String", # Designated institute type of customer. 199 "website": "A String", # Web address for the edu customer's institution. 200 }, 201 "isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. 202 "languageCode": "A String", # Language code. 203 "phoneNumber": "A String", # Phone number associated with the Cloud Identity. 204 "primaryDomain": "A String", # Output only. The primary domain name. 205 }, 206 "createTime": "A String", # Output only. Timestamp of when the channel partner link is created. 207 "inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation. 208 "linkState": "A String", # Required. State of the channel partner link. 209 "name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. 210 "publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. 211 "resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller. 212 "updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated. 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 218 <pre>List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. 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. Return value: The list of the distributor account's ChannelPartnerLink resources. 219 220Args: 221 parent: string, Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id} (required) 222 pageSize: integer, Optional. Requested page size. Server might return fewer results than requested. If unspecified, server will pick a default size (25). The maximum value is 200; the server will coerce values above 200. 223 pageToken: string, Optional. A token for a page of results other than the first page. Obtained using ListChannelPartnerLinksResponse.next_page_token of the previous CloudChannelService.ListChannelPartnerLinks call. 224 view: string, Optional. The level of granularity the ChannelPartnerLink will display. 225 Allowed values 226 UNSPECIFIED - The default / unset value. The API will default to the BASIC view. 227 BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info. 228 FULL - Includes all fields. 229 x__xgafv: string, V1 error format. 230 Allowed values 231 1 - v1 error format 232 2 - v2 error format 233 234Returns: 235 An object of the form: 236 237 { # Response message for CloudChannelService.ListChannelPartnerLinks. 238 "channelPartnerLinks": [ # The Channel partner links for a reseller. 239 { # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. 240 "channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR). 241 "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. 242 "alternateEmail": "A String", # The alternate email. 243 "customerType": "A String", # CustomerType indicates verification type needed for using services. 244 "eduData": { # Required Edu Attributes # Edu information about the customer. 245 "instituteSize": "A String", # Size of the institute. 246 "instituteType": "A String", # Designated institute type of customer. 247 "website": "A String", # Web address for the edu customer's institution. 248 }, 249 "isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. 250 "languageCode": "A String", # Language code. 251 "phoneNumber": "A String", # Phone number associated with the Cloud Identity. 252 "primaryDomain": "A String", # Output only. The primary domain name. 253 }, 254 "createTime": "A String", # Output only. Timestamp of when the channel partner link is created. 255 "inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation. 256 "linkState": "A String", # Required. State of the channel partner link. 257 "name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. 258 "publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. 259 "resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller. 260 "updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated. 261 }, 262 ], 263 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page. 264}</pre> 265</div> 266 267<div class="method"> 268 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 269 <pre>Retrieves the next page of results. 270 271Args: 272 previous_request: The request for the previous page. (required) 273 previous_response: The response from the request for the previous page. (required) 274 275Returns: 276 A request object that you can call 'execute()' on to request the next 277 page. Returns None if there are no more items in the collection. 278 </pre> 279</div> 280 281<div class="method"> 282 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> 283 <pre>Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. 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. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * 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 updated ChannelPartnerLink resource. 284 285Args: 286 name: string, Required. The resource name of the channel partner link to cancel. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner. (required) 287 body: object, The request body. 288 The object takes the form of: 289 290{ # Request message for CloudChannelService.UpdateChannelPartnerLink 291 "channelPartnerLink": { # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. # Required. The channel partner link to update. Only channel_partner_link.link_state is allowed for updates. 292 "channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR). 293 "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. 294 "alternateEmail": "A String", # The alternate email. 295 "customerType": "A String", # CustomerType indicates verification type needed for using services. 296 "eduData": { # Required Edu Attributes # Edu information about the customer. 297 "instituteSize": "A String", # Size of the institute. 298 "instituteType": "A String", # Designated institute type of customer. 299 "website": "A String", # Web address for the edu customer's institution. 300 }, 301 "isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. 302 "languageCode": "A String", # Language code. 303 "phoneNumber": "A String", # Phone number associated with the Cloud Identity. 304 "primaryDomain": "A String", # Output only. The primary domain name. 305 }, 306 "createTime": "A String", # Output only. Timestamp of when the channel partner link is created. 307 "inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation. 308 "linkState": "A String", # Required. State of the channel partner link. 309 "name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. 310 "publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. 311 "resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller. 312 "updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated. 313 }, 314 "updateMask": "A String", # Required. The update mask that applies to the resource. The only allowable value for an update mask is channel_partner_link.link_state. 315} 316 317 x__xgafv: string, V1 error format. 318 Allowed values 319 1 - v1 error format 320 2 - v2 error format 321 322Returns: 323 An object of the form: 324 325 { # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. 326 "channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR). 327 "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. 328 "alternateEmail": "A String", # The alternate email. 329 "customerType": "A String", # CustomerType indicates verification type needed for using services. 330 "eduData": { # Required Edu Attributes # Edu information about the customer. 331 "instituteSize": "A String", # Size of the institute. 332 "instituteType": "A String", # Designated institute type of customer. 333 "website": "A String", # Web address for the edu customer's institution. 334 }, 335 "isDomainVerified": True or False, # Output only. Whether the domain is verified. This field is not returned for a Customer's cloud_identity_info resource. Partners can use the domains.get() method of the Workspace SDK's Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in to track domain verification of their resolve Workspace customers. 336 "languageCode": "A String", # Language code. 337 "phoneNumber": "A String", # Phone number associated with the Cloud Identity. 338 "primaryDomain": "A String", # Output only. The primary domain name. 339 }, 340 "createTime": "A String", # Output only. Timestamp of when the channel partner link is created. 341 "inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation. 342 "linkState": "A String", # Required. State of the channel partner link. 343 "name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. 344 "publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. 345 "resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller. 346 "updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated. 347}</pre> 348</div> 349 350</body></html>