CreateReportSchema
Create schema for a custom report.
CreateReportSchema
CreateReportSchema creates a schema file based on the specified report. This schema adds a table to your existing list that corresponds with the results of your report which can be queried like other tables. Reports from the Google Ads Manager are not modeled by adapter as queryable tables by default.
The generated schema file outlines the metadata for the report, such as columns and column data types. You can edit the file to adjust data types, rename columns, and include or exclude columns.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| ReportName | String | True | False | The name of the report. |
| BaseReportName | String | False | False | The original report name that the new report will be based on. |
| FileName | String | False | False | The full file path and name of the schema to generate. Ex : 'C:/Users/User/Desktop/SampleReport.rsd' |
| Metrics | String | False | False | Metrics of the report separated by comma. Ex: 'AD_SERVER_IMPRESSIONS,AD_SERVER_TARGETED_IMPRESSIONS,AD_SERVER_CLICKS,AD_SERVER_TARGETED_CLICKS' |
| Dimensions | String | False | False | Dimensions of the report separated by comma. Ex: 'MONTH_AND_YEAR,WEEK,DATE,DAY,CUSTOM_DIMENSION,ORDER_NAME' |
| CustomFieldIdsPrimitive | String | False | False | The list of CustomField.id (Number, Toggle or Text type) separated by comma. Ex: '1459925,1459958'. To add a CustomField to the report, you must also include its corresponding dimension in the list of Dimensions. |
| CustomFieldIdsDropdown | String | False | False | The list of CustomField.id (Drop-down type) separated by comma. Ex: '1459925,1459958'. To add a CustomField to the report, you must also include its corresponding dimension in the list of Dimensions. |
| CustomDimensionKeyIds | String | False | False | The list of custom dimension custom targeting key IDs separated by comma. Ex: '13539564,13539567'. To add a custom dimension key ID, you must include 'CUSTOM_DIMENSION' in the list of Dimensions. |
| FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if FileName is not set. |
Result Set Columns
| Name | Type | Description |
| FileData | String | The schema's content encoded in BASE64. Only used if FileName and FileStream are not set. |
| Success | String | Returns True if the report is successfully created. |