Method: documents.create

İstekle verilen başlığı kullanarak boş bir doküman oluşturur. İstekteki diğer alanlar (sağlanan içerikler dahil) 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 metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "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

Belgenin başlığı.
tabs[]

object (Tab)

Bir belgenin parçası olan sekmeler.

Sekmeler, başka bir sekmenin içine yerleştirilmiş alt sekmeler içerebilir. Alt sekmeler Tab.childTabs alanı ile gösterilir.
revisionId

string

Yalnızca çıkış. Dokümanın düzeltme kimliği. Güncelleme isteklerinde, bir belgenin hangi düzeltmesine güncelleme uygulanacağını ve belgenin bu düzeltmeden sonra düzenlenmesi durumunda isteğin nasıl davranacağını belirtmek için kullanılabilir. Yalnızca kullanıcının doküman için 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 zamanla değişebilir. İade edilen düzeltme kimliğinin yalnızca iade edildikten sonraki 24 saat boyunca geçerli olduğu garanti edilir ve kullanıcılar arasında paylaşılamaz. Çağrılar arasında düzeltme kimliği değişmemişse belge değişmemiştir. Buna karşılık, aynı belge ve kullanıcı için kimliğin değişmesi genellikle belgenin güncellendiği anlamına gelir. Ancak, değişen kimlikler, kimlik biçimindeki değişiklikler gibi dahili faktörlerden de kaynaklanabilir.
suggestionsViewMode

enum (SuggestionsViewMode)

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

Not: Bir dokümanı düzenlerken değişiklikler SUGGESTIONS_INLINE içeren bir dokümana göre yapılmalıdır.
commentsViewMode

enum (CommentsViewMode)

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

comments[]

object (CommentThread)

Yalnızca çıkış. Dokümanla ilişkili yorumlar. Yalnızca commentsViewMode parametresi yorum gerektirecek şekilde ayarlanırsa (ör. COMMENTS_VIEW_MODE_INCLUDED) doldurulur.

suggestions[]

object (SuggestionThread)

Yalnızca çıkış. Dokümanla ilişkili öneriler. Yalnızca commentsViewMode parametresi yorum gerektirecek şekilde ayarlanırsa (ör. COMMENTS_VIEW_MODE_INCLUDED) doldurulur.

body

object (Body)

Yalnızca çıkış. Belgenin ana gövdesi.

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

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

Yalnızca çıkış. Belgedeki üstbilgiler, üstbilgi kimliğine göre anahtarlanır.

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

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

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

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

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

Yalnızca çıkış. Belgedeki dipnotlar, dipnot kimliğine göre anahtarlanır.

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

object (DocumentStyle)

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

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

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

Yalnızca çıkış. Dokümanın stilinde önerilen değişiklikler, öneri kimliğine göre anahtarlanır.

Eski alan: Bunun yerine, Document.tabs.documentTab.suggestedDocumentStyleChanges parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.suggestedDocumentStyleChanges alanını kullanın.includeTabsContent false veya ayarlanmamışsa bu alan, dokümandaki ilk sekme hakkında bilgi içerir.
namedStyles

object (NamedStyles)

Yalnızca çıkış. Belgenin adlandırılmış stilleri.

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

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

Yalnızca çıkış. Belgenin adlandırılmış stillerinde önerilen değişiklikler, öneri kimliğine göre anahtarlanır.

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

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

Yalnızca çıkış. Belgedeki listeler, liste kimliğine göre anahtarlanır.

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

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

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

Eski alan: Bunun yerine, Document.tabs.documentTab.namedRanges parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.namedRanges alanını kullanın.includeTabsContent false veya ayarlanmamışsa bu alan, dokümandaki ilk sekme hakkında bilgi içerir.
inlineObjects

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

Yalnızca çıkış. Dokümandaki satır içi nesneler, nesne kimliğine göre anahtarlanır.

Eski alan: Bunun yerine, Document.tabs.documentTab.inlineObjects parametresi true olarak ayarlandığında tüm sekmelerdeki gerçek doküman içeriğini gösteren Document.tabs.documentTab.inlineObjects alanını kullanın.includeTabsContent false veya ayarlanmamışsa bu alan, dokümandaki ilk sekme hakkında bilgi içerir.
positionedObjects

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

Yalnızca çıkış. Belgedeki konumlandırılmış nesneler, nesne kimliğine göre anahtarlanır.

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

Yanıt metni

Başarılı olursa yanıt metni, yeni oluşturulan 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ılavuzu'na bakın.