Admin SDK API . customer . devices . chromeos

batchChangeStatus(customerId, body=None, x__xgafv=None)

Changes the status of a batch of ChromeOS devices. For more information about changing a ChromeOS device state [Repair, repurpose, or retire ChromeOS devices](https://support.google.com/chrome/a/answer/3523633).

Args:
  customerId: string, Required. Immutable ID of the Google Workspace account. (required)
  body: object, The request body.
    The object takes the form of:

{ # A request for changing the status of a batch of ChromeOS devices.
  "changeChromeOsDeviceStatusAction": "A String", # Required. The action to take on the ChromeOS device in order to change its status.
  "deprovisionReason": "A String", # Optional. The reason behind a device deprovision. Must be provided if 'changeChromeOsDeviceStatusAction' is set to 'CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION'. Otherwise, omit this field.
  "deviceIds": [ # Required. List of the IDs of the ChromeOS devices to change. Maximum 50.
    "A String",
  ],
}

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

Returns:
  An object of the form:

    { # The response of changing the status of a batch of ChromeOS devices.
  "changeChromeOsDeviceStatusResults": [ # The results for each of the ChromeOS devices provided in the request.
    { # The result of a single ChromeOS device for a Change state operation.
      "deviceId": "A String", # The unique ID of the ChromeOS device.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "response": { # Response for a successful ChromeOS device status change. # The device could change its status successfully.
      },
    },
  ],
}

close()

Close httplib2 connections.

issueCommand(customerId, deviceId, body=None, x__xgafv=None)

Issues a command for the device to execute.

Args:
  customerId: string, Immutable. ID of the Google Workspace account. (required)
  deviceId: string, Immutable. ID of Chrome OS Device. (required)
  body: object, The request body.
    The object takes the form of:

{ # A request for issuing a command.
  "commandType": "A String", # The type of command.
  "payload": "A String", # The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { "volume": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { "ackedUserPresence": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`.
}

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

Returns:
  An object of the form:

    { # A response for issuing a command.
  "commandId": "A String", # The unique ID of the issued command, used to retrieve the command status.
}