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 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 gövdesi, aşağıdaki yapıya sahip 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)

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.child_tabs 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. Döndürülen düzeltme kimliğinin, yalnızca iade edildikten sonra 24 saat boyunca geçerli olacağı garanti edilir ve bu kimlik 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, kimliğin değiştirilmesi (aynı doküman ve kullanıcı için) 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 öneriler 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.document_tab.body kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki 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.document_tab.headers 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ış. Dokümandaki, altbilgi kimliğiyle birlikte yayınlanan altbilgiler.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.document_tab.footers kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki 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.document_tab.footnotes 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ış. Dokümanın 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.document_tab.document_style kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki 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.document_tab.suggested_document_style_changes 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.document_tab.named_styles 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ış. Dokümanın adlandırılmış stillerinde öneri kimliği ile belirtilen değişiklikler.

Eski alan: Bunun yerine, includeTabsContent parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.document_tab.suggested_named_styles_changes kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki 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.document_tab.lists kullanın. false değerine ayarlanır veya ayarlanmadan bırakılırsa bu alan, dokümandaki 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.document_tab.named_ranges 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ış. Dokümandaki, nesne kimliğiyle ilişkili 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.document_tab.inline_objects 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ış. Dokümandaki nesne kimliğiyle anahtarlanmış 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.document_tab.positioned_objects 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 gövdesi, 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ılavuzunu inceleyin.