PHP Extension Google Drive: Rename a File (Update a File's MetaData)

Back to Index

Updates a file's metadata and/or content with patch semantics. (This example renames the file having id = 1R_70heIyzIAu1_u0prXbYcaIiJRVkgBl)

Documentation: https://developers.google.com/drive/v3/reference/files/update

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

$rest = new CkRest();

//   Provide a previously obtained OAuth2 access token.
$oauth2 = new CkOAuth2();
$oauth2->put_AccessToken('OAUTH2_ACCESS_TOKEN');
$rest->SetAuthOAuth2($oauth2);

$success = $rest->Connect('www.googleapis.com',443,true,true);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$rest->AddQueryParam('includeTeamDriveItems','true');
$rest->AddQueryParam('supportsTeamDrives','true');

//  The following code creates the JSON request body.
//  The JSON created by this code is shown below.
$jsonReq = new CkJsonObject();
$jsonReq->UpdateString('name','three_penguins.jpg');

$sbReq = new CkStringBuilder();
$jsonReq->EmitSb($sbReq);

$rest->AddHeader('Content-Type','application/json');

$sbJson = new CkStringBuilder();
$success = $rest->FullRequestSb('PATCH','/drive/v3/files/1R_70heIyzIAu1_u0prXbYcaIiJRVkgBl',$sbReq,$sbJson);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

if ($rest->get_ResponseStatusCode() != 200) {
    print 'Received error response code: ' . $rest->get_ResponseStatusCode() . "\n";
    print 'Response body:' . "\n";
    print $sbJson->getAsString() . "\n";
    exit;
}

$json = new CkJsonObject();
$json->LoadSb($sbJson);

//  The following code parses the JSON response.
//  A sample JSON response is shown below the sample code.

$kind = $json->stringOf('kind');
$id = $json->stringOf('id');
$name = $json->stringOf('name');
$mimeType = $json->stringOf('mimeType');
$teamDriveId = $json->stringOf('teamDriveId');

print 'Example Completed.' . "\n";

?>

Sample JSON Request Body

{
    "name": "three_penguins.jpg"
}

Sample JSON Response Body

{
  "kind": "drive#file",
  "id": "1R_70heIyzIAu1_u0prXbYcaIiJRVkgBl",
  "name": "three_penguins.jpg",
  "mimeType": "image/jpeg",
  "teamDriveId": "0AEd3EhGff2SaUk9PVA"
}