CreateCustomSchema
Creates a custom schema file based on the specified Dimensions and Metrics.
CreateCustomSchema
Creates a custom schema file based on the specified Dimensions and Metrics.
A custom schema may be used for a more tailored approach to your data. Custom options may include comma-separated lists for specific data.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| TableName | String | True | False | The name for the new table. |
| Description | String | False | False | An optional description for the table. |
| WriteToFile | String | False | False | Whether to write to an output file. Defaults to true, must be set to false to write to FileStream or FileData. |
| Dimensions | String | False | False | A comma-separated list of dimensions to include in the schema file. Enter ColumnAlias=ColumnName Example: Alias1=Column1,Alias2=column2. Here is a list of the possible values: https://ga-dev-tools.web.app/dimensions-metrics-explorer/ |
| Metrics | String | True | False | A comma-separated list of metrics to include in the schema file. Enter ColumnAlias=ColumnName Example: Alias1=Column1,Alias2=column2. Here is a list of the possible values: https://ga-dev-tools.web.app/dimensions-metrics-explorer/ |
| Profile | String | False | False | The Profile Id or website URL to retrieve data from. This acts as the Report's default Profile when no value is specified for either the Profile pseudo-column or the Profile connection property. |
| FileStream | String | False | True | OutputStream to write the created schema. Only used if WriteToFile set to false |
Result Set Columns
| Name | Type | Description |
| Success | String | Whether the schema was created successfully. |
| SchemaFile | String | The generated schema file. |
| FileData | String | The generated schema encoded in base64. Only returned if WriteToFile set to false and FileStream is not set. |