Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 04bafe14efe7a6d1a7da03de89312062a4afa127 / . / docs / dyn / androiddeviceprovisioning_v1.customers.html
blob: 699b37f7e6e3b2cc608c44217e0368e58a34992e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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
75<h1><a href="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.customers.html">customers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="androiddeviceprovisioning_v1.customers.configurations.html">configurations()</a></code>
79</p>
80<p class="firstline">Returns the configurations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="androiddeviceprovisioning_v1.customers.devices.html">devices()</a></code>
84</p>
85<p class="firstline">Returns the devices Resource.</p>
86
87<p class="toc_element">
88 <code><a href="androiddeviceprovisioning_v1.customers.dpcs.html">dpcs()</a></code>
89</p>
90<p class="firstline">Returns the dpcs Resource.</p>
91
92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93 <code><a href="#close">close()</a></code></p>
94<p class="firstline">Close httplib2 connections.</p>
95<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]96 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Lists the user's customer accounts.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]108 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 <pre>Lists the user&#x27;s customer accounts.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110
111Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]112 pageSize: integer, The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]113 pageToken: string, A token specifying which result page to return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119Returns:
120 An object of the form:
121
122 { # Response message for listing my customers.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]123 &quot;customers&quot;: [ # The customer accounts the calling user is a member of.
124 { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
125 &quot;adminEmails&quot;: [ # Optional. Email address of customer&#x27;s users in the admin role. Each email address must be associated with a Google Account.
126 &quot;A String&quot;,
127 ],
128 &quot;companyId&quot;: &quot;A String&quot;, # Output only. The ID of the company. Assigned by the server.
129 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the company. For example _XYZ Corp_. Displayed to the company&#x27;s employees in the zero-touch enrollment portal.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]130 &quot;languageCode&quot;: &quot;A String&quot;, # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]131 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]132 &quot;ownerEmails&quot;: [ # Required. Input only. Email address of customer&#x27;s users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization&#x27;s portal users.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]133 &quot;A String&quot;,
134 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]135 &quot;skipWelcomeEmail&quot;: True or False, # Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]136 &quot;termsStatus&quot;: &quot;A String&quot;, # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
137 },
138 ],
139 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token used to access the next page of results. Omitted if no further results are available.
140}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141</div>
142
143<div class="method">
144 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
145 <pre>Retrieves the next page of results.
146
147Args:
148 previous_request: The request for the previous page. (required)
149 previous_response: The response from the request for the previous page. (required)
150
151Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 page. Returns None if there are no more items in the collection.
154 </pre>
155</div>
156
157</body></html>