From d233f6926d84118f656dece45cc958acaeb3f014 Mon Sep 17 00:00:00 2001 From: Google API Typings Generator <69665763+google-api-typings-generator@users.noreply.github.com> Date: Thu, 24 Sep 2020 13:26:34 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Merge=20PR=20#48121=20[gapi.clie?= =?UTF-8?q?nt.analyticsreporting]=20automatic=20update=20by=20@google-api-?= =?UTF-8?q?typings-generator?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Maxim Mazurok --- .../gapi.client.analyticsreporting-tests.ts | 264 +++++- .../gapi.client.analyticsreporting/index.d.ts | 803 ++++++++++-------- .../gapi.client.analyticsreporting/readme.md | 59 +- .../tsconfig.json | 10 +- .../tslint.json | 5 +- 5 files changed, 721 insertions(+), 420 deletions(-) diff --git a/types/gapi.client.analyticsreporting/gapi.client.analyticsreporting-tests.ts b/types/gapi.client.analyticsreporting/gapi.client.analyticsreporting-tests.ts index bacc354694..b639edc6db 100644 --- a/types/gapi.client.analyticsreporting/gapi.client.analyticsreporting-tests.ts +++ b/types/gapi.client.analyticsreporting/gapi.client.analyticsreporting-tests.ts @@ -1,8 +1,11 @@ -/* This is stub file for gapi.client.{{=it.name}} definition tests */ +/* This is stub file for gapi.client.analyticsreporting definition tests */ /* IMPORTANT. -* This file was automatically generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually. -* In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator +* This file was automatically generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually. +* In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator **/ + +// Revision: 20200922 + gapi.load('client', () => { /** now we can use gapi.client */ gapi.client.load('analyticsreporting', 'v4', () => { @@ -17,21 +20,268 @@ gapi.load('client', () => { /** View your Google Analytics data */ 'https://www.googleapis.com/auth/analytics.readonly', ]; - const immediate = true; + const immediate = false; gapi.auth.authorize({ client_id, scope, immediate }, authResult => { if (authResult && !authResult.error) { - /** handle succesfull authorization */ + /** handle successful authorization */ run(); } else { /** handle authorization error */ } }); - run(); }); async function run() { /** Returns the Analytics data. */ - await gapi.client.reports.batchGet({ + await gapi.client.analyticsreporting.reports.batchGet({ + }, { + reportRequests: [ + { + cohortGroup: { + cohorts: [ + { + dateRange: { + endDate: "Test string", + startDate: "Test string", + }, + name: "Test string", + type: "Test string", + } ], + lifetimeValue: true, + }, + dateRanges: [ + { + endDate: "Test string", + startDate: "Test string", + } ], + dimensionFilterClauses: [ + { + filters: [ + { + caseSensitive: true, + dimensionName: "Test string", + expressions: [ + "Test string" ], + not: true, + operator: "Test string", + } ], + operator: "Test string", + } ], + dimensions: [ + { + histogramBuckets: [ + "Test string" ], + name: "Test string", + } ], + filtersExpression: "Test string", + hideTotals: true, + hideValueRanges: true, + includeEmptyRows: true, + metricFilterClauses: [ + { + filters: [ + { + comparisonValue: "Test string", + metricName: "Test string", + not: true, + operator: "Test string", + } ], + operator: "Test string", + } ], + metrics: [ + { + alias: "Test string", + expression: "Test string", + formattingType: "Test string", + } ], + orderBys: [ + { + fieldName: "Test string", + orderType: "Test string", + sortOrder: "Test string", + } ], + pageSize: 42, + pageToken: "Test string", + pivots: [ + { + dimensionFilterClauses: [ + { + filters: [ + { + caseSensitive: true, + dimensionName: "Test string", + expressions: [ + "Test string" ], + not: true, + operator: "Test string", + } ], + operator: "Test string", + } ], + dimensions: [ + { + histogramBuckets: [ + "Test string" ], + name: "Test string", + } ], + maxGroupCount: 42, + metrics: [ + { + alias: "Test string", + expression: "Test string", + formattingType: "Test string", + } ], + startGroup: 42, + } ], + samplingLevel: "Test string", + segments: [ + { + dynamicSegment: { + name: "Test string", + sessionSegment: { + segmentFilters: [ + { + not: true, + sequenceSegment: { + firstStepShouldMatchFirstHit: true, + segmentSequenceSteps: [ + { + matchType: "Test string", + orFiltersForSegment: [ + { + segmentFilterClauses: [ + { + dimensionFilter: { + caseSensitive: true, + dimensionName: "Test string", + expressions: [ + "Test string" ], + maxComparisonValue: "Test string", + minComparisonValue: "Test string", + operator: "Test string", + }, + metricFilter: { + comparisonValue: "Test string", + maxComparisonValue: "Test string", + metricName: "Test string", + operator: "Test string", + scope: "Test string", + }, + not: true, + } ], + } ], + } ], + }, + simpleSegment: { + orFiltersForSegment: [ + { + segmentFilterClauses: [ + { + dimensionFilter: { + caseSensitive: true, + dimensionName: "Test string", + expressions: [ + "Test string" ], + maxComparisonValue: "Test string", + minComparisonValue: "Test string", + operator: "Test string", + }, + metricFilter: { + comparisonValue: "Test string", + maxComparisonValue: "Test string", + metricName: "Test string", + operator: "Test string", + scope: "Test string", + }, + not: true, + } ], + } ], + }, + } ], + }, + userSegment: { + segmentFilters: [ + { + not: true, + sequenceSegment: { + firstStepShouldMatchFirstHit: true, + segmentSequenceSteps: [ + { + matchType: "Test string", + orFiltersForSegment: [ + { + segmentFilterClauses: [ + { + dimensionFilter: { + caseSensitive: true, + dimensionName: "Test string", + expressions: [ + "Test string" ], + maxComparisonValue: "Test string", + minComparisonValue: "Test string", + operator: "Test string", + }, + metricFilter: { + comparisonValue: "Test string", + maxComparisonValue: "Test string", + metricName: "Test string", + operator: "Test string", + scope: "Test string", + }, + not: true, + } ], + } ], + } ], + }, + simpleSegment: { + orFiltersForSegment: [ + { + segmentFilterClauses: [ + { + dimensionFilter: { + caseSensitive: true, + dimensionName: "Test string", + expressions: [ + "Test string" ], + maxComparisonValue: "Test string", + minComparisonValue: "Test string", + operator: "Test string", + }, + metricFilter: { + comparisonValue: "Test string", + maxComparisonValue: "Test string", + metricName: "Test string", + operator: "Test string", + scope: "Test string", + }, + not: true, + } ], + } ], + }, + } ], + }, + }, + segmentId: "Test string", + } ], + viewId: "Test string", + } ], + useResourceQuotas: true, + }); + /** Returns User Activity data. */ + await gapi.client.analyticsreporting.userActivity.search({ + }, { + activityTypes: [ + "Test string" ], + dateRange: { + endDate: "Test string", + startDate: "Test string", + }, + pageSize: 42, + pageToken: "Test string", + user: { + type: "Test string", + userId: "Test string", + }, + viewId: "Test string", }); } }); diff --git a/types/gapi.client.analyticsreporting/index.d.ts b/types/gapi.client.analyticsreporting/index.d.ts index 9c2d842b2f..b067aacc40 100644 --- a/types/gapi.client.analyticsreporting/index.d.ts +++ b/types/gapi.client.analyticsreporting/index.d.ts @@ -1,84 +1,101 @@ -// Type definitions for non-npm package Google Google Analytics Reporting API v4 4.0 +// Type definitions for non-npm package Analytics Reporting API v4 4.0 // Project: https://developers.google.com/analytics/devguides/reporting/core/v4/ -// Definitions by: Bolisov Alexey +// Definitions by: Maxim Mazurok +// Google API Typings Generator +// Nick Amoscato +// Declan Vong // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.3 +// TypeScript Version: 2.8 // IMPORTANT -// This file was generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually. -// In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator +// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually. +// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator // Generated from: https://analyticsreporting.googleapis.com/$discovery/rest?version=v4 +// Revision: 20200922 /// declare namespace gapi.client { - /** Load Google Analytics Reporting API v4 */ + /** Load Analytics Reporting API v4 */ function load(name: "analyticsreporting", version: "v4"): PromiseLike; function load(name: "analyticsreporting", version: "v4", callback: () => any): void; - const reports: analyticsreporting.ReportsResource; - namespace analyticsreporting { + interface Activity { + /** + * Timestamp of the activity. If activities for a visit cross midnight and occur in two separate dates, then two sessions (one per date) share the session identifier. For example, say + * session ID 113472 has activity within 2019-08-20, and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID 113472 is one session, and session ID 243742 is two + * sessions. + */ + activityTime?: string; + /** Type of this activity. */ + activityType?: string; + /** This will be set if `activity_type` equals `SCREEN_VIEW`. */ + appview?: ScreenviewData; + /** + * For manual campaign tracking, it is the value of the utm_campaign campaign tracking parameter. For AdWords autotagging, it is the name(s) of the online ad campaign(s) you use for + * the property. If you use neither, its value is (not set). + */ + campaign?: string; + /** The Channel Group associated with an end user's session for this View (defined by the View's Channel Groupings). */ + channelGrouping?: string; + /** A list of all custom dimensions associated with this activity. */ + customDimension?: CustomDimension[]; + /** This will be set if `activity_type` equals `ECOMMERCE`. */ + ecommerce?: EcommerceData; + /** This field contains all the details pertaining to an event and will be set if `activity_type` equals `EVENT`. */ + event?: EventData; + /** This field contains a list of all the goals that were reached in this activity when `activity_type` equals `GOAL`. */ + goals?: GoalSetData; + /** The hostname from which the tracking request was made. */ + hostname?: string; + /** + * For manual campaign tracking, it is the value of the utm_term campaign tracking parameter. For AdWords traffic, it contains the best matching targeting criteria. For the display + * network, where multiple targeting criteria could have caused the ad to show up, it returns the best matching targeting criteria as selected by Ads. This could be display_keyword, + * site placement, boomuserlist, user_interest, age, or gender. Otherwise its value is (not set). + */ + keyword?: string; + /** The first page in users' sessions, or the landing page. */ + landingPagePath?: string; + /** + * The type of referrals. For manual campaign tracking, it is the value of the utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If users came from a search + * engine detected by Google Analytics, it is organic. If the referrer is not a search engine, it is referral. If users came directly to the property and document.referrer is empty, + * its value is (none). + */ + medium?: string; + /** This will be set if `activity_type` equals `PAGEVIEW`. This field contains all the details about the visitor and the page that was visited. */ + pageview?: PageviewData; + /** + * The source of referrals. For manual campaign tracking, it is the value of the utm_source campaign tracking parameter. For AdWords autotagging, it is google. If you use neither, it + * is the domain of the source (e.g., document.referrer) referring the users. It may also contain a port address. If users arrived without a referrer, its value is (direct). + */ + source?: string; + } interface Cohort { /** - * This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users - * whose first visit date is between start date and end date defined in the - * DateRange. The date ranges should be aligned for cohort requests. If the - * request contains `ga:cohortNthDay` it should be exactly one day long, - * if `ga:cohortNthWeek` it should be aligned to the week boundary (starting - * at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range - * should be aligned to the month (starting at the first and ending on the - * last day of the month). - * For LTV requests there are no such restrictions. - * You do not need to supply a date range for the - * `reportsRequest.dateRanges` field. + * This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users whose first visit date is between start date and end date defined in the DateRange. The date ranges should be + * aligned for cohort requests. If the request contains `ga:cohortNthDay` it should be exactly one day long, if `ga:cohortNthWeek` it should be aligned to the week boundary (starting + * at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range should be aligned to the month (starting at the first and ending on the last day of the month). For LTV + * requests there are no such restrictions. You do not need to supply a date range for the `reportsRequest.dateRanges` field. */ dateRange?: DateRange; - /** - * A unique name for the cohort. If not defined name will be auto-generated - * with values cohort_[1234...]. - */ + /** A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...]. */ name?: string; - /** - * Type of the cohort. The only supported type as of now is - * `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated - * as `FIRST_VISIT_DATE` type cohort. - */ + /** Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type cohort. */ type?: string; } interface CohortGroup { /** The definition for the cohort. */ cohorts?: Cohort[]; /** - * Enable Life Time Value (LTV). LTV measures lifetime value for users - * acquired through different channels. - * Please see: - * [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and - * [Lifetime Value](https://support.google.com/analytics/answer/6182550) - * If the value of lifetimeValue is false: - * - * - The metric values are similar to the values in the web interface cohort - * report. - * - The cohort definition date ranges must be aligned to the calendar week - * and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in - * the cohort definition should be a Sunday and the `endDate` should be the - * following Saturday, and for `ga:cohortNthMonth`, the `startDate` - * should be the 1st of the month and `endDate` should be the last day - * of the month. - * - * When the lifetimeValue is true: - * - * - The metric values will correspond to the values in the web interface - * LifeTime value report. - * - The Lifetime Value report shows you how user value (Revenue) and - * engagement (Appviews, Goal Completions, Sessions, and Session Duration) - * grow during the 90 days after a user is acquired. - * - The metrics are calculated as a cumulative average per user per the time - * increment. - * - The cohort definition date ranges need not be aligned to the calendar - * week and month boundaries. - * - The `viewId` must be an - * [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) + * Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort + * Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - + * The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while + * requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the + * `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in + * the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) + * grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not + * be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) */ lifetimeValue?: boolean; } @@ -88,6 +105,12 @@ declare namespace gapi.client { /** Metric headers for the metrics in the response. */ metricHeader?: MetricHeader; } + interface CustomDimension { + /** Slot number of custom dimension. */ + index?: number; + /** Value of the custom dimension. Default value (i.e. empty string) indicates clearing sesion/visitor scope custom dimension value. */ + value?: string; + } interface DateRange { /** The end date for the query in the format `YYYY-MM-DD`. */ endDate?: string; @@ -102,37 +125,14 @@ declare namespace gapi.client { } interface Dimension { /** - * If non-empty, we place dimension values into buckets after string to - * int64. Dimension values that are not the string representation of an - * integral value will be converted to zero. The bucket values have to be in - * increasing order. Each bucket is closed on the lower end, and open on the - * upper end. The "first" bucket includes all values less than the first - * boundary, the "last" bucket includes all values up to infinity. Dimension - * values that fall in a bucket get transformed to a new dimension value. For - * example, if one gives a list of "0, 1, 3, 4, 7", then we return the - * following buckets: - * - * - bucket #1: values < 0, dimension value "<0" - * - bucket #2: values in [0,1), dimension value "0" - * - bucket #3: values in [1,3), dimension value "1-2" - * - bucket #4: values in [3,4), dimension value "3" - * - bucket #5: values in [4,7), dimension value "4-6" - * - bucket #6: values >= 7, dimension value "7+" - * - * NOTE: If you are applying histogram mutation on any dimension, and using - * that dimension in sort, you will want to use the sort type - * `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values - * will be sorted according to dictionary - * (lexicographic) order. For example the ascending dictionary order is: - * - * "<50", "1001+", "121-1000", "50-120" - * - * And the ascending `HISTOGRAM_BUCKET` order is: - * - * "<50", "50-120", "121-1000", "1001+" - * - * The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` - * for a histogram-mutated dimension. + * If non-empty, we place dimension values into buckets after string to int64. Dimension values that are not the string representation of an integral value will be converted to zero. + * The bucket values have to be in increasing order. Each bucket is closed on the lower end, and open on the upper end. The "first" bucket includes all values less than the first + * boundary, the "last" bucket includes all values up to infinity. Dimension values that fall in a bucket get transformed to a new dimension value. For example, if one gives a list of + * "0, 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0, dimension value "<0" - bucket #2: values in [0,1), dimension value "0" - bucket #3: values in [1,3), + * dimension value "1-2" - bucket #4: values in [3,4), dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" - bucket #6: values >= 7, dimension value "7+" NOTE: If + * you are applying histogram mutation on any dimension, and using that dimension in sort, you will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without that the + * dimension values will be sorted according to dictionary (lexicographic) order. For example the ascending dictionary order is: "<50", "1001+", "121-1000", "50-120" And the ascending + * `HISTOGRAM_BUCKET` order is: "<50", "50-120", "121-1000", "1001+" The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension. */ histogramBuckets?: string[]; /** Name of the dimension to fetch, for example `ga:browser`. */ @@ -144,30 +144,19 @@ declare namespace gapi.client { /** The dimension to filter on. A DimensionFilter must contain a dimension. */ dimensionName?: string; /** - * Strings or regular expression to match against. Only the first value of - * the list is used for comparison unless the operator is `IN_LIST`. - * If `IN_LIST` operator, then the entire list is used to filter the - * dimensions as explained in the description of the `IN_LIST` operator. + * Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list + * is used to filter the dimensions as explained in the description of the `IN_LIST` operator. */ expressions?: string[]; - /** - * Logical `NOT` operator. If this boolean is set to true, then the matching - * dimension values will be excluded in the report. The default is false. - */ + /** Logical `NOT` operator. If this boolean is set to true, then the matching dimension values will be excluded in the report. The default is false. */ not?: boolean; /** How to match the dimension to the expression. The default is REGEXP. */ operator?: string; } interface DimensionFilterClause { - /** - * The repeated set of filters. They are logically combined based on the - * operator specified. - */ + /** The repeated set of filters. They are logically combined based on the operator specified. */ filters?: DimensionFilter[]; - /** - * The operator for combining multiple dimension filters. If unspecified, it - * is treated as an `OR`. - */ + /** The operator for combining multiple dimension filters. If unspecified, it is treated as an `OR`. */ operator?: string; } interface DynamicSegment { @@ -178,76 +167,103 @@ declare namespace gapi.client { /** User Segment to select users to include in the segment. */ userSegment?: SegmentDefinition; } + interface EcommerceData { + /** Action associated with this e-commerce action. */ + actionType?: string; + /** The type of this e-commerce activity. */ + ecommerceType?: string; + /** Details of the products in this transaction. */ + products?: ProductData[]; + /** Transaction details of this e-commerce action. */ + transaction?: TransactionData; + } + interface EventData { + /** Type of interaction with the object. Eg: 'play'. */ + eventAction?: string; + /** The object on the page that was interacted with. Eg: 'Video'. */ + eventCategory?: string; + /** Number of such events in this activity. */ + eventCount?: string; + /** Label attached with the event. */ + eventLabel?: string; + /** Numeric value associated with the event. */ + eventValue?: string; + } interface GetReportsRequest { /** - * Requests, each request will have a separate response. - * There can be a maximum of 5 requests. All requests should have the same - * `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`. + * Requests, each request will have a separate response. There can be a maximum of 5 requests. All requests should have the same `dateRanges`, `viewId`, `segments`, `samplingLevel`, + * and `cohortGroup`. */ reportRequests?: ReportRequest[]; + /** + * Enables [resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is set to `True` the per view + * (profile) quotas are governed by the computational cost of the request. Note that using cost based quotas will higher enable sampling rates. (10 Million for `SMALL`, 100M for + * `LARGE`. See the [limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details. + */ + useResourceQuotas?: boolean; } interface GetReportsResponse { + /** The amount of resource quota tokens deducted to execute the query. Includes all responses. */ + queryCost?: number; /** Responses corresponding to each of the request. */ reports?: Report[]; + /** The amount of resource quota remaining for the property. */ + resourceQuotasRemaining?: ResourceQuotasRemaining; + } + interface GoalData { + /** URL of the page where this goal was completed. */ + goalCompletionLocation?: string; + /** Total number of goal completions in this activity. */ + goalCompletions?: string; + /** This identifies the goal as configured for the profile. */ + goalIndex?: number; + /** Name of the goal. */ + goalName?: string; + /** URL of the page one step prior to the goal completion. */ + goalPreviousStep1?: string; + /** URL of the page two steps prior to the goal completion. */ + goalPreviousStep2?: string; + /** URL of the page three steps prior to the goal completion. */ + goalPreviousStep3?: string; + /** Value in this goal. */ + goalValue?: number; + } + interface GoalSetData { + /** All the goals that were reached in the current activity. */ + goals?: GoalData[]; } interface Metric { /** - * An alias for the metric expression is an alternate name for the - * expression. The alias can be used for filtering and sorting. This field - * is optional and is useful if the expression is not a single metric but - * a complex expression which cannot be used in filtering and sorting. - * The alias is also used in the response column header. + * An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting. This field is optional and is useful if the expression + * is not a single metric but a complex expression which cannot be used in filtering and sorting. The alias is also used in the response column header. */ alias?: string; /** - * A metric expression in the request. An expression is constructed from one - * or more metrics and numbers. Accepted operators include: Plus (+), Minus - * (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, - * Positive cardinal numbers (0-9), can include decimals and is limited to - * 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the - * metric expression is just a single metric name like `ga:users`. - * Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics - * will result in unexpected results. + * A metric expression in the request. An expression is constructed from one or more metrics and numbers. Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided + * by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases + * the metric expression is just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results. */ expression?: string; - /** - * Specifies how the metric expression should be formatted, for example - * `INTEGER`. - */ + /** Specifies how the metric expression should be formatted, for example `INTEGER`. */ formattingType?: string; } interface MetricFilter { /** The value to compare against. */ comparisonValue?: string; - /** - * The metric that will be filtered on. A metricFilter must contain a metric - * name. A metric name can be an alias earlier defined as a metric or it can - * also be a metric expression. - */ + /** The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression. */ metricName?: string; - /** - * Logical `NOT` operator. If this boolean is set to true, then the matching - * metric values will be excluded in the report. The default is false. - */ + /** Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false. */ not?: boolean; /** - * Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the - * comparisonValue, the default is `EQUAL`. If the operator is - * `IS_MISSING`, checks if the metric is missing and would ignore the - * comparisonValue. + * Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore + * the comparisonValue. */ operator?: string; } interface MetricFilterClause { - /** - * The repeated set of filters. They are logically combined based on the - * operator specified. - */ + /** The repeated set of filters. They are logically combined based on the operator specified. */ filters?: MetricFilter[]; - /** - * The operator for combining multiple metric filters. If unspecified, it is - * treated as an `OR`. - */ + /** The operator for combining multiple metric filters. If unspecified, it is treated as an `OR`. */ operator?: string; } interface MetricHeader { @@ -262,16 +278,10 @@ declare namespace gapi.client { /** The type of the metric, for example `INTEGER`. */ type?: string; } - interface OrFiltersForSegment { - /** List of segment filters to be combined with a `OR` operator. */ - segmentFilterClauses?: SegmentFilterClause[]; - } interface OrderBy { /** - * The field which to sort by. The default sort order is ascending. Example: - * `ga:browser`. - * Note, that you can only specify one field for sort here. For example, - * `ga:browser, ga:city` is not valid. + * The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` + * is not valid. */ fieldName?: string; /** The order type. The default orderType is `VALUE`. */ @@ -279,47 +289,38 @@ declare namespace gapi.client { /** The sorting order for the field. */ sortOrder?: string; } + interface OrFiltersForSegment { + /** List of segment filters to be combined with a `OR` operator. */ + segmentFilterClauses?: SegmentFilterClause[]; + } + interface PageviewData { + /** The URL of the page that the visitor viewed. */ + pagePath?: string; + /** The title of the page that the visitor viewed. */ + pageTitle?: string; + } interface Pivot { /** - * DimensionFilterClauses are logically combined with an `AND` operator: only - * data that is included by all these DimensionFilterClauses contributes to - * the values in this pivot region. Dimension filters can be used to restrict - * the columns shown in the pivot region. For example if you have - * `ga:browser` as the requested dimension in the pivot region, and you - * specify key filters to restrict `ga:browser` to only "IE" or "Firefox", - * then only those two browsers would show up as columns. + * DimensionFilterClauses are logically combined with an `AND` operator: only data that is included by all these DimensionFilterClauses contributes to the values in this pivot region. + * Dimension filters can be used to restrict the columns shown in the pivot region. For example if you have `ga:browser` as the requested dimension in the pivot region, and you specify + * key filters to restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers would show up as columns. */ dimensionFilterClauses?: DimensionFilterClause[]; /** - * A list of dimensions to show as pivot columns. A Pivot can have a maximum - * of 4 dimensions. Pivot dimensions are part of the restriction on the - * total number of dimensions allowed in the request. + * A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 dimensions. Pivot dimensions are part of the restriction on the total number of dimensions allowed in + * the request. */ dimensions?: Dimension[]; - /** - * Specifies the maximum number of groups to return. - * The default value is 10, also the maximum value is 1,000. - */ + /** Specifies the maximum number of groups to return. The default value is 10, also the maximum value is 1,000. */ maxGroupCount?: number; - /** - * The pivot metrics. Pivot metrics are part of the - * restriction on total number of metrics allowed in the request. - */ + /** The pivot metrics. Pivot metrics are part of the restriction on total number of metrics allowed in the request. */ metrics?: Metric[]; /** - * If k metrics were requested, then the response will contain some - * data-dependent multiple of k columns in the report. E.g., if you pivoted - * on the dimension `ga:browser` then you'd get k columns for "Firefox", k - * columns for "IE", k columns for "Chrome", etc. The ordering of the groups - * of columns is determined by descending order of "total" for the first of - * the k values. Ties are broken by lexicographic ordering of the first - * pivot dimension, then lexicographic ordering of the second pivot - * dimension, and so on. E.g., if the totals for the first value for - * Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns - * would be Chrome, Firefox, IE. - * - * The following let you choose which of the groups of k columns are - * included in the response. + * If k metrics were requested, then the response will contain some data-dependent multiple of k columns in the report. E.g., if you pivoted on the dimension `ga:browser` then you'd + * get k columns for "Firefox", k columns for "IE", k columns for "Chrome", etc. The ordering of the groups of columns is determined by descending order of "total" for the first of the + * k values. Ties are broken by lexicographic ordering of the first pivot dimension, then lexicographic ordering of the second pivot dimension, and so on. E.g., if the totals for the + * first value for Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns would be Chrome, Firefox, IE. The following let you choose which of the groups of k columns + * are included in the response. */ startGroup?: number; } @@ -341,6 +342,16 @@ declare namespace gapi.client { /** The values of the metrics in each of the pivot regions. */ values?: string[]; } + interface ProductData { + /** The total revenue from purchased product items. */ + itemRevenue?: number; + /** The product name, supplied by the e-commerce tracking application, for the purchased items. */ + productName?: string; + /** Total number of this product units in the transaction. */ + productQuantity?: string; + /** Unique code that represents the product. */ + productSku?: string; + } interface Report { /** The column headers. */ columnHeader?: ColumnHeader; @@ -350,186 +361,104 @@ declare namespace gapi.client { nextPageToken?: string; } interface ReportData { - /** - * The last time the data in the report was refreshed. All the hits received - * before this timestamp are included in the calculation of the report. - */ + /** The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report. */ dataLastRefreshed?: string; - /** - * Indicates if response to this request is golden or not. Data is - * golden when the exact same request will not produce any new results if - * asked at a later point in time. - */ + /** Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time. */ isDataGolden?: boolean; - /** - * Minimum and maximum values seen over all matching rows. These are both - * empty when `hideValueRanges` in the request is false, or when - * rowCount is zero. - */ + /** Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero. */ maximums?: DateRangeValues[]; - /** - * Minimum and maximum values seen over all matching rows. These are both - * empty when `hideValueRanges` in the request is false, or when - * rowCount is zero. - */ + /** Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero. */ minimums?: DateRangeValues[]; /** Total number of matching rows for this query. */ rowCount?: number; /** There's one ReportRow for every unique combination of dimensions. */ rows?: ReportRow[]; /** - * If the results are - * [sampled](https://support.google.com/analytics/answer/2637192), - * this returns the total number of samples read, one entry per date range. - * If the results are not sampled this field will not be defined. See - * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - * for details. + * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range. If the results are not + * sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ samplesReadCounts?: string[]; /** - * If the results are - * [sampled](https://support.google.com/analytics/answer/2637192), - * this returns the total number of - * samples present, one entry per date range. If the results are not sampled - * this field will not be defined. See - * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - * for details. + * If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range. If the results are not + * sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ samplingSpaceSizes?: string[]; /** - * For each requested date range, for the set of all rows that match - * the query, every requested value format gets a total. The total - * for a value format is computed by first totaling the metrics - * mentioned in the value format and then evaluating the value - * format as a scalar expression. E.g., The "totals" for - * `3 / (ga:sessions + 2)` we compute - * `3 / ((sum of all relevant ga:sessions) + 2)`. - * Totals are computed before pagination. + * For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling + * the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all + * relevant ga:sessions) + 2)`. Totals are computed before pagination. */ totals?: DateRangeValues[]; } interface ReportRequest { /** - * Cohort group associated with this request. If there is a cohort group - * in the request the `ga:cohort` dimension must be present. - * Every [ReportRequest](#ReportRequest) within a `batchGet` method must - * contain the same `cohortGroup` definition. + * Cohort group associated with this request. If there is a cohort group in the request the `ga:cohort` dimension must be present. Every [ReportRequest](#ReportRequest) within a + * `batchGet` method must contain the same `cohortGroup` definition. */ cohortGroup?: CohortGroup; /** - * Date ranges in the request. The request can have a maximum of 2 date - * ranges. The response will contain a set of metric values for each - * combination of the dimensions for each date range in the request. So, if - * there are two date ranges, there will be two set of metric values, one for - * the original date range and one for the second date range. - * The `reportRequest.dateRanges` field should not be specified for cohorts - * or Lifetime value requests. - * If a date range is not provided, the default date range is (startDate: - * current date - 7 days, endDate: current date - 1 day). Every - * [ReportRequest](#ReportRequest) within a `batchGet` method must - * contain the same `dateRanges` definition. + * Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date + * range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The + * `reportRequest.dateRanges` field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date + * - 7 days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `dateRanges` definition. */ dateRanges?: DateRange[]; /** - * The dimension filter clauses for filtering Dimension Values. They are - * logically combined with the `AND` operator. Note that filtering occurs - * before any dimensions are aggregated, so that the returned metrics - * represent the total for only the relevant dimensions. + * The dimension filter clauses for filtering Dimension Values. They are logically combined with the `AND` operator. Note that filtering occurs before any dimensions are aggregated, so + * that the returned metrics represent the total for only the relevant dimensions. */ dimensionFilterClauses?: DimensionFilterClause[]; - /** - * The dimensions requested. - * Requests can have a total of 7 dimensions. - */ + /** The dimensions requested. Requests can have a total of 9 dimensions. */ dimensions?: Dimension[]; /** - * Dimension or metric filters that restrict the data returned for your - * request. To use the `filtersExpression`, supply a dimension or metric on - * which to filter, followed by the filter expression. For example, the - * following expression selects `ga:browser` dimension which starts with - * Firefox; `ga:browser=~^Firefox`. For more information on dimensions - * and metric filters, see - * [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters). + * Dimension or metric filters that restrict the data returned for your request. To use the `filtersExpression`, supply a dimension or metric on which to filter, followed by the filter + * expression. For example, the following expression selects `ga:browser` dimension which starts with Firefox; `ga:browser=~^Firefox`. For more information on dimensions and metric + * filters, see [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters). */ filtersExpression?: string; - /** - * If set to true, hides the total of all metrics for all the matching rows, - * for every date range. The default false and will return the totals. - */ + /** If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals. */ hideTotals?: boolean; - /** - * If set to true, hides the minimum and maximum across all matching rows. - * The default is false and the value ranges are returned. - */ + /** If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned. */ hideValueRanges?: boolean; - /** - * If set to false, the response does not include rows if all the retrieved - * metrics are equal to zero. The default is false which will exclude these - * rows. - */ + /** If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows. */ includeEmptyRows?: boolean; /** - * The metric filter clauses. They are logically combined with the `AND` - * operator. Metric filters look at only the first date range and not the - * comparing date range. Note that filtering on metrics occurs after the - * metrics are aggregated. + * The metric filter clauses. They are logically combined with the `AND` operator. Metric filters look at only the first date range and not the comparing date range. Note that + * filtering on metrics occurs after the metrics are aggregated. */ metricFilterClauses?: MetricFilterClause[]; - /** - * The metrics requested. - * Requests must specify at least one metric. Requests can have a - * total of 10 metrics. - */ + /** The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics. */ metrics?: Metric[]; - /** - * Sort order on output rows. To compare two rows, the elements of the - * following are applied in order until a difference is found. All date - * ranges in the output get the same row order. - */ + /** Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order. */ orderBys?: OrderBy[]; /** - * Page size is for paging and specifies the maximum number of returned rows. - * Page size should be >= 0. A query returns the default of 1,000 rows. - * The Analytics Core Reporting API returns a maximum of 10,000 rows per - * request, no matter how many you ask for. It can also return fewer rows - * than requested, if there aren't as many dimension segments as you expect. - * For instance, there are fewer than 300 possible values for `ga:country`, - * so when segmenting only by country, you can't get more than 300 rows, - * even if you set `pageSize` to a higher value. + * Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API + * returns a maximum of 100,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you + * expect. For instance, there are fewer than 300 possible values for `ga:country`, so when segmenting only by country, you can't get more than 300 rows, even if you set `pageSize` to + * a higher value. */ pageSize?: number; /** - * A continuation token to get the next page of the results. Adding this to - * the request will return the rows after the pageToken. The pageToken should - * be the value returned in the nextPageToken parameter in the response to - * the GetReports request. + * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the + * nextPageToken parameter in the response to the GetReports request. */ pageToken?: string; /** The pivot definitions. Requests can have a maximum of 2 pivots. */ pivots?: Pivot[]; /** - * The desired report - * [sample](https://support.google.com/analytics/answer/2637192) size. - * If the the `samplingLevel` field is unspecified the `DEFAULT` sampling - * level is used. Every [ReportRequest](#ReportRequest) within a - * `batchGet` method must contain the same `samplingLevel` definition. See - * [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - * for details. + * The desired report [sample](https://support.google.com/analytics/answer/2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` sampling level is used. Every + * [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `samplingLevel` definition. See [developer + * guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. */ samplingLevel?: string; /** - * Segment the data returned for the request. A segment definition helps look - * at a subset of the segment request. A request can contain up to four - * segments. Every [ReportRequest](#ReportRequest) within a - * `batchGet` method must contain the same `segments` definition. Requests - * with segments must have the `ga:segment` dimension. + * Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every + * [ReportRequest](#ReportRequest) within a `batchGet` method must contain the same `segments` definition. Requests with segments must have the `ga:segment` dimension. */ segments?: Segment[]; /** - * The Analytics - * [view ID](https://support.google.com/analytics/answer/1009618) - * from which to retrieve data. Every [ReportRequest](#ReportRequest) - * within a `batchGet` method must contain the same `viewId`. + * The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [ReportRequest](#ReportRequest) within a `batchGet` method must + * contain the same `viewId`. */ viewId?: string; } @@ -539,6 +468,58 @@ declare namespace gapi.client { /** List of metrics for each requested DateRange. */ metrics?: DateRangeValues[]; } + interface ResourceQuotasRemaining { + /** Daily resource quota remaining remaining. */ + dailyQuotaTokensRemaining?: number; + /** Hourly resource quota tokens remaining. */ + hourlyQuotaTokensRemaining?: number; + } + interface ScreenviewData { + /** The application name. */ + appName?: string; + /** Mobile manufacturer or branded name. Eg: "Google", "Apple" etc. */ + mobileDeviceBranding?: string; + /** Mobile device model. Eg: "Pixel", "iPhone" etc. */ + mobileDeviceModel?: string; + /** The name of the screen. */ + screenName?: string; + } + interface SearchUserActivityRequest { + /** Set of all activity types being requested. Only acvities matching these types will be returned in the response. If empty, all activies will be returned. */ + activityTypes?: string[]; + /** Date range for which to retrieve the user activity. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). */ + dateRange?: DateRange; + /** + * Page size is for paging and specifies the maximum number of returned rows. Page size should be > 0. If the value is 0 or if the field isn't specified, the request returns the + * default of 1000 rows per page. + */ + pageSize?: number; + /** + * A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the + * nextPageToken parameter in the response to the [SearchUserActivityRequest](#SearchUserActivityRequest) request. + */ + pageToken?: string; + /** Required. Unique user Id to query for. Every [SearchUserActivityRequest](#SearchUserActivityRequest) must contain this field. */ + user?: User; + /** + * Required. The Analytics [view ID](https://support.google.com/analytics/answer/1009618) from which to retrieve data. Every [SearchUserActivityRequest](#SearchUserActivityRequest) + * must contain the `viewId`. + */ + viewId?: string; + } + interface SearchUserActivityResponse { + /** This token should be passed to [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the next page. */ + nextPageToken?: string; + /** + * This field represents the [sampling rate](https://support.google.com/analytics/answer/2637192) for the given request and is a number between 0.0 to 1.0. See [developer + * guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details. + */ + sampleRate?: number; + /** Each record represents a session (device details, duration, etc). */ + sessions?: UserActivitySession[]; + /** Total rows returned by this query (across different pages). */ + totalRows?: number; + } interface Segment { /** A dynamic segment definition in the request. */ dynamicSegment?: DynamicSegment; @@ -546,10 +527,7 @@ declare namespace gapi.client { segmentId?: string; } interface SegmentDefinition { - /** - * A segment is defined by a set of segment filters which are combined - * together with a logical `AND` operation. - */ + /** A segment is defined by a set of segment filters which are combined together with a logical `AND` operation. */ segmentFilters?: SegmentFilter[]; } interface SegmentDimensionFilter { @@ -568,37 +546,17 @@ declare namespace gapi.client { } interface SegmentFilter { /** - * If true, match the complement of simple or sequence segment. - * For example, to match all visits not from "New York", we can define the - * segment as follows: - * - * "sessionSegment": { - * "segmentFilters": [{ - * "simpleSegment" :{ - * "orFiltersForSegment": [{ - * "segmentFilterClauses":[{ - * "dimensionFilter": { - * "dimensionName": "ga:city", - * "expressions": ["New York"] - * } - * }] - * }] - * }, - * "not": "True" - * }] - * }, + * If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { + * "segmentFilters": [{ "simpleSegment" :{ "orFiltersForSegment": [{ "segmentFilterClauses":[{ "dimensionFilter": { "dimensionName": "ga:city", "expressions": ["New York"] } }] }] }, + * "not": "True" }] }, */ not?: boolean; /** - * Sequence conditions consist of one or more steps, where each step is - * defined by one or more dimension/metric conditions. Multiple steps can - * be combined with special sequence operators. + * Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence + * operators. */ sequenceSegment?: SequenceSegment; - /** - * A Simple segment conditions consist of one or more dimension/metric - * conditions that can be combined - */ + /** A Simple segment conditions consist of one or more dimension/metric conditions that can be combined */ simpleSegment?: SimpleSegment; } interface SegmentFilterClause { @@ -610,59 +568,69 @@ declare namespace gapi.client { not?: boolean; } interface SegmentMetricFilter { - /** - * The value to compare against. If the operator is `BETWEEN`, this value is - * treated as minimum comparison value. - */ + /** The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value. */ comparisonValue?: string; /** Max comparison value is only used for `BETWEEN` operator. */ maxComparisonValue?: string; - /** - * The metric that will be filtered on. A `metricFilter` must contain a - * metric name. - */ + /** The metric that will be filtered on. A `metricFilter` must contain a metric name. */ metricName?: string; - /** - * Specifies is the operation to perform to compare the metric. The default - * is `EQUAL`. - */ + /** Specifies is the operation to perform to compare the metric. The default is `EQUAL`. */ operator?: string; /** - * Scope for a metric defines the level at which that metric is defined. The - * specified metric scope must be equal to or greater than its primary scope - * as defined in the data model. The primary scope is defined by if the - * segment is selecting users or sessions. + * Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The + * primary scope is defined by if the segment is selecting users or sessions. */ scope?: string; } interface SegmentSequenceStep { - /** - * Specifies if the step immediately precedes or can be any time before the - * next step. - */ + /** Specifies if the step immediately precedes or can be any time before the next step. */ matchType?: string; - /** - * A sequence is specified with a list of Or grouped filters which are - * combined with `AND` operator. - */ + /** A sequence is specified with a list of Or grouped filters which are combined with `AND` operator. */ orFiltersForSegment?: OrFiltersForSegment[]; } interface SequenceSegment { - /** - * If set, first step condition must match the first hit of the visitor (in - * the date range). - */ + /** If set, first step condition must match the first hit of the visitor (in the date range). */ firstStepShouldMatchFirstHit?: boolean; /** The list of steps in the sequence. */ segmentSequenceSteps?: SegmentSequenceStep[]; } interface SimpleSegment { - /** - * A list of segment filters groups which are combined with logical `AND` - * operator. - */ + /** A list of segment filters groups which are combined with logical `AND` operator. */ orFiltersForSegment?: OrFiltersForSegment[]; } + interface TransactionData { + /** The transaction ID, supplied by the e-commerce tracking method, for the purchase in the shopping cart. */ + transactionId?: string; + /** The total sale revenue (excluding shipping and tax) of the transaction. */ + transactionRevenue?: number; + /** Total cost of shipping. */ + transactionShipping?: number; + /** Total tax for the transaction. */ + transactionTax?: number; + } + interface User { + /** Type of the user in the request. The field `userId` is associated with this type. */ + type?: string; + /** Unique Id of the user for which the data is being requested. */ + userId?: string; + } + interface UserActivitySession { + /** Represents a detailed view into each of the activity in this session. */ + activities?: Activity[]; + /** + * The data source of a hit. By default, hits sent from analytics.js are reported as "web" and hits sent from the mobile SDKs are reported as "app". These values can be overridden in + * the Measurement Protocol. + */ + dataSource?: string; + /** The type of device used: "mobile", "tablet" etc. */ + deviceCategory?: string; + /** Platform on which the activity happened: "android", "ios" etc. */ + platform?: string; + /** Date of this session in ISO-8601 format. */ + sessionDate?: string; + /** Unique ID of the session. */ + sessionId?: string; + } interface ReportsResource { /** Returns the Analytics data. */ batchGet(request: { @@ -672,8 +640,6 @@ declare namespace gapi.client { access_token?: string; /** Data format for response. */ alt?: string; - /** OAuth bearer token. */ - bearer_token?: string; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ @@ -682,17 +648,100 @@ declare namespace gapi.client { key?: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; - /** Pretty-print response. */ - pp?: boolean; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; - /** Legacy upload protocol for media (e.g. "media", "multipart"). */ - uploadType?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; + /** Legacy upload protocol for media (e.g. "media", "multipart"). */ + uploadType?: string; + /** Request body */ + resource: GetReportsRequest; }): Request; + batchGet(request: { + /** V1 error format. */ + "$.xgafv"?: string; + /** OAuth access token. */ + access_token?: string; + /** Data format for response. */ + alt?: string; + /** JSONP */ + callback?: string; + /** Selector specifying which fields to include in a partial response. */ + fields?: string; + /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ + key?: string; + /** OAuth 2.0 token for the current user. */ + oauth_token?: string; + /** Returns response with indentations and line breaks. */ + prettyPrint?: boolean; + /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ + quotaUser?: string; + /** Upload protocol for media (e.g. "raw", "multipart"). */ + upload_protocol?: string; + /** Legacy upload protocol for media (e.g. "media", "multipart"). */ + uploadType?: string; + }, + body: GetReportsRequest): Request; } + interface UserActivityResource { + /** Returns User Activity data. */ + search(request: { + /** V1 error format. */ + "$.xgafv"?: string; + /** OAuth access token. */ + access_token?: string; + /** Data format for response. */ + alt?: string; + /** JSONP */ + callback?: string; + /** Selector specifying which fields to include in a partial response. */ + fields?: string; + /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ + key?: string; + /** OAuth 2.0 token for the current user. */ + oauth_token?: string; + /** Returns response with indentations and line breaks. */ + prettyPrint?: boolean; + /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ + quotaUser?: string; + /** Upload protocol for media (e.g. "raw", "multipart"). */ + upload_protocol?: string; + /** Legacy upload protocol for media (e.g. "media", "multipart"). */ + uploadType?: string; + /** Request body */ + resource: SearchUserActivityRequest; + }): Request; + search(request: { + /** V1 error format. */ + "$.xgafv"?: string; + /** OAuth access token. */ + access_token?: string; + /** Data format for response. */ + alt?: string; + /** JSONP */ + callback?: string; + /** Selector specifying which fields to include in a partial response. */ + fields?: string; + /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ + key?: string; + /** OAuth 2.0 token for the current user. */ + oauth_token?: string; + /** Returns response with indentations and line breaks. */ + prettyPrint?: boolean; + /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ + quotaUser?: string; + /** Upload protocol for media (e.g. "raw", "multipart"). */ + upload_protocol?: string; + /** Legacy upload protocol for media (e.g. "media", "multipart"). */ + uploadType?: string; + }, + body: SearchUserActivityRequest): Request; + } + + const reports: ReportsResource; + + const userActivity: UserActivityResource; } } diff --git a/types/gapi.client.analyticsreporting/readme.md b/types/gapi.client.analyticsreporting/readme.md index 96b09af1b4..f3b920bb93 100644 --- a/types/gapi.client.analyticsreporting/readme.md +++ b/types/gapi.client.analyticsreporting/readme.md @@ -1,10 +1,12 @@ -# TypeScript typings for Google Analytics Reporting API v4 +# TypeScript typings for Analytics Reporting API v4 + Accesses Analytics report data. For detailed description please check [documentation](https://developers.google.com/analytics/devguides/reporting/core/v4/). ## Installing -Install typings for Google Analytics Reporting API: +Install typings for Analytics Reporting API: + ``` npm install @types/gapi.client.analyticsreporting@v4 --save-dev ``` @@ -12,51 +14,60 @@ npm install @types/gapi.client.analyticsreporting@v4 --save-dev ## Usage You need to initialize Google API client in your code: + ```typescript -gapi.load("client", () => { - // now we can use gapi.client - // ... +gapi.load('client', () => { + // now we can use gapi.client + // ... }); ``` Then load api client wrapper: + ```typescript gapi.client.load('analyticsreporting', 'v4', () => { - // now we can use gapi.client.analyticsreporting - // ... + // now we can use gapi.client.analyticsreporting + // ... }); ``` Don't forget to authenticate your client before sending any request to resources: -```typescript +```typescript // declare client_id registered in Google Developers Console var client_id = '', - scope = [ - // View and manage your Google Analytics data - 'https://www.googleapis.com/auth/analytics', - - // View your Google Analytics data - 'https://www.googleapis.com/auth/analytics.readonly', + scope = [ + // View and manage your Google Analytics data + 'https://www.googleapis.com/auth/analytics', + + // View your Google Analytics data + 'https://www.googleapis.com/auth/analytics.readonly', ], immediate = true; // ... -gapi.auth.authorize({ client_id: client_id, scope: scope, immediate: immediate }, authResult => { +gapi.auth.authorize( + { client_id: client_id, scope: scope, immediate: immediate }, + authResult => { if (authResult && !authResult.error) { - /* handle succesfull authorization */ + /* handle successful authorization */ } else { /* handle authorization error */ } -}); +}); ``` -After that you can use Google Analytics Reporting API resources: +After that you can use Analytics Reporting API resources: -```typescript - -/* -Returns the Analytics data. +```typescript + +/* +Returns the Analytics data. */ -await gapi.client.reports.batchGet({ }); -``` \ No newline at end of file +await gapi.client.analyticsreporting.reports.batchGet({ }); + +/* +Returns User Activity data. +*/ +await gapi.client.analyticsreporting.userActivity.search({ }); +``` diff --git a/types/gapi.client.analyticsreporting/tsconfig.json b/types/gapi.client.analyticsreporting/tsconfig.json index ceb938b191..a8d9a7ac7f 100644 --- a/types/gapi.client.analyticsreporting/tsconfig.json +++ b/types/gapi.client.analyticsreporting/tsconfig.json @@ -1,10 +1,7 @@ { "compilerOptions": { "module": "commonjs", - "lib": [ - "es6", - "dom" - ], + "lib": ["es6", "dom"], "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": true, @@ -17,8 +14,5 @@ "forceConsistentCasingInFileNames": true, "strictFunctionTypes": true }, - "files": [ - "index.d.ts", - "gapi.client.analyticsreporting-tests.ts" - ] + "files": ["index.d.ts", "gapi.client.analyticsreporting-tests.ts"] } diff --git a/types/gapi.client.analyticsreporting/tslint.json b/types/gapi.client.analyticsreporting/tslint.json index 485f63dae0..f93cf8562a 100644 --- a/types/gapi.client.analyticsreporting/tslint.json +++ b/types/gapi.client.analyticsreporting/tslint.json @@ -1,6 +1,3 @@ { - "extends": "dtslint/dt.json", - "rules": { - "await-promise": false - } + "extends": "dtslint/dt.json" }