diff --git a/providers/src/googleworkspace/v00.00.00000/provider.yaml b/providers/src/googleworkspace/v00.00.00000/provider.yaml new file mode 100644 index 00000000..f83241ee --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/provider.yaml @@ -0,0 +1,53 @@ +id: googleworkspace +name: googleworkspace +version: v00.00.00000 +providerServices: + driveactivityv2: + id: driveactivityv2:v00.00.00000 + name: driveactivityv2 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/driveactivityv2.yaml + title: Drive Activity API + version: v00.00.00000 + description: Provides a historical view of activity in Google Drive. + drivelabelsv2: + id: drivelabelsv2:v00.00.00000 + name: drivelabelsv2 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivelabelsv2.yaml + title: Drive Labels API + version: v00.00.00000 + description: An API for managing Drive Labels + drivelabelsv2beta: + id: drivelabelsv2beta:v00.00.00000 + name: drivelabelsv2beta + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml + title: Drive Labels API + version: v00.00.00000 + description: An API for managing Drive Labels + drivev2: + id: drivev2:v00.00.00000 + name: drivev2 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivev2.yaml + title: Google Drive API + version: v00.00.00000 + description: The Google Drive API allows clients to access resources from Google Drive. + drivev3: + id: drivev3:v00.00.00000 + name: drivev3 + preferred: true + service: + $ref: googleworkspace/v00.00.00000/services/drivev3.yaml + title: Google Drive API + version: v00.00.00000 + description: The Google Drive API allows clients to access resources from Google Drive. +config: + auth: + credentialsenvvar: GOOGLE_CREDENTIALS + type: service_account diff --git a/providers/src/googleworkspace/v00.00.00000/services/driveactivityv2.yaml b/providers/src/googleworkspace/v00.00.00000/services/driveactivityv2.yaml new file mode 100644 index 00000000..dbff2568 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/driveactivityv2.yaml @@ -0,0 +1,1296 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Drive Activity API + description: Provides a historical view of activity in Google Drive. + version: v2 + x-discovery-doc-revision: '20241203' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/activity/ +servers: + - url: https://driveactivity.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive.activity: View and add to the activity record of files in your Google Drive + https://www.googleapis.com/auth/drive.activity.readonly: View the activity record of files in your Google Drive + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + QueryDriveActivityRequest: + id: QueryDriveActivityRequest + description: The request message for querying Drive activity. + type: object + properties: + itemName: + description: >- + Return activities for this Drive item. The format is + `items/ITEM_ID`. + type: string + ancestorName: + description: >- + Return activities for this Drive folder, plus all children and + descendants. The format is `items/ITEM_ID`. + type: string + consolidationStrategy: + description: >- + Details on how to consolidate related actions that make up the + activity. If not set, then related actions aren't consolidated. + $ref: '#/components/schemas/ConsolidationStrategy' + pageSize: + description: >- + 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. + type: integer + format: int32 + pageToken: + description: >- + 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. + type: string + filter: + description: >- + 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` + type: string + ConsolidationStrategy: + id: ConsolidationStrategy + description: >- + 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. + type: object + properties: + none: + description: The individual activities are not consolidated. + $ref: '#/components/schemas/NoConsolidation' + legacy: + description: >- + The individual activities are consolidated using the legacy + strategy. + $ref: '#/components/schemas/Legacy' + NoConsolidation: + id: NoConsolidation + description: A strategy that does no consolidation of individual activities. + type: object + properties: {} + Legacy: + id: Legacy + description: >- + 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. + type: object + properties: {} + QueryDriveActivityResponse: + id: QueryDriveActivityResponse + description: Response message for querying Drive activity. + type: object + properties: + activities: + description: List of activity requested. + type: array + items: + $ref: '#/components/schemas/DriveActivity' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + DriveActivity: + id: DriveActivity + description: >- + 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. + type: object + properties: + primaryActionDetail: + description: >- + 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. + $ref: '#/components/schemas/ActionDetail' + actors: + description: All actor(s) responsible for the activity. + type: array + items: + $ref: '#/components/schemas/Actor' + actions: + description: Details on all actions in this activity. + type: array + items: + $ref: '#/components/schemas/Action' + targets: + description: >- + 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. + type: array + items: + $ref: '#/components/schemas/Target' + timestamp: + description: The activity occurred at this specific time. + type: string + format: google-datetime + timeRange: + description: The activity occurred over this time range. + $ref: '#/components/schemas/TimeRange' + ActionDetail: + id: ActionDetail + description: Data describing the type and additional information of an action. + type: object + properties: + create: + description: An object was created. + $ref: '#/components/schemas/Create' + edit: + description: An object was edited. + $ref: '#/components/schemas/Edit' + move: + description: An object was moved. + $ref: '#/components/schemas/Move' + rename: + description: An object was renamed. + $ref: '#/components/schemas/Rename' + delete: + description: An object was deleted. + $ref: '#/components/schemas/Delete' + restore: + description: A deleted object was restored. + $ref: '#/components/schemas/Restore' + permissionChange: + description: The permission on an object was changed. + $ref: '#/components/schemas/PermissionChange' + comment: + description: A change about comments was made. + $ref: '#/components/schemas/Comment' + dlpChange: + description: A change happened in data leak prevention status. + $ref: '#/components/schemas/DataLeakPreventionChange' + reference: + description: An object was referenced in an application outside of Drive/Docs. + $ref: '#/components/schemas/ApplicationReference' + settingsChange: + description: Settings were changed. + $ref: '#/components/schemas/SettingsChange' + appliedLabelChange: + description: Label was changed. + $ref: '#/components/schemas/AppliedLabelChange' + Create: + id: Create + description: An object was created. + type: object + properties: + new: + description: >- + If present, indicates the object was newly created (e.g. as a blank + document), not derived from a Drive object or external object. + $ref: '#/components/schemas/New' + upload: + description: >- + If present, indicates the object originated externally and was + uploaded to Drive. + $ref: '#/components/schemas/Upload' + copy: + description: >- + If present, indicates the object was created by copying an existing + Drive object. + $ref: '#/components/schemas/Copy' + New: + id: New + description: An object was created from scratch. + type: object + properties: {} + Upload: + id: Upload + description: An object was uploaded into Drive. + type: object + properties: {} + Copy: + id: Copy + description: An object was created by copying an existing object. + type: object + properties: + originalObject: + description: The original object. + $ref: '#/components/schemas/TargetReference' + TargetReference: + id: TargetReference + description: A lightweight reference to the target of activity. + type: object + properties: + driveItem: + description: The target is a Drive item. + $ref: '#/components/schemas/DriveItemReference' + drive: + description: The target is a shared drive. + $ref: '#/components/schemas/DriveReference' + teamDrive: + description: This field is deprecated; please use the `drive` field instead. + deprecated: true + $ref: '#/components/schemas/TeamDriveReference' + DriveItemReference: + id: DriveItemReference + description: A lightweight reference to a Drive item, such as a file or folder. + type: object + properties: + name: + description: The target Drive item. The format is `items/ITEM_ID`. + type: string + title: + description: The title of the Drive item. + type: string + file: + description: This field is deprecated; please use the `driveFile` field instead. + deprecated: true + $ref: '#/components/schemas/File' + folder: + description: >- + This field is deprecated; please use the `driveFolder` field + instead. + deprecated: true + $ref: '#/components/schemas/Folder' + driveFile: + description: The Drive item is a file. + $ref: '#/components/schemas/DriveFile' + driveFolder: + description: >- + The Drive item is a folder. Includes information about the type of + folder. + $ref: '#/components/schemas/DriveFolder' + File: + id: File + deprecated: true + description: This item is deprecated; please see `DriveFile` instead. + type: object + properties: {} + Folder: + id: Folder + deprecated: true + description: This item is deprecated; please see `DriveFolder` instead. + type: object + properties: + type: + description: This field is deprecated; please see `DriveFolder.type` instead. + type: string + enumDescriptions: + - This item is deprecated; please see `DriveFolder.Type` instead. + - This item is deprecated; please see `DriveFolder.Type` instead. + - This item is deprecated; please see `DriveFolder.Type` instead. + - This item is deprecated; please see `DriveFolder.Type` instead. + enum: + - TYPE_UNSPECIFIED + - MY_DRIVE_ROOT + - TEAM_DRIVE_ROOT + - STANDARD_FOLDER + DriveFile: + id: DriveFile + description: A Drive item which is a file. + type: object + properties: {} + DriveFolder: + id: DriveFolder + description: A Drive item which is a folder. + type: object + properties: + type: + description: The type of Drive folder. + type: string + enumDescriptions: + - The folder type is unknown. + - The folder is the root of a user's MyDrive. + - The folder is the root of a shared drive. + - The folder is a standard, non-root, folder. + enum: + - TYPE_UNSPECIFIED + - MY_DRIVE_ROOT + - SHARED_DRIVE_ROOT + - STANDARD_FOLDER + DriveReference: + id: DriveReference + description: A lightweight reference to a shared drive. + type: object + properties: + name: + description: >- + 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. + type: string + title: + description: The title of the shared drive. + type: string + TeamDriveReference: + id: TeamDriveReference + deprecated: true + description: This item is deprecated; please see `DriveReference` instead. + type: object + properties: + name: + description: This field is deprecated; please see `DriveReference.name` instead. + type: string + title: + description: This field is deprecated; please see `DriveReference.title` instead. + type: string + Edit: + id: Edit + description: An empty message indicating an object was edited. + type: object + properties: {} + Move: + id: Move + description: An object was moved. + type: object + properties: + addedParents: + description: The added parent object(s). + type: array + items: + $ref: '#/components/schemas/TargetReference' + removedParents: + description: The removed parent object(s). + type: array + items: + $ref: '#/components/schemas/TargetReference' + Rename: + id: Rename + description: An object was renamed. + type: object + properties: + oldTitle: + description: The previous title of the drive object. + type: string + newTitle: + description: The new title of the drive object. + type: string + Delete: + id: Delete + description: An object was deleted. + type: object + properties: + type: + description: The type of delete action taken. + type: string + enumDescriptions: + - Deletion type is not available. + - An object was put into the trash. + - An object was deleted permanently. + enum: + - TYPE_UNSPECIFIED + - TRASH + - PERMANENT_DELETE + Restore: + id: Restore + description: A deleted object was restored. + type: object + properties: + type: + description: The type of restore action taken. + type: string + enumDescriptions: + - The type is not available. + - An object was restored from the trash. + enum: + - TYPE_UNSPECIFIED + - UNTRASH + PermissionChange: + id: PermissionChange + description: A change of the permission setting on an item. + type: object + properties: + addedPermissions: + description: The set of permissions added by this change. + type: array + items: + $ref: '#/components/schemas/Permission' + removedPermissions: + description: The set of permissions removed by this change. + type: array + items: + $ref: '#/components/schemas/Permission' + Permission: + id: Permission + description: The permission setting of an object. + type: object + properties: + role: + description: >- + Indicates the [Google Drive permissions + role](https://developers.google.com/drive/web/manage-sharing#roles). + The role determines a user's ability to read, write, and comment on + items. + type: string + enumDescriptions: + - The role is not available. + - A role granting full access. + - A role granting the ability to manage people and settings. + - A role granting the ability to contribute and manage content. + - >- + A role granting the ability to contribute content. This role is + sometimes also known as "writer". + - A role granting the ability to view and comment on content. + - >- + A role granting the ability to view content. This role is + sometimes also known as "reader". + - >- + A role granting the ability to view content only after it has been + published to the web. This role is sometimes also known as + "published reader". See + https://support.google.com/sites/answer/6372880 for more + information. + enum: + - ROLE_UNSPECIFIED + - OWNER + - ORGANIZER + - FILE_ORGANIZER + - EDITOR + - COMMENTER + - VIEWER + - PUBLISHED_VIEWER + user: + description: The user to whom this permission applies. + $ref: '#/components/schemas/User' + group: + description: The group to whom this permission applies. + $ref: '#/components/schemas/Group' + domain: + description: The domain to whom this permission applies. + $ref: '#/components/schemas/Domain' + anyone: + description: If set, this permission applies to anyone, even logged out users. + $ref: '#/components/schemas/Anyone' + allowDiscovery: + description: >- + If true, the item can be discovered (e.g. in the user's "Shared with + me" collection) without needing a link to the item. + type: boolean + User: + id: User + description: Information about an end user. + type: object + properties: + knownUser: + description: A known user. + $ref: '#/components/schemas/KnownUser' + deletedUser: + description: A user whose account has since been deleted. + $ref: '#/components/schemas/DeletedUser' + unknownUser: + description: A user about whom nothing is currently known. + $ref: '#/components/schemas/UnknownUser' + KnownUser: + id: KnownUser + description: A known user. + type: object + properties: + personName: + description: >- + 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/. + type: string + isCurrentUser: + description: True if this is the user making the request. + type: boolean + DeletedUser: + id: DeletedUser + description: A user whose account has since been deleted. + type: object + properties: {} + UnknownUser: + id: UnknownUser + description: A user about whom nothing is currently known. + type: object + properties: {} + Group: + id: Group + description: Information about a group. + type: object + properties: + email: + description: The email address of the group. + type: string + title: + description: The title of the group. + type: string + Domain: + id: Domain + description: Information about a domain. + type: object + properties: + name: + description: The name of the domain, e.g. `google.com`. + type: string + legacyId: + description: An opaque string used to identify this domain. + type: string + Anyone: + id: Anyone + description: Represents any user (including a logged out user). + type: object + properties: {} + Comment: + id: Comment + description: A change about comments on an object. + type: object + properties: + post: + description: A change on a regular posted comment. + $ref: '#/components/schemas/Post' + assignment: + description: A change on an assignment. + $ref: '#/components/schemas/Assignment' + suggestion: + description: A change on a suggestion. + $ref: '#/components/schemas/Suggestion' + mentionedUsers: + description: Users who are mentioned in this comment. + type: array + items: + $ref: '#/components/schemas/User' + Post: + id: Post + description: A regular posted comment. + type: object + properties: + subtype: + description: The sub-type of this event. + type: string + enumDescriptions: + - Subtype not available. + - A post was added. + - A post was deleted. + - A reply was added. + - A reply was deleted. + - A posted comment was resolved. + - A posted comment was reopened. + enum: + - SUBTYPE_UNSPECIFIED + - ADDED + - DELETED + - REPLY_ADDED + - REPLY_DELETED + - RESOLVED + - REOPENED + Assignment: + id: Assignment + description: A comment with an assignment. + type: object + properties: + subtype: + description: The sub-type of this event. + type: string + enumDescriptions: + - Subtype not available. + - An assignment was added. + - An assignment was deleted. + - An assignment reply was added. + - An assignment reply was deleted. + - An assignment was resolved. + - A resolved assignment was reopened. + - An assignment was reassigned. + enum: + - SUBTYPE_UNSPECIFIED + - ADDED + - DELETED + - REPLY_ADDED + - REPLY_DELETED + - RESOLVED + - REOPENED + - REASSIGNED + assignedUser: + description: The user to whom the comment was assigned. + $ref: '#/components/schemas/User' + Suggestion: + id: Suggestion + description: A suggestion. + type: object + properties: + subtype: + description: The sub-type of this event. + type: string + enumDescriptions: + - Subtype not available. + - A suggestion was added. + - A suggestion was deleted. + - A suggestion reply was added. + - A suggestion reply was deleted. + - A suggestion was accepted. + - A suggestion was rejected. + - An accepted suggestion was deleted. + - A rejected suggestion was deleted. + enum: + - SUBTYPE_UNSPECIFIED + - ADDED + - DELETED + - REPLY_ADDED + - REPLY_DELETED + - ACCEPTED + - REJECTED + - ACCEPT_DELETED + - REJECT_DELETED + DataLeakPreventionChange: + id: DataLeakPreventionChange + description: A change in the object's data leak prevention status. + type: object + properties: + type: + description: The type of Data Leak Prevention (DLP) change. + type: string + enumDescriptions: + - An update to the DLP state that is neither FLAGGED or CLEARED. + - Document has been flagged as containing sensitive content. + - Document is no longer flagged as containing sensitive content. + enum: + - TYPE_UNSPECIFIED + - FLAGGED + - CLEARED + ApplicationReference: + id: ApplicationReference + description: Activity in applications other than Drive. + type: object + properties: + type: + description: The reference type corresponding to this event. + type: string + enumDescriptions: + - The type is not available. + - The links of one or more Drive items were posted. + - Comments were made regarding a Drive item. + enum: + - UNSPECIFIED_REFERENCE_TYPE + - LINK + - DISCUSS + SettingsChange: + id: SettingsChange + description: Information about settings changes. + type: object + properties: + restrictionChanges: + description: The set of changes made to restrictions. + type: array + items: + $ref: '#/components/schemas/RestrictionChange' + RestrictionChange: + id: RestrictionChange + description: Information about restriction policy changes to a feature. + type: object + properties: + feature: + description: The feature which had a change in restriction policy. + type: string + enumDescriptions: + - The feature which changed restriction settings was not available. + - >- + When restricted, this prevents items from being shared outside the + domain. + - When restricted, this prevents direct sharing of individual items. + - >- + When restricted, this prevents actions like copy, download, and + print that might result in uncontrolled duplicates of items. + - When restricted, this prevents use of Drive File Stream. + - When restricted, this limits sharing of folders to managers only. + enum: + - FEATURE_UNSPECIFIED + - SHARING_OUTSIDE_DOMAIN + - DIRECT_SHARING + - ITEM_DUPLICATION + - DRIVE_FILE_STREAM + - FILE_ORGANIZER_CAN_SHARE_FOLDERS + newRestriction: + description: The restriction in place after the change. + type: string + enumDescriptions: + - The type of restriction is not available. + - The feature is available without restriction. + - The use of this feature is fully restricted. + enum: + - RESTRICTION_UNSPECIFIED + - UNRESTRICTED + - FULLY_RESTRICTED + AppliedLabelChange: + id: AppliedLabelChange + description: Label changes that were made on the Target. + type: object + properties: + changes: + description: Changes that were made to the Label on the Target. + type: array + items: + $ref: '#/components/schemas/AppliedLabelChangeDetail' + AppliedLabelChangeDetail: + id: AppliedLabelChangeDetail + description: A change made to a Label on the Target. + type: object + properties: + label: + description: >- + 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`. + type: string + types: + description: The types of changes made to the Label on the Target. + type: array + items: + type: string + enumDescriptions: + - The type of change to this Label is not available. + - The identified Label was added to the Target. + - The identified Label was removed from the Target. + - Field values were changed on the Target. + - The Label was applied as a side-effect of Drive item creation. + enum: + - TYPE_UNSPECIFIED + - LABEL_ADDED + - LABEL_REMOVED + - LABEL_FIELD_VALUE_CHANGED + - LABEL_APPLIED_BY_ITEM_CREATE + title: + description: The human-readable title of the label that changed. + type: string + fieldChanges: + description: >- + Field Changes. Only present if `types` contains + `LABEL_FIELD_VALUE_CHANGED`. + type: array + items: + $ref: '#/components/schemas/FieldValueChange' + FieldValueChange: + id: FieldValueChange + description: Change to a Field value. + type: object + properties: + fieldId: + description: The ID of this field. Field IDs are unique within a Label. + type: string + oldValue: + description: >- + 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. + $ref: '#/components/schemas/FieldValue' + newValue: + description: >- + 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. + $ref: '#/components/schemas/FieldValue' + displayName: + description: The human-readable display name for this field. + type: string + FieldValue: + id: FieldValue + description: Contains a value of a Field. + type: object + properties: + text: + description: Text Field value. + $ref: '#/components/schemas/Text' + textList: + description: Text List Field value. + $ref: '#/components/schemas/TextList' + selection: + description: Selection Field value. + $ref: '#/components/schemas/Selection' + selectionList: + description: Selection List Field value. + $ref: '#/components/schemas/SelectionList' + integer: + description: Integer Field value. + $ref: '#/components/schemas/Integer' + user: + description: User Field value. + $ref: '#/components/schemas/SingleUser' + userList: + description: User List Field value. + $ref: '#/components/schemas/UserList' + date: + description: Date Field value. + $ref: '#/components/schemas/Date' + Text: + id: Text + description: Wrapper for Text Field value. + type: object + properties: + value: + description: Value of Text Field. + type: string + TextList: + id: TextList + description: Wrapper for Text List Field value. + type: object + properties: + values: + description: Text values. + type: array + items: + $ref: '#/components/schemas/Text' + Selection: + id: Selection + description: >- + Wrapper for Selection Field value as combined value/display_name pair + for selected choice. + type: object + properties: + value: + description: Selection value as Field Choice ID. + type: string + displayName: + description: Selection value as human-readable display string. + type: string + SelectionList: + id: SelectionList + description: Wrapper for SelectionList Field value. + type: object + properties: + values: + description: Selection values. + type: array + items: + $ref: '#/components/schemas/Selection' + Integer: + id: Integer + description: Wrapper for Integer Field value. + type: object + properties: + value: + description: Integer value. + type: string + format: int64 + SingleUser: + id: SingleUser + description: Wrapper for User Field value. + type: object + properties: + value: + description: User value as email. + type: string + UserList: + id: UserList + description: Wrapper for UserList Field value. + type: object + properties: + values: + description: User values. + type: array + items: + $ref: '#/components/schemas/SingleUser' + Date: + id: Date + description: Wrapper for Date Field value. + type: object + properties: + value: + description: Date value. + type: string + format: google-datetime + Actor: + id: Actor + description: The actor of a Drive activity. + type: object + properties: + user: + description: An end user. + $ref: '#/components/schemas/User' + anonymous: + description: An anonymous user. + $ref: '#/components/schemas/AnonymousUser' + impersonation: + description: An account acting on behalf of another. + $ref: '#/components/schemas/Impersonation' + system: + description: A non-user actor (i.e. system triggered). + $ref: '#/components/schemas/SystemEvent' + administrator: + description: An administrator. + $ref: '#/components/schemas/Administrator' + AnonymousUser: + id: AnonymousUser + description: >- + Empty message representing an anonymous user or indicating the + authenticated user should be anonymized. + type: object + properties: {} + Impersonation: + id: Impersonation + description: >- + Information about an impersonation, where an admin acts on behalf of an + end user. Information about the acting admin is not currently available. + type: object + properties: + impersonatedUser: + description: The impersonated user. + $ref: '#/components/schemas/User' + SystemEvent: + id: SystemEvent + description: Event triggered by system operations instead of end users. + type: object + properties: + type: + description: The type of the system event that may triggered activity. + type: string + enumDescriptions: + - The event type is unspecified. + - The event is a consequence of a user account being deleted. + - The event is due to the system automatically purging trash. + enum: + - TYPE_UNSPECIFIED + - USER_DELETION + - TRASH_AUTO_PURGE + Administrator: + id: Administrator + description: Empty message representing an administrator. + type: object + properties: {} + Action: + id: Action + description: Information about the action. + type: object + properties: + detail: + description: The type and detailed information about the action. + $ref: '#/components/schemas/ActionDetail' + actor: + description: >- + The actor responsible for this action (or empty if all actors are + responsible). + $ref: '#/components/schemas/Actor' + target: + description: >- + The target this action affects (or empty if affecting all targets). + This represents the state of the target immediately after this + action occurred. + $ref: '#/components/schemas/Target' + timestamp: + description: The action occurred at this specific time. + type: string + format: google-datetime + timeRange: + description: The action occurred over this time range. + $ref: '#/components/schemas/TimeRange' + Target: + id: Target + description: >- + 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/drive/activity/v2#activityhistory). + type: object + properties: + driveItem: + description: The target is a Drive item. + $ref: '#/components/schemas/DriveItem' + drive: + description: The target is a shared drive. + $ref: '#/components/schemas/Drive' + fileComment: + description: The target is a comment on a Drive file. + $ref: '#/components/schemas/FileComment' + teamDrive: + description: This field is deprecated; please use the `drive` field instead. + deprecated: true + $ref: '#/components/schemas/TeamDrive' + DriveItem: + id: DriveItem + description: A Drive item, such as a file or folder. + type: object + properties: + name: + description: The target Drive item. The format is `items/ITEM_ID`. + type: string + title: + description: The title of the Drive item. + type: string + file: + description: This field is deprecated; please use the `driveFile` field instead. + deprecated: true + $ref: '#/components/schemas/File' + folder: + description: >- + This field is deprecated; please use the `driveFolder` field + instead. + deprecated: true + $ref: '#/components/schemas/Folder' + driveFile: + description: The Drive item is a file. + $ref: '#/components/schemas/DriveFile' + driveFolder: + description: >- + The Drive item is a folder. Includes information about the type of + folder. + $ref: '#/components/schemas/DriveFolder' + mimeType: + description: >- + The MIME type of the Drive item. See + https://developers.google.com/drive/v3/web/mime-types. + type: string + owner: + description: Information about the owner of this Drive item. + $ref: '#/components/schemas/Owner' + Owner: + id: Owner + description: Information about the owner of a Drive item. + type: object + properties: + user: + description: The user that owns the Drive item. + $ref: '#/components/schemas/User' + drive: + description: The drive that owns the item. + $ref: '#/components/schemas/DriveReference' + teamDrive: + description: This field is deprecated; please use the `drive` field instead. + deprecated: true + $ref: '#/components/schemas/TeamDriveReference' + domain: + description: The domain of the Drive item owner. + $ref: '#/components/schemas/Domain' + Drive: + id: Drive + description: Information about a shared drive. + type: object + properties: + name: + description: >- + 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. + type: string + title: + description: The title of the shared drive. + type: string + root: + description: The root of this shared drive. + $ref: '#/components/schemas/DriveItem' + FileComment: + id: FileComment + description: A comment on a file. + type: object + properties: + legacyCommentId: + description: >- + The comment in the discussion thread. This identifier is an opaque + string compatible with the Drive API; see + https://developers.google.com/drive/v3/reference/comments/get + type: string + legacyDiscussionId: + description: >- + 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/drive/v3/reference/comments/get + type: string + linkToDiscussion: + description: >- + The link to the discussion thread containing this comment, for + example, `https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID`. + type: string + parent: + description: The Drive item containing this comment. + $ref: '#/components/schemas/DriveItem' + TeamDrive: + id: TeamDrive + deprecated: true + description: This item is deprecated; please see `Drive` instead. + type: object + properties: + name: + description: This field is deprecated; please see `Drive.name` instead. + type: string + title: + description: This field is deprecated; please see `Drive.title` instead. + type: string + root: + description: This field is deprecated; please see `Drive.root` instead. + $ref: '#/components/schemas/DriveItem' + TimeRange: + id: TimeRange + description: Information about time ranges. + type: object + properties: + startTime: + description: The start of the time range. + type: string + format: google-datetime + endTime: + description: The end of the time range. + type: string + format: google-datetime + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + activity: + id: googleworkspace.driveactivityv2.activity + name: activity + title: Activity + methods: + query: + operation: + $ref: '#/paths/~1v2~1activity:query/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2/activity:query: + parameters: + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: Query past activity in Google Drive. + operationId: driveactivity.activity.query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDriveActivityRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.activity + Oauth2c: + - https://www.googleapis.com/auth/drive.activity + - Oauth2: + - https://www.googleapis.com/auth/drive.activity.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.activity.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDriveActivityResponse' + parameters: [] diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2.yaml new file mode 100644 index 00000000..637d6e24 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2.yaml @@ -0,0 +1,3394 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Drive Labels API + description: An API for managing Drive Labels + version: v2 + x-discovery-doc-revision: '20241204' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/labels +servers: + - url: https://drivelabels.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive.admin.labels: >- + See, edit, create, and delete all Google Drive labels in your + organization, and see your organization's label-related admin + policies + https://www.googleapis.com/auth/drive.labels.readonly: See your Google Drive labels + https://www.googleapis.com/auth/drive.labels: See, edit, create, and delete your Google Drive labels + https://www.googleapis.com/auth/drive.admin.labels.readonly: >- + See all Google Drive labels and label-related admin policies in + your organization + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest: + properties: + selectionOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptions' + description: Update field to Selection. + id: + description: Required. The Field to update. + type: string + updateMask: + type: string + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root of `type_options` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + textOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldTextOptions' + description: Update field to Text. + integerOptions: + description: Update field to Integer. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldIntegerOptions' + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDateOptions' + description: Update field to Date. + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldUserOptions' + description: Update field to User. + description: Request to change the type of a Field. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest + type: object + GoogleAppsDriveLabelsV2BadgeColors: + id: GoogleAppsDriveLabelsV2BadgeColors + type: object + description: >- + The color derived from BadgeConfig and changed to the closest + recommended supported color. + properties: + soloColor: + readOnly: true + $ref: '#/components/schemas/GoogleTypeColor' + description: Output only. Color that can be used for text without a background. + backgroundColor: + readOnly: true + $ref: '#/components/schemas/GoogleTypeColor' + description: Output only. Badge background that pairs with the foreground. + foregroundColor: + description: Output only. Badge foreground that pairs with the background. + $ref: '#/components/schemas/GoogleTypeColor' + readOnly: true + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice: + type: object + description: Selection field choice. + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice + properties: + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties + description: Basic properties of the choice. + id: + type: string + description: >- + The unique value of the choice. This ID is autogenerated. Matches + the regex: `([a-zA-Z0-9_])+`. + createTime: + type: string + format: google-datetime + description: Output only. The time this choice was created. + readOnly: true + displayHints: + description: Output only. UI display hints for rendering a choice. + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints + appliedCapabilities: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities + description: >- + Output only. The capabilities related to this choice on applied + metadata. + readOnly: true + disableTime: + description: >- + Output only. The time this choice was disabled. This value has no + meaning when the choice is not disabled. + readOnly: true + format: google-datetime + type: string + creator: + readOnly: true + description: Output only. The user who created this choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + updater: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who updated this choice last. + readOnly: true + updateTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time this choice was updated last. + schemaCapabilities: + readOnly: true + description: >- + Output only. The capabilities related to this option when editing + the option. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities + publishTime: + type: string + description: >- + Output only. The time this choice was published. This value has no + meaning when the choice is not published. + readOnly: true + format: google-datetime + publisher: + description: >- + Output only. The user who published this choice. This value has no + meaning when the choice is not published. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + lifecycle: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' + description: Output only. Lifecycle of the choice. + readOnly: true + lockStatus: + readOnly: true + description: Output only. The LockStatus of this choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' + disabler: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + description: >- + Output only. The user who disabled this choice. This value has no + meaning when the option is not disabled. + GoogleAppsDriveLabelsV2ListLimits: + type: object + properties: + maxEntries: + type: integer + format: int32 + description: Maximum number of values allowed for the Field type. + id: GoogleAppsDriveLabelsV2ListLimits + description: Limits for list-variant of a Field type. + GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest: + description: Updates one or more Label Permissions. + id: GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest + properties: + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + UpdateLabelPermissionRequest messages must either be empty or match + this field. + requests: + description: Required. The request message specifying the resources to update. + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest + type: array + type: object + GoogleAppsDriveLabelsV2LifecycleDisabledPolicy: + properties: + hideInSearch: + type: boolean + description: >- + Whether to hide this disabled object in the search menu for Drive + items. * When `false`, the object is generally shown in the UI as + disabled but it appears in the search results when searching for + Drive items. * When `true`, the object is generally hidden in the UI + when searching for Drive items. + showInApply: + type: boolean + description: >- + Whether to show this disabled object in the apply menu on Drive + items. * When `true`, the object is generally shown in the UI as + disabled and is unselectable. * When `false`, the object is + generally hidden in the UI. + id: GoogleAppsDriveLabelsV2LifecycleDisabledPolicy + description: >- + The policy that governs how to treat a disabled label, field, or + selection choice in different contexts. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties: + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties + properties: + badgeConfig: + description: >- + The badge configuration for this choice. When set, the label that + owns this choice is considered a "badged label". + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeConfig' + description: + description: The description of this label. + type: string + insertBeforeChoice: + description: >- + Input only. Insert or move this choice before the indicated choice. + If empty, the choice is placed at the end of the list. + type: string + displayName: + type: string + description: Required. The display text to show in the UI identifying this field. + type: object + description: Basic properties of the choice. + GoogleTypeColor: + properties: + red: + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + blue: + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + green: + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + alpha: + format: float + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + type: object + id: GoogleTypeColor + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse: + type: object + properties: + updatedLabel: + description: >- + The label after updates were applied. This is only set if + [BatchUpdateLabelResponse2.include_label_in_response] is `true` and + there were no errors. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + responses: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse + type: array + description: >- + The reply of the updates. This maps 1:1 with the updates, although + responses to some requests may be empty. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse + description: Response for Label update. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest + properties: + fieldId: + type: string + description: Required. The Selection Field from which a Choice will be deleted. + id: + description: Required. Choice to delete. + type: string + description: Request to delete a Choice. + GoogleAppsDriveLabelsV2FieldListOptions: + description: Options for a multi-valued variant of an associated field type. + id: GoogleAppsDriveLabelsV2FieldListOptions + type: object + properties: + maxEntries: + description: Maximum number of entries permitted. + format: int32 + type: integer + GoogleAppsDriveLabelsV2BadgeConfig: + id: GoogleAppsDriveLabelsV2BadgeConfig + description: Badge status of the label. + properties: + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: >- + The color of the badge. When not specified, no badge is rendered. + The background, foreground, and solo (light and dark mode) colors + set here are changed in the Drive UI into the closest recommended + supported color. + priorityOverride: + format: int64 + description: >- + Override the default global priority of this badge. When set to 0, + the default priority heuristic is used. + type: string + type: object + GoogleAppsDriveLabelsV2LongTextLimits: + id: GoogleAppsDriveLabelsV2LongTextLimits + type: object + properties: + maxLength: + description: Maximum length allowed for a long text Field type. + type: integer + format: int32 + minLength: + description: Minimum length allowed for a long text Field type. + format: int32 + type: integer + description: Limits for long text Field type. + GoogleAppsDriveLabelsV2LabelLimits: + type: object + description: >- + Label constraints governing the structure of a Label; such as, the + maximum number of Fields allowed and maximum length of the label title. + id: GoogleAppsDriveLabelsV2LabelLimits + properties: + fieldLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldLimits' + description: The limits for Fields. + maxDeletedFields: + format: int32 + description: The maximum number of published Fields that can be deleted. + type: integer + maxDraftRevisions: + type: integer + description: >- + The maximum number of draft revisions that will be kept before + deleting old drafts. + format: int32 + maxFields: + format: int32 + description: The maximum number of Fields allowed within the label. + type: integer + maxDescriptionLength: + type: integer + description: The maximum number of characters allowed for the description. + format: int32 + maxTitleLength: + format: int32 + description: The maximum number of characters allowed for the title. + type: integer + name: + type: string + description: Resource name. + GoogleTypeDate: + type: object + properties: + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + id: GoogleTypeDate + GoogleAppsDriveLabelsV2PublishLabelRequest: + type: object + properties: + writeControl: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + description: Request to publish a label. + id: GoogleAppsDriveLabelsV2PublishLabelRequest + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse + description: Response following Choice enable. + properties: {} + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest: + properties: + fieldId: + type: string + description: Required. The Selection Field to update. + id: + type: string + description: Required. The Choice to update. + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties + description: Required. The Choice properties to update. + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + description: Request to update a Choice properties. + GoogleAppsDriveLabelsV2Lifecycle: + description: >- + The lifecycle state of an object, such as label, field, or choice. The + lifecycle enforces the following transitions: * `UNPUBLISHED_DRAFT` + (starting state) * `UNPUBLISHED_DRAFT` -> `PUBLISHED` * + `UNPUBLISHED_DRAFT` -> (Deleted) * `PUBLISHED` -> `DISABLED` * + `DISABLED` -> `PUBLISHED` * `DISABLED` -> (Deleted) The published and + disabled states have some distinct characteristics: * Published—Some + kinds of changes might be made to an object in this state, in which case + `has_unpublished_changes` will be true. Also, some kinds of changes are + not permitted. Generally, any change that would invalidate or cause new + restrictions on existing metadata related to the label are rejected. * + Disabled—When disabled, the configured `DisabledPolicy` takes effect. + type: object + properties: + disabledPolicy: + description: >- + The policy that governs how to show a disabled label, field, or + selection choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + hasUnpublishedChanges: + description: >- + Output only. Whether the object associated with this lifecycle has + unpublished changes. + type: boolean + readOnly: true + state: + enum: + - STATE_UNSPECIFIED + - UNPUBLISHED_DRAFT + - PUBLISHED + - DISABLED + - DELETED + readOnly: true + description: Output only. The state of the object associated with this lifecycle. + type: string + enumDescriptions: + - Unknown State. + - >- + The initial state of an object. Once published, the object can + never return to this state. Once an object is published, certain + kinds of changes are no longer permitted. + - >- + The object has been published. The object might have unpublished + draft changes as indicated by `has_unpublished_changes`. + - >- + The object has been published and has since been disabled. The + object might have unpublished draft changes as indicated by + `has_unpublished_changes`. + - The object has been deleted. + id: GoogleAppsDriveLabelsV2Lifecycle + GoogleAppsDriveLabelsV2FieldLimits: + id: GoogleAppsDriveLabelsV2FieldLimits + description: >- + Field constants governing the structure of a Field; such as, the maximum + title length, minimum and maximum field values or length, etc. + type: object + properties: + userLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserLimits' + description: User Field limits. + longTextLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LongTextLimits' + description: Long text Field limits. + textLimits: + description: The relevant limits for the specified Field.Type. Text Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2TextLimits' + maxDescriptionLength: + type: integer + format: int32 + description: Limits for Field description, also called help text. + dateLimits: + description: Date Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DateLimits' + maxDisplayNameLength: + type: integer + format: int32 + description: Limits for Field title. + maxIdLength: + format: int32 + type: integer + description: Max length for the id. + selectionLimits: + description: Selection Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2SelectionLimits' + integerLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2IntegerLimits' + description: Integer Field limits. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest: + type: object + description: Request to enable the Field. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest + properties: + id: + type: string + description: Required. ID of the Field to enable. + GoogleAppsDriveLabelsV2FieldUserOptions: + description: Options for the user field type. + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldListOptions' + description: >- + When specified, indicates that this field supports a list of values. + Once the field is published, this cannot be changed. + id: GoogleAppsDriveLabelsV2FieldUserOptions + type: object + GoogleAppsDriveLabelsV2LabelLockCapabilities: + properties: + canViewPolicy: + type: boolean + description: True if the user is authorized to view the policy. + description: A description of a user's capabilities on a LabelLock. + type: object + id: GoogleAppsDriveLabelsV2LabelLockCapabilities + GoogleAppsDriveLabelsV2SelectionLimits: + description: Limits for selection Field type. + properties: + maxIdLength: + description: Maximum ID length for a selection options. + type: integer + format: int32 + maxChoices: + format: int32 + type: integer + description: The max number of choices. + maxDisplayNameLength: + description: Maximum length for display name. + format: int32 + type: integer + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLimits' + description: Limits for list-variant of a Field type. + maxDeletedChoices: + format: int32 + description: Maximum number of deleted choices. + type: integer + type: object + id: GoogleAppsDriveLabelsV2SelectionLimits + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse + properties: {} + description: Response following Field disable. + type: object + GoogleAppsDriveLabelsV2LabelProperties: + type: object + id: GoogleAppsDriveLabelsV2LabelProperties + properties: + description: + type: string + description: The description of the label. + title: + type: string + description: Required. Title of the label. + description: Basic properties of the label. + GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest: + type: object + id: GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest + properties: + requests: + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest + description: Required. The request message specifying the resources to update. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + DeleteLabelPermissionRequest messages must either be empty or match + this field. + type: boolean + description: Deletes one of more Label Permissions. + GoogleAppsDriveLabelsV2ListLabelsResponse: + id: GoogleAppsDriveLabelsV2ListLabelsResponse + properties: + nextPageToken: + type: string + description: The token of the next page in the response. + labels: + description: Labels. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + type: array + description: Response for listing Labels. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities: + type: object + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities + description: The capabilities related to this choice on applied metadata. + properties: + canSelect: + type: boolean + description: Whether the user can select this choice on an item. + canSearch: + type: boolean + description: Whether the user can use this choice in search queries. + canRead: + description: Whether the user can read related applied metadata on items. + type: boolean + GoogleAppsDriveLabelsV2FieldProperties: + properties: + required: + description: Whether the field should be marked as required. + type: boolean + displayName: + type: string + description: Required. The display text to show in the UI identifying this field. + insertBeforeField: + type: string + description: >- + Input only. Insert or move this field before the indicated field. If + empty, the field is placed at the end of the list. + type: object + id: GoogleAppsDriveLabelsV2FieldProperties + description: The basic properties of the field. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse: + type: object + description: Response following Field delete. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse + properties: {} + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse: + properties: {} + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse + description: Response following update to Field type. + GoogleAppsDriveLabelsV2FieldAppliedCapabilities: + id: GoogleAppsDriveLabelsV2FieldAppliedCapabilities + description: The capabilities related to this field on applied metadata. + type: object + properties: + canSearch: + type: boolean + description: Whether the user can search for Drive items referencing this field. + canWrite: + type: boolean + description: Whether the user can set this field on Drive items. + canRead: + type: boolean + description: Whether the user can read related applied metadata on items. + GoogleAppsDriveLabelsV2FieldSchemaCapabilities: + properties: + canUpdate: + type: boolean + description: Whether the user can change this field. + canDisable: + type: boolean + description: >- + Whether the user can disable this field. The user must have + permission and this field must not already be disabled. + canDelete: + type: boolean + description: >- + Whether the user can delete this field. The user must have + permission and the field must be deprecated. + canEnable: + description: >- + Whether the user can enable this field. The user must have + permission and this field must be disabled. + type: boolean + description: The capabilities related to this field when editing the field. + id: GoogleAppsDriveLabelsV2FieldSchemaCapabilities + type: object + GoogleAppsDriveLabelsV2UserLimits: + description: Limits for Field.Type.USER. + id: GoogleAppsDriveLabelsV2UserLimits + properties: + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLimits' + description: Limits for list-variant of a Field type. + type: object + GoogleAppsDriveLabelsV2ListLabelLocksResponse: + description: The response to a ListLabelLocksRequest. + id: GoogleAppsDriveLabelsV2ListLabelLocksResponse + properties: + nextPageToken: + type: string + description: The token of the next page in the response. + labelLocks: + description: LabelLocks. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLock' + type: array + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse: + properties: + priority: + format: int32 + description: >- + The priority of the updated field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + type: integer + description: Response following update to Field properties. + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse + type: object + GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest: + type: object + id: GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest + description: >- + Updates a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + properties: + parent: + description: Required. The parent Label resource name. + type: string + labelPermission: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + description: Required. The permission to create or update on the Label. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + GoogleAppsDriveLabelsV2EnableLabelRequest: + properties: + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + description: Request to enable a label. + id: GoogleAppsDriveLabelsV2EnableLabelRequest + type: object + GoogleAppsDriveLabelsV2LockStatus: + id: GoogleAppsDriveLabelsV2LockStatus + properties: + locked: + type: boolean + readOnly: true + description: >- + Output only. Indicates whether this label component is the (direct) + target of a LabelLock. A label component can be implicitly locked + even if it's not the direct target of a LabelLock, in which case + this field is set to false. + description: >- + Contains information about whether a label component should be + considered locked. + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest: + properties: + properties: + description: Required. Label properties to update. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelProperties' + updateMask: + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `label_properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest + description: Updates basic properties of a Label. + type: object + GoogleAppsDriveLabelsV2DateLimits: + type: object + properties: + maxValue: + description: Maximum value for the date Field type. + $ref: '#/components/schemas/GoogleTypeDate' + minValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: Minimum value for the date Field type. + id: GoogleAppsDriveLabelsV2DateLimits + description: Limits for date Field type. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse + type: object + description: Response following Choice delete. + properties: {} + GoogleProtobufEmpty: + type: object + properties: {} + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: GoogleProtobufEmpty + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Request to update Field properties. + properties: + updateMask: + type: string + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldProperties' + description: Required. Basic Field properties. + id: + description: Required. The Field to update. + type: string + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest + type: object + description: Request to create a Field within a Label. + properties: + field: + description: Required. Field to create. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Field' + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints: + properties: + disabled: + description: Whether the option should be shown in the UI as disabled. + type: boolean + hiddenInSearch: + type: boolean + description: >- + This option should be hidden in the search menu when searching for + Drive items. + badgePriority: + description: >- + The priority of this badge. Used to compare and sort between + multiple badges. A lower number means the badge should be shown + first. When a badging configuration is not present, this will be 0. + Otherwise, this will be set to `BadgeConfig.priority_override` or + the default heuristic which prefers creation date of the label, and + field and option priority. + format: int64 + type: string + badgeColors: + description: >- + The colors to use for the badge. Changed to Google Material colors + based on the chosen `properties.badge_config.color`. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeColors' + darkBadgeColors: + description: >- + The dark-mode color to use for the badge. Changed to Google Material + colors based on the chosen `properties.badge_config.color`. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2BadgeColors' + shownInApply: + description: >- + This option should be shown in the apply menu when applying values + to a Drive item. + type: boolean + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints + description: UI display hints for rendering an option. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities: + properties: + canUpdate: + description: Whether the user can update this choice. + type: boolean + canDisable: + description: Whether the user can disable this choice. + type: boolean + canDelete: + type: boolean + description: Whether the user can delete this choice. + canEnable: + type: boolean + description: Whether the user can enable this choice. + type: object + id: GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities + description: The capabilities related to this choice when editing the choice. + GoogleAppsDriveLabelsV2UserCapabilities: + type: object + id: GoogleAppsDriveLabelsV2UserCapabilities + description: The capabilities of a user. + properties: + canAdministrateLabels: + description: >- + Output only. Whether the user is an administrator for the shared + labels feature. + readOnly: true + type: boolean + canCreateSharedLabels: + readOnly: true + description: >- + Output only. Whether the user is allowed to create new shared + labels. + type: boolean + canCreateAdminLabels: + type: boolean + readOnly: true + description: Output only. Whether the user is allowed to create new admin labels. + canAccessLabelManager: + type: boolean + readOnly: true + description: >- + Output only. Whether the user is allowed access to the label + manager. + name: + description: Output only. Resource name for the user capabilities. + type: string + readOnly: true + GoogleAppsDriveLabelsV2FieldTextOptions: + type: object + id: GoogleAppsDriveLabelsV2FieldTextOptions + description: Options for the Text field type. + properties: + maxLength: + type: integer + format: int32 + description: Output only. The maximum valid length of values for the text field. + readOnly: true + minLength: + description: Output only. The minimum valid length of values for the text field. + format: int32 + readOnly: true + type: integer + GoogleAppsDriveLabelsV2Label: + description: >- + A label defines a taxonomy that can be applied to Drive items in order + to organize and search across items. Labels can be simple strings, or + can contain fields that describe additional metadata that can be further + used to organize and search Drive items. + id: GoogleAppsDriveLabelsV2Label + properties: + appliedCapabilities: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelAppliedCapabilities' + description: >- + Output only. The capabilities related to this label on applied + metadata. + readOnly: true + publishTime: + description: >- + Output only. The time this label was published. This value has no + meaning when the label is not published. + format: google-datetime + type: string + readOnly: true + revisionCreator: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who created this label revision. + disabler: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: >- + Output only. The user who disabled this label. This value has no + meaning when the label is not disabled. + readOnly: true + id: + type: string + description: >- + Output only. Globally unique identifier of this label. ID makes up + part of the label `name`, but unlike `name`, ID is consistent + between revisions. Matches the regex: `([a-zA-Z0-9])+` + readOnly: true + revisionId: + type: string + readOnly: true + description: >- + Output only. Revision ID of the label. Revision ID might be part of + the label `name` depending on the request issued. A new revision is + created whenever revisioned properties of a label are changed. + Matches the regex: `([a-zA-Z0-9])+` + creator: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who created this label. + lifecycle: + description: >- + Output only. The lifecycle state of the label including whether it's + published, deprecated, and has draft changes. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' + readOnly: true + appliedLabelPolicy: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy' + readOnly: true + description: >- + Output only. Behavior of this label when it's applied to Drive + items. + schemaCapabilities: + description: Output only. The capabilities the user has on this label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelSchemaCapabilities' + displayHints: + description: Output only. UI display hints for rendering the label. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelDisplayHints' + readOnly: true + labelType: + type: string + enumDescriptions: + - Unknown label type. + - Shared labels may be shared with users to apply to Drive items. + - >- + Admin-owned label. Only creatable and editable by admins. Supports + some additional admin-only features. + - >- + A label owned by an internal Google application rather than a + customer. These labels are read-only. + enum: + - LABEL_TYPE_UNSPECIFIED + - SHARED + - ADMIN + - GOOGLE_APP + description: Required. The type of label. + revisionCreateTime: + format: google-datetime + description: Output only. The time this label revision was created. + readOnly: true + type: string + customer: + type: string + readOnly: true + description: >- + Output only. The customer this label belongs to. For example: + "customers/123abc789." + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelProperties' + description: Required. The basic properties of the label. + name: + readOnly: true + description: >- + Output only. Resource name of the label. Will be in the form of + either: `labels/{id}` or `labels/{id}@{revision_id}` depending on + the request. See `id` and `revision_id` below. + type: string + disableTime: + format: google-datetime + readOnly: true + description: >- + Output only. The time this label was disabled. This value has no + meaning when the label is not disabled. + type: string + createTime: + format: google-datetime + readOnly: true + description: Output only. The time this label was created. + type: string + learnMoreUri: + type: string + description: >- + Custom URL to present to users to allow them to learn more about + this label and how it should be used. + fields: + type: array + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Field' + description: List of fields in descending priority order. + lockStatus: + description: Output only. The LockStatus of this label. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' + readOnly: true + publisher: + description: >- + Output only. The user who published this label. This value has no + meaning when the label is not published. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + type: object + GoogleAppsDriveLabelsV2IntegerLimits: + type: object + id: GoogleAppsDriveLabelsV2IntegerLimits + properties: + minValue: + type: string + description: Minimum value for an integer Field type. + format: int64 + maxValue: + format: int64 + description: Maximum value for an integer Field type. + type: string + description: Limits for integer Field type. + GoogleAppsDriveLabelsV2FieldDateOptions: + properties: + minValue: + description: Output only. Minimum valid value (year, month, day). + readOnly: true + $ref: '#/components/schemas/GoogleTypeDate' + dateFormat: + readOnly: true + description: Output only. ICU date format. + type: string + dateFormatType: + type: string + description: >- + Localized date formatting option. Field values are rendered in this + format according to their locale. + enumDescriptions: + - Date format unspecified. + - >- + Includes full month name. For example, January 12, 1999 (MMMM d, + y) + - Short, numeric, representation. For example, 12/13/99 (M/d/yy) + enum: + - DATE_FORMAT_UNSPECIFIED + - LONG_DATE + - SHORT_DATE + maxValue: + description: Output only. Maximum valid value (year, month, day). + readOnly: true + $ref: '#/components/schemas/GoogleTypeDate' + id: GoogleAppsDriveLabelsV2FieldDateOptions + description: Options for the date field type. + type: object + GoogleAppsDriveLabelsV2FieldSelectionOptions: + type: object + description: Options for the selection field type. + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldListOptions' + description: >- + When specified, indicates this field supports a list of values. Once + the field is published, this cannot be changed. + choices: + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice + description: >- + The options available for this selection field. The list order is + consistent, and modified with `insert_before_choice`. + id: GoogleAppsDriveLabelsV2FieldSelectionOptions + GoogleAppsDriveLabelsV2UserInfo: + type: object + properties: + person: + type: string + description: >- + The identifier for this user that can be used with the People API to + get more information. For example, people/12345678. + id: GoogleAppsDriveLabelsV2UserInfo + description: Information about a user. + GoogleAppsDriveLabelsV2LabelAppliedCapabilities: + id: GoogleAppsDriveLabelsV2LabelAppliedCapabilities + type: object + description: The capabilities a user has on this label's applied metadata. + properties: + canRemove: + type: boolean + description: Whether the user can remove this label from items. + canApply: + type: boolean + description: Whether the user can apply this label to items. + canRead: + type: boolean + description: Whether the user can read applied metadata related to this label. + GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse: + description: Response for updating one or more Label Permissions. + type: object + properties: + permissions: + description: Required. Permissions updated. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + type: array + id: GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse + GoogleAppsDriveLabelsV2WriteControl: + description: >- + Provides control over how write requests are executed. When not + specified, the last write wins. + properties: + requiredRevisionId: + type: string + description: >- + The revision_id of the label that the write request will be applied + to. If this is not the latest revision of the label, the request + will not be processed and will return a 400 Bad Request error. + id: GoogleAppsDriveLabelsV2WriteControl + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse: + properties: {} + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse + description: Response following Choice disable. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse: + properties: + priority: + format: int32 + type: integer + description: >- + The priority of the created field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + id: + type: string + description: >- + The field of the created field. When left blank in a create request, + a key will be autogenerated and can be identified here. + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse + description: Response following Field create. + type: object + GoogleAppsDriveLabelsV2ListLabelPermissionsResponse: + type: object + description: Response for listing the permissions on a Label. + properties: + nextPageToken: + description: The token of the next page in the response. + type: string + labelPermissions: + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + type: array + description: Label permissions. + id: GoogleAppsDriveLabelsV2ListLabelPermissionsResponse + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse + description: Response following Selection Choice create. + properties: + fieldId: + description: The server-generated id of the field. + type: string + id: + description: The server-generated ID of the created choice within the Field + type: string + GoogleAppsDriveLabelsV2TextLimits: + id: GoogleAppsDriveLabelsV2TextLimits + properties: + maxLength: + description: Maximum length allowed for a text Field type. + format: int32 + type: integer + minLength: + type: integer + format: int32 + description: Minimum length allowed for a text Field type. + type: object + description: Limits for text Field type. + GoogleAppsDriveLabelsV2FieldIntegerOptions: + description: Options for the Integer field type. + id: GoogleAppsDriveLabelsV2FieldIntegerOptions + type: object + properties: + maxValue: + type: string + description: Output only. The maximum valid value for the integer field. + readOnly: true + format: int64 + minValue: + format: int64 + type: string + readOnly: true + description: Output only. The minimum valid value for the integer field. + GoogleAppsDriveLabelsV2LabelSchemaCapabilities: + properties: + canUpdate: + description: Whether the user can change this label. + type: boolean + canEnable: + type: boolean + description: >- + Whether the user can enable this label. The user must have + permission and this label must be disabled. + canDisable: + description: >- + Whether the user can disable this label. The user must have + permission and this label must not already be disabled. + type: boolean + canDelete: + type: boolean + description: >- + Whether the user can delete this label. The user must have + permission and the label must be disabled. + id: GoogleAppsDriveLabelsV2LabelSchemaCapabilities + type: object + description: The capabilities related to this label when editing the label. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + properties: + priority: + format: int32 + type: integer + description: >- + The priority of the updated choice. The priority may change from + what was specified to assure contiguous priorities between choices + (1-n). + type: object + description: Response following update to Selection Choice properties. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse: + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse + properties: + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse + description: Update Field type and/or type options. + enableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse + description: Enables a Choice within a Selection Field. + updateField: + description: Updates basic properties of a Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse + description: Deletes a Field from the label. + updateLabel: + description: Updated basic properties of a Label. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse + deleteSelectionChoice: + description: Deletes a Choice from a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse + description: Enables Field. + createSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse + description: Creates a new selection list option to add to a Selection Field. + disableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse + description: Disables Field. + updateSelectionChoiceProperties: + description: Updates a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + disableSelectionChoice: + description: Disables a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse + createField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse + description: Creates a new Field. + description: A single response from an update. + GoogleAppsDriveLabelsV2LabelDisplayHints: + description: UI display hints for rendering the label. + properties: + priority: + type: string + description: Order to display label in a list. + format: int64 + disabled: + type: boolean + description: Whether the label should be shown in the UI as disabled. + shownInApply: + description: >- + This label should be shown in the apply menu when applying values to + a Drive item. + type: boolean + hiddenInSearch: + description: >- + This label should be hidden in the search menu when searching for + Drive items. + type: boolean + type: object + id: GoogleAppsDriveLabelsV2LabelDisplayHints + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest: + properties: + id: + description: Required. Key of the Field to disable. + type: string + updateMask: + type: string + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + disabledPolicy: + description: Required. Field Disabled Policy. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest + description: Request to disable the Field. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest + description: Request to create a Selection Choice. + properties: + choice: + description: Required. The Choice to create. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice + fieldId: + description: Required. The Selection Field in which a Choice will be created. + type: string + GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy: + id: GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy + properties: + copyMode: + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + type: string + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + description: >- + Indicates how the applied label and field values should be copied + when a Drive item is copied. + type: object + description: Behavior of this label when it's applied to Drive items. + GoogleAppsDriveLabelsV2FieldDisplayHints: + description: UI display hints for rendering a field. + type: object + id: GoogleAppsDriveLabelsV2FieldDisplayHints + properties: + shownInApply: + description: >- + This field should be shown in the apply menu when applying values to + a Drive item. + type: boolean + required: + type: boolean + description: Whether the field should be shown as required in the UI. + hiddenInSearch: + type: boolean + description: >- + This field should be hidden in the search menu when searching for + Drive items. + disabled: + type: boolean + description: Whether the field should be shown in the UI as disabled. + GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest: + description: >- + Deletes a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + id: GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest + properties: + name: + description: Required. Label Permission resource name. + type: string + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse + description: Response following Field enable. + properties: {} + type: object + GoogleAppsDriveLabelsV2DisableLabelRequest: + type: object + properties: + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + type: string + writeControl: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + disabledPolicy: + description: Disabled policy to use. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + description: Request to deprecate a published Label. + id: GoogleAppsDriveLabelsV2DisableLabelRequest + GoogleAppsDriveLabelsV2LabelPermission: + id: GoogleAppsDriveLabelsV2LabelPermission + properties: + group: + type: string + description: Group resource name. + role: + description: The role the principal should have. + enum: + - LABEL_ROLE_UNSPECIFIED + - READER + - APPLIER + - ORGANIZER + - EDITOR + enumDescriptions: + - Unknown role. + - >- + A reader can read the label and associated metadata applied to + Drive items. + - >- + An applier can write associated metadata on Drive items in which + they also have write access to. Implies `READER`. + - >- + An organizer can pin this label in shared drives they manage and + add new appliers to the label. + - >- + Editors can make any update including deleting the label which + also deletes the associated Drive item metadata. Implies + `APPLIER`. + type: string + person: + type: string + description: Person resource name. + audience: + type: string + description: >- + Audience to grant a role to. The magic value of `audiences/default` + may be used to apply the role to the default audience in the context + of the organization that owns the Label. + email: + type: string + description: >- + Specifies the email address for a user or group pricinpal. Not + populated for audience principals. User and Group permissions may + only be inserted using email address. On update requests, if email + address is specified, no principal should be specified. + name: + description: Resource name of this permission. + type: string + type: object + description: >- + The permission that applies to a principal (user, group, audience) on a + label. + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest + properties: + fieldId: + description: Required. The Selection Field in which a Choice will be enabled. + type: string + id: + type: string + description: Required. Choice to enable. + description: Request to enable a Choice. + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest: + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest + description: A single kind of update to apply to a Label. + properties: + deleteSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest + description: Delete a Choice within a Selection Field. + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest + description: Update Field type and/or type options. + enableSelectionChoice: + description: Enable a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest + description: Enables the Field. + disableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest + description: Disables the Field. + updateSelectionChoiceProperties: + description: Update a Choice properties within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest + description: Deletes a Field from the label. + updateField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Updates basic properties of a Field. + disableSelectionChoice: + description: Disable a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest + createField: + description: Creates a new Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest + updateLabel: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest + description: Updates the Label properties. + createSelectionChoice: + description: Creates Choice within a Selection field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest + GoogleAppsDriveLabelsV2LabelLock: + properties: + createTime: + readOnly: true + type: string + description: Output only. The time this LabelLock was created. + format: google-datetime + capabilities: + description: Output only. The user's capabilities on this LabelLock. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLockCapabilities' + fieldId: + type: string + description: >- + The ID of the Field that should be locked. Empty if the whole Label + should be locked. + name: + description: Output only. Resource name of this LabelLock. + readOnly: true + type: string + choiceId: + type: string + description: >- + The ID of the Selection Field Choice that should be locked. If + present, `field_id` must also be present. + state: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETING + enumDescriptions: + - Unknown state. + - The LabelLock is active and is being enforced by the server. + - >- + The LabelLock is being deleted. The LabelLock will continue to be + enforced by the server until it has been fully removed. + readOnly: true + type: string + description: Output only. This LabelLock's state. + creator: + description: >- + Output only. The user whose credentials were used to create the + LabelLock. This will not be present if no user was responsible for + creating the LabelLock. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + deleteTime: + readOnly: true + type: string + description: >- + Output only. A timestamp indicating when this LabelLock was + scheduled for deletion. This will be present only if this LabelLock + is in the DELETING state. + format: google-datetime + description: A Lock that can be applied to a Label, Field, or Choice. + id: GoogleAppsDriveLabelsV2LabelLock + type: object + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest: + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest + description: Request to delete the Field. + type: object + properties: + id: + description: Required. ID of the Field to delete. + type: string + GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest: + properties: + copyMode: + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + type: string + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + description: >- + Required. Indicates how the applied Label, and Field values should + be copied when a Drive item is copied. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + view: + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + type: string + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + description: >- + Request to update the `CopyMode` of the given Label. Changes to this + policy are not revisioned, do not require publishing, and take effect + immediately. \ + type: object + id: GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest + GoogleAppsDriveLabelsV2Field: + description: >- + Defines a field that has a display name, data type, and other + configuration options. This field defines the kind of metadata that may + be set on a Drive item. + type: object + properties: + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldUserOptions' + description: User field options. + creator: + description: Output only. The user who created this field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + selectionOptions: + description: Selection field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSelectionOptions' + lifecycle: + description: Output only. The lifecycle of this field. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Lifecycle' + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDateOptions' + description: Date field options. + integerOptions: + description: Integer field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldIntegerOptions' + disabler: + description: >- + Output only. The user who disabled this field. This value has no + meaning when the field is not disabled. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + readOnly: true + publisher: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: >- + Output only. The user who published this field. This value has no + meaning when the field is not published. + lockStatus: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LockStatus' + description: Output only. The LockStatus of this field. + readOnly: true + disableTime: + readOnly: true + format: google-datetime + description: >- + Output only. The time this field was disabled. This value has no + meaning when the field is not disabled. + type: string + appliedCapabilities: + readOnly: true + description: >- + Output only. The capabilities this user has on this field and its + value when the label is applied on Drive items. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldAppliedCapabilities' + schemaCapabilities: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldSchemaCapabilities' + description: Output only. The capabilities this user has when editing this field. + readOnly: true + queryKey: + type: string + description: >- + Output only. The key to use when constructing Drive search queries + to find files based on values defined for this field on files. For + example, "`{query_key}` > 2001-01-01". + readOnly: true + id: + description: >- + Output only. The key of a field, unique within a label or library. + This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+` + readOnly: true + type: string + createTime: + type: string + readOnly: true + description: Output only. The time this field was created. + format: google-datetime + displayHints: + description: Output only. UI display hints for rendering a field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldDisplayHints' + readOnly: true + textOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldTextOptions' + description: Text field options. + updater: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserInfo' + description: Output only. The user who modified this field. + readOnly: true + updateTime: + readOnly: true + description: Output only. The time this field was updated. + format: google-datetime + type: string + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2FieldProperties' + description: The basic properties of the field. + id: GoogleAppsDriveLabelsV2Field + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest: + description: >- + The set of requests for updating aspects of a Label. If any request is + not valid, no requests will be applied. + type: object + id: GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest + properties: + requests: + description: >- + A list of updates to apply to the Label. Requests will be applied in + the order they are specified. + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest + type: array + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + writeControl: + description: Provides control over how write requests are executed. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2WriteControl' + view: + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + type: string + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized Field + labels when `include_label_in_response` is `true`. + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse: + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse + description: Response following update to Label properties. + type: object + properties: {} + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest: + description: Request to disable a Choice. + properties: + fieldId: + type: string + description: Required. The Selection Field in which a Choice will be disabled. + disabledPolicy: + description: Required. The disabled policy to update. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LifecycleDisabledPolicy' + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + id: + description: Required. Choice to disable. + type: string + type: object + id: >- + GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest + parameters: + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + x-stackQL-resources: + limits_label: + id: googleworkspace.drivelabelsv2.limits_label + name: limits_label + title: Limits_label + methods: + get_label: + operation: + $ref: '#/paths/~1v2~1limits~1label/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/limits_label/methods/get_label' + insert: [] + update: [] + replace: [] + delete: [] + users_capabilities: + id: googleworkspace.drivelabelsv2.users_capabilities + name: users_capabilities + title: Users_capabilities + methods: + get_capabilities: + operation: + $ref: '#/paths/~1v2~1users~1{usersId}~1capabilities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/users_capabilities/methods/get_capabilities + insert: [] + update: [] + replace: [] + delete: [] + labels_label_copy_mode: + id: googleworkspace.drivelabelsv2.labels_label_copy_mode + name: labels_label_copy_mode + title: Labels_label_copy_mode + methods: + update_label_copy_mode: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:updateLabelCopyMode/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_label_copy_mode/methods/update_label_copy_mode + replace: [] + delete: [] + labels: + id: googleworkspace.drivelabelsv2.labels + name: labels + title: Labels + methods: + enable: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1v2~1labels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v2~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labels + publish: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:publish/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delta: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:delta/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}:disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/labels/methods/get' + - $ref: '#/components/x-stackQL-resources/labels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/delete' + labels_permissions: + id: googleworkspace.drivelabelsv2.labels_permissions + name: labels_permissions + title: Labels_permissions + methods: + update_permissions: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}~1permissions/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_permissions/methods/update_permissions + replace: [] + delete: [] + permissions: + id: googleworkspace.drivelabelsv2.permissions + name: permissions + title: Permissions + methods: + list: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelPermissions + create: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + batch_update: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions:batchUpdate/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions~1{permissionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + batch_delete: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions:batchDelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_delete' + revisions_permissions: + id: googleworkspace.drivelabelsv2.revisions_permissions + name: revisions_permissions + title: Revisions_permissions + methods: + update_permissions: + operation: + $ref: >- + #/paths/~1v2~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_permissions/methods/update_permissions + replace: [] + delete: [] + locks: + id: googleworkspace.drivelabelsv2.locks + name: locks + title: Locks + methods: + list: + operation: + $ref: '#/paths/~1v2~1labels~1{labelsId}~1locks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelLocks + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locks/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2/limits/label: + parameters: &ref_1 + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + get: + description: >- + Get the constraints on the structure of a Label; such as, the maximum + number of Fields allowed and maximum length of the label title. + operationId: drivelabels.limits.getLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelLimits' + parameters: + - in: query + name: name + schema: + type: string + /v2/users/{usersId}/capabilities: + parameters: *ref_1 + get: + description: Gets the user capabilities. + operationId: drivelabels.users.getCapabilities + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2UserCapabilities' + parameters: + - in: path + name: usersId + required: true + schema: + type: string + - in: query + name: customer + schema: + type: string + /v2/labels/{labelsId}:updateLabelCopyMode: + parameters: *ref_1 + post: + description: >- + Updates a Label's `CopyMode`. Changes to this policy are not revisioned, + do not require publishing, and take effect immediately. + operationId: drivelabels.labels.updateLabelCopyMode + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}:enable: + parameters: *ref_1 + post: + description: >- + Enable a disabled Label and restore it to its published state. This will + result in a new published revision based on the current disabled + published revision. If there is an existing disabled draft revision, a + new revision will be created based on that draft and will be enabled. + operationId: drivelabels.labels.enable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2EnableLabelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels: + parameters: *ref_1 + post: + description: Creates a new Label. + operationId: drivelabels.labels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: languageCode + schema: + type: string + get: + description: List labels. + operationId: drivelabels.labels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2ListLabelsResponse' + parameters: + - in: query + name: customer + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: view + schema: + type: string + - in: query + name: minimumRole + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: publishedOnly + schema: + type: boolean + /v2/labels/{labelsId}:publish: + parameters: *ref_1 + post: + description: >- + Publish all draft changes to the Label. Once published, the Label may + not return to its draft state. See + `google.apps.drive.labels.v2.Lifecycle` for more information. Publishing + a Label will result in a new published revision. All previous draft + revisions will be deleted. Previous published revisions will be kept but + are subject to automated deletion as needed. Once published, some + changes are no longer permitted. Generally, any change that would + invalidate or cause new restrictions on existing metadata related to the + Label will be rejected. For example, the following changes to a Label + will be rejected after the Label is published: * The label cannot be + directly deleted. It must be disabled first, then deleted. * + Field.FieldType cannot be changed. * Changes to Field validation options + cannot reject something that was previously accepted. * Reducing the max + entries. + operationId: drivelabels.labels.publish + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2PublishLabelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}:delta: + parameters: *ref_1 + post: + description: >- + Updates a single Label by applying a set of update requests resulting in + a new draft revision. The batch update is all-or-nothing: If any of the + update requests are invalid, no changes are applied. The resulting draft + revision must be published before the changes may be used with Drive + Items. + operationId: drivelabels.labels.delta + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/permissions: + parameters: *ref_1 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a Label and related metadata on Drive Items. Once + deleted, the Label and related Drive item metadata will be deleted. Only + draft Labels, and disabled Labels may be deleted. + operationId: drivelabels.labels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: writeControl.requiredRevisionId + schema: + type: string + get: + description: >- + Get a label by its resource name. Resource name may be any of: * + `labels/{id}` - See `labels/{id}@latest` * `labels/{id}@latest` - Gets + the latest revision of the label. * `labels/{id}@published` - Gets the + current published revision of the label. * `labels/{id}@{revision_id}` - + Gets the label at the specified revision ID. + operationId: drivelabels.labels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: languageCode + schema: + type: string + - in: query + name: view + schema: + type: string + /v2/labels/{labelsId}:disable: + parameters: *ref_1 + post: + description: >- + Disable a published Label. Disabling a Label will result in a new + disabled published revision based on the current published revision. If + there is a draft revision, a new disabled draft revision will be created + based on the latest draft revision. Older draft revisions will be + deleted. Once disabled, a label may be deleted with `DeleteLabel`. + operationId: drivelabels.labels.disable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2DisableLabelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2Label' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions: + parameters: *ref_1 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.revisions.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: useAdminAccess + schema: + type: boolean + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2LabelPermission' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}/revisions/{revisionsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.revisions.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2/labels/{labelsId}/revisions/{revisionsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2/labels/{labelsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2ListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml new file mode 100644 index 00000000..acd7f346 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivelabelsv2beta.yaml @@ -0,0 +1,3415 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Drive Labels API + description: An API for managing Drive Labels + version: v2beta + x-discovery-doc-revision: '20241204' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/labels +servers: + - url: https://drivelabels.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive.admin.labels.readonly: >- + See all Google Drive labels and label-related admin policies in + your organization + https://www.googleapis.com/auth/drive.labels: See, edit, create, and delete your Google Drive labels + https://www.googleapis.com/auth/drive.admin.labels: >- + See, edit, create, and delete all Google Drive labels in your + organization, and see your organization's label-related admin + policies + https://www.googleapis.com/auth/drive.labels.readonly: See your Google Drive labels + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse: + id: GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse + description: Response for updating one or more Label Permissions. + properties: + permissions: + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + type: array + description: Required. Permissions updated. + type: object + GoogleAppsDriveLabelsV2betaFieldSchemaCapabilities: + id: GoogleAppsDriveLabelsV2betaFieldSchemaCapabilities + description: The capabilities related to this field when editing the field. + type: object + properties: + canDelete: + type: boolean + description: >- + Whether the user can delete this field. The user must have + permission and the field must be deprecated. + canDisable: + description: >- + Whether the user can disable this field. The user must have + permission and this field must not already be disabled. + type: boolean + canUpdate: + type: boolean + description: Whether the user can change this field. + canEnable: + type: boolean + description: >- + Whether the user can enable this field. The user must have + permission and this field must be disabled. + GoogleAppsDriveLabelsV2betaDeleteLabelPermissionRequest: + description: >- + Deletes a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + properties: + name: + type: string + description: Required. Label Permission resource name. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + id: GoogleAppsDriveLabelsV2betaDeleteLabelPermissionRequest + type: object + GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy: + type: object + properties: + showInApply: + description: >- + Whether to show this disabled object in the apply menu on Drive + items. * When `true`, the object is generally shown in the UI as + disabled and is unselectable. * When `false`, the object is + generally hidden in the UI. + type: boolean + hideInSearch: + type: boolean + description: >- + Whether to hide this disabled object in the search menu for Drive + items. * When `false`, the object is generally shown in the UI as + disabled but it appears in the search results when searching for + Drive items. * When `true`, the object is generally hidden in the UI + when searching for Drive items. + id: GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: >- + The policy that governs how to treat a disabled label, field, or + selection choice in different contexts. + GoogleAppsDriveLabelsV2betaListLimits: + type: object + properties: + maxEntries: + description: Maximum number of values allowed for the Field type. + type: integer + format: int32 + id: GoogleAppsDriveLabelsV2betaListLimits + description: Limits for list-variant of a Field type. + GoogleAppsDriveLabelsV2betaUpdateLabelCopyModeRequest: + id: GoogleAppsDriveLabelsV2betaUpdateLabelCopyModeRequest + type: object + description: >- + Request to update the `CopyMode` of the given Label. Changes to this + policy are not revisioned, do not require publishing, and take effect + immediately. \ + properties: + view: + type: string + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + copyMode: + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + description: >- + Required. Indicates how the applied Label, and Field values should + be copied when a Drive item is copied. + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + type: string + languageCode: + type: string + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + GoogleAppsDriveLabelsV2betaDisableLabelRequest: + properties: + updateMask: + format: google-fieldmask + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: Disabled policy to use. + type: object + description: Request to deprecate a published Label. + id: GoogleAppsDriveLabelsV2betaDisableLabelRequest + GoogleAppsDriveLabelsV2betaLabelLock: + type: object + description: A Lock that can be applied to a Label, Field, or Choice. + id: GoogleAppsDriveLabelsV2betaLabelLock + properties: + name: + readOnly: true + description: Output only. Resource name of this LabelLock. + type: string + capabilities: + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelLockCapabilities + description: Output only. The user's capabilities on this LabelLock. + fieldId: + type: string + description: >- + The ID of the Field that should be locked. Empty if the whole Label + should be locked. + createTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The time this LabelLock was created. + deleteTime: + format: google-datetime + readOnly: true + description: >- + Output only. A timestamp indicating when this LabelLock was + scheduled for deletion. This will be present only if this LabelLock + is in the DELETING state. + type: string + creator: + readOnly: true + description: >- + Output only. The user whose credentials were used to create the + LabelLock. This will not be present if no user was responsible for + creating the LabelLock. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + state: + enumDescriptions: + - Unknown state. + - The LabelLock is active and is being enforced by the server. + - >- + The LabelLock is being deleted. The LabelLock will continue to be + enforced by the server until it has been fully removed. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETING + description: Output only. This LabelLock's state. + readOnly: true + type: string + choiceId: + description: >- + The ID of the Selection Field Choice that should be locked. If + present, `field_id` must also be present. + type: string + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteSelectionChoiceRequest + properties: + fieldId: + description: Required. The Selection Field from which a Choice will be deleted. + type: string + id: + description: Required. Choice to delete. + type: string + description: Request to delete a Choice. + GoogleAppsDriveLabelsV2betaFieldDisplayHints: + properties: + disabled: + description: Whether the field should be shown in the UI as disabled. + type: boolean + required: + type: boolean + description: Whether the field should be shown as required in the UI. + hiddenInSearch: + description: >- + This field should be hidden in the search menu when searching for + Drive items. + type: boolean + shownInApply: + type: boolean + description: >- + This field should be shown in the apply menu when applying values to + a Drive item. + id: GoogleAppsDriveLabelsV2betaFieldDisplayHints + type: object + description: UI display hints for rendering a field. + GoogleAppsDriveLabelsV2betaListLabelsResponse: + type: object + properties: + labels: + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + type: array + description: Labels. + nextPageToken: + type: string + description: The token of the next page in the response. + description: Response for listing Labels. + id: GoogleAppsDriveLabelsV2betaListLabelsResponse + GoogleAppsDriveLabelsV2betaLockStatus: + properties: + locked: + readOnly: true + description: >- + Output only. Indicates whether this label component is the (direct) + target of a LabelLock. A label component can be implicitly locked + even if it's not the direct target of a LabelLock, in which case + this field is set to false. + type: boolean + type: object + id: GoogleAppsDriveLabelsV2betaLockStatus + description: >- + Contains information about whether a label component should be + considered locked. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableSelectionChoiceRequest: + description: Request to enable a Choice. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableSelectionChoiceRequest + type: object + properties: + id: + type: string + description: Required. Choice to enable. + fieldId: + description: Required. The Selection Field in which a Choice will be enabled. + type: string + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + description: Response following update to Selection Choice properties. + properties: + priority: + description: >- + The priority of the updated choice. The priority may change from + what was specified to assure contiguous priorities between choices + (1-n). + type: integer + format: int32 + GoogleAppsDriveLabelsV2betaUserLimits: + type: object + description: Limits for Field.Type.USER. + properties: + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaListLimits' + description: Limits for list-variant of a Field type. + id: GoogleAppsDriveLabelsV2betaUserLimits + GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse: + description: Response for listing the permissions on a Label. + id: GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse + type: object + properties: + nextPageToken: + type: string + description: The token of the next page in the response. + labelPermissions: + type: array + description: Label permissions. + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestRequest: + description: A single kind of update to apply to a Label. + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestRequest + properties: + deleteSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteSelectionChoiceRequest + description: Delete a Choice within a Selection Field. + updateLabel: + description: Updates the Label properties. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateLabelPropertiesRequest + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldTypeRequest + description: Update Field type and/or type options. + createField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateFieldRequest + description: Creates a new Field. + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteFieldRequest + description: Deletes a Field from the label. + updateField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Updates basic properties of a Field. + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableFieldRequest + description: Enables the Field. + disableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableSelectionChoiceRequest + description: Disable a Choice within a Selection Field. + enableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableSelectionChoiceRequest + description: Enable a Choice within a Selection Field. + disableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableFieldRequest + description: Disables the Field. + updateSelectionChoiceProperties: + description: Update a Choice properties within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + createSelectionChoice: + description: Creates Choice within a Selection field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateSelectionChoiceRequest + GoogleAppsDriveLabelsV2betaLifecycle: + description: >- + The lifecycle state of an object, such as label, field, or choice. The + lifecycle enforces the following transitions: * `UNPUBLISHED_DRAFT` + (starting state) * `UNPUBLISHED_DRAFT` -> `PUBLISHED` * + `UNPUBLISHED_DRAFT` -> (Deleted) * `PUBLISHED` -> `DISABLED` * + `DISABLED` -> `PUBLISHED` * `DISABLED` -> (Deleted) The published and + disabled states have some distinct characteristics: * Published—Some + kinds of changes might be made to an object in this state, in which case + `has_unpublished_changes` will be true. Also, some kinds of changes are + not permitted. Generally, any change that would invalidate or cause new + restrictions on existing metadata related to the label are rejected. * + Disabled—When disabled, the configured `DisabledPolicy` takes effect. + id: GoogleAppsDriveLabelsV2betaLifecycle + type: object + properties: + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: >- + The policy that governs how to show a disabled label, field, or + selection choice. + state: + enumDescriptions: + - Unknown State. + - >- + The initial state of an object. Once published, the object can + never return to this state. Once an object is published, certain + kinds of changes are no longer permitted. + - >- + The object has been published. The object might have unpublished + draft changes as indicated by `has_unpublished_changes`. + - >- + The object has been published and has since been disabled. The + object might have unpublished draft changes as indicated by + `has_unpublished_changes`. + - The object has been deleted. + enum: + - STATE_UNSPECIFIED + - UNPUBLISHED_DRAFT + - PUBLISHED + - DISABLED + - DELETED + readOnly: true + description: Output only. The state of the object associated with this lifecycle. + type: string + hasUnpublishedChanges: + description: >- + Output only. Whether the object associated with this lifecycle has + unpublished changes. + readOnly: true + type: boolean + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequest: + properties: + view: + type: string + description: >- + When specified, only certain fields belonging to the indicated view + will be returned. + enum: + - LABEL_VIEW_BASIC + - LABEL_VIEW_FULL + enumDescriptions: + - >- + Implies the field mask: + `name,id,revision_id,label_type,properties.*` + - All possible fields. + requests: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestRequest + description: >- + A list of updates to apply to the Label. Requests will be applied in + the order they are specified. + type: array + writeControl: + description: Provides control over how write requests are executed. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized Field + labels when `include_label_in_response` is `true`. + type: string + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequest + description: >- + The set of requests for updating aspects of a Label. If any request is + not valid, no requests will be applied. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseResponse: + properties: + updateLabel: + description: Updated basic properties of a Label. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateLabelPropertiesResponse + enableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableSelectionChoiceResponse + description: Enables a Choice within a Selection Field. + updateFieldType: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldTypeResponse + description: Update Field type and/or type options. + updateField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldPropertiesResponse + description: Updates basic properties of a Field. + updateSelectionChoiceProperties: + description: Updates a Choice within a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse + disableField: + description: Disables Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableFieldResponse + disableSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableSelectionChoiceResponse + description: Disables a Choice within a Selection Field. + createSelectionChoice: + description: Creates a new selection list option to add to a Selection Field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateSelectionChoiceResponse + createField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateFieldResponse + description: Creates a new Field. + deleteSelectionChoice: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteSelectionChoiceResponse + description: Deletes a Choice from a Selection Field. + deleteField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteFieldResponse + description: Deletes a Field from the label. + enableField: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableFieldResponse + description: Enables Field. + description: A single response from an update. + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseResponse + GoogleAppsDriveLabelsV2betaLabelLockCapabilities: + id: GoogleAppsDriveLabelsV2betaLabelLockCapabilities + description: A description of a user's capabilities on a LabelLock. + properties: + canViewPolicy: + type: boolean + description: True if the user is authorized to view the policy. + type: object + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice: + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice + description: Selection field choice. + properties: + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties + description: Basic properties of the choice. + publisher: + readOnly: true + description: >- + Output only. The user who published this choice. This value has no + meaning when the choice is not published. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + disableTime: + type: string + description: >- + Output only. The time this choice was disabled. This value has no + meaning when the choice is not disabled. + readOnly: true + format: google-datetime + updateTime: + format: google-datetime + description: Output only. The time this choice was updated last. + type: string + readOnly: true + updater: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: Output only. The user who updated this choice last. + publishTime: + readOnly: true + type: string + format: google-datetime + description: >- + Output only. The time this choice was published. This value has no + meaning when the choice is not published. + createTime: + type: string + readOnly: true + description: Output only. The time this choice was created. + format: google-datetime + id: + description: >- + The unique value of the choice. This ID is autogenerated. Matches + the regex: `([a-zA-Z0-9_])+`. + type: string + schemaCapabilities: + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceSchemaCapabilities + description: >- + Output only. The capabilities related to this option when editing + the option. + disabler: + readOnly: true + description: >- + Output only. The user who disabled this choice. This value has no + meaning when the option is not disabled. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + appliedCapabilities: + description: >- + Output only. The capabilities related to this choice on applied + metadata. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceAppliedCapabilities + readOnly: true + lifecycle: + description: Output only. Lifecycle of the choice. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLifecycle' + displayHints: + description: Output only. UI display hints for rendering a choice. + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceDisplayHints + creator: + description: Output only. The user who created this choice. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + readOnly: true + lockStatus: + description: Output only. The LockStatus of this choice. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLockStatus' + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldPropertiesResponse: + description: Response following update to Field properties. + properties: + priority: + description: >- + The priority of the updated field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + type: integer + format: int32 + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldPropertiesResponse + type: object + GoogleAppsDriveLabelsV2betaSelectionLimits: + properties: + maxChoices: + description: The max number of choices. + format: int32 + type: integer + listLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaListLimits' + description: Limits for list-variant of a Field type. + maxIdLength: + description: Maximum ID length for a selection options. + type: integer + format: int32 + maxDisplayNameLength: + type: integer + format: int32 + description: Maximum length for display name. + maxDeletedChoices: + description: Maximum number of deleted choices. + type: integer + format: int32 + type: object + description: Limits for selection Field type. + id: GoogleAppsDriveLabelsV2betaSelectionLimits + GoogleAppsDriveLabelsV2betaFieldListOptions: + id: GoogleAppsDriveLabelsV2betaFieldListOptions + properties: + maxEntries: + description: Maximum number of entries permitted. + format: int32 + type: integer + type: object + description: Options for a multi-valued variant of an associated field type. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest: + type: object + description: Request to update a Choice properties. + properties: + id: + description: Required. The Choice to update. + type: string + fieldId: + description: Required. The Selection Field to update. + type: string + properties: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties + description: Required. The Choice properties to update. + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceAppliedCapabilities: + type: object + description: The capabilities related to this choice on applied metadata. + id: >- + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceAppliedCapabilities + properties: + canRead: + description: Whether the user can read related applied metadata on items. + type: boolean + canSearch: + type: boolean + description: Whether the user can use this choice in search queries. + canSelect: + description: Whether the user can select this choice on an item. + type: boolean + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceSchemaCapabilities: + type: object + properties: + canUpdate: + type: boolean + description: Whether the user can update this choice. + canEnable: + type: boolean + description: Whether the user can enable this choice. + canDelete: + description: Whether the user can delete this choice. + type: boolean + canDisable: + type: boolean + description: Whether the user can disable this choice. + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceSchemaCapabilities + description: The capabilities related to this choice when editing the choice. + GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest: + type: object + properties: + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + UpdateLabelPermissionRequest messages must either be empty or match + this field. + requests: + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaUpdateLabelPermissionRequest + description: Required. The request message specifying the resources to update. + id: GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest + description: Updates one or more Label Permissions. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldPropertiesRequest: + type: object + properties: + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldProperties' + description: Required. Basic Field properties. + updateMask: + format: google-fieldmask + description: >- + The fields that should be updated. At least one field must be + specified. The root `properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + id: + type: string + description: Required. The Field to update. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldPropertiesRequest + description: Request to update Field properties. + GoogleAppsDriveLabelsV2betaDateLimits: + id: GoogleAppsDriveLabelsV2betaDateLimits + properties: + minValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: Minimum value for the date Field type. + maxValue: + description: Maximum value for the date Field type. + $ref: '#/components/schemas/GoogleTypeDate' + description: Limits for date Field type. + type: object + GoogleAppsDriveLabelsV2betaEnableLabelRequest: + type: object + description: Request to enable a label. + id: GoogleAppsDriveLabelsV2betaEnableLabelRequest + properties: + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableSelectionChoiceResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableSelectionChoiceResponse + description: Response following Choice disable. + properties: {} + GoogleAppsDriveLabelsV2betaField: + type: object + properties: + selectionOptions: + description: Selection field options. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptions + updateTime: + description: Output only. The time this field was updated. + type: string + readOnly: true + format: google-datetime + id: + type: string + readOnly: true + description: >- + Output only. The key of a field, unique within a label or library. + This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+` + integerOptions: + description: Integer field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldIntegerOptions' + publisher: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: >- + Output only. The user who published this field. This value has no + meaning when the field is not published. + lifecycle: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLifecycle' + readOnly: true + description: Output only. The lifecycle of this field. + lockStatus: + description: Output only. The LockStatus of this field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLockStatus' + readOnly: true + creator: + description: Output only. The user who created this field. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + properties: + description: The basic properties of the field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldProperties' + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldUserOptions' + description: User field options. + disableTime: + type: string + readOnly: true + description: >- + Output only. The time this field was disabled. This value has no + meaning when the field is not disabled. + format: google-datetime + textOptions: + description: Text field options. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldTextOptions' + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldDateOptions' + description: Date field options. + updater: + readOnly: true + description: Output only. The user who modified this field. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + displayHints: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldDisplayHints' + readOnly: true + description: Output only. UI display hints for rendering a field. + disabler: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: >- + Output only. The user who disabled this field. This value has no + meaning when the field is not disabled. + queryKey: + description: >- + Output only. The key to use when constructing Drive search queries + to find files based on values defined for this field on files. For + example, "`{query_key}` > 2001-01-01". + readOnly: true + type: string + schemaCapabilities: + description: Output only. The capabilities this user has when editing this field. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSchemaCapabilities + readOnly: true + appliedCapabilities: + readOnly: true + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldAppliedCapabilities + description: >- + Output only. The capabilities this user has on this field and its + value when the label is applied on Drive items. + createTime: + type: string + format: google-datetime + readOnly: true + description: Output only. The time this field was created. + id: GoogleAppsDriveLabelsV2betaField + description: >- + Defines a field that has a display name, data type, and other + configuration options. This field defines the kind of metadata that may + be set on a Drive item. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableSelectionChoiceRequest: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableSelectionChoiceRequest + description: Request to disable a Choice. + properties: + fieldId: + type: string + description: Required. The Selection Field in which a Choice will be disabled. + id: + description: Required. Choice to disable. + type: string + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + format: google-fieldmask + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: Required. The disabled policy to update. + GoogleAppsDriveLabelsV2betaFieldSelectionOptions: + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptions + description: Options for the selection field type. + type: object + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldListOptions' + description: >- + When specified, indicates this field supports a list of values. Once + the field is published, this cannot be changed. + choices: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice + type: array + description: >- + The options available for this selection field. The list order is + consistent, and modified with `insert_before_choice`. + GoogleAppsDriveLabelsV2betaLongTextLimits: + description: Limits for long text Field type. + properties: + maxLength: + type: integer + description: Maximum length allowed for a long text Field type. + format: int32 + minLength: + format: int32 + description: Minimum length allowed for a long text Field type. + type: integer + id: GoogleAppsDriveLabelsV2betaLongTextLimits + type: object + GoogleAppsDriveLabelsV2betaFieldProperties: + type: object + properties: + insertBeforeField: + type: string + description: >- + Input only. Insert or move this field before the indicated field. If + empty, the field is placed at the end of the list. + displayName: + type: string + description: Required. The display text to show in the UI identifying this field. + required: + description: Whether the field should be marked as required. + type: boolean + id: GoogleAppsDriveLabelsV2betaFieldProperties + description: The basic properties of the field. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateSelectionChoiceResponse: + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateSelectionChoiceResponse + type: object + properties: + fieldId: + description: The server-generated id of the field. + type: string + id: + description: The server-generated ID of the created choice within the Field + type: string + description: Response following Selection Choice create. + GoogleAppsDriveLabelsV2betaLabelLimits: + type: object + id: GoogleAppsDriveLabelsV2betaLabelLimits + properties: + maxDeletedFields: + type: integer + format: int32 + description: The maximum number of published Fields that can be deleted. + fieldLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldLimits' + description: The limits for Fields. + name: + type: string + description: Resource name. + maxDescriptionLength: + description: The maximum number of characters allowed for the description. + format: int32 + type: integer + maxFields: + type: integer + description: The maximum number of Fields allowed within the label. + format: int32 + maxDraftRevisions: + type: integer + description: >- + The maximum number of draft revisions that will be kept before + deleting old drafts. + format: int32 + maxTitleLength: + format: int32 + description: The maximum number of characters allowed for the title. + type: integer + description: >- + Label constraints governing the structure of a Label; such as, the + maximum number of Fields allowed and maximum length of the label title. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponse: + properties: + responses: + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseResponse + description: >- + The reply of the updates. This maps 1:1 with the updates, although + responses to some requests may be empty. + type: array + updatedLabel: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + description: >- + The label after updates were applied. This is only set if + [BatchUpdateLabelResponse2.include_label_in_response] is `true` and + there were no errors. + description: Response for Label update. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponse + type: object + GoogleAppsDriveLabelsV2betaBadgeConfig: + type: object + properties: + priorityOverride: + type: string + format: int64 + description: >- + Override the default global priority of this badge. When set to 0, + the default priority heuristic is used. + color: + description: >- + The color of the badge. When not specified, no badge is rendered. + The background, foreground, and solo (light and dark mode) colors + set here are changed in the Drive UI into the closest recommended + supported color. + $ref: '#/components/schemas/GoogleTypeColor' + id: GoogleAppsDriveLabelsV2betaBadgeConfig + description: Badge status of the label. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableFieldResponse: + properties: {} + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableFieldResponse + description: Response following Field enable. + GoogleAppsDriveLabelsV2betaFieldLimits: + id: GoogleAppsDriveLabelsV2betaFieldLimits + description: >- + Field constants governing the structure of a Field; such as, the maximum + title length, minimum and maximum field values or length, etc. + properties: + longTextLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLongTextLimits' + description: Long text Field limits. + dateLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaDateLimits' + description: Date Field limits. + maxDescriptionLength: + description: Limits for Field description, also called help text. + type: integer + format: int32 + maxIdLength: + description: Max length for the id. + type: integer + format: int32 + maxDisplayNameLength: + type: integer + format: int32 + description: Limits for Field title. + selectionLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaSelectionLimits' + description: Selection Field limits. + integerLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaIntegerLimits' + description: Integer Field limits. + userLimits: + description: User Field limits. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserLimits' + textLimits: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaTextLimits' + description: The relevant limits for the specified Field.Type. Text Field limits. + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldTypeResponse: + description: Response following update to Field type. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateFieldTypeResponse + type: object + properties: {} + GoogleTypeDate: + properties: + month: + format: int32 + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + year: + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + id: GoogleTypeDate + GoogleAppsDriveLabelsV2betaFieldIntegerOptions: + properties: + minValue: + description: Output only. The minimum valid value for the integer field. + readOnly: true + format: int64 + type: string + maxValue: + format: int64 + readOnly: true + type: string + description: Output only. The maximum valid value for the integer field. + description: Options for the Integer field type. + type: object + id: GoogleAppsDriveLabelsV2betaFieldIntegerOptions + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableSelectionChoiceResponse: + description: Response following Choice enable. + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseEnableSelectionChoiceResponse + properties: {} + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteFieldResponse: + description: Response following Field delete. + properties: {} + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteFieldResponse + GoogleAppsDriveLabelsV2betaLabelAppliedCapabilities: + id: GoogleAppsDriveLabelsV2betaLabelAppliedCapabilities + type: object + description: The capabilities a user has on this label's applied metadata. + properties: + canApply: + description: Whether the user can apply this label to items. + type: boolean + canRemove: + description: Whether the user can remove this label from items. + type: boolean + canRead: + type: boolean + description: Whether the user can read applied metadata related to this label. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableFieldRequest: + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDisableFieldRequest + description: Request to disable the Field. + type: object + properties: + id: + description: Required. Key of the Field to disable. + type: string + disabledPolicy: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLifecycleDisabledPolicy + description: Required. Field Disabled Policy. + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `disabled_policy` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + type: string + GoogleAppsDriveLabelsV2betaFieldDateOptions: + properties: + minValue: + readOnly: true + description: Output only. Minimum valid value (year, month, day). + $ref: '#/components/schemas/GoogleTypeDate' + dateFormat: + type: string + readOnly: true + description: Output only. ICU date format. + maxValue: + readOnly: true + description: Output only. Maximum valid value (year, month, day). + $ref: '#/components/schemas/GoogleTypeDate' + dateFormatType: + type: string + description: >- + Localized date formatting option. Field values are rendered in this + format according to their locale. + enumDescriptions: + - Date format unspecified. + - >- + Includes full month name. For example, January 12, 1999 (MMMM d, + y) + - Short, numeric, representation. For example, 12/13/99 (M/d/yy) + enum: + - DATE_FORMAT_UNSPECIFIED + - LONG_DATE + - SHORT_DATE + type: object + description: Options for the date field type. + id: GoogleAppsDriveLabelsV2betaFieldDateOptions + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateFieldRequest: + description: Request to create a Field within a Label. + properties: + field: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaField' + description: Required. Field to create. + type: object + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateFieldRequest + GoogleAppsDriveLabelsV2betaFieldTextOptions: + type: object + id: GoogleAppsDriveLabelsV2betaFieldTextOptions + properties: + maxLength: + description: Output only. The maximum valid length of values for the text field. + type: integer + readOnly: true + format: int32 + minLength: + format: int32 + type: integer + description: Output only. The minimum valid length of values for the text field. + readOnly: true + description: Options for the Text field type. + GoogleAppsDriveLabelsV2betaUserCapabilities: + properties: + name: + type: string + readOnly: true + description: Output only. Resource name for the user capabilities. + canCreateSharedLabels: + description: >- + Output only. Whether the user is allowed to create new shared + labels. + type: boolean + readOnly: true + canCreateAdminLabels: + readOnly: true + type: boolean + description: Output only. Whether the user is allowed to create new admin labels. + canAdministrateLabels: + readOnly: true + description: >- + Output only. Whether the user is an administrator for the shared + labels feature. + type: boolean + canAccessLabelManager: + readOnly: true + type: boolean + description: >- + Output only. Whether the user is allowed access to the label + manager. + description: The capabilities of a user. + type: object + id: GoogleAppsDriveLabelsV2betaUserCapabilities + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceDisplayHints: + description: UI display hints for rendering an option. + type: object + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceDisplayHints + properties: + badgeColors: + description: >- + The colors to use for the badge. Changed to Google Material colors + based on the chosen `properties.badge_config.color`. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaBadgeColors' + badgePriority: + type: string + format: int64 + description: >- + The priority of this badge. Used to compare and sort between + multiple badges. A lower number means the badge should be shown + first. When a badging configuration is not present, this will be 0. + Otherwise, this will be set to `BadgeConfig.priority_override` or + the default heuristic which prefers creation date of the label, and + field and option priority. + shownInApply: + type: boolean + description: >- + This option should be shown in the apply menu when applying values + to a Drive item. + hiddenInSearch: + description: >- + This option should be hidden in the search menu when searching for + Drive items. + type: boolean + darkBadgeColors: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaBadgeColors' + description: >- + The dark-mode color to use for the badge. Changed to Google Material + colors based on the chosen `properties.badge_config.color`. + disabled: + type: boolean + description: Whether the option should be shown in the UI as disabled. + GoogleAppsDriveLabelsV2betaLabelSchemaCapabilities: + type: object + description: The capabilities related to this label when editing the label. + id: GoogleAppsDriveLabelsV2betaLabelSchemaCapabilities + properties: + canDelete: + description: >- + Whether the user can delete this label. The user must have + permission and the label must be disabled. + type: boolean + canDisable: + description: >- + Whether the user can disable this label. The user must have + permission and this label must not already be disabled. + type: boolean + canEnable: + type: boolean + description: >- + Whether the user can enable this label. The user must have + permission and this label must be disabled. + canUpdate: + description: Whether the user can change this label. + type: boolean + GoogleAppsDriveLabelsV2betaUpdateLabelPermissionRequest: + type: object + properties: + labelPermission: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + description: Required. The permission to create or update on the Label. + useAdminAccess: + type: boolean + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + parent: + type: string + description: Required. The parent Label resource name. + description: >- + Updates a Label Permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + id: GoogleAppsDriveLabelsV2betaUpdateLabelPermissionRequest + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteSelectionChoiceResponse: + description: Response following Choice delete. + type: object + properties: {} + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDeleteSelectionChoiceResponse + GoogleAppsDriveLabelsV2betaListLabelLocksResponse: + type: object + properties: + labelLocks: + description: LabelLocks. + type: array + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelLock' + nextPageToken: + description: The token of the next page in the response. + type: string + id: GoogleAppsDriveLabelsV2betaListLabelLocksResponse + description: The response to a ListLabelLocksRequest. + GoogleAppsDriveLabelsV2betaBadgeColors: + type: object + id: GoogleAppsDriveLabelsV2betaBadgeColors + description: >- + The color derived from BadgeConfig and changed to the closest + recommended supported color. + properties: + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Output only. Badge background that pairs with the foreground. + readOnly: true + soloColor: + description: Output only. Color that can be used for text without a background. + readOnly: true + $ref: '#/components/schemas/GoogleTypeColor' + foregroundColor: + readOnly: true + description: Output only. Badge foreground that pairs with the background. + $ref: '#/components/schemas/GoogleTypeColor' + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateFieldResponse: + description: Response following Field create. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseCreateFieldResponse + type: object + properties: + id: + type: string + description: >- + The field of the created field. When left blank in a create request, + a key will be autogenerated and can be identified here. + priority: + format: int32 + type: integer + description: >- + The priority of the created field. The priority may change from what + was specified to assure contiguous priorities between fields (1-n). + GoogleAppsDriveLabelsV2betaLabelProperties: + type: object + id: GoogleAppsDriveLabelsV2betaLabelProperties + description: Basic properties of the label. + properties: + title: + type: string + description: Required. Title of the label. + description: + description: The description of the label. + type: string + GoogleTypeColor: + id: GoogleTypeColor + properties: + red: + type: number + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + alpha: + type: number + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + format: float + green: + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + blue: + type: number + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. + type: object + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateLabelPropertiesRequest: + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateLabelPropertiesRequest + description: Updates basic properties of a Label. + type: object + properties: + updateMask: + description: >- + The fields that should be updated. At least one field must be + specified. The root `label_properties` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + type: string + format: google-fieldmask + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelProperties' + description: Required. Label properties to update. + GoogleAppsDriveLabelsV2betaLabelPermission: + description: >- + The permission that applies to a principal (user, group, audience) on a + label. + type: object + properties: + person: + description: Person resource name. + type: string + audience: + description: >- + Audience to grant a role to. The magic value of `audiences/default` + may be used to apply the role to the default audience in the context + of the organization that owns the Label. + type: string + group: + description: Group resource name. + type: string + email: + description: >- + Specifies the email address for a user or group pricinpal. Not + populated for audience principals. User and Group permissions may + only be inserted using email address. On update requests, if email + address is specified, no principal should be specified. + type: string + name: + description: Resource name of this permission. + type: string + role: + enumDescriptions: + - Unknown role. + - >- + A reader can read the label and associated metadata applied to + Drive items. + - >- + An applier can write associated metadata on Drive items in which + they also have write access to. Implies `READER`. + - >- + An organizer can pin this label in shared drives they manage and + add new appliers to the label. + - >- + Editors can make any update including deleting the label which + also deletes the associated Drive item metadata. Implies + `APPLIER`. + enum: + - LABEL_ROLE_UNSPECIFIED + - READER + - APPLIER + - ORGANIZER + - EDITOR + type: string + description: The role the principal should have. + id: GoogleAppsDriveLabelsV2betaLabelPermission + GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties: + type: object + properties: + badgeConfig: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaBadgeConfig' + description: >- + The badge configuration for this choice. When set, the label that + owns this choice is considered a "badged label". + displayName: + description: Required. The display text to show in the UI identifying this field. + type: string + insertBeforeChoice: + type: string + description: >- + Input only. Insert or move this choice before the indicated choice. + If empty, the choice is placed at the end of the list. + description: + description: The description of this label. + type: string + id: GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoiceProperties + description: Basic properties of the choice. + GoogleAppsDriveLabelsV2betaIntegerLimits: + description: Limits for integer Field type. + type: object + id: GoogleAppsDriveLabelsV2betaIntegerLimits + properties: + minValue: + type: string + format: int64 + description: Minimum value for an integer Field type. + maxValue: + type: string + description: Maximum value for an integer Field type. + format: int64 + GoogleAppsDriveLabelsV2betaLabelAppliedLabelPolicy: + type: object + description: Behavior of this label when it's applied to Drive items. + properties: + copyMode: + type: string + description: >- + Indicates how the applied label and field values should be copied + when a Drive item is copied. + enumDescriptions: + - Copy mode unspecified. + - >- + The applied label and field values are not copied by default when + the Drive item it's applied to is copied. + - >- + The applied label and field values are always copied when the + Drive item it's applied to is copied. Only admins can use this + mode. + - >- + The applied label and field values are copied if the label is + appliable by the user making the copy. + enum: + - COPY_MODE_UNSPECIFIED + - DO_NOT_COPY + - ALWAYS_COPY + - COPY_APPLIABLE + id: GoogleAppsDriveLabelsV2betaLabelAppliedLabelPolicy + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableFieldResponse: + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseDisableFieldResponse + type: object + description: Response following Field disable. + properties: {} + GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest: + id: GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest + description: Deletes one of more Label Permissions. + properties: + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. If this is set, the use_admin_access field in the + DeleteLabelPermissionRequest messages must either be empty or match + this field. + type: boolean + requests: + description: Required. The request message specifying the resources to update. + type: array + items: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeleteLabelPermissionRequest + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateLabelPropertiesResponse: + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponseUpdateLabelPropertiesResponse + properties: {} + description: Response following update to Label properties. + GoogleAppsDriveLabelsV2betaFieldUserOptions: + type: object + id: GoogleAppsDriveLabelsV2betaFieldUserOptions + properties: + listOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldListOptions' + description: >- + When specified, indicates that this field supports a list of values. + Once the field is published, this cannot be changed. + description: Options for the user field type. + GoogleAppsDriveLabelsV2betaLabelDisplayHints: + type: object + id: GoogleAppsDriveLabelsV2betaLabelDisplayHints + properties: + priority: + format: int64 + type: string + description: Order to display label in a list. + disabled: + type: boolean + description: Whether the label should be shown in the UI as disabled. + hiddenInSearch: + type: boolean + description: >- + This label should be hidden in the search menu when searching for + Drive items. + shownInApply: + description: >- + This label should be shown in the apply menu when applying values to + a Drive item. + type: boolean + description: UI display hints for rendering the label. + GoogleAppsDriveLabelsV2betaUserInfo: + properties: + person: + description: >- + The identifier for this user that can be used with the People API to + get more information. For example, people/12345678. + type: string + id: GoogleAppsDriveLabelsV2betaUserInfo + type: object + description: Information about a user. + GoogleProtobufEmpty: + type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + properties: {} + id: GoogleProtobufEmpty + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateSelectionChoiceRequest: + description: Request to create a Selection Choice. + type: object + id: >- + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestCreateSelectionChoiceRequest + properties: + choice: + description: Required. The Choice to create. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptionsChoice + fieldId: + description: Required. The Selection Field in which a Choice will be created. + type: string + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldTypeRequest: + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestUpdateFieldTypeRequest + type: object + properties: + dateOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldDateOptions' + description: Update field to Date. + textOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldTextOptions' + description: Update field to Text. + userOptions: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldUserOptions' + description: Update field to User. + updateMask: + type: string + description: >- + The fields that should be updated. At least one field must be + specified. The root of `type_options` is implied and should not be + specified. A single `*` can be used as short-hand for updating every + field. + format: google-fieldmask + integerOptions: + description: Update field to Integer. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaFieldIntegerOptions' + selectionOptions: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaFieldSelectionOptions + description: Update field to Selection. + id: + description: Required. The Field to update. + type: string + description: Request to change the type of a Field. + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteFieldRequest: + type: object + description: Request to delete the Field. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestDeleteFieldRequest + properties: + id: + description: Required. ID of the Field to delete. + type: string + GoogleAppsDriveLabelsV2betaFieldAppliedCapabilities: + type: object + description: The capabilities related to this field on applied metadata. + id: GoogleAppsDriveLabelsV2betaFieldAppliedCapabilities + properties: + canWrite: + description: Whether the user can set this field on Drive items. + type: boolean + canRead: + description: Whether the user can read related applied metadata on items. + type: boolean + canSearch: + description: Whether the user can search for Drive items referencing this field. + type: boolean + GoogleAppsDriveLabelsV2betaWriteControl: + id: GoogleAppsDriveLabelsV2betaWriteControl + properties: + requiredRevisionId: + type: string + description: >- + The revision_id of the label that the write request will be applied + to. If this is not the latest revision of the label, the request + will not be processed and will return a 400 Bad Request error. + description: >- + Provides control over how write requests are executed. When not + specified, the last write wins. + type: object + GoogleAppsDriveLabelsV2betaPublishLabelRequest: + description: Request to publish a label. + type: object + id: GoogleAppsDriveLabelsV2betaPublishLabelRequest + properties: + useAdminAccess: + description: >- + Set to `true` in order to use the user's admin credentials. The + server will verify the user is an admin for the Label before + allowing access. + type: boolean + writeControl: + description: >- + Provides control over how write requests are executed. Defaults to + unset, which means last write wins. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaWriteControl' + languageCode: + description: >- + The BCP-47 language code to use for evaluating localized field + labels. When not specified, values in the default configured + language will be used. + type: string + GoogleAppsDriveLabelsV2betaTextLimits: + description: Limits for text Field type. + id: GoogleAppsDriveLabelsV2betaTextLimits + properties: + maxLength: + format: int32 + description: Maximum length allowed for a text Field type. + type: integer + minLength: + format: int32 + type: integer + description: Minimum length allowed for a text Field type. + type: object + GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableFieldRequest: + description: Request to enable the Field. + id: GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequestEnableFieldRequest + type: object + properties: + id: + description: Required. ID of the Field to enable. + type: string + GoogleAppsDriveLabelsV2betaLabel: + description: >- + A label defines a taxonomy that can be applied to Drive items in order + to organize and search across items. Labels can be simple strings, or + can contain fields that describe additional metadata that can be further + used to organize and search Drive items. + id: GoogleAppsDriveLabelsV2betaLabel + type: object + properties: + lockStatus: + description: Output only. The LockStatus of this label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLockStatus' + disabler: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: >- + Output only. The user who disabled this label. This value has no + meaning when the label is not disabled. + readOnly: true + displayHints: + description: Output only. UI display hints for rendering the label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelDisplayHints' + properties: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelProperties' + description: Required. The basic properties of the label. + lifecycle: + description: >- + Output only. The lifecycle state of the label including whether it's + published, deprecated, and has draft changes. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLifecycle' + readOnly: true + publishTime: + type: string + description: >- + Output only. The time this label was published. This value has no + meaning when the label is not published. + format: google-datetime + readOnly: true + appliedCapabilities: + description: >- + Output only. The capabilities related to this label on applied + metadata. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelAppliedCapabilities + readOnly: true + id: + description: >- + Output only. Globally unique identifier of this label. ID makes up + part of the label `name`, but unlike `name`, ID is consistent + between revisions. Matches the regex: `([a-zA-Z0-9])+` + type: string + readOnly: true + publisher: + readOnly: true + description: >- + Output only. The user who published this label. This value has no + meaning when the label is not published. + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + revisionId: + description: >- + Output only. Revision ID of the label. Revision ID might be part of + the label `name` depending on the request issued. A new revision is + created whenever revisioned properties of a label are changed. + Matches the regex: `([a-zA-Z0-9])+` + type: string + readOnly: true + labelType: + enumDescriptions: + - Unknown label type. + - Shared labels may be shared with users to apply to Drive items. + - >- + Admin-owned label. Only creatable and editable by admins. Supports + some additional admin-only features. + - >- + A label owned by an internal Google application rather than a + customer. These labels are read-only. + enum: + - LABEL_TYPE_UNSPECIFIED + - SHARED + - ADMIN + - GOOGLE_APP + description: Required. The type of label. + type: string + customer: + readOnly: true + type: string + description: >- + Output only. The customer this label belongs to. For example: + "customers/123abc789." + fields: + description: List of fields in descending priority order. + type: array + items: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaField' + schemaCapabilities: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelSchemaCapabilities + description: Output only. The capabilities the user has on this label. + readOnly: true + appliedLabelPolicy: + description: >- + Output only. Behavior of this label when it's applied to Drive + items. + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelAppliedLabelPolicy + readOnly: true + name: + description: >- + Output only. Resource name of the label. Will be in the form of + either: `labels/{id}` or `labels/{id}@{revision_id}` depending on + the request. See `id` and `revision_id` below. + readOnly: true + type: string + creator: + description: Output only. The user who created this label. + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + disableTime: + format: google-datetime + description: >- + Output only. The time this label was disabled. This value has no + meaning when the label is not disabled. + readOnly: true + type: string + revisionCreateTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The time this label revision was created. + learnMoreUri: + type: string + description: >- + Custom URL to present to users to allow them to learn more about + this label and how it should be used. + createTime: + type: string + description: Output only. The time this label was created. + readOnly: true + format: google-datetime + revisionCreator: + readOnly: true + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaUserInfo' + description: Output only. The user who created this label revision. + parameters: + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + x-stackQL-resources: + users_capabilities: + id: googleworkspace.drivelabelsv2beta.users_capabilities + name: users_capabilities + title: Users_capabilities + methods: + get_capabilities: + operation: + $ref: '#/paths/~1v2beta~1users~1{usersId}~1capabilities/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/users_capabilities/methods/get_capabilities + insert: [] + update: [] + replace: [] + delete: [] + labels: + id: googleworkspace.drivelabelsv2beta.labels + name: labels + title: Labels + methods: + create: + operation: + $ref: '#/paths/~1v2beta~1labels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v2beta~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labels + delta: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:delta/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:enable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + publish: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:publish/post' + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:disable/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/labels/methods/get' + - $ref: '#/components/x-stackQL-resources/labels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/delete' + labels_permissions: + id: googleworkspace.drivelabelsv2beta.labels_permissions + name: labels_permissions + title: Labels_permissions + methods: + update_permissions: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1permissions/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_permissions/methods/update_permissions + replace: [] + delete: [] + permissions: + id: googleworkspace.drivelabelsv2beta.permissions + name: permissions + title: Permissions + methods: + create: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelPermissions + delete: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1permissions~1{permissionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + batch_update: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1permissions:batchUpdate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + batch_delete: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1permissions:batchDelete/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + - $ref: '#/components/x-stackQL-resources/permissions/methods/batch_delete' + labels_label_copy_mode: + id: googleworkspace.drivelabelsv2beta.labels_label_copy_mode + name: labels_label_copy_mode + title: Labels_label_copy_mode + methods: + update_label_copy_mode: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}:updateLabelCopyMode/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/labels_label_copy_mode/methods/update_label_copy_mode + replace: [] + delete: [] + locks: + id: googleworkspace.drivelabelsv2beta.locks + name: locks + title: Locks + methods: + list: + operation: + $ref: '#/paths/~1v2beta~1labels~1{labelsId}~1locks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labelLocks + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locks/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + revisions_permissions: + id: googleworkspace.drivelabelsv2beta.revisions_permissions + name: revisions_permissions + title: Revisions_permissions + methods: + update_permissions: + operation: + $ref: >- + #/paths/~1v2beta~1labels~1{labelsId}~1revisions~1{revisionsId}~1permissions/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_permissions/methods/update_permissions + replace: [] + delete: [] + limits_label: + id: googleworkspace.drivelabelsv2beta.limits_label + name: limits_label + title: Limits_label + methods: + get_label: + operation: + $ref: '#/paths/~1v2beta~1limits~1label/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/limits_label/methods/get_label' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2beta/users/{usersId}/capabilities: + parameters: &ref_1 + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + get: + description: Gets the user capabilities. + operationId: drivelabels.users.getCapabilities + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaUserCapabilities + parameters: + - in: path + name: usersId + required: true + schema: + type: string + - in: query + name: customer + schema: + type: string + /v2beta/labels: + parameters: *ref_1 + post: + description: Creates a new Label. + operationId: drivelabels.labels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: query + name: languageCode + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: List labels. + operationId: drivelabels.labels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelsResponse + parameters: + - in: query + name: customer + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: publishedOnly + schema: + type: boolean + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: minimumRole + schema: + type: string + /v2beta/labels/{labelsId}/permissions: + parameters: *ref_1 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageToken + schema: + type: string + /v2beta/labels/{labelsId}:delta: + parameters: *ref_1 + post: + description: >- + Updates a single Label by applying a set of update requests resulting in + a new draft revision. The batch update is all-or-nothing: If any of the + update requests are invalid, no changes are applied. The resulting draft + revision must be published before the changes may be used with Drive + Items. + operationId: drivelabels.labels.delta + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDeltaUpdateLabelResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}:updateLabelCopyMode: + parameters: *ref_1 + post: + description: >- + Updates a Label's `CopyMode`. Changes to this policy are not revisioned, + do not require publishing, and take effect immediately. + operationId: drivelabels.labels.updateLabelCopyMode + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaUpdateLabelCopyModeRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a Label and related metadata on Drive Items. Once + deleted, the Label and related Drive item metadata will be deleted. Only + draft Labels, and disabled Labels may be deleted. + operationId: drivelabels.labels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: writeControl.requiredRevisionId + schema: + type: string + get: + description: >- + Get a label by its resource name. Resource name may be any of: * + `labels/{id}` - See `labels/{id}@latest` * `labels/{id}@latest` - Gets + the latest revision of the label. * `labels/{id}@published` - Gets the + current published revision of the label. * `labels/{id}@{revision_id}` - + Gets the label at the specified revision ID. + operationId: drivelabels.labels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}:enable: + parameters: *ref_1 + post: + description: >- + Enable a disabled Label and restore it to its published state. This will + result in a new published revision based on the current disabled + published revision. If there is an existing disabled draft revision, a + new revision will be created based on that draft and will be enabled. + operationId: drivelabels.labels.enable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaEnableLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}:publish: + parameters: *ref_1 + post: + description: >- + Publish all draft changes to the Label. Once published, the Label may + not return to its draft state. See + `google.apps.drive.labels.v2.Lifecycle` for more information. Publishing + a Label will result in a new published revision. All previous draft + revisions will be deleted. Previous published revisions will be kept but + are subject to automated deletion as needed. Once published, some + changes are no longer permitted. Generally, any change that would + invalidate or cause new restrictions on existing metadata related to the + Label will be rejected. For example, the following changes to a Label + will be rejected after the Label is published: * The label cannot be + directly deleted. It must be disabled first, then deleted. * + Field.FieldType cannot be changed. * Changes to Field validation options + cannot reject something that was previously accepted. * Reducing the max + entries. + operationId: drivelabels.labels.publish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaPublishLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}:disable: + parameters: *ref_1 + post: + description: >- + Disable a published Label. Disabling a Label will result in a new + disabled published revision based on the current published revision. If + there is a draft revision, a new disabled draft revision will be created + based on the latest draft revision. Older draft revisions will be + deleted. Once disabled, a label may be deleted with `DeleteLabel`. + operationId: drivelabels.labels.disable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaDisableLabelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabel' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/revisions/{revisionsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.revisions.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions: + parameters: *ref_1 + post: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + get: + description: Lists a Label's permissions. + operationId: drivelabels.labels.revisions.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + patch: + description: >- + Updates a Label's permissions. If a permission for the indicated + principal doesn't exist, a new Label Permission is created, otherwise + the existing permission is updated. Permissions affect the Label + resource as a whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.updatePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaLabelPermission + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}/revisions/{revisionsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.revisions.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/locks: + parameters: *ref_1 + get: + description: Lists the LabelLocks on a Label. + operationId: drivelabels.labels.locks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaListLabelLocksResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2beta/labels/{labelsId}/permissions:batchDelete: + parameters: *ref_1 + post: + description: >- + Deletes Label permissions. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchDeleteLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/labels/{labelsId}/permissions/{permissionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Label's permission. Permissions affect the Label resource as a + whole, are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + - in: path + name: permissionsId + required: true + schema: + type: string + - in: query + name: useAdminAccess + schema: + type: boolean + /v2beta/labels/{labelsId}/permissions:batchUpdate: + parameters: *ref_1 + post: + description: >- + Updates Label permissions. If a permission for the indicated principal + doesn't exist, a new Label Permission is created, otherwise the existing + permission is updated. Permissions affect the Label resource as a whole, + are not revisioned, and do not require publishing. + operationId: drivelabels.labels.permissions.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleAppsDriveLabelsV2betaBatchUpdateLabelPermissionsResponse + parameters: + - in: path + name: labelsId + required: true + schema: + type: string + /v2beta/limits/label: + parameters: *ref_1 + get: + description: >- + Get the constraints on the structure of a Label; such as, the maximum + number of Fields allowed and maximum length of the label title. + operationId: drivelabels.limits.getLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.admin.labels.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.labels + Oauth2c: + - https://www.googleapis.com/auth/drive.labels + - Oauth2: + - https://www.googleapis.com/auth/drive.labels.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.labels.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleAppsDriveLabelsV2betaLabelLimits' + parameters: + - in: query + name: name + schema: + type: string diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivev2.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivev2.yaml new file mode 100644 index 00000000..1b207b12 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivev2.yaml @@ -0,0 +1,7544 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Google Drive API + description: The Google Drive API allows clients to access resources from Google Drive. + version: v2 + x-discovery-doc-revision: '20241202' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/ +servers: + - url: https://www.googleapis.com/drive/v2 +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive: See, edit, create, and delete all of your Google Drive files + https://www.googleapis.com/auth/drive.appdata: >- + See, create, and delete its own configuration data in your Google + Drive + https://www.googleapis.com/auth/drive.apps.readonly: View your Google Drive apps + https://www.googleapis.com/auth/drive.file: >- + See, edit, create, and delete only the specific Google Drive files + you use with this app + https://www.googleapis.com/auth/drive.meet.readonly: >- + See and download your Google Drive files that were created or + edited by Google Meet. + https://www.googleapis.com/auth/drive.metadata: View and manage metadata of files in your Google Drive + https://www.googleapis.com/auth/drive.metadata.readonly: See information about your Google Drive files + https://www.googleapis.com/auth/drive.photos.readonly: View the photos, videos and albums in your Google Photos + https://www.googleapis.com/auth/drive.readonly: See and download all your Google Drive files + https://www.googleapis.com/auth/drive.scripts: Modify your Google Apps Script scripts' behavior + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + About: + id: About + description: An item with user information and settings. + type: object + properties: + name: + description: The name of the current user. + type: string + quotaBytesTotal: + description: >- + The total number of quota bytes. This is only relevant when + quotaType is LIMITED. + type: string + format: int64 + quotaBytesUsed: + description: The number of quota bytes used by Google Drive. + type: string + format: int64 + quotaBytesUsedInTrash: + description: The number of quota bytes used by trashed items. + type: string + format: int64 + largestChangeId: + description: The largest change id. + type: string + format: int64 + remainingChangeIds: + description: The number of remaining change ids, limited to no more than 2500. + type: string + format: int64 + rootFolderId: + description: The id of the root folder. + type: string + importFormats: + description: The allowable import formats. + type: array + items: + type: object + properties: + source: + description: The imported file's content type to convert from. + type: string + targets: + description: The possible content types to convert to. + type: array + items: + type: string + exportFormats: + description: The allowable export formats. + type: array + items: + type: object + properties: + source: + description: The content type to convert from. + type: string + targets: + description: The possible content types to convert to. + type: array + items: + type: string + additionalRoleInfo: + description: >- + Information about supported additional roles per file type. The most + specific type takes precedence. + type: array + items: + type: object + properties: + type: + description: The content type that this additional role info applies to. + type: string + roleSets: + description: The supported additional roles per primary role. + type: array + items: + type: object + properties: + primaryRole: + description: A primary permission role. + type: string + additionalRoles: + description: The supported additional roles with the primary role. + type: array + items: + type: string + features: + description: List of additional features enabled on this account. + type: array + items: + type: object + properties: + featureName: + description: The name of the feature. + type: string + featureRate: + description: >- + The request limit rate for this feature, in queries per + second. + type: number + format: double + maxUploadSizes: + description: >- + List of max upload sizes for each file type. The most specific type + takes precedence. + type: array + items: + type: object + properties: + type: + description: The file type. + type: string + size: + description: The max upload size for this type. + type: string + format: int64 + domainSharingPolicy: + description: >- + The domain sharing policy for the current user. Possible values are: + * `allowed` * `allowedWithWarning` * `incomingOnly` * `disallowed` + type: string + kind: + description: This is always `drive#about`. + default: drive#about + type: string + permissionId: + description: The current user's ID as visible in the permissions collection. + type: string + isCurrentAppInstalled: + description: >- + A boolean indicating whether the authenticated app is installed by + the authenticated user. + type: boolean + quotaBytesUsedAggregate: + description: >- + The number of quota bytes used by all Google apps (Drive, Picasa, + etc.). + type: string + format: int64 + user: + description: The authenticated user. + $ref: '#/components/schemas/User' + etag: + description: The ETag of the item. + type: string + languageCode: + description: >- + The user's language or locale code, as defined by BCP 47, with some + extensions from Unicode's LDML format + (http://www.unicode.org/reports/tr35/). + type: string + selfLink: + description: A link back to this item. + type: string + quotaType: + description: >- + The type of the user's storage quota. Possible values are: * + `LIMITED` * `UNLIMITED` + type: string + folderColorPalette: + description: The palette of allowable folder colors as RGB hex strings. + type: array + items: + type: string + driveThemes: + description: A list of themes that are supported for shared drives. + type: array + items: + type: object + properties: + id: + description: The ID of the theme. + type: string + backgroundImageLink: + description: A link to this theme's background image. + type: string + colorRgb: + description: The color of this theme as an RGB hex string. + type: string + canCreateDrives: + description: Whether the user can create shared drives. + type: boolean + quotaBytesByService: + description: The amount of storage quota used by different Google services. + type: array + items: + type: object + properties: + serviceName: + description: The service's name, e.g. DRIVE, GMAIL, or PHOTOS. + type: string + bytesUsed: + description: The storage quota bytes used by the service. + type: string + format: int64 + teamDriveThemes: + description: 'Deprecated: Use `driveThemes` instead.' + deprecated: true + type: array + items: + type: object + properties: + id: + description: 'Deprecated: Use `driveThemes/id` instead.' + deprecated: true + type: string + backgroundImageLink: + description: 'Deprecated: Use `driveThemes/backgroundImageLink` instead.' + deprecated: true + type: string + colorRgb: + description: 'Deprecated: Use `driveThemes/colorRgb` instead.' + deprecated: true + type: string + canCreateTeamDrives: + description: 'Deprecated: Use `canCreateDrives` instead.' + deprecated: true + type: boolean + User: + id: User + description: Information about a Drive user. + type: object + properties: + displayName: + description: Output only. A plain text displayable name for this user. + type: string + kind: + description: Output only. This is always `drive#user`. + default: drive#user + type: string + isAuthenticatedUser: + description: >- + Output only. Whether this user is the same as the authenticated user + for whom the request was made. + type: boolean + permissionId: + description: Output only. The user's ID as visible in the permissions collection. + type: string + emailAddress: + description: Output only. The email address of the user. + type: string + picture: + description: Output only. The user's profile picture. + type: object + properties: + url: + description: >- + Output Only. A URL that points to a profile picture of this + user. + type: string + App: + id: App + description: >- + The apps resource provides a list of the 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. + type: object + properties: + name: + description: The name of the app. + type: string + objectType: + description: >- + The type of object this app creates (e.g. Chart). If empty, the app + name should be used instead. + type: string + supportsCreate: + description: Whether this app supports creating new objects. + type: boolean + productUrl: + description: A link to the product listing for this app. + type: string + primaryMimeTypes: + description: The list of primary mime types. + type: array + items: + type: string + secondaryMimeTypes: + description: The list of secondary mime types. + type: array + items: + type: string + primaryFileExtensions: + description: The list of primary file extensions. + type: array + items: + type: string + secondaryFileExtensions: + description: The list of secondary file extensions. + type: array + items: + type: string + id: + description: The ID of the app. + type: string + supportsImport: + description: Whether this app supports importing from Docs Editors. + type: boolean + installed: + description: Whether the app is installed. + type: boolean + authorized: + description: Whether the app is authorized to access data on the user's Drive. + type: boolean + icons: + description: The various icons for the app. + type: array + items: + type: object + properties: + size: + description: >- + Size of the icon. Represented as the maximum of the width and + height. + type: integer + format: int32 + category: + description: >- + Category of the icon. Allowed values are: * `application` - + icon for the application * `document` - icon for a file + associated with the app * `documentShared` - icon for a shared + file associated with the app + type: string + iconUrl: + description: URL for the icon. + type: string + useByDefault: + description: >- + Whether the app is selected as the default handler for the types it + supports. + type: boolean + kind: + description: This is always `drive#app`. + default: drive#app + type: string + shortDescription: + description: A short description of the app. + type: string + longDescription: + description: A long description of the app. + type: string + supportsMultiOpen: + description: Whether this app supports opening more than one file. + type: boolean + productId: + description: The ID of the product listing for this app. + type: string + openUrlTemplate: + description: >- + The template url for opening files with this app. The template will + contain `{ids}` and/or `{exportIds}` to be replaced by the actual + file ids. See Open Files for the full documentation. + type: string + createUrl: + description: The url to create a new file with this app. + type: string + createInFolderTemplate: + description: >- + The template url to create a new file with this app in a given + folder. The template will contain {folderId} to be replaced by the + folder to create the new file in. + type: string + supportsOfflineCreate: + description: Whether this app supports creating new files when offline. + type: boolean + hasDriveWideScope: + description: >- + Whether the app has drive-wide scope. An app with drive-wide scope + can access all files in the user's drive. + type: boolean + AppList: + id: AppList + description: >- + A list of third-party applications which the user has installed or given + access to Google Drive. + type: object + properties: + etag: + description: The ETag of the list. + type: string + defaultAppIds: + description: >- + List of app IDs that the user has specified to use by default. The + list is in reverse-priority order (lowest to highest). + type: array + items: + type: string + kind: + description: This is always `drive#appList`. + default: drive#appList + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of apps. + type: array + items: + $ref: '#/components/schemas/App' + Change: + id: Change + description: Representation of a change to a file or shared drive. + type: object + properties: + id: + description: The ID of the change. + type: string + format: int64 + deleted: + description: >- + Whether the file or shared drive has been removed from this list of + changes, for example by deletion or loss of access. + type: boolean + file: + description: >- + The updated state of the file. Present if the type is file and the + file has not been removed from this list of changes. + $ref: '#/components/schemas/File' + fileId: + description: The ID of the file associated with this change. + type: string + modificationDate: + description: The time of this modification. + type: string + format: date-time + kind: + description: This is always `drive#change`. + default: drive#change + type: string + type: + description: 'Deprecated: Use `changeType` instead.' + deprecated: true + type: string + teamDriveId: + description: 'Deprecated: Use `driveId` instead.' + deprecated: true + type: string + teamDrive: + description: 'Deprecated: Use `drive` instead.' + deprecated: true + $ref: '#/components/schemas/TeamDrive' + changeType: + description: The type of the change. Possible values are `file` and `drive`. + type: string + selfLink: + description: A link back to this change. + type: string + driveId: + description: The ID of the shared drive associated with this change. + type: string + drive: + description: >- + 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. + $ref: '#/components/schemas/Drive' + File: + id: File + description: >- + 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. + type: object + properties: + kind: + description: Output only. The type of file. This is always `drive#file`. + default: drive#file + type: string + userPermission: + description: >- + Output only. The permissions for the authenticated user on this + file. + $ref: '#/components/schemas/Permission' + fileExtension: + description: >- + Output only. The final component of `fullFileExtension` with + trailing text that does not appear to be part of the extension + removed. This field is only populated for files with content stored + in Google Drive; it is not populated for Docs Editors or shortcut + files. + type: string + md5Checksum: + description: >- + Output only. An MD5 checksum for the content of this file. This + field is only populated for files with content stored in Google + Drive; it is not populated for Docs Editors or shortcut files. + type: string + selfLink: + description: Output only. A link back to this file. + type: string + ownerNames: + description: >- + Output only. Name(s) of the owner(s) of this file. Not populated for + items in shared drives. + type: array + items: + type: string + lastModifyingUserName: + description: Output only. Name of the last user to modify this file. + type: string + editable: + description: 'Output only. Deprecated: Use `capabilities/canEdit` instead.' + deprecated: true + type: boolean + writersCanShare: + description: >- + Whether writers can share the document with other users. Not + populated for items in shared drives. + type: boolean + downloadUrl: + description: >- + Output only. Short lived download URL for the file. This field is + only populated for files with content stored in Google Drive; it is + not populated for Google Docs or shortcut files. + type: string + mimeType: + description: >- + The MIME type of the file. This is only mutable on update when + uploading new content. This field can be left blank, and the + mimetype will be determined from the uploaded content's MIME type. + type: string + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + readOnly: true + type: object + additionalProperties: + type: string + driveId: + description: >- + Output only. ID of the shared drive the file resides in. Only + populated for items in shared drives. + type: string + parents: + description: >- + 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 an insert 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. + type: array + items: + $ref: '#/components/schemas/ParentReference' + thumbnailLink: + description: >- + 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), + 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. + type: string + appDataContents: + description: Output only. Whether this file is in the Application Data folder. + type: boolean + webViewLink: + description: >- + Output only. A link only available on public folders for viewing + their static web assets (HTML, CSS, JS, etc) via Google Drive's + Website Hosting. + type: string + iconLink: + description: Output only. A link to the file's icon. + type: string + shared: + description: >- + Output only. Whether the file has been shared. Not populated for + items in shared drives. + type: boolean + lastModifyingUser: + description: >- + Output only. The last user to modify this file. This field is only + populated when the last modification was performed by a signed-in + user. + $ref: '#/components/schemas/User' + owners: + description: >- + 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. + type: array + items: + $ref: '#/components/schemas/User' + openWithLinks: + description: >- + Output only. A map of the id of each of the user's apps to a link to + open this file with that app. Only populated when the + drive.apps.readonly scope is used. + type: object + additionalProperties: + type: string + defaultOpenWithLink: + description: >- + Output only. A link to open this file with the user's default app + for this file. Only populated when the drive.apps.readonly scope is + used. + type: string + headRevisionId: + description: >- + Output only. The ID of the file's head revision. This field is only + populated for files with content stored in Google Drive; it is not + populated for Docs Editors or shortcut files. + type: string + properties: + description: The list of properties. + type: array + items: + $ref: '#/components/schemas/Property' + copyable: + description: 'Output only. Deprecated: Use `capabilities/canCopy` instead.' + deprecated: true + type: boolean + etag: + description: Output only. ETag of the file. + type: string + sharingUser: + description: >- + Output only. User that shared the item with the current user, if + available. + $ref: '#/components/schemas/User' + alternateLink: + description: >- + Output only. A link for opening the file in a relevant Google editor + or viewer. + type: string + embedLink: + description: Output only. A link for embedding the file. + type: string + webContentLink: + description: >- + Output only. A link for downloading the content of the file in a + browser using cookie based authentication. In cases where the + content is shared publicly, the content can be downloaded without + any credentials. + type: string + fileSize: + description: >- + Output only. Size in bytes of blobs and first party editor files. + Won't be populated for files that have no size, like shortcuts and + folders. + type: string + format: int64 + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download this file, should be + disabled for readers and commenters. + type: boolean + permissions: + description: >- + Output only. The list of permissions for users with access to this + file. Not populated for items in shared drives. + type: array + items: + $ref: '#/components/schemas/Permission' + hasThumbnail: + description: >- + Output only. Whether this file has a thumbnail. This does not + indicate whether the requesting app has access to the thumbnail. To + check access, look for the presence of the thumbnailLink field. + type: boolean + spaces: + description: >- + Output only. The list of spaces which contain the file. Supported + values are `drive`, `appDataFolder` and `photos`. + type: array + items: + type: string + folderColorRgb: + description: >- + Folder color as an RGB hex string if the file is a folder or a + shortcut to a folder. The list of supported colors is available in + the folderColorPalette field of the About resource. If an + unsupported color is specified, it will be changed to the closest + color in the palette. + type: string + id: + description: The ID of the file. + type: string + title: + description: >- + The title of this file. Note that for immutable items such as the + top level folders of shared drives, My Drive root folder, and + Application Data folder the title is constant. + type: string + description: + description: A short description of the file. + type: string + labels: + description: A group of labels for the file. + type: object + properties: + viewed: + description: Whether this file has been viewed by this user. + type: boolean + restricted: + description: >- + Output only. Deprecated: Use `copyRequiresWriterPermission` + instead. + deprecated: true + type: boolean + starred: + description: Whether this file is starred by the user. + type: boolean + hidden: + description: Output only. Deprecated. + deprecated: true + type: boolean + trashed: + description: >- + Whether this file has been trashed. This label applies to all + users accessing the file; however, only owners are allowed to + see and untrash files. + type: boolean + modified: + description: Output only. Whether the file has been modified by this user. + type: boolean + explicitlyTrashed: + description: >- + Output only. Whether this file has been explicitly trashed, as + opposed to recursively trashed. + type: boolean + createdDate: + description: Create time for this file (formatted RFC 3339 timestamp). + type: string + format: date-time + modifiedDate: + description: >- + Last time this file was modified by anyone (formatted RFC 3339 + timestamp). This is only mutable on update when the setModifiedDate + parameter is set. + type: string + format: date-time + modifiedByMeDate: + description: >- + Last time this file was modified by the user (formatted RFC 3339 + timestamp). Note that setting modifiedDate will also update the + modifiedByMe date for the user which set the date. + type: string + format: date-time + lastViewedByMeDate: + description: >- + Last time this file was viewed by the user (formatted RFC 3339 + timestamp). + type: string + format: date-time + markedViewedByMeDate: + description: Deprecated. + type: string + format: date-time + sharedWithMeDate: + description: >- + Time at which this file was shared with the user (formatted RFC 3339 + timestamp). + type: string + format: date-time + quotaBytesUsed: + description: Output only. The number of quota bytes used by this file. + type: string + format: int64 + version: + description: >- + 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 requesting user. + type: string + format: int64 + indexableText: + description: Indexable text attributes for the file (can only be written) + type: object + properties: + text: + description: The text to be indexed for this file. + type: string + originalFilename: + description: >- + The original filename of the uploaded content if available, or else + the original value of the `title` field. This is only available for + files with binary content in Google Drive. + type: string + ownedByMe: + description: >- + Output only. Whether the file is owned by the current user. Not + populated for items in shared drives. + type: boolean + canComment: + description: 'Output only. Deprecated: Use `capabilities/canComment` instead.' + deprecated: true + type: boolean + shareable: + description: 'Output only. Deprecated: Use `capabilities/canShare` instead.' + deprecated: true + type: boolean + fullFileExtension: + description: >- + Output only. The full file extension; extracted from the title. May + contain multiple concatenated extensions, such as "tar.gz". Removing + an extension from the title does not clear this field; however, + changing the extension on the title does update this field. This + field is only populated for files with content stored in Google + Drive; it is not populated for Docs Editors or shortcut files. + type: string + isAppAuthorized: + description: >- + Output only. Whether the file was created or opened by the + requesting app. + type: boolean + teamDriveId: + description: 'Output only. Deprecated: Use `driveId` instead.' + deprecated: true + type: string + capabilities: + description: >- + Output only. Capabilities the current user has on this file. Each + capability corresponds to a fine-grained action that a user may + take. + type: object + properties: + canChangeRestrictedDownload: + description: Output only. Deprecated. + deprecated: true + type: boolean + canMoveChildrenOutOfDrive: + description: >- + Output only. Whether the current user can move children of this + folder outside of the shared drive. This is false when the item + is not a folder. Only populated for items in shared drives. + type: boolean + canReadDrive: + description: >- + Output only. Whether the current user can read the shared drive + to which this file belongs. Only populated for items in shared + drives. + type: boolean + canEdit: + description: >- + 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`. + type: boolean + canCopy: + description: >- + 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 itself if it + is not a folder. + type: boolean + canComment: + description: Output only. Whether the current user can comment on this file. + type: boolean + canAddChildren: + description: >- + Output only. Whether the current user can add children to this + folder. This is always false when the item is not a folder. + type: boolean + canDelete: + description: Output only. Whether the current user can delete this file. + type: boolean + canDownload: + description: Output only. Whether the current user can download this file. + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + this folder. This is always false when the item is not a folder. + type: boolean + canRemoveChildren: + description: >- + Output only. Whether the current user can remove children from + this folder. This is always false when the item is not a folder. + For a folder in a shared drive, use `canDeleteChildren` or + `canTrashChildren` instead. + type: boolean + canRename: + description: Output only. Whether the current user can rename this file. + type: boolean + canTrash: + description: >- + Output only. Whether the current user can move this file to + trash. + type: boolean + canReadRevisions: + description: >- + 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 + itself if it is not a folder, can be read. + type: boolean + canReadTeamDrive: + description: 'Output only. Deprecated: Use `canReadDrive` instead.' + deprecated: true + type: boolean + canMoveTeamDriveItem: + description: >- + Output only. Deprecated: Use `canMoveItemWithinDrive` or + `canMoveItemOutOfDrive` instead. + deprecated: true + type: boolean + canChangeCopyRequiresWriterPermission: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this file. + type: boolean + canMoveItemIntoTeamDrive: + description: 'Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canUntrash: + description: >- + Output only. Whether the current user can restore this file from + trash. + type: boolean + canModifyContent: + description: >- + Output only. Whether the current user can modify the content of + this file. + type: boolean + canMoveItemWithinTeamDrive: + description: 'Output only. Deprecated: Use `canMoveItemWithinDrive` instead.' + deprecated: true + type: boolean + canMoveItemOutOfTeamDrive: + description: 'Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children of + this folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveChildrenOutOfTeamDrive: + description: >- + Output only. Deprecated: Use `canMoveChildrenOutOfDrive` + instead. + deprecated: true + type: boolean + canMoveChildrenWithinTeamDrive: + description: >- + Output only. Deprecated: Use `canMoveChildrenWithinDrive` + instead. + deprecated: true + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children of this + folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveItemOutOfDrive: + description: >- + 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 is being added. + type: boolean + canAddMyDriveParent: + description: >- + 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. + type: boolean + canRemoveMyDriveParent: + description: >- + 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. + type: boolean + canMoveItemWithinDrive: + description: >- + 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 is being added + and the parent that is being removed. + type: boolean + canShare: + description: >- + Output only. Whether the current user can modify the sharing + settings for this file. + type: boolean + canMoveChildrenWithinDrive: + description: >- + Output only. Whether the current user can move children of this + folder within this drive. This is false when the item is not 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. + type: boolean + canModifyContentRestriction: + description: >- + Deprecated: Output only. Use one of + `canModifyEditorContentRestriction`, + `canModifyOwnerContentRestriction` or + `canRemoveContentRestriction`. + deprecated: true + type: boolean + canAddFolderFromAnotherDrive: + description: >- + 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 is not a folder. Only + populated for items in shared drives. + type: boolean + canChangeSecurityUpdateEnabled: + description: >- + Output only. Whether the current user can change the + securityUpdateEnabled field on link share metadata. + type: boolean + canAcceptOwnership: + description: >- + Output only. Whether the current user is the pending owner of + the file. Not populated for shared drive files. + type: boolean + canReadLabels: + description: >- + Output only. Whether the current user can read the labels on the + file. + type: boolean + canModifyLabels: + description: >- + Output only. Whether the current user can modify the labels on + the file. + type: boolean + canModifyEditorContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions on the file which are editor restricted. + type: boolean + canModifyOwnerContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions which are owner restricted. + type: boolean + canRemoveContentRestriction: + description: >- + Output only. Whether there is a content restriction on the file + that can be removed by the current user. + type: boolean + hasAugmentedPermissions: + description: >- + Output only. Whether there are permissions directly on this file. + This field is only populated for items in shared drives. + type: boolean + trashingUser: + description: >- + Output only. If the file has been explicitly trashed, the user who + trashed it. Only populated for items in shared drives. + $ref: '#/components/schemas/User' + canReadRevisions: + description: >- + Output only. Deprecated: Use `capabilities/canReadRevisions` + instead. + deprecated: true + type: boolean + thumbnailVersion: + description: >- + Output only. The thumbnail version for use in thumbnail cache + invalidation. + type: string + format: int64 + trashedDate: + description: >- + The time that the item was trashed (formatted RFC 3339 timestamp). + Only populated for items in shared drives. + type: string + format: date-time + permissionIds: + description: >- + Output only. List of permission IDs for users with access to this + file. + type: array + items: + type: string + thumbnail: + description: >- + A thumbnail for the file. This will only be used if a standard + thumbnail cannot be generated. + type: object + properties: + image: + description: >- + The URL-safe Base64 encoded bytes of the thumbnail image. It + should conform to RFC 4648 section 5. + type: string + format: byte + mimeType: + description: The MIME type of the thumbnail. + type: string + imageMediaMetadata: + description: >- + Output only. Metadata about image media. This will only be present + for image types, and its contents will depend on what can be parsed + from the image content. + type: object + properties: + flashUsed: + description: Output only. Whether a flash was used to create the photo. + type: boolean + meteringMode: + description: Output only. The metering mode used to create the photo. + type: string + sensor: + description: Output only. The type of sensor used to create the photo. + type: string + exposureMode: + description: Output only. The exposure mode used to create the photo. + type: string + colorSpace: + description: Output only. The color space of the photo. + type: string + whiteBalance: + description: Output only. The white balance mode used to create the photo. + type: string + width: + description: Output only. The width of the image in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the image in pixels. + type: integer + format: int32 + location: + description: >- + Output only. Geographic location information stored in the + image. + type: object + properties: + latitude: + description: Output only. The latitude stored in the image. + type: number + format: double + longitude: + description: Output only. The longitude stored in the image. + type: number + format: double + altitude: + description: Output only. The altitude stored in the image. + type: number + format: double + rotation: + description: >- + Output only. The number of clockwise 90 degree rotations applied + from the image's original orientation. + type: integer + format: int32 + date: + description: >- + Output only. The date and time the photo was taken (EXIF format + timestamp). + type: string + cameraMake: + description: Output only. The make of the camera used to create the photo. + type: string + cameraModel: + description: Output only. The model of the camera used to create the photo. + type: string + exposureTime: + description: Output only. The length of the exposure, in seconds. + type: number + format: float + aperture: + description: Output only. The aperture used to create the photo (f-number). + type: number + format: float + focalLength: + description: >- + Output only. The focal length used to create the photo, in + millimeters. + type: number + format: float + isoSpeed: + description: Output only. The ISO speed used to create the photo. + type: integer + format: int32 + exposureBias: + description: Output only. The exposure bias of the photo (APEX value). + type: number + format: float + maxApertureValue: + description: >- + Output only. The smallest f-number of the lens at the focal + length used to create the photo (APEX value). + type: number + format: float + subjectDistance: + description: >- + Output only. The distance to the subject of the photo, in + meters. + type: integer + format: int32 + lens: + description: Output only. The lens used to create the photo. + type: string + videoMediaMetadata: + description: >- + Output only. Metadata about video media. This will only be present + for video types. + type: object + properties: + width: + description: Output only. The width of the video in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the video in pixels. + type: integer + format: int32 + durationMillis: + description: Output only. The duration of the video in milliseconds. + type: string + format: int64 + shortcutDetails: + description: >- + Shortcut file details. Only populated for shortcut files, which have + the mimeType field set to `application/vnd.google-apps.shortcut`. + Can only be set on `files.insert` requests. + type: object + properties: + targetId: + description: >- + The ID of the file that this shortcut points to. Can only be set + on `files.insert` requests. + type: string + targetMimeType: + description: >- + 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. + type: string + targetResourceKey: + description: Output only. The ResourceKey for the target file. + type: string + contentRestrictions: + description: >- + Restrictions for accessing the content of the file. Only populated + if such a restriction exists. + type: array + items: + $ref: '#/components/schemas/ContentRestriction' + resourceKey: + description: Output only. A key needed to access the item via a shared link. + type: string + linkShareMetadata: + description: >- + Contains details about the link URLs that clients are using to refer + to this item. + type: object + properties: + securityUpdateEligible: + description: Output only. Whether the file is eligible for security update. + type: boolean + securityUpdateEnabled: + description: >- + Output only. Whether the security update is enabled for this + file. + type: boolean + labelInfo: + description: Output only. An overview of the labels on the file. + type: object + properties: + labels: + description: >- + 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. + type: array + items: + $ref: '#/components/schemas/Label' + sha1Checksum: + description: >- + 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 is not populated for Docs Editors or + shortcut files. + type: string + sha256Checksum: + description: >- + 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 is not populated for Docs Editors or + shortcut files. + type: string + Permission: + id: Permission + description: >- + A permission for a file. A permission grants a user, group, domain, or + the world access to a file or a folder hierarchy. 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. + type: object + properties: + id: + description: >- + The ID of the user this permission refers to, and identical to the + `permissionId` in the About and Files resources. When making a + `drive.permissions.insert` request, exactly one of the `id` or + `value` fields must be specified unless the permission type is + `anyone`, in which case both `id` and `value` are ignored. + type: string + name: + description: Output only. The name for this permission. + type: string + type: + description: >- + The account type. Allowed values are: * `user` * `group` * `domain` + * `anyone` + annotations: + required: + - drive.permissions.insert + type: string + role: + description: >- + The primary role for this user. While new values may be supported in + the future, the following are currently allowed: * `owner` * + `organizer` * `fileOrganizer` * `writer` * `reader` + annotations: + required: + - drive.permissions.insert + type: string + additionalRoles: + description: >- + Additional roles for this user. Only `commenter` is currently + allowed, though more may be supported in the future. + type: array + items: + type: string + authKey: + description: Output only. Deprecated. + deprecated: true + type: string + value: + description: >- + The email address or domain name for the entity. This is used during + inserts and is not populated in responses. When making a + `drive.permissions.insert` request, exactly one of the `id` or + `value` fields must be specified unless the permission type is + `anyone`, in which case both `id` and `value` are ignored. + type: string + kind: + description: Output only. This is always `drive#permission`. + default: drive#permission + type: string + withLink: + description: Whether the link is required for this permission. + type: boolean + photoLink: + description: Output only. A link to the profile photo, if available. + type: string + selfLink: + description: Output only. A link back to this permission. + type: string + emailAddress: + description: >- + Output only. The email address of the user or group this permission + refers to. This is an output-only field which is present when the + permission type is `user` or `group`. + type: string + domain: + description: >- + Output only. The domain name of the entity this permission refers + to. This is an output-only field which is present when the + permission type is `user`, `group` or `domain`. + type: string + etag: + description: Output only. The ETag of the permission. + type: string + permissionDetails: + description: >- + Output only. Details of whether the permissions on this shared drive + item are inherited or directly on this item. This is an output-only + field which is present only for shared drive items. + readOnly: true + type: array + items: + type: object + properties: + permissionType: + description: >- + Output only. The permission type for this user. While new + values may be added in future, the following are currently + possible: * `file` * `member` + type: string + role: + description: >- + Output only. The primary role for this user. While new values + may be added in the future, the following are currently + possible: * `organizer` * `fileOrganizer` * `writer` * + `reader` + type: string + additionalRoles: + description: >- + Output only. Additional roles for this user. Only `commenter` + is currently possible, though more may be supported in the + future. + type: array + items: + type: string + inheritedFrom: + description: >- + Output only. The ID of the item from which this permission is + inherited. This is an output-only field. + type: string + inherited: + description: >- + Output only. Whether this permission is inherited. This field + is always populated. This is an output-only field. + type: boolean + expirationDate: + description: >- + The time at which this permission will expire (RFC 3339 date-time). + Expiration dates have the following restrictions: - They can only be + set on user and group permissions - The date must be in the future - + The date cannot be more than a year in the future - The date can + only be set on drive.permissions.update or drive.permissions.patch + requests + type: string + format: date-time + teamDrivePermissionDetails: + description: 'Output only. Deprecated: Use `permissionDetails` instead.' + readOnly: true + deprecated: true + type: array + items: + type: object + properties: + teamDrivePermissionType: + description: >- + Output only. Deprecated: Use + `permissionDetails/permissionType` instead. + deprecated: true + type: string + role: + description: 'Output only. Deprecated: Use `permissionDetails/role` instead.' + deprecated: true + type: string + additionalRoles: + description: >- + Output only. Deprecated: Use + `permissionDetails/additionalRoles` instead. + deprecated: true + type: array + items: + type: string + inheritedFrom: + description: >- + Output only. Deprecated: Use `permissionDetails/inheritedFrom` + instead. + deprecated: true + type: string + inherited: + description: >- + Output only. Deprecated: Use `permissionDetails/inherited` + instead. + deprecated: true + type: boolean + deleted: + description: >- + Output only. Whether the account associated with this permission has + been deleted. This field only pertains to user and group + permissions. + type: boolean + view: + description: >- + Indicates the view for this permission. Only populated for + permissions that belong to a view. `published` is the only supported + value. + type: string + pendingOwner: + description: >- + Whether the account associated with this permission is a pending + owner. Only populated for `user` type permissions for files that are + not in a shared drive. + type: boolean + ParentReference: + id: ParentReference + description: >- + A reference to a file's parent. A file can only have one parent folder; + specifying multiple parents isn't supported. Some resource methods (such + as `parents.get`) require a `parentId`. Use the `parents.list` method to + retrieve the ID for a parent. + type: object + properties: + selfLink: + description: Output only. A link back to this reference. + type: string + id: + description: The ID of the parent. + annotations: + required: + - drive.parents.insert + type: string + isRoot: + description: Output only. Whether or not the parent is the root folder. + type: boolean + kind: + description: Output only. This is always `drive#parentReference`. + default: drive#parentReference + type: string + parentLink: + description: Output only. A link to the parent. + type: string + Property: + id: Property + description: >- + A key-value pair attached to a file that is either public or private to + an application. The following limits apply to file properties: * Maximum + of 100 properties total per file * Maximum of 30 private properties per + app * Maximum of 30 public properties * Maximum of 124 bytes size limit + on (key + value) string in UTF-8 encoding for a single property Some + resource methods (such as `properties.update`) require a `propertyKey`. + Use the `properties.list` method to retrieve the key for a property. + type: object + properties: + selfLink: + description: Output only. The link back to this property. + type: string + value: + description: The value of this property. + type: string + visibility: + description: >- + The visibility of this property. Allowed values are PRIVATE + (default) and PUBLIC. Private 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. + type: string + kind: + description: Output only. This is always `drive#property`. + default: drive#property + type: string + etag: + description: Output only. ETag of the property. + type: string + key: + description: The key of this property. + annotations: + required: + - drive.properties.insert + type: string + ContentRestriction: + id: ContentRestriction + description: A restriction for accessing the content of the file. + type: object + properties: + readOnly: + description: >- + 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. + type: boolean + reason: + description: >- + Reason for why the content of the file is restricted. This is only + mutable on requests that also set `readOnly=true`. + type: string + type: + description: >- + Output only. The type of the content restriction. Currently the only + possible value is `globalContentRestriction`. + type: string + restrictingUser: + description: >- + Output only. The user who set the content restriction. Only + populated if `readOnly` is true. + $ref: '#/components/schemas/User' + restrictionDate: + description: >- + The time at which the content restriction was set (formatted RFC + 3339 timestamp). Only populated if readOnly is true. + type: string + format: date-time + ownerRestricted: + description: >- + 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. + type: boolean + systemRestricted: + description: >- + 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. + type: boolean + Label: + id: Label + description: Representation of a label and label fields. + type: object + properties: + id: + description: The ID of the label. + type: string + revisionId: + description: The revision ID of the label. + type: string + kind: + description: This is always `drive#label` + default: drive#label + type: string + fields: + description: A map of the fields on the label, keyed by the field's ID. + type: object + additionalProperties: + $ref: '#/components/schemas/LabelField' + LabelField: + id: LabelField + description: Representation of field, which is a typed key-value pair. + type: object + properties: + kind: + description: This is always `drive#labelField`. + default: drive#labelField + type: string + id: + description: The identifier of this label field. + type: string + valueType: + description: >- + The field type. While new values may be supported in the future, the + following are currently allowed: * `dateString` * `integer` * + `selection` * `text` * `user` + type: string + dateString: + description: >- + Only present if valueType is dateString. RFC 3339 formatted date: + YYYY-MM-DD. + type: array + items: + type: string + format: date + integer: + description: Only present if `valueType` is `integer`. + type: array + items: + type: string + format: int64 + selection: + description: Only present if `valueType` is `selection` + type: array + items: + type: string + text: + description: Only present if `valueType` is `text`. + type: array + items: + type: string + user: + description: Only present if `valueType` is `user`. + type: array + items: + $ref: '#/components/schemas/User' + TeamDrive: + id: TeamDrive + description: 'Deprecated: Use the `drive` collection instead.' + type: object + properties: + id: + description: >- + The ID of this Team Drive which is also the ID of the top level + folder of this Team Drive. + type: string + name: + description: The name of this Team Drive. + annotations: + required: + - drive.teamdrives.insert + type: string + colorRgb: + description: >- + 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`. + type: string + kind: + description: This is always `drive#teamDrive` + default: drive#teamDrive + type: string + backgroundImageLink: + description: A short-lived link to this Team Drive's background image. + type: string + capabilities: + description: Capabilities the current user has on this Team Drive. + type: object + properties: + canAddChildren: + description: >- + Whether the current user can add children to folders in this + Team Drive. + type: boolean + canComment: + description: >- + Whether the current user can comment on files in this Team + Drive. + type: boolean + canCopy: + description: Whether the current user can copy files in this Team Drive. + type: boolean + canDeleteTeamDrive: + description: >- + 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. + type: boolean + canDownload: + description: Whether the current user can download files in this Team Drive. + type: boolean + canEdit: + description: Whether the current user can edit files in this Team Drive + type: boolean + canListChildren: + description: >- + Whether the current user can list the children of folders in + this Team Drive. + type: boolean + canManageMembers: + description: >- + Whether the current user can add members to this Team Drive or + remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Whether the current user can read the revisions resource of + files in this Team Drive. + type: boolean + canRemoveChildren: + description: >- + Deprecated: Use `canDeleteChildren` or `canTrashChildren` + instead. + deprecated: true + type: boolean + canRename: + description: >- + Whether the current user can rename files or folders in this + Team Drive. + type: boolean + canRenameTeamDrive: + description: Whether the current user can rename this Team Drive. + type: boolean + canChangeTeamDriveBackground: + description: >- + Whether the current user can change the background of this Team + Drive. + type: boolean + canShare: + description: >- + Whether the current user can share files or folders in this Team + Drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Whether the current user can change the + `copyRequiresWriterPermission` restriction of this Team Drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Whether the current user can change the `domainUsersOnly` + restriction of this Team Drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + Team Drive. + type: boolean + canChangeTeamMembersOnlyRestriction: + description: >- + Whether the current user can change the `teamMembersOnly` + restriction of this Team Drive. + type: boolean + canDeleteChildren: + description: >- + Whether the current user can delete children from folders in + this Team Drive. + type: boolean + canTrashChildren: + description: >- + Whether the current user can trash children from folders in this + Team Drive. + type: boolean + canResetTeamDriveRestrictions: + description: >- + Whether the current user can reset the Team Drive restrictions + to defaults. + type: boolean + themeId: + description: >- + 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.insert` 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`. + type: string + backgroundImageFile: + description: >- + An image file and cropping parameters from which a background image + for this Team Drive is set. This is a write only field; it can only + be set on `drive.teamdrives.update` requests that don't set + `themeId`. When specified, all fields of the `backgroundImageFile` + must be set. + type: object + properties: + id: + description: >- + The ID of an image file in Drive to use for the background + image. + type: string + xCoordinate: + description: >- + 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. + type: number + format: float + yCoordinate: + description: >- + 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. + type: number + format: float + width: + description: >- + 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. + type: number + format: float + createdDate: + description: The time at which the Team Drive was created (RFC 3339 date-time). + type: string + format: date-time + restrictions: + description: >- + A set of restrictions that apply to this Team Drive or items inside + this Team Drive. + type: object + properties: + copyRequiresWriterPermission: + description: >- + 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. + type: boolean + domainUsersOnly: + description: >- + 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. + type: boolean + teamMembersOnly: + description: >- + Whether access to items inside this Team Drive is restricted to + members of this Team Drive. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this Team Drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + 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. + type: boolean + orgUnitId: + description: >- + The organizational unit of this shared drive. This field is only + populated on `drives.list` responses when the `useDomainAdminAccess` + parameter is set to `true`. + type: string + Drive: + id: Drive + description: >- + 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. + type: object + properties: + id: + description: >- + Output only. The ID of this shared drive which is also the ID of the + top level folder of this shared drive. + type: string + name: + description: The name of this shared drive. + annotations: + required: + - drive.drives.insert + type: string + colorRgb: + description: >- + 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`. + type: string + kind: + description: Output only. This is always `drive#drive` + default: drive#drive + type: string + backgroundImageLink: + description: >- + Output only. A short-lived link to this shared drive's background + image. + type: string + capabilities: + description: Output only. Capabilities the current user has on this shared drive. + type: object + properties: + canAddChildren: + description: >- + Output only. Whether the current user can add children to + folders in this shared drive. + type: boolean + canComment: + description: >- + Output only. Whether the current user can comment on files in + this shared drive. + type: boolean + canCopy: + description: >- + Output only. Whether the current user can copy files in this + shared drive. + type: boolean + canDeleteDrive: + description: >- + 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. + type: boolean + canDownload: + description: >- + Output only. Whether the current user can download files in this + shared drive. + type: boolean + canEdit: + description: >- + Output only. Whether the current user can edit files in this + shared drive + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + folders in this shared drive. + type: boolean + canManageMembers: + description: >- + Output only. Whether the current user can add members to this + shared drive or remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Output only. Whether the current user can read the revisions + resource of files in this shared drive. + type: boolean + canRename: + description: >- + Output only. Whether the current user can rename files or + folders in this shared drive. + type: boolean + canRenameDrive: + description: >- + Output only. Whether the current user can rename this shared + drive. + type: boolean + canChangeDriveBackground: + description: >- + Output only. Whether the current user can change the background + of this shared drive. + type: boolean + canShare: + description: >- + Output only. Whether the current user can share files or folders + in this shared drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this shared drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `domainUsersOnly` restriction of this shared drive. + type: boolean + canChangeDriveMembersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `driveMembersOnly` restriction of this shared drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + shared drive. + type: boolean + canResetDriveRestrictions: + description: >- + Output only. Whether the current user can reset the shared drive + restrictions to defaults. + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children from + folders in this shared drive. + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children from + folders in this shared drive. + type: boolean + themeId: + description: >- + 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.insert` 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`. + type: string + backgroundImageFile: + description: >- + 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. + type: object + properties: + id: + description: >- + The ID of an image file in Google Drive to use for the + background image. + type: string + xCoordinate: + description: >- + 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. + type: number + format: float + yCoordinate: + description: >- + 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. + type: number + format: float + width: + description: >- + 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. + type: number + format: float + createdDate: + description: The time at which the shared drive was created (RFC 3339 date-time). + type: string + format: date-time + hidden: + description: Whether the shared drive is hidden from default view. + type: boolean + restrictions: + description: >- + A set of restrictions that apply to this shared drive or items + inside this shared drive. + type: object + properties: + copyRequiresWriterPermission: + description: >- + 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. + type: boolean + domainUsersOnly: + description: >- + 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. + type: boolean + driveMembersOnly: + description: >- + Whether access to items inside this shared drive is restricted + to its members. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this shared drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + 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. + type: boolean + orgUnitId: + description: >- + 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`. + type: string + StartPageToken: + id: StartPageToken + type: object + properties: + startPageToken: + description: The starting page token for listing changes. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#startPageToken"`. + default: drive#startPageToken + type: string + ChangeList: + id: ChangeList + description: A list of changes for a user. + type: object + properties: + largestChangeId: + description: The current largest change ID. + type: string + format: int64 + nextPageToken: + description: >- + The page token for the next page of changes. This will be absent if + the end of the changes 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. + type: string + kind: + description: This is always `drive#changeList`. + default: drive#changeList + type: string + etag: + description: The ETag of the list. + type: string + newStartPageToken: + description: >- + The starting page token for future changes. This will be present + only if the end of the current changes list has been reached. + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of changes. + type: string + items: + description: >- + The list of changes. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Change' + Channel: + id: Channel + description: A notification channel used to watch for resource changes. + type: object + properties: + payload: + description: A Boolean value to indicate whether payload is wanted. Optional. + type: boolean + id: + description: A UUID or similar unique string that identifies this channel. + type: string + resourceId: + description: >- + An opaque ID that identifies the resource being watched on this + channel. Stable across different API versions. + type: string + resourceUri: + description: A version-specific identifier for the watched resource. + type: string + token: + description: >- + An arbitrary string delivered to the target address with each + notification delivered over this channel. Optional. + type: string + expiration: + description: >- + Date and time of notification channel expiration, expressed as a + Unix timestamp, in milliseconds. Optional. + type: string + format: int64 + type: + description: >- + The type of delivery mechanism used for this channel. Valid values + are "web_hook" or "webhook". + type: string + address: + description: The address where notifications are delivered for this channel. + type: string + params: + description: >- + Additional parameters controlling delivery channel behavior. + Optional. + type: object + additionalProperties: + type: string + kind: + description: >- + Identifies this as a notification channel used to watch for changes + to a resource, which is `api#channel`. + default: api#channel + type: string + ChildReference: + id: ChildReference + description: >- + A reference to a folder's child. Some resource methods (such as + `children.get`) require a `childId`. Use the `children.list` method to + retrieve the ID of the child. + type: object + properties: + id: + description: The ID of the child. + annotations: + required: + - drive.children.insert + type: string + selfLink: + description: Output only. A link back to this reference. + type: string + kind: + description: Output only. This is always `drive#childReference`. + default: drive#childReference + type: string + childLink: + description: Output only. A link to the child. + type: string + ChildList: + id: ChildList + description: A list of children of a file. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of children. This will be absent if + the end of the children 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. + type: string + kind: + description: This is always `drive#childList`. + default: drive#childList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of children. + type: string + items: + description: >- + The list of children. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/ChildReference' + Comment: + id: Comment + description: >- + A comment on a file in Google Drive. 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. + type: object + properties: + commentId: + description: Output only. The ID of the comment. + type: string + kind: + description: Output only. This is always `drive#comment`. + default: drive#comment + type: string + createdDate: + description: The date when this comment was first created. + type: string + format: date-time + modifiedDate: + description: The date when this comment or any of its replies were last modified. + type: string + format: date-time + fileId: + description: Output only. The file which this comment is addressing. + type: string + status: + description: >- + Output only. The status of this comment. Status can be changed by + posting a reply to a comment with the desired status. * `open` - The + comment is still open. * `resolved` - The comment has been resolved + by one of its replies. + type: string + anchor: + description: >- + A region of the document represented as a JSON string. For details + on defining anchor properties, refer to [Add comments and + replies](https://developers.google.com/drive/api/v2/manage-comments). + type: string + replies: + description: Output only. Replies to this post. + type: array + items: + $ref: '#/components/schemas/CommentReply' + author: + description: >- + Output only. The author of the comment. The author's email address + and permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether this comment has been deleted. If a comment has + been deleted the content will be cleared and this will only + represent a comment that once existed. + type: boolean + selfLink: + description: Output only. A link back to this comment. + type: string + htmlContent: + description: Output only. HTML formatted content for this comment. + type: string + content: + description: >- + The plain text content used to create this comment. This is not HTML + safe and should only be used as a starting point to make edits to a + comment's content. + annotations: + required: + - drive.comments.insert + - drive.comments.patch + - drive.comments.update + type: string + context: + description: The context of the file which is being commented on. + type: object + properties: + type: + description: The MIME type of the context snippet. + type: string + value: + description: >- + Data representation of the segment of the file being commented + on. In the case of a text file for example, this would be the + actual text that the comment is about. + type: string + fileTitle: + description: Output only. The title of the file which this comment is addressing. + type: string + CommentReply: + id: CommentReply + description: >- + A comment on a file in Google Drive. Some resource methods (such as + `replies.update`) require a `replyId`. Use the `replies.list` method to + retrieve the ID for a reply. + type: object + properties: + replyId: + description: Output only. The ID of the reply. + type: string + kind: + description: Output only. This is always `drive#commentReply`. + default: drive#commentReply + type: string + createdDate: + description: The date when this reply was first created. + type: string + format: date-time + modifiedDate: + description: The date when this reply was last modified. + type: string + format: date-time + verb: + description: >- + The action this reply performed to the parent comment. When creating + a new reply this is the action to be perform to the parent comment. + Possible values are: * `resolve` - To resolve a comment. * `reopen` + - To reopen (un-resolve) a comment. + type: string + author: + description: >- + Output only. The author of the reply. The author's email address and + permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether this reply has been deleted. If a reply has + been deleted the content will be cleared and this will only + represent a reply that once existed. + type: boolean + htmlContent: + description: Output only. HTML formatted content for this reply. + type: string + content: + description: >- + The plain text content used to create this reply. This is not HTML + safe and should only be used as a starting point to make edits to a + reply's content. This field is required on inserts if no verb is + specified (resolve/reopen). + annotations: + required: + - drive.replies.patch + - drive.replies.update + type: string + CommentList: + id: CommentList + description: A list of comments on a file in Google Drive. + type: object + properties: + kind: + description: This is always `drive#commentList`. + default: drive#commentList + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of comments. + type: string + items: + description: >- + The list of comments. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Comment' + nextPageToken: + description: >- + 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. + type: string + DriveList: + id: DriveList + description: A list of shared drives. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: This is always `drive#driveList` + default: drive#driveList + type: string + items: + description: >- + The list of shared drives. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Drive' + GeneratedIds: + id: GeneratedIds + description: A list of generated IDs which can be provided in insert requests + type: object + properties: + ids: + description: The IDs generated for the requesting user in the specified space. + type: array + items: + type: string + space: + description: The type of file that can be created with these IDs. + type: string + kind: + description: This is always `drive#generatedIds` + default: drive#generatedIds + type: string + FileList: + id: FileList + description: A list of files. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: This is always `drive#fileList`. + default: drive#fileList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + incompleteSearch: + description: >- + Whether the search process was incomplete. If true, then some search + results may be missing, since all documents were not searched. This + may occur when searching multiple drives with the "allDrives" + corpora, but all corpora could not be searched. When this happens, + it is suggested that clients narrow their query by choosing a + different corpus such as "default" or "drive". + type: boolean + nextLink: + description: A link to the next page of files. + type: string + items: + description: >- + The list of files. If nextPageToken is populated, then this list may + be incomplete and an additional page of results should be fetched. + type: array + items: + $ref: '#/components/schemas/File' + LabelList: + id: LabelList + description: A list of labels applied to a file. + type: object + properties: + items: + description: The list of labels. + type: array + items: + $ref: '#/components/schemas/Label' + nextPageToken: + description: >- + 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. + type: string + kind: + description: This is always `drive#labelList` + default: drive#labelList + type: string + ModifyLabelsRequest: + id: ModifyLabelsRequest + description: >- + 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. + type: object + properties: + labelModifications: + description: The list of modifications to apply to the labels on the file. + type: array + items: + $ref: '#/components/schemas/LabelModification' + kind: + description: This is always `drive#modifyLabelsRequest`. + default: drive#modifyLabelsRequest + type: string + LabelModification: + id: LabelModification + description: >- + 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. + type: object + properties: + labelId: + description: The ID of the label to modify. + annotations: + required: + - drive.files.modifyLabels + type: string + fieldModifications: + description: The list of modifications to this label's fields. + type: array + items: + $ref: '#/components/schemas/LabelFieldModification' + removeLabel: + description: If true, the label will be removed from the file. + type: boolean + kind: + description: This is always `drive#labelModification`. + default: drive#labelModification + type: string + LabelFieldModification: + id: LabelFieldModification + description: A modification to a label's field. + type: object + properties: + fieldId: + description: The ID of the field to be modified. + type: string + kind: + description: This is always `drive#labelFieldModification`. + default: drive#labelFieldModification + type: string + setDateValues: + description: >- + 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. + type: array + items: + type: string + format: date + setTextValues: + description: Sets the value of a `text` field. + type: array + items: + type: string + setSelectionValues: + description: Replaces a `selection` field with these new values. + type: array + items: + type: string + setIntegerValues: + description: Replaces the value of an `integer` field with these new values. + type: array + items: + type: string + format: int64 + setUserValues: + description: >- + Replaces a `user` field with these new values. The values must be + valid email addresses. + type: array + items: + type: string + unsetValues: + description: Unsets the values for this field. + type: boolean + ModifyLabelsResponse: + id: ModifyLabelsResponse + description: >- + Response to a ModifyLabels request. This contains only those labels + which were added or updated by the request. + type: object + properties: + modifiedLabels: + description: The list of labels which were added or updated by the request. + type: array + items: + $ref: '#/components/schemas/Label' + kind: + description: This is always `drive#modifyLabelsResponse` + default: drive#modifyLabelsResponse + type: string + ParentList: + id: ParentList + description: A list of a file's parents. + type: object + properties: + kind: + description: This is always `drive#parentList`. + default: drive#parentList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of parents. + type: array + items: + $ref: '#/components/schemas/ParentReference' + PermissionId: + id: PermissionId + description: An ID for a user or group as seen in Permission items. + type: object + properties: + kind: + description: This is always `drive#permissionId`. + default: drive#permissionId + type: string + id: + description: The permission ID. + type: string + PermissionList: + id: PermissionList + description: A list of permissions associated with a file. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: This is always `drive#permissionList`. + default: drive#permissionList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of permissions. + type: array + items: + $ref: '#/components/schemas/Permission' + PropertyList: + id: PropertyList + description: >- + A collection of properties, key-value pairs that are either public or + private to an application. + type: object + properties: + kind: + description: This is always `drive#propertyList`. + default: drive#propertyList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: The link back to this list. + type: string + items: + description: The list of properties. + type: array + items: + $ref: '#/components/schemas/Property' + CommentReplyList: + id: CommentReplyList + description: A list of replies to a comment on a file in Google Drive. + type: object + properties: + kind: + description: This is always `drive#commentReplyList`. + default: drive#commentReplyList + type: string + selfLink: + description: A link back to this list. + type: string + nextLink: + description: A link to the next page of replies. + type: string + items: + description: >- + The list of replies. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/CommentReply' + nextPageToken: + description: >- + 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. + type: string + Revision: + id: Revision + description: >- + A revision of a file. Some resource methods (such as `revisions.update`) + require a `revisionId`. Use the `revisions.list` method to retrieve the + ID for a revision. + type: object + properties: + id: + description: Output only. The ID of the revision. + type: string + mimeType: + description: Output only. The MIME type of the revision. + type: string + kind: + description: Output only. This is always `drive#revision`. + default: drive#revision + type: string + published: + description: >- + Whether this revision is published. This is only populated and can + only be modified for Docs Editors files. + type: boolean + etag: + description: Output only. The ETag of the revision. + type: string + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + type: object + additionalProperties: + type: string + pinned: + description: >- + Whether this revision is pinned to prevent automatic purging. If not + set, the revision is automatically purged 30 days after newer + content is uploaded. This field can only be modified on files with + content stored in Drive, excluding Docs Editors files. Revisions can + also be pinned when they are created through the + drive.files.insert/update/copy by using the pinned query parameter. + Pinned revisions are stored indefinitely using additional storage + quota, up to a maximum of 200 revisions. + type: boolean + md5Checksum: + description: >- + Output only. An MD5 checksum for the content of this revision. This + will only be populated on files with content stored in Drive. + type: string + modifiedDate: + description: Last time this revision was modified (formatted RFC 3339 timestamp). + type: string + format: date-time + lastModifyingUserName: + description: Output only. Name of the last user to modify this revision. + type: string + downloadUrl: + description: >- + Output only. Short term download URL for the file. This will only be + populated on files with content stored in Drive. + type: string + publishAuto: + description: >- + Whether subsequent revisions will be automatically republished. This + is only populated and can only be modified for Docs Editors files. + type: boolean + publishedOutsideDomain: + description: >- + Whether this revision is published outside the domain. This is only + populated and can only be modified for Docs Editors files. + type: boolean + publishedLink: + description: >- + Output only. A link to the published revision. This is only + populated for Google Sites files. + type: string + fileSize: + description: >- + Output only. The size of the revision in bytes. This will only be + populated on files with content stored in Drive. + type: string + format: int64 + originalFilename: + description: >- + Output only. The original filename when this revision was created. + This will only be populated on files with content stored in Drive. + type: string + lastModifyingUser: + description: >- + 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. + $ref: '#/components/schemas/User' + selfLink: + description: Output only. A link back to this revision. + type: string + RevisionList: + id: RevisionList + description: A list of revisions of a file. + type: object + properties: + nextPageToken: + description: >- + The page token for the next page of revisions. This field 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. + type: string + kind: + description: This is always `drive#revisionList`. + default: drive#revisionList + type: string + etag: + description: The ETag of the list. + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: >- + The list of revisions. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Revision' + TeamDriveList: + id: TeamDriveList + description: A list of Team Drives. + type: object + properties: + nextPageToken: + description: The page token for the next page of Team Drives. + type: string + kind: + description: This is always `drive#teamDriveList` + default: drive#teamDriveList + type: string + items: + description: The list of Team Drives. + type: array + items: + $ref: '#/components/schemas/TeamDrive' + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + about: + id: googleworkspace.drivev2.about + name: about + title: About + methods: + get: + operation: + $ref: '#/paths/~1about/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/about/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + apps: + id: googleworkspace.drivev2.apps + name: apps + title: Apps + methods: + get: + operation: + $ref: '#/paths/~1apps~1{appId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + changes: + id: googleworkspace.drivev2.changes + name: changes + title: Changes + methods: + get: + operation: + $ref: '#/paths/~1changes~1{changeId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1changes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + watch: + operation: + $ref: '#/paths/~1changes~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/changes/methods/get' + - $ref: '#/components/x-stackQL-resources/changes/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + changes_start_page_token: + id: googleworkspace.drivev2.changes_start_page_token + name: changes_start_page_token + title: Changes_start_page_token + methods: + get_start_page_token: + operation: + $ref: '#/paths/~1changes~1startPageToken/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/changes_start_page_token/methods/get_start_page_token + insert: [] + update: [] + replace: [] + delete: [] + channels: + id: googleworkspace.drivev2.channels + name: channels + title: Channels + methods: + stop: + operation: + $ref: '#/paths/~1channels~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + children: + id: googleworkspace.drivev2.children + name: children + title: Children + methods: + delete: + operation: + $ref: '#/paths/~1files~1{folderId}~1children~1{childId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{folderId}~1children~1{childId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{folderId}~1children/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{folderId}~1children/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/children/methods/get' + - $ref: '#/components/x-stackQL-resources/children/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/children/methods/insert' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/children/methods/delete' + comments: + id: googleworkspace.drivev2.comments + name: comments + title: Comments + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/get' + - $ref: '#/components/x-stackQL-resources/comments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/comments/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/comments/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/comments/methods/delete' + drives: + id: googleworkspace.drivev2.drives + name: drives + title: Drives + methods: + delete: + operation: + $ref: '#/paths/~1drives~1{driveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1drives~1{driveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1drives~1{driveId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + hide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1hide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1drives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1drives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + unhide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1unhide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drives/methods/get' + - $ref: '#/components/x-stackQL-resources/drives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drives/methods/insert' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/drives/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/drives/methods/delete' + files: + id: googleworkspace.drivev2.files + name: files + title: Files + methods: + copy: + operation: + $ref: '#/paths/~1files~1{fileId}~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1files~1{fileId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + empty_trash: + operation: + $ref: '#/paths/~1files~1trash/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: '#/paths/~1files~1{fileId}~1export/get' + response: + mediaType: application/json + openAPIDocKey: '200' + generate_ids: + operation: + $ref: '#/paths/~1files~1generateIds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + modify_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1modifyLabels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + touch: + operation: + $ref: '#/paths/~1files~1{fileId}~1touch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + trash: + operation: + $ref: '#/paths/~1files~1{fileId}~1trash/post' + response: + mediaType: application/json + openAPIDocKey: '200' + untrash: + operation: + $ref: '#/paths/~1files~1{fileId}~1untrash/post' + response: + mediaType: application/json + openAPIDocKey: '200' + watch: + operation: + $ref: '#/paths/~1files~1{fileId}~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files/methods/get' + - $ref: '#/components/x-stackQL-resources/files/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/files/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/files/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/files/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/files/methods/delete' + files_labels: + id: googleworkspace.drivev2.files_labels + name: files_labels + title: Files_labels + methods: + list_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1listLabels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files_labels/methods/list_labels' + insert: [] + update: [] + replace: [] + delete: [] + parents: + id: googleworkspace.drivev2.parents + name: parents + title: Parents + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents~1{parentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents~1{parentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1parents/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/parents/methods/get' + - $ref: '#/components/x-stackQL-resources/parents/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/parents/methods/insert' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/parents/methods/delete' + permissions: + id: googleworkspace.drivev2.permissions + name: permissions + title: Permissions + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + permissions_id_for_email: + id: googleworkspace.drivev2.permissions_id_for_email + name: permissions_id_for_email + title: Permissions_id_for_email + methods: + get_id_for_email: + operation: + $ref: '#/paths/~1permissionIds~1{email}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/permissions_id_for_email/methods/get_id_for_email + insert: [] + update: [] + replace: [] + delete: [] + properties: + id: googleworkspace.drivev2.properties + name: properties + title: Properties + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties~1{propertyKey}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1properties/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/properties/methods/get' + - $ref: '#/components/x-stackQL-resources/properties/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/properties/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/properties/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/properties/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/properties/methods/delete' + replies: + id: googleworkspace.drivev2.replies + name: replies + title: Replies + methods: + delete: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/replies/methods/get' + - $ref: '#/components/x-stackQL-resources/replies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/replies/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/replies/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/replies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/replies/methods/delete' + revisions: + id: googleworkspace.drivev2.revisions + name: revisions + title: Revisions + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/revisions/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/revisions/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' + teamdrives: + id: googleworkspace.drivev2.teamdrives + name: teamdrives + title: Teamdrives + methods: + delete: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: '#/paths/~1teamdrives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1teamdrives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/get' + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/insert' + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/delete' +paths: + /about: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Gets the information about the current user along with Drive API + settings + operationId: drive.about.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/About' + parameters: + - in: query + name: includeSubscribed + schema: + type: boolean + - in: query + name: maxChangeIdCount + schema: + type: string + format: int64 + - in: query + name: startChangeId + schema: + type: string + format: int64 + /apps/{appId}: + parameters: *ref_1 + get: + description: Gets a specific app. + operationId: drive.apps.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/App' + parameters: + - in: path + name: appId + required: true + schema: + type: string + /apps: + parameters: *ref_1 + get: + description: Lists a user's installed apps. + operationId: drive.apps.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AppList' + parameters: + - in: query + name: appFilterExtensions + schema: + type: string + - in: query + name: appFilterMimeTypes + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /changes/{changeId}: + parameters: *ref_1 + get: + description: >- + Deprecated: Use `changes.getStartPageToken` and `changes.list` to + retrieve recent changes. + operationId: drive.changes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Change' + parameters: + - in: path + name: changeId + required: true + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + /changes/startPageToken: + parameters: *ref_1 + get: + description: Gets the starting pageToken for listing future changes. + operationId: drive.changes.getStartPageToken + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/StartPageToken' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + /changes: + parameters: *ref_1 + get: + description: Lists the changes for a user or shared drive. + operationId: drive.changes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeList' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeSubscribed + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: startChangeId + schema: + type: string + format: int64 + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /changes/watch: + parameters: *ref_1 + post: + description: Subscribe to changes for a user. + operationId: drive.changes.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeSubscribed + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: startChangeId + schema: + type: string + format: int64 + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /channels/stop: + parameters: *ref_1 + post: + description: Stops watching resources through this channel. + operationId: drive.channels.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: [] + /files/{folderId}/children/{childId}: + parameters: *ref_1 + delete: + description: Removes a child from a folder. + operationId: drive.children.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: path + name: childId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: Gets a specific child reference. + operationId: drive.children.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChildReference' + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: path + name: childId + required: true + schema: + type: string + /files/{folderId}/children: + parameters: *ref_1 + post: + description: Inserts a file into a folder. + operationId: drive.children.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChildReference' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChildReference' + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + get: + description: Lists a folder's children. + operationId: drive.children.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChildList' + parameters: + - in: path + name: folderId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + /files/{fileId}/comments/{commentId}: + parameters: *ref_1 + delete: + description: Deletes a comment. + operationId: drive.comments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Gets a comment by ID. + operationId: drive.comments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates an existing comment. + operationId: drive.comments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + put: + description: Updates an existing comment. + operationId: drive.comments.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + /files/{fileId}/comments: + parameters: *ref_1 + post: + description: Creates a new comment on the given file. + operationId: drive.comments.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + get: + description: Lists a file's comments. + operationId: drive.comments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: updatedMin + schema: + type: string + /drives/{driveId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a shared drive for which the user is an `organizer`. + The shared drive cannot contain any untrashed items. + operationId: drive.drives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: allowItemDeletion + schema: + type: boolean + get: + description: Gets a shared drive's metadata by ID. + operationId: drive.drives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + put: + description: Updates the metadata for a shared drive. + operationId: drive.drives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}/hide: + parameters: *ref_1 + post: + description: Hides a shared drive from the default view. + operationId: drive.drives.hide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /drives: + parameters: *ref_1 + post: + description: Creates a new shared drive. + operationId: drive.drives.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: ' Lists the user''s shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.' + operationId: drive.drives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DriveList' + parameters: + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}/unhide: + parameters: *ref_1 + post: + description: Restores a shared drive to the default view. + operationId: drive.drives.unhide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /files/{fileId}/copy: + parameters: *ref_1 + post: + description: Creates a copy of the specified file. + operationId: drive.files.copy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: visibility + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file owned by the user without moving it to the + trash. If the file belongs to a shared drive, the user must be an + `organizer` on the parent folder. If the target is a folder, all + descendants owned by the user are also deleted. + operationId: drive.files.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: ' Gets a file''s metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).' + operationId: drive.files.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: projection + schema: + type: string + - in: query + name: revisionId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + patch: + description: >- + Updates a file's metadata and/or content. When calling this method, only + populate fields in the request that you want to modify. When updating + fields, some fields might change automatically, such as modifiedDate. + This method supports patch semantics. + operationId: drive.files.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.scripts + Oauth2c: + - https://www.googleapis.com/auth/drive.scripts + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: addParents + schema: + type: string + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: modifiedDateBehavior + schema: + type: string + - in: query + name: newRevision + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: removeParents + schema: + type: string + - in: query + name: setModifiedDate + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + put: + description: ' Updates a file''s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).' + operationId: drive.files.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.scripts + Oauth2c: + - https://www.googleapis.com/auth/drive.scripts + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: addParents + schema: + type: string + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: modifiedDateBehavior + schema: + type: string + - in: query + name: newRevision + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: removeParents + schema: + type: string + - in: query + name: setModifiedDate + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/trash: + parameters: *ref_1 + delete: + description: Permanently deletes all of the user's trashed files. + operationId: drive.files.emptyTrash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: driveId + schema: + type: string + /files/{fileId}/export: + parameters: *ref_1 + get: + description: >- + Exports a Google Workspace document to the requested MIME type and + returns exported byte content. Note that the exported content is limited + to 10MB. + operationId: drive.files.export + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: mimeType + required: true + schema: + type: string + /files/generateIds: + parameters: *ref_1 + get: + description: >- + Generates a set of file IDs which can be provided in insert or copy + requests. + operationId: drive.files.generateIds + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GeneratedIds' + parameters: + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: space + schema: + type: string + - in: query + name: type + schema: + type: string + /files: + parameters: *ref_1 + post: + description: ' Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file''s MIME type.' + operationId: drive.files.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: query + name: convert + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ocr + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: pinned + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: timedTextLanguage + schema: + type: string + - in: query + name: timedTextTrackName + schema: + type: string + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: visibility + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + get: + description: ' Lists the user''s files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don''t want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.' + operationId: drive.files.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FileList' + parameters: + - in: query + name: corpora + schema: + type: string + - in: query + name: corpus + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: projection + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/listLabels: + parameters: *ref_1 + get: + description: Lists the labels on a file. + operationId: drive.files.listLabels + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LabelList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/modifyLabels: + parameters: *ref_1 + post: + description: >- + Modifies the set of labels applied to a file. Returns a list of the + labels that were added or modified. + operationId: drive.files.modifyLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsResponse' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/touch: + parameters: *ref_1 + post: + description: Set the file's updated time to the current server time. + operationId: drive.files.touch + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/trash: + parameters: *ref_1 + post: + description: >- + Moves a file to the trash. The currently authenticated user must own the + file or be at least a `fileOrganizer` on the parent for shared drive + files. + operationId: drive.files.trash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/untrash: + parameters: *ref_1 + post: + description: >- + Restores a file from the trash. The currently authenticated user must + own the file or be at least a `fileOrganizer` on the parent for shared + drive files. + operationId: drive.files.untrash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/watch: + parameters: *ref_1 + post: + description: Subscribes to changes to a file. + operationId: drive.files.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: revisionId + schema: + type: string + - in: query + name: updateViewedDate + schema: + type: boolean + - in: query + name: projection + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/parents/{parentId}: + parameters: *ref_1 + delete: + description: Removes a parent from a file. + operationId: drive.parents.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: parentId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: Gets a specific parent reference. + operationId: drive.parents.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParentReference' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: parentId + required: true + schema: + type: string + /files/{fileId}/parents: + parameters: *ref_1 + post: + description: Adds a parent folder for a file. + operationId: drive.parents.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ParentReference' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParentReference' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + get: + description: Lists a file's parents. + operationId: drive.parents.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParentList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/permissions/{permissionId}: + parameters: *ref_1 + delete: + description: >- + Deletes a permission from a file or shared drive. **Warning:** + Concurrent permissions operations on the same file are not supported; + only the last update is applied. + operationId: drive.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Gets a permission by ID. + operationId: drive.permissions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: >- + Updates a permission using patch semantics. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: removeExpiration + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + put: + description: >- + Updates a permission. **Warning:** Concurrent permissions operations on + the same file are not supported; only the last update is applied. + operationId: drive.permissions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: removeExpiration + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /permissionIds/{email}: + parameters: *ref_1 + get: + description: Returns the permission ID for an email address. + operationId: drive.permissions.getIdForEmail + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionId' + parameters: + - in: path + name: email + required: true + schema: + type: string + /files/{fileId}/permissions: + parameters: *ref_1 + post: + description: >- + Inserts a permission for a file or shared drive. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: emailMessage + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: moveToNewOwnersRoot + schema: + type: boolean + - in: query + name: sendNotificationEmails + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Lists a file's or shared drive's permissions. + operationId: drive.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + /files/{fileId}/properties/{propertyKey}: + parameters: *ref_1 + delete: + description: Deletes a property. + operationId: drive.properties.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + get: + description: Gets a property by its key. + operationId: drive.properties.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + patch: + description: Updates a property. + operationId: drive.properties.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + put: + description: Updates a property. + operationId: drive.properties.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: propertyKey + required: true + schema: + type: string + - in: query + name: visibility + schema: + type: string + /files/{fileId}/properties: + parameters: *ref_1 + post: + description: Adds a property to a file, or updates it if it already exists. + operationId: drive.properties.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Property' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + get: + description: Lists a file's properties. + operationId: drive.properties.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PropertyList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/comments/{commentId}/replies/{replyId}: + parameters: *ref_1 + delete: + description: Deletes a reply. + operationId: drive.replies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + get: + description: Gets a reply. + operationId: drive.replies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates an existing reply. + operationId: drive.replies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + put: + description: Updates an existing reply. + operationId: drive.replies.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + /files/{fileId}/comments/{commentId}/replies: + parameters: *ref_1 + post: + description: Creates a new reply to the given comment. + operationId: drive.replies.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Lists all of the replies to a comment. + operationId: drive.replies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentReplyList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/revisions/{revisionId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file version. You can only delete revisions for + files with binary content, like images or videos. Revisions for other + files, like Google Docs or Sheets, and the last remaining file version + can't be deleted. + operationId: drive.revisions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + get: + description: Gets a specific revision. + operationId: drive.revisions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + patch: + description: Updates a revision. + operationId: drive.revisions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + put: + description: Updates a revision. + operationId: drive.revisions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + /files/{fileId}/revisions: + parameters: *ref_1 + get: + description: Lists a file's revisions. + operationId: drive.revisions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RevisionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /teamdrives/{teamDriveId}: + parameters: *ref_1 + delete: + description: 'Deprecated: Use `drives.delete` instead.' + operationId: drive.teamdrives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.get` instead.' + operationId: drive.teamdrives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + put: + description: 'Deprecated: Use `drives.update` instead.' + operationId: drive.teamdrives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /teamdrives: + parameters: *ref_1 + post: + description: 'Deprecated: Use `drives.insert` instead.' + operationId: drive.teamdrives.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.list` instead.' + operationId: drive.teamdrives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDriveList' + parameters: + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean diff --git a/providers/src/googleworkspace/v00.00.00000/services/drivev3.yaml b/providers/src/googleworkspace/v00.00.00000/services/drivev3.yaml new file mode 100644 index 00000000..3c2a93f7 --- /dev/null +++ b/providers/src/googleworkspace/v00.00.00000/services/drivev3.yaml @@ -0,0 +1,6115 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Google Drive API + description: The Google Drive API allows clients to access resources from Google Drive. + version: v3 + x-discovery-doc-revision: '20241202' + x-generated-date: '2024-12-07' +externalDocs: + url: https://developers.google.com/drive/ +servers: + - url: https://www.googleapis.com/drive/v3 +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/drive: See, edit, create, and delete all of your Google Drive files + https://www.googleapis.com/auth/drive.appdata: >- + See, create, and delete its own configuration data in your Google + Drive + https://www.googleapis.com/auth/drive.apps.readonly: View your Google Drive apps + https://www.googleapis.com/auth/drive.file: >- + See, edit, create, and delete only the specific Google Drive files + you use with this app + https://www.googleapis.com/auth/drive.meet.readonly: >- + See and download your Google Drive files that were created or + edited by Google Meet. + https://www.googleapis.com/auth/drive.metadata: View and manage metadata of files in your Google Drive + https://www.googleapis.com/auth/drive.metadata.readonly: See information about your Google Drive files + https://www.googleapis.com/auth/drive.photos.readonly: View the photos, videos and albums in your Google Photos + https://www.googleapis.com/auth/drive.readonly: See and download all your Google Drive files + https://www.googleapis.com/auth/drive.scripts: Modify your Google Apps Script scripts' behavior + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + 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}`. + type: string + metadata: + description: >- + 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. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + 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. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + 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`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + 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). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + 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. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + About: + id: About + description: Information about the user, the user's Drive, and system capabilities. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#about"`. + default: drive#about + type: string + storageQuota: + description: >- + 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. + type: object + properties: + limit: + description: >- + 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. + type: string + format: int64 + usageInDrive: + description: The usage by all files in Google Drive. + type: string + format: int64 + usageInDriveTrash: + description: The usage by trashed files in Google Drive. + type: string + format: int64 + usage: + description: >- + 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. + type: string + format: int64 + driveThemes: + description: A list of themes that are supported for shared drives. + type: array + items: + type: object + properties: + id: + description: The ID of the theme. + type: string + backgroundImageLink: + description: A link to this theme's background image. + type: string + colorRgb: + description: The color of this theme as an RGB hex string. + type: string + canCreateDrives: + description: Whether the user can create shared drives. + type: boolean + importFormats: + description: >- + A map of source MIME type to possible targets for all supported + imports. + type: object + additionalProperties: + type: array + items: + type: string + exportFormats: + description: >- + A map of source MIME type to possible targets for all supported + exports. + type: object + additionalProperties: + type: array + items: + type: string + appInstalled: + description: Whether the user has installed the requesting app. + type: boolean + user: + description: The authenticated user. + $ref: '#/components/schemas/User' + folderColorPalette: + description: The currently supported folder colors as RGB hex strings. + type: array + items: + type: string + maxImportSizes: + description: A map of maximum import sizes by MIME type, in bytes. + type: object + additionalProperties: + type: string + format: int64 + maxUploadSize: + description: The maximum upload size in bytes. + type: string + format: int64 + teamDriveThemes: + description: 'Deprecated: Use `driveThemes` instead.' + deprecated: true + type: array + items: + type: object + properties: + id: + description: 'Deprecated: Use `driveThemes/id` instead.' + deprecated: true + type: string + backgroundImageLink: + description: 'Deprecated: Use `driveThemes/backgroundImageLink` instead.' + deprecated: true + type: string + colorRgb: + description: 'Deprecated: Use `driveThemes/colorRgb` instead.' + deprecated: true + type: string + canCreateTeamDrives: + description: 'Deprecated: Use `canCreateDrives` instead.' + deprecated: true + type: boolean + User: + id: User + description: Information about a Drive user. + type: object + properties: + displayName: + description: Output only. A plain text displayable name for this user. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#user"`. + default: drive#user + type: string + me: + description: Output only. Whether this user is the requesting user. + type: boolean + permissionId: + description: Output only. The user's ID as visible in Permission resources. + type: string + emailAddress: + description: >- + 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. + type: string + photoLink: + description: Output only. A link to the user's profile photo, if available. + type: string + App: + id: App + description: >- + 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. + type: object + properties: + name: + description: The name of the app. + type: string + objectType: + description: >- + The type of object this app creates such as a Chart. If empty, the + app name should be used instead. + type: string + supportsCreate: + description: Whether this app supports creating objects. + type: boolean + productUrl: + description: A link to the product listing for this app. + type: string + primaryMimeTypes: + description: The list of primary MIME types. + type: array + items: + type: string + secondaryMimeTypes: + description: The list of secondary MIME types. + type: array + items: + type: string + primaryFileExtensions: + description: The list of primary file extensions. + type: array + items: + type: string + secondaryFileExtensions: + description: The list of secondary file extensions. + type: array + items: + type: string + id: + description: The ID of the app. + type: string + supportsImport: + description: Whether this app supports importing from Google Docs. + type: boolean + installed: + description: Whether the app is installed. + type: boolean + authorized: + description: Whether the app is authorized to access data on the user's Drive. + type: boolean + icons: + description: The various icons for the app. + type: array + items: + $ref: '#/components/schemas/AppIcons' + useByDefault: + description: >- + Whether the app is selected as the default handler for the types it + supports. + type: boolean + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string "drive#app". + default: drive#app + type: string + shortDescription: + description: A short description of the app. + type: string + longDescription: + description: A long description of the app. + type: string + supportsMultiOpen: + description: Whether this app supports opening more than one file. + type: boolean + productId: + description: The ID of the product listing for this app. + type: string + openUrlTemplate: + description: >- + 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. + type: string + createUrl: + description: The URL to create a file with this app. + type: string + createInFolderTemplate: + description: >- + 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. + type: string + supportsOfflineCreate: + description: Whether this app supports creating files when offline. + type: boolean + hasDriveWideScope: + description: >- + Whether the app has Drive-wide scope. An app with Drive-wide scope + can access all files in the user's Drive. + type: boolean + AppIcons: + id: AppIcons + type: object + properties: + size: + description: >- + Size of the icon. Represented as the maximum of the width and + height. + type: integer + format: int32 + category: + description: >- + 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. + type: string + iconUrl: + description: URL for the icon. + type: string + AppList: + id: AppList + description: >- + A list of third-party applications which the user has installed or given + access to Google Drive. + type: object + properties: + defaultAppIds: + description: >- + The list of app IDs that the user has specified to use by default. + The list is in reverse-priority order (lowest to highest). + type: array + items: + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string "drive#appList". + default: drive#appList + type: string + selfLink: + description: A link back to this list. + type: string + items: + description: The list of apps. + type: array + items: + $ref: '#/components/schemas/App' + StartPageToken: + id: StartPageToken + type: object + properties: + startPageToken: + description: >- + The starting page token for listing future changes. The page token + doesn't expire. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#startPageToken"`. + default: drive#startPageToken + type: string + ChangeList: + id: ChangeList + description: A list of changes for a user. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#changeList"`. + default: drive#changeList + type: string + nextPageToken: + description: >- + 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. + type: string + newStartPageToken: + description: >- + 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. + type: string + changes: + description: >- + The list of changes. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Change' + Change: + id: Change + description: A change to a file or shared drive. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#change"`. + default: drive#change + type: string + removed: + description: >- + Whether the file or shared drive has been removed from this list of + changes, for example by deletion or loss of access. + type: boolean + file: + description: >- + The updated state of the file. Present if the type is file and the + file has not been removed from this list of changes. + $ref: '#/components/schemas/File' + fileId: + description: The ID of the file which has changed. + type: string + time: + description: The time of this change (RFC 3339 date-time). + type: string + format: date-time + driveId: + description: The ID of the shared drive associated with this change. + type: string + type: + description: 'Deprecated: Use `changeType` instead.' + deprecated: true + type: string + teamDriveId: + description: 'Deprecated: Use `driveId` instead.' + deprecated: true + type: string + teamDrive: + description: 'Deprecated: Use `drive` instead.' + deprecated: true + $ref: '#/components/schemas/TeamDrive' + changeType: + description: The type of the change. Possible values are `file` and `drive`. + type: string + drive: + description: >- + 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. + $ref: '#/components/schemas/Drive' + File: + id: File + description: >- + 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. + type: object + properties: + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#file"`. + default: drive#file + type: string + driveId: + description: >- + Output only. ID of the shared drive the file resides in. Only + populated for items in shared drives. + type: string + fileExtension: + description: >- + Output only. The final component of `fullFileExtension`. This is + only available for files with binary content in Google Drive. + type: string + copyRequiresWriterPermission: + description: >- + Whether the options to copy, print, or download this file, should be + disabled for readers and commenters. + type: boolean + md5Checksum: + description: >- + Output only. The MD5 checksum for the content of the file. This is + only applicable to files with binary content in Google Drive. + type: string + contentHints: + description: >- + Additional information about the content of the file. These fields + are never populated in responses. + type: object + properties: + indexableText: + description: >- + Text to be indexed for the file to improve fullText queries. + This is limited to 128KB in length and may contain HTML + elements. + type: string + thumbnail: + description: >- + A thumbnail for the file. This will only be used if Google Drive + cannot generate a standard thumbnail. + type: object + properties: + image: + description: >- + The thumbnail data encoded with URL-safe Base64 (RFC 4648 + section 5). + type: string + format: byte + mimeType: + description: The MIME type of the thumbnail. + type: string + writersCanShare: + description: >- + Whether users with only `writer` permission can modify the file's + permissions. Not populated for items in shared drives. + type: boolean + viewedByMe: + description: Output only. Whether the file has been viewed by this user. + type: boolean + mimeType: + description: >- + 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 resource. + type: string + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + readOnly: true + type: object + additionalProperties: + type: string + parents: + description: >- + 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. + type: array + items: + type: string + thumbnailLink: + description: >- + 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. + type: string + iconLink: + description: Output only. A static, unauthenticated link to the file's icon. + type: string + shared: + description: >- + Output only. Whether the file has been shared. Not populated for + items in shared drives. + type: boolean + lastModifyingUser: + description: >- + 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. + $ref: '#/components/schemas/User' + owners: + description: >- + 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. + type: array + items: + $ref: '#/components/schemas/User' + headRevisionId: + description: >- + Output only. The ID of the file's head revision. This is currently + only available for files with binary content in Google Drive. + type: string + sharingUser: + description: >- + Output only. The user who shared the file with the requesting user, + if applicable. + $ref: '#/components/schemas/User' + webViewLink: + description: >- + Output only. A link for opening the file in a relevant Google editor + or viewer in a browser. + type: string + webContentLink: + description: >- + 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. + type: string + size: + description: >- + Output only. Size in bytes of blobs and first party editor files. + Won't be populated for files that have no size, like shortcuts and + folders. + type: string + format: int64 + viewersCanCopyContent: + description: 'Deprecated: Use `copyRequiresWriterPermission` instead.' + deprecated: true + type: boolean + permissions: + description: >- + 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. + type: array + items: + $ref: '#/components/schemas/Permission' + hasThumbnail: + description: >- + Output only. Whether this file has a thumbnail. This does not + indicate whether the requesting app has access to the thumbnail. To + check access, look for the presence of the thumbnailLink field. + type: boolean + spaces: + description: >- + Output only. The list of spaces which contain the file. The + currently supported values are 'drive', 'appDataFolder' and + 'photos'. + type: array + items: + type: string + folderColorRgb: + description: >- + 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 resource. If an unsupported + color is specified, the closest color in the palette is used + instead. + type: string + id: + description: The ID of the file. + type: string + name: + description: >- + The name of the file. This is not necessarily unique within a + folder. Note that for immutable items such as the top level folders + of shared drives, My Drive root folder, and Application Data folder + the name is constant. + type: string + description: + description: A short description of the file. + type: string + starred: + description: Whether the user has starred the file. + type: boolean + trashed: + description: >- + Whether the file has been trashed, either explicitly or from a + trashed parent folder. Only the owner may trash a file, and other + users cannot see files in the owner's trash. + type: boolean + explicitlyTrashed: + description: >- + Output only. Whether the file has been explicitly trashed, as + opposed to recursively trashed from a parent folder. + type: boolean + createdTime: + description: The time at which the file was created (RFC 3339 date-time). + type: string + format: date-time + modifiedTime: + description: >- + he last time the file was modified by anyone (RFC 3339 date-time). + Note that setting modifiedTime will also update modifiedByMeTime for + the user. + type: string + format: date-time + modifiedByMeTime: + description: >- + The last time the file was modified by the user (RFC 3339 + date-time). + type: string + format: date-time + viewedByMeTime: + description: The last time the file was viewed by the user (RFC 3339 date-time). + type: string + format: date-time + sharedWithMeTime: + description: >- + The time at which the file was shared with the user, if applicable + (RFC 3339 date-time). + type: string + format: date-time + quotaBytesUsed: + description: >- + 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. + type: string + format: int64 + version: + description: >- + 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. + type: string + format: int64 + originalFilename: + description: >- + 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. + type: string + ownedByMe: + description: >- + Output only. Whether the user owns the file. Not populated for items + in shared drives. + type: boolean + fullFileExtension: + description: >- + 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 is not cleared if the new name does not contain + a valid extension. + type: string + properties: + description: >- + A collection of arbitrary key-value pairs which are visible to all + apps. + + Entries with null values are cleared in update and copy requests. + type: object + additionalProperties: + type: string + appProperties: + description: >- + 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. + type: object + additionalProperties: + type: string + isAppAuthorized: + description: >- + Output only. Whether the file was created or opened by the + requesting app. + type: boolean + teamDriveId: + description: 'Deprecated: Output only. Use `driveId` instead.' + deprecated: true + type: string + capabilities: + description: >- + Output only. Capabilities the current user has on this file. Each + capability corresponds to a fine-grained action that a user may + take. + type: object + properties: + canChangeViewersCanCopyContent: + description: 'Deprecated: Output only.' + deprecated: true + type: boolean + canMoveChildrenOutOfDrive: + description: >- + Output only. Whether the current user can move children of this + folder outside of the shared drive. This is false when the item + is not a folder. Only populated for items in shared drives. + type: boolean + canReadDrive: + description: >- + Output only. Whether the current user can read the shared drive + to which this file belongs. Only populated for items in shared + drives. + type: boolean + canEdit: + description: >- + 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`. + type: boolean + canCopy: + description: >- + 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 itself if it + is not a folder. + type: boolean + canComment: + description: Output only. Whether the current user can comment on this file. + type: boolean + canAddChildren: + description: >- + Output only. Whether the current user can add children to this + folder. This is always false when the item is not a folder. + type: boolean + canDelete: + description: Output only. Whether the current user can delete this file. + type: boolean + canDownload: + description: Output only. Whether the current user can download this file. + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + this folder. This is always false when the item is not a folder. + type: boolean + canRemoveChildren: + description: >- + Output only. Whether the current user can remove children from + this folder. This is always false when the item is not a folder. + For a folder in a shared drive, use `canDeleteChildren` or + `canTrashChildren` instead. + type: boolean + canRename: + description: Output only. Whether the current user can rename this file. + type: boolean + canTrash: + description: >- + Output only. Whether the current user can move this file to + trash. + type: boolean + canReadRevisions: + description: >- + 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 + itself if it is not a folder, can be read. + type: boolean + canReadTeamDrive: + description: 'Deprecated: Output only. Use `canReadDrive` instead.' + deprecated: true + type: boolean + canMoveTeamDriveItem: + description: >- + Deprecated: Output only. Use `canMoveItemWithinDrive` or + `canMoveItemOutOfDrive` instead. + deprecated: true + type: boolean + canChangeCopyRequiresWriterPermission: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this file. + type: boolean + canMoveItemIntoTeamDrive: + description: 'Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canUntrash: + description: >- + Output only. Whether the current user can restore this file from + trash. + type: boolean + canModifyContent: + description: >- + Output only. Whether the current user can modify the content of + this file. + type: boolean + canMoveItemWithinTeamDrive: + description: 'Deprecated: Output only. Use `canMoveItemWithinDrive` instead.' + deprecated: true + type: boolean + canMoveItemOutOfTeamDrive: + description: 'Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.' + deprecated: true + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children of + this folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveChildrenOutOfTeamDrive: + description: >- + Deprecated: Output only. Use `canMoveChildrenOutOfDrive` + instead. + deprecated: true + type: boolean + canMoveChildrenWithinTeamDrive: + description: >- + Deprecated: Output only. Use `canMoveChildrenWithinDrive` + instead. + deprecated: true + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children of this + folder. This is false when the item is not a folder. Only + populated for items in shared drives. + type: boolean + canMoveItemOutOfDrive: + description: >- + 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 is being added. + type: boolean + canAddMyDriveParent: + description: >- + 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. + type: boolean + canRemoveMyDriveParent: + description: >- + 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. + type: boolean + canMoveItemWithinDrive: + description: >- + 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 is being added + and the parent that is being removed. + type: boolean + canShare: + description: >- + Output only. Whether the current user can modify the sharing + settings for this file. + type: boolean + canMoveChildrenWithinDrive: + description: >- + Output only. Whether the current user can move children of this + folder within this drive. This is false when the item is not 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. + type: boolean + canModifyContentRestriction: + description: >- + Deprecated: Output only. Use one of + `canModifyEditorContentRestriction`, + `canModifyOwnerContentRestriction` or + `canRemoveContentRestriction`. + deprecated: true + type: boolean + canAddFolderFromAnotherDrive: + description: >- + 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 is not a folder. Only + populated for items in shared drives. + type: boolean + canChangeSecurityUpdateEnabled: + description: >- + Output only. Whether the current user can change the + securityUpdateEnabled field on link share metadata. + type: boolean + canAcceptOwnership: + description: >- + Output only. Whether the current user is the pending owner of + the file. Not populated for shared drive files. + type: boolean + canReadLabels: + description: >- + Output only. Whether the current user can read the labels on the + file. + type: boolean + canModifyLabels: + description: >- + Output only. Whether the current user can modify the labels on + the file. + type: boolean + canModifyEditorContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions on the file which are editor restricted. + type: boolean + canModifyOwnerContentRestriction: + description: >- + Output only. Whether the current user can add or modify content + restrictions which are owner restricted. + type: boolean + canRemoveContentRestriction: + description: >- + Output only. Whether there is a content restriction on the file + that can be removed by the current user. + type: boolean + hasAugmentedPermissions: + description: >- + Output only. Whether there are permissions directly on this file. + This field is only populated for items in shared drives. + type: boolean + trashingUser: + description: >- + Output only. If the file has been explicitly trashed, the user who + trashed it. Only populated for items in shared drives. + $ref: '#/components/schemas/User' + thumbnailVersion: + description: >- + Output only. The thumbnail version for use in thumbnail cache + invalidation. + type: string + format: int64 + trashedTime: + description: >- + The time that the item was trashed (RFC 3339 date-time). Only + populated for items in shared drives. + type: string + format: date-time + modifiedByMe: + description: Output only. Whether the file has been modified by this user. + type: boolean + permissionIds: + description: >- + Output only. List of permission IDs for users with access to this + file. + type: array + items: + type: string + imageMediaMetadata: + description: Output only. Additional metadata about image media, if available. + type: object + properties: + flashUsed: + description: Output only. Whether a flash was used to create the photo. + type: boolean + meteringMode: + description: Output only. The metering mode used to create the photo. + type: string + sensor: + description: Output only. The type of sensor used to create the photo. + type: string + exposureMode: + description: Output only. The exposure mode used to create the photo. + type: string + colorSpace: + description: Output only. The color space of the photo. + type: string + whiteBalance: + description: Output only. The white balance mode used to create the photo. + type: string + width: + description: Output only. The width of the image in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the image in pixels. + type: integer + format: int32 + location: + description: >- + Output only. Geographic location information stored in the + image. + type: object + properties: + latitude: + description: Output only. The latitude stored in the image. + type: number + format: double + longitude: + description: Output only. The longitude stored in the image. + type: number + format: double + altitude: + description: Output only. The altitude stored in the image. + type: number + format: double + rotation: + description: >- + Output only. The number of clockwise 90 degree rotations applied + from the image's original orientation. + type: integer + format: int32 + time: + description: >- + Output only. The date and time the photo was taken (EXIF + DateTime). + type: string + cameraMake: + description: Output only. The make of the camera used to create the photo. + type: string + cameraModel: + description: Output only. The model of the camera used to create the photo. + type: string + exposureTime: + description: Output only. The length of the exposure, in seconds. + type: number + format: float + aperture: + description: Output only. The aperture used to create the photo (f-number). + type: number + format: float + focalLength: + description: >- + Output only. The focal length used to create the photo, in + millimeters. + type: number + format: float + isoSpeed: + description: Output only. The ISO speed used to create the photo. + type: integer + format: int32 + exposureBias: + description: Output only. The exposure bias of the photo (APEX value). + type: number + format: float + maxApertureValue: + description: >- + Output only. The smallest f-number of the lens at the focal + length used to create the photo (APEX value). + type: number + format: float + subjectDistance: + description: >- + Output only. The distance to the subject of the photo, in + meters. + type: integer + format: int32 + lens: + description: Output only. The lens used to create the photo. + type: string + videoMediaMetadata: + description: >- + Output only. Additional metadata about video media. This may not be + available immediately upon upload. + type: object + properties: + width: + description: Output only. The width of the video in pixels. + type: integer + format: int32 + height: + description: Output only. The height of the video in pixels. + type: integer + format: int32 + durationMillis: + description: Output only. The duration of the video in milliseconds. + type: string + format: int64 + shortcutDetails: + description: >- + Shortcut file details. Only populated for shortcut files, which have + the mimeType field set to `application/vnd.google-apps.shortcut`. + Can only be set on `files.create` requests. + type: object + properties: + targetId: + description: >- + The ID of the file that this shortcut points to. Can only be set + on `files.create` requests. + type: string + targetMimeType: + description: >- + 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. + type: string + targetResourceKey: + description: Output only. The ResourceKey for the target file. + type: string + contentRestrictions: + description: >- + Restrictions for accessing the content of the file. Only populated + if such a restriction exists. + type: array + items: + $ref: '#/components/schemas/ContentRestriction' + resourceKey: + description: Output only. A key needed to access the item via a shared link. + type: string + linkShareMetadata: + description: >- + Contains details about the link URLs that clients are using to refer + to this item. + type: object + properties: + securityUpdateEligible: + description: Output only. Whether the file is eligible for security update. + type: boolean + securityUpdateEnabled: + description: >- + Output only. Whether the security update is enabled for this + file. + type: boolean + labelInfo: + description: Output only. An overview of the labels on the file. + type: object + properties: + labels: + description: >- + 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. + type: array + items: + $ref: '#/components/schemas/Label' + sha1Checksum: + description: >- + 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 is not populated for Docs Editors or + shortcut files. + type: string + sha256Checksum: + description: >- + 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 is not populated for Docs Editors or + shortcut files. + type: string + Permission: + id: Permission + description: >- + A permission for a file. A permission grants a user, group, domain, or + the world access to a file or a folder hierarchy. 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. + type: object + properties: + id: + description: >- + Output only. The ID of this permission. This is a unique identifier + for the grantee, and is published in User resources as + `permissionId`. IDs should be treated as opaque values. + type: string + displayName: + description: >- + 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 "Joe Smith." * `group` - Name of the Google Group, such as "The + Company Administrators." * `domain` - String domain name, such as + "thecompany.com." * `anyone` - No `displayName` is present. + type: string + type: + description: >- + The type of the grantee. Valid values are: * `user` * `group` * + `domain` * `anyone` When creating a permission, if `type` is `user` + or `group`, you must provide an `emailAddress` for the user or + group. When `type` is `domain`, you must provide a `domain`. There + isn't extra information required for an `anyone` type. + annotations: + required: + - drive.permissions.create + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#permission"`. + default: drive#permission + type: string + permissionDetails: + description: >- + Output only. Details of whether the permissions on this shared drive + item are inherited or directly on this item. This is an output-only + field which is present only for shared drive items. + readOnly: true + type: array + items: + type: object + properties: + permissionType: + description: >- + Output only. The permission type for this user. While new + values may be added in future, the following are currently + possible: * `file` * `member` + type: string + inheritedFrom: + description: >- + Output only. The ID of the item from which this permission is + inherited. This is an output-only field. + type: string + role: + description: >- + Output only. The primary role for this user. While new values + may be added in the future, the following are currently + possible: * `organizer` * `fileOrganizer` * `writer` * + `commenter` * `reader` + type: string + inherited: + description: >- + Output only. Whether this permission is inherited. This field + is always populated. This is an output-only field. + type: boolean + photoLink: + description: Output only. A link to the user's profile photo, if available. + type: string + emailAddress: + description: >- + The email address of the user or group to which this permission + refers. + type: string + role: + description: >- + The role granted by this permission. While new values may be + supported in the future, the following are currently allowed: * + `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * + `reader` + annotations: + required: + - drive.permissions.create + type: string + allowFileDiscovery: + description: >- + Whether the permission allows the file to be discovered through + search. This is only applicable for permissions of type `domain` or + `anyone`. + type: boolean + domain: + description: The domain to which this permission refers. + type: string + expirationTime: + description: >- + 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 + type: string + format: date-time + teamDrivePermissionDetails: + description: >- + Output only. Deprecated: Output only. Use `permissionDetails` + instead. + readOnly: true + deprecated: true + type: array + items: + type: object + properties: + teamDrivePermissionType: + description: >- + Deprecated: Output only. Use + `permissionDetails/permissionType` instead. + deprecated: true + type: string + inheritedFrom: + description: >- + Deprecated: Output only. Use `permissionDetails/inheritedFrom` + instead. + deprecated: true + type: string + role: + description: 'Deprecated: Output only. Use `permissionDetails/role` instead.' + deprecated: true + type: string + inherited: + description: >- + Deprecated: Output only. Use `permissionDetails/inherited` + instead. + deprecated: true + type: boolean + deleted: + description: >- + Output only. Whether the account associated with this permission has + been deleted. This field only pertains to user and group + permissions. + type: boolean + view: + description: >- + Indicates the view for this permission. Only populated for + permissions that belong to a view. 'published' is the only supported + value. + type: string + pendingOwner: + description: >- + Whether the account associated with this permission is a pending + owner. Only populated for `user` type permissions for files that are + not in a shared drive. + type: boolean + ContentRestriction: + id: ContentRestriction + description: A restriction for accessing the content of the file. + type: object + properties: + readOnly: + description: >- + 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. + type: boolean + reason: + description: >- + Reason for why the content of the file is restricted. This is only + mutable on requests that also set `readOnly=true`. + type: string + type: + description: >- + Output only. The type of the content restriction. Currently the only + possible value is `globalContentRestriction`. + type: string + restrictingUser: + description: >- + Output only. The user who set the content restriction. Only + populated if `readOnly` is true. + $ref: '#/components/schemas/User' + restrictionTime: + description: >- + The time at which the content restriction was set (formatted RFC + 3339 timestamp). Only populated if readOnly is true. + type: string + format: date-time + ownerRestricted: + description: >- + 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. + type: boolean + systemRestricted: + description: >- + 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. + type: boolean + Label: + id: Label + description: Representation of label and label fields. + type: object + properties: + id: + description: The ID of the label. + type: string + revisionId: + description: The revision ID of the label. + type: string + kind: + description: This is always drive#label + type: string + fields: + description: A map of the fields on the label, keyed by the field's ID. + type: object + additionalProperties: + $ref: '#/components/schemas/LabelField' + LabelField: + id: LabelField + description: Representation of field, which is a typed key-value pair. + type: object + properties: + kind: + description: This is always drive#labelField. + type: string + id: + description: The identifier of this label field. + type: string + valueType: + description: >- + The field type. While new values may be supported in the future, the + following are currently allowed: * `dateString` * `integer` * + `selection` * `text` * `user` + type: string + dateString: + description: >- + Only present if valueType is dateString. RFC 3339 formatted date: + YYYY-MM-DD. + type: array + items: + type: string + format: date + integer: + description: Only present if `valueType` is `integer`. + type: array + items: + type: string + format: int64 + selection: + description: Only present if `valueType` is `selection` + type: array + items: + type: string + text: + description: Only present if `valueType` is `text`. + type: array + items: + type: string + user: + description: Only present if `valueType` is `user`. + type: array + items: + $ref: '#/components/schemas/User' + TeamDrive: + id: TeamDrive + description: 'Deprecated: use the drive collection instead.' + type: object + properties: + id: + description: >- + The ID of this Team Drive which is also the ID of the top level + folder of this Team Drive. + type: string + name: + description: The name of this Team Drive. + type: string + colorRgb: + description: >- + 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`. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#teamDrive"`. + default: drive#teamDrive + type: string + backgroundImageLink: + description: A short-lived link to this Team Drive's background image. + type: string + capabilities: + description: Capabilities the current user has on this Team Drive. + type: object + properties: + canAddChildren: + description: >- + Whether the current user can add children to folders in this + Team Drive. + type: boolean + canComment: + description: >- + Whether the current user can comment on files in this Team + Drive. + type: boolean + canCopy: + description: Whether the current user can copy files in this Team Drive. + type: boolean + canDeleteTeamDrive: + description: >- + 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. + type: boolean + canDownload: + description: Whether the current user can download files in this Team Drive. + type: boolean + canEdit: + description: Whether the current user can edit files in this Team Drive + type: boolean + canListChildren: + description: >- + Whether the current user can list the children of folders in + this Team Drive. + type: boolean + canManageMembers: + description: >- + Whether the current user can add members to this Team Drive or + remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Whether the current user can read the revisions resource of + files in this Team Drive. + type: boolean + canRemoveChildren: + description: >- + Deprecated: Use `canDeleteChildren` or `canTrashChildren` + instead. + deprecated: true + type: boolean + canRename: + description: >- + Whether the current user can rename files or folders in this + Team Drive. + type: boolean + canRenameTeamDrive: + description: Whether the current user can rename this Team Drive. + type: boolean + canChangeTeamDriveBackground: + description: >- + Whether the current user can change the background of this Team + Drive. + type: boolean + canShare: + description: >- + Whether the current user can share files or folders in this Team + Drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Whether the current user can change the + `copyRequiresWriterPermission` restriction of this Team Drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Whether the current user can change the `domainUsersOnly` + restriction of this Team Drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + Team Drive. + type: boolean + canChangeTeamMembersOnlyRestriction: + description: >- + Whether the current user can change the `teamMembersOnly` + restriction of this Team Drive. + type: boolean + canDeleteChildren: + description: >- + Whether the current user can delete children from folders in + this Team Drive. + type: boolean + canTrashChildren: + description: >- + Whether the current user can trash children from folders in this + Team Drive. + type: boolean + canResetTeamDriveRestrictions: + description: >- + Whether the current user can reset the Team Drive restrictions + to defaults. + type: boolean + themeId: + description: >- + 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`. + type: string + backgroundImageFile: + description: >- + An image file and cropping parameters from which a background image + for this Team Drive is set. This is a write only field; it can only + be set on `drive.teamdrives.update` requests that don't set + `themeId`. When specified, all fields of the `backgroundImageFile` + must be set. + type: object + properties: + id: + description: >- + The ID of an image file in Drive to use for the background + image. + type: string + xCoordinate: + description: >- + 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. + type: number + format: float + yCoordinate: + description: >- + 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. + type: number + format: float + width: + description: >- + 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. + type: number + format: float + createdTime: + description: The time at which the Team Drive was created (RFC 3339 date-time). + type: string + format: date-time + restrictions: + description: >- + A set of restrictions that apply to this Team Drive or items inside + this Team Drive. + type: object + properties: + copyRequiresWriterPermission: + description: >- + 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. + type: boolean + domainUsersOnly: + description: >- + 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. + type: boolean + teamMembersOnly: + description: >- + Whether access to items inside this Team Drive is restricted to + members of this Team Drive. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this Team Drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + 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. + type: boolean + orgUnitId: + description: >- + The organizational unit of this shared drive. This field is only + populated on `drives.list` responses when the `useDomainAdminAccess` + parameter is set to `true`. + type: string + Drive: + id: Drive + description: >- + 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. + type: object + properties: + id: + description: >- + Output only. The ID of this shared drive which is also the ID of the + top level folder of this shared drive. + type: string + name: + description: The name of this shared drive. + type: string + colorRgb: + description: >- + 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`. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#drive"`. + default: drive#drive + type: string + backgroundImageLink: + description: >- + Output only. A short-lived link to this shared drive's background + image. + type: string + capabilities: + description: Output only. Capabilities the current user has on this shared drive. + type: object + properties: + canAddChildren: + description: >- + Output only. Whether the current user can add children to + folders in this shared drive. + type: boolean + canComment: + description: >- + Output only. Whether the current user can comment on files in + this shared drive. + type: boolean + canCopy: + description: >- + Output only. Whether the current user can copy files in this + shared drive. + type: boolean + canDeleteDrive: + description: >- + 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. + type: boolean + canDownload: + description: >- + Output only. Whether the current user can download files in this + shared drive. + type: boolean + canEdit: + description: >- + Output only. Whether the current user can edit files in this + shared drive + type: boolean + canListChildren: + description: >- + Output only. Whether the current user can list the children of + folders in this shared drive. + type: boolean + canManageMembers: + description: >- + Output only. Whether the current user can add members to this + shared drive or remove them or change their role. + type: boolean + canReadRevisions: + description: >- + Output only. Whether the current user can read the revisions + resource of files in this shared drive. + type: boolean + canRename: + description: >- + Output only. Whether the current user can rename files or + folders in this shared drive. + type: boolean + canRenameDrive: + description: >- + Output only. Whether the current user can rename this shared + drive. + type: boolean + canChangeDriveBackground: + description: >- + Output only. Whether the current user can change the background + of this shared drive. + type: boolean + canShare: + description: >- + Output only. Whether the current user can share files or folders + in this shared drive. + type: boolean + canChangeCopyRequiresWriterPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `copyRequiresWriterPermission` restriction of this shared drive. + type: boolean + canChangeDomainUsersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `domainUsersOnly` restriction of this shared drive. + type: boolean + canChangeDriveMembersOnlyRestriction: + description: >- + Output only. Whether the current user can change the + `driveMembersOnly` restriction of this shared drive. + type: boolean + canChangeSharingFoldersRequiresOrganizerPermissionRestriction: + description: >- + Output only. Whether the current user can change the + `sharingFoldersRequiresOrganizerPermission` restriction of this + shared drive. + type: boolean + canResetDriveRestrictions: + description: >- + Output only. Whether the current user can reset the shared drive + restrictions to defaults. + type: boolean + canDeleteChildren: + description: >- + Output only. Whether the current user can delete children from + folders in this shared drive. + type: boolean + canTrashChildren: + description: >- + Output only. Whether the current user can trash children from + folders in this shared drive. + type: boolean + themeId: + description: >- + 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`. + type: string + backgroundImageFile: + description: >- + 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. + type: object + properties: + id: + description: >- + The ID of an image file in Google Drive to use for the + background image. + type: string + xCoordinate: + description: >- + 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. + type: number + format: float + yCoordinate: + description: >- + 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. + type: number + format: float + width: + description: >- + 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. + type: number + format: float + createdTime: + description: The time at which the shared drive was created (RFC 3339 date-time). + type: string + format: date-time + hidden: + description: Whether the shared drive is hidden from default view. + type: boolean + restrictions: + description: >- + 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. + type: object + properties: + copyRequiresWriterPermission: + description: >- + 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. + type: boolean + domainUsersOnly: + description: >- + 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. + type: boolean + driveMembersOnly: + description: >- + Whether access to items inside this shared drive is restricted + to its members. + type: boolean + adminManagedRestrictions: + description: >- + Whether administrative privileges on this shared drive are + required to modify restrictions. + type: boolean + sharingFoldersRequiresOrganizerPermission: + description: >- + 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. + type: boolean + orgUnitId: + description: >- + 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`. + type: string + Channel: + id: Channel + description: A notification channel used to watch for resource changes. + type: object + properties: + payload: + description: A Boolean value to indicate whether payload is wanted. Optional. + type: boolean + id: + description: A UUID or similar unique string that identifies this channel. + type: string + resourceId: + description: >- + An opaque ID that identifies the resource being watched on this + channel. Stable across different API versions. + type: string + resourceUri: + description: A version-specific identifier for the watched resource. + type: string + token: + description: >- + An arbitrary string delivered to the target address with each + notification delivered over this channel. Optional. + type: string + expiration: + description: >- + Date and time of notification channel expiration, expressed as a + Unix timestamp, in milliseconds. Optional. + type: string + format: int64 + type: + description: >- + The type of delivery mechanism used for this channel. Valid values + are "web_hook" or "webhook". + type: string + address: + description: The address where notifications are delivered for this channel. + type: string + params: + description: >- + Additional parameters controlling delivery channel behavior. + Optional. + type: object + additionalProperties: + type: string + kind: + description: >- + Identifies this as a notification channel used to watch for changes + to a resource, which is `api#channel`. + default: api#channel + type: string + Comment: + id: Comment + description: >- + 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. + type: object + properties: + id: + description: Output only. The ID of the comment. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#comment"`. + default: drive#comment + type: string + createdTime: + description: The time at which the comment was created (RFC 3339 date-time). + type: string + format: date-time + modifiedTime: + description: >- + The last time the comment or any of its replies was modified (RFC + 3339 date-time). + type: string + format: date-time + resolved: + description: >- + Output only. Whether the comment has been resolved by one of its + replies. + type: boolean + anchor: + description: >- + 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/drive/api/v3/manage-comments). + type: string + replies: + description: >- + Output only. The full list of replies to the comment in + chronological order. + type: array + items: + $ref: '#/components/schemas/Reply' + author: + description: >- + Output only. The author of the comment. The author's email address + and permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether the comment has been deleted. A deleted comment + has no content. + type: boolean + htmlContent: + description: Output only. The content of the comment with HTML formatting. + type: string + content: + description: >- + The plain text content of the comment. This field is used for + setting the content, while `htmlContent` should be displayed. + annotations: + required: + - drive.comments.create + - drive.comments.update + type: string + quotedFileContent: + description: >- + 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. + type: object + properties: + mimeType: + description: The MIME type of the quoted content. + type: string + value: + description: >- + The quoted content itself. This is interpreted as plain text if + set through the API. + type: string + Reply: + id: Reply + description: >- + 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. + type: object + properties: + id: + description: Output only. The ID of the reply. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#reply"`. + default: drive#reply + type: string + createdTime: + description: The time at which the reply was created (RFC 3339 date-time). + type: string + format: date-time + modifiedTime: + description: The last time the reply was modified (RFC 3339 date-time). + type: string + format: date-time + action: + description: >- + The action the reply performed to the parent comment. Valid values + are: * `resolve` * `reopen` + type: string + author: + description: >- + Output only. The author of the reply. The author's email address and + permission ID will not be populated. + $ref: '#/components/schemas/User' + deleted: + description: >- + Output only. Whether the reply has been deleted. A deleted reply has + no content. + type: boolean + htmlContent: + description: Output only. The content of the reply with HTML formatting. + type: string + content: + description: >- + The plain text content of the reply. This field is used for setting + the content, while `htmlContent` should be displayed. This is + required on creates if no `action` is specified. + annotations: + required: + - drive.replies.update + type: string + CommentList: + id: CommentList + description: A list of comments on a file. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#commentList"`. + default: drive#commentList + type: string + comments: + description: >- + The list of comments. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Comment' + nextPageToken: + description: >- + 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. + type: string + DriveList: + id: DriveList + description: A list of shared drives. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#driveList"`. + default: drive#driveList + type: string + drives: + description: >- + The list of shared drives. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Drive' + GeneratedIds: + id: GeneratedIds + description: A list of generated file IDs which can be provided in create requests. + type: object + properties: + ids: + description: The IDs generated for the requesting user in the specified space. + type: array + items: + type: string + space: + description: The type of file that can be created with these IDs. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#generatedIds"`. + default: drive#generatedIds + type: string + FileList: + id: FileList + description: A list of files. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#fileList"`. + default: drive#fileList + type: string + incompleteSearch: + description: >- + 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'. + type: boolean + files: + description: >- + The list of files. If nextPageToken is populated, then this list may + be incomplete and an additional page of results should be fetched. + type: array + items: + $ref: '#/components/schemas/File' + LabelList: + id: LabelList + description: A list of labels applied to a file. + type: object + properties: + labels: + description: The list of labels. + type: array + items: + $ref: '#/components/schemas/Label' + nextPageToken: + description: >- + 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. + type: string + kind: + description: This is always drive#labelList + type: string + ModifyLabelsRequest: + id: ModifyLabelsRequest + description: >- + 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. + type: object + properties: + labelModifications: + description: The list of modifications to apply to the labels on the file. + type: array + items: + $ref: '#/components/schemas/LabelModification' + kind: + description: This is always drive#modifyLabelsRequest. + type: string + LabelModification: + id: LabelModification + description: >- + 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. + type: object + properties: + labelId: + description: The ID of the label to modify. + annotations: + required: + - drive.files.modifyLabels + type: string + fieldModifications: + description: The list of modifications to this label's fields. + type: array + items: + $ref: '#/components/schemas/LabelFieldModification' + removeLabel: + description: If true, the label will be removed from the file. + type: boolean + kind: + description: This is always drive#labelModification. + type: string + LabelFieldModification: + id: LabelFieldModification + description: A modification to a label's field. + type: object + properties: + fieldId: + description: The ID of the field to be modified. + type: string + kind: + description: This is always drive#labelFieldModification. + type: string + setDateValues: + description: >- + 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. + type: array + items: + type: string + format: date + setTextValues: + description: Sets the value of a `text` field. + type: array + items: + type: string + setSelectionValues: + description: Replaces a `selection` field with these new values. + type: array + items: + type: string + setIntegerValues: + description: Replaces the value of an `integer` field with these new values. + type: array + items: + type: string + format: int64 + setUserValues: + description: >- + Replaces a `user` field with these new values. The values must be + valid email addresses. + type: array + items: + type: string + unsetValues: + description: Unsets the values for this field. + type: boolean + ModifyLabelsResponse: + id: ModifyLabelsResponse + description: >- + Response to a ModifyLabels request. This contains only those labels + which were added or updated by the request. + type: object + properties: + modifiedLabels: + description: The list of labels which were added or updated by the request. + type: array + items: + $ref: '#/components/schemas/Label' + kind: + description: This is always drive#modifyLabelsResponse + type: string + PermissionList: + id: PermissionList + description: A list of permissions for a file. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#permissionList"`. + default: drive#permissionList + type: string + permissions: + description: >- + The list of permissions. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Permission' + ReplyList: + id: ReplyList + description: A list of replies to a comment on a file. + type: object + properties: + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#replyList"`. + default: drive#replyList + type: string + replies: + description: >- + The list of replies. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Reply' + nextPageToken: + description: >- + 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. + type: string + Revision: + id: Revision + description: >- + 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. + type: object + properties: + id: + description: Output only. The ID of the revision. + type: string + mimeType: + description: Output only. The MIME type of the revision. + type: string + kind: + description: >- + Output only. Identifies what kind of resource this is. Value: the + fixed string `"drive#revision"`. + default: drive#revision + type: string + published: + description: >- + Whether this revision is published. This is only applicable to Docs + Editors files. + type: boolean + exportLinks: + description: >- + Output only. Links for exporting Docs Editors files to specific + formats. + type: object + additionalProperties: + type: string + keepForever: + description: >- + 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. + type: boolean + md5Checksum: + description: >- + Output only. The MD5 checksum of the revision's content. This is + only applicable to files with binary content in Drive. + type: string + modifiedTime: + description: The last time the revision was modified (RFC 3339 date-time). + type: string + format: date-time + publishAuto: + description: >- + Whether subsequent revisions will be automatically republished. This + is only applicable to Docs Editors files. + type: boolean + publishedOutsideDomain: + description: >- + Whether this revision is published outside the domain. This is only + applicable to Docs Editors files. + type: boolean + publishedLink: + description: >- + Output only. A link to the published revision. This is only + populated for Google Sites files. + type: string + size: + description: >- + Output only. The size of the revision's content in bytes. This is + only applicable to files with binary content in Drive. + type: string + format: int64 + originalFilename: + description: >- + Output only. The original filename used to create this revision. + This is only applicable to files with binary content in Drive. + type: string + lastModifyingUser: + description: >- + 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. + $ref: '#/components/schemas/User' + RevisionList: + id: RevisionList + description: A list of revisions of a file. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#revisionList"`. + default: drive#revisionList + type: string + revisions: + description: >- + The list of revisions. If nextPageToken is populated, then this list + may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/Revision' + TeamDriveList: + id: TeamDriveList + description: A list of Team Drives. + type: object + properties: + nextPageToken: + description: >- + 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. + type: string + kind: + description: >- + Identifies what kind of resource this is. Value: the fixed string + `"drive#teamDriveList"`. + default: drive#teamDriveList + type: string + teamDrives: + description: >- + The list of Team Drives. If nextPageToken is populated, then this + list may be incomplete and an additional page of results should be + fetched. + type: array + items: + $ref: '#/components/schemas/TeamDrive' + AccessProposal: + id: AccessProposal + description: The Access Proposal resource for outstanding access proposals on a file + type: object + properties: + fileId: + description: The file id that the proposal for access is on + type: string + proposalId: + description: The id of the access proposal + type: string + requesterEmailAddress: + description: The email address of the requesting user + type: string + recipientEmailAddress: + description: >- + The email address of the user that will receive permissions if + accepted + type: string + rolesAndViews: + description: A wrapper for the role and view of an access proposal. + type: array + items: + $ref: '#/components/schemas/AccessProposalRoleAndView' + requestMessage: + description: The message that the requester added to the proposal + type: string + createTime: + description: The creation time + type: string + format: google-datetime + AccessProposalRoleAndView: + id: AccessProposalRoleAndView + description: A wrapper for the role and view of an access proposal. + type: object + properties: + role: + description: >- + The role that was proposed by the requester New values may be added + in the future, but the following are currently possible: * `writer` + * `commenter` * `reader` + type: string + view: + description: >- + Indicates the view for this access proposal. Only populated for + proposals that belong to a view. `published` is the only supported + value. + type: string + ResolveAccessProposalRequest: + id: ResolveAccessProposalRequest + description: Request message for resolving an AccessProposal on a file. + type: object + properties: + role: + description: >- + Optional. The roles the approver has allowed, if any. Note: This + field is required for the `ACCEPT` action. + type: array + items: + type: string + view: + description: >- + Optional. Indicates the view for this access proposal. This should + only be set when the proposal belongs to a view. `published` is the + only supported value. + type: string + action: + description: Required. The action to take on the AccessProposal. + type: string + enumDescriptions: + - Unspecified action + - >- + The user accepts the proposal. Note: If this action is used, the + `role` field must have at least one value. + - The user denies the proposal + enum: + - ACTION_UNSPECIFIED + - ACCEPT + - DENY + sendNotification: + description: >- + Optional. Whether to send an email to the requester when the + AccessProposal is denied or accepted. + type: boolean + ListAccessProposalsResponse: + id: ListAccessProposalsResponse + description: The response to an Access Proposal list request. + type: object + properties: + accessProposals: + description: >- + The list of Access Proposals. This field is only populated in v3 and + v3beta. + type: array + items: + $ref: '#/components/schemas/AccessProposal' + nextPageToken: + description: >- + 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. + type: string + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + operations: + id: googleworkspace.drivev3.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: '#/paths/~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: '#/paths/~1operations~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operation: + id: googleworkspace.drivev3.operation + name: operation + title: Operation + methods: + delete: + operation: + $ref: '#/paths/~1operation~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: '#/paths/~1operation~1{name}:cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operation/methods/delete' + about: + id: googleworkspace.drivev3.about + name: about + title: About + methods: + get: + operation: + $ref: '#/paths/~1about/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/about/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + apps: + id: googleworkspace.drivev3.apps + name: apps + title: Apps + methods: + get: + operation: + $ref: '#/paths/~1apps~1{appId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apps/methods/get' + - $ref: '#/components/x-stackQL-resources/apps/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + changes_start_page_token: + id: googleworkspace.drivev3.changes_start_page_token + name: changes_start_page_token + title: Changes_start_page_token + methods: + get_start_page_token: + operation: + $ref: '#/paths/~1changes~1startPageToken/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/changes_start_page_token/methods/get_start_page_token + insert: [] + update: [] + replace: [] + delete: [] + changes: + id: googleworkspace.drivev3.changes + name: changes + title: Changes + methods: + list: + operation: + $ref: '#/paths/~1changes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.changes + watch: + operation: + $ref: '#/paths/~1changes~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/changes/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + channels: + id: googleworkspace.drivev3.channels + name: channels + title: Channels + methods: + stop: + operation: + $ref: '#/paths/~1channels~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + comments: + id: googleworkspace.drivev3.comments + name: comments + title: Comments + methods: + create: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.comments + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/get' + - $ref: '#/components/x-stackQL-resources/comments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/comments/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/comments/methods/delete' + drives: + id: googleworkspace.drivev3.drives + name: drives + title: Drives + methods: + create: + operation: + $ref: '#/paths/~1drives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1drives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.drives + delete: + operation: + $ref: '#/paths/~1drives~1{driveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1drives~1{driveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1drives~1{driveId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + hide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1hide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + unhide: + operation: + $ref: '#/paths/~1drives~1{driveId}~1unhide/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/drives/methods/get' + - $ref: '#/components/x-stackQL-resources/drives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/drives/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/drives/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/drives/methods/delete' + files: + id: googleworkspace.drivev3.files + name: files + title: Files + methods: + copy: + operation: + $ref: '#/paths/~1files~1{fileId}~1copy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1files/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.files + delete: + operation: + $ref: '#/paths/~1files~1{fileId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + empty_trash: + operation: + $ref: '#/paths/~1files~1trash/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: '#/paths/~1files~1{fileId}~1export/get' + response: + mediaType: application/json + openAPIDocKey: '200' + generate_ids: + operation: + $ref: '#/paths/~1files~1generateIds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + modify_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1modifyLabels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + watch: + operation: + $ref: '#/paths/~1files~1{fileId}~1watch/post' + response: + mediaType: application/json + openAPIDocKey: '200' + download: + operation: + $ref: '#/paths/~1files~1{fileId}~1download/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files/methods/get' + - $ref: '#/components/x-stackQL-resources/files/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/files/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/files/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/files/methods/delete' + files_labels: + id: googleworkspace.drivev3.files_labels + name: files_labels + title: Files_labels + methods: + list_labels: + operation: + $ref: '#/paths/~1files~1{fileId}~1listLabels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.labels + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files_labels/methods/list_labels' + insert: [] + update: [] + replace: [] + delete: [] + permissions: + id: googleworkspace.drivev3.permissions + name: permissions + title: Permissions + methods: + create: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.permissions + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1permissions~1{permissionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/permissions/methods/get' + - $ref: '#/components/x-stackQL-resources/permissions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/permissions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete' + replies: + id: googleworkspace.drivev3.replies + name: replies + title: Replies + methods: + create: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1comments~1{commentId}~1replies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.replies + delete: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1comments~1{commentId}~1replies~1{replyId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/replies/methods/get' + - $ref: '#/components/x-stackQL-resources/replies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/replies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/replies/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/replies/methods/delete' + revisions: + id: googleworkspace.drivev3.revisions + name: revisions + title: Revisions + methods: + delete: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions~1{revisionId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1revisions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.revisions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/revisions/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' + teamdrives: + id: googleworkspace.drivev3.teamdrives + name: teamdrives + title: Teamdrives + methods: + create: + operation: + $ref: '#/paths/~1teamdrives/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1teamdrives/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.teamDrives + delete: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1teamdrives~1{teamDriveId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/get' + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/teamdrives/methods/delete' + accessproposals: + id: googleworkspace.drivev3.accessproposals + name: accessproposals + title: Accessproposals + methods: + get: + operation: + $ref: '#/paths/~1files~1{fileId}~1accessproposals~1{proposalId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + resolve: + operation: + $ref: >- + #/paths/~1files~1{fileId}~1accessproposals~1{proposalId}:resolve/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1files~1{fileId}~1accessproposals/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.accessProposals + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/accessproposals/methods/get' + - $ref: '#/components/x-stackQL-resources/accessproposals/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /operations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: drive.operations.list + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: query + name: name + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /operations/{name}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: drive.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: name + required: true + schema: + type: string + /operation/{name}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: drive.operation.delete + security: [] + responses: + '204': + description: No Content + parameters: + - in: path + name: name + required: true + schema: + type: string + /operation/{name}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: drive.operation.cancel + security: [] + responses: + '204': + description: No Content + parameters: + - in: path + name: name + required: true + schema: + type: string + /about: + parameters: *ref_1 + get: + description: >- + Gets information about the user, the user's Drive, and system + capabilities. + operationId: drive.about.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/About' + parameters: [] + /apps/{appId}: + parameters: *ref_1 + get: + description: Gets a specific app. + operationId: drive.apps.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/App' + parameters: + - in: path + name: appId + required: true + schema: + type: string + /apps: + parameters: *ref_1 + get: + description: Lists a user's installed apps. + operationId: drive.apps.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive.apps.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.apps.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AppList' + parameters: + - in: query + name: appFilterExtensions + schema: + type: string + - in: query + name: appFilterMimeTypes + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /changes/startPageToken: + parameters: *ref_1 + get: + description: Gets the starting pageToken for listing future changes. + operationId: drive.changes.getStartPageToken + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/StartPageToken' + parameters: + - in: query + name: driveId + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + /changes: + parameters: *ref_1 + get: + description: Lists the changes for a user or shared drive. + operationId: drive.changes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ChangeList' + parameters: + - in: query + name: pageToken + required: true + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeRemoved + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: restrictToMyDrive + schema: + type: boolean + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /changes/watch: + parameters: *ref_1 + post: + description: Subscribes to changes for a user. + operationId: drive.changes.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: query + name: pageToken + required: true + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeCorpusRemovals + schema: + type: boolean + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeRemoved + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: restrictToMyDrive + schema: + type: boolean + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /channels/stop: + parameters: *ref_1 + post: + description: Stops watching resources through this channel. + operationId: drive.channels.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: [] + /files/{fileId}/comments: + parameters: *ref_1 + post: + description: Creates a comment on a file. + operationId: drive.comments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + get: + description: Lists a file's comments. + operationId: drive.comments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CommentList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: startModifiedTime + schema: + type: string + /files/{fileId}/comments/{commentId}: + parameters: *ref_1 + delete: + description: Deletes a comment. + operationId: drive.comments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Gets a comment by ID. + operationId: drive.comments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates a comment with patch semantics. + operationId: drive.comments.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + /drives: + parameters: *ref_1 + post: + description: Creates a shared drive. + operationId: drive.drives.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: ' Lists the user''s shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.' + operationId: drive.drives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DriveList' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a shared drive for which the user is an `organizer`. + The shared drive cannot contain any untrashed items. + operationId: drive.drives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: allowItemDeletion + schema: + type: boolean + get: + description: Gets a shared drive's metadata by ID. + operationId: drive.drives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: Updates the metadata for a shared drive. + operationId: drive.drives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /drives/{driveId}/hide: + parameters: *ref_1 + post: + description: Hides a shared drive from the default view. + operationId: drive.drives.hide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /drives/{driveId}/unhide: + parameters: *ref_1 + post: + description: Restores a shared drive to the default view. + operationId: drive.drives.unhide + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Drive' + parameters: + - in: path + name: driveId + required: true + schema: + type: string + /files/{fileId}/copy: + parameters: *ref_1 + post: + description: >- + Creates a copy of a file and applies any requested updates with patch + semantics. + operationId: drive.files.copy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ignoreDefaultVisibility + schema: + type: boolean + - in: query + name: keepRevisionForever + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files: + parameters: *ref_1 + post: + description: ' Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file''s MIME type.' + operationId: drive.files.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: ignoreDefaultVisibility + schema: + type: boolean + - in: query + name: keepRevisionForever + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + get: + description: ' Lists the user''s files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don''t want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.' + operationId: drive.files.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FileList' + parameters: + - in: query + name: corpora + schema: + type: string + - in: query + name: corpus + schema: + type: string + - in: query + name: driveId + schema: + type: string + - in: query + name: includeItemsFromAllDrives + schema: + type: boolean + - in: query + name: includeTeamDriveItems + schema: + type: boolean + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: spaces + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: teamDriveId + schema: + type: string + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file owned by the user without moving it to the + trash. If the file belongs to a shared drive, the user must be an + `organizer` on the parent folder. If the target is a folder, all + descendants owned by the user are also deleted. + operationId: drive.files.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: enforceSingleParent + schema: + type: boolean + get: + description: ' Gets a file''s metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).' + operationId: drive.files.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + patch: + description: ' Updates a file''s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).' + operationId: drive.files.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/File' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.scripts + Oauth2c: + - https://www.googleapis.com/auth/drive.scripts + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/File' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: addParents + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: keepRevisionForever + schema: + type: boolean + - in: query + name: ocrLanguage + schema: + type: string + - in: query + name: removeParents + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useContentAsIndexableText + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/trash: + parameters: *ref_1 + delete: + description: Permanently deletes all of the user's trashed files. + operationId: drive.files.emptyTrash + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: driveId + schema: + type: string + /files/{fileId}/export: + parameters: *ref_1 + get: + description: >- + Exports a Google Workspace document to the requested MIME type and + returns exported byte content. Note that the exported content is limited + to 10MB. + operationId: drive.files.export + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: mimeType + required: true + schema: + type: string + /files/generateIds: + parameters: *ref_1 + get: + description: >- + Generates a set of file IDs which can be provided in create or copy + requests. + operationId: drive.files.generateIds + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GeneratedIds' + parameters: + - in: query + name: count + schema: + type: integer + format: int32 + - in: query + name: space + schema: + type: string + - in: query + name: type + schema: + type: string + /files/{fileId}/listLabels: + parameters: *ref_1 + get: + description: Lists the labels on a file. + operationId: drive.files.listLabels + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LabelList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/modifyLabels: + parameters: *ref_1 + post: + description: >- + Modifies the set of labels applied to a file. Returns a list of the + labels that were added or modified. + operationId: drive.files.modifyLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyLabelsResponse' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + /files/{fileId}/watch: + parameters: *ref_1 + post: + description: Subscribes to changes to a file. + operationId: drive.files.watch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: acknowledgeAbuse + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + - in: query + name: includeLabels + schema: + type: string + /files/{fileId}/download: + parameters: *ref_1 + post: + description: >- + Downloads content of a file. Operations are valid for 24 hours from the + time of creation. + operationId: drive.files.download + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: mimeType + schema: + type: string + - in: query + name: revisionId + schema: + type: string + /files/{fileId}/permissions: + parameters: *ref_1 + post: + description: >- + Creates a permission for a file or shared drive. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: emailMessage + schema: + type: string + - in: query + name: enforceSingleParent + schema: + type: boolean + - in: query + name: moveToNewOwnersRoot + schema: + type: boolean + - in: query + name: sendNotificationEmail + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Lists a file's or shared drive's permissions. + operationId: drive.permissions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + - in: query + name: includePermissionsForView + schema: + type: string + /files/{fileId}/permissions/{permissionId}: + parameters: *ref_1 + delete: + description: >- + Deletes a permission. **Warning:** Concurrent permissions operations on + the same file are not supported; only the last update is applied. + operationId: drive.permissions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + get: + description: Gets a permission by ID. + operationId: drive.permissions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: >- + Updates a permission with patch semantics. **Warning:** Concurrent + permissions operations on the same file are not supported; only the last + update is applied. + operationId: drive.permissions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Permission' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: permissionId + required: true + schema: + type: string + - in: query + name: removeExpiration + schema: + type: boolean + - in: query + name: supportsAllDrives + schema: + type: boolean + - in: query + name: supportsTeamDrives + schema: + type: boolean + - in: query + name: transferOwnership + schema: + type: boolean + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /files/{fileId}/comments/{commentId}/replies: + parameters: *ref_1 + post: + description: Creates a reply to a comment. + operationId: drive.replies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + get: + description: Lists a comment's replies. + operationId: drive.replies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ReplyList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /files/{fileId}/comments/{commentId}/replies/{replyId}: + parameters: *ref_1 + delete: + description: Deletes a reply. + operationId: drive.replies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + get: + description: Gets a reply by ID. + operationId: drive.replies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + - in: query + name: includeDeleted + schema: + type: boolean + patch: + description: Updates a reply with patch semantics. + operationId: drive.replies.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Reply' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: commentId + required: true + schema: + type: string + - in: path + name: replyId + required: true + schema: + type: string + /files/{fileId}/revisions/{revisionId}: + parameters: *ref_1 + delete: + description: >- + Permanently deletes a file version. You can only delete revisions for + files with binary content in Google Drive, like images or videos. + Revisions for other files, like Google Docs or Sheets, and the last + remaining file version can't be deleted. + operationId: drive.revisions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + get: + description: Gets a revision's metadata or content by ID. + operationId: drive.revisions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + - in: query + name: acknowledgeAbuse + schema: + type: boolean + patch: + description: Updates a revision with patch semantics. + operationId: drive.revisions.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Revision' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: revisionId + required: true + schema: + type: string + /files/{fileId}/revisions: + parameters: *ref_1 + get: + description: Lists a file's revisions. + operationId: drive.revisions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.appdata + Oauth2c: + - https://www.googleapis.com/auth/drive.appdata + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.meet.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.meet.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.photos.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.photos.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RevisionList' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /teamdrives: + parameters: *ref_1 + post: + description: 'Deprecated: Use `drives.create` instead.' + operationId: drive.teamdrives.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: query + name: requestId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.list` instead.' + operationId: drive.teamdrives.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDriveList' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: q + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /teamdrives/{teamDriveId}: + parameters: *ref_1 + delete: + description: 'Deprecated: Use `drives.delete` instead.' + operationId: drive.teamdrives.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '204': + description: No Content + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + get: + description: 'Deprecated: Use `drives.get` instead.' + operationId: drive.teamdrives.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + patch: + description: 'Deprecated: Use `drives.update` instead.' + operationId: drive.teamdrives.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TeamDrive' + parameters: + - in: path + name: teamDriveId + required: true + schema: + type: string + - in: query + name: useDomainAdminAccess + schema: + type: boolean + /files/{fileId}/accessproposals/{proposalId}: + parameters: *ref_1 + get: + description: Retrieves an AccessProposal by ID. + operationId: drive.accessproposals.get + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AccessProposal' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: proposalId + required: true + schema: + type: string + /files/{fileId}/accessproposals/{proposalId}:resolve: + parameters: *ref_1 + post: + description: Used to approve or deny an Access Proposal. + operationId: drive.accessproposals.resolve + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResolveAccessProposalRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + responses: + '204': + description: No Content + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: path + name: proposalId + required: true + schema: + type: string + /files/{fileId}/accessproposals: + parameters: *ref_1 + get: + description: >- + List the AccessProposals on a file. Note: Only approvers are able to + list AccessProposals on a file. If the user is not an approver, returns + a 403. + operationId: drive.accessproposals.list + security: + - Oauth2: + - https://www.googleapis.com/auth/drive + Oauth2c: + - https://www.googleapis.com/auth/drive + - Oauth2: + - https://www.googleapis.com/auth/drive.file + Oauth2c: + - https://www.googleapis.com/auth/drive.file + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata + - Oauth2: + - https://www.googleapis.com/auth/drive.metadata.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.metadata.readonly + - Oauth2: + - https://www.googleapis.com/auth/drive.readonly + Oauth2c: + - https://www.googleapis.com/auth/drive.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAccessProposalsResponse' + parameters: + - in: path + name: fileId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32