Some methods support field projection, which allows you to control which fields the method returns.
Specify a predefined enumeration in the fields
parameter to indicate the fields you want a method to return. The enumerations may be either:
In some cases, specific fields
values may be protected by additional permissions.
Legacy APIs offer fieldsets
and fields
to manage returned fields:
Fieldsets are predefined and named sets of fields. Fieldsets cover common use cases. The default fieldset is typically the full object, although some methods may specify a different default fieldset. See each method's documentation for specific details.
Fields allow you to supply a list of individual field names to return.
If you specify fieldsets and projected fields together in a request, the union of all included fields is returned. For example, if you specify the BASIC
fieldset and the info.birthdate
field, all fields included in the BASIC
fieldset and info.birthdate
are returned.
If neither fieldsets nor projected fields are specified, the default fieldset is returned.