REST Resource: projects.locations.privateOffers.documents

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 must include a EULA, either by assigning a standard EULA or attaching a custom EULA document, or a statement of work document.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "documentType": enum (DocumentType),
  "mimeType": string,

  // Union field content can be only one of the following:
  "inlineContent": string
  // End of list of possible types for union field content.
}
Fields
name

string

Identifier. Name of the resource.
createTime

string (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 (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 (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'
Union field content. Mechanism for storing the document content. content can be only one of the following:
inlineContent

string (bytes format)

Optional. Byte content of an unstructured document. Max size: 4MB

A base64-encoded string.

DocumentType

Supported types of documents. Additional document types may be added in future. Further editions of the Google Cloud Marketplace Standard EULA may be published in future, which may result in changes to the subset of Standard EULA versions permitted to be used in new offers.

Enums
DOCUMENT_TYPE_UNSPECIFIED The default / unset value. Do not use.
CUSTOM_END_USER_LICENSE_AGREEMENT

The document is a custom EULA used in place of the standard product EULA. A private offer may not have more than one custom EULA document.

If this enum value is set, then mimeType and inlineContent must be set.
STATEMENT_OF_WORK

The document is the statement of work required by the Cloud Marketplace Product Specific Terms for all Professional Services product private offers. This document type is not permitted for private offers of any other product type. A private offer may not have more than one statement of work document.

The mimeType and inlineContent fields must be set.
STANDARD_END_USER_LICENSE_AGREEMENT_V1 The document is the Marketplace standard EULA, with the following link: https://cloud.google.com/terms/marketplace/eula-standard-v1-12102020. Existing offers may have this document type, but this is not permitted for new offers.
STANDARD_END_USER_LICENSE_AGREEMENT_V2

The document is the Marketplace standard EULA, with the following link: https://cloud.google.com/terms/marketplace/eula-standard-v2-01272021

New offers using Standard EULAs should set this enum value. This is not permitted for Professional Services products.

The mimeType and inlineContent fields must not be set.

Methods

create

 Creates a new PrivateOfferDocument in a given project and location.

delete

 Deletes the target PrivateOfferDocument.

get

 Gets details of a single PrivateOfferDocument.

list

 Lists PrivateOfferDocuments for the given parent.

patch

 Updates the target PrivateOfferDocument.