Method: documents.create

İstekle verilen başlığı kullanarak boş bir doküman oluşturur. İstekle ilgili diğer alanlar (sağlanan içerikler dahil) yoksayılır.

Oluşturulan belgeyi 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ış. Dokümanın kimliği.

title

string

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

tabs[]

object (Tab)

Yalnızca çıkış. Dokümanın parçası olan sekmeler

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

revisionId

string

Yalnızca çıkış. Dokümanın düzeltme kimliği. Güncellemelerin hangi belge düzeltmesine uygulanacağını ve belgenin bu düzeltmeden sonra düzenlenmesi durumunda isteğin nasıl davranacağını belirtmek için güncelleme isteklerinde kullanılabilir. Yalnızca kullanıcının dokümanı 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 döndürüldükten sonraki 24 saat içinde 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şmediyse belge değişmemiştir. Aynı şekilde, aynı belge ve kullanıcı için kimliğin değişmesi genellikle belgenin güncellendiği anlamına gelir. Ancak değişen kimlik, kimlik biçimindeki değişiklikler gibi dahili faktörlerden de kaynaklanabilir.

suggestionsViewMode

enum (SuggestionsViewMode)

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

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 ayarlanmışsa (ör. COMMENTS_VIEW_MODE_INCLUDED) doldurulur.

suggestions[]

object (SuggestionThread)

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

body

object (Body)

Yalnızca çıkış. Belgenin 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 alanını kullanın. 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ış. Dokümandaki üstbilgiler, üstbilgi kimliğine göre anahtarlanı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.headers alanını kullanın. 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ış. Dokümandaki altbilgiler, altbilgi kimliğine göre anahtarlanı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 alanını kullanın. 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, includeTabsContent 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. false veya ayarlanmamışsa bu alan, dokümandaki ilk sekme hakkında bilgi 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.documentTab.documentStyle alanını kullanın. 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ış. Belgenin stilinde önerilen değişiklikler, öneri kimliğine göre anahtarlanı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.suggestedDocumentStyleChanges alanını kullanın. 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, includeTabsContent 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. 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, includeTabsContent 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. 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ış. Dokümandaki listeler, liste kimliğine göre anahtarlanı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.lists alanını kullanın. 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, includeTabsContent 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. 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, includeTabsContent 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. 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, includeTabsContent 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. false veya ayarlanmamışsa bu alan, dokümandaki ilk sekme hakkında bilgi içerir.

Yanıt metni

Başarılı olursa yanıt gövdesi, 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'nu inceleyin.