Interface GoogleAnalyticsV1NodeParameters

Source
interface GoogleAnalyticsV1NodeParameters {
    additionalFields?:
        | {
            dateRangesUi?: {
                dateRanges: {
                    endDate?: string;
                    startDate?: string;
                };
            };
            dimensionFiltersUi?: {
                filterValues: {
                    dimensionName?: string;
                    expressions?: string;
                    operator?: | "BEGINS_WITH"
                    | "ENDS_WITH"
                    | "NUMERIC_EQUAL"
                    | "EXACT"
                    | "NUMERIC_GREATER_THAN"
                    | "NUMERIC_LESS_THAN"
                    | "PARTIAL"
                    | "REGEXP";
                }[];
            };
            dimensionUi?: {
                dimensionValues: { name?: string }[];
            };
            hideTotals?: boolean;
            hideValueRanges?: boolean;
            includeEmptyRows?: boolean;
            metricsUi?: {
                metricValues: {
                    alias?: string;
                    expression?: string;
                    formattingType?: | "CURRENCY"
                    | "FLOAT"
                    | "INTEGER"
                    | "PERCENT"
                    | "TIME";
                }[];
            };
            useResourceQuotas?: boolean;
        }
        | {
            activityTypes?: (
                | "ECOMMERCE"
                | "EVENT"
                | "GOAL"
                | "PAGEVIEW"
                | "SCREENVIEW"
            )[];
        };
    limit?: number;
    operation?: "get"
    | "search";
    resource?: "report" | "userActivity";
    returnAll?: boolean;
    simple?: boolean;
    userId?: string;
    viewId?: string;
}

Properties§

Source§

readonly additionalFields?:
    | {
        dateRangesUi?: {
            dateRanges: {
                endDate?: string;
                startDate?: string;
            };
        };
        dimensionFiltersUi?: {
            filterValues: {
                dimensionName?: string;
                expressions?: string;
                operator?: | "BEGINS_WITH"
                | "ENDS_WITH"
                | "NUMERIC_EQUAL"
                | "EXACT"
                | "NUMERIC_GREATER_THAN"
                | "NUMERIC_LESS_THAN"
                | "PARTIAL"
                | "REGEXP";
            }[];
        };
        dimensionUi?: { dimensionValues: { name?: string }[] };
        hideTotals?: boolean;
        hideValueRanges?: boolean;
        includeEmptyRows?: boolean;
        metricsUi?: {
            metricValues: {
                alias?: string;
                expression?: string;
                formattingType?:
                    | "CURRENCY"
                    | "FLOAT"
                    | "INTEGER"
                    | "PERCENT"
                    | "TIME";
            }[];
        };
        useResourceQuotas?: boolean;
    }
    | {
        activityTypes?: (
            | "ECOMMERCE"
            | "EVENT"
            | "GOAL"
            | "PAGEVIEW"
            | "SCREENVIEW"
        )[];
    }

Default: {}

Source§

readonly limit?: number

Max number of results to return Default: 1000 Type options: {"minValue":1,"maxValue":1000}

Source§

readonly operation?: "get" | "search"

Default: "get"

Source§

readonly resource?: "report" | "userActivity"

Default: "report"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

Source§

readonly userId?: string

ID of a user

Source§

readonly viewId?: string

The View ID of Google Analytics. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getViews"}