Reference documentation and code samples for the Google API Common Protos Client class SystemParameters.
System parameter configuration
A system parameter is a special kind of parameter defined by the API
system, not by an individual API. It is typically mapped to an HTTP header
and/or a URL query parameter. This configuration specifies which methods
change the names of the system parameters.
Generated from protobuf messagegoogle.api.SystemParameters
Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:* All service configuration rules follow "last one wins" order.
getRules
Define system parameters.
The parameters defined here will override the default parameters
implemented by the system. If this field is missing from the service
config, default system parameters will be used. Default system parameters
and names is implementation-dependent.
Example: define api key for all methods
system_parameters
rules:
selector: "*"
parameters:
name: api_key
url_query_parameter: api_key
Example: define 2 api key names for a specific method.
system_parameters
rules:
selector: "/ListShelves"
parameters:
name: api_key
http_header: Api-Key1
name: api_key
http_header: Api-Key2NOTE:All service configuration rules follow "last one wins" order.
The parameters defined here will override the default parameters
implemented by the system. If this field is missing from the service
config, default system parameters will be used. Default system parameters
and names is implementation-dependent.
Example: define api key for all methods
system_parameters
rules:
selector: "*"
parameters:
name: api_key
url_query_parameter: api_key
Example: define 2 api key names for a specific method.
system_parameters
rules:
selector: "/ListShelves"
parameters:
name: api_key
http_header: Api-Key1
name: api_key
http_header: Api-Key2NOTE:All service configuration rules follow "last one wins" order.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class SystemParameters (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Api.SystemParameters)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Api.SystemParameters)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Api.SystemParameters)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Api.SystemParameters)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Api.SystemParameters)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Api.SystemParameters) \nReference documentation and code samples for the Google API Common Protos Client class SystemParameters.\n\n### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.\n\nGenerated from protobuf message `google.api.SystemParameters`\n\nNamespace\n---------\n\nGoogle \\\\ Api\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getRules\n\nDefine system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\nExample: define api key for all methods\nsystem_parameters\nrules:\n\n- selector: \"\\*\" parameters:\n - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules:\n- selector: \"/ListShelves\" parameters:\n - name: api_key http_header: Api-Key1\n - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow \"last one wins\" order.\n\n### setRules\n\nDefine system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\nExample: define api key for all methods\nsystem_parameters\nrules:\n\n- selector: \"\\*\" parameters:\n - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules:\n- selector: \"/ListShelves\" parameters:\n - name: api_key http_header: Api-Key1\n - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow \"last one wins\" order."]]
