REST Resource: projects.locations.privateOffers.documents

Ressource: PrivateOfferDocument

Nachricht zur Beschreibung der PrivateOfferDocument-Ressource. Wird verwendet, um Dokumente an ein privates Angebot im Status „ENTWURF“ anzuhängen. Sobald sich ein privates Angebot nicht mehr im Status „ENTWURF“ befindet, kann die Gruppe der untergeordneten Dokumente nicht mehr geändert werden. Vorhandene Dokumente können nicht aktualisiert oder gelöscht und neue Dokumente nicht hinzugefügt werden.

Ein privates Angebot darf höchstens ein Dokument jedes Typs enthalten und darf nicht sowohl eine Standard-EULA als auch eine benutzerdefinierte EULA haben.

Welche Dokumenttypen erforderlich, optional oder nicht zulässig sind, hängt vom Dienst ab, für den das Angebot gilt, und wird in Service.document_requirement zurückgegeben.

JSON-Darstellung
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "documentType": enum (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.
}
Felder
name

string

ID. Der Name der Ressource.

createTime

string (Timestamp format)

Nur Ausgabe. Der Erstellungszeitpunkt der Ressource.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt der letzten Aktualisierung der Ressource.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

documentType

enum (DocumentType)

Erforderlich. Der Klassifizierungstyp des Dokuments. Wird verwendet, um zwischen verschiedenen Arten von Dokumenten zu unterscheiden, die aus unterschiedlichen geschäftlichen Gründen an ein privates Angebot angehängt werden können.

mimeType

string

Optional. Der MIME-Typ des Dokuments. Dient zur Unterscheidung zwischen verschiedenen Dokumentformaten. Unterstützte Formate (die in Zukunft möglicherweise erweitert werden)

  • 'application/pdf'
Mechanismus zum Speichern des Dokumentinhalts. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
inlineContent

string (bytes format)

Optional. Byte-Inhalt eines unstrukturierten Dokuments. Maximale Größe: 4 MB

Ein base64-codierter String.

Ende der sich gegenseitig ausschließenden Felder.

Methoden

create

Erstellt ein neues PrivateOfferDocument in einem bestimmten Projekt und an einem bestimmten Standort.

delete

Löscht das Ziel-PrivateOfferDocument.

get

Ruft Details zu einem einzelnen PrivateOfferDocument ab.

list

Listet PrivateOfferDocuments für das angegebene übergeordnete Element auf.

patch

Aktualisiert das Ziel-PrivateOfferDocument.