@wirecat/drive-cli 0.0.0-stage → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +204 -0
- package/README.md +195 -2
- package/dist/api-contract.d.ts +7 -0
- package/dist/api-contract.d.ts.map +1 -0
- package/dist/api-contract.js +42 -0
- package/dist/api-contract.js.map +1 -0
- package/dist/bin/drive.d.ts +3 -0
- package/dist/bin/drive.d.ts.map +1 -0
- package/dist/bin/drive.js +41 -0
- package/dist/bin/drive.js.map +1 -0
- package/dist/config.d.ts +74 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +83 -0
- package/dist/config.js.map +1 -0
- package/dist/documents.d.ts +4 -0
- package/dist/documents.d.ts.map +1 -0
- package/dist/documents.js +36 -0
- package/dist/documents.js.map +1 -0
- package/dist/errors.d.ts +3 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +39 -0
- package/dist/errors.js.map +1 -0
- package/dist/extraction.d.ts +14 -0
- package/dist/extraction.d.ts.map +1 -0
- package/dist/extraction.js +49 -0
- package/dist/extraction.js.map +1 -0
- package/dist/generated/definitions.d.ts +3 -0
- package/dist/generated/definitions.d.ts.map +1 -0
- package/dist/generated/definitions.js +9798 -0
- package/dist/generated/definitions.js.map +1 -0
- package/dist/generated/manifest.d.ts +3 -0
- package/dist/generated/manifest.d.ts.map +1 -0
- package/dist/generated/manifest.js +8346 -0
- package/dist/generated/manifest.js.map +1 -0
- package/dist/generated/metadata.d.ts +74 -0
- package/dist/generated/metadata.d.ts.map +1 -0
- package/dist/generated/metadata.js +342 -0
- package/dist/generated/metadata.js.map +1 -0
- package/dist/generated/schemas.d.ts +649 -0
- package/dist/generated/schemas.d.ts.map +1 -0
- package/dist/generated/schemas.js +2602 -0
- package/dist/generated/schemas.js.map +1 -0
- package/dist/generated/types.d.ts +3940 -0
- package/dist/generated/types.d.ts.map +1 -0
- package/dist/generated/types.js +5 -0
- package/dist/generated/types.js.map +1 -0
- package/dist/google-api.d.ts +15 -0
- package/dist/google-api.d.ts.map +1 -0
- package/dist/google-api.js +94 -0
- package/dist/google-api.js.map +1 -0
- package/dist/google.d.ts +8 -0
- package/dist/google.d.ts.map +1 -0
- package/dist/google.js +173 -0
- package/dist/google.js.map +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -0
- package/dist/knowledge-commands.d.ts +19 -0
- package/dist/knowledge-commands.d.ts.map +1 -0
- package/dist/knowledge-commands.js +184 -0
- package/dist/knowledge-commands.js.map +1 -0
- package/dist/knowledge.d.ts +50 -0
- package/dist/knowledge.d.ts.map +1 -0
- package/dist/knowledge.js +249 -0
- package/dist/knowledge.js.map +1 -0
- package/dist/login.d.ts +25 -0
- package/dist/login.d.ts.map +1 -0
- package/dist/login.js +116 -0
- package/dist/login.js.map +1 -0
- package/dist/mcp.d.ts +35 -0
- package/dist/mcp.d.ts.map +1 -0
- package/dist/mcp.js +147 -0
- package/dist/mcp.js.map +1 -0
- package/dist/model.d.ts +100 -0
- package/dist/model.d.ts.map +1 -0
- package/dist/model.js +3 -0
- package/dist/model.js.map +1 -0
- package/dist/oauth-application.d.ts +5 -0
- package/dist/oauth-application.d.ts.map +1 -0
- package/dist/oauth-application.js +8 -0
- package/dist/oauth-application.js.map +1 -0
- package/dist/policy.d.ts +16 -0
- package/dist/policy.d.ts.map +1 -0
- package/dist/policy.js +65 -0
- package/dist/policy.js.map +1 -0
- package/dist/profile-lock.d.ts +5 -0
- package/dist/profile-lock.d.ts.map +1 -0
- package/dist/profile-lock.js +27 -0
- package/dist/profile-lock.js.map +1 -0
- package/dist/program.d.ts +20 -0
- package/dist/program.d.ts.map +1 -0
- package/dist/program.js +655 -0
- package/dist/program.js.map +1 -0
- package/dist/registry.d.ts +7 -0
- package/dist/registry.d.ts.map +1 -0
- package/dist/registry.js +15 -0
- package/dist/registry.js.map +1 -0
- package/dist/remote-commands.d.ts +10 -0
- package/dist/remote-commands.d.ts.map +1 -0
- package/dist/remote-commands.js +169 -0
- package/dist/remote-commands.js.map +1 -0
- package/dist/schema.d.ts +6 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +77 -0
- package/dist/schema.js.map +1 -0
- package/dist/state.d.ts +11 -0
- package/dist/state.d.ts.map +1 -0
- package/dist/state.js +90 -0
- package/dist/state.js.map +1 -0
- package/dist/store.d.ts +5 -0
- package/dist/store.d.ts.map +1 -0
- package/dist/store.js +135 -0
- package/dist/store.js.map +1 -0
- package/dist/sync.d.ts +20 -0
- package/dist/sync.d.ts.map +1 -0
- package/dist/sync.js +278 -0
- package/dist/sync.js.map +1 -0
- package/dist/tokens.d.ts +26 -0
- package/dist/tokens.d.ts.map +1 -0
- package/dist/tokens.js +83 -0
- package/dist/tokens.js.map +1 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/version.js +3 -0
- package/dist/version.js.map +1 -0
- package/package.json +82 -4
|
@@ -0,0 +1,3940 @@
|
|
|
1
|
+
/** This resource represents a long-running operation that is the result of a network API call. */
|
|
2
|
+
export type DriveOperation = {
|
|
3
|
+
/** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
|
|
4
|
+
response?: Record<string, unknown>;
|
|
5
|
+
/** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */
|
|
6
|
+
metadata?: Record<string, unknown>;
|
|
7
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
8
|
+
error?: DriveStatus;
|
|
9
|
+
/** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
|
|
10
|
+
name?: string;
|
|
11
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
12
|
+
done?: boolean;
|
|
13
|
+
};
|
|
14
|
+
/** A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive. */
|
|
15
|
+
export type DrivePermission = {
|
|
16
|
+
/** The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required. */
|
|
17
|
+
type?: string;
|
|
18
|
+
/** Output only. Details of whether the permissions on this item are inherited or are directly on this item. */
|
|
19
|
+
permissionDetails?: Array<{
|
|
20
|
+
/** Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). */
|
|
21
|
+
role?: string;
|
|
22
|
+
/** Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. */
|
|
23
|
+
inheritedFrom?: string;
|
|
24
|
+
/** Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. */
|
|
25
|
+
inherited?: boolean;
|
|
26
|
+
/** Output only. The permission type for this user. Supported values include: * `file` * `member` */
|
|
27
|
+
permissionType?: string;
|
|
28
|
+
}>;
|
|
29
|
+
/** Output only. Deprecated: Output only. Use `permissionDetails` instead. */
|
|
30
|
+
teamDrivePermissionDetails?: Array<{
|
|
31
|
+
/** Deprecated: Output only. Use `permissionDetails/inherited` instead. */
|
|
32
|
+
inherited?: boolean;
|
|
33
|
+
/** Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead. */
|
|
34
|
+
inheritedFrom?: string;
|
|
35
|
+
/** Deprecated: Output only. Use `permissionDetails/permissionType` instead. */
|
|
36
|
+
teamDrivePermissionType?: string;
|
|
37
|
+
/** Deprecated: Output only. Use `permissionDetails/role` instead. */
|
|
38
|
+
role?: string;
|
|
39
|
+
}>;
|
|
40
|
+
/** Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. */
|
|
41
|
+
deleted?: boolean;
|
|
42
|
+
/** Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. */
|
|
43
|
+
allowFileDiscovery?: boolean;
|
|
44
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. */
|
|
45
|
+
kind?: string;
|
|
46
|
+
/** The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). */
|
|
47
|
+
role?: string;
|
|
48
|
+
/** Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values. */
|
|
49
|
+
id?: string;
|
|
50
|
+
/** Output only. A link to the user's profile photo, if available. */
|
|
51
|
+
photoLink?: string;
|
|
52
|
+
/** When `true`, only organizers, owners, and users with permissions added directly on the item can access it. */
|
|
53
|
+
inheritedPermissionsDisabled?: boolean;
|
|
54
|
+
/** Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive. */
|
|
55
|
+
pendingOwner?: boolean;
|
|
56
|
+
/** The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future */
|
|
57
|
+
expirationTime?: string;
|
|
58
|
+
/** Output only. The email address of the user or group to which this permission refers. */
|
|
59
|
+
emailAddress?: string;
|
|
60
|
+
/** Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google Account, such as "Dana A." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "cymbalgroup.com." * `anyone` - No `displayName` is present. */
|
|
61
|
+
displayName?: string;
|
|
62
|
+
/** Output only. The domain to which this permission refers. */
|
|
63
|
+
domain?: string;
|
|
64
|
+
/** Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views). */
|
|
65
|
+
view?: string;
|
|
66
|
+
};
|
|
67
|
+
/** Representation of a reviewer addition. */
|
|
68
|
+
export type DriveAddReviewer = {
|
|
69
|
+
/** Required. The email of the reviewer to add. */
|
|
70
|
+
addedReviewerEmail?: string;
|
|
71
|
+
};
|
|
72
|
+
/** Deprecated: use the drive collection instead. Next ID: 33 */
|
|
73
|
+
export type DriveTeamDrive = {
|
|
74
|
+
/** Capabilities the current user has on this Team Drive. */
|
|
75
|
+
capabilities?: {
|
|
76
|
+
/** Whether the current user can edit files in this Team Drive */
|
|
77
|
+
canEdit?: boolean;
|
|
78
|
+
/** Whether the current user can list the children of folders in this Team Drive. */
|
|
79
|
+
canListChildren?: boolean;
|
|
80
|
+
/** Whether the current user can rename this Team Drive. */
|
|
81
|
+
canRenameTeamDrive?: boolean;
|
|
82
|
+
/** Whether the current user can change the `teamMembersOnly` restriction of this Team Drive. */
|
|
83
|
+
canChangeTeamMembersOnlyRestriction?: boolean;
|
|
84
|
+
/** Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive. */
|
|
85
|
+
canChangeSharingFoldersRequiresOrganizerPermissionRestriction?: boolean;
|
|
86
|
+
/** Whether the current user can read the revisions resource of files in this Team Drive. */
|
|
87
|
+
canReadRevisions?: boolean;
|
|
88
|
+
/** Whether the current user can change the `domainUsersOnly` restriction of this Team Drive. */
|
|
89
|
+
canChangeDomainUsersOnlyRestriction?: boolean;
|
|
90
|
+
/** Whether the current user can delete children from folders in this Team Drive. */
|
|
91
|
+
canDeleteChildren?: boolean;
|
|
92
|
+
/** Output only. Whether the current user can change organizer-applied download restrictions of this shared drive. */
|
|
93
|
+
canChangeDownloadRestriction?: boolean;
|
|
94
|
+
/** Whether the current user can reset the Team Drive restrictions to defaults. */
|
|
95
|
+
canResetTeamDriveRestrictions?: boolean;
|
|
96
|
+
/** Whether the current user can share files or folders in this Team Drive. */
|
|
97
|
+
canShare?: boolean;
|
|
98
|
+
/** Whether the current user can rename files or folders in this Team Drive. */
|
|
99
|
+
canRename?: boolean;
|
|
100
|
+
/** Whether the current user can add members to this Team Drive or remove them or change their role. */
|
|
101
|
+
canManageMembers?: boolean;
|
|
102
|
+
/** Whether the current user can change the background of this Team Drive. */
|
|
103
|
+
canChangeTeamDriveBackground?: boolean;
|
|
104
|
+
/** Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive. */
|
|
105
|
+
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
|
|
106
|
+
/** Whether the current user can add children to folders in this Team Drive. */
|
|
107
|
+
canAddChildren?: boolean;
|
|
108
|
+
/** Whether the current user can download files in this Team Drive. */
|
|
109
|
+
canDownload?: boolean;
|
|
110
|
+
/** Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. */
|
|
111
|
+
canDeleteTeamDrive?: boolean;
|
|
112
|
+
/** Whether the current user can copy files in this Team Drive. */
|
|
113
|
+
canCopy?: boolean;
|
|
114
|
+
/** Whether the current user can comment on files in this Team Drive. */
|
|
115
|
+
canComment?: boolean;
|
|
116
|
+
/** Whether the current user can trash children from folders in this Team Drive. */
|
|
117
|
+
canTrashChildren?: boolean;
|
|
118
|
+
/** Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead. */
|
|
119
|
+
canRemoveChildren?: boolean;
|
|
120
|
+
};
|
|
121
|
+
/** The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. */
|
|
122
|
+
id?: string;
|
|
123
|
+
/** A set of restrictions that apply to this Team Drive or items inside this Team Drive. */
|
|
124
|
+
restrictions?: {
|
|
125
|
+
/** If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. */
|
|
126
|
+
sharingFoldersRequiresOrganizerPermission?: boolean;
|
|
127
|
+
/** Whether access to items inside this Team Drive is restricted to members of this Team Drive. */
|
|
128
|
+
teamMembersOnly?: boolean;
|
|
129
|
+
/** Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive. */
|
|
130
|
+
copyRequiresWriterPermission?: boolean;
|
|
131
|
+
/** Whether administrative privileges on this Team Drive are required to modify restrictions. */
|
|
132
|
+
adminManagedRestrictions?: boolean;
|
|
133
|
+
/** Download restrictions applied by shared drive managers. */
|
|
134
|
+
downloadRestriction?: DriveDownloadRestriction;
|
|
135
|
+
/** Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. */
|
|
136
|
+
domainUsersOnly?: boolean;
|
|
137
|
+
};
|
|
138
|
+
/** The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`. */
|
|
139
|
+
orgUnitId?: string;
|
|
140
|
+
/** The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`. */
|
|
141
|
+
themeId?: string;
|
|
142
|
+
/** The name of this Team Drive. */
|
|
143
|
+
name?: string;
|
|
144
|
+
/** The background image file for a Team Drive. */
|
|
145
|
+
backgroundImageFile?: {
|
|
146
|
+
/** The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high. */
|
|
147
|
+
width?: number;
|
|
148
|
+
/** The ID of an image file in Drive to use for the background image. */
|
|
149
|
+
id?: string;
|
|
150
|
+
/** The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image. */
|
|
151
|
+
xCoordinate?: number;
|
|
152
|
+
/** The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image. */
|
|
153
|
+
yCoordinate?: number;
|
|
154
|
+
};
|
|
155
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#teamDrive"`. */
|
|
156
|
+
kind?: string;
|
|
157
|
+
/** A short-lived link to this Team Drive's background image. */
|
|
158
|
+
backgroundImageLink?: string;
|
|
159
|
+
/** The time at which the Team Drive was created (RFC 3339 date-time). */
|
|
160
|
+
createdTime?: string;
|
|
161
|
+
/** The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`. */
|
|
162
|
+
colorRgb?: string;
|
|
163
|
+
};
|
|
164
|
+
/** The response to an access proposal list request. */
|
|
165
|
+
export type DriveListAccessProposalsResponse = {
|
|
166
|
+
/** The continuation token for the next page of results. This will be absent if the end of the results list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */
|
|
167
|
+
nextPageToken?: string;
|
|
168
|
+
/** The list of access proposals. This field is only populated in Drive API v3. */
|
|
169
|
+
accessProposals?: Array<DriveAccessProposal>;
|
|
170
|
+
};
|
|
171
|
+
/** A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. */
|
|
172
|
+
export type DriveReply = {
|
|
173
|
+
/** The time at which the reply was created (RFC 3339 date-time). */
|
|
174
|
+
createdTime?: string;
|
|
175
|
+
/** Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty. */
|
|
176
|
+
mentionedEmailAddresses?: Array<string>;
|
|
177
|
+
/** Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset. */
|
|
178
|
+
assigneeEmailAddress?: string;
|
|
179
|
+
/** The plain text content of the reply. This field is used for setting the content, while `htmlContent` should be displayed. This field is required by the `create` method if no `action` value is specified. */
|
|
180
|
+
content?: string;
|
|
181
|
+
/** Output only. The ID of the reply. */
|
|
182
|
+
id?: string;
|
|
183
|
+
/** Output only. The author of the reply. The author's email address and permission ID won't be populated. */
|
|
184
|
+
author?: DriveUser;
|
|
185
|
+
/** The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen` */
|
|
186
|
+
action?: string;
|
|
187
|
+
/** Output only. Whether the reply has been deleted. A deleted reply has no content. */
|
|
188
|
+
deleted?: boolean;
|
|
189
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. */
|
|
190
|
+
kind?: string;
|
|
191
|
+
/** The last time the reply was modified (RFC 3339 date-time). */
|
|
192
|
+
modifiedTime?: string;
|
|
193
|
+
/** Output only. The content of the reply with HTML formatting. */
|
|
194
|
+
htmlContent?: string;
|
|
195
|
+
};
|
|
196
|
+
/** A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. */
|
|
197
|
+
export type DriveComment = {
|
|
198
|
+
/** Output only. Whether the comment has been resolved by one of its replies. */
|
|
199
|
+
resolved?: boolean;
|
|
200
|
+
/** Output only. The full list of replies to the comment in chronological order. */
|
|
201
|
+
replies?: Array<DriveReply>;
|
|
202
|
+
/** The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. */
|
|
203
|
+
quotedFileContent?: {
|
|
204
|
+
/** The quoted content itself. This is interpreted as plain text if set through the API. */
|
|
205
|
+
value?: string;
|
|
206
|
+
/** The MIME type of the quoted content. */
|
|
207
|
+
mimeType?: string;
|
|
208
|
+
};
|
|
209
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. */
|
|
210
|
+
kind?: string;
|
|
211
|
+
/** A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). */
|
|
212
|
+
anchor?: string;
|
|
213
|
+
/** The last time the comment or any of its replies was modified (RFC 3339 date-time). */
|
|
214
|
+
modifiedTime?: string;
|
|
215
|
+
/** Output only. The content of the comment with HTML formatting. */
|
|
216
|
+
htmlContent?: string;
|
|
217
|
+
/** Output only. The author of the comment. The author's email address and permission ID will not be populated. */
|
|
218
|
+
author?: DriveUser;
|
|
219
|
+
/** The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed. */
|
|
220
|
+
content?: string;
|
|
221
|
+
/** Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset. */
|
|
222
|
+
assigneeEmailAddress?: string;
|
|
223
|
+
/** Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty. */
|
|
224
|
+
mentionedEmailAddresses?: Array<string>;
|
|
225
|
+
/** Output only. Whether the comment has been deleted. A deleted comment has no content. */
|
|
226
|
+
deleted?: boolean;
|
|
227
|
+
/** Output only. The ID of the comment. */
|
|
228
|
+
id?: string;
|
|
229
|
+
/** The time at which the comment was created (RFC 3339 date-time). */
|
|
230
|
+
createdTime?: string;
|
|
231
|
+
};
|
|
232
|
+
/** A change to a file or shared drive. */
|
|
233
|
+
export type DriveChange = {
|
|
234
|
+
/** The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. */
|
|
235
|
+
drive?: DriveDrive;
|
|
236
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#change"`. */
|
|
237
|
+
kind?: string;
|
|
238
|
+
/** Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. */
|
|
239
|
+
removed?: boolean;
|
|
240
|
+
/** The time of this change (RFC 3339 date-time). */
|
|
241
|
+
time?: string;
|
|
242
|
+
/** Deprecated: Use `drive` instead. */
|
|
243
|
+
teamDrive?: DriveTeamDrive;
|
|
244
|
+
/** The ID of the shared drive associated with this change. */
|
|
245
|
+
driveId?: string;
|
|
246
|
+
/** Deprecated: Use `changeType` instead. */
|
|
247
|
+
type?: string;
|
|
248
|
+
/** Deprecated: Use `driveId` instead. */
|
|
249
|
+
teamDriveId?: string;
|
|
250
|
+
/** The ID of the file which has changed. */
|
|
251
|
+
fileId?: string;
|
|
252
|
+
/** The type of the change. Possible values are `file` and `drive`. */
|
|
253
|
+
changeType?: string;
|
|
254
|
+
/** The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. */
|
|
255
|
+
file?: DriveFile;
|
|
256
|
+
};
|
|
257
|
+
/** Representation of the CSE DecryptionMetadata. */
|
|
258
|
+
export type DriveDecryptionMetadata = {
|
|
259
|
+
/** The ID of the KACLS (Key ACL Service) used to encrypt the file. */
|
|
260
|
+
kaclsId?: string;
|
|
261
|
+
/** The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. */
|
|
262
|
+
jwt?: string;
|
|
263
|
+
/** The name of the KACLS (Key ACL Service) used to encrypt the file. */
|
|
264
|
+
kaclsName?: string;
|
|
265
|
+
/** Key format for the unwrapped key. Must be `tinkAesGcmKey`. */
|
|
266
|
+
keyFormat?: string;
|
|
267
|
+
/** The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. */
|
|
268
|
+
wrappedKey?: string;
|
|
269
|
+
/** The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference */
|
|
270
|
+
encryptionResourceKeyHash?: string;
|
|
271
|
+
/** Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small */
|
|
272
|
+
aes256GcmChunkSize?: string;
|
|
273
|
+
};
|
|
274
|
+
/** A modification to a label's field. */
|
|
275
|
+
export type DriveLabelFieldModification = {
|
|
276
|
+
/** Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD. */
|
|
277
|
+
setDateValues?: Array<string>;
|
|
278
|
+
/** Sets the value of a `text` field. */
|
|
279
|
+
setTextValues?: Array<string>;
|
|
280
|
+
/** Replaces the value of an `integer` field with these new values. */
|
|
281
|
+
setIntegerValues?: Array<string>;
|
|
282
|
+
/** Unsets the values for this field. */
|
|
283
|
+
unsetValues?: boolean;
|
|
284
|
+
/** This is always `"drive#labelFieldModification"`. */
|
|
285
|
+
kind?: string;
|
|
286
|
+
/** The ID of the field to be modified. */
|
|
287
|
+
fieldId?: string;
|
|
288
|
+
/** Replaces a `selection` field with these new values. */
|
|
289
|
+
setSelectionValues?: Array<string>;
|
|
290
|
+
/** Replaces a `user` field with these new values. The values must be a valid email addresses. */
|
|
291
|
+
setUserValues?: Array<string>;
|
|
292
|
+
};
|
|
293
|
+
/** The response of an approvals list request. */
|
|
294
|
+
export type DriveApprovalList = {
|
|
295
|
+
/** The page token for the next page of approvals. This is absent if the end of the approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. */
|
|
296
|
+
nextPageToken?: string;
|
|
297
|
+
/** The list of approvals. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
298
|
+
items?: Array<DriveApproval>;
|
|
299
|
+
/** This is always drive#approvalList */
|
|
300
|
+
kind?: string;
|
|
301
|
+
};
|
|
302
|
+
/** A list of shared drives. */
|
|
303
|
+
export type DriveDriveList = {
|
|
304
|
+
/** The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
305
|
+
drives?: Array<DriveDrive>;
|
|
306
|
+
/** The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
307
|
+
nextPageToken?: string;
|
|
308
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#driveList"`. */
|
|
309
|
+
kind?: string;
|
|
310
|
+
};
|
|
311
|
+
export type DriveStartPageToken = {
|
|
312
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#startPageToken"`. */
|
|
313
|
+
kind?: string;
|
|
314
|
+
/** The starting page token for listing future changes. The page token doesn't expire. */
|
|
315
|
+
startPageToken?: string;
|
|
316
|
+
};
|
|
317
|
+
/** Request for commenting on an approval. */
|
|
318
|
+
export type DriveCommentApprovalRequest = {
|
|
319
|
+
/** Required. A message to comment on the approval. This message is included in notifications for the action and in the approval activity log. */
|
|
320
|
+
message?: string;
|
|
321
|
+
};
|
|
322
|
+
/** A restriction for copy and download of the file. */
|
|
323
|
+
export type DriveDownloadRestriction = {
|
|
324
|
+
/** Whether download and copy is restricted for writers. If true, download is also restricted for readers. */
|
|
325
|
+
restrictedForWriters?: boolean;
|
|
326
|
+
/** Whether download and copy is restricted for readers. */
|
|
327
|
+
restrictedForReaders?: boolean;
|
|
328
|
+
};
|
|
329
|
+
/** A list of Team Drives. */
|
|
330
|
+
export type DriveTeamDriveList = {
|
|
331
|
+
/** The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
332
|
+
nextPageToken?: string;
|
|
333
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#teamDriveList"`. */
|
|
334
|
+
kind?: string;
|
|
335
|
+
/** The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
336
|
+
teamDrives?: Array<DriveTeamDrive>;
|
|
337
|
+
};
|
|
338
|
+
/** Request for reassigning an approval. Reviewers can be added or replaced, but not removed. */
|
|
339
|
+
export type DriveReassignApprovalRequest = {
|
|
340
|
+
/** Optional. The list of reviewer replacements. */
|
|
341
|
+
replaceReviewers?: Array<DriveReplaceReviewer>;
|
|
342
|
+
/** Optional. The list of reviewers to add. */
|
|
343
|
+
addReviewers?: Array<DriveAddReviewer>;
|
|
344
|
+
/** Optional. A message to send to the new reviewers. This message is included in notifications for the action and in the approval activity log. */
|
|
345
|
+
message?: string;
|
|
346
|
+
};
|
|
347
|
+
/** Representation of a reviewer replacement. */
|
|
348
|
+
export type DriveReplaceReviewer = {
|
|
349
|
+
/** Required. The email of the reviewer to add. */
|
|
350
|
+
addedReviewerEmail?: string;
|
|
351
|
+
/** Required. The email of the reviewer to remove. */
|
|
352
|
+
removedReviewerEmail?: string;
|
|
353
|
+
};
|
|
354
|
+
/** Representation of field, which is a typed key-value pair. */
|
|
355
|
+
export type DriveLabelField = {
|
|
356
|
+
/** Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. */
|
|
357
|
+
dateString?: Array<string>;
|
|
358
|
+
/** This is always drive#labelField. */
|
|
359
|
+
kind?: string;
|
|
360
|
+
/** The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` */
|
|
361
|
+
valueType?: string;
|
|
362
|
+
/** The identifier of this label field. */
|
|
363
|
+
id?: string;
|
|
364
|
+
/** Only present if `valueType` is `user`. */
|
|
365
|
+
user?: Array<DriveUser>;
|
|
366
|
+
/** Only present if `valueType` is `text`. */
|
|
367
|
+
text?: Array<string>;
|
|
368
|
+
/** Only present if `valueType` is `integer`. */
|
|
369
|
+
integer?: Array<string>;
|
|
370
|
+
/** Only present if `valueType` is `selection` */
|
|
371
|
+
selection?: Array<string>;
|
|
372
|
+
};
|
|
373
|
+
/** Metadata for an approval. An approval is a review or approve process for a Drive item. */
|
|
374
|
+
export type DriveApproval = {
|
|
375
|
+
/** The responses made on the approval by reviewers. */
|
|
376
|
+
reviewerResponses?: Array<DriveReviewerResponse>;
|
|
377
|
+
/** Target file id of the approval. */
|
|
378
|
+
targetFileId?: string;
|
|
379
|
+
/** Output only. The time the approval was created. */
|
|
380
|
+
createTime?: string;
|
|
381
|
+
/** The time that the approval is due. */
|
|
382
|
+
dueTime?: string;
|
|
383
|
+
/** The approval ID. */
|
|
384
|
+
approvalId?: string;
|
|
385
|
+
/** This is always drive#approval. */
|
|
386
|
+
kind?: string;
|
|
387
|
+
/** Output only. The status of the approval at the time this resource was requested. */
|
|
388
|
+
status?: "STATUS_UNSPECIFIED" | "IN_PROGRESS" | "APPROVED" | "CANCELLED" | "DECLINED";
|
|
389
|
+
/** Output only. The most recent time the approval was modified. */
|
|
390
|
+
modifyTime?: string;
|
|
391
|
+
/** Output only. The behavior of the approval when the file content changes. */
|
|
392
|
+
fileContentChangeBehavior?: "FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED" | "RESET_APPROVAL" | "NO_APPROVAL_ACTION";
|
|
393
|
+
/** The user that requested the approval. */
|
|
394
|
+
initiator?: DriveUser;
|
|
395
|
+
/** Output only. The time the approval was completed. */
|
|
396
|
+
completeTime?: string;
|
|
397
|
+
};
|
|
398
|
+
/** A list of changes for a user. */
|
|
399
|
+
export type DriveChangeList = {
|
|
400
|
+
/** The page token for the next page of changes. This will be absent if the end of the changes list has been reached. The page token doesn't expire. */
|
|
401
|
+
nextPageToken?: string;
|
|
402
|
+
/** The starting page token for future changes. This will be present only if the end of the current changes list has been reached. The page token doesn't expire. */
|
|
403
|
+
newStartPageToken?: string;
|
|
404
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#changeList"`. */
|
|
405
|
+
kind?: string;
|
|
406
|
+
/** The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
407
|
+
changes?: Array<DriveChange>;
|
|
408
|
+
};
|
|
409
|
+
/** Request for declining an approval as a reviewer. */
|
|
410
|
+
export type DriveDeclineApprovalRequest = {
|
|
411
|
+
/** Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log. */
|
|
412
|
+
message?: string;
|
|
413
|
+
};
|
|
414
|
+
/** A list of generated file IDs which can be provided in create requests. */
|
|
415
|
+
export type DriveGeneratedIds = {
|
|
416
|
+
/** The IDs generated for the requesting user in the specified space. */
|
|
417
|
+
ids?: Array<string>;
|
|
418
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#generatedIds"`. */
|
|
419
|
+
kind?: string;
|
|
420
|
+
/** The type of file that can be created with these IDs. */
|
|
421
|
+
space?: string;
|
|
422
|
+
};
|
|
423
|
+
/** Details about the client-side encryption applied to the file. */
|
|
424
|
+
export type DriveClientEncryptionDetails = {
|
|
425
|
+
/** The encryption state of the file. The values expected here are: - encrypted - unencrypted */
|
|
426
|
+
encryptionState?: string;
|
|
427
|
+
/** The metadata used for client-side operations. */
|
|
428
|
+
decryptionMetadata?: DriveDecryptionMetadata;
|
|
429
|
+
};
|
|
430
|
+
/** A list of revisions of a file. */
|
|
431
|
+
export type DriveRevisionList = {
|
|
432
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#revisionList"`. */
|
|
433
|
+
kind?: string;
|
|
434
|
+
/** The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
435
|
+
nextPageToken?: string;
|
|
436
|
+
/** The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
437
|
+
revisions?: Array<DriveRevision>;
|
|
438
|
+
};
|
|
439
|
+
/** A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file. */
|
|
440
|
+
export type DriveLabelModification = {
|
|
441
|
+
/** The ID of the label to modify. */
|
|
442
|
+
labelId?: string;
|
|
443
|
+
/** This is always `"drive#labelModification"`. */
|
|
444
|
+
kind?: string;
|
|
445
|
+
/** If true, the label will be removed from the file. */
|
|
446
|
+
removeLabel?: boolean;
|
|
447
|
+
/** The list of modifications to this label's fields. */
|
|
448
|
+
fieldModifications?: Array<DriveLabelFieldModification>;
|
|
449
|
+
};
|
|
450
|
+
/** A notification channel used to watch for resource changes. */
|
|
451
|
+
export type DriveChannel = {
|
|
452
|
+
/** The address where notifications are delivered for this channel. */
|
|
453
|
+
address?: string;
|
|
454
|
+
/** The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook". */
|
|
455
|
+
type?: string;
|
|
456
|
+
/** A UUID or similar unique string that identifies this channel. */
|
|
457
|
+
id?: string;
|
|
458
|
+
/** A version-specific identifier for the watched resource. */
|
|
459
|
+
resourceUri?: string;
|
|
460
|
+
/** A Boolean value to indicate whether payload is wanted. Optional. */
|
|
461
|
+
payload?: boolean;
|
|
462
|
+
/** Additional parameters controlling delivery channel behavior. Optional. */
|
|
463
|
+
params?: Record<string, string>;
|
|
464
|
+
/** Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. */
|
|
465
|
+
expiration?: string;
|
|
466
|
+
/** An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. */
|
|
467
|
+
token?: string;
|
|
468
|
+
/** An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. */
|
|
469
|
+
resourceId?: string;
|
|
470
|
+
/** Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. */
|
|
471
|
+
kind?: string;
|
|
472
|
+
};
|
|
473
|
+
/** Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request. */
|
|
474
|
+
export type DriveModifyLabelsResponse = {
|
|
475
|
+
/** This is always `"drive#modifyLabelsResponse"`. */
|
|
476
|
+
kind?: string;
|
|
477
|
+
/** The list of labels which were added or updated by the request. */
|
|
478
|
+
modifiedLabels?: Array<DriveLabel>;
|
|
479
|
+
};
|
|
480
|
+
/** A list of replies to a comment on a file. */
|
|
481
|
+
export type DriveReplyList = {
|
|
482
|
+
/** The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
483
|
+
nextPageToken?: string;
|
|
484
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#replyList"`. */
|
|
485
|
+
kind?: string;
|
|
486
|
+
/** The list of replies. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
487
|
+
replies?: Array<DriveReply>;
|
|
488
|
+
};
|
|
489
|
+
/** A list of files. */
|
|
490
|
+
export type DriveFileList = {
|
|
491
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#fileList"`. */
|
|
492
|
+
kind?: string;
|
|
493
|
+
/** Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`. */
|
|
494
|
+
incompleteSearch?: boolean;
|
|
495
|
+
/** The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
496
|
+
nextPageToken?: string;
|
|
497
|
+
/** The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
498
|
+
files?: Array<DriveFile>;
|
|
499
|
+
};
|
|
500
|
+
/** The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision. */
|
|
501
|
+
export type DriveRevision = {
|
|
502
|
+
/** Output only. A link to the published revision. This is only populated for Docs Editors files. */
|
|
503
|
+
publishedLink?: string;
|
|
504
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`. */
|
|
505
|
+
kind?: string;
|
|
506
|
+
/** Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive. */
|
|
507
|
+
size?: string;
|
|
508
|
+
/** Whether this revision is published outside the domain. This is only applicable to Docs Editors files. */
|
|
509
|
+
publishedOutsideDomain?: boolean;
|
|
510
|
+
/** Output only. The ID of the revision. */
|
|
511
|
+
id?: string;
|
|
512
|
+
/** Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive. */
|
|
513
|
+
md5Checksum?: string;
|
|
514
|
+
/** Output only. Links for exporting Docs Editors files to specific formats. */
|
|
515
|
+
exportLinks?: Record<string, string>;
|
|
516
|
+
/** Output only. The MIME type of the revision. */
|
|
517
|
+
mimeType?: string;
|
|
518
|
+
/** Whether this revision is published. This is only applicable to Docs Editors files. */
|
|
519
|
+
published?: boolean;
|
|
520
|
+
/** The last time the revision was modified (RFC 3339 date-time). */
|
|
521
|
+
modifiedTime?: string;
|
|
522
|
+
/** Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files. */
|
|
523
|
+
publishAuto?: boolean;
|
|
524
|
+
/** Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. */
|
|
525
|
+
lastModifyingUser?: DriveUser;
|
|
526
|
+
/** Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive. */
|
|
527
|
+
originalFilename?: string;
|
|
528
|
+
/** Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive. */
|
|
529
|
+
keepForever?: boolean;
|
|
530
|
+
};
|
|
531
|
+
export type DriveAppIcons = {
|
|
532
|
+
/** URL for the icon. */
|
|
533
|
+
iconUrl?: string;
|
|
534
|
+
/** Category of the icon. Allowed values are: * `application` - The icon for the application. * `document` - The icon for a file associated with the app. * `documentShared` - The icon for a shared file associated with the app. */
|
|
535
|
+
category?: string;
|
|
536
|
+
/** Size of the icon. Represented as the maximum of the width and height. */
|
|
537
|
+
size?: number;
|
|
538
|
+
};
|
|
539
|
+
/** Manage outstanding access proposals on a file. */
|
|
540
|
+
export type DriveAccessProposal = {
|
|
541
|
+
/** The email address of the requesting user. */
|
|
542
|
+
requesterEmailAddress?: string;
|
|
543
|
+
/** The email address of the user that will receive permissions, if accepted. */
|
|
544
|
+
recipientEmailAddress?: string;
|
|
545
|
+
/** The message that the requester added to the proposal. */
|
|
546
|
+
requestMessage?: string;
|
|
547
|
+
/** The file ID that the proposal for access is on. */
|
|
548
|
+
fileId?: string;
|
|
549
|
+
/** The ID of the access proposal. */
|
|
550
|
+
proposalId?: string;
|
|
551
|
+
/** The creation time. */
|
|
552
|
+
createTime?: string;
|
|
553
|
+
/** A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). */
|
|
554
|
+
rolesAndViews?: Array<DriveAccessProposalRoleAndView>;
|
|
555
|
+
};
|
|
556
|
+
/** Download restrictions applied to the file. */
|
|
557
|
+
export type DriveDownloadRestrictionsMetadata = {
|
|
558
|
+
/** The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. */
|
|
559
|
+
itemDownloadRestriction?: DriveDownloadRestriction;
|
|
560
|
+
/** Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. */
|
|
561
|
+
effectiveDownloadRestrictionWithContext?: DriveDownloadRestriction;
|
|
562
|
+
};
|
|
563
|
+
/** Information about a Drive user. */
|
|
564
|
+
export type DriveUser = {
|
|
565
|
+
/** Output only. A plain text displayable name for this user. */
|
|
566
|
+
displayName?: string;
|
|
567
|
+
/** Output only. A link to the user's profile photo, if available. */
|
|
568
|
+
photoLink?: string;
|
|
569
|
+
/** Output only. The user's ID as visible in Permission resources. */
|
|
570
|
+
permissionId?: string;
|
|
571
|
+
/** Output only. Whether this user is the requesting user. */
|
|
572
|
+
me?: boolean;
|
|
573
|
+
/** Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. */
|
|
574
|
+
emailAddress?: string;
|
|
575
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. */
|
|
576
|
+
kind?: string;
|
|
577
|
+
};
|
|
578
|
+
/** A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). */
|
|
579
|
+
export type DriveAccessProposalRoleAndView = {
|
|
580
|
+
/** The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader` */
|
|
581
|
+
role?: string;
|
|
582
|
+
/** Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported. */
|
|
583
|
+
view?: string;
|
|
584
|
+
};
|
|
585
|
+
/** A list of labels applied to a file. */
|
|
586
|
+
export type DriveLabelList = {
|
|
587
|
+
/** The list of labels. */
|
|
588
|
+
labels?: Array<DriveLabel>;
|
|
589
|
+
/** This is always `"drive#labelList"`. */
|
|
590
|
+
kind?: string;
|
|
591
|
+
/** The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
592
|
+
nextPageToken?: string;
|
|
593
|
+
};
|
|
594
|
+
/** A list of third-party applications which the user has installed or given access to Google Drive. */
|
|
595
|
+
export type DriveAppList = {
|
|
596
|
+
/** A link back to this list. */
|
|
597
|
+
selfLink?: string;
|
|
598
|
+
/** The list of app IDs that the user has specified to use by default. The list is in reverse-priority order (lowest to highest). */
|
|
599
|
+
defaultAppIds?: Array<string>;
|
|
600
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string "drive#appList". */
|
|
601
|
+
kind?: string;
|
|
602
|
+
/** The list of apps. */
|
|
603
|
+
items?: Array<DriveApp>;
|
|
604
|
+
};
|
|
605
|
+
/** JWT and associated metadata used to generate CSE files. */
|
|
606
|
+
export type DriveGenerateCseTokenResponse = {
|
|
607
|
+
/** The fileId for which the JWT was generated. */
|
|
608
|
+
fileId?: string;
|
|
609
|
+
/** Name of the KACLs that the returned KACLs ID points to. */
|
|
610
|
+
currentKaclsName?: string;
|
|
611
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#generateCseTokenResponse"`. */
|
|
612
|
+
kind?: string;
|
|
613
|
+
/** The current Key ACL Service (KACLS) ID associated with the JWT. */
|
|
614
|
+
currentKaclsId?: string;
|
|
615
|
+
/** The signed JSON Web Token (JWT) for the file. */
|
|
616
|
+
jwt?: string;
|
|
617
|
+
};
|
|
618
|
+
/** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
|
|
619
|
+
export type DriveStatus = {
|
|
620
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
621
|
+
code?: number;
|
|
622
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
623
|
+
details?: Array<Record<string, unknown>>;
|
|
624
|
+
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
625
|
+
message?: string;
|
|
626
|
+
};
|
|
627
|
+
/** A list of permissions for a file. */
|
|
628
|
+
export type DrivePermissionList = {
|
|
629
|
+
/** The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
630
|
+
permissions?: Array<DrivePermission>;
|
|
631
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#permissionList"`. */
|
|
632
|
+
kind?: string;
|
|
633
|
+
/** The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
634
|
+
nextPageToken?: string;
|
|
635
|
+
};
|
|
636
|
+
/** Allows creating an approval on a file. */
|
|
637
|
+
export type DriveStartApprovalRequest = {
|
|
638
|
+
/** Optional. The behavior of the approval when the file content changes. */
|
|
639
|
+
fileContentChangeBehavior?: "FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED" | "RESET_APPROVAL" | "NO_APPROVAL_ACTION";
|
|
640
|
+
/** Required. The emails of the users who are set to review the approval. */
|
|
641
|
+
reviewerEmails?: Array<string>;
|
|
642
|
+
/** Optional. Whether to lock the file when starting the approval. */
|
|
643
|
+
lockFile?: boolean;
|
|
644
|
+
/** Optional. The time that the approval is due. */
|
|
645
|
+
dueTime?: string;
|
|
646
|
+
/** Optional. A message to send to reviewers when notifying them of the approval request. */
|
|
647
|
+
message?: string;
|
|
648
|
+
};
|
|
649
|
+
/** A list of comments on a file. */
|
|
650
|
+
export type DriveCommentList = {
|
|
651
|
+
/** The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
|
652
|
+
comments?: Array<DriveComment>;
|
|
653
|
+
/** The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. */
|
|
654
|
+
nextPageToken?: string;
|
|
655
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#commentList"`. */
|
|
656
|
+
kind?: string;
|
|
657
|
+
};
|
|
658
|
+
/** Representation of label and label fields. */
|
|
659
|
+
export type DriveLabel = {
|
|
660
|
+
/** This is always drive#label */
|
|
661
|
+
kind?: string;
|
|
662
|
+
/** The ID of the label. */
|
|
663
|
+
id?: string;
|
|
664
|
+
/** A map of the fields on the label, keyed by the field's ID. */
|
|
665
|
+
fields?: Record<string, DriveLabelField>;
|
|
666
|
+
/** The revision ID of the label. */
|
|
667
|
+
revisionId?: string;
|
|
668
|
+
};
|
|
669
|
+
/** Request for cancelling an approval as an initiator. */
|
|
670
|
+
export type DriveCancelApprovalRequest = {
|
|
671
|
+
/** Optional. A message to accompany the cancellation of the approval. This message is included in notifications for the action and in the approval activity log. */
|
|
672
|
+
message?: string;
|
|
673
|
+
};
|
|
674
|
+
/** A response on an approval made by a specific reviewer. */
|
|
675
|
+
export type DriveReviewerResponse = {
|
|
676
|
+
/** This is always drive#reviewerResponse. */
|
|
677
|
+
kind?: string;
|
|
678
|
+
/** The user that's responsible for this response. */
|
|
679
|
+
reviewer?: DriveUser;
|
|
680
|
+
/** A reviewer’s response for the approval. */
|
|
681
|
+
response?: "RESPONSE_UNSPECIFIED" | "NO_RESPONSE" | "APPROVED" | "DECLINED";
|
|
682
|
+
};
|
|
683
|
+
/** A restriction for accessing the content of the file. */
|
|
684
|
+
export type DriveContentRestriction = {
|
|
685
|
+
/** Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions. */
|
|
686
|
+
systemRestricted?: boolean;
|
|
687
|
+
/** Output only. The user who set the content restriction. Only populated if `readOnly=true`. */
|
|
688
|
+
restrictingUser?: DriveUser;
|
|
689
|
+
/** Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. */
|
|
690
|
+
readOnly?: boolean;
|
|
691
|
+
/** Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. */
|
|
692
|
+
ownerRestricted?: boolean;
|
|
693
|
+
/** Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. */
|
|
694
|
+
reason?: string;
|
|
695
|
+
/** Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. */
|
|
696
|
+
type?: string;
|
|
697
|
+
/** The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. */
|
|
698
|
+
restrictionTime?: string;
|
|
699
|
+
};
|
|
700
|
+
/** Request for approving an approval as a reviewer. */
|
|
701
|
+
export type DriveApproveApprovalRequest = {
|
|
702
|
+
/** Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log. */
|
|
703
|
+
message?: string;
|
|
704
|
+
};
|
|
705
|
+
/** The `apps` resource provides a list of apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details. Some resource methods (such as `apps.get`) require an `appId`. Use the `apps.list` method to retrieve the ID for an installed application. */
|
|
706
|
+
export type DriveApp = {
|
|
707
|
+
/** A long description of the app. */
|
|
708
|
+
longDescription?: string;
|
|
709
|
+
/** Whether this app supports creating files when offline. */
|
|
710
|
+
supportsOfflineCreate?: boolean;
|
|
711
|
+
/** The list of primary file extensions. */
|
|
712
|
+
primaryFileExtensions?: Array<string>;
|
|
713
|
+
/** The name of the app. */
|
|
714
|
+
name?: string;
|
|
715
|
+
/** The URL to create a file with this app. */
|
|
716
|
+
createUrl?: string;
|
|
717
|
+
/** Whether the app is authorized to access data on the user's Drive. */
|
|
718
|
+
authorized?: boolean;
|
|
719
|
+
/** Whether the app is selected as the default handler for the types it supports. */
|
|
720
|
+
useByDefault?: boolean;
|
|
721
|
+
/** The template URL to create a file with this app in a given folder. The template contains the {folderId} to be replaced by the folder ID house the new file. */
|
|
722
|
+
createInFolderTemplate?: string;
|
|
723
|
+
/** The various icons for the app. */
|
|
724
|
+
icons?: Array<DriveAppIcons>;
|
|
725
|
+
/** The type of object this app creates such as a Chart. If empty, the app name should be used instead. */
|
|
726
|
+
objectType?: string;
|
|
727
|
+
/** The ID of the app. */
|
|
728
|
+
id?: string;
|
|
729
|
+
/** The list of secondary MIME types. */
|
|
730
|
+
secondaryMimeTypes?: Array<string>;
|
|
731
|
+
/** The ID of the product listing for this app. */
|
|
732
|
+
productId?: string;
|
|
733
|
+
/** The template URL for opening files with this app. The template contains {ids} or {exportIds} to be replaced by the actual file IDs. For more information, see Open Files for the full documentation. */
|
|
734
|
+
openUrlTemplate?: string;
|
|
735
|
+
/** Whether this app supports opening more than one file. */
|
|
736
|
+
supportsMultiOpen?: boolean;
|
|
737
|
+
/** Whether this app supports importing from Google Docs. */
|
|
738
|
+
supportsImport?: boolean;
|
|
739
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string "drive#app". */
|
|
740
|
+
kind?: string;
|
|
741
|
+
/** Whether the app has Drive-wide scope. An app with Drive-wide scope can access all files in the user's Drive. */
|
|
742
|
+
hasDriveWideScope?: boolean;
|
|
743
|
+
/** A link to the product listing for this app. */
|
|
744
|
+
productUrl?: string;
|
|
745
|
+
/** The list of secondary file extensions. */
|
|
746
|
+
secondaryFileExtensions?: Array<string>;
|
|
747
|
+
/** Whether the app is installed. */
|
|
748
|
+
installed?: boolean;
|
|
749
|
+
/** A short description of the app. */
|
|
750
|
+
shortDescription?: string;
|
|
751
|
+
/** The list of primary MIME types. */
|
|
752
|
+
primaryMimeTypes?: Array<string>;
|
|
753
|
+
/** Whether this app supports creating objects. */
|
|
754
|
+
supportsCreate?: boolean;
|
|
755
|
+
};
|
|
756
|
+
/** The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file. */
|
|
757
|
+
export type DriveFile = {
|
|
758
|
+
/** Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. */
|
|
759
|
+
hasAugmentedPermissions?: boolean;
|
|
760
|
+
/** Whether the user has starred the file. */
|
|
761
|
+
starred?: boolean;
|
|
762
|
+
/** Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. */
|
|
763
|
+
trashed?: boolean;
|
|
764
|
+
/** Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. */
|
|
765
|
+
sha1Checksum?: string;
|
|
766
|
+
/** The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. */
|
|
767
|
+
originalFilename?: string;
|
|
768
|
+
/** Output only. List of permission IDs for users with access to this file. */
|
|
769
|
+
permissionIds?: Array<string>;
|
|
770
|
+
/** The last time the file was modified by the user (RFC 3339 date-time). */
|
|
771
|
+
modifiedByMeTime?: string;
|
|
772
|
+
/** Output only. Additional metadata about video media. This may not be available immediately upon upload. */
|
|
773
|
+
videoMediaMetadata?: {
|
|
774
|
+
/** Output only. The duration of the video in milliseconds. */
|
|
775
|
+
durationMillis?: string;
|
|
776
|
+
/** Output only. The width of the video in pixels. */
|
|
777
|
+
width?: number;
|
|
778
|
+
/** Output only. The height of the video in pixels. */
|
|
779
|
+
height?: number;
|
|
780
|
+
};
|
|
781
|
+
/** Output only. Whether the file was created or opened by the requesting app. */
|
|
782
|
+
isAppAuthorized?: boolean;
|
|
783
|
+
/** Output only. Whether the file has been shared. Not populated for items in shared drives. */
|
|
784
|
+
shared?: boolean;
|
|
785
|
+
/** Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder. */
|
|
786
|
+
explicitlyTrashed?: boolean;
|
|
787
|
+
/** Output only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. */
|
|
788
|
+
permissions?: Array<DrivePermission>;
|
|
789
|
+
/** Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. */
|
|
790
|
+
clientEncryptionDetails?: DriveClientEncryptionDetails;
|
|
791
|
+
/** Additional information about the content of the file. These fields are never populated in responses. */
|
|
792
|
+
contentHints?: {
|
|
793
|
+
/** A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. */
|
|
794
|
+
thumbnail?: {
|
|
795
|
+
/** The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). */
|
|
796
|
+
image?: string;
|
|
797
|
+
/** The MIME type of the thumbnail. */
|
|
798
|
+
mimeType?: string;
|
|
799
|
+
};
|
|
800
|
+
/** Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. */
|
|
801
|
+
indexableText?: string;
|
|
802
|
+
};
|
|
803
|
+
/** Output only. The user who shared the file with the requesting user, if applicable. */
|
|
804
|
+
sharingUser?: DriveUser;
|
|
805
|
+
/** Contains details about the link URLs that clients are using to refer to this item. */
|
|
806
|
+
linkShareMetadata?: {
|
|
807
|
+
/** Output only. Whether the security update is enabled for this file. */
|
|
808
|
+
securityUpdateEnabled?: boolean;
|
|
809
|
+
/** Output only. Whether the file is eligible for security update. */
|
|
810
|
+
securityUpdateEligible?: boolean;
|
|
811
|
+
};
|
|
812
|
+
/** Deprecated: Use `copyRequiresWriterPermission` instead. */
|
|
813
|
+
viewersCanCopyContent?: boolean;
|
|
814
|
+
/** Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. */
|
|
815
|
+
sha256Checksum?: string;
|
|
816
|
+
/** Whether the options to copy, print, or download this file should be disabled for readers and commenters. */
|
|
817
|
+
copyRequiresWriterPermission?: boolean;
|
|
818
|
+
/** Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. */
|
|
819
|
+
md5Checksum?: string;
|
|
820
|
+
/** The last time the file was viewed by the user (RFC 3339 date-time). */
|
|
821
|
+
viewedByMeTime?: string;
|
|
822
|
+
/** Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. */
|
|
823
|
+
lastModifyingUser?: DriveUser;
|
|
824
|
+
/** Output only. Links for exporting Docs Editors files to specific formats. */
|
|
825
|
+
exportLinks?: Record<string, string>;
|
|
826
|
+
/** The time at which the file was created (RFC 3339 date-time). */
|
|
827
|
+
createdTime?: string;
|
|
828
|
+
/** The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. */
|
|
829
|
+
name?: string;
|
|
830
|
+
/** Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. */
|
|
831
|
+
spaces?: Array<string>;
|
|
832
|
+
/** Output only. Whether the file has been viewed by this user. */
|
|
833
|
+
viewedByMe?: boolean;
|
|
834
|
+
/** Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. */
|
|
835
|
+
fileExtension?: string;
|
|
836
|
+
/** Output only. Additional metadata about image media, if available. */
|
|
837
|
+
imageMediaMetadata?: {
|
|
838
|
+
/** Output only. The exposure mode used to create the photo. */
|
|
839
|
+
exposureMode?: string;
|
|
840
|
+
/** Output only. The make of the camera used to create the photo. */
|
|
841
|
+
cameraMake?: string;
|
|
842
|
+
/** Output only. The aperture used to create the photo (f-number). */
|
|
843
|
+
aperture?: number;
|
|
844
|
+
/** Output only. The length of the exposure, in seconds. */
|
|
845
|
+
exposureTime?: number;
|
|
846
|
+
/** Output only. The type of sensor used to create the photo. */
|
|
847
|
+
sensor?: string;
|
|
848
|
+
/** Output only. The distance to the subject of the photo, in meters. */
|
|
849
|
+
subjectDistance?: number;
|
|
850
|
+
/** Output only. The focal length used to create the photo, in millimeters. */
|
|
851
|
+
focalLength?: number;
|
|
852
|
+
/** Output only. The width of the image in pixels. */
|
|
853
|
+
width?: number;
|
|
854
|
+
/** Output only. The ISO speed used to create the photo. */
|
|
855
|
+
isoSpeed?: number;
|
|
856
|
+
/** Output only. The lens used to create the photo. */
|
|
857
|
+
lens?: string;
|
|
858
|
+
/** Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. */
|
|
859
|
+
rotation?: number;
|
|
860
|
+
/** Output only. The height of the image in pixels. */
|
|
861
|
+
height?: number;
|
|
862
|
+
/** Output only. The white balance mode used to create the photo. */
|
|
863
|
+
whiteBalance?: string;
|
|
864
|
+
/** Output only. The model of the camera used to create the photo. */
|
|
865
|
+
cameraModel?: string;
|
|
866
|
+
/** Output only. The date and time the photo was taken (EXIF DateTime). */
|
|
867
|
+
time?: string;
|
|
868
|
+
/** Output only. Whether a flash was used to create the photo. */
|
|
869
|
+
flashUsed?: boolean;
|
|
870
|
+
/** Output only. Geographic location information stored in the image. */
|
|
871
|
+
location?: {
|
|
872
|
+
/** Output only. The altitude stored in the image. */
|
|
873
|
+
altitude?: number;
|
|
874
|
+
/** Output only. The latitude stored in the image. */
|
|
875
|
+
latitude?: number;
|
|
876
|
+
/** Output only. The longitude stored in the image. */
|
|
877
|
+
longitude?: number;
|
|
878
|
+
};
|
|
879
|
+
/** Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). */
|
|
880
|
+
maxApertureValue?: number;
|
|
881
|
+
/** Output only. The color space of the photo. */
|
|
882
|
+
colorSpace?: string;
|
|
883
|
+
/** Output only. The metering mode used to create the photo. */
|
|
884
|
+
meteringMode?: string;
|
|
885
|
+
/** Output only. The exposure bias of the photo (APEX value). */
|
|
886
|
+
exposureBias?: number;
|
|
887
|
+
};
|
|
888
|
+
/** A short description of the file. */
|
|
889
|
+
description?: string;
|
|
890
|
+
/** Label information on the file. */
|
|
891
|
+
labelInfo?: {
|
|
892
|
+
/** Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned. */
|
|
893
|
+
labels?: Array<DriveLabel>;
|
|
894
|
+
};
|
|
895
|
+
/** Output only. Whether the user owns the file. Not populated for items in shared drives. */
|
|
896
|
+
ownedByMe?: boolean;
|
|
897
|
+
/** The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](https://developers.google.com/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. */
|
|
898
|
+
folderColorRgb?: string;
|
|
899
|
+
/** Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives. */
|
|
900
|
+
writersCanShare?: boolean;
|
|
901
|
+
/** Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. */
|
|
902
|
+
webContentLink?: string;
|
|
903
|
+
/** Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. */
|
|
904
|
+
trashingUser?: DriveUser;
|
|
905
|
+
/** Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. */
|
|
906
|
+
driveId?: string;
|
|
907
|
+
/** Information about a shortcut file. */
|
|
908
|
+
shortcutDetails?: {
|
|
909
|
+
/** The ID of the file that this shortcut points to. Can only be set on `files.create` requests. */
|
|
910
|
+
targetId?: string;
|
|
911
|
+
/** Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. */
|
|
912
|
+
targetMimeType?: string;
|
|
913
|
+
/** Output only. The `resourceKey` for the target file. */
|
|
914
|
+
targetResourceKey?: string;
|
|
915
|
+
};
|
|
916
|
+
/** Restrictions for accessing the content of the file. Only populated if such a restriction exists. */
|
|
917
|
+
contentRestrictions?: Array<DriveContentRestriction>;
|
|
918
|
+
/** Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. */
|
|
919
|
+
hasThumbnail?: boolean;
|
|
920
|
+
/** Deprecated: Output only. Use `driveId` instead. */
|
|
921
|
+
teamDriveId?: string;
|
|
922
|
+
/** he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. */
|
|
923
|
+
modifiedTime?: string;
|
|
924
|
+
/** The time at which the file was shared with the user, if applicable (RFC 3339 date-time). */
|
|
925
|
+
sharedWithMeTime?: string;
|
|
926
|
+
/** Output only. A key needed to access the item via a shared link. */
|
|
927
|
+
resourceKey?: string;
|
|
928
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`. */
|
|
929
|
+
kind?: string;
|
|
930
|
+
/** Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives. */
|
|
931
|
+
owners?: Array<DriveUser>;
|
|
932
|
+
/** The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. */
|
|
933
|
+
parents?: Array<string>;
|
|
934
|
+
/** Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. */
|
|
935
|
+
thumbnailLink?: string;
|
|
936
|
+
/** Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. */
|
|
937
|
+
headRevisionId?: string;
|
|
938
|
+
/** The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. */
|
|
939
|
+
trashedTime?: string;
|
|
940
|
+
/** A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties. */
|
|
941
|
+
appProperties?: Record<string, string>;
|
|
942
|
+
/** Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). */
|
|
943
|
+
capabilities?: {
|
|
944
|
+
/** Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
|
945
|
+
canDeleteChildren?: boolean;
|
|
946
|
+
/** Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. */
|
|
947
|
+
canChangeSecurityUpdateEnabled?: boolean;
|
|
948
|
+
/** Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
|
949
|
+
canTrashChildren?: boolean;
|
|
950
|
+
/** Deprecated: Output only. */
|
|
951
|
+
canChangeViewersCanCopyContent?: boolean;
|
|
952
|
+
/** Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. */
|
|
953
|
+
canAcceptOwnership?: boolean;
|
|
954
|
+
/** Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. */
|
|
955
|
+
canListChildren?: boolean;
|
|
956
|
+
/** Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. */
|
|
957
|
+
canMoveItemWithinDrive?: boolean;
|
|
958
|
+
/** Output only. Whether there's a content restriction on the file that can be removed by the current user. */
|
|
959
|
+
canRemoveContentRestriction?: boolean;
|
|
960
|
+
/** Output only. Whether the current user can read the labels on the file. */
|
|
961
|
+
canReadLabels?: boolean;
|
|
962
|
+
/** Output only. Whether the current user can restore this file from trash. */
|
|
963
|
+
canUntrash?: boolean;
|
|
964
|
+
/** Output only. Whether the current user can move this file to trash. */
|
|
965
|
+
canTrash?: boolean;
|
|
966
|
+
/** Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. */
|
|
967
|
+
canMoveTeamDriveItem?: boolean;
|
|
968
|
+
/** Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. */
|
|
969
|
+
canAddChildren?: boolean;
|
|
970
|
+
/** Whether the current user can start an approval on the file. */
|
|
971
|
+
canStartApproval?: boolean;
|
|
972
|
+
/** Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. */
|
|
973
|
+
canRemoveChildren?: boolean;
|
|
974
|
+
/** Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. */
|
|
975
|
+
canReadRevisions?: boolean;
|
|
976
|
+
/** Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. */
|
|
977
|
+
canMoveItemIntoTeamDrive?: boolean;
|
|
978
|
+
/** Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility). */
|
|
979
|
+
canAccessViaGenAi?: boolean;
|
|
980
|
+
/** Output only. Whether the current user can modify the labels on the file. */
|
|
981
|
+
canModifyLabels?: boolean;
|
|
982
|
+
/** Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. */
|
|
983
|
+
canChangeItemDownloadRestriction?: boolean;
|
|
984
|
+
/** Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. */
|
|
985
|
+
canRemoveMyDriveParent?: boolean;
|
|
986
|
+
/** Output only. Whether the current user can rename this file. */
|
|
987
|
+
canRename?: boolean;
|
|
988
|
+
/** Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. */
|
|
989
|
+
canMoveChildrenWithinDrive?: boolean;
|
|
990
|
+
/** Output only. Whether the current user can delete this file. */
|
|
991
|
+
canDelete?: boolean;
|
|
992
|
+
/** Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. */
|
|
993
|
+
canCopy?: boolean;
|
|
994
|
+
/** Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. */
|
|
995
|
+
canMoveChildrenWithinTeamDrive?: boolean;
|
|
996
|
+
/** Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. */
|
|
997
|
+
canModifyEditorContentRestriction?: boolean;
|
|
998
|
+
/** Whether a user can re-enable inherited permissions. */
|
|
999
|
+
canEnableInheritedPermissions?: boolean;
|
|
1000
|
+
/** Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. */
|
|
1001
|
+
canMoveChildrenOutOfTeamDrive?: boolean;
|
|
1002
|
+
/** Deprecated: Output only. Use `canMoveItemWithinDrive` instead. */
|
|
1003
|
+
canMoveItemWithinTeamDrive?: boolean;
|
|
1004
|
+
/** Output only. Whether the current user can add or modify content restrictions which are owner restricted. */
|
|
1005
|
+
canModifyOwnerContentRestriction?: boolean;
|
|
1006
|
+
/** Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. */
|
|
1007
|
+
canModifyContentRestriction?: boolean;
|
|
1008
|
+
/** Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. */
|
|
1009
|
+
canMoveItemOutOfTeamDrive?: boolean;
|
|
1010
|
+
/** Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
|
1011
|
+
canAddFolderFromAnotherDrive?: boolean;
|
|
1012
|
+
/** Output only. Whether the current user can modify the content of this file. */
|
|
1013
|
+
canModifyContent?: boolean;
|
|
1014
|
+
/** Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
|
1015
|
+
canMoveChildrenOutOfDrive?: boolean;
|
|
1016
|
+
/** Output only. Whether the current user can download this file. */
|
|
1017
|
+
canDownload?: boolean;
|
|
1018
|
+
/** Deprecated: Output only. Use `canReadDrive` instead. */
|
|
1019
|
+
canReadTeamDrive?: boolean;
|
|
1020
|
+
/** Output only. Whether the current user can modify the sharing settings for this file. */
|
|
1021
|
+
canShare?: boolean;
|
|
1022
|
+
/** Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. */
|
|
1023
|
+
canMoveItemOutOfDrive?: boolean;
|
|
1024
|
+
/** Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. */
|
|
1025
|
+
canReadDrive?: boolean;
|
|
1026
|
+
/** Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. */
|
|
1027
|
+
canChangeCopyRequiresWriterPermission?: boolean;
|
|
1028
|
+
/** Whether a user can disable inherited permissions. */
|
|
1029
|
+
canDisableInheritedPermissions?: boolean;
|
|
1030
|
+
/** Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`. */
|
|
1031
|
+
canEdit?: boolean;
|
|
1032
|
+
/** Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. */
|
|
1033
|
+
canAddMyDriveParent?: boolean;
|
|
1034
|
+
/** Output only. Whether the current user can comment on this file. */
|
|
1035
|
+
canComment?: boolean;
|
|
1036
|
+
};
|
|
1037
|
+
/** A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests. */
|
|
1038
|
+
properties?: Record<string, string>;
|
|
1039
|
+
/** The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](https://developers.google.com/workspace/drive/api/reference/rest/v3/about) resource. */
|
|
1040
|
+
mimeType?: string;
|
|
1041
|
+
/** Output only. A link for opening the file in a relevant Google editor or viewer in a browser. */
|
|
1042
|
+
webViewLink?: string;
|
|
1043
|
+
/** Output only. The thumbnail version for use in thumbnail cache invalidation. */
|
|
1044
|
+
thumbnailVersion?: string;
|
|
1045
|
+
/** Whether this file has inherited permissions disabled. Inherited permissions are enabled by default. */
|
|
1046
|
+
inheritedPermissionsDisabled?: boolean;
|
|
1047
|
+
/** Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled. */
|
|
1048
|
+
quotaBytesUsed?: string;
|
|
1049
|
+
/** Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. */
|
|
1050
|
+
size?: string;
|
|
1051
|
+
/** Output only. Whether the file has been modified by this user. */
|
|
1052
|
+
modifiedByMe?: boolean;
|
|
1053
|
+
/** Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. */
|
|
1054
|
+
fullFileExtension?: string;
|
|
1055
|
+
/** Output only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user. */
|
|
1056
|
+
version?: string;
|
|
1057
|
+
/** Download restrictions applied on the file. */
|
|
1058
|
+
downloadRestrictions?: DriveDownloadRestrictionsMetadata;
|
|
1059
|
+
/** The ID of the file. */
|
|
1060
|
+
id?: string;
|
|
1061
|
+
/** Output only. A static, unauthenticated link to the file's icon. */
|
|
1062
|
+
iconLink?: string;
|
|
1063
|
+
};
|
|
1064
|
+
/** Information about the user, the user's Drive, and system capabilities. */
|
|
1065
|
+
export type DriveAbout = {
|
|
1066
|
+
/** A map of source MIME type to possible targets for all supported imports. */
|
|
1067
|
+
importFormats?: Record<string, Array<string>>;
|
|
1068
|
+
/** The maximum upload size in bytes. */
|
|
1069
|
+
maxUploadSize?: string;
|
|
1070
|
+
/** Deprecated: Use `canCreateDrives` instead. */
|
|
1071
|
+
canCreateTeamDrives?: boolean;
|
|
1072
|
+
/** A map of maximum import sizes by MIME type, in bytes. */
|
|
1073
|
+
maxImportSizes?: Record<string, string>;
|
|
1074
|
+
/** Deprecated: Use `driveThemes` instead. */
|
|
1075
|
+
teamDriveThemes?: Array<{
|
|
1076
|
+
/** Deprecated: Use `driveThemes/id` instead. */
|
|
1077
|
+
id?: string;
|
|
1078
|
+
/** Deprecated: Use `driveThemes/colorRgb` instead. */
|
|
1079
|
+
colorRgb?: string;
|
|
1080
|
+
/** Deprecated: Use `driveThemes/backgroundImageLink` instead. */
|
|
1081
|
+
backgroundImageLink?: string;
|
|
1082
|
+
}>;
|
|
1083
|
+
/** The user's storage quota limits and usage. For users that are part of an organization with pooled storage, information about the limit and usage across all services is for the organization, rather than the individual user. All fields are measured in bytes. */
|
|
1084
|
+
storageQuota?: {
|
|
1085
|
+
/** The usage by all files in Google Drive. */
|
|
1086
|
+
usageInDrive?: string;
|
|
1087
|
+
/** The total usage across all services. For users that are part of an organization with pooled storage, this is the usage across all services for the organization, rather than the individual user. */
|
|
1088
|
+
usage?: string;
|
|
1089
|
+
/** The usage by trashed files in Google Drive. */
|
|
1090
|
+
usageInDriveTrash?: string;
|
|
1091
|
+
/** The usage limit, if applicable. This will not be present if the user has unlimited storage. For users that are part of an organization with pooled storage, this is the limit for the organization, rather than the individual user. */
|
|
1092
|
+
limit?: string;
|
|
1093
|
+
};
|
|
1094
|
+
/** Whether the user can create shared drives. */
|
|
1095
|
+
canCreateDrives?: boolean;
|
|
1096
|
+
/** A map of source MIME type to possible targets for all supported exports. */
|
|
1097
|
+
exportFormats?: Record<string, Array<string>>;
|
|
1098
|
+
/** Identifies what kind of resource this is. Value: the fixed string `"drive#about"`. */
|
|
1099
|
+
kind?: string;
|
|
1100
|
+
/** Whether the user has installed the requesting app. */
|
|
1101
|
+
appInstalled?: boolean;
|
|
1102
|
+
/** The currently supported folder colors as RGB hex strings. */
|
|
1103
|
+
folderColorPalette?: Array<string>;
|
|
1104
|
+
/** A list of themes that are supported for shared drives. */
|
|
1105
|
+
driveThemes?: Array<{
|
|
1106
|
+
/** The color of this theme as an RGB hex string. */
|
|
1107
|
+
colorRgb?: string;
|
|
1108
|
+
/** The ID of the theme. */
|
|
1109
|
+
id?: string;
|
|
1110
|
+
/** A link to this theme's background image. */
|
|
1111
|
+
backgroundImageLink?: string;
|
|
1112
|
+
}>;
|
|
1113
|
+
/** The authenticated user. */
|
|
1114
|
+
user?: DriveUser;
|
|
1115
|
+
};
|
|
1116
|
+
/** Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive. */
|
|
1117
|
+
export type DriveDrive = {
|
|
1118
|
+
/** The name of this shared drive. */
|
|
1119
|
+
name?: string;
|
|
1120
|
+
/** Output only. Capabilities the current user has on this shared drive. */
|
|
1121
|
+
capabilities?: {
|
|
1122
|
+
/** Output only. Whether the current user can add members to this shared drive or remove them or change their role. */
|
|
1123
|
+
canManageMembers?: boolean;
|
|
1124
|
+
/** Output only. Whether the current user can rename files or folders in this shared drive. */
|
|
1125
|
+
canRename?: boolean;
|
|
1126
|
+
/** Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. */
|
|
1127
|
+
canChangeDriveMembersOnlyRestriction?: boolean;
|
|
1128
|
+
/** Output only. Whether the current user can list the children of folders in this shared drive. */
|
|
1129
|
+
canListChildren?: boolean;
|
|
1130
|
+
/** Output only. Whether the current user can add children to folders in this shared drive. */
|
|
1131
|
+
canAddChildren?: boolean;
|
|
1132
|
+
/** Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. */
|
|
1133
|
+
canChangeSharingFoldersRequiresOrganizerPermissionRestriction?: boolean;
|
|
1134
|
+
/** Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. */
|
|
1135
|
+
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
|
|
1136
|
+
/** Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. */
|
|
1137
|
+
canChangeDomainUsersOnlyRestriction?: boolean;
|
|
1138
|
+
/** Output only. Whether the current user can download files in this shared drive. */
|
|
1139
|
+
canDownload?: boolean;
|
|
1140
|
+
/** Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive. */
|
|
1141
|
+
canDeleteDrive?: boolean;
|
|
1142
|
+
/** Output only. Whether the current user can share files or folders in this shared drive. */
|
|
1143
|
+
canShare?: boolean;
|
|
1144
|
+
/** Output only. Whether the current user can rename this shared drive. */
|
|
1145
|
+
canRenameDrive?: boolean;
|
|
1146
|
+
/** Output only. Whether the current user can read the revisions resource of files in this shared drive. */
|
|
1147
|
+
canReadRevisions?: boolean;
|
|
1148
|
+
/** Output only. Whether the current user can copy files in this shared drive. */
|
|
1149
|
+
canCopy?: boolean;
|
|
1150
|
+
/** Output only. Whether the current user can trash children from folders in this shared drive. */
|
|
1151
|
+
canTrashChildren?: boolean;
|
|
1152
|
+
/** Output only. Whether the current user can change organizer-applied download restrictions of this shared drive. */
|
|
1153
|
+
canChangeDownloadRestriction?: boolean;
|
|
1154
|
+
/** Output only. Whether the current user can comment on files in this shared drive. */
|
|
1155
|
+
canComment?: boolean;
|
|
1156
|
+
/** Output only. Whether the current user can edit files in this shared drive */
|
|
1157
|
+
canEdit?: boolean;
|
|
1158
|
+
/** Output only. Whether the current user can delete children from folders in this shared drive. */
|
|
1159
|
+
canDeleteChildren?: boolean;
|
|
1160
|
+
/** Output only. Whether the current user can change the background of this shared drive. */
|
|
1161
|
+
canChangeDriveBackground?: boolean;
|
|
1162
|
+
/** Output only. Whether the current user can reset the shared drive restrictions to defaults. */
|
|
1163
|
+
canResetDriveRestrictions?: boolean;
|
|
1164
|
+
};
|
|
1165
|
+
/** A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions. */
|
|
1166
|
+
restrictions?: {
|
|
1167
|
+
/** Whether administrative privileges on this shared drive are required to modify restrictions. */
|
|
1168
|
+
adminManagedRestrictions?: boolean;
|
|
1169
|
+
/** If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders. */
|
|
1170
|
+
sharingFoldersRequiresOrganizerPermission?: boolean;
|
|
1171
|
+
/** Whether access to items inside this shared drive is restricted to its members. */
|
|
1172
|
+
driveMembersOnly?: boolean;
|
|
1173
|
+
/** Download restrictions applied by shared drive managers. */
|
|
1174
|
+
downloadRestriction?: DriveDownloadRestriction;
|
|
1175
|
+
/** Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive. */
|
|
1176
|
+
copyRequiresWriterPermission?: boolean;
|
|
1177
|
+
/** Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. */
|
|
1178
|
+
domainUsersOnly?: boolean;
|
|
1179
|
+
};
|
|
1180
|
+
/** Whether the shared drive is hidden from default view. */
|
|
1181
|
+
hidden?: boolean;
|
|
1182
|
+
/** Output only. A short-lived link to this shared drive's background image. */
|
|
1183
|
+
backgroundImageLink?: string;
|
|
1184
|
+
/** The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`. */
|
|
1185
|
+
colorRgb?: string;
|
|
1186
|
+
/** Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`. */
|
|
1187
|
+
kind?: string;
|
|
1188
|
+
/** Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. */
|
|
1189
|
+
id?: string;
|
|
1190
|
+
/** An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set. */
|
|
1191
|
+
backgroundImageFile?: {
|
|
1192
|
+
/** The ID of an image file in Google Drive to use for the background image. */
|
|
1193
|
+
id?: string;
|
|
1194
|
+
/** The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image. */
|
|
1195
|
+
xCoordinate?: number;
|
|
1196
|
+
/** The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image. */
|
|
1197
|
+
yCoordinate?: number;
|
|
1198
|
+
/** The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high. */
|
|
1199
|
+
width?: number;
|
|
1200
|
+
};
|
|
1201
|
+
/** The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`. */
|
|
1202
|
+
themeId?: string;
|
|
1203
|
+
/** Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`. */
|
|
1204
|
+
orgUnitId?: string;
|
|
1205
|
+
/** The time at which the shared drive was created (RFC 3339 date-time). */
|
|
1206
|
+
createdTime?: string;
|
|
1207
|
+
};
|
|
1208
|
+
/** A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically. */
|
|
1209
|
+
export type DriveModifyLabelsRequest = {
|
|
1210
|
+
/** The list of modifications to apply to the labels on the file. */
|
|
1211
|
+
labelModifications?: Array<DriveLabelModification>;
|
|
1212
|
+
/** This is always `"drive#modifyLabelsRequest"`. */
|
|
1213
|
+
kind?: string;
|
|
1214
|
+
};
|
|
1215
|
+
/** Request message for resolving an AccessProposal on a file. */
|
|
1216
|
+
export type DriveResolveAccessProposalRequest = {
|
|
1217
|
+
/** Optional. Whether to send an email to the requester when the access proposal is denied or accepted. */
|
|
1218
|
+
sendNotification?: boolean;
|
|
1219
|
+
/** Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action. */
|
|
1220
|
+
role?: Array<string>;
|
|
1221
|
+
/** Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported. */
|
|
1222
|
+
view?: string;
|
|
1223
|
+
/** Required. The action to take on the access proposal. */
|
|
1224
|
+
action?: "ACTION_UNSPECIFIED" | "ACCEPT" | "DENY";
|
|
1225
|
+
};
|
|
1226
|
+
/** Describes the bullet of a paragraph. */
|
|
1227
|
+
export type DocsBullet = {
|
|
1228
|
+
/** The paragraph-specific text style applied to this bullet. */
|
|
1229
|
+
textStyle?: DocsTextStyle;
|
|
1230
|
+
/** The nesting level of this paragraph in the list. */
|
|
1231
|
+
nestingLevel?: number;
|
|
1232
|
+
/** The ID of the list this paragraph belongs to. */
|
|
1233
|
+
listId?: string;
|
|
1234
|
+
};
|
|
1235
|
+
/** A reference to the external linked source content. */
|
|
1236
|
+
export type DocsLinkedContentReference = {
|
|
1237
|
+
/** A reference to the linked chart. */
|
|
1238
|
+
sheetsChartReference?: DocsSheetsChartReference;
|
|
1239
|
+
};
|
|
1240
|
+
/** Properties of a PositionedObject. */
|
|
1241
|
+
export type DocsPositionedObjectProperties = {
|
|
1242
|
+
/** The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. */
|
|
1243
|
+
positioning?: DocsPositionedObjectPositioning;
|
|
1244
|
+
/** The embedded object of this positioned object. */
|
|
1245
|
+
embeddedObject?: DocsEmbeddedObject;
|
|
1246
|
+
};
|
|
1247
|
+
/** An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. */
|
|
1248
|
+
export type DocsPositionedObject = {
|
|
1249
|
+
/** The suggested changes to the positioned object properties, keyed by suggestion ID. */
|
|
1250
|
+
suggestedPositionedObjectPropertiesChanges?: Record<string, DocsSuggestedPositionedObjectProperties>;
|
|
1251
|
+
/** The suggested insertion ID. If empty, then this is not a suggested insertion. */
|
|
1252
|
+
suggestedInsertionId?: string;
|
|
1253
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1254
|
+
suggestedDeletionIds?: Array<string>;
|
|
1255
|
+
/** The ID of this positioned object. */
|
|
1256
|
+
objectId?: string;
|
|
1257
|
+
/** The properties of this positioned object. */
|
|
1258
|
+
positionedObjectProperties?: DocsPositionedObjectProperties;
|
|
1259
|
+
};
|
|
1260
|
+
/** An RGB color. */
|
|
1261
|
+
export type DocsRgbColor = {
|
|
1262
|
+
/** The red component of the color, from 0.0 to 1.0. */
|
|
1263
|
+
red?: number;
|
|
1264
|
+
/** The blue component of the color, from 0.0 to 1.0. */
|
|
1265
|
+
blue?: number;
|
|
1266
|
+
/** The green component of the color, from 0.0 to 1.0. */
|
|
1267
|
+
green?: number;
|
|
1268
|
+
};
|
|
1269
|
+
/** The contents and style of a cell in a Table. */
|
|
1270
|
+
export type DocsTableCell = {
|
|
1271
|
+
/** The style of the cell. */
|
|
1272
|
+
tableCellStyle?: DocsTableCellStyle;
|
|
1273
|
+
/** The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
1274
|
+
suggestedInsertionIds?: Array<string>;
|
|
1275
|
+
/** The suggested changes to the table cell style, keyed by suggestion ID. */
|
|
1276
|
+
suggestedTableCellStyleChanges?: Record<string, DocsSuggestedTableCellStyle>;
|
|
1277
|
+
/** The content of the cell. */
|
|
1278
|
+
content?: Array<DocsStructuralElement>;
|
|
1279
|
+
/** The zero-based start index of this cell, in UTF-16 code units. */
|
|
1280
|
+
startIndex?: number;
|
|
1281
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1282
|
+
suggestedDeletionIds?: Array<string>;
|
|
1283
|
+
/** The zero-based end index of this cell, exclusive, in UTF-16 code units. */
|
|
1284
|
+
endIndex?: number;
|
|
1285
|
+
};
|
|
1286
|
+
/** Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor. */
|
|
1287
|
+
export type DocsReplaceImageRequest = {
|
|
1288
|
+
/** The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field. */
|
|
1289
|
+
uri?: string;
|
|
1290
|
+
/** The replacement method. */
|
|
1291
|
+
imageReplaceMethod?: "IMAGE_REPLACE_METHOD_UNSPECIFIED" | "CENTER_CROP";
|
|
1292
|
+
/** The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
1293
|
+
tabId?: string;
|
|
1294
|
+
/** The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request. */
|
|
1295
|
+
imageObjectId?: string;
|
|
1296
|
+
};
|
|
1297
|
+
/** A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
1298
|
+
export type DocsTableRowStyleSuggestionState = {
|
|
1299
|
+
/** Indicates if there was a suggested change to min_row_height. */
|
|
1300
|
+
minRowHeightSuggested?: boolean;
|
|
1301
|
+
};
|
|
1302
|
+
/** Represents the background of a document. */
|
|
1303
|
+
export type DocsBackground = {
|
|
1304
|
+
/** The background color. */
|
|
1305
|
+
color?: DocsOptionalColor;
|
|
1306
|
+
};
|
|
1307
|
+
/** A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. */
|
|
1308
|
+
export type DocsAutoText = {
|
|
1309
|
+
/** The text style of this AutoText. */
|
|
1310
|
+
textStyle?: DocsTextStyle;
|
|
1311
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1312
|
+
suggestedDeletionIds?: Array<string>;
|
|
1313
|
+
/** The type of this auto text. */
|
|
1314
|
+
type?: "TYPE_UNSPECIFIED" | "PAGE_NUMBER" | "PAGE_COUNT";
|
|
1315
|
+
/** The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
1316
|
+
suggestedInsertionIds?: Array<string>;
|
|
1317
|
+
/** The suggested text style changes to this AutoText, keyed by suggestion ID. */
|
|
1318
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
1319
|
+
};
|
|
1320
|
+
/** A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. */
|
|
1321
|
+
export type DocsDropdown = {
|
|
1322
|
+
/** The text style of this dropdown. */
|
|
1323
|
+
textStyle?: DocsTextStyle;
|
|
1324
|
+
/** IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. */
|
|
1325
|
+
suggestedDeletionIds?: Array<string>;
|
|
1326
|
+
/** IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. */
|
|
1327
|
+
suggestedInsertionIds?: Array<string>;
|
|
1328
|
+
/** The ID of this dropdown. */
|
|
1329
|
+
dropdownId?: string;
|
|
1330
|
+
/** The suggested properties changes to this dropdown, keyed by suggestion ID. */
|
|
1331
|
+
suggestedDropdownPropertiesChanges?: Record<string, DocsSuggestedDropdownProperties>;
|
|
1332
|
+
/** The suggested text style changes to this dropdown, keyed by suggestion ID. */
|
|
1333
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
1334
|
+
/** The properties of this dropdown. */
|
|
1335
|
+
dropdownProperties?: DocsDropdownProperties;
|
|
1336
|
+
};
|
|
1337
|
+
/** The result of replacing text. */
|
|
1338
|
+
export type DocsReplaceAllTextResponse = {
|
|
1339
|
+
/** The number of occurrences changed by replacing all text. */
|
|
1340
|
+
occurrencesChanged?: number;
|
|
1341
|
+
};
|
|
1342
|
+
/** Updates a named style. */
|
|
1343
|
+
export type DocsUpdateNamedStyleRequest = {
|
|
1344
|
+
/** The document tab to update. By default, the update is applied to the first tab. */
|
|
1345
|
+
tabId?: string;
|
|
1346
|
+
/** The document style to update. */
|
|
1347
|
+
namedStyle?: DocsNamedStyle;
|
|
1348
|
+
/** The NamedStyle fields that should be updated. At least `named_style_type` must be specified. The root `named_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `"text_style"` and `"text_style.bold"`. To update the paragraph style's alignment property, set `fields` to include `"paragraph_style"` and `"paragraph_style.alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `"text_style"` or `"paragraph_style"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields. */
|
|
1349
|
+
fields?: string;
|
|
1350
|
+
};
|
|
1351
|
+
/** A suggested change to a TextStyle. */
|
|
1352
|
+
export type DocsSuggestedTextStyle = {
|
|
1353
|
+
/** A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. */
|
|
1354
|
+
textStyle?: DocsTextStyle;
|
|
1355
|
+
/** A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. */
|
|
1356
|
+
textStyleSuggestionState?: DocsTextStyleSuggestionState;
|
|
1357
|
+
};
|
|
1358
|
+
/** Properties specific to a RichLink. */
|
|
1359
|
+
export type DocsRichLinkProperties = {
|
|
1360
|
+
/** The URI to the RichLink. This is always present. */
|
|
1361
|
+
uri?: string;
|
|
1362
|
+
/** The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. */
|
|
1363
|
+
title?: string;
|
|
1364
|
+
/** The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). */
|
|
1365
|
+
mimeType?: string;
|
|
1366
|
+
};
|
|
1367
|
+
/** A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. */
|
|
1368
|
+
export type DocsPageBreak = {
|
|
1369
|
+
/** The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
1370
|
+
suggestedInsertionIds?: Array<string>;
|
|
1371
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1372
|
+
suggestedDeletionIds?: Array<string>;
|
|
1373
|
+
/** The suggested text style changes to this PageBreak, keyed by suggestion ID. */
|
|
1374
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
1375
|
+
/** The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. */
|
|
1376
|
+
textStyle?: DocsTextStyle;
|
|
1377
|
+
};
|
|
1378
|
+
/** Properties specific to a dropdown. */
|
|
1379
|
+
export type DocsDropdownProperties = {
|
|
1380
|
+
/** The ID of the selected option in this dropdown. */
|
|
1381
|
+
selectedOptionId?: string;
|
|
1382
|
+
/** The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. */
|
|
1383
|
+
displayValue?: string;
|
|
1384
|
+
/** The ID of the DropdownDefinition that defines the options for this dropdown. */
|
|
1385
|
+
dropdownDefinitionId?: string;
|
|
1386
|
+
};
|
|
1387
|
+
/** A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
1388
|
+
export type DocsSheetsChartReferenceSuggestionState = {
|
|
1389
|
+
/** Indicates if there was a suggested change to spreadsheet_id. */
|
|
1390
|
+
spreadsheetIdSuggested?: boolean;
|
|
1391
|
+
/** Indicates if there was a suggested change to chart_id. */
|
|
1392
|
+
chartIdSuggested?: boolean;
|
|
1393
|
+
};
|
|
1394
|
+
/** The shading of a paragraph. */
|
|
1395
|
+
export type DocsShading = {
|
|
1396
|
+
/** The background color of this paragraph shading. */
|
|
1397
|
+
backgroundColor?: DocsOptionalColor;
|
|
1398
|
+
};
|
|
1399
|
+
/** Replaces all instances of text matching a criteria with replace text. */
|
|
1400
|
+
export type DocsReplaceAllTextRequest = {
|
|
1401
|
+
/** Finds text in the document matching this substring. */
|
|
1402
|
+
containsText?: DocsSubstringMatchCriteria;
|
|
1403
|
+
/** The text that will replace the matched text. */
|
|
1404
|
+
replaceText?: string;
|
|
1405
|
+
/** Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. */
|
|
1406
|
+
tabsCriteria?: DocsTabsCriteria;
|
|
1407
|
+
};
|
|
1408
|
+
/** A reference to a linked chart embedded from Google Sheets. */
|
|
1409
|
+
export type DocsSheetsChartReference = {
|
|
1410
|
+
/** The ID of the specific chart in the Google Sheets spreadsheet that's embedded. */
|
|
1411
|
+
chartId?: number;
|
|
1412
|
+
/** The ID of the Google Sheets spreadsheet that contains the source chart. */
|
|
1413
|
+
spreadsheetId?: string;
|
|
1414
|
+
};
|
|
1415
|
+
/** Contains properties describing the look and feel of a list bullet at a given level of nesting. */
|
|
1416
|
+
export type DocsNestingLevel = {
|
|
1417
|
+
/** The type of glyph used by bullets when paragraphs at this level of nesting is ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to the list item's order within the list. */
|
|
1418
|
+
glyphType?: "GLYPH_TYPE_UNSPECIFIED" | "NONE" | "DECIMAL" | "ZERO_DECIMAL" | "UPPER_ALPHA" | "ALPHA" | "UPPER_ROMAN" | "ROMAN";
|
|
1419
|
+
/** The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. */
|
|
1420
|
+
indentStart?: DocsDimension;
|
|
1421
|
+
/** The text style of bullets at this level of nesting. */
|
|
1422
|
+
textStyle?: DocsTextStyle;
|
|
1423
|
+
/** The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. */
|
|
1424
|
+
startNumber?: number;
|
|
1425
|
+
/** A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. */
|
|
1426
|
+
glyphSymbol?: string;
|
|
1427
|
+
/** The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. */
|
|
1428
|
+
glyphFormat?: string;
|
|
1429
|
+
/** The amount of indentation for the first line of paragraphs at this level of nesting. */
|
|
1430
|
+
indentFirstLine?: DocsDimension;
|
|
1431
|
+
/** The alignment of the bullet within the space allotted for rendering the bullet. */
|
|
1432
|
+
bulletAlignment?: "BULLET_ALIGNMENT_UNSPECIFIED" | "START" | "CENTER" | "END";
|
|
1433
|
+
};
|
|
1434
|
+
/** The suggestions which were affected by a given update. */
|
|
1435
|
+
export type DocsSuggestionResponse = {
|
|
1436
|
+
/** The IDs of suggestions which were deleted during the update. */
|
|
1437
|
+
deletedSuggestionIds?: Array<string>;
|
|
1438
|
+
/** The IDs of suggestions which were created during the update. */
|
|
1439
|
+
createdSuggestionIds?: Array<string>;
|
|
1440
|
+
/** The IDs of suggestions which were accepted during the update. */
|
|
1441
|
+
acceptedSuggestionIds?: Array<string>;
|
|
1442
|
+
/** The IDs of suggestions which were rejected during the update. */
|
|
1443
|
+
rejectedSuggestionIds?: Array<string>;
|
|
1444
|
+
/** The IDs of suggestions whose summaries were updated during the update. */
|
|
1445
|
+
updatedSummarySuggestionIds?: Array<string>;
|
|
1446
|
+
};
|
|
1447
|
+
/** A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. */
|
|
1448
|
+
export type DocsFootnoteReference = {
|
|
1449
|
+
/** The rendered number of this footnote. */
|
|
1450
|
+
footnoteNumber?: string;
|
|
1451
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1452
|
+
suggestedDeletionIds?: Array<string>;
|
|
1453
|
+
/** The text style of this FootnoteReference. */
|
|
1454
|
+
textStyle?: DocsTextStyle;
|
|
1455
|
+
/** The suggested text style changes to this FootnoteReference, keyed by suggestion ID. */
|
|
1456
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
1457
|
+
/** The ID of the footnote that contains the content of this footnote reference. */
|
|
1458
|
+
footnoteId?: string;
|
|
1459
|
+
/** The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
1460
|
+
suggestedInsertionIds?: Array<string>;
|
|
1461
|
+
};
|
|
1462
|
+
/** A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
1463
|
+
export type DocsTextStyleSuggestionState = {
|
|
1464
|
+
/** Indicates if there was a suggested change to italic. */
|
|
1465
|
+
italicSuggested?: boolean;
|
|
1466
|
+
/** Indicates if there was a suggested change to small_caps. */
|
|
1467
|
+
smallCapsSuggested?: boolean;
|
|
1468
|
+
/** Indicates if there was a suggested change to weighted_font_family. */
|
|
1469
|
+
weightedFontFamilySuggested?: boolean;
|
|
1470
|
+
/** Indicates if there was a suggested change to link. */
|
|
1471
|
+
linkSuggested?: boolean;
|
|
1472
|
+
/** Indicates if there was a suggested change to font_size. */
|
|
1473
|
+
fontSizeSuggested?: boolean;
|
|
1474
|
+
/** Indicates if there was a suggested change to background_color. */
|
|
1475
|
+
backgroundColorSuggested?: boolean;
|
|
1476
|
+
/** Indicates if there was a suggested change to foreground_color. */
|
|
1477
|
+
foregroundColorSuggested?: boolean;
|
|
1478
|
+
/** Indicates if there was a suggested change to bold. */
|
|
1479
|
+
boldSuggested?: boolean;
|
|
1480
|
+
/** Indicates if there was a suggested change to underline. */
|
|
1481
|
+
underlineSuggested?: boolean;
|
|
1482
|
+
/** Indicates if there was a suggested change to baseline_offset. */
|
|
1483
|
+
baselineOffsetSuggested?: boolean;
|
|
1484
|
+
/** Indicates if there was a suggested change to strikethrough. */
|
|
1485
|
+
strikethroughSuggested?: boolean;
|
|
1486
|
+
};
|
|
1487
|
+
/** A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
1488
|
+
export type DocsDropdownPropertiesSuggestionState = {
|
|
1489
|
+
/** Indicates if there was a suggested change to selected_option_id. */
|
|
1490
|
+
selectedOptionIdSuggested?: boolean;
|
|
1491
|
+
};
|
|
1492
|
+
/** A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
1493
|
+
export type DocsNestingLevelSuggestionState = {
|
|
1494
|
+
/** A mask that indicates which of the fields in text style have been changed in this suggestion. */
|
|
1495
|
+
textStyleSuggestionState?: DocsTextStyleSuggestionState;
|
|
1496
|
+
/** Indicates if there was a suggested change to glyph_format. */
|
|
1497
|
+
glyphFormatSuggested?: boolean;
|
|
1498
|
+
/** Indicates if there was a suggested change to glyph_type. */
|
|
1499
|
+
glyphTypeSuggested?: boolean;
|
|
1500
|
+
/** Indicates if there was a suggested change to bullet_alignment. */
|
|
1501
|
+
bulletAlignmentSuggested?: boolean;
|
|
1502
|
+
/** Indicates if there was a suggested change to start_number. */
|
|
1503
|
+
startNumberSuggested?: boolean;
|
|
1504
|
+
/** Indicates if there was a suggested change to indent_start. */
|
|
1505
|
+
indentStartSuggested?: boolean;
|
|
1506
|
+
/** Indicates if there was a suggested change to glyph_symbol. */
|
|
1507
|
+
glyphSymbolSuggested?: boolean;
|
|
1508
|
+
/** Indicates if there was a suggested change to indent_first_line. */
|
|
1509
|
+
indentFirstLineSuggested?: boolean;
|
|
1510
|
+
};
|
|
1511
|
+
/** A StructuralElement representing a table. */
|
|
1512
|
+
export type DocsTable = {
|
|
1513
|
+
/** Number of rows in the table. */
|
|
1514
|
+
rows?: number;
|
|
1515
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1516
|
+
suggestedDeletionIds?: Array<string>;
|
|
1517
|
+
/** The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
1518
|
+
suggestedInsertionIds?: Array<string>;
|
|
1519
|
+
/** The contents and style of each row. */
|
|
1520
|
+
tableRows?: Array<DocsTableRow>;
|
|
1521
|
+
/** Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. */
|
|
1522
|
+
columns?: number;
|
|
1523
|
+
/** The style of the table. */
|
|
1524
|
+
tableStyle?: DocsTableStyle;
|
|
1525
|
+
};
|
|
1526
|
+
/** Location of a single cell within a table. */
|
|
1527
|
+
export type DocsTableCellLocation = {
|
|
1528
|
+
/** The zero-based row index. For example, the second row in the table has a row index of 1. */
|
|
1529
|
+
rowIndex?: number;
|
|
1530
|
+
/** The zero-based column index. For example, the second column in the table has a column index of 1. */
|
|
1531
|
+
columnIndex?: number;
|
|
1532
|
+
/** The location where the table starts in the document. */
|
|
1533
|
+
tableStartLocation?: DocsLocation;
|
|
1534
|
+
};
|
|
1535
|
+
/** A single response from an update. */
|
|
1536
|
+
export type DocsResponse = {
|
|
1537
|
+
/** The result of adding a reply to a comment or suggestion. */
|
|
1538
|
+
addCommentReply?: DocsAddCommentReplyResponse;
|
|
1539
|
+
/** The result of adding a document tab. */
|
|
1540
|
+
addDocumentTab?: DocsAddDocumentTabResponse;
|
|
1541
|
+
/** The result of inserting a dropdown. */
|
|
1542
|
+
insertDropdown?: DocsInsertDropdownResponse;
|
|
1543
|
+
/** The result of replacing text. */
|
|
1544
|
+
replaceAllText?: DocsReplaceAllTextResponse;
|
|
1545
|
+
/** The result of inserting an inline image. */
|
|
1546
|
+
insertInlineImage?: DocsInsertInlineImageResponse;
|
|
1547
|
+
/** The result of inserting an inline Google Sheets chart. */
|
|
1548
|
+
insertInlineSheetsChart?: DocsInsertInlineSheetsChartResponse;
|
|
1549
|
+
/** The result of creating a dropdown definition. */
|
|
1550
|
+
createDropdownDefinition?: DocsCreateDropdownDefinitionResponse;
|
|
1551
|
+
/** The result of creating a footnote. */
|
|
1552
|
+
createFootnote?: DocsCreateFootnoteResponse;
|
|
1553
|
+
/** The result of creating a footer. */
|
|
1554
|
+
createFooter?: DocsCreateFooterResponse;
|
|
1555
|
+
/** The result of creating a header. */
|
|
1556
|
+
createHeader?: DocsCreateHeaderResponse;
|
|
1557
|
+
/** The result of inserting a comment. */
|
|
1558
|
+
insertComment?: DocsInsertCommentResponse;
|
|
1559
|
+
/** The result of creating a named range. */
|
|
1560
|
+
createNamedRange?: DocsCreateNamedRangeResponse;
|
|
1561
|
+
};
|
|
1562
|
+
/** The style of the document. */
|
|
1563
|
+
export type DocsDocumentStyle = {
|
|
1564
|
+
/** The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1565
|
+
marginHeader?: DocsDimension;
|
|
1566
|
+
/** The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1567
|
+
marginTop?: DocsDimension;
|
|
1568
|
+
/** The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1569
|
+
marginLeft?: DocsDimension;
|
|
1570
|
+
/** The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1571
|
+
defaultHeaderId?: string;
|
|
1572
|
+
/** The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1573
|
+
marginFooter?: DocsDimension;
|
|
1574
|
+
/** The background of the document. Documents cannot have a transparent background color. */
|
|
1575
|
+
background?: DocsBackground;
|
|
1576
|
+
/** Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1577
|
+
useFirstPageHeaderFooter?: boolean;
|
|
1578
|
+
/** The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1579
|
+
evenPageFooterId?: string;
|
|
1580
|
+
/** The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1581
|
+
marginBottom?: DocsDimension;
|
|
1582
|
+
/** Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1583
|
+
flipPageOrientation?: boolean;
|
|
1584
|
+
/** The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1585
|
+
pageNumberStart?: number;
|
|
1586
|
+
/** The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1587
|
+
marginRight?: DocsDimension;
|
|
1588
|
+
/** The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1589
|
+
evenPageHeaderId?: string;
|
|
1590
|
+
/** The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1591
|
+
pageSize?: DocsSize;
|
|
1592
|
+
/** The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1593
|
+
defaultFooterId?: string;
|
|
1594
|
+
/** The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1595
|
+
firstPageHeaderId?: string;
|
|
1596
|
+
/** The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1597
|
+
firstPageFooterId?: string;
|
|
1598
|
+
/** Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1599
|
+
useCustomHeaderFooterMargins?: boolean;
|
|
1600
|
+
/** Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
1601
|
+
useEvenPageHeaderFooter?: boolean;
|
|
1602
|
+
/** Specifies document-level format settings, such as the document mode (pages vs pageless). */
|
|
1603
|
+
documentFormat?: DocsDocumentFormat;
|
|
1604
|
+
};
|
|
1605
|
+
/** Deletes a row from a table. */
|
|
1606
|
+
export type DocsDeleteTableRowRequest = {
|
|
1607
|
+
/** The reference table cell location from which the row will be deleted. The row this cell spans will be deleted. If this is a merged cell that spans multiple rows, all rows that the cell spans will be deleted. If no rows remain in the table after this deletion, the whole table is deleted. */
|
|
1608
|
+
tableCellLocation?: DocsTableCellLocation;
|
|
1609
|
+
};
|
|
1610
|
+
/** Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character. */
|
|
1611
|
+
export type DocsCreateFootnoteRequest = {
|
|
1612
|
+
/** Inserts the footnote reference at the end of the document body. Footnote references cannot be inserted inside a header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. */
|
|
1613
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
1614
|
+
/** Inserts the footnote reference at a specific index in the document. The footnote reference must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Footnote references cannot be inserted inside an equation, header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. */
|
|
1615
|
+
location?: DocsLocation;
|
|
1616
|
+
};
|
|
1617
|
+
/** Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned. */
|
|
1618
|
+
export type DocsCreateHeaderRequest = {
|
|
1619
|
+
/** The type of header to create. */
|
|
1620
|
+
type?: "HEADER_FOOTER_TYPE_UNSPECIFIED" | "DEFAULT";
|
|
1621
|
+
/** The location of the SectionBreak which begins the section this header should belong to. If `section_break_location' is unset or if it refers to the first section break in the document body, the header applies to the DocumentStyle */
|
|
1622
|
+
sectionBreakLocation?: DocsLocation;
|
|
1623
|
+
};
|
|
1624
|
+
/** Inserts a reply Post into a CommentThread or SuggestionThread. */
|
|
1625
|
+
export type DocsAddCommentReplyRequest = {
|
|
1626
|
+
/** The ID of the SuggestionThread to add the reply to. */
|
|
1627
|
+
suggestionId?: string;
|
|
1628
|
+
/** The Post representing the reply. */
|
|
1629
|
+
post?: DocsPost;
|
|
1630
|
+
/** The ID of the CommentThread to add the reply to. */
|
|
1631
|
+
commentId?: string;
|
|
1632
|
+
};
|
|
1633
|
+
/** Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. */
|
|
1634
|
+
export type DocsDeleteParagraphBulletsRequest = {
|
|
1635
|
+
/** The range to delete bullets from. */
|
|
1636
|
+
range?: DocsRange;
|
|
1637
|
+
};
|
|
1638
|
+
/** The suggestion state of a NamedStyles message. */
|
|
1639
|
+
export type DocsNamedStylesSuggestionState = {
|
|
1640
|
+
/** A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. */
|
|
1641
|
+
stylesSuggestionStates?: Array<DocsNamedStyleSuggestionState>;
|
|
1642
|
+
};
|
|
1643
|
+
/** Properties of a tab. */
|
|
1644
|
+
export type DocsTabProperties = {
|
|
1645
|
+
/** The zero-based index of the tab within the parent. */
|
|
1646
|
+
index?: number;
|
|
1647
|
+
/** Output only. The depth of the tab within the document. Root-level tabs start at 0. */
|
|
1648
|
+
nestingLevel?: number;
|
|
1649
|
+
/** The immutable ID of the tab. */
|
|
1650
|
+
tabId?: string;
|
|
1651
|
+
/** Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. */
|
|
1652
|
+
parentTabId?: string;
|
|
1653
|
+
/** Optional. The emoji icon displayed with the tab. A valid emoji icon is represented by a non-empty Unicode string. Any set of characters that don't represent a single emoji is invalid. If an emoji is invalid, a 400 bad request error is returned. If this value is unset or empty, the tab will display the default tab icon. */
|
|
1654
|
+
iconEmoji?: string;
|
|
1655
|
+
/** The user-visible name of the tab. */
|
|
1656
|
+
title?: string;
|
|
1657
|
+
};
|
|
1658
|
+
/** A suggested change to the DocumentStyle. */
|
|
1659
|
+
export type DocsSuggestedDocumentStyle = {
|
|
1660
|
+
/** A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. */
|
|
1661
|
+
documentStyleSuggestionState?: DocsDocumentStyleSuggestionState;
|
|
1662
|
+
/** A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. */
|
|
1663
|
+
documentStyle?: DocsDocumentStyle;
|
|
1664
|
+
};
|
|
1665
|
+
/** Creates a NamedRange referencing the given range. */
|
|
1666
|
+
export type DocsCreateNamedRangeRequest = {
|
|
1667
|
+
/** The name of the NamedRange. Names do not need to be unique. Names must be at least 1 character and no more than 256 characters, measured in UTF-16 code units. */
|
|
1668
|
+
name?: string;
|
|
1669
|
+
/** The range to apply the name to. */
|
|
1670
|
+
range?: DocsRange;
|
|
1671
|
+
};
|
|
1672
|
+
/** An embedded object in the document. */
|
|
1673
|
+
export type DocsEmbeddedObject = {
|
|
1674
|
+
/** The properties of an embedded drawing. */
|
|
1675
|
+
embeddedDrawingProperties?: DocsEmbeddedDrawingProperties;
|
|
1676
|
+
/** The right margin of the embedded object. */
|
|
1677
|
+
marginRight?: DocsDimension;
|
|
1678
|
+
/** The visible size of the image after cropping. */
|
|
1679
|
+
size?: DocsSize;
|
|
1680
|
+
/** The border of the embedded object. */
|
|
1681
|
+
embeddedObjectBorder?: DocsEmbeddedObjectBorder;
|
|
1682
|
+
/** The left margin of the embedded object. */
|
|
1683
|
+
marginLeft?: DocsDimension;
|
|
1684
|
+
/** The top margin of the embedded object. */
|
|
1685
|
+
marginTop?: DocsDimension;
|
|
1686
|
+
/** The description of the embedded object. The `title` and `description` are both combined to display alt text. */
|
|
1687
|
+
description?: string;
|
|
1688
|
+
/** A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. */
|
|
1689
|
+
linkedContentReference?: DocsLinkedContentReference;
|
|
1690
|
+
/** The title of the embedded object. The `title` and `description` are both combined to display alt text. */
|
|
1691
|
+
title?: string;
|
|
1692
|
+
/** The bottom margin of the embedded object. */
|
|
1693
|
+
marginBottom?: DocsDimension;
|
|
1694
|
+
/** The properties of an image. */
|
|
1695
|
+
imageProperties?: DocsImageProperties;
|
|
1696
|
+
};
|
|
1697
|
+
/** Deletes a Header from the document. */
|
|
1698
|
+
export type DocsDeleteHeaderRequest = {
|
|
1699
|
+
/** The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
1700
|
+
tabId?: string;
|
|
1701
|
+
/** The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section. */
|
|
1702
|
+
headerId?: string;
|
|
1703
|
+
};
|
|
1704
|
+
/** Inserts a table at the specified location. A newline character will be inserted before the inserted table. */
|
|
1705
|
+
export type DocsInsertTableRequest = {
|
|
1706
|
+
/** The number of rows in the table. */
|
|
1707
|
+
rows?: number;
|
|
1708
|
+
/** Inserts the table at the end of the given header, footer or document body. A newline character will be inserted before the inserted table. Tables cannot be inserted inside a footnote. */
|
|
1709
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
1710
|
+
/** Inserts the table at a specific model index. A newline character will be inserted before the inserted table, therefore the table start index will be at the specified location index + 1. The table must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph). Tables cannot be inserted inside a footnote or equation. */
|
|
1711
|
+
location?: DocsLocation;
|
|
1712
|
+
/** The number of columns in the table. */
|
|
1713
|
+
columns?: number;
|
|
1714
|
+
};
|
|
1715
|
+
/** The result of inserting a Dropdown. */
|
|
1716
|
+
export type DocsInsertDropdownResponse = {
|
|
1717
|
+
/** The newly-inserted Dropdown. */
|
|
1718
|
+
dropdown?: DocsDropdown;
|
|
1719
|
+
};
|
|
1720
|
+
/** Inserts a date at the specified location. */
|
|
1721
|
+
export type DocsInsertDateRequest = {
|
|
1722
|
+
/** Inserts the date at the end of the given header, footer or document body. */
|
|
1723
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
1724
|
+
/** Inserts the date at a specific index in the document. The date must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph). */
|
|
1725
|
+
location?: DocsLocation;
|
|
1726
|
+
/** The properties of the date to insert. */
|
|
1727
|
+
dateElementProperties?: DocsDateElementProperties;
|
|
1728
|
+
};
|
|
1729
|
+
/** Response message for adding a reply. */
|
|
1730
|
+
export type DocsAddCommentReplyResponse = {
|
|
1731
|
+
/** The newly-inserted reply Post. */
|
|
1732
|
+
post?: DocsPost;
|
|
1733
|
+
};
|
|
1734
|
+
/** The contents and style of a row in a Table. */
|
|
1735
|
+
export type DocsTableRow = {
|
|
1736
|
+
/** The suggested style changes to this row, keyed by suggestion ID. */
|
|
1737
|
+
suggestedTableRowStyleChanges?: Record<string, DocsSuggestedTableRowStyle>;
|
|
1738
|
+
/** The zero-based end index of this row, exclusive, in UTF-16 code units. */
|
|
1739
|
+
endIndex?: number;
|
|
1740
|
+
/** The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
1741
|
+
suggestedInsertionIds?: Array<string>;
|
|
1742
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1743
|
+
suggestedDeletionIds?: Array<string>;
|
|
1744
|
+
/** The style of the table row. */
|
|
1745
|
+
tableRowStyle?: DocsTableRowStyle;
|
|
1746
|
+
/** The zero-based start index of this row, in UTF-16 code units. */
|
|
1747
|
+
startIndex?: number;
|
|
1748
|
+
/** The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. */
|
|
1749
|
+
tableCells?: Array<DocsTableCell>;
|
|
1750
|
+
};
|
|
1751
|
+
/** The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. */
|
|
1752
|
+
export type DocsListProperties = {
|
|
1753
|
+
/** Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. */
|
|
1754
|
+
nestingLevels?: Array<DocsNestingLevel>;
|
|
1755
|
+
};
|
|
1756
|
+
/** A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
1757
|
+
export type DocsImagePropertiesSuggestionState = {
|
|
1758
|
+
/** Indicates if there was a suggested change to transparency. */
|
|
1759
|
+
transparencySuggested?: boolean;
|
|
1760
|
+
/** Indicates if there was a suggested change to contrast. */
|
|
1761
|
+
contrastSuggested?: boolean;
|
|
1762
|
+
/** Indicates if there was a suggested change to content_uri. */
|
|
1763
|
+
contentUriSuggested?: boolean;
|
|
1764
|
+
/** A mask that indicates which of the fields in crop_properties have been changed in this suggestion. */
|
|
1765
|
+
cropPropertiesSuggestionState?: DocsCropPropertiesSuggestionState;
|
|
1766
|
+
/** Indicates if there was a suggested change to brightness. */
|
|
1767
|
+
brightnessSuggested?: boolean;
|
|
1768
|
+
/** Indicates if there was a suggested change to source_uri. */
|
|
1769
|
+
sourceUriSuggested?: boolean;
|
|
1770
|
+
/** Indicates if there was a suggested change to angle. */
|
|
1771
|
+
angleSuggested?: boolean;
|
|
1772
|
+
};
|
|
1773
|
+
/** A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. */
|
|
1774
|
+
export type DocsNamedRange = {
|
|
1775
|
+
/** The ranges that belong to this named range. */
|
|
1776
|
+
ranges?: Array<DocsRange>;
|
|
1777
|
+
/** The ID of the named range. */
|
|
1778
|
+
namedRangeId?: string;
|
|
1779
|
+
/** The name of the named range. */
|
|
1780
|
+
name?: string;
|
|
1781
|
+
};
|
|
1782
|
+
/** A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. */
|
|
1783
|
+
export type DocsNamedStyle = {
|
|
1784
|
+
/** The type of this named style. */
|
|
1785
|
+
namedStyleType?: "NAMED_STYLE_TYPE_UNSPECIFIED" | "NORMAL_TEXT" | "TITLE" | "SUBTITLE" | "HEADING_1" | "HEADING_2" | "HEADING_3" | "HEADING_4" | "HEADING_5" | "HEADING_6";
|
|
1786
|
+
/** The text style of this named style. */
|
|
1787
|
+
textStyle?: DocsTextStyle;
|
|
1788
|
+
/** The paragraph style of this named style. */
|
|
1789
|
+
paragraphStyle?: DocsParagraphStyle;
|
|
1790
|
+
};
|
|
1791
|
+
/** The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. */
|
|
1792
|
+
export type DocsEmbeddedDrawingProperties = Record<string, unknown>;
|
|
1793
|
+
/** Deletes a suggestion. Returns a 403 forbidden error if the requesting user is not the author of the suggestion. */
|
|
1794
|
+
export type DocsDeleteSuggestionRequest = {
|
|
1795
|
+
/** The ID of the suggestion. */
|
|
1796
|
+
suggestionId?: string;
|
|
1797
|
+
};
|
|
1798
|
+
/** Update the properties of a document tab. */
|
|
1799
|
+
export type DocsUpdateDocumentTabPropertiesRequest = {
|
|
1800
|
+
/** The tab properties to update. */
|
|
1801
|
+
tabProperties?: DocsTabProperties;
|
|
1802
|
+
/** The fields that should be updated. At least one field must be specified. The root `tab_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */
|
|
1803
|
+
fields?: string;
|
|
1804
|
+
};
|
|
1805
|
+
/** Deletes content from the document. */
|
|
1806
|
+
export type DocsDeleteContentRangeRequest = {
|
|
1807
|
+
/** The range of content to delete. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles, lists, positioned objects and bookmarks as the two paragraphs are merged. Attempting to delete certain ranges can result in an invalid document structure in which case a 400 bad request error is returned. Some examples of invalid delete requests include: * Deleting one code unit of a surrogate pair. * Deleting the last newline character of a Body, Header, Footer, Footnote, TableCell or TableOfContents. * Deleting the start or end of a Table, TableOfContents or Equation without deleting the entire element. * Deleting the newline character before a Table, TableOfContents or SectionBreak without deleting the element. * Deleting individual rows or cells of a table. Deleting the content within a table cell is allowed. */
|
|
1808
|
+
range?: DocsRange;
|
|
1809
|
+
};
|
|
1810
|
+
/** Accepts a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document. */
|
|
1811
|
+
export type DocsAcceptSuggestionRequest = {
|
|
1812
|
+
/** The ID of the suggestion. */
|
|
1813
|
+
suggestionId?: string;
|
|
1814
|
+
};
|
|
1815
|
+
/** A ParagraphElement representing a horizontal line. */
|
|
1816
|
+
export type DocsHorizontalRule = {
|
|
1817
|
+
/** The suggested text style changes to this HorizontalRule, keyed by suggestion ID. */
|
|
1818
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
1819
|
+
/** The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. */
|
|
1820
|
+
textStyle?: DocsTextStyle;
|
|
1821
|
+
/** The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
1822
|
+
suggestedInsertionIds?: Array<string>;
|
|
1823
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1824
|
+
suggestedDeletionIds?: Array<string>;
|
|
1825
|
+
};
|
|
1826
|
+
/** A reference to a heading in this document. */
|
|
1827
|
+
export type DocsHeadingLink = {
|
|
1828
|
+
/** The ID of the tab containing this heading. */
|
|
1829
|
+
tabId?: string;
|
|
1830
|
+
/** The ID of a heading in this document. */
|
|
1831
|
+
id?: string;
|
|
1832
|
+
};
|
|
1833
|
+
/** Update the styling of text. */
|
|
1834
|
+
export type DocsUpdateTextStyleRequest = {
|
|
1835
|
+
/** The range of text to style. The range may be extended to include adjacent newlines. If the range fully contains a paragraph belonging to a list, the paragraph's bullet is also updated with the matching text style. Ranges cannot be inserted inside a relative UpdateTextStyleRequest. */
|
|
1836
|
+
range?: DocsRange;
|
|
1837
|
+
/** The fields that should be updated. At least one field must be specified. The root `text_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to `"bold"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */
|
|
1838
|
+
fields?: string;
|
|
1839
|
+
/** The styles to set on the text. If the value for a particular style matches that of the parent, that style will be set to inherit. Certain text style changes may cause other changes in order to to mirror the behavior of the Docs editor. See the documentation of TextStyle for more information. */
|
|
1840
|
+
textStyle?: DocsTextStyle;
|
|
1841
|
+
};
|
|
1842
|
+
/** Updates the DocumentStyle. */
|
|
1843
|
+
export type DocsUpdateDocumentStyleRequest = {
|
|
1844
|
+
/** The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document. */
|
|
1845
|
+
tabId?: string;
|
|
1846
|
+
/** The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`. */
|
|
1847
|
+
fields?: string;
|
|
1848
|
+
/** The styles to set on the document. Certain document style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of DocumentStyle for more information. */
|
|
1849
|
+
documentStyle?: DocsDocumentStyle;
|
|
1850
|
+
};
|
|
1851
|
+
/** A color that can either be fully opaque or fully transparent. */
|
|
1852
|
+
export type DocsOptionalColor = {
|
|
1853
|
+
/** If set, this will be used as an opaque color. If unset, this represents a transparent color. */
|
|
1854
|
+
color?: DocsColor;
|
|
1855
|
+
};
|
|
1856
|
+
/** Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. */
|
|
1857
|
+
export type DocsEndOfSegmentLocation = {
|
|
1858
|
+
/** The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */
|
|
1859
|
+
segmentId?: string;
|
|
1860
|
+
/** The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
1861
|
+
tabId?: string;
|
|
1862
|
+
};
|
|
1863
|
+
/** A suggested change to InlineObjectProperties. */
|
|
1864
|
+
export type DocsSuggestedInlineObjectProperties = {
|
|
1865
|
+
/** An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. */
|
|
1866
|
+
inlineObjectProperties?: DocsInlineObjectProperties;
|
|
1867
|
+
/** A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. */
|
|
1868
|
+
inlineObjectPropertiesSuggestionState?: DocsInlineObjectPropertiesSuggestionState;
|
|
1869
|
+
};
|
|
1870
|
+
/** Inserts text at the specified location. */
|
|
1871
|
+
export type DocsInsertTextRequest = {
|
|
1872
|
+
/** Inserts the text at the end of a header, footer, footnote or the document body. */
|
|
1873
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
1874
|
+
/** Inserts the text at a specific index in the document. Text must be inserted inside the bounds of an existing Paragraph. For instance, text cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The text must be inserted in the preceding paragraph. */
|
|
1875
|
+
location?: DocsLocation;
|
|
1876
|
+
/** The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. */
|
|
1877
|
+
text?: string;
|
|
1878
|
+
};
|
|
1879
|
+
/** Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned. */
|
|
1880
|
+
export type DocsCreateFooterRequest = {
|
|
1881
|
+
/** The type of footer to create. */
|
|
1882
|
+
type?: "HEADER_FOOTER_TYPE_UNSPECIFIED" | "DEFAULT";
|
|
1883
|
+
/** The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. */
|
|
1884
|
+
sectionBreakLocation?: DocsLocation;
|
|
1885
|
+
};
|
|
1886
|
+
/** A criteria that matches a specific string of text in the document. */
|
|
1887
|
+
export type DocsSubstringMatchCriteria = {
|
|
1888
|
+
/** Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - `True`: the search text is treated as a regular expressions. - `False`: the search text is treated as a substring for matching. */
|
|
1889
|
+
searchByRegex?: boolean;
|
|
1890
|
+
/** Indicates whether the search should respect case: - `True`: the search is case sensitive. - `False`: the search is case insensitive. */
|
|
1891
|
+
matchCase?: boolean;
|
|
1892
|
+
/** The text to search for in the document. */
|
|
1893
|
+
text?: string;
|
|
1894
|
+
};
|
|
1895
|
+
/** The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. */
|
|
1896
|
+
export type DocsNamedStyles = {
|
|
1897
|
+
/** The named styles. There's an entry for each of the possible named style types. */
|
|
1898
|
+
styles?: Array<DocsNamedStyle>;
|
|
1899
|
+
};
|
|
1900
|
+
/** The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. */
|
|
1901
|
+
export type DocsTableCellStyle = {
|
|
1902
|
+
/** The column span of the cell. This property is read-only. */
|
|
1903
|
+
columnSpan?: number;
|
|
1904
|
+
/** The bottom border of the cell. */
|
|
1905
|
+
borderBottom?: DocsTableCellBorder;
|
|
1906
|
+
/** The top border of the cell. */
|
|
1907
|
+
borderTop?: DocsTableCellBorder;
|
|
1908
|
+
/** The right padding of the cell. */
|
|
1909
|
+
paddingRight?: DocsDimension;
|
|
1910
|
+
/** The bottom padding of the cell. */
|
|
1911
|
+
paddingBottom?: DocsDimension;
|
|
1912
|
+
/** The background color of the cell. */
|
|
1913
|
+
backgroundColor?: DocsOptionalColor;
|
|
1914
|
+
/** The left padding of the cell. */
|
|
1915
|
+
paddingLeft?: DocsDimension;
|
|
1916
|
+
/** The left border of the cell. */
|
|
1917
|
+
borderLeft?: DocsTableCellBorder;
|
|
1918
|
+
/** The top padding of the cell. */
|
|
1919
|
+
paddingTop?: DocsDimension;
|
|
1920
|
+
/** The row span of the cell. This property is read-only. */
|
|
1921
|
+
rowSpan?: number;
|
|
1922
|
+
/** The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. */
|
|
1923
|
+
contentAlignment?: "CONTENT_ALIGNMENT_UNSPECIFIED" | "CONTENT_ALIGNMENT_UNSUPPORTED" | "TOP" | "MIDDLE" | "BOTTOM";
|
|
1924
|
+
/** The right border of the cell. */
|
|
1925
|
+
borderRight?: DocsTableCellBorder;
|
|
1926
|
+
};
|
|
1927
|
+
/** A suggested change to PositionedObjectProperties. */
|
|
1928
|
+
export type DocsSuggestedPositionedObjectProperties = {
|
|
1929
|
+
/** A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. */
|
|
1930
|
+
positionedObjectPropertiesSuggestionState?: DocsPositionedObjectPropertiesSuggestionState;
|
|
1931
|
+
/** A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. */
|
|
1932
|
+
positionedObjectProperties?: DocsPositionedObjectProperties;
|
|
1933
|
+
};
|
|
1934
|
+
/** Properties that apply to a section's column. */
|
|
1935
|
+
export type DocsSectionColumnProperties = {
|
|
1936
|
+
/** Output only. The width of the column. */
|
|
1937
|
+
width?: DocsDimension;
|
|
1938
|
+
/** The padding at the end of the column. */
|
|
1939
|
+
paddingEnd?: DocsDimension;
|
|
1940
|
+
};
|
|
1941
|
+
/** Deletes a reply Post from a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains an action. - The reply post contains an assignee. */
|
|
1942
|
+
export type DocsDeleteCommentReplyRequest = {
|
|
1943
|
+
/** The ID of the reply Post being deleted. */
|
|
1944
|
+
postId?: string;
|
|
1945
|
+
/** The ID of the SuggestionThread which the post belongs to. */
|
|
1946
|
+
suggestionId?: string;
|
|
1947
|
+
/** The ID of the CommentThread which the post belongs to. */
|
|
1948
|
+
commentId?: string;
|
|
1949
|
+
};
|
|
1950
|
+
/** A border around an EmbeddedObject. */
|
|
1951
|
+
export type DocsEmbeddedObjectBorder = {
|
|
1952
|
+
/** The dash style of the border. */
|
|
1953
|
+
dashStyle?: "DASH_STYLE_UNSPECIFIED" | "SOLID" | "DOT" | "DASH";
|
|
1954
|
+
/** The property state of the border property. */
|
|
1955
|
+
propertyState?: "RENDERED" | "NOT_RENDERED";
|
|
1956
|
+
/** The width of the border. */
|
|
1957
|
+
width?: DocsDimension;
|
|
1958
|
+
/** The color of the border. */
|
|
1959
|
+
color?: DocsOptionalColor;
|
|
1960
|
+
};
|
|
1961
|
+
/** A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
1962
|
+
export type DocsInlineObjectPropertiesSuggestionState = {
|
|
1963
|
+
/** A mask that indicates which of the fields in embedded_object have been changed in this suggestion. */
|
|
1964
|
+
embeddedObjectSuggestionState?: DocsEmbeddedObjectSuggestionState;
|
|
1965
|
+
};
|
|
1966
|
+
/** A collection of all the NamedRanges in the document that share a given name. */
|
|
1967
|
+
export type DocsNamedRanges = {
|
|
1968
|
+
/** The NamedRanges that share the same name. */
|
|
1969
|
+
namedRanges?: Array<DocsNamedRange>;
|
|
1970
|
+
/** The name that all the named ranges share. */
|
|
1971
|
+
name?: string;
|
|
1972
|
+
};
|
|
1973
|
+
/** An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. */
|
|
1974
|
+
export type DocsInlineObject = {
|
|
1975
|
+
/** The ID of this inline object. Can be used to update an object’s properties. */
|
|
1976
|
+
objectId?: string;
|
|
1977
|
+
/** The suggested changes to the inline object properties, keyed by suggestion ID. */
|
|
1978
|
+
suggestedInlineObjectPropertiesChanges?: Record<string, DocsSuggestedInlineObjectProperties>;
|
|
1979
|
+
/** The suggested insertion ID. If empty, then this is not a suggested insertion. */
|
|
1980
|
+
suggestedInsertionId?: string;
|
|
1981
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
1982
|
+
suggestedDeletionIds?: Array<string>;
|
|
1983
|
+
/** The properties of this inline object. */
|
|
1984
|
+
inlineObjectProperties?: DocsInlineObjectProperties;
|
|
1985
|
+
};
|
|
1986
|
+
/** Inserts an empty column into a table. */
|
|
1987
|
+
export type DocsInsertTableColumnRequest = {
|
|
1988
|
+
/** Whether to insert new column to the right of the reference cell location. - `True`: insert to the right. - `False`: insert to the left. */
|
|
1989
|
+
insertRight?: boolean;
|
|
1990
|
+
/** The reference table cell location from which columns will be inserted. A new column will be inserted to the left (or right) of the column where the reference cell is. If the reference cell is a merged cell, a new column will be inserted to the left (or right) of the merged cell. */
|
|
1991
|
+
tableCellLocation?: DocsTableCellLocation;
|
|
1992
|
+
};
|
|
1993
|
+
/** A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. */
|
|
1994
|
+
export type DocsTableCellBorder = {
|
|
1995
|
+
/** The dash style of the border. */
|
|
1996
|
+
dashStyle?: "DASH_STYLE_UNSPECIFIED" | "SOLID" | "DOT" | "DASH";
|
|
1997
|
+
/** The width of the border. */
|
|
1998
|
+
width?: DocsDimension;
|
|
1999
|
+
/** The color of the border. This color cannot be transparent. */
|
|
2000
|
+
color?: DocsOptionalColor;
|
|
2001
|
+
};
|
|
2002
|
+
/** A document header. */
|
|
2003
|
+
export type DocsHeader = {
|
|
2004
|
+
/** The ID of the header. */
|
|
2005
|
+
headerId?: string;
|
|
2006
|
+
/** The contents of the header. The indexes for a header's content begin at zero. */
|
|
2007
|
+
content?: Array<DocsStructuralElement>;
|
|
2008
|
+
};
|
|
2009
|
+
/** Response message for inserting a comment. */
|
|
2010
|
+
export type DocsInsertCommentResponse = {
|
|
2011
|
+
/** The newly-inserted comment thread. */
|
|
2012
|
+
commentThread?: DocsCommentThread;
|
|
2013
|
+
};
|
|
2014
|
+
/** Updates the properties of a Dropdown. */
|
|
2015
|
+
export type DocsUpdateDropdownPropertiesRequest = {
|
|
2016
|
+
/** The ID of the tab that contains the dropdown to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
2017
|
+
tabId?: string;
|
|
2018
|
+
/** The properties to update. */
|
|
2019
|
+
dropdownProperties?: DocsDropdownProperties;
|
|
2020
|
+
/** The fields that should be updated. At least one field must be specified. The root `dropdown_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */
|
|
2021
|
+
fields?: string;
|
|
2022
|
+
/** Required. The Dropdown ID. */
|
|
2023
|
+
dropdownId?: string;
|
|
2024
|
+
};
|
|
2025
|
+
/** A tab in a document. */
|
|
2026
|
+
export type DocsTab = {
|
|
2027
|
+
/** The child tabs nested within this tab. */
|
|
2028
|
+
childTabs?: Array<DocsTab>;
|
|
2029
|
+
/** The properties of the tab, like ID and title. */
|
|
2030
|
+
tabProperties?: DocsTabProperties;
|
|
2031
|
+
/** A tab with document contents, like text and images. */
|
|
2032
|
+
documentTab?: DocsDocumentTab;
|
|
2033
|
+
};
|
|
2034
|
+
/** A solid color. */
|
|
2035
|
+
export type DocsColor = {
|
|
2036
|
+
/** The RGB color value. */
|
|
2037
|
+
rgbColor?: DocsRgbColor;
|
|
2038
|
+
};
|
|
2039
|
+
/** A document footer. */
|
|
2040
|
+
export type DocsFooter = {
|
|
2041
|
+
/** The ID of the footer. */
|
|
2042
|
+
footerId?: string;
|
|
2043
|
+
/** The contents of the footer. The indexes for a footer's content begin at zero. */
|
|
2044
|
+
content?: Array<DocsStructuralElement>;
|
|
2045
|
+
};
|
|
2046
|
+
/** A suggested change to dropdown definition properties. */
|
|
2047
|
+
export type DocsSuggestedDropdownDefinitionProperties = {
|
|
2048
|
+
/** A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values. */
|
|
2049
|
+
dropdownDefinitionProperties?: DocsDropdownDefinitionProperties;
|
|
2050
|
+
/** A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. */
|
|
2051
|
+
dropdownDefinitionPropertiesSuggestionState?: DocsDropdownDefinitionPropertiesSuggestionState;
|
|
2052
|
+
};
|
|
2053
|
+
/** A collection of object IDs. */
|
|
2054
|
+
export type DocsObjectReferences = {
|
|
2055
|
+
/** The object IDs. */
|
|
2056
|
+
objectIds?: Array<string>;
|
|
2057
|
+
};
|
|
2058
|
+
/** A StructuralElement representing a table of contents. */
|
|
2059
|
+
export type DocsTableOfContents = {
|
|
2060
|
+
/** The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
2061
|
+
suggestedInsertionIds?: Array<string>;
|
|
2062
|
+
/** The content of the table of contents. */
|
|
2063
|
+
content?: Array<DocsStructuralElement>;
|
|
2064
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
2065
|
+
suggestedDeletionIds?: Array<string>;
|
|
2066
|
+
};
|
|
2067
|
+
/** A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2068
|
+
export type DocsListPropertiesSuggestionState = {
|
|
2069
|
+
/** A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. */
|
|
2070
|
+
nestingLevelsSuggestionStates?: Array<DocsNestingLevelSuggestionState>;
|
|
2071
|
+
};
|
|
2072
|
+
/** A StructuralElement describes content that provides structure to the document. */
|
|
2073
|
+
export type DocsStructuralElement = {
|
|
2074
|
+
/** The zero-based start index of this structural element, in UTF-16 code units. */
|
|
2075
|
+
startIndex?: number;
|
|
2076
|
+
/** A table type of structural element. */
|
|
2077
|
+
table?: DocsTable;
|
|
2078
|
+
/** A table of contents type of structural element. */
|
|
2079
|
+
tableOfContents?: DocsTableOfContents;
|
|
2080
|
+
/** A section break type of structural element. */
|
|
2081
|
+
sectionBreak?: DocsSectionBreak;
|
|
2082
|
+
/** A paragraph type of structural element. */
|
|
2083
|
+
paragraph?: DocsParagraph;
|
|
2084
|
+
/** The zero-based end index of this structural element, exclusive, in UTF-16 code units. */
|
|
2085
|
+
endIndex?: number;
|
|
2086
|
+
};
|
|
2087
|
+
/** Inserts an InlineObject containing an image at the given location. */
|
|
2088
|
+
export type DocsInsertInlineImageRequest = {
|
|
2089
|
+
/** Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote. */
|
|
2090
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
2091
|
+
/** The size that the image should appear as in the document. This property is optional and the final size of the image in the document is determined by the following rules: * If neither width nor height is specified, then a default size of the image is calculated based on its resolution. * If one dimension is specified then the other dimension is calculated to preserve the aspect ratio of the image. * If both width and height are specified, the image is scaled to fit within the provided dimensions while maintaining its aspect ratio. */
|
|
2092
|
+
objectSize?: DocsSize;
|
|
2093
|
+
/** The image URI. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI must be publicly accessible and at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field. */
|
|
2094
|
+
uri?: string;
|
|
2095
|
+
/** Inserts the image at a specific index in the document. The image must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Inline images cannot be inserted inside a footnote or equation. */
|
|
2096
|
+
location?: DocsLocation;
|
|
2097
|
+
};
|
|
2098
|
+
/** The document body. The body typically contains the full document contents except for headers, footers, and footnotes. */
|
|
2099
|
+
export type DocsBody = {
|
|
2100
|
+
/** The contents of the body. The indexes for the body's content begin at zero. */
|
|
2101
|
+
content?: Array<DocsStructuralElement>;
|
|
2102
|
+
};
|
|
2103
|
+
/** Inserts an empty row into a table. */
|
|
2104
|
+
export type DocsInsertTableRowRequest = {
|
|
2105
|
+
/** The reference table cell location from which rows will be inserted. A new row will be inserted above (or below) the row where the reference cell is. If the reference cell is a merged cell, a new row will be inserted above (or below) the merged cell. */
|
|
2106
|
+
tableCellLocation?: DocsTableCellLocation;
|
|
2107
|
+
/** Whether to insert new row below the reference cell location. - `True`: insert below the cell. - `False`: insert above the cell. */
|
|
2108
|
+
insertBelow?: boolean;
|
|
2109
|
+
};
|
|
2110
|
+
/** Provides control over how write requests are executed. */
|
|
2111
|
+
export type DocsWriteControl = {
|
|
2112
|
+
/** How the request updates should be applied to the document. If unspecified, the request updates will be applied as normal edits. */
|
|
2113
|
+
writeMode?: "WRITE_MODE_UNSPECIFIED" | "EDIT" | "SUGGEST";
|
|
2114
|
+
/** The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied. */
|
|
2115
|
+
requiredRevisionId?: string;
|
|
2116
|
+
/** The optional target revision ID of the document the write request is applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request are applied against the collaborator changes. This results in a new revision of the document that incorporates both the collaborator changes and the changes in the request, with the Docs server resolving conflicting changes. When using target revision ID, the API client can be thought of as another collaborator of the document. The target revision ID can only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 bad request error. The request should be tried again after retrieving the latest version of the document. Usually a revision ID remains valid for use as a target revision for several minutes after it's read, but for frequently edited documents this window might be shorter. */
|
|
2117
|
+
targetRevisionId?: string;
|
|
2118
|
+
};
|
|
2119
|
+
/** The result of creating a footer. */
|
|
2120
|
+
export type DocsCreateFooterResponse = {
|
|
2121
|
+
/** The ID of the created footer. */
|
|
2122
|
+
footerId?: string;
|
|
2123
|
+
};
|
|
2124
|
+
/** A dropdown definition in the document. */
|
|
2125
|
+
export type DocsDropdownDefinition = {
|
|
2126
|
+
/** The properties of this dropdown definition. */
|
|
2127
|
+
dropdownDefinitionProperties?: DocsDropdownDefinitionProperties;
|
|
2128
|
+
/** The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated. */
|
|
2129
|
+
dropdownDefinitionId?: string;
|
|
2130
|
+
/** ID for suggestion that deletes this dropdown definition. */
|
|
2131
|
+
suggestedDeletionId?: string;
|
|
2132
|
+
/** ID for suggestion that inserts this dropdown definition. */
|
|
2133
|
+
suggestedInsertionId?: string;
|
|
2134
|
+
/** Suggested property changes to this definition, keyed by suggestion ID. */
|
|
2135
|
+
suggestedDropdownDefinitionPropertiesChanges?: Record<string, DocsSuggestedDropdownDefinitionProperties>;
|
|
2136
|
+
};
|
|
2137
|
+
/** The styling that applies to a section. */
|
|
2138
|
+
export type DocsSectionStyle = {
|
|
2139
|
+
/** The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2140
|
+
contentDirection?: "CONTENT_DIRECTION_UNSPECIFIED" | "LEFT_TO_RIGHT" | "RIGHT_TO_LEFT";
|
|
2141
|
+
/** The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2142
|
+
marginHeader?: DocsDimension;
|
|
2143
|
+
/** The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2144
|
+
marginLeft?: DocsDimension;
|
|
2145
|
+
/** The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
2146
|
+
evenPageHeaderId?: string;
|
|
2147
|
+
/** The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2148
|
+
marginTop?: DocsDimension;
|
|
2149
|
+
/** The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
2150
|
+
firstPageHeaderId?: string;
|
|
2151
|
+
/** The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
2152
|
+
firstPageFooterId?: string;
|
|
2153
|
+
/** The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
2154
|
+
defaultFooterId?: string;
|
|
2155
|
+
/** The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2156
|
+
marginFooter?: DocsDimension;
|
|
2157
|
+
/** The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2158
|
+
pageNumberStart?: number;
|
|
2159
|
+
/** The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2160
|
+
marginBottom?: DocsDimension;
|
|
2161
|
+
/** Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2162
|
+
flipPageOrientation?: boolean;
|
|
2163
|
+
/** The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
2164
|
+
evenPageFooterId?: string;
|
|
2165
|
+
/** The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2166
|
+
marginRight?: DocsDimension;
|
|
2167
|
+
/** The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2168
|
+
columnSeparatorStyle?: "COLUMN_SEPARATOR_STYLE_UNSPECIFIED" | "NONE" | "BETWEEN_EACH_COLUMN";
|
|
2169
|
+
/** The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. */
|
|
2170
|
+
columnProperties?: Array<DocsSectionColumnProperties>;
|
|
2171
|
+
/** Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
2172
|
+
useFirstPageHeaderFooter?: boolean;
|
|
2173
|
+
/** Output only. The type of section. */
|
|
2174
|
+
sectionType?: "SECTION_TYPE_UNSPECIFIED" | "CONTINUOUS" | "NEXT_PAGE";
|
|
2175
|
+
/** The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
2176
|
+
defaultHeaderId?: string;
|
|
2177
|
+
};
|
|
2178
|
+
/** Request message for BatchUpdateDocument. */
|
|
2179
|
+
export type DocsBatchUpdateDocumentRequest = {
|
|
2180
|
+
/** A list of updates to apply to the document. */
|
|
2181
|
+
requests?: Array<DocsRequest>;
|
|
2182
|
+
/** Provides control over how write requests are executed. */
|
|
2183
|
+
writeControl?: DocsWriteControl;
|
|
2184
|
+
};
|
|
2185
|
+
/** A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2186
|
+
export type DocsEmbeddedObjectSuggestionState = {
|
|
2187
|
+
/** A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. */
|
|
2188
|
+
linkedContentReferenceSuggestionState?: DocsLinkedContentReferenceSuggestionState;
|
|
2189
|
+
/** A mask that indicates which of the fields in size have been changed in this suggestion. */
|
|
2190
|
+
sizeSuggestionState?: DocsSizeSuggestionState;
|
|
2191
|
+
/** Indicates if there was a suggested change to title. */
|
|
2192
|
+
titleSuggested?: boolean;
|
|
2193
|
+
/** Indicates if there was a suggested change to margin_left. */
|
|
2194
|
+
marginLeftSuggested?: boolean;
|
|
2195
|
+
/** Indicates if there was a suggested change to margin_bottom. */
|
|
2196
|
+
marginBottomSuggested?: boolean;
|
|
2197
|
+
/** Indicates if there was a suggested change to description. */
|
|
2198
|
+
descriptionSuggested?: boolean;
|
|
2199
|
+
/** A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. */
|
|
2200
|
+
embeddedObjectBorderSuggestionState?: DocsEmbeddedObjectBorderSuggestionState;
|
|
2201
|
+
/** Indicates if there was a suggested change to margin_top. */
|
|
2202
|
+
marginTopSuggested?: boolean;
|
|
2203
|
+
/** Indicates if there was a suggested change to margin_right. */
|
|
2204
|
+
marginRightSuggested?: boolean;
|
|
2205
|
+
/** A mask that indicates which of the fields in image_properties have been changed in this suggestion. */
|
|
2206
|
+
imagePropertiesSuggestionState?: DocsImagePropertiesSuggestionState;
|
|
2207
|
+
/** A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. */
|
|
2208
|
+
embeddedDrawingPropertiesSuggestionState?: DocsEmbeddedDrawingPropertiesSuggestionState;
|
|
2209
|
+
};
|
|
2210
|
+
/** A ParagraphElement that represents a run of text that all has the same styling. */
|
|
2211
|
+
export type DocsTextRun = {
|
|
2212
|
+
/** The text style of this run. */
|
|
2213
|
+
textStyle?: DocsTextStyle;
|
|
2214
|
+
/** The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
2215
|
+
suggestedInsertionIds?: Array<string>;
|
|
2216
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
2217
|
+
suggestedDeletionIds?: Array<string>;
|
|
2218
|
+
/** The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. */
|
|
2219
|
+
content?: string;
|
|
2220
|
+
/** The suggested text style changes to this run, keyed by suggestion ID. */
|
|
2221
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
2222
|
+
};
|
|
2223
|
+
/** A tab stop within a paragraph. */
|
|
2224
|
+
export type DocsTabStop = {
|
|
2225
|
+
/** The alignment of this tab stop. If unset, the value defaults to START. */
|
|
2226
|
+
alignment?: "TAB_STOP_ALIGNMENT_UNSPECIFIED" | "START" | "CENTER" | "END";
|
|
2227
|
+
/** The offset between this tab stop and the start margin. */
|
|
2228
|
+
offset?: DocsDimension;
|
|
2229
|
+
};
|
|
2230
|
+
/** Properties of a DateElement. */
|
|
2231
|
+
export type DocsDateElementProperties = {
|
|
2232
|
+
/** Output only. Indicates how the DateElement is displayed in the document. */
|
|
2233
|
+
displayText?: string;
|
|
2234
|
+
/** Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. */
|
|
2235
|
+
timeFormat?: "TIME_FORMAT_UNSPECIFIED" | "TIME_FORMAT_DISABLED" | "TIME_FORMAT_HOUR_MINUTE" | "TIME_FORMAT_HOUR_MINUTE_TIMEZONE";
|
|
2236
|
+
/** The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. */
|
|
2237
|
+
timestamp?: string;
|
|
2238
|
+
/** The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. */
|
|
2239
|
+
locale?: string;
|
|
2240
|
+
/** The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. */
|
|
2241
|
+
timeZoneId?: string;
|
|
2242
|
+
/** Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. */
|
|
2243
|
+
dateFormat?: "DATE_FORMAT_UNSPECIFIED" | "DATE_FORMAT_CUSTOM" | "DATE_FORMAT_MONTH_DAY_ABBREVIATED" | "DATE_FORMAT_MONTH_DAY_FULL" | "DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED" | "DATE_FORMAT_ISO8601";
|
|
2244
|
+
};
|
|
2245
|
+
/** A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2246
|
+
export type DocsParagraphStyleSuggestionState = {
|
|
2247
|
+
/** Indicates if there was a suggested change to indent_start. */
|
|
2248
|
+
indentStartSuggested?: boolean;
|
|
2249
|
+
/** Indicates if there was a suggested change to border_bottom. */
|
|
2250
|
+
borderBottomSuggested?: boolean;
|
|
2251
|
+
/** Indicates if there was a suggested change to spacing_mode. */
|
|
2252
|
+
spacingModeSuggested?: boolean;
|
|
2253
|
+
/** Indicates if there was a suggested change to heading_id. */
|
|
2254
|
+
headingIdSuggested?: boolean;
|
|
2255
|
+
/** Indicates if there was a suggested change to space_below. */
|
|
2256
|
+
spaceBelowSuggested?: boolean;
|
|
2257
|
+
/** A mask that indicates which of the fields in shading have been changed in this suggestion. */
|
|
2258
|
+
shadingSuggestionState?: DocsShadingSuggestionState;
|
|
2259
|
+
/** Indicates if there was a suggested change to direction. */
|
|
2260
|
+
directionSuggested?: boolean;
|
|
2261
|
+
/** Indicates if there was a suggested change to page_break_before. */
|
|
2262
|
+
pageBreakBeforeSuggested?: boolean;
|
|
2263
|
+
/** Indicates if there was a suggested change to avoid_widow_and_orphan. */
|
|
2264
|
+
avoidWidowAndOrphanSuggested?: boolean;
|
|
2265
|
+
/** Indicates if there was a suggested change to keep_lines_together. */
|
|
2266
|
+
keepLinesTogetherSuggested?: boolean;
|
|
2267
|
+
/** Indicates if there was a suggested change to named_style_type. */
|
|
2268
|
+
namedStyleTypeSuggested?: boolean;
|
|
2269
|
+
/** Indicates if there was a suggested change to line_spacing. */
|
|
2270
|
+
lineSpacingSuggested?: boolean;
|
|
2271
|
+
/** Indicates if there was a suggested change to border_right. */
|
|
2272
|
+
borderRightSuggested?: boolean;
|
|
2273
|
+
/** Indicates if there was a suggested change to space_above. */
|
|
2274
|
+
spaceAboveSuggested?: boolean;
|
|
2275
|
+
/** Indicates if there was a suggested change to alignment. */
|
|
2276
|
+
alignmentSuggested?: boolean;
|
|
2277
|
+
/** Indicates if there was a suggested change to border_top. */
|
|
2278
|
+
borderTopSuggested?: boolean;
|
|
2279
|
+
/** Indicates if there was a suggested change to border_between. */
|
|
2280
|
+
borderBetweenSuggested?: boolean;
|
|
2281
|
+
/** Indicates if there was a suggested change to border_left. */
|
|
2282
|
+
borderLeftSuggested?: boolean;
|
|
2283
|
+
/** Indicates if there was a suggested change to indent_end. */
|
|
2284
|
+
indentEndSuggested?: boolean;
|
|
2285
|
+
/** Indicates if there was a suggested change to indent_first_line. */
|
|
2286
|
+
indentFirstLineSuggested?: boolean;
|
|
2287
|
+
/** Indicates if there was a suggested change to keep_with_next. */
|
|
2288
|
+
keepWithNextSuggested?: boolean;
|
|
2289
|
+
};
|
|
2290
|
+
/** Properties specific to a linked Person. */
|
|
2291
|
+
export type DocsPersonProperties = {
|
|
2292
|
+
/** The name of the person if it's displayed in the link text instead of the person's email address. */
|
|
2293
|
+
name?: string;
|
|
2294
|
+
/** The email address linked to this Person. This field is always present. */
|
|
2295
|
+
email?: string;
|
|
2296
|
+
};
|
|
2297
|
+
/** A suggested change to a TableRowStyle. */
|
|
2298
|
+
export type DocsSuggestedTableRowStyle = {
|
|
2299
|
+
/** A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. */
|
|
2300
|
+
tableRowStyle?: DocsTableRowStyle;
|
|
2301
|
+
/** A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. */
|
|
2302
|
+
tableRowStyleSuggestionState?: DocsTableRowStyleSuggestionState;
|
|
2303
|
+
};
|
|
2304
|
+
/** Unmerges cells in a Table. */
|
|
2305
|
+
export type DocsUnmergeTableCellsRequest = {
|
|
2306
|
+
/** The table range specifying which cells of the table to unmerge. All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing. If there is text in any of the merged cells, the text will remain in the "head" cell of the resulting block of unmerged cells. The "head" cell is the upper-left cell when the content direction is from left to right, and the upper-right otherwise. */
|
|
2307
|
+
tableRange?: DocsTableRange;
|
|
2308
|
+
};
|
|
2309
|
+
/** Represents a single comment thread. */
|
|
2310
|
+
export type DocsCommentThread = {
|
|
2311
|
+
/** The unique ID of the comment thread. */
|
|
2312
|
+
commentId?: string;
|
|
2313
|
+
/** The quoted text from the document when the comment was created, formatted as plain-text. */
|
|
2314
|
+
plainTextQuote?: string;
|
|
2315
|
+
/** Replies to the head post. */
|
|
2316
|
+
replies?: Array<DocsPost>;
|
|
2317
|
+
/** The ID of the CommentAnchor in the document that this thread is tied to. Multiple comment threads may be anchored to the same CommentAnchor. */
|
|
2318
|
+
anchorId?: string;
|
|
2319
|
+
/** The first post in the thread. */
|
|
2320
|
+
headPost?: DocsPost;
|
|
2321
|
+
/** Whether the thread is open or resolved. */
|
|
2322
|
+
status?: "STATUS_UNSPECIFIED" | "OPEN" | "RESOLVED";
|
|
2323
|
+
};
|
|
2324
|
+
/** The properties of an image. */
|
|
2325
|
+
export type DocsImageProperties = {
|
|
2326
|
+
/** The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. */
|
|
2327
|
+
brightness?: number;
|
|
2328
|
+
/** The clockwise rotation angle of the image, in radians. */
|
|
2329
|
+
angle?: number;
|
|
2330
|
+
/** The source URI is the URI used to insert the image. The source URI can be empty. */
|
|
2331
|
+
sourceUri?: string;
|
|
2332
|
+
/** A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. */
|
|
2333
|
+
contentUri?: string;
|
|
2334
|
+
/** The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. */
|
|
2335
|
+
contrast?: number;
|
|
2336
|
+
/** The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. */
|
|
2337
|
+
transparency?: number;
|
|
2338
|
+
/** The crop properties of the image. */
|
|
2339
|
+
cropProperties?: DocsCropProperties;
|
|
2340
|
+
};
|
|
2341
|
+
/** One or more locations in the document that are tied to CommentThreads with the same anchorId. Note: Multiple anchors may refer to the same location. */
|
|
2342
|
+
export type DocsCommentAnchor = {
|
|
2343
|
+
/** The ID of the comment anchor. */
|
|
2344
|
+
anchorId?: string;
|
|
2345
|
+
/** A collection of Ranges in the document which are tied to this anchor. */
|
|
2346
|
+
ranges?: Array<DocsRange>;
|
|
2347
|
+
};
|
|
2348
|
+
/** Deletes a NamedRange. */
|
|
2349
|
+
export type DocsDeleteNamedRangeRequest = {
|
|
2350
|
+
/** Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs. */
|
|
2351
|
+
tabsCriteria?: DocsTabsCriteria;
|
|
2352
|
+
/** The name of the range(s) to delete. All named ranges with the given name will be deleted. */
|
|
2353
|
+
name?: string;
|
|
2354
|
+
/** The ID of the named range to delete. */
|
|
2355
|
+
namedRangeId?: string;
|
|
2356
|
+
};
|
|
2357
|
+
/** A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2358
|
+
export type DocsEmbeddedDrawingPropertiesSuggestionState = Record<string, unknown>;
|
|
2359
|
+
/** The properties of a column in a table. */
|
|
2360
|
+
export type DocsTableColumnProperties = {
|
|
2361
|
+
/** The width type of the column. */
|
|
2362
|
+
widthType?: "WIDTH_TYPE_UNSPECIFIED" | "EVENLY_DISTRIBUTED" | "FIXED_WIDTH";
|
|
2363
|
+
/** The width of the column. Set when the column's `width_type` is FIXED_WIDTH. */
|
|
2364
|
+
width?: DocsDimension;
|
|
2365
|
+
};
|
|
2366
|
+
/** A Google Docs document. */
|
|
2367
|
+
export type DocsDocument = {
|
|
2368
|
+
/** Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2369
|
+
inlineObjects?: Record<string, DocsInlineObject>;
|
|
2370
|
+
/** Output only. Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. */
|
|
2371
|
+
tabs?: Array<DocsTab>;
|
|
2372
|
+
/** Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2373
|
+
footers?: Record<string, DocsFooter>;
|
|
2374
|
+
/** Output only. The suggestions associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). */
|
|
2375
|
+
suggestions?: Array<DocsSuggestionThread>;
|
|
2376
|
+
/** Output only. The ID of the document. */
|
|
2377
|
+
documentId?: string;
|
|
2378
|
+
/** Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2379
|
+
namedStyles?: DocsNamedStyles;
|
|
2380
|
+
/** Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2381
|
+
documentStyle?: DocsDocumentStyle;
|
|
2382
|
+
/** Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2383
|
+
suggestedDocumentStyleChanges?: Record<string, DocsSuggestedDocumentStyle>;
|
|
2384
|
+
/** The title of the document. */
|
|
2385
|
+
title?: string;
|
|
2386
|
+
/** Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2387
|
+
headers?: Record<string, DocsHeader>;
|
|
2388
|
+
/** Output only. The comments view mode applied to the document. */
|
|
2389
|
+
commentsViewMode?: "COMMENTS_VIEW_MODE_UNSPECIFIED" | "COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS" | "COMMENTS_VIEW_MODE_OMITTED" | "COMMENTS_VIEW_MODE_INCLUDED";
|
|
2390
|
+
/** Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2391
|
+
positionedObjects?: Record<string, DocsPositionedObject>;
|
|
2392
|
+
/** Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. */
|
|
2393
|
+
suggestionsViewMode?: "DEFAULT_FOR_CURRENT_ACCESS" | "SUGGESTIONS_INLINE" | "PREVIEW_SUGGESTIONS_ACCEPTED" | "PREVIEW_WITHOUT_SUGGESTIONS";
|
|
2394
|
+
/** Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. */
|
|
2395
|
+
revisionId?: string;
|
|
2396
|
+
/** Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2397
|
+
footnotes?: Record<string, DocsFootnote>;
|
|
2398
|
+
/** Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2399
|
+
suggestedNamedStylesChanges?: Record<string, DocsSuggestedNamedStyles>;
|
|
2400
|
+
/** Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2401
|
+
lists?: Record<string, DocsList>;
|
|
2402
|
+
/** Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2403
|
+
namedRanges?: Record<string, DocsNamedRanges>;
|
|
2404
|
+
/** Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
2405
|
+
body?: DocsBody;
|
|
2406
|
+
/** Output only. The comments associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). */
|
|
2407
|
+
comments?: Array<DocsCommentThread>;
|
|
2408
|
+
};
|
|
2409
|
+
/** Properties of an InlineObject. */
|
|
2410
|
+
export type DocsInlineObjectProperties = {
|
|
2411
|
+
/** The embedded object of this inline object. */
|
|
2412
|
+
embeddedObject?: DocsEmbeddedObject;
|
|
2413
|
+
};
|
|
2414
|
+
/** A criteria that specifies in which tabs a request executes. */
|
|
2415
|
+
export type DocsTabsCriteria = {
|
|
2416
|
+
/** The list of tab IDs in which the request executes. */
|
|
2417
|
+
tabIds?: Array<string>;
|
|
2418
|
+
};
|
|
2419
|
+
/** A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2420
|
+
export type DocsCropPropertiesSuggestionState = {
|
|
2421
|
+
/** Indicates if there was a suggested change to offset_right. */
|
|
2422
|
+
offsetRightSuggested?: boolean;
|
|
2423
|
+
/** Indicates if there was a suggested change to offset_bottom. */
|
|
2424
|
+
offsetBottomSuggested?: boolean;
|
|
2425
|
+
/** Indicates if there was a suggested change to angle. */
|
|
2426
|
+
angleSuggested?: boolean;
|
|
2427
|
+
/** Indicates if there was a suggested change to offset_left. */
|
|
2428
|
+
offsetLeftSuggested?: boolean;
|
|
2429
|
+
/** Indicates if there was a suggested change to offset_top. */
|
|
2430
|
+
offsetTopSuggested?: boolean;
|
|
2431
|
+
};
|
|
2432
|
+
/** A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2433
|
+
export type DocsDropdownDefinitionPropertiesSuggestionState = {
|
|
2434
|
+
/** Indicates if there was a suggested change to options. */
|
|
2435
|
+
optionsSuggested?: boolean;
|
|
2436
|
+
/** Indicates if there was a suggested change to title. */
|
|
2437
|
+
titleSuggested?: boolean;
|
|
2438
|
+
};
|
|
2439
|
+
/** Response message from a BatchUpdateDocument request. */
|
|
2440
|
+
export type DocsBatchUpdateDocumentResponse = {
|
|
2441
|
+
/** The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */
|
|
2442
|
+
replies?: Array<DocsResponse>;
|
|
2443
|
+
/** Whether comment updates were applied in the batch request. */
|
|
2444
|
+
commentUpdateState?: "COMMENT_UPDATE_STATE_UNSPECIFIED" | "NO_UPDATES_REQUESTED" | "ALL_SAVED" | "ALL_FAILED_UNKNOWN_REASON";
|
|
2445
|
+
/** The ID of the document to which the updates were applied to. */
|
|
2446
|
+
documentId?: string;
|
|
2447
|
+
/** The suggestions which were affected by each update. This maps 1:1 with the updates. */
|
|
2448
|
+
suggestionResponses?: Array<DocsSuggestionResponse>;
|
|
2449
|
+
/** The updated write control after applying the request. */
|
|
2450
|
+
writeControl?: DocsWriteControl;
|
|
2451
|
+
};
|
|
2452
|
+
/** Deletes a column from a table. */
|
|
2453
|
+
export type DocsDeleteTableColumnRequest = {
|
|
2454
|
+
/** The reference table cell location from which the column will be deleted. The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. */
|
|
2455
|
+
tableCellLocation?: DocsTableCellLocation;
|
|
2456
|
+
};
|
|
2457
|
+
/** A document footnote. */
|
|
2458
|
+
export type DocsFootnote = {
|
|
2459
|
+
/** The contents of the footnote. The indexes for a footnote's content begin at zero. */
|
|
2460
|
+
content?: Array<DocsStructuralElement>;
|
|
2461
|
+
/** The ID of the footnote. */
|
|
2462
|
+
footnoteId?: string;
|
|
2463
|
+
};
|
|
2464
|
+
/** A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2465
|
+
export type DocsLinkedContentReferenceSuggestionState = {
|
|
2466
|
+
/** A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. */
|
|
2467
|
+
sheetsChartReferenceSuggestionState?: DocsSheetsChartReferenceSuggestionState;
|
|
2468
|
+
};
|
|
2469
|
+
/** Updates a Post in a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The post is the headPost of a SuggestionThread. - The requesting user is not the author of the post. */
|
|
2470
|
+
export type DocsUpdateCommentPostRequest = {
|
|
2471
|
+
/** The ID of the post being updated. */
|
|
2472
|
+
postId?: string;
|
|
2473
|
+
/** The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units. */
|
|
2474
|
+
content?: string;
|
|
2475
|
+
/** The ID of the CommentThread which the post belongs to. */
|
|
2476
|
+
commentId?: string;
|
|
2477
|
+
/** The ID of the SuggestionThread which the post belongs to. */
|
|
2478
|
+
suggestionId?: string;
|
|
2479
|
+
};
|
|
2480
|
+
/** A suggested change to a TableCellStyle. */
|
|
2481
|
+
export type DocsSuggestedTableCellStyle = {
|
|
2482
|
+
/** A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. */
|
|
2483
|
+
tableCellStyleSuggestionState?: DocsTableCellStyleSuggestionState;
|
|
2484
|
+
/** A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. */
|
|
2485
|
+
tableCellStyle?: DocsTableCellStyle;
|
|
2486
|
+
};
|
|
2487
|
+
/** A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. */
|
|
2488
|
+
export type DocsColumnBreak = {
|
|
2489
|
+
/** The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. */
|
|
2490
|
+
textStyle?: DocsTextStyle;
|
|
2491
|
+
/** The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
2492
|
+
suggestedInsertionIds?: Array<string>;
|
|
2493
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
2494
|
+
suggestedDeletionIds?: Array<string>;
|
|
2495
|
+
/** The suggested text style changes to this ColumnBreak, keyed by suggestion ID. */
|
|
2496
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
2497
|
+
};
|
|
2498
|
+
/** Represents a font family and weight of text. */
|
|
2499
|
+
export type DocsWeightedFontFamily = {
|
|
2500
|
+
/** The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. */
|
|
2501
|
+
weight?: number;
|
|
2502
|
+
/** The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. */
|
|
2503
|
+
fontFamily?: string;
|
|
2504
|
+
};
|
|
2505
|
+
/** Represents a user who authored a comment or suggestion post. */
|
|
2506
|
+
export type DocsPostAuthor = {
|
|
2507
|
+
/** The display name of the user. May be absent if the author is anonymous. */
|
|
2508
|
+
displayName?: string;
|
|
2509
|
+
/** Whether the user is anonymous. */
|
|
2510
|
+
anonymous?: boolean;
|
|
2511
|
+
/** The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported document. */
|
|
2512
|
+
user?: string;
|
|
2513
|
+
/** Whether the user is the authenticated user making the request. */
|
|
2514
|
+
me?: boolean;
|
|
2515
|
+
};
|
|
2516
|
+
/** A tab with document contents. */
|
|
2517
|
+
export type DocsDocumentTab = {
|
|
2518
|
+
/** The main body of the document tab. */
|
|
2519
|
+
body?: DocsBody;
|
|
2520
|
+
/** The suggested changes to the named styles of the document tab, keyed by suggestion ID. */
|
|
2521
|
+
suggestedNamedStylesChanges?: Record<string, DocsSuggestedNamedStyles>;
|
|
2522
|
+
/** The named ranges in the document tab, keyed by name. */
|
|
2523
|
+
namedRanges?: Record<string, DocsNamedRanges>;
|
|
2524
|
+
/** The positioned objects in the document tab, keyed by object ID. */
|
|
2525
|
+
positionedObjects?: Record<string, DocsPositionedObject>;
|
|
2526
|
+
/** The suggested changes to the style of the document tab, keyed by suggestion ID. */
|
|
2527
|
+
suggestedDocumentStyleChanges?: Record<string, DocsSuggestedDocumentStyle>;
|
|
2528
|
+
/** The style of the document tab. */
|
|
2529
|
+
documentStyle?: DocsDocumentStyle;
|
|
2530
|
+
/** The headers in the document tab, keyed by header ID. */
|
|
2531
|
+
headers?: Record<string, DocsHeader>;
|
|
2532
|
+
/** The inline objects in the document tab, keyed by object ID. */
|
|
2533
|
+
inlineObjects?: Record<string, DocsInlineObject>;
|
|
2534
|
+
/** The named styles of the document tab. */
|
|
2535
|
+
namedStyles?: DocsNamedStyles;
|
|
2536
|
+
/** The lists in the document tab, keyed by list ID. */
|
|
2537
|
+
lists?: Record<string, DocsList>;
|
|
2538
|
+
/** The footnotes in the document tab, keyed by footnote ID. */
|
|
2539
|
+
footnotes?: Record<string, DocsFootnote>;
|
|
2540
|
+
/** The footers in the document tab, keyed by footer ID. */
|
|
2541
|
+
footers?: Record<string, DocsFooter>;
|
|
2542
|
+
/** The comment anchors in a document tab, keyed by anchor ID. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). */
|
|
2543
|
+
commentAnchors?: Record<string, DocsCommentAnchor>;
|
|
2544
|
+
/** The dropdown definitions in a document tab, keyed by dropdown definition ID. */
|
|
2545
|
+
dropdownDefinitions?: Record<string, DocsDropdownDefinition>;
|
|
2546
|
+
};
|
|
2547
|
+
/** Inserts a CommentThread into the document. */
|
|
2548
|
+
export type DocsInsertCommentRequest = {
|
|
2549
|
+
/** The Range in the document that is tied to this comment. */
|
|
2550
|
+
range?: DocsRange;
|
|
2551
|
+
/** Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units. */
|
|
2552
|
+
assigneeEmailAddress?: string;
|
|
2553
|
+
/** The text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units. */
|
|
2554
|
+
content?: string;
|
|
2555
|
+
};
|
|
2556
|
+
/** A suggested change to a ParagraphStyle. */
|
|
2557
|
+
export type DocsSuggestedParagraphStyle = {
|
|
2558
|
+
/** A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. */
|
|
2559
|
+
paragraphStyle?: DocsParagraphStyle;
|
|
2560
|
+
/** A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. */
|
|
2561
|
+
paragraphStyleSuggestionState?: DocsParagraphStyleSuggestionState;
|
|
2562
|
+
};
|
|
2563
|
+
/** Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost. */
|
|
2564
|
+
export type DocsDeleteCommentRequest = {
|
|
2565
|
+
/** The ID of the CommentThread that is being deleted. */
|
|
2566
|
+
commentId?: string;
|
|
2567
|
+
};
|
|
2568
|
+
/** Styles that apply to a table. */
|
|
2569
|
+
export type DocsTableStyle = {
|
|
2570
|
+
/** The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. */
|
|
2571
|
+
tableColumnProperties?: Array<DocsTableColumnProperties>;
|
|
2572
|
+
};
|
|
2573
|
+
/** Updates the properties of a DropdownDefinition. */
|
|
2574
|
+
export type DocsUpdateDropdownDefinitionPropertiesRequest = {
|
|
2575
|
+
/** The ID of the DropdownDefinition to update. */
|
|
2576
|
+
dropdownDefinitionId?: string;
|
|
2577
|
+
/** The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
2578
|
+
tabId?: string;
|
|
2579
|
+
/** A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{"A": "B"}`. */
|
|
2580
|
+
selectedOptionIdReplacements?: Record<string, string>;
|
|
2581
|
+
/** The properties to update. */
|
|
2582
|
+
dropdownDefinitionProperties?: DocsDropdownDefinitionProperties;
|
|
2583
|
+
/** The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`. */
|
|
2584
|
+
fields?: string;
|
|
2585
|
+
};
|
|
2586
|
+
/** Response message for creating a dropdown definition. */
|
|
2587
|
+
export type DocsCreateDropdownDefinitionResponse = {
|
|
2588
|
+
/** The newly-created DropdownDefinition. */
|
|
2589
|
+
dropdownDefinition?: DocsDropdownDefinition;
|
|
2590
|
+
};
|
|
2591
|
+
/** Deletes a tab. If the tab has child tabs, they are deleted as well. */
|
|
2592
|
+
export type DocsDeleteTabRequest = {
|
|
2593
|
+
/** The ID of the tab to delete. */
|
|
2594
|
+
tabId?: string;
|
|
2595
|
+
};
|
|
2596
|
+
/** A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2597
|
+
export type DocsPositionedObjectPropertiesSuggestionState = {
|
|
2598
|
+
/** A mask that indicates which of the fields in positioning have been changed in this suggestion. */
|
|
2599
|
+
positioningSuggestionState?: DocsPositionedObjectPositioningSuggestionState;
|
|
2600
|
+
/** A mask that indicates which of the fields in embedded_object have been changed in this suggestion. */
|
|
2601
|
+
embeddedObjectSuggestionState?: DocsEmbeddedObjectSuggestionState;
|
|
2602
|
+
};
|
|
2603
|
+
/** A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2604
|
+
export type DocsTableCellStyleSuggestionState = {
|
|
2605
|
+
/** Indicates if there was a suggested change to content_alignment. */
|
|
2606
|
+
contentAlignmentSuggested?: boolean;
|
|
2607
|
+
/** Indicates if there was a suggested change to column_span. */
|
|
2608
|
+
columnSpanSuggested?: boolean;
|
|
2609
|
+
/** Indicates if there was a suggested change to border_left. */
|
|
2610
|
+
borderLeftSuggested?: boolean;
|
|
2611
|
+
/** Indicates if there was a suggested change to padding_top. */
|
|
2612
|
+
paddingTopSuggested?: boolean;
|
|
2613
|
+
/** Indicates if there was a suggested change to padding_bottom. */
|
|
2614
|
+
paddingBottomSuggested?: boolean;
|
|
2615
|
+
/** Indicates if there was a suggested change to border_bottom. */
|
|
2616
|
+
borderBottomSuggested?: boolean;
|
|
2617
|
+
/** Indicates if there was a suggested change to padding_right. */
|
|
2618
|
+
paddingRightSuggested?: boolean;
|
|
2619
|
+
/** Indicates if there was a suggested change to padding_left. */
|
|
2620
|
+
paddingLeftSuggested?: boolean;
|
|
2621
|
+
/** Indicates if there was a suggested change to row_span. */
|
|
2622
|
+
rowSpanSuggested?: boolean;
|
|
2623
|
+
/** Indicates if there was a suggested change to border_top. */
|
|
2624
|
+
borderTopSuggested?: boolean;
|
|
2625
|
+
/** Indicates if there was a suggested change to background_color. */
|
|
2626
|
+
backgroundColorSuggested?: boolean;
|
|
2627
|
+
/** Indicates if there was a suggested change to border_right. */
|
|
2628
|
+
borderRightSuggested?: boolean;
|
|
2629
|
+
};
|
|
2630
|
+
/** The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. */
|
|
2631
|
+
export type DocsPositionedObjectPositioning = {
|
|
2632
|
+
/** The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. */
|
|
2633
|
+
leftOffset?: DocsDimension;
|
|
2634
|
+
/** The layout of this positioned object. */
|
|
2635
|
+
layout?: "POSITIONED_OBJECT_LAYOUT_UNSPECIFIED" | "WRAP_TEXT" | "BREAK_LEFT" | "BREAK_RIGHT" | "BREAK_LEFT_RIGHT" | "IN_FRONT_OF_TEXT" | "BEHIND_TEXT";
|
|
2636
|
+
/** The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. */
|
|
2637
|
+
topOffset?: DocsDimension;
|
|
2638
|
+
};
|
|
2639
|
+
/** Adds a document tab. When a tab is added at a given index, all subsequent tabs' indexes are incremented. */
|
|
2640
|
+
export type DocsAddDocumentTabRequest = {
|
|
2641
|
+
/** The properties of the tab to add. All properties are optional. */
|
|
2642
|
+
tabProperties?: DocsTabProperties;
|
|
2643
|
+
};
|
|
2644
|
+
/** A ParagraphElement representing an equation. */
|
|
2645
|
+
export type DocsEquation = {
|
|
2646
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
2647
|
+
suggestedDeletionIds?: Array<string>;
|
|
2648
|
+
/** The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
2649
|
+
suggestedInsertionIds?: Array<string>;
|
|
2650
|
+
};
|
|
2651
|
+
/** Styles that apply to a table row. */
|
|
2652
|
+
export type DocsTableRowStyle = {
|
|
2653
|
+
/** Whether the row is a table header. */
|
|
2654
|
+
tableHeader?: boolean;
|
|
2655
|
+
/** The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. */
|
|
2656
|
+
minRowHeight?: DocsDimension;
|
|
2657
|
+
/** Whether the row cannot overflow across page or column boundaries. */
|
|
2658
|
+
preventOverflow?: boolean;
|
|
2659
|
+
};
|
|
2660
|
+
/** Represents document-level format settings. */
|
|
2661
|
+
export type DocsDocumentFormat = {
|
|
2662
|
+
/** Whether the document has pages or is pageless. */
|
|
2663
|
+
documentMode?: "DOCUMENT_MODE_UNSPECIFIED" | "PAGES" | "PAGELESS";
|
|
2664
|
+
};
|
|
2665
|
+
/** Specifies a contiguous range of text. */
|
|
2666
|
+
export type DocsRange = {
|
|
2667
|
+
/** The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. */
|
|
2668
|
+
segmentId?: string;
|
|
2669
|
+
/** The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */
|
|
2670
|
+
endIndex?: number;
|
|
2671
|
+
/** The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
2672
|
+
tabId?: string;
|
|
2673
|
+
/** The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */
|
|
2674
|
+
startIndex?: number;
|
|
2675
|
+
};
|
|
2676
|
+
/** A date instance mentioned in a document. */
|
|
2677
|
+
export type DocsDateElement = {
|
|
2678
|
+
/** The text style of this DateElement. */
|
|
2679
|
+
textStyle?: DocsTextStyle;
|
|
2680
|
+
/** IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. */
|
|
2681
|
+
suggestedDeletionIds?: Array<string>;
|
|
2682
|
+
/** The suggested changes to the date element properties, keyed by suggestion ID. */
|
|
2683
|
+
suggestedDateElementPropertiesChanges?: Record<string, DocsSuggestedDateElementProperties>;
|
|
2684
|
+
/** IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. */
|
|
2685
|
+
suggestedInsertionIds?: Array<string>;
|
|
2686
|
+
/** The properties of this DateElement. */
|
|
2687
|
+
dateElementProperties?: DocsDateElementProperties;
|
|
2688
|
+
/** Output only. The unique ID of this date. */
|
|
2689
|
+
dateId?: string;
|
|
2690
|
+
/** The suggested text style changes to this DateElement, keyed by suggestion ID. */
|
|
2691
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
2692
|
+
};
|
|
2693
|
+
/** A suggested change to ListProperties. */
|
|
2694
|
+
export type DocsSuggestedListProperties = {
|
|
2695
|
+
/** A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. */
|
|
2696
|
+
listProperties?: DocsListProperties;
|
|
2697
|
+
/** A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. */
|
|
2698
|
+
listPropertiesSuggestionState?: DocsListPropertiesSuggestionState;
|
|
2699
|
+
};
|
|
2700
|
+
/** A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. */
|
|
2701
|
+
export type DocsList = {
|
|
2702
|
+
/** The suggested changes to the list properties, keyed by suggestion ID. */
|
|
2703
|
+
suggestedListPropertiesChanges?: Record<string, DocsSuggestedListProperties>;
|
|
2704
|
+
/** The suggested insertion ID. If empty, then this is not a suggested insertion. */
|
|
2705
|
+
suggestedInsertionId?: string;
|
|
2706
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this list. */
|
|
2707
|
+
suggestedDeletionIds?: Array<string>;
|
|
2708
|
+
/** The properties of the list. */
|
|
2709
|
+
listProperties?: DocsListProperties;
|
|
2710
|
+
};
|
|
2711
|
+
/** An option in a Dropdown. */
|
|
2712
|
+
export type DocsDropdownOption = {
|
|
2713
|
+
/** The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. */
|
|
2714
|
+
textStyle?: DocsTextStyle;
|
|
2715
|
+
/** The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. */
|
|
2716
|
+
optionId?: string;
|
|
2717
|
+
/** The display value of this dropdown option. */
|
|
2718
|
+
displayValue?: string;
|
|
2719
|
+
};
|
|
2720
|
+
/** The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angles are 0, the image is not cropped. */
|
|
2721
|
+
export type DocsCropProperties = {
|
|
2722
|
+
/** The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. */
|
|
2723
|
+
offsetRight?: number;
|
|
2724
|
+
/** The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. */
|
|
2725
|
+
offsetTop?: number;
|
|
2726
|
+
/** The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. */
|
|
2727
|
+
offsetLeft?: number;
|
|
2728
|
+
/** The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. */
|
|
2729
|
+
angle?: number;
|
|
2730
|
+
/** The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. */
|
|
2731
|
+
offsetBottom?: number;
|
|
2732
|
+
};
|
|
2733
|
+
/** A border around a paragraph. */
|
|
2734
|
+
export type DocsParagraphBorder = {
|
|
2735
|
+
/** The color of the border. */
|
|
2736
|
+
color?: DocsOptionalColor;
|
|
2737
|
+
/** The width of the border. */
|
|
2738
|
+
width?: DocsDimension;
|
|
2739
|
+
/** The padding of the border. */
|
|
2740
|
+
padding?: DocsDimension;
|
|
2741
|
+
/** The dash style of the border. */
|
|
2742
|
+
dashStyle?: "DASH_STYLE_UNSPECIFIED" | "SOLID" | "DOT" | "DASH";
|
|
2743
|
+
};
|
|
2744
|
+
/** A suggested change to the NamedStyles. */
|
|
2745
|
+
export type DocsSuggestedNamedStyles = {
|
|
2746
|
+
/** A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. */
|
|
2747
|
+
namedStyles?: DocsNamedStyles;
|
|
2748
|
+
/** A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. */
|
|
2749
|
+
namedStylesSuggestionState?: DocsNamedStylesSuggestionState;
|
|
2750
|
+
};
|
|
2751
|
+
/** A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. */
|
|
2752
|
+
export type DocsSizeSuggestionState = {
|
|
2753
|
+
/** Indicates if there was a suggested change to height. */
|
|
2754
|
+
heightSuggested?: boolean;
|
|
2755
|
+
/** Indicates if there was a suggested change to width. */
|
|
2756
|
+
widthSuggested?: boolean;
|
|
2757
|
+
};
|
|
2758
|
+
/** A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2759
|
+
export type DocsEmbeddedObjectBorderSuggestionState = {
|
|
2760
|
+
/** Indicates if there was a suggested change to width. */
|
|
2761
|
+
widthSuggested?: boolean;
|
|
2762
|
+
/** Indicates if there was a suggested change to dash_style. */
|
|
2763
|
+
dashStyleSuggested?: boolean;
|
|
2764
|
+
/** Indicates if there was a suggested change to color. */
|
|
2765
|
+
colorSuggested?: boolean;
|
|
2766
|
+
/** Indicates if there was a suggested change to property_state. */
|
|
2767
|
+
propertyStateSuggested?: boolean;
|
|
2768
|
+
};
|
|
2769
|
+
/** Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. */
|
|
2770
|
+
export type DocsParagraphStyle = {
|
|
2771
|
+
/** The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. */
|
|
2772
|
+
indentEnd?: DocsDimension;
|
|
2773
|
+
/** The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. */
|
|
2774
|
+
borderBottom?: DocsParagraphBorder;
|
|
2775
|
+
/** Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. */
|
|
2776
|
+
avoidWidowAndOrphan?: boolean;
|
|
2777
|
+
/** The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. */
|
|
2778
|
+
headingId?: string;
|
|
2779
|
+
/** The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. */
|
|
2780
|
+
borderTop?: DocsParagraphBorder;
|
|
2781
|
+
/** The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. */
|
|
2782
|
+
borderBetween?: DocsParagraphBorder;
|
|
2783
|
+
/** The spacing mode for the paragraph. */
|
|
2784
|
+
spacingMode?: "SPACING_MODE_UNSPECIFIED" | "NEVER_COLLAPSE" | "COLLAPSE_LISTS";
|
|
2785
|
+
/** The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. */
|
|
2786
|
+
indentFirstLine?: DocsDimension;
|
|
2787
|
+
/** The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. */
|
|
2788
|
+
direction?: "CONTENT_DIRECTION_UNSPECIFIED" | "LEFT_TO_RIGHT" | "RIGHT_TO_LEFT";
|
|
2789
|
+
/** Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. */
|
|
2790
|
+
keepLinesTogether?: boolean;
|
|
2791
|
+
/** Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. */
|
|
2792
|
+
keepWithNext?: boolean;
|
|
2793
|
+
/** Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. */
|
|
2794
|
+
pageBreakBefore?: boolean;
|
|
2795
|
+
/** The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. */
|
|
2796
|
+
lineSpacing?: number;
|
|
2797
|
+
/** The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. */
|
|
2798
|
+
indentStart?: DocsDimension;
|
|
2799
|
+
/** The amount of extra space below the paragraph. If unset, the value is inherited from the parent. */
|
|
2800
|
+
spaceBelow?: DocsDimension;
|
|
2801
|
+
/** A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. */
|
|
2802
|
+
tabStops?: Array<DocsTabStop>;
|
|
2803
|
+
/** The amount of extra space above the paragraph. If unset, the value is inherited from the parent. */
|
|
2804
|
+
spaceAbove?: DocsDimension;
|
|
2805
|
+
/** The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. */
|
|
2806
|
+
borderLeft?: DocsParagraphBorder;
|
|
2807
|
+
/** The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. */
|
|
2808
|
+
borderRight?: DocsParagraphBorder;
|
|
2809
|
+
/** The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. */
|
|
2810
|
+
namedStyleType?: "NAMED_STYLE_TYPE_UNSPECIFIED" | "NORMAL_TEXT" | "TITLE" | "SUBTITLE" | "HEADING_1" | "HEADING_2" | "HEADING_3" | "HEADING_4" | "HEADING_5" | "HEADING_6";
|
|
2811
|
+
/** The shading of the paragraph. If unset, the value is inherited from the parent. */
|
|
2812
|
+
shading?: DocsShading;
|
|
2813
|
+
/** The text alignment for this paragraph. */
|
|
2814
|
+
alignment?: "ALIGNMENT_UNSPECIFIED" | "START" | "CENTER" | "END" | "JUSTIFIED";
|
|
2815
|
+
};
|
|
2816
|
+
/** Updates the style of a range of table cells. */
|
|
2817
|
+
export type DocsUpdateTableCellStyleRequest = {
|
|
2818
|
+
/** The fields that should be updated. At least one field must be specified. The root `tableCellStyle` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the table cell background color, set `fields` to `"backgroundColor"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */
|
|
2819
|
+
fields?: string;
|
|
2820
|
+
/** The style to set on the table cells. When updating borders, if a cell shares a border with an adjacent cell, the corresponding border property of the adjacent cell is updated as well. Borders that are merged and invisible are not updated. Since updating a border shared by adjacent cells in the same request can cause conflicting border updates, border updates are applied in the following order: - `border_right` - `border_left` - `border_bottom` - `border_top` */
|
|
2821
|
+
tableCellStyle?: DocsTableCellStyle;
|
|
2822
|
+
/** The table range representing the subset of the table to which the updates are applied. */
|
|
2823
|
+
tableRange?: DocsTableRange;
|
|
2824
|
+
/** The location where the table starts in the document. When specified, the updates are applied to all the cells in the table. */
|
|
2825
|
+
tableStartLocation?: DocsLocation;
|
|
2826
|
+
};
|
|
2827
|
+
/** A suggestion state of a NamedStyle message. */
|
|
2828
|
+
export type DocsNamedStyleSuggestionState = {
|
|
2829
|
+
/** The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. */
|
|
2830
|
+
namedStyleType?: "NAMED_STYLE_TYPE_UNSPECIFIED" | "NORMAL_TEXT" | "TITLE" | "SUBTITLE" | "HEADING_1" | "HEADING_2" | "HEADING_3" | "HEADING_4" | "HEADING_5" | "HEADING_6";
|
|
2831
|
+
/** A mask that indicates which of the fields in paragraph style have been changed in this suggestion. */
|
|
2832
|
+
paragraphStyleSuggestionState?: DocsParagraphStyleSuggestionState;
|
|
2833
|
+
/** A mask that indicates which of the fields in text style have been changed in this suggestion. */
|
|
2834
|
+
textStyleSuggestionState?: DocsTextStyleSuggestionState;
|
|
2835
|
+
};
|
|
2836
|
+
/** A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
2837
|
+
export type DocsDateElementPropertiesSuggestionState = {
|
|
2838
|
+
/** Indicates if there was a suggested change to locale. */
|
|
2839
|
+
localeSuggested?: boolean;
|
|
2840
|
+
/** Indicates if there was a suggested change to time_format. */
|
|
2841
|
+
timeFormatSuggested?: boolean;
|
|
2842
|
+
/** Indicates if there was a suggested change to time_zone_id. */
|
|
2843
|
+
timeZoneIdSuggested?: boolean;
|
|
2844
|
+
/** Indicates if there was a suggested change to timestamp. */
|
|
2845
|
+
timestampSuggested?: boolean;
|
|
2846
|
+
/** Indicates if there was a suggested change to date_format. */
|
|
2847
|
+
dateFormatSuggested?: boolean;
|
|
2848
|
+
};
|
|
2849
|
+
/** A suggested change to a DateElementProperties. */
|
|
2850
|
+
export type DocsSuggestedDateElementProperties = {
|
|
2851
|
+
/** A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. */
|
|
2852
|
+
dateElementPropertiesSuggestionState?: DocsDateElementPropertiesSuggestionState;
|
|
2853
|
+
/** DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. */
|
|
2854
|
+
dateElementProperties?: DocsDateElementProperties;
|
|
2855
|
+
};
|
|
2856
|
+
/** A reference to another portion of a document or an external URL resource. */
|
|
2857
|
+
export type DocsLink = {
|
|
2858
|
+
/** The ID of a tab in this document. */
|
|
2859
|
+
tabId?: string;
|
|
2860
|
+
/** An external URL. */
|
|
2861
|
+
url?: string;
|
|
2862
|
+
/** A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. */
|
|
2863
|
+
heading?: DocsHeadingLink;
|
|
2864
|
+
/** The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. */
|
|
2865
|
+
headingId?: string;
|
|
2866
|
+
/** The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. */
|
|
2867
|
+
bookmarkId?: string;
|
|
2868
|
+
/** A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. */
|
|
2869
|
+
bookmark?: DocsBookmarkLink;
|
|
2870
|
+
};
|
|
2871
|
+
/** Deletes a PositionedObject from the document. */
|
|
2872
|
+
export type DocsDeletePositionedObjectRequest = {
|
|
2873
|
+
/** The ID of the positioned object to delete. */
|
|
2874
|
+
objectId?: string;
|
|
2875
|
+
/** The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
2876
|
+
tabId?: string;
|
|
2877
|
+
};
|
|
2878
|
+
/** Deletes a DropdownDefinition. If the dropdown definition is referenced by any dropdown instances (chips) in the document, a 400 bad request error is returned. */
|
|
2879
|
+
export type DocsDeleteDropdownDefinitionRequest = {
|
|
2880
|
+
/** The ID of the tab that contains the dropdown definition to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
2881
|
+
tabId?: string;
|
|
2882
|
+
/** The ID of the DropdownDefinition to delete. */
|
|
2883
|
+
dropdownDefinitionId?: string;
|
|
2884
|
+
};
|
|
2885
|
+
/** Merges cells in a Table. */
|
|
2886
|
+
export type DocsMergeTableCellsRequest = {
|
|
2887
|
+
/** The table range specifying which cells of the table to merge. Any text in the cells being merged will be concatenated and stored in the "head" cell of the range. This is the upper-left cell of the range when the content direction is left to right, and the upper-right cell of the range otherwise. If the range is non-rectangular (which can occur in some cases where the range covers cells that are already merged or where the table is non-rectangular), a 400 bad request error is returned. */
|
|
2888
|
+
tableRange?: DocsTableRange;
|
|
2889
|
+
};
|
|
2890
|
+
/** A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). */
|
|
2891
|
+
export type DocsRichLink = {
|
|
2892
|
+
/** Output only. The properties of this RichLink. This field is always present. */
|
|
2893
|
+
richLinkProperties?: DocsRichLinkProperties;
|
|
2894
|
+
/** The suggested text style changes to this RichLink, keyed by suggestion ID. */
|
|
2895
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
2896
|
+
/** The text style of this RichLink. */
|
|
2897
|
+
textStyle?: DocsTextStyle;
|
|
2898
|
+
/** IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. */
|
|
2899
|
+
suggestedInsertionIds?: Array<string>;
|
|
2900
|
+
/** Output only. The ID of this link. */
|
|
2901
|
+
richLinkId?: string;
|
|
2902
|
+
/** IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. */
|
|
2903
|
+
suggestedDeletionIds?: Array<string>;
|
|
2904
|
+
};
|
|
2905
|
+
/** Properties of a dropdown definition. */
|
|
2906
|
+
export type DocsDropdownDefinitionProperties = {
|
|
2907
|
+
/** The title of the dropdown definition. */
|
|
2908
|
+
title?: string;
|
|
2909
|
+
/** The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. */
|
|
2910
|
+
options?: Array<DocsDropdownOption>;
|
|
2911
|
+
};
|
|
2912
|
+
/** The result of creating a header. */
|
|
2913
|
+
export type DocsCreateHeaderResponse = {
|
|
2914
|
+
/** The ID of the created header. */
|
|
2915
|
+
headerId?: string;
|
|
2916
|
+
};
|
|
2917
|
+
/** A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. */
|
|
2918
|
+
export type DocsParagraph = {
|
|
2919
|
+
/** The suggested paragraph style changes to this paragraph, keyed by suggestion ID. */
|
|
2920
|
+
suggestedParagraphStyleChanges?: Record<string, DocsSuggestedParagraphStyle>;
|
|
2921
|
+
/** The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. */
|
|
2922
|
+
suggestedPositionedObjectIds?: Record<string, DocsObjectReferences>;
|
|
2923
|
+
/** The style of this paragraph. */
|
|
2924
|
+
paragraphStyle?: DocsParagraphStyle;
|
|
2925
|
+
/** The IDs of the positioned objects tethered to this paragraph. */
|
|
2926
|
+
positionedObjectIds?: Array<string>;
|
|
2927
|
+
/** The bullet for this paragraph. If not present, the paragraph does not belong to a list. */
|
|
2928
|
+
bullet?: DocsBullet;
|
|
2929
|
+
/** The suggested changes to this paragraph's bullet. */
|
|
2930
|
+
suggestedBulletChanges?: Record<string, DocsSuggestedBullet>;
|
|
2931
|
+
/** The content of the paragraph, broken down into its component parts. */
|
|
2932
|
+
elements?: Array<DocsParagraphElement>;
|
|
2933
|
+
};
|
|
2934
|
+
/** The result of creating a named range. */
|
|
2935
|
+
export type DocsCreateNamedRangeResponse = {
|
|
2936
|
+
/** The ID of the created named range. */
|
|
2937
|
+
namedRangeId?: string;
|
|
2938
|
+
};
|
|
2939
|
+
/** Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. */
|
|
2940
|
+
export type DocsTextStyle = {
|
|
2941
|
+
/** Whether or not the text is in small capital letters. */
|
|
2942
|
+
smallCaps?: boolean;
|
|
2943
|
+
/** Whether or not the text is underlined. */
|
|
2944
|
+
underline?: boolean;
|
|
2945
|
+
/** The size of the text's font. */
|
|
2946
|
+
fontSize?: DocsDimension;
|
|
2947
|
+
/** Whether or not the text is rendered as bold. */
|
|
2948
|
+
bold?: boolean;
|
|
2949
|
+
/** The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. */
|
|
2950
|
+
baselineOffset?: "BASELINE_OFFSET_UNSPECIFIED" | "NONE" | "SUPERSCRIPT" | "SUBSCRIPT";
|
|
2951
|
+
/** The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. */
|
|
2952
|
+
link?: DocsLink;
|
|
2953
|
+
/** The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. */
|
|
2954
|
+
backgroundColor?: DocsOptionalColor;
|
|
2955
|
+
/** The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. */
|
|
2956
|
+
weightedFontFamily?: DocsWeightedFontFamily;
|
|
2957
|
+
/** Whether or not the text is italicized. */
|
|
2958
|
+
italic?: boolean;
|
|
2959
|
+
/** The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. */
|
|
2960
|
+
foregroundColor?: DocsOptionalColor;
|
|
2961
|
+
/** Whether or not the text is struck through. */
|
|
2962
|
+
strikethrough?: boolean;
|
|
2963
|
+
};
|
|
2964
|
+
/** Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. */
|
|
2965
|
+
export type DocsCreateParagraphBulletsRequest = {
|
|
2966
|
+
/** The range to apply the bullet preset to. */
|
|
2967
|
+
range?: DocsRange;
|
|
2968
|
+
/** The kinds of bullet glyphs to be used. */
|
|
2969
|
+
bulletPreset?: "BULLET_GLYPH_PRESET_UNSPECIFIED" | "BULLET_DISC_CIRCLE_SQUARE" | "BULLET_DIAMONDX_ARROW3D_SQUARE" | "BULLET_CHECKBOX" | "BULLET_ARROW_DIAMOND_DISC" | "BULLET_STAR_CIRCLE_SQUARE" | "BULLET_ARROW3D_CIRCLE_SQUARE" | "BULLET_LEFTTRIANGLE_DIAMOND_DISC" | "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE" | "BULLET_DIAMOND_CIRCLE_SQUARE" | "NUMBERED_DECIMAL_ALPHA_ROMAN" | "NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS" | "NUMBERED_DECIMAL_NESTED" | "NUMBERED_UPPERALPHA_ALPHA_ROMAN" | "NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL" | "NUMBERED_ZERODECIMAL_ALPHA_ROMAN";
|
|
2970
|
+
};
|
|
2971
|
+
/** Rejects a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document and is not the author of the suggestion. */
|
|
2972
|
+
export type DocsRejectSuggestionRequest = {
|
|
2973
|
+
/** The ID of the suggestion. */
|
|
2974
|
+
suggestionId?: string;
|
|
2975
|
+
};
|
|
2976
|
+
/** The result of creating a footnote. */
|
|
2977
|
+
export type DocsCreateFootnoteResponse = {
|
|
2978
|
+
/** The ID of the created footnote. */
|
|
2979
|
+
footnoteId?: string;
|
|
2980
|
+
};
|
|
2981
|
+
/** A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. */
|
|
2982
|
+
export type DocsSectionBreak = {
|
|
2983
|
+
/** The style of the section after this section break. */
|
|
2984
|
+
sectionStyle?: DocsSectionStyle;
|
|
2985
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
2986
|
+
suggestedDeletionIds?: Array<string>;
|
|
2987
|
+
/** The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
2988
|
+
suggestedInsertionIds?: Array<string>;
|
|
2989
|
+
};
|
|
2990
|
+
/** A suggested change to dropdown properties. */
|
|
2991
|
+
export type DocsSuggestedDropdownProperties = {
|
|
2992
|
+
/** A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. */
|
|
2993
|
+
dropdownPropertiesSuggestionState?: DocsDropdownPropertiesSuggestionState;
|
|
2994
|
+
/** A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. */
|
|
2995
|
+
dropdownProperties?: DocsDropdownProperties;
|
|
2996
|
+
};
|
|
2997
|
+
/** A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. */
|
|
2998
|
+
export type DocsBackgroundSuggestionState = {
|
|
2999
|
+
/** Indicates whether the current background color has been modified in this suggestion. */
|
|
3000
|
+
backgroundColorSuggested?: boolean;
|
|
3001
|
+
};
|
|
3002
|
+
/** Update the styling of all paragraphs that overlap with the given range. */
|
|
3003
|
+
export type DocsUpdateParagraphStyleRequest = {
|
|
3004
|
+
/** The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */
|
|
3005
|
+
fields?: string;
|
|
3006
|
+
/** The styles to set on the paragraphs. Certain paragraph style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of ParagraphStyle for more information. */
|
|
3007
|
+
paragraphStyle?: DocsParagraphStyle;
|
|
3008
|
+
/** The range overlapping the paragraphs to style. */
|
|
3009
|
+
range?: DocsRange;
|
|
3010
|
+
};
|
|
3011
|
+
/** A ParagraphElement that contains an InlineObject. */
|
|
3012
|
+
export type DocsInlineObjectElement = {
|
|
3013
|
+
/** The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. */
|
|
3014
|
+
textStyle?: DocsTextStyle;
|
|
3015
|
+
/** The ID of the InlineObject this element contains. */
|
|
3016
|
+
inlineObjectId?: string;
|
|
3017
|
+
/** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
|
|
3018
|
+
suggestedDeletionIds?: Array<string>;
|
|
3019
|
+
/** The suggested text style changes to this InlineObject, keyed by suggestion ID. */
|
|
3020
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
3021
|
+
/** The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
|
|
3022
|
+
suggestedInsertionIds?: Array<string>;
|
|
3023
|
+
};
|
|
3024
|
+
/** Deletes a Footer from the document. */
|
|
3025
|
+
export type DocsDeleteFooterRequest = {
|
|
3026
|
+
/** The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
3027
|
+
tabId?: string;
|
|
3028
|
+
/** The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. */
|
|
3029
|
+
footerId?: string;
|
|
3030
|
+
};
|
|
3031
|
+
/** Updates the number of pinned table header rows in a table. */
|
|
3032
|
+
export type DocsPinTableHeaderRowsRequest = {
|
|
3033
|
+
/** The location where the table starts in the document. */
|
|
3034
|
+
tableStartLocation?: DocsLocation;
|
|
3035
|
+
/** The number of table rows to pin, where 0 implies that all rows are unpinned. */
|
|
3036
|
+
pinnedHeaderRowsCount?: number;
|
|
3037
|
+
};
|
|
3038
|
+
/** A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
3039
|
+
export type DocsPositionedObjectPositioningSuggestionState = {
|
|
3040
|
+
/** Indicates if there was a suggested change to top_offset. */
|
|
3041
|
+
topOffsetSuggested?: boolean;
|
|
3042
|
+
/** Indicates if there was a suggested change to left_offset. */
|
|
3043
|
+
leftOffsetSuggested?: boolean;
|
|
3044
|
+
/** Indicates if there was a suggested change to layout. */
|
|
3045
|
+
layoutSuggested?: boolean;
|
|
3046
|
+
};
|
|
3047
|
+
/** The result of inserting an embedded Google Sheets chart. */
|
|
3048
|
+
export type DocsInsertInlineSheetsChartResponse = {
|
|
3049
|
+
/** The object ID of the inserted chart. */
|
|
3050
|
+
objectId?: string;
|
|
3051
|
+
};
|
|
3052
|
+
/** Inserts a person mention. */
|
|
3053
|
+
export type DocsInsertPersonRequest = {
|
|
3054
|
+
/** Inserts the person mention at the end of a header, footer, footnote or the document body. */
|
|
3055
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
3056
|
+
/** Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Person mentions cannot be inserted inside an equation. */
|
|
3057
|
+
location?: DocsLocation;
|
|
3058
|
+
/** The properties of the person mention to insert. */
|
|
3059
|
+
personProperties?: DocsPersonProperties;
|
|
3060
|
+
};
|
|
3061
|
+
/** Inserts a RichLink at the specified location. */
|
|
3062
|
+
export type DocsInsertRichLinkRequest = {
|
|
3063
|
+
/** The properties of the rich link to insert. */
|
|
3064
|
+
richLinkProperties?: DocsRichLinkProperties;
|
|
3065
|
+
/** Inserts the rich link at a specific index in the document. The rich link must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The rich link cannot be inserted inside an equation. */
|
|
3066
|
+
location?: DocsLocation;
|
|
3067
|
+
/** Inserts the rich link at the end of a header, footer, footnote or the document body. */
|
|
3068
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
3069
|
+
};
|
|
3070
|
+
/** A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
3071
|
+
export type DocsBulletSuggestionState = {
|
|
3072
|
+
/** Indicates if there was a suggested change to the nesting_level. */
|
|
3073
|
+
nestingLevelSuggested?: boolean;
|
|
3074
|
+
/** Indicates if there was a suggested change to the list_id. */
|
|
3075
|
+
listIdSuggested?: boolean;
|
|
3076
|
+
/** A mask that indicates which of the fields in text style have been changed in this suggestion. */
|
|
3077
|
+
textStyleSuggestionState?: DocsTextStyleSuggestionState;
|
|
3078
|
+
};
|
|
3079
|
+
/** Updates the SectionStyle. */
|
|
3080
|
+
export type DocsUpdateSectionStyleRequest = {
|
|
3081
|
+
/** The fields that should be updated. At least one field must be specified. The root `section_style` is implied and must not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the left margin, set `fields` to `"margin_left"`. */
|
|
3082
|
+
fields?: string;
|
|
3083
|
+
/** The range overlapping the sections to style. Because section breaks can only be inserted inside the body, the segment ID field must be empty. */
|
|
3084
|
+
range?: DocsRange;
|
|
3085
|
+
/** The styles to be set on the section. Certain section style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of SectionStyle for more information. */
|
|
3086
|
+
sectionStyle?: DocsSectionStyle;
|
|
3087
|
+
};
|
|
3088
|
+
/** Inserts a Dropdown at the specified location. */
|
|
3089
|
+
export type DocsInsertDropdownRequest = {
|
|
3090
|
+
/** The EndOfSegmentLocation in the document to insert the dropdown at. */
|
|
3091
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
3092
|
+
/** Required. The DropdownDefinition ID. */
|
|
3093
|
+
dropdownDefinitionId?: string;
|
|
3094
|
+
/** Optional initial value for the dropdown. If this field is not specified, the new dropdown will default to selecting the first option defined in the dropdown definition. If this field is specified but does not reference a valid option in the dropdown definition, a 400 bad request error is returned. */
|
|
3095
|
+
selectedOptionId?: string;
|
|
3096
|
+
/** The Location in the document to insert the dropdown at. */
|
|
3097
|
+
location?: DocsLocation;
|
|
3098
|
+
};
|
|
3099
|
+
/** A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. */
|
|
3100
|
+
export type DocsPerson = {
|
|
3101
|
+
/** IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. */
|
|
3102
|
+
suggestedDeletionIds?: Array<string>;
|
|
3103
|
+
/** Output only. The unique ID of this link. */
|
|
3104
|
+
personId?: string;
|
|
3105
|
+
/** The suggested text style changes to this Person, keyed by suggestion ID. */
|
|
3106
|
+
suggestedTextStyleChanges?: Record<string, DocsSuggestedTextStyle>;
|
|
3107
|
+
/** IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. */
|
|
3108
|
+
suggestedInsertionIds?: Array<string>;
|
|
3109
|
+
/** The text style of this Person. */
|
|
3110
|
+
textStyle?: DocsTextStyle;
|
|
3111
|
+
/** Output only. The properties of this Person. This field is always present. */
|
|
3112
|
+
personProperties?: DocsPersonProperties;
|
|
3113
|
+
};
|
|
3114
|
+
/** The result of inserting an inline image. */
|
|
3115
|
+
export type DocsInsertInlineImageResponse = {
|
|
3116
|
+
/** The ID of the created InlineObject. */
|
|
3117
|
+
objectId?: string;
|
|
3118
|
+
};
|
|
3119
|
+
/** A single update to apply to a document. */
|
|
3120
|
+
export type DocsRequest = {
|
|
3121
|
+
/** Inserts a section break at the specified location. */
|
|
3122
|
+
insertSectionBreak?: DocsInsertSectionBreakRequest;
|
|
3123
|
+
/** Inserts an empty column into a table. */
|
|
3124
|
+
insertTableColumn?: DocsInsertTableColumnRequest;
|
|
3125
|
+
/** Updates the properties of a DropdownDefinition. */
|
|
3126
|
+
updateDropdownDefinitionProperties?: DocsUpdateDropdownDefinitionPropertiesRequest;
|
|
3127
|
+
/** Adds a document tab. */
|
|
3128
|
+
addDocumentTab?: DocsAddDocumentTabRequest;
|
|
3129
|
+
/** Deletes a document tab. */
|
|
3130
|
+
deleteTab?: DocsDeleteTabRequest;
|
|
3131
|
+
/** Creates a header. */
|
|
3132
|
+
createHeader?: DocsCreateHeaderRequest;
|
|
3133
|
+
/** Inserts a page break at the specified location. */
|
|
3134
|
+
insertPageBreak?: DocsInsertPageBreakRequest;
|
|
3135
|
+
/** Deletes a DropdownDefinition. */
|
|
3136
|
+
deleteDropdownDefinition?: DocsDeleteDropdownDefinitionRequest;
|
|
3137
|
+
/** Deletes a positioned object from the document. */
|
|
3138
|
+
deletePositionedObject?: DocsDeletePositionedObjectRequest;
|
|
3139
|
+
/** Creates a named range. */
|
|
3140
|
+
createNamedRange?: DocsCreateNamedRangeRequest;
|
|
3141
|
+
/** Unmerges cells in a table. */
|
|
3142
|
+
unmergeTableCells?: DocsUnmergeTableCellsRequest;
|
|
3143
|
+
/** Deletes a reply Post from a CommentThread or SuggestionThread. */
|
|
3144
|
+
deleteCommentReply?: DocsDeleteCommentReplyRequest;
|
|
3145
|
+
/** Inserts a Dropdown at the specified location. */
|
|
3146
|
+
insertDropdown?: DocsInsertDropdownRequest;
|
|
3147
|
+
/** Replaces an image in the document. */
|
|
3148
|
+
replaceImage?: DocsReplaceImageRequest;
|
|
3149
|
+
/** Inserts text at the specified location. */
|
|
3150
|
+
insertText?: DocsInsertTextRequest;
|
|
3151
|
+
/** Rejects a suggestion. */
|
|
3152
|
+
rejectSuggestion?: DocsRejectSuggestionRequest;
|
|
3153
|
+
/** Replaces all instances of the specified text. */
|
|
3154
|
+
replaceAllText?: DocsReplaceAllTextRequest;
|
|
3155
|
+
/** Updates the properties of a Dropdown. */
|
|
3156
|
+
updateDropdownProperties?: DocsUpdateDropdownPropertiesRequest;
|
|
3157
|
+
/** Deletes a footer from the document. */
|
|
3158
|
+
deleteFooter?: DocsDeleteFooterRequest;
|
|
3159
|
+
/** Inserts a CommentThread into the document. */
|
|
3160
|
+
insertComment?: DocsInsertCommentRequest;
|
|
3161
|
+
/** Updates the section style of the specified range. */
|
|
3162
|
+
updateSectionStyle?: DocsUpdateSectionStyleRequest;
|
|
3163
|
+
/** Deletes content from the document. */
|
|
3164
|
+
deleteContentRange?: DocsDeleteContentRangeRequest;
|
|
3165
|
+
/** Updates the style of table cells. */
|
|
3166
|
+
updateTableCellStyle?: DocsUpdateTableCellStyleRequest;
|
|
3167
|
+
/** Deletes a CommentThread. */
|
|
3168
|
+
deleteComment?: DocsDeleteCommentRequest;
|
|
3169
|
+
/** Updates the style of the document. */
|
|
3170
|
+
updateDocumentStyle?: DocsUpdateDocumentStyleRequest;
|
|
3171
|
+
/** Creates a DropdownDefinition. */
|
|
3172
|
+
createDropdownDefinition?: DocsCreateDropdownDefinitionRequest;
|
|
3173
|
+
/** Merges cells in a table. */
|
|
3174
|
+
mergeTableCells?: DocsMergeTableCellsRequest;
|
|
3175
|
+
/** Deletes a header from the document. */
|
|
3176
|
+
deleteHeader?: DocsDeleteHeaderRequest;
|
|
3177
|
+
/** Updates a named style. */
|
|
3178
|
+
updateNamedStyle?: DocsUpdateNamedStyleRequest;
|
|
3179
|
+
/** Updates the row style in a table. */
|
|
3180
|
+
updateTableRowStyle?: DocsUpdateTableRowStyleRequest;
|
|
3181
|
+
/** Inserts an inline image at the specified location. */
|
|
3182
|
+
insertInlineImage?: DocsInsertInlineImageRequest;
|
|
3183
|
+
/** Updates the text style at the specified range. */
|
|
3184
|
+
updateTextStyle?: DocsUpdateTextStyleRequest;
|
|
3185
|
+
/** Updates the number of pinned header rows in a table. */
|
|
3186
|
+
pinTableHeaderRows?: DocsPinTableHeaderRowsRequest;
|
|
3187
|
+
/** Accepts a suggestion. */
|
|
3188
|
+
acceptSuggestion?: DocsAcceptSuggestionRequest;
|
|
3189
|
+
/** Updates an existing post (head post or reply) of a CommentThread or SuggestionThread. */
|
|
3190
|
+
updateCommentPost?: DocsUpdateCommentPostRequest;
|
|
3191
|
+
/** Replaces the content in a named range. */
|
|
3192
|
+
replaceNamedRangeContent?: DocsReplaceNamedRangeContentRequest;
|
|
3193
|
+
/** Inserts a table at the specified location. */
|
|
3194
|
+
insertTable?: DocsInsertTableRequest;
|
|
3195
|
+
/** Adds a reply to a CommentThread or SuggestionThread. */
|
|
3196
|
+
addCommentReply?: DocsAddCommentReplyRequest;
|
|
3197
|
+
/** Updates the paragraph style at the specified range. */
|
|
3198
|
+
updateParagraphStyle?: DocsUpdateParagraphStyleRequest;
|
|
3199
|
+
/** Deletes a row from a table. */
|
|
3200
|
+
deleteTableRow?: DocsDeleteTableRowRequest;
|
|
3201
|
+
/** Deletes a suggestion. */
|
|
3202
|
+
deleteSuggestion?: DocsDeleteSuggestionRequest;
|
|
3203
|
+
/** Inserts a person mention. */
|
|
3204
|
+
insertPerson?: DocsInsertPersonRequest;
|
|
3205
|
+
/** Insert a rich link. */
|
|
3206
|
+
insertRichLink?: DocsInsertRichLinkRequest;
|
|
3207
|
+
/** Deletes bullets from paragraphs. */
|
|
3208
|
+
deleteParagraphBullets?: DocsDeleteParagraphBulletsRequest;
|
|
3209
|
+
/** Creates a footer. */
|
|
3210
|
+
createFooter?: DocsCreateFooterRequest;
|
|
3211
|
+
/** Inserts a date. */
|
|
3212
|
+
insertDate?: DocsInsertDateRequest;
|
|
3213
|
+
/** Deletes a named range. */
|
|
3214
|
+
deleteNamedRange?: DocsDeleteNamedRangeRequest;
|
|
3215
|
+
/** Creates bullets for paragraphs. */
|
|
3216
|
+
createParagraphBullets?: DocsCreateParagraphBulletsRequest;
|
|
3217
|
+
/** Inserts an empty row into a table. */
|
|
3218
|
+
insertTableRow?: DocsInsertTableRowRequest;
|
|
3219
|
+
/** Deletes a column from a table. */
|
|
3220
|
+
deleteTableColumn?: DocsDeleteTableColumnRequest;
|
|
3221
|
+
/** Updates the properties of columns in a table. */
|
|
3222
|
+
updateTableColumnProperties?: DocsUpdateTableColumnPropertiesRequest;
|
|
3223
|
+
/** Creates a footnote. */
|
|
3224
|
+
createFootnote?: DocsCreateFootnoteRequest;
|
|
3225
|
+
/** Updates the properties of a document tab. */
|
|
3226
|
+
updateDocumentTabProperties?: DocsUpdateDocumentTabPropertiesRequest;
|
|
3227
|
+
};
|
|
3228
|
+
/** Inserts a page break followed by a newline at the specified location. */
|
|
3229
|
+
export type DocsInsertPageBreakRequest = {
|
|
3230
|
+
/** Inserts the page break at the end of the document body. Page breaks cannot be inserted inside a footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. */
|
|
3231
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
3232
|
+
/** Inserts the page break at a specific index in the document. The page break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Page breaks cannot be inserted inside a table, equation, footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. */
|
|
3233
|
+
location?: DocsLocation;
|
|
3234
|
+
};
|
|
3235
|
+
/** A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. */
|
|
3236
|
+
export type DocsDocumentStyleSuggestionState = {
|
|
3237
|
+
/** Indicates if there was a suggested change to default_footer_id. */
|
|
3238
|
+
defaultFooterIdSuggested?: boolean;
|
|
3239
|
+
/** Indicates if there was a suggested change to margin_header. */
|
|
3240
|
+
marginHeaderSuggested?: boolean;
|
|
3241
|
+
/** Indicates if there was a suggested change to use_even_page_header_footer. */
|
|
3242
|
+
useEvenPageHeaderFooterSuggested?: boolean;
|
|
3243
|
+
/** Indicates if there was a suggested change to even_page_header_id. */
|
|
3244
|
+
evenPageHeaderIdSuggested?: boolean;
|
|
3245
|
+
/** Indicates if there was a suggested change to default_header_id. */
|
|
3246
|
+
defaultHeaderIdSuggested?: boolean;
|
|
3247
|
+
/** Indicates if there was a suggested change to use_first_page_header_footer. */
|
|
3248
|
+
useFirstPageHeaderFooterSuggested?: boolean;
|
|
3249
|
+
/** Indicates if there was a suggested change to even_page_footer_id. */
|
|
3250
|
+
evenPageFooterIdSuggested?: boolean;
|
|
3251
|
+
/** A mask that indicates which of the fields in size have been changed in this suggestion. */
|
|
3252
|
+
pageSizeSuggestionState?: DocsSizeSuggestionState;
|
|
3253
|
+
/** Indicates if there was a suggested change to page_number_start. */
|
|
3254
|
+
pageNumberStartSuggested?: boolean;
|
|
3255
|
+
/** Indicates if there was a suggested change to margin_top. */
|
|
3256
|
+
marginTopSuggested?: boolean;
|
|
3257
|
+
/** Indicates if there was a suggested change to first_page_footer_id. */
|
|
3258
|
+
firstPageFooterIdSuggested?: boolean;
|
|
3259
|
+
/** Indicates if there was a suggested change to use_custom_header_footer_margins. */
|
|
3260
|
+
useCustomHeaderFooterMarginsSuggested?: boolean;
|
|
3261
|
+
/** A mask that indicates which of the fields in background have been changed in this suggestion. */
|
|
3262
|
+
backgroundSuggestionState?: DocsBackgroundSuggestionState;
|
|
3263
|
+
/** Optional. Indicates if there was a suggested change to flip_page_orientation. */
|
|
3264
|
+
flipPageOrientationSuggested?: boolean;
|
|
3265
|
+
/** Indicates if there was a suggested change to margin_left. */
|
|
3266
|
+
marginLeftSuggested?: boolean;
|
|
3267
|
+
/** Indicates if there was a suggested change to margin_right. */
|
|
3268
|
+
marginRightSuggested?: boolean;
|
|
3269
|
+
/** Indicates if there was a suggested change to first_page_header_id. */
|
|
3270
|
+
firstPageHeaderIdSuggested?: boolean;
|
|
3271
|
+
/** Indicates if there was a suggested change to margin_bottom. */
|
|
3272
|
+
marginBottomSuggested?: boolean;
|
|
3273
|
+
/** Indicates if there was a suggested change to margin_footer. */
|
|
3274
|
+
marginFooterSuggested?: boolean;
|
|
3275
|
+
};
|
|
3276
|
+
/** A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. */
|
|
3277
|
+
export type DocsShadingSuggestionState = {
|
|
3278
|
+
/** Indicates if there was a suggested change to the Shading. */
|
|
3279
|
+
backgroundColorSuggested?: boolean;
|
|
3280
|
+
};
|
|
3281
|
+
/** A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectangle. For example, let's say we have a 3 x 3 table where all the cells of the last row are merged together. The table looks like this: [ ] A table range with table cell location = (table_start_location, row = 0, column = 0), row span = 3 and column span = 2 specifies the following cells: x x [ x x x ] */
|
|
3282
|
+
export type DocsTableRange = {
|
|
3283
|
+
/** The column span of the table range. */
|
|
3284
|
+
columnSpan?: number;
|
|
3285
|
+
/** The cell location where the table range starts. */
|
|
3286
|
+
tableCellLocation?: DocsTableCellLocation;
|
|
3287
|
+
/** The row span of the table range. */
|
|
3288
|
+
rowSpan?: number;
|
|
3289
|
+
};
|
|
3290
|
+
/** Creates a new DropdownDefinition in the document. */
|
|
3291
|
+
export type DocsCreateDropdownDefinitionRequest = {
|
|
3292
|
+
/** Required. The DropdownDefinition to create. */
|
|
3293
|
+
dropdownDefinition?: DocsDropdownDefinition;
|
|
3294
|
+
/** The ID of the tab to create the dropdown definition in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
3295
|
+
tabId?: string;
|
|
3296
|
+
};
|
|
3297
|
+
/** A ParagraphElement describes content within a Paragraph. */
|
|
3298
|
+
export type DocsParagraphElement = {
|
|
3299
|
+
/** The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. */
|
|
3300
|
+
endIndex?: number;
|
|
3301
|
+
/** A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) */
|
|
3302
|
+
richLink?: DocsRichLink;
|
|
3303
|
+
/** An inline object paragraph element. */
|
|
3304
|
+
inlineObjectElement?: DocsInlineObjectElement;
|
|
3305
|
+
/** A page break paragraph element. */
|
|
3306
|
+
pageBreak?: DocsPageBreak;
|
|
3307
|
+
/** An equation paragraph element. */
|
|
3308
|
+
equation?: DocsEquation;
|
|
3309
|
+
/** A horizontal rule paragraph element. */
|
|
3310
|
+
horizontalRule?: DocsHorizontalRule;
|
|
3311
|
+
/** A paragraph element that represents a date. */
|
|
3312
|
+
dateElement?: DocsDateElement;
|
|
3313
|
+
/** An auto text paragraph element. */
|
|
3314
|
+
autoText?: DocsAutoText;
|
|
3315
|
+
/** A footnote reference paragraph element. */
|
|
3316
|
+
footnoteReference?: DocsFootnoteReference;
|
|
3317
|
+
/** A paragraph element that represents a dropdown menu. */
|
|
3318
|
+
dropdown?: DocsDropdown;
|
|
3319
|
+
/** A paragraph element that links to a person or email address. */
|
|
3320
|
+
person?: DocsPerson;
|
|
3321
|
+
/** A text run paragraph element. */
|
|
3322
|
+
textRun?: DocsTextRun;
|
|
3323
|
+
/** A column break paragraph element. */
|
|
3324
|
+
columnBreak?: DocsColumnBreak;
|
|
3325
|
+
/** The zero-based start index of this paragraph element, in UTF-16 code units. */
|
|
3326
|
+
startIndex?: number;
|
|
3327
|
+
};
|
|
3328
|
+
/** A suggested change to a Bullet. */
|
|
3329
|
+
export type DocsSuggestedBullet = {
|
|
3330
|
+
/** A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. */
|
|
3331
|
+
bullet?: DocsBullet;
|
|
3332
|
+
/** A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. */
|
|
3333
|
+
bulletSuggestionState?: DocsBulletSuggestionState;
|
|
3334
|
+
};
|
|
3335
|
+
/** Represents a single post in a comment or suggestion thread. */
|
|
3336
|
+
export type DocsPost = {
|
|
3337
|
+
/** Output only. Whether the post is from a copied document. This field cannot be set directly by callers. */
|
|
3338
|
+
fromCopiedDocument?: boolean;
|
|
3339
|
+
/** Optional. The action type for comment posts. */
|
|
3340
|
+
commentAction?: "COMMENT_ACTION_TYPE_UNSPECIFIED" | "NO_COMMENT_ACTION_CHANGE" | "RESOLVE" | "REOPEN";
|
|
3341
|
+
/** The content of the post. Required to be non-empty if commentAction is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units. */
|
|
3342
|
+
content?: string;
|
|
3343
|
+
/** Output only. Whether the post is deleted. If `true`, content and author fields will be empty. */
|
|
3344
|
+
deleted?: boolean;
|
|
3345
|
+
/** Output only. Whether the post is from a document comparison. This field cannot be set directly by callers. */
|
|
3346
|
+
fromDocumentComparison?: boolean;
|
|
3347
|
+
/** Output only. The unique ID of the post. */
|
|
3348
|
+
postId?: string;
|
|
3349
|
+
/** Output only. The content of the post as HTML. */
|
|
3350
|
+
contentHtml?: string;
|
|
3351
|
+
/** Output only. The action type for suggestion posts. */
|
|
3352
|
+
suggestionAction?: "SUGGESTION_ACTION_TYPE_UNSPECIFIED" | "NO_SUGGESTION_ACTION_CHANGE" | "ACCEPT" | "REJECT";
|
|
3353
|
+
/** Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - The parent thread is a SuggestionThread. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assigneeEmail` exceeds 2048 UTF-8 code units. */
|
|
3354
|
+
assigneeEmail?: string;
|
|
3355
|
+
/** Output only. Whether the post is from an imported document. This field cannot be set directly by callers. */
|
|
3356
|
+
fromImportedDocument?: boolean;
|
|
3357
|
+
/** Output only. The user who created the post. */
|
|
3358
|
+
author?: DocsPostAuthor;
|
|
3359
|
+
/** Output only. The time the post was last updated. */
|
|
3360
|
+
updateTime?: string;
|
|
3361
|
+
/** Output only. The time the post was created. */
|
|
3362
|
+
createTime?: string;
|
|
3363
|
+
};
|
|
3364
|
+
/** Updates the TableRowStyle of rows in a table. */
|
|
3365
|
+
export type DocsUpdateTableRowStyleRequest = {
|
|
3366
|
+
/** The styles to be set on the rows. */
|
|
3367
|
+
tableRowStyle?: DocsTableRowStyle;
|
|
3368
|
+
/** The fields that should be updated. At least one field must be specified. The root `tableRowStyle` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the minimum row height, set `fields` to `"min_row_height"`. */
|
|
3369
|
+
fields?: string;
|
|
3370
|
+
/** The list of zero-based row indices whose style should be updated. If no indices are specified, all rows will be updated. */
|
|
3371
|
+
rowIndices?: Array<number>;
|
|
3372
|
+
/** The location where the table starts in the document. */
|
|
3373
|
+
tableStartLocation?: DocsLocation;
|
|
3374
|
+
};
|
|
3375
|
+
/** Inserts a section break at the given location. A newline character will be inserted before the section break. */
|
|
3376
|
+
export type DocsInsertSectionBreakRequest = {
|
|
3377
|
+
/** The type of section to insert. */
|
|
3378
|
+
sectionType?: "SECTION_TYPE_UNSPECIFIED" | "CONTINUOUS" | "NEXT_PAGE";
|
|
3379
|
+
/** Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty. */
|
|
3380
|
+
endOfSegmentLocation?: DocsEndOfSegmentLocation;
|
|
3381
|
+
/** Inserts a newline and a section break at a specific index in the document. The section break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the segment ID field must be empty. */
|
|
3382
|
+
location?: DocsLocation;
|
|
3383
|
+
};
|
|
3384
|
+
/** Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned. */
|
|
3385
|
+
export type DocsReplaceNamedRangeContentRequest = {
|
|
3386
|
+
/** Replaces the content of the specified named range(s) with the given text. */
|
|
3387
|
+
text?: string;
|
|
3388
|
+
/** The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op. */
|
|
3389
|
+
namedRangeName?: string;
|
|
3390
|
+
/** The ID of the named range whose content will be replaced. If there is no named range with the given ID a 400 bad request error is returned. */
|
|
3391
|
+
namedRangeId?: string;
|
|
3392
|
+
/** Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. */
|
|
3393
|
+
tabsCriteria?: DocsTabsCriteria;
|
|
3394
|
+
};
|
|
3395
|
+
/** A particular location in the document. */
|
|
3396
|
+
export type DocsLocation = {
|
|
3397
|
+
/** The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */
|
|
3398
|
+
segmentId?: string;
|
|
3399
|
+
/** The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
3400
|
+
tabId?: string;
|
|
3401
|
+
/** The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. */
|
|
3402
|
+
index?: number;
|
|
3403
|
+
};
|
|
3404
|
+
/** A width and height. */
|
|
3405
|
+
export type DocsSize = {
|
|
3406
|
+
/** The height of the object. */
|
|
3407
|
+
height?: DocsDimension;
|
|
3408
|
+
/** The width of the object. */
|
|
3409
|
+
width?: DocsDimension;
|
|
3410
|
+
};
|
|
3411
|
+
/** Updates the TableColumnProperties of columns in a table. */
|
|
3412
|
+
export type DocsUpdateTableColumnPropertiesRequest = {
|
|
3413
|
+
/** The fields that should be updated. At least one field must be specified. The root `tableColumnProperties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the column width, set `fields` to `"width"`. */
|
|
3414
|
+
fields?: string;
|
|
3415
|
+
/** The table column properties to update. If the value of `table_column_properties#width` is less than 5 points (5/72 inch), a 400 bad request error is returned. */
|
|
3416
|
+
tableColumnProperties?: DocsTableColumnProperties;
|
|
3417
|
+
/** The location where the table starts in the document. */
|
|
3418
|
+
tableStartLocation?: DocsLocation;
|
|
3419
|
+
/** The list of zero-based column indices whose property should be updated. If no indices are specified, all columns will be updated. */
|
|
3420
|
+
columnIndices?: Array<number>;
|
|
3421
|
+
};
|
|
3422
|
+
/** The result of adding a document tab. */
|
|
3423
|
+
export type DocsAddDocumentTabResponse = {
|
|
3424
|
+
/** The properties of the newly added tab. */
|
|
3425
|
+
tabProperties?: DocsTabProperties;
|
|
3426
|
+
};
|
|
3427
|
+
/** A magnitude in a single direction in the specified units. */
|
|
3428
|
+
export type DocsDimension = {
|
|
3429
|
+
/** The units for magnitude. */
|
|
3430
|
+
unit?: "UNIT_UNSPECIFIED" | "PT";
|
|
3431
|
+
/** The magnitude. */
|
|
3432
|
+
magnitude?: number;
|
|
3433
|
+
};
|
|
3434
|
+
/** Represents a single suggestion thread. Suggestion threads are created as a byproduct of saving changes to the document while in suggestion mode, and cannot be created directly. */
|
|
3435
|
+
export type DocsSuggestionThread = {
|
|
3436
|
+
/** Whether the thread is open, accepted, or rejected. */
|
|
3437
|
+
status?: "STATUS_UNSPECIFIED" | "OPEN" | "ACCEPTED" | "REJECTED";
|
|
3438
|
+
/** The unique ID of the suggestion. */
|
|
3439
|
+
suggestionId?: string;
|
|
3440
|
+
/** The first post in the thread. */
|
|
3441
|
+
headPost?: DocsPost;
|
|
3442
|
+
/** Summary of the suggested differences in the document, in HTML. May be empty. */
|
|
3443
|
+
summaryHtml?: string;
|
|
3444
|
+
/** Replies to the head post. */
|
|
3445
|
+
replies?: Array<DocsPost>;
|
|
3446
|
+
/** Summary of the suggested differences in the document, in plain text. May be empty. */
|
|
3447
|
+
summaryText?: string;
|
|
3448
|
+
};
|
|
3449
|
+
/** A reference to a bookmark in this document. */
|
|
3450
|
+
export type DocsBookmarkLink = {
|
|
3451
|
+
/** The ID of the tab containing this bookmark. */
|
|
3452
|
+
tabId?: string;
|
|
3453
|
+
/** The ID of a bookmark in this document. */
|
|
3454
|
+
id?: string;
|
|
3455
|
+
};
|
|
3456
|
+
/** Label changes that were made on the Target. */
|
|
3457
|
+
export type DriveactivityAppliedLabelChange = {
|
|
3458
|
+
/** Changes that were made to the Label on the Target. */
|
|
3459
|
+
changes?: Array<DriveactivityAppliedLabelChangeDetail>;
|
|
3460
|
+
};
|
|
3461
|
+
/** A strategy that consolidates activities using the grouping rules from the legacy V1 Activity API. Similar actions occurring within a window of time can be grouped across multiple targets (such as moving a set of files at once) or multiple actors (such as several users editing the same item). Grouping rules for this strategy are specific to each type of action. */
|
|
3462
|
+
export type DriveactivityLegacy = Record<string, unknown>;
|
|
3463
|
+
/** A change in the object's data leak prevention status. */
|
|
3464
|
+
export type DriveactivityDataLeakPreventionChange = {
|
|
3465
|
+
/** The type of Data Leak Prevention (DLP) change. */
|
|
3466
|
+
type?: "TYPE_UNSPECIFIED" | "FLAGGED" | "CLEARED";
|
|
3467
|
+
};
|
|
3468
|
+
/** Wrapper for User Field value. */
|
|
3469
|
+
export type DriveactivitySingleUser = {
|
|
3470
|
+
/** User value as email. */
|
|
3471
|
+
value?: string;
|
|
3472
|
+
};
|
|
3473
|
+
/** A lightweight reference to the target of activity. */
|
|
3474
|
+
export type DriveactivityTargetReference = {
|
|
3475
|
+
/** The target is a Drive item. */
|
|
3476
|
+
driveItem?: DriveactivityDriveItemReference;
|
|
3477
|
+
/** This field is deprecated; please use the `drive` field instead. */
|
|
3478
|
+
teamDrive?: DriveactivityTeamDriveReference;
|
|
3479
|
+
/** The target is a shared drive. */
|
|
3480
|
+
drive?: DriveactivityDriveReference;
|
|
3481
|
+
};
|
|
3482
|
+
/** A regular posted comment. */
|
|
3483
|
+
export type DriveactivityPost = {
|
|
3484
|
+
/** The sub-type of this event. */
|
|
3485
|
+
subtype?: "SUBTYPE_UNSPECIFIED" | "ADDED" | "DELETED" | "REPLY_ADDED" | "REPLY_DELETED" | "RESOLVED" | "REOPENED";
|
|
3486
|
+
};
|
|
3487
|
+
/** Information about an impersonation, where an admin acts on behalf of an end user. Information about the acting admin is not currently available. */
|
|
3488
|
+
export type DriveactivityImpersonation = {
|
|
3489
|
+
/** The impersonated user. */
|
|
3490
|
+
impersonatedUser?: DriveactivityUser;
|
|
3491
|
+
};
|
|
3492
|
+
/** Change to a Field value. */
|
|
3493
|
+
export type DriveactivityFieldValueChange = {
|
|
3494
|
+
/** The ID of this field. Field IDs are unique within a Label. */
|
|
3495
|
+
fieldId?: string;
|
|
3496
|
+
/** The value that was previously set on the field. If not present, the field was newly set. At least one of {old_value|new_value} is always set. */
|
|
3497
|
+
oldValue?: DriveactivityFieldValue;
|
|
3498
|
+
/** The value that is now set on the field. If not present, the field was cleared. At least one of {old_value|new_value} is always set. */
|
|
3499
|
+
newValue?: DriveactivityFieldValue;
|
|
3500
|
+
/** The human-readable display name for this field. */
|
|
3501
|
+
displayName?: string;
|
|
3502
|
+
};
|
|
3503
|
+
/** Empty message representing an administrator. */
|
|
3504
|
+
export type DriveactivityAdministrator = Record<string, unknown>;
|
|
3505
|
+
/** A lightweight reference to a shared drive. */
|
|
3506
|
+
export type DriveactivityDriveReference = {
|
|
3507
|
+
/** The resource name of the shared drive. The format is `COLLECTION_ID/DRIVE_ID`. Clients should not assume a specific collection ID for this resource name. */
|
|
3508
|
+
name?: string;
|
|
3509
|
+
/** The title of the shared drive. */
|
|
3510
|
+
title?: string;
|
|
3511
|
+
};
|
|
3512
|
+
/** Information about time ranges. */
|
|
3513
|
+
export type DriveactivityTimeRange = {
|
|
3514
|
+
/** The start of the time range. */
|
|
3515
|
+
startTime?: string;
|
|
3516
|
+
/** The end of the time range. */
|
|
3517
|
+
endTime?: string;
|
|
3518
|
+
};
|
|
3519
|
+
/** A single Drive activity comprising one or more Actions by one or more Actors on one or more Targets. Some Action groupings occur spontaneously, such as moving an item into a shared folder triggering a permission change. Other groupings of related Actions, such as multiple Actors editing one item or moving multiple files into a new folder, are controlled by the selection of a ConsolidationStrategy in the QueryDriveActivityRequest. */
|
|
3520
|
+
export type DriveactivityDriveActivity = {
|
|
3521
|
+
/** All actor(s) responsible for the activity. */
|
|
3522
|
+
actors?: Array<DriveactivityActor>;
|
|
3523
|
+
/** The activity occurred over this time range. */
|
|
3524
|
+
timeRange?: DriveactivityTimeRange;
|
|
3525
|
+
/** All Google Drive objects this activity is about (e.g. file, folder, drive). This represents the state of the target immediately after the actions occurred. */
|
|
3526
|
+
targets?: Array<DriveactivityTarget>;
|
|
3527
|
+
/** Key information about the primary action for this activity. This is either representative, or the most important, of all actions in the activity, according to the ConsolidationStrategy in the request. */
|
|
3528
|
+
primaryActionDetail?: DriveactivityActionDetail;
|
|
3529
|
+
/** Details on all actions in this activity. */
|
|
3530
|
+
actions?: Array<DriveactivityAction>;
|
|
3531
|
+
/** The activity occurred at this specific time. */
|
|
3532
|
+
timestamp?: string;
|
|
3533
|
+
};
|
|
3534
|
+
/** Wrapper for SelectionList Field value. */
|
|
3535
|
+
export type DriveactivitySelectionList = {
|
|
3536
|
+
/** Selection values. */
|
|
3537
|
+
values?: Array<DriveactivitySelection>;
|
|
3538
|
+
};
|
|
3539
|
+
/** This item is deprecated; please see `DriveFile` instead. */
|
|
3540
|
+
export type DriveactivityFile = Record<string, unknown>;
|
|
3541
|
+
/** An object was deleted. */
|
|
3542
|
+
export type DriveactivityDelete = {
|
|
3543
|
+
/** The type of delete action taken. */
|
|
3544
|
+
type?: "TYPE_UNSPECIFIED" | "TRASH" | "PERMANENT_DELETE";
|
|
3545
|
+
};
|
|
3546
|
+
/** Information about restriction policy changes to a feature. */
|
|
3547
|
+
export type DriveactivityRestrictionChange = {
|
|
3548
|
+
/** The feature which had a change in restriction policy. */
|
|
3549
|
+
feature?: "FEATURE_UNSPECIFIED" | "SHARING_OUTSIDE_DOMAIN" | "DIRECT_SHARING" | "ITEM_DUPLICATION" | "DRIVE_FILE_STREAM" | "FILE_ORGANIZER_CAN_SHARE_FOLDERS" | "READERS_CAN_DOWNLOAD" | "WRITERS_CAN_DOWNLOAD";
|
|
3550
|
+
/** The restriction in place after the change. */
|
|
3551
|
+
newRestriction?: "RESTRICTION_UNSPECIFIED" | "UNRESTRICTED" | "FULLY_RESTRICTED";
|
|
3552
|
+
};
|
|
3553
|
+
/** An object was created from scratch. */
|
|
3554
|
+
export type DriveactivityNew = Record<string, unknown>;
|
|
3555
|
+
/** Wrapper for Integer Field value. */
|
|
3556
|
+
export type DriveactivityInteger = {
|
|
3557
|
+
/** Integer value. */
|
|
3558
|
+
value?: string;
|
|
3559
|
+
};
|
|
3560
|
+
/** A suggestion. */
|
|
3561
|
+
export type DriveactivitySuggestion = {
|
|
3562
|
+
/** The sub-type of this event. */
|
|
3563
|
+
subtype?: "SUBTYPE_UNSPECIFIED" | "ADDED" | "DELETED" | "REPLY_ADDED" | "REPLY_DELETED" | "ACCEPTED" | "REJECTED" | "ACCEPT_DELETED" | "REJECT_DELETED";
|
|
3564
|
+
};
|
|
3565
|
+
/** Information about a group. */
|
|
3566
|
+
export type DriveactivityGroup = {
|
|
3567
|
+
/** The email address of the group. */
|
|
3568
|
+
email?: string;
|
|
3569
|
+
/** The title of the group. */
|
|
3570
|
+
title?: string;
|
|
3571
|
+
};
|
|
3572
|
+
/** Response message for querying Drive activity. */
|
|
3573
|
+
export type DriveactivityQueryDriveActivityResponse = {
|
|
3574
|
+
/** List of activity requested. */
|
|
3575
|
+
activities?: Array<DriveactivityDriveActivity>;
|
|
3576
|
+
/** Token to retrieve the next page of results, or empty if there are no more results in the list. */
|
|
3577
|
+
nextPageToken?: string;
|
|
3578
|
+
};
|
|
3579
|
+
/** Data describing the type and additional information of an action. */
|
|
3580
|
+
export type DriveactivityActionDetail = {
|
|
3581
|
+
/** A deleted object was restored. */
|
|
3582
|
+
restore?: DriveactivityRestore;
|
|
3583
|
+
/** The permission on an object was changed. */
|
|
3584
|
+
permissionChange?: DriveactivityPermissionChange;
|
|
3585
|
+
/** A change happened in data leak prevention status. */
|
|
3586
|
+
dlpChange?: DriveactivityDataLeakPreventionChange;
|
|
3587
|
+
/** An object was edited. */
|
|
3588
|
+
edit?: DriveactivityEdit;
|
|
3589
|
+
/** Settings were changed. */
|
|
3590
|
+
settingsChange?: DriveactivitySettingsChange;
|
|
3591
|
+
/** An object was referenced in an application outside of Drive/Docs. */
|
|
3592
|
+
reference?: DriveactivityApplicationReference;
|
|
3593
|
+
/** An object was created. */
|
|
3594
|
+
create?: DriveactivityCreate;
|
|
3595
|
+
/** An object was renamed. */
|
|
3596
|
+
rename?: DriveactivityRename;
|
|
3597
|
+
/** An object was moved. */
|
|
3598
|
+
move?: DriveactivityMove;
|
|
3599
|
+
/** Label was changed. */
|
|
3600
|
+
appliedLabelChange?: DriveactivityAppliedLabelChange;
|
|
3601
|
+
/** A change about comments was made. */
|
|
3602
|
+
comment?: DriveactivityComment;
|
|
3603
|
+
/** An object was deleted. */
|
|
3604
|
+
delete?: DriveactivityDelete;
|
|
3605
|
+
};
|
|
3606
|
+
/** Information about the action. */
|
|
3607
|
+
export type DriveactivityAction = {
|
|
3608
|
+
/** The type and detailed information about the action. */
|
|
3609
|
+
detail?: DriveactivityActionDetail;
|
|
3610
|
+
/** The action occurred at this specific time. */
|
|
3611
|
+
timestamp?: string;
|
|
3612
|
+
/** The target this action affects (or empty if affecting all targets). This represents the state of the target immediately after this action occurred. */
|
|
3613
|
+
target?: DriveactivityTarget;
|
|
3614
|
+
/** The action occurred over this time range. */
|
|
3615
|
+
timeRange?: DriveactivityTimeRange;
|
|
3616
|
+
/** The actor responsible for this action (or empty if all actors are responsible). */
|
|
3617
|
+
actor?: DriveactivityActor;
|
|
3618
|
+
};
|
|
3619
|
+
/** A change about comments on an object. */
|
|
3620
|
+
export type DriveactivityComment = {
|
|
3621
|
+
/** A change on a suggestion. */
|
|
3622
|
+
suggestion?: DriveactivitySuggestion;
|
|
3623
|
+
/** A change on an assignment. */
|
|
3624
|
+
assignment?: DriveactivityAssignment;
|
|
3625
|
+
/** A change on a regular posted comment. */
|
|
3626
|
+
post?: DriveactivityPost;
|
|
3627
|
+
/** Users who are mentioned in this comment. */
|
|
3628
|
+
mentionedUsers?: Array<DriveactivityUser>;
|
|
3629
|
+
};
|
|
3630
|
+
/** A comment on a file. */
|
|
3631
|
+
export type DriveactivityFileComment = {
|
|
3632
|
+
/** The comment in the discussion thread. This identifier is an opaque string compatible with the Drive API; see https://developers.google.com/workspace/drive/v3/reference/comments/get */
|
|
3633
|
+
legacyCommentId?: string;
|
|
3634
|
+
/** The link to the discussion thread containing this comment, for example, `https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID`. */
|
|
3635
|
+
linkToDiscussion?: string;
|
|
3636
|
+
/** The discussion thread to which the comment was added. This identifier is an opaque string compatible with the Drive API and references the first comment in a discussion; see https://developers.google.com/workspace/drive/v3/reference/comments/get */
|
|
3637
|
+
legacyDiscussionId?: string;
|
|
3638
|
+
/** The Drive item containing this comment. */
|
|
3639
|
+
parent?: DriveactivityDriveItem;
|
|
3640
|
+
};
|
|
3641
|
+
/** A comment with an assignment. */
|
|
3642
|
+
export type DriveactivityAssignment = {
|
|
3643
|
+
/** The sub-type of this event. */
|
|
3644
|
+
subtype?: "SUBTYPE_UNSPECIFIED" | "ADDED" | "DELETED" | "REPLY_ADDED" | "REPLY_DELETED" | "RESOLVED" | "REOPENED" | "REASSIGNED";
|
|
3645
|
+
/** The user to whom the comment was assigned. */
|
|
3646
|
+
assignedUser?: DriveactivityUser;
|
|
3647
|
+
};
|
|
3648
|
+
/** A strategy that does no consolidation of individual activities. */
|
|
3649
|
+
export type DriveactivityNoConsolidation = Record<string, unknown>;
|
|
3650
|
+
/** A Drive item which is a file. */
|
|
3651
|
+
export type DriveactivityDriveFile = Record<string, unknown>;
|
|
3652
|
+
/** Wrapper for Text Field value. */
|
|
3653
|
+
export type DriveactivityText = {
|
|
3654
|
+
/** Value of Text Field. */
|
|
3655
|
+
value?: string;
|
|
3656
|
+
};
|
|
3657
|
+
/** An object was moved. */
|
|
3658
|
+
export type DriveactivityMove = {
|
|
3659
|
+
/** The added parent object(s). */
|
|
3660
|
+
addedParents?: Array<DriveactivityTargetReference>;
|
|
3661
|
+
/** The removed parent object(s). */
|
|
3662
|
+
removedParents?: Array<DriveactivityTargetReference>;
|
|
3663
|
+
};
|
|
3664
|
+
/** A user about whom nothing is currently known. */
|
|
3665
|
+
export type DriveactivityUnknownUser = Record<string, unknown>;
|
|
3666
|
+
/** Information about settings changes. */
|
|
3667
|
+
export type DriveactivitySettingsChange = {
|
|
3668
|
+
/** The set of changes made to restrictions. */
|
|
3669
|
+
restrictionChanges?: Array<DriveactivityRestrictionChange>;
|
|
3670
|
+
};
|
|
3671
|
+
/** Activity in applications other than Drive. */
|
|
3672
|
+
export type DriveactivityApplicationReference = {
|
|
3673
|
+
/** The reference type corresponding to this event. */
|
|
3674
|
+
type?: "UNSPECIFIED_REFERENCE_TYPE" | "LINK" | "DISCUSS";
|
|
3675
|
+
};
|
|
3676
|
+
/** An empty message indicating an object was edited. */
|
|
3677
|
+
export type DriveactivityEdit = Record<string, unknown>;
|
|
3678
|
+
/** Represents any user (including a logged out user). */
|
|
3679
|
+
export type DriveactivityAnyone = Record<string, unknown>;
|
|
3680
|
+
/** This item is deprecated; please see `Drive` instead. */
|
|
3681
|
+
export type DriveactivityTeamDrive = {
|
|
3682
|
+
/** This field is deprecated; please see `Drive.title` instead. */
|
|
3683
|
+
title?: string;
|
|
3684
|
+
/** This field is deprecated; please see `Drive.name` instead. */
|
|
3685
|
+
name?: string;
|
|
3686
|
+
/** This field is deprecated; please see `Drive.root` instead. */
|
|
3687
|
+
root?: DriveactivityDriveItem;
|
|
3688
|
+
};
|
|
3689
|
+
/** Event triggered by system operations instead of end users. */
|
|
3690
|
+
export type DriveactivitySystemEvent = {
|
|
3691
|
+
/** The type of the system event that may triggered activity. */
|
|
3692
|
+
type?: "TYPE_UNSPECIFIED" | "USER_DELETION" | "TRASH_AUTO_PURGE";
|
|
3693
|
+
};
|
|
3694
|
+
/** Information about a domain. */
|
|
3695
|
+
export type DriveactivityDomain = {
|
|
3696
|
+
/** An opaque string used to identify this domain. */
|
|
3697
|
+
legacyId?: string;
|
|
3698
|
+
/** The name of the domain, e.g. `google.com`. */
|
|
3699
|
+
name?: string;
|
|
3700
|
+
};
|
|
3701
|
+
/** The actor of a Drive activity. */
|
|
3702
|
+
export type DriveactivityActor = {
|
|
3703
|
+
/** An anonymous user. */
|
|
3704
|
+
anonymous?: DriveactivityAnonymousUser;
|
|
3705
|
+
/** An end user. */
|
|
3706
|
+
user?: DriveactivityUser;
|
|
3707
|
+
/** A non-user actor (i.e. system triggered). */
|
|
3708
|
+
system?: DriveactivitySystemEvent;
|
|
3709
|
+
/** An administrator. */
|
|
3710
|
+
administrator?: DriveactivityAdministrator;
|
|
3711
|
+
/** An account acting on behalf of another. */
|
|
3712
|
+
impersonation?: DriveactivityImpersonation;
|
|
3713
|
+
};
|
|
3714
|
+
/** Wrapper for Selection Field value as combined value/display_name pair for selected choice. */
|
|
3715
|
+
export type DriveactivitySelection = {
|
|
3716
|
+
/** Selection value as Field Choice ID. */
|
|
3717
|
+
value?: string;
|
|
3718
|
+
/** Selection value as human-readable display string. */
|
|
3719
|
+
displayName?: string;
|
|
3720
|
+
};
|
|
3721
|
+
/** The permission setting of an object. */
|
|
3722
|
+
export type DriveactivityPermission = {
|
|
3723
|
+
/** If true, the item can be discovered (e.g. in the user's "Shared with me" collection) without needing a link to the item. */
|
|
3724
|
+
allowDiscovery?: boolean;
|
|
3725
|
+
/** Indicates the [Google Drive permissions role](https://developers.google.com/workspace/drive/web/manage-sharing#roles). The role determines a user's ability to read, write, and comment on items. */
|
|
3726
|
+
role?: "ROLE_UNSPECIFIED" | "OWNER" | "ORGANIZER" | "FILE_ORGANIZER" | "EDITOR" | "COMMENTER" | "VIEWER" | "PUBLISHED_VIEWER";
|
|
3727
|
+
/** The domain to whom this permission applies. */
|
|
3728
|
+
domain?: DriveactivityDomain;
|
|
3729
|
+
/** The user to whom this permission applies. */
|
|
3730
|
+
user?: DriveactivityUser;
|
|
3731
|
+
/** The group to whom this permission applies. */
|
|
3732
|
+
group?: DriveactivityGroup;
|
|
3733
|
+
/** If set, this permission applies to anyone, even logged out users. */
|
|
3734
|
+
anyone?: DriveactivityAnyone;
|
|
3735
|
+
};
|
|
3736
|
+
/** An object was renamed. */
|
|
3737
|
+
export type DriveactivityRename = {
|
|
3738
|
+
/** The previous title of the drive object. */
|
|
3739
|
+
oldTitle?: string;
|
|
3740
|
+
/** The new title of the drive object. */
|
|
3741
|
+
newTitle?: string;
|
|
3742
|
+
};
|
|
3743
|
+
/** A deleted object was restored. */
|
|
3744
|
+
export type DriveactivityRestore = {
|
|
3745
|
+
/** The type of restore action taken. */
|
|
3746
|
+
type?: "TYPE_UNSPECIFIED" | "UNTRASH";
|
|
3747
|
+
};
|
|
3748
|
+
/** A known user. */
|
|
3749
|
+
export type DriveactivityKnownUser = {
|
|
3750
|
+
/** True if this is the user making the request. */
|
|
3751
|
+
isCurrentUser?: boolean;
|
|
3752
|
+
/** The identifier for this user that can be used with the People API to get more information. The format is `people/ACCOUNT_ID`. See https://developers.google.com/people/. */
|
|
3753
|
+
personName?: string;
|
|
3754
|
+
};
|
|
3755
|
+
/** Wrapper for UserList Field value. */
|
|
3756
|
+
export type DriveactivityUserList = {
|
|
3757
|
+
/** User values. */
|
|
3758
|
+
values?: Array<DriveactivitySingleUser>;
|
|
3759
|
+
};
|
|
3760
|
+
/** The request message for querying Drive activity. */
|
|
3761
|
+
export type DriveactivityQueryDriveActivityRequest = {
|
|
3762
|
+
/** The minimum number of activities desired in the response; the server attempts to return at least this quantity. The server may also return fewer activities if it has a partial response ready before the request times out. If not set, a default value is used. */
|
|
3763
|
+
pageSize?: number;
|
|
3764
|
+
/** Return activities for this Drive folder, plus all children and descendants. The format is `items/ITEM_ID`. */
|
|
3765
|
+
ancestorName?: string;
|
|
3766
|
+
/** The filtering for items returned from this query request. The format of the filter string is a sequence of expressions, joined by an optional "AND", where each expression is of the form "field operator value". Supported fields: - `time`: Uses numerical operators on date values either in terms of milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples: - `time > 1452409200000 AND time <= 1492812924310` - `time >= "2016-01-10T01:02:03-05:00"` - `detail.action_detail_case`: Uses the "has" operator (:) and either a singular value or a list of allowed action types enclosed in parentheses, separated by a space. To exclude a result from the response, prepend a hyphen (`-`) to the beginning of the filter string. Examples: - `detail.action_detail_case:RENAME` - `detail.action_detail_case:(CREATE RESTORE)` - `-detail.action_detail_case:MOVE` */
|
|
3767
|
+
filter?: string;
|
|
3768
|
+
/** Details on how to consolidate related actions that make up the activity. If not set, then related actions aren't consolidated. */
|
|
3769
|
+
consolidationStrategy?: DriveactivityConsolidationStrategy;
|
|
3770
|
+
/** Return activities for this Drive item. The format is `items/ITEM_ID`. */
|
|
3771
|
+
itemName?: string;
|
|
3772
|
+
/** The token identifies which page of results to return. Set this to the next_page_token value returned from a previous query to obtain the following page of results. If not set, the first page of results is returned. */
|
|
3773
|
+
pageToken?: string;
|
|
3774
|
+
};
|
|
3775
|
+
/** An object was uploaded into Drive. */
|
|
3776
|
+
export type DriveactivityUpload = Record<string, unknown>;
|
|
3777
|
+
/** An object was created. */
|
|
3778
|
+
export type DriveactivityCreate = {
|
|
3779
|
+
/** If present, indicates the object originated externally and was uploaded to Drive. */
|
|
3780
|
+
upload?: DriveactivityUpload;
|
|
3781
|
+
/** If present, indicates the object was created by copying an existing Drive object. */
|
|
3782
|
+
copy?: DriveactivityCopy;
|
|
3783
|
+
/** If present, indicates the object was newly created (e.g. as a blank document), not derived from a Drive object or external object. */
|
|
3784
|
+
new?: DriveactivityNew;
|
|
3785
|
+
};
|
|
3786
|
+
/** Information about an end user. */
|
|
3787
|
+
export type DriveactivityUser = {
|
|
3788
|
+
/** A known user. */
|
|
3789
|
+
knownUser?: DriveactivityKnownUser;
|
|
3790
|
+
/** A user whose account has since been deleted. */
|
|
3791
|
+
deletedUser?: DriveactivityDeletedUser;
|
|
3792
|
+
/** A user about whom nothing is currently known. */
|
|
3793
|
+
unknownUser?: DriveactivityUnknownUser;
|
|
3794
|
+
};
|
|
3795
|
+
/** Information about a shared drive. */
|
|
3796
|
+
export type DriveactivityDrive = {
|
|
3797
|
+
/** The resource name of the shared drive. The format is `COLLECTION_ID/DRIVE_ID`. Clients should not assume a specific collection ID for this resource name. */
|
|
3798
|
+
name?: string;
|
|
3799
|
+
/** The root of this shared drive. */
|
|
3800
|
+
root?: DriveactivityDriveItem;
|
|
3801
|
+
/** The title of the shared drive. */
|
|
3802
|
+
title?: string;
|
|
3803
|
+
};
|
|
3804
|
+
/** A lightweight reference to a Drive item, such as a file or folder. */
|
|
3805
|
+
export type DriveactivityDriveItemReference = {
|
|
3806
|
+
/** The target Drive item. The format is `items/ITEM_ID`. */
|
|
3807
|
+
name?: string;
|
|
3808
|
+
/** The title of the Drive item. */
|
|
3809
|
+
title?: string;
|
|
3810
|
+
/** The Drive item is a folder. Includes information about the type of folder. */
|
|
3811
|
+
driveFolder?: DriveactivityDriveFolder;
|
|
3812
|
+
/** This field is deprecated; please use the `driveFolder` field instead. */
|
|
3813
|
+
folder?: DriveactivityFolder;
|
|
3814
|
+
/** The Drive item is a file. */
|
|
3815
|
+
driveFile?: DriveactivityDriveFile;
|
|
3816
|
+
/** This field is deprecated; please use the `driveFile` field instead. */
|
|
3817
|
+
file?: DriveactivityFile;
|
|
3818
|
+
};
|
|
3819
|
+
/** A change made to a Label on the Target. */
|
|
3820
|
+
export type DriveactivityAppliedLabelChangeDetail = {
|
|
3821
|
+
/** Field Changes. Only present if `types` contains `LABEL_FIELD_VALUE_CHANGED`. */
|
|
3822
|
+
fieldChanges?: Array<DriveactivityFieldValueChange>;
|
|
3823
|
+
/** The Label name representing the Label that changed. This name always contains the revision of the Label that was used when this Action occurred. The format is `labels/id@revision`. */
|
|
3824
|
+
label?: string;
|
|
3825
|
+
/** The types of changes made to the Label on the Target. */
|
|
3826
|
+
types?: Array<"TYPE_UNSPECIFIED" | "LABEL_ADDED" | "LABEL_REMOVED" | "LABEL_FIELD_VALUE_CHANGED" | "LABEL_APPLIED_BY_ITEM_CREATE">;
|
|
3827
|
+
/** The human-readable title of the label that changed. */
|
|
3828
|
+
title?: string;
|
|
3829
|
+
};
|
|
3830
|
+
/** Empty message representing an anonymous user or indicating the authenticated user should be anonymized. */
|
|
3831
|
+
export type DriveactivityAnonymousUser = Record<string, unknown>;
|
|
3832
|
+
/** Contains a value of a Field. */
|
|
3833
|
+
export type DriveactivityFieldValue = {
|
|
3834
|
+
/** User List Field value. */
|
|
3835
|
+
userList?: DriveactivityUserList;
|
|
3836
|
+
/** Date Field value. */
|
|
3837
|
+
date?: DriveactivityDate;
|
|
3838
|
+
/** Integer Field value. */
|
|
3839
|
+
integer?: DriveactivityInteger;
|
|
3840
|
+
/** Selection List Field value. */
|
|
3841
|
+
selectionList?: DriveactivitySelectionList;
|
|
3842
|
+
/** Text List Field value. */
|
|
3843
|
+
textList?: DriveactivityTextList;
|
|
3844
|
+
/** Text Field value. */
|
|
3845
|
+
text?: DriveactivityText;
|
|
3846
|
+
/** User Field value. */
|
|
3847
|
+
user?: DriveactivitySingleUser;
|
|
3848
|
+
/** Selection Field value. */
|
|
3849
|
+
selection?: DriveactivitySelection;
|
|
3850
|
+
};
|
|
3851
|
+
/** A user whose account has since been deleted. */
|
|
3852
|
+
export type DriveactivityDeletedUser = Record<string, unknown>;
|
|
3853
|
+
/** A Drive item, such as a file or folder. */
|
|
3854
|
+
export type DriveactivityDriveItem = {
|
|
3855
|
+
/** The MIME type of the Drive item. See https://developers.google.com/workspace/drive/v3/web/mime-types. */
|
|
3856
|
+
mimeType?: string;
|
|
3857
|
+
/** The target Drive item. The format is `items/ITEM_ID`. */
|
|
3858
|
+
name?: string;
|
|
3859
|
+
/** The Drive item is a folder. Includes information about the type of folder. */
|
|
3860
|
+
driveFolder?: DriveactivityDriveFolder;
|
|
3861
|
+
/** This field is deprecated; please use the `driveFolder` field instead. */
|
|
3862
|
+
folder?: DriveactivityFolder;
|
|
3863
|
+
/** Information about the owner of this Drive item. */
|
|
3864
|
+
owner?: DriveactivityOwner;
|
|
3865
|
+
/** The Drive item is a file. */
|
|
3866
|
+
driveFile?: DriveactivityDriveFile;
|
|
3867
|
+
/** This field is deprecated; please use the `driveFile` field instead. */
|
|
3868
|
+
file?: DriveactivityFile;
|
|
3869
|
+
/** The title of the Drive item. */
|
|
3870
|
+
title?: string;
|
|
3871
|
+
};
|
|
3872
|
+
/** This item is deprecated; please see `DriveFolder` instead. */
|
|
3873
|
+
export type DriveactivityFolder = {
|
|
3874
|
+
/** This field is deprecated; please see `DriveFolder.type` instead. */
|
|
3875
|
+
type?: "TYPE_UNSPECIFIED" | "MY_DRIVE_ROOT" | "TEAM_DRIVE_ROOT" | "STANDARD_FOLDER";
|
|
3876
|
+
};
|
|
3877
|
+
/** Wrapper for Text List Field value. */
|
|
3878
|
+
export type DriveactivityTextList = {
|
|
3879
|
+
/** Text values. */
|
|
3880
|
+
values?: Array<DriveactivityText>;
|
|
3881
|
+
};
|
|
3882
|
+
/** Information about the target of activity. For more information on how activity history is shared with users, see [Activity history visibility](https://developers.google.com/workspace/drive/activity/v2#activityhistory). */
|
|
3883
|
+
export type DriveactivityTarget = {
|
|
3884
|
+
/** The target is a shared drive. */
|
|
3885
|
+
drive?: DriveactivityDrive;
|
|
3886
|
+
/** The target is a Drive item. */
|
|
3887
|
+
driveItem?: DriveactivityDriveItem;
|
|
3888
|
+
/** This field is deprecated; please use the `drive` field instead. */
|
|
3889
|
+
teamDrive?: DriveactivityTeamDrive;
|
|
3890
|
+
/** The target is a comment on a Drive file. */
|
|
3891
|
+
fileComment?: DriveactivityFileComment;
|
|
3892
|
+
};
|
|
3893
|
+
/** A Drive item which is a folder. */
|
|
3894
|
+
export type DriveactivityDriveFolder = {
|
|
3895
|
+
/** The type of Drive folder. */
|
|
3896
|
+
type?: "TYPE_UNSPECIFIED" | "MY_DRIVE_ROOT" | "SHARED_DRIVE_ROOT" | "STANDARD_FOLDER";
|
|
3897
|
+
};
|
|
3898
|
+
/** How the individual activities are consolidated. If a set of activities is related they can be consolidated into one combined activity, such as one actor performing the same action on multiple targets, or multiple actors performing the same action on a single target. The strategy defines the rules for which activities are related. */
|
|
3899
|
+
export type DriveactivityConsolidationStrategy = {
|
|
3900
|
+
/** The individual activities are consolidated using the legacy strategy. */
|
|
3901
|
+
legacy?: DriveactivityLegacy;
|
|
3902
|
+
/** The individual activities are not consolidated. */
|
|
3903
|
+
none?: DriveactivityNoConsolidation;
|
|
3904
|
+
};
|
|
3905
|
+
/** A change of the permission setting on an item. */
|
|
3906
|
+
export type DriveactivityPermissionChange = {
|
|
3907
|
+
/** The set of permissions added by this change. */
|
|
3908
|
+
addedPermissions?: Array<DriveactivityPermission>;
|
|
3909
|
+
/** The set of permissions removed by this change. */
|
|
3910
|
+
removedPermissions?: Array<DriveactivityPermission>;
|
|
3911
|
+
};
|
|
3912
|
+
/** This item is deprecated; please see `DriveReference` instead. */
|
|
3913
|
+
export type DriveactivityTeamDriveReference = {
|
|
3914
|
+
/** This field is deprecated; please see `DriveReference.name` instead. */
|
|
3915
|
+
name?: string;
|
|
3916
|
+
/** This field is deprecated; please see `DriveReference.title` instead. */
|
|
3917
|
+
title?: string;
|
|
3918
|
+
};
|
|
3919
|
+
/** An object was created by copying an existing object. */
|
|
3920
|
+
export type DriveactivityCopy = {
|
|
3921
|
+
/** The original object. */
|
|
3922
|
+
originalObject?: DriveactivityTargetReference;
|
|
3923
|
+
};
|
|
3924
|
+
/** Wrapper for Date Field value. */
|
|
3925
|
+
export type DriveactivityDate = {
|
|
3926
|
+
/** Date value. */
|
|
3927
|
+
value?: string;
|
|
3928
|
+
};
|
|
3929
|
+
/** Information about the owner of a Drive item. */
|
|
3930
|
+
export type DriveactivityOwner = {
|
|
3931
|
+
/** The domain of the Drive item owner. */
|
|
3932
|
+
domain?: DriveactivityDomain;
|
|
3933
|
+
/** This field is deprecated; please use the `drive` field instead. */
|
|
3934
|
+
teamDrive?: DriveactivityTeamDriveReference;
|
|
3935
|
+
/** The user that owns the Drive item. */
|
|
3936
|
+
user?: DriveactivityUser;
|
|
3937
|
+
/** The drive that owns the item. */
|
|
3938
|
+
drive?: DriveactivityDriveReference;
|
|
3939
|
+
};
|
|
3940
|
+
//# sourceMappingURL=types.d.ts.map
|