Method: documents.create

İstekte belirtilen başlığı kullanarak boş bir doküman oluşturur. Sağlanan içerikler dahil olmak üzere istekteki diğer alanlar yoksayı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 metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Alanlar
documentId

string

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

title

string

Dokümanın başlığı.

tabs[]

object (Tab)

Bir dokümanın parçası olan sekmeler.

Sekmeler, başka bir sekmenin içine yerleştirilmiş bir sekme olan alt sekmeler içerebilir. Alt sekmeler, Tab.childTabs alanıyla temsil edilir.

revisionId

string

Yalnızca çıkış. Dokümanın düzeltme kimliği. Güncellemelerin hangi düzeltmeye uygulanacağını ve doküman bu düzeltmeden sonra düzenlenmişse isteğin nasıl davranması gerektiğini belirtmek için güncelleme isteklerinde kullanılabilir. Yalnızca kullanıcının dokümana düzenleme erişimi varsa 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. İade edilen düzeltme kimliğinin yalnızca iade edildikten sonraki 24 saat boyunca geçerli olacağı garanti edilir ve kullanıcılar arasında paylaşılamaz. Çağrılar arasında düzeltme kimliği değişmiyorsa doküman da değişmemiştir. Buna karşılık, aynı doküman ve kullanıcı için değişen bir kimlik genellikle dokümanın güncellendiği anlamına gelir. Ancak kimliğin değiştirilmesi, kimlik biçimi değişiklikleri gibi dahili faktörlerden de kaynaklanıyor olabilir.

suggestionsViewMode

enum (SuggestionsViewMode)

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

Not: Doküman düzenlenirken değişiklikler SUGGESTIONS_INLINE içeren bir dokümana dayanmalıdır.

body

object (Body)

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

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.body kullanın. false veya ayarlanmamışsa bu alan, belgedeki ilk sekmeyle ilgili bilgileri içerir.

headers

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

Yalnızca çıkış. Üstbilgi kimliğiyle birlikte sağlanan, dokümandaki başlıklar.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.headers değerini kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki ilk sekmeyle ilgili bilgileri içerir.

footers

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

Yalnızca çıkış. Belgedeki altbilgiler, altbilgi kimliğine göre anahtarlanmıştır.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.footers değerini kullanın. false veya ayarlanmamışsa bu alan, belgedeki ilk sekmeyle ilgili bilgileri içerir.

footnotes

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

Yalnızca çıkış. Dokümandaki dipnot kimliği ile belirtilmiş dipnotlar.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.footnotes değerini kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki ilk sekmeyle ilgili bilgileri içerir.

documentStyle

object (DocumentStyle)

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

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.documentStyle kullanın. false veya ayarlanmamışsa bu alan, belgedeki ilk sekmeyle ilgili bilgileri içerir.

suggestedDocumentStyleChanges

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

Yalnızca çıkış. Dokümanın stili için önerilen değişiklikler (öneri kimliği ile belirtilir).

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.suggestedDocumentStyleChanges kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki ilk sekmeyle ilgili bilgileri içerir.

namedStyles

object (NamedStyles)

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

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.namedStyles kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki ilk sekmeyle ilgili bilgileri içerir.

suggestedNamedStylesChanges

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

Yalnızca çıkış. Önerilen değişiklikler, öneri kimliğine göre anahtarlandırılmış olarak dokümanın adlandırılmış stillerinde yapılır.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.suggestedNamedStylesChanges değerini kullanın. false veya ayarlanmamışsa bu alan, belgedeki ilk sekmeyle ilgili bilgileri içerir.

lists

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

Yalnızca çıkış. Liste kimliğiyle ilişkili olarak dokümandaki listeler.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.lists kullanın. false veya ayarlanmamışsa bu alan, belgedeki ilk sekmeyle ilgili bilgileri içerir.

namedRanges

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

Yalnızca çıkış. Dokümandaki adlandırılmış aralıklar (ada göre anahtarlamalı).

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.namedRanges kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki ilk sekmeyle ilgili bilgileri içerir.

inlineObjects

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

Yalnızca çıkış. Nesne kimliğine göre anahtarlanmış, dokümandaki satır içi nesneler.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.inlineObjects değerini kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki ilk sekmeyle ilgili bilgileri içerir.

positionedObjects

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

Yalnızca çıkış. Nesne kimliğine göre anahtarlanmış, dokümanda konumlandırılmış nesneler.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.positionedObjects değerini kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki ilk sekmeyle ilgili bilgileri içerir.

Yanıt gövdesi

Başarılı olursa yanıt metni, yeni oluşturulmuş bir 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.