Method: partners.devices.metadata
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThis API endpoint updates reseller metadata associated with a specific device.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a POST method to a URL that includes \u003ccode\u003emetadataOwnerId\u003c/code\u003e and \u003ccode\u003edeviceId\u003c/code\u003e as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a JSON object containing \u003ccode\u003edeviceMetadata\u003c/code\u003e, which specifies the metadata to be attached to the device.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns an instance of \u003ccode\u003eDeviceMetadata\u003c/code\u003e, providing details about the updated metadata.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e.\u003c/p\u003e\n"]]],["This document details how to update reseller metadata for a device using a POST request to `https://androiddeviceprovisioning.googleapis.com/v1/partners/{metadataOwnerId}/devices/{deviceId}/metadata`. The `metadataOwnerId` (partner ID) and `deviceId` are required path parameters. The request body must contain a JSON object with `deviceMetadata`. A successful response returns a `DeviceMetadata` instance. This action requires the `https://www.googleapis.com/auth/androidworkprovisioning` OAuth scope for authorization. The update is completed using a Transcoding syntax.\n"],null,["# Method: partners.devices.metadata\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nUpdates reseller metadata associated with the device.\n\n### HTTP request\n\n`POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{metadataOwnerId}/devices/{deviceId}/metadata`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `metadataOwnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The owner of the newly set metadata. Set this to the partner ID. |\n| `deviceId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the device. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|-------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"deviceMetadata\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceMetadata) } } ``` |\n\n| Fields ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deviceMetadata` | `object (`[DeviceMetadata](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceMetadata)`)` Required. The metadata to attach to the device. |\n\n### Response body\n\nIf successful, the response body contains an instance of [DeviceMetadata](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceMetadata).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidworkprovisioning`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]