1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
<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.channelPartnerLinks.html">channelPartnerLinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudchannel_v1.accounts.channelPartnerLinks.channelPartnerRepricingConfigs.html">channelPartnerRepricingConfigs()</a></code>
</p>
<p class="firstline">Returns the channelPartnerRepricingConfigs Resource.</p>
<p class="toc_element">
<code><a href="cloudchannel_v1.accounts.channelPartnerLinks.customers.html">customers()</a></code>
</p>
<p class="firstline">Returns the customers Resource.</p>
<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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<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>
<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="create">create(parent, body=None, x__xgafv=None)</code>
<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.
Args:
parent: string, Required. Create a channel partner link for the provided reseller account's resource name. Parent uses the format: accounts/{account_id} (required)
body: object, The request body.
The object takes the form of:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"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.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"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.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<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.
Args:
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)
view: string, Optional. The level of granularity the ChannelPartnerLink will display.
Allowed values
UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.
FULL - Includes all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"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.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<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.
Args:
parent: string, Required. The resource name of the reseller account for listing channel partner links. Parent uses the format: accounts/{account_id} (required)
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.
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.
view: string, Optional. The level of granularity the ChannelPartnerLink will display.
Allowed values
UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
BASIC - Includes all fields except the ChannelPartnerLink.channel_partner_cloud_identity_info.
FULL - Includes all fields.
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 CloudChannelService.ListChannelPartnerLinks.
"channelPartnerLinks": [ # The Channel partner links for a reseller.
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"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.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListChannelPartnerLinksRequest.page_token to obtain that page.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<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.
Args:
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)
body: object, The request body.
The object takes the form of:
{ # Request message for CloudChannelService.UpdateChannelPartnerLink
"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.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"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.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
},
"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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.
"channelPartnerCloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity info of the channel partner (IR).
"adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard.
"alternateEmail": "A String", # The alternate email.
"customerType": "A String", # CustomerType indicates verification type needed for using services.
"eduData": { # Required Edu Attributes # Edu information about the customer.
"instituteSize": "A String", # Size of the institute.
"instituteType": "A String", # Designated institute type of customer.
"website": "A String", # Web address for the edu customer's institution.
},
"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.
"languageCode": "A String", # Language code.
"phoneNumber": "A String", # Phone number associated with the Cloud Identity.
"primaryDomain": "A String", # Output only. The primary domain name.
},
"createTime": "A String", # Output only. Timestamp of when the channel partner link is created.
"inviteLinkUri": "A String", # Output only. URI of the web page where partner accepts the link invitation.
"linkState": "A String", # Required. State of the channel partner link.
"name": "A String", # Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}.
"publicId": "A String", # Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination.
"resellerCloudIdentityId": "A String", # Required. Cloud Identity ID of the linked reseller.
"updateTime": "A String", # Output only. Timestamp of when the channel partner link is updated.
}</pre>
</div>
</body></html>
|
