Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Export-GDriveFile

SYNOPSIS

Exports a Google Doc to the requested MIME type and returns the exported content.

SYNTAX

Export-GDriveFile [-FileId] <String> [-MimeType] <String> [-DownloadPath] <String> [-TargetUserEmail <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Exports a Google Doc to the requested MIME type and returns the exported content.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Export-GDriveFile -FileId $SomeFileIdString -MimeType $SomeMimeTypeString -DownloadPath $SomeDownloadPath

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-FileId

The ID of the file.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MimeType

The MIME type of the format requested for this export. For details on the acceptable MIME types, please see uri="https://developers.google.com/drive/v3/web/manage-downloads"\>\[DownloadFiles\]

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DownloadPath

The target download path of the file, including filename and extension.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetUserEmail

The email account to be targeted by the service account.

Type: String
Parameter Sets: (All)
Aliases: ServiceAccountTarget

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

The ID of the file.

System.String

The MIME type of the format requested for this export. For details on the acceptable MIME types, please see uri="https://developers.google.com/drive/v3/web/manage-downloads"\>\[DownloadFiles\]

System.String

The target download path of the file, including filename and extension.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Drive API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally