RequestMask
Stay organized with collections
Save and categorize content based on your preferences.
DEPRECATED(Please use personFields
instead)
Describes which person fields to return in the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-06 UTC."],[[["\u003cp\u003eThis item is deprecated and users should utilize \u003ccode\u003epersonFields\u003c/code\u003e instead.\u003c/p\u003e\n"],["\u003cp\u003eIt describes which person fields to return in the response using a JSON representation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eincludeField\u003c/code\u003e requires a FieldMask format to specify desired fields.\u003c/p\u003e\n"],["\u003cp\u003eUsers must provide a comma-separated list of person fields, prefixed with \u003ccode\u003eperson.\u003c/code\u003e, to be included in the response.\u003c/p\u003e\n"]]],["The deprecated item describes the `includeField` for specifying which person fields to return in a response. It is represented in JSON as `{\"includeField\": string}`. The `includeField` is a required string containing a comma-separated list of person fields, formatted as `person.field`, using the FieldMask format. This has been deprecated in favor of `personFields`.\n"],null,["# RequestMask\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\n| This item is deprecated!\n**DEPRECATED** (Please use `personFields` instead)\n\nDescribes which person fields to return in the response.\n\n| JSON representation |\n|------------------------------------|\n| ``` { \"includeField\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `includeField` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. |"]]
