Method: documents.create

İstekte verilen başlığı kullanarak boş bir doküman oluşturur. Sağlanan içerikler de dahil olmak üzere istekteki diğer alanlar yok sayılır.

Oluşturulan dokümanı döndürür.

HTTP isteği

POST https://docs.googleapis.com/v1/documents

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İstek gövdesi aşağıdaki yapıya sahip veriler içerir:

JSON gösterimi 
{
  "documentId": string,
  "title": string,
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Alanlar
documentId

string

Yalnızca çıkış. Belgenin kimliği.
title

string

Belgenin başlığı.
body

object (Body)

Yalnızca çıkış. Dokümanın ana gövdesi.
headers

map (key: string, value: object (Header))

Yalnızca çıkış. Üstbilgide belirtilen dokümandaki başlıklar.
footers

map (key: string, value: object (Footer))

Yalnızca çıkış. Dokümandaki altbilgi kimliğiyle eşleşen altbilgiler.
footnotes

map (key: string, value: object (Footnote))

Yalnızca çıkış. Dokümandaki, dipnot kimliğiyle düzenlenmiş dipnotlar.
documentStyle

object (DocumentStyle)

Yalnızca çıkış. Belgenin stili.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Yalnızca çıkış. Önerilen, öneri kimliği anahtarıyla dokümanın stilinde yapılan değişikliklerdir.
namedStyles

object (NamedStyles)

Yalnızca çıkış. Dokümanın adlandırılmış stilleri.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Yalnızca çıkış. Öneri kimliği temel alınarak dokümanın adlandırılmış stilleri için önerilen değişiklikler.
lists

map (key: string, value: object (List))

Yalnızca çıkış. Belgede bulunan, liste kimliğinden oluşan listeler.
namedRanges

map (key: string, value: object (NamedRanges))

Yalnızca çıkış. Dokümanda ada göre adlandırılan adlandırılmış aralıklar.
revisionId

string

Yalnızca çıkış. Dokümanın düzeltme kimliği. Bir dokümanda hangi düzeltmenin uygulanacağını ve bu düzeltmeden sonra doküman düzenlenmişse isteğin nasıl davranması gerektiğini belirtmek için güncelleme isteklerinde kullanılabilir. Yalnızca kullanıcı doküman için düzenleme erişimine sahipse doldurulur.

Düzeltme kimliği sıralı bir sayı değil, opak bir dizedir. Düzeltme kimliğinin biçimi zaman içinde değişebilir. Döndürülen düzeltme kimliğinin, geri verildikten sonraki 24 saat boyunca geçerli olacağı ve kullanıcılar arasında paylaşılamayacağı garanti edilir. Düzeltme kimliği aramalar arasında değiştirilmezse doküman değişmemiştir. Diğer yandan, değişen kimlik (aynı doküman ve kullanıcı için) genellikle dokümanın güncellendiği anlamına gelir. Bununla birlikte, değişen kimlik, kimlik biçimi değişiklikleri gibi dahili faktörlerden de kaynaklanabilir.
suggestionsViewMode

enum (SuggestionsViewMode)

Yalnızca çıkış. Dokümana uygulanan öneri görünümü modu.

Not: Bir dokümanı düzenlerken, değişiklikler SUGGESTIONS_INLINE içeren bir dokümanı temel almalıdır.
inlineObjects

map (key: string, value: object (InlineObject))

Yalnızca çıkış. Dokümandaki nesne kimliği anahtarlı satır içi nesneler.
positionedObjects

map (key: string, value: object (PositionedObject))

Yalnızca çıkış. Dokümandaki nesne kimliği anahtarıyla konumlandırılmış nesneler.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, yeni oluşturulan Document örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.