Возвращать определенные поля

Чтобы вернуть именно те поля, которые вам нужны, и повысить производительность, используйте системный параметр fields в вызове метода.

Параметр fields использует FieldMask для фильтрации ответов. Маски полей используются для указания подмножества полей, которые должен вернуть запрос. Использование маски поля — хорошая практика проектирования, позволяющая избежать запроса ненужных данных, что, в свою очередь, помогает избежать ненужного времени обработки.

По умолчанию сервер возвращает набор полей, специфичных для запрашиваемого ресурса. Например, метод get() ресурса files может возвращать только id , name и mimeType . Метод get() ресурса permissions возвращает другой набор полей по умолчанию.

После того как сервер обработает действительный запрос, включающий параметр fields , он возвращает код состояния HTTP 200 OK вместе с запрошенными данными. Если параметр полей имеет ошибку или по какой-либо другой причине недействителен, сервер возвращает код состояния HTTP 400 Bad Request вместе с сообщением об ошибке, указывающим, что не так с выбором полей. Например, files.list(fields='files(id,capabilities,canAddChildren)') выдает ошибку «Неверный выбор поля canAddChildren». Правильный параметр полей для этого примера — files.list(fields='files(id,capabilities/canAddChildren)') .

Чтобы определить поля, которые вы можете вернуть с помощью параметра fields , посетите страницу документации запрашиваемого ресурса. Например, чтобы узнать, какие поля можно вернуть для файла, обратитесь к документации по ресурсам files .

Правила формата параметров поля

Формат значения параметра запроса полей во многом основан на синтаксисе XPath. Ниже приведены правила форматирования параметра fields . Во всех этих правилах используются примеры, связанные с методом files.get() .

  • Используйте список, разделенный запятыми, чтобы выбрать несколько полей, например 'name, mimeType' .

  • Используйте a/b , чтобы выбрать поле b , вложенное в поле a , например 'capabilities/canDownload' . Дополнительные сведения см. в разделе Получение полей вложенного ресурса .

  • Используйте дополнительный селектор, чтобы запросить набор определенных подполей массивов или объектов, помещая выражения в круглые скобки «()». Например, 'permissions(id)' возвращает только идентификатор разрешения для каждого элемента в массиве разрешений.

  • Чтобы вернуть все поля объекта, используйте звездочку ( * ) в качестве подстановочного знака при выборе полей. Например, 'permissions/permissionDetails/*' выбирает все доступные поля сведений о разрешениях для каждого разрешения. Обратите внимание, что использование подстановочного знака может привести к снижению производительности запроса.

Показать пример

Запрос

В этом примере мы предоставляем параметр пути к идентификатору файла и несколько полей в качестве параметра запроса в запросе. Ответ возвращает значения полей для идентификатора файла.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared

Ответ 

{
  "name": "File1",
  "starred": false,
  "shared": true
  }
}

Получить поля вложенного ресурса

Если поле ссылается на другой ресурс, вы можете указать, какие поля вложенного ресурса следует извлечь.

Например, чтобы получить поле role (вложенный ресурс) ресурса permissions , используйте любой из следующих параметров:

  • permissions.get() с fields=role .
  • permissions.get() с fields=* чтобы показать все поля permissions .
  • files.get() с fields=permissions(role) или fields=permissions/role .
  • files.get() с fields=permissions чтобы показать все поля permissions .
  • changes.list() с fields=changes(file(permissions(role))) .

Чтобы получить несколько полей, используйте список, разделенный запятыми. Например, files.list() с fields=files(id,name,createdTime,modifiedTime,size) .

Показать пример

Запрос

В этом примере мы предоставляем параметр пути к идентификатору файла и несколько полей, включая определенные поля ресурса вложенных разрешений, в качестве параметра запроса в запросе. Ответ возвращает значения полей для идентификатора файла.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared,permissions(kind,type,role)

Ответ 

{
  "name": "File1",
  "starred": false,
  "shared": true,
  "permissions": [
    {
      "kind": "drive#permission",
      "type": "user",
      "role": "owner"
    }
  ]
}