Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / licensing_v1.licenseAssignments.html
blob: 7bc694d56d311de5c1b062dbec45d2d753417200 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]75<h1><a href="licensing_v1.html">Enterprise License Manager API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(productId, skuId, userId, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82<p class="firstline">Revoke a license.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]84 <code><a href="#get">get(productId, skuId, userId, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85<p class="firstline">Get a specific user's license by product SKU.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]87 <code><a href="#insert">insert(productId, skuId, body=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88<p class="firstline">Assign a license.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]90 <code><a href="#listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]93 <code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94<p class="firstline">List all users assigned licenses for a specific product SKU.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95<p class="toc_element">
96 <code><a href="#listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#listForProduct_next">listForProduct_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]102 <code><a href="#patch">patch(productId, skuId, userId, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Patch a Licensing info via Apiary Patch Orchestration</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]105 <code><a href="#update">update(productId, skuId, userId, body=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106<p class="firstline">Reassign a user's product SKU with a different SKU in the same product.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107<h3>Method Details</h3>
108<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="delete">delete(productId, skuId, userId, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 <pre>Revoke a license.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116
117Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 productId: string, A product&#x27;s unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
119 skuId: string, A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]120 userId: string, The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes. (required)
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125</pre>
126</div>
127
128<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]129 <code class="details" id="get">get(productId, skuId, userId, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 <pre>Get a specific user&#x27;s license by product SKU.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131
132Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 productId: string, A product&#x27;s unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
134 skuId: string, A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]135 userId: string, The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes. (required)
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140
141Returns:
142 An object of the form:
143
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 { # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]145 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
146 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]147 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]148 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]150 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 }</pre>
154</div>
155
156<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]157 <code class="details" id="insert">insert(productId, skuId, body=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]158 <pre>Assign a license.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159
160Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 productId: string, A product&#x27;s unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
162 skuId: string, A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]163 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164 The object takes the form of:
165
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]166{ # Representation of a license assignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 &quot;userId&quot;: &quot;A String&quot;, # Email id of the user
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 }
169
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]170 x__xgafv: string, V1 error format.
171 Allowed values
172 1 - v1 error format
173 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]174
175Returns:
176 An object of the form:
177
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]178 { # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]179 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
180 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]181 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]182 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]184 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]185 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 }</pre>
188</div>
189
190<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]191 <code class="details" id="listForProduct">listForProduct(productId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]192 <pre>List all users assigned licenses for a specific product SKU.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]193
194Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 productId: string, A product&#x27;s unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]196 customerId: string, Customer&#x27;s customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]197 maxResults: integer, The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 pageToken: string, Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]203
204Returns:
205 An object of the form:
206
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]207 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]208 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]209 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
210 &quot;kind&quot;: &quot;licensing#licenseAssignmentList&quot;, # Identifies the resource as a collection of LicenseAssignments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 &quot;items&quot;: [ # The LicenseAssignments in this page of results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]212 { # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]213 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
214 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]215 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]216 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]218 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]219 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]221 },
222 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 }</pre>
224</div>
225
226<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]227 <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, maxResults=None, pageToken=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]228 <pre>List all users assigned licenses for a specific product SKU.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]229
230Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 productId: string, A product&#x27;s unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
232 skuId: string, A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]233 customerId: string, Customer&#x27;s customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]234 maxResults: integer, The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]235 pageToken: string, Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240
241Returns:
242 An object of the form:
243
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]244 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]245 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]246 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
247 &quot;kind&quot;: &quot;licensing#licenseAssignmentList&quot;, # Identifies the resource as a collection of LicenseAssignments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]248 &quot;items&quot;: [ # The LicenseAssignments in this page of results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]249 { # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]250 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
251 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]252 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]253 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]255 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]256 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]258 },
259 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]260 }</pre>
261</div>
262
263<div class="method">
264 <code class="details" id="listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</code>
265 <pre>Retrieves the next page of results.
266
267Args:
268 previous_request: The request for the previous page. (required)
269 previous_response: The response from the request for the previous page. (required)
270
271Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]272 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 page. Returns None if there are no more items in the collection.
274 </pre>
275</div>
276
277<div class="method">
278 <code class="details" id="listForProduct_next">listForProduct_next(previous_request, previous_response)</code>
279 <pre>Retrieves the next page of results.
280
281Args:
282 previous_request: The request for the previous page. (required)
283 previous_response: The response from the request for the previous page. (required)
284
285Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]286 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]287 page. Returns None if there are no more items in the collection.
288 </pre>
289</div>
290
291<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]292 <code class="details" id="patch">patch(productId, skuId, userId, body=None, x__xgafv=None)</code>
293 <pre>Patch a Licensing info via Apiary Patch Orchestration
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]294
295Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 productId: string, A product&#x27;s unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
297 skuId: string, A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]298 userId: string, The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]299 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]300 The object takes the form of:
301
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]302{ # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]303 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
304 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]305 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]306 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]307 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]308 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]309 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]310 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]311}
312
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317
318Returns:
319 An object of the form:
320
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]321 { # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]322 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
323 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]324 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]325 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]326 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]327 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]328 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]329 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]330 }</pre>
331</div>
332
333<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]334 <code class="details" id="update">update(productId, skuId, userId, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 <pre>Reassign a user&#x27;s product SKU with a different SKU in the same product.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]336
337Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 productId: string, A product&#x27;s unique identifier. For more information about products in this version of the API, see Products and SKUs. (required)
339 skuId: string, A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]340 userId: string, The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]341 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]342 The object takes the form of:
343
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]344{ # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]345 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
346 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]347 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]348 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]349 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]350 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]351 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]352 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]353}
354
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]355 x__xgafv: string, V1 error format.
356 Allowed values
357 1 - v1 error format
358 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]359
360Returns:
361 An object of the form:
362
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]363 { # Representation of a license assignment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]364 &quot;productName&quot;: &quot;A String&quot;, # Display Name of the product.
365 &quot;skuName&quot;: &quot;A String&quot;, # Display Name of the sku of the product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]366 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]367 &quot;kind&quot;: &quot;licensing#licenseAssignment&quot;, # Identifies the resource as a LicenseAssignment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]368 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]369 &quot;skuId&quot;: &quot;A String&quot;, # A product SKU&#x27;s unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]370 &quot;userId&quot;: &quot;A String&quot;, # The user&#x27;s current primary email address. If the user&#x27;s email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user&#x27;s email address changes. If the userId is suspended, the license status changes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]371 &quot;productId&quot;: &quot;A String&quot;, # A product&#x27;s unique identifier. For more information about products in this version of the API, see Product and SKU IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]372 }</pre>
373</div>
374
375</body></html>