- [Resource: PrivateOfferDocument](https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents#PrivateOfferDocument)
  - [JSON representation](https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents#PrivateOfferDocument.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents#METHODS_SUMMARY)

## Resource: PrivateOfferDocument

Message describing the PrivateOfferDocument resource. Used to attach documents to a private offer in state DRAFT. Once a private offer is no longer in state DRAFT, the set of child documents is immutable. Existing documents cannot be updated or deleted, and new documents cannot be added.

A private offer may have at most one document of each type, and may not have both a standard EULA and a custom EULA.

Which document types are required, optional, or not permitted depends on the service the offer is for, and is returned in `Service.document_requirement`.

| JSON representation |
|---|
| ``` { "name": string, "createTime": string, "updateTime": string, "documentType": enum (`https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/DocumentType`), "mimeType": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "inlineContent": string // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. Name of the resource. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The creation time of the resource. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The last update time of the resource. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `documentType` | ``enum (`https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/DocumentType`)`` Required. The classification type of the document. Used to distinguish between different types of documents that may be attached to a private offer for different business purposes. |
| `mimeType` | `string` Optional. The MIME type of the document. Used to distinguish between different document formats. Supported formats (which may be expanded in the future) - 'application/pdf' |
| Mechanism for storing the document content. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `inlineContent` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. Byte content of an unstructured document. Max size: 4MB A base64-encoded string. |
| End of mutually exclusive fields. ||

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents/create` | Creates a new PrivateOfferDocument in a given project and location. |
| ### `https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents/delete` | Deletes the target PrivateOfferDocument. |
| ### `https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents/get` | Gets details of a single PrivateOfferDocument. |
| ### `https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents/list` | Lists PrivateOfferDocuments for the given parent. |
| ### `https://docs.cloud.google.com/marketplace/docs/partners/commerce-producer-api/reference/rest/v1beta/projects.locations.privateOffers.documents/patch` | Updates the target PrivateOfferDocument. |