Android Device Provisioning Partner API . partners . customers

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.

list(partnerId, pageSize=None, pageToken=None, x__xgafv=None)

Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.

Args:
  parent: string, Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message to create a customer.
  "customer": { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs. # Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that's associated with a Google Account. The values for `companyId` and `name` must be empty.
    "adminEmails": [ # Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
      "A String",
    ],
    "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
    "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
    "googleWorkspaceAccount": { # A Google Workspace customer. # Output only. The Google Workspace account associated with this customer. Only used for customer Companies.
      "customerId": "A String", # Required. The customer ID.
      "preProvisioningTokens": [ # Output only. The pre-provisioning tokens previously used to claim devices.
        "A String",
      ],
    },
    "languageCode": "A String", # 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)
    "name": "A String", # 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.
    "ownerEmails": [ # Required. Input only. Email address of customer'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's portal users.
      "A String",
    ],
    "skipWelcomeEmail": True or False, # Input only. Deprecated: This field is no longer supported and is ignored by the server.
    "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
  "adminEmails": [ # Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
    "A String",
  ],
  "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
  "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
  "googleWorkspaceAccount": { # A Google Workspace customer. # Output only. The Google Workspace account associated with this customer. Only used for customer Companies.
    "customerId": "A String", # Required. The customer ID.
    "preProvisioningTokens": [ # Output only. The pre-provisioning tokens previously used to claim devices.
      "A String",
    ],
  },
  "languageCode": "A String", # 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)
  "name": "A String", # 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.
  "ownerEmails": [ # Required. Input only. Email address of customer'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's portal users.
    "A String",
  ],
  "skipWelcomeEmail": True or False, # Input only. Deprecated: This field is no longer supported and is ignored by the server.
  "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
}
list(partnerId, pageSize=None, pageToken=None, x__xgafv=None)
Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.

Args:
  partnerId: string, Required. The ID of the reseller partner. (required)
  pageSize: integer, The maximum number of results to be returned. If not specified or 0, all the records are returned.
  pageToken: string, A token identifying a page of results returned by the server.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message of all customers related to this partner.
  "customers": [ # List of customers related to this reseller partner.
    { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
      "adminEmails": [ # Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
        "A String",
      ],
      "companyId": "A String", # Output only. The ID of the company. Assigned by the server.
      "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
      "googleWorkspaceAccount": { # A Google Workspace customer. # Output only. The Google Workspace account associated with this customer. Only used for customer Companies.
        "customerId": "A String", # Required. The customer ID.
        "preProvisioningTokens": [ # Output only. The pre-provisioning tokens previously used to claim devices.
          "A String",
        ],
      },
      "languageCode": "A String", # 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)
      "name": "A String", # 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.
      "ownerEmails": [ # Required. Input only. Email address of customer'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's portal users.
        "A String",
      ],
      "skipWelcomeEmail": True or False, # Input only. Deprecated: This field is no longer supported and is ignored by the server.
      "termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Omitted if no further results are available.
  "totalSize": 42, # The total count of items in the list irrespective of pagination.
}
list_next(previous_request, previous_response)
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.