@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20230404 → 0.0.20230405

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +275 -1
  2. package/package.json +1 -1
  3. package/tests.ts +86 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://analyticsadmin.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20230404
12
+ // Revision: 20230405
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -516,6 +516,8 @@ declare namespace gapi.client {
516
516
  attributionSettings?: GoogleAnalyticsAdminV1alphaAttributionSettings;
517
517
  /** A snapshot of a BigQuery link resource in change history. */
518
518
  bigqueryLink?: GoogleAnalyticsAdminV1alphaBigQueryLink;
519
+ /** A snapshot of a ChannelGroup resource in change history. */
520
+ channelGroup?: GoogleAnalyticsAdminV1alphaChannelGroup;
519
521
  /** A snapshot of a ConversionEvent resource in change history. */
520
522
  conversionEvent?: GoogleAnalyticsAdminV1alphaConversionEvent;
521
523
  /** A snapshot of a CustomDimension resource in change history. */
@@ -564,6 +566,53 @@ declare namespace gapi.client {
564
566
  */
565
567
  userActorEmail?: string;
566
568
  }
569
+ interface GoogleAnalyticsAdminV1alphaChannelGroup {
570
+ /** The description of the Channel Group. Max length of 256 characters. */
571
+ description?: string;
572
+ /** Required. The display name of the Channel Group. Max length of 80 characters. */
573
+ displayName?: string;
574
+ /** Required. The grouping rules of channels. Maximum number of rules is 25. */
575
+ groupingRule?: GoogleAnalyticsAdminV1alphaGroupingRule[];
576
+ /** Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group} */
577
+ name?: string;
578
+ /** Output only. Default Channel Group defined by Google, which cannot be updated. */
579
+ systemDefined?: boolean;
580
+ }
581
+ interface GoogleAnalyticsAdminV1alphaChannelGroupFilter {
582
+ /** Required. Immutable. The dimension name to filter. */
583
+ fieldName?: string;
584
+ /** A filter for a string dimension that matches a particular list of options. */
585
+ inListFilter?: GoogleAnalyticsAdminV1alphaChannelGroupFilterInListFilter;
586
+ /** A filter for a string-type dimension that matches a particular pattern. */
587
+ stringFilter?: GoogleAnalyticsAdminV1alphaChannelGroupFilterStringFilter;
588
+ }
589
+ interface GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression {
590
+ /** A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression. */
591
+ andGroup?: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList;
592
+ /** A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression. */
593
+ filter?: GoogleAnalyticsAdminV1alphaChannelGroupFilter;
594
+ /**
595
+ * A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level
596
+ * ChannelGroupFilterExpression.
597
+ */
598
+ notExpression?: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression;
599
+ /** A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group. */
600
+ orGroup?: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList;
601
+ }
602
+ interface GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList {
603
+ /** A list of Channel Group filter expressions. */
604
+ filterExpressions?: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression[];
605
+ }
606
+ interface GoogleAnalyticsAdminV1alphaChannelGroupFilterInListFilter {
607
+ /** Required. The list of possible string values to match against. Must be non-empty. */
608
+ values?: string[];
609
+ }
610
+ interface GoogleAnalyticsAdminV1alphaChannelGroupFilterStringFilter {
611
+ /** Required. The match type for the string filter. */
612
+ matchType?: string;
613
+ /** Required. The string value to be matched against. */
614
+ value?: string;
615
+ }
567
616
  interface GoogleAnalyticsAdminV1alphaConnectedSiteTag {
568
617
  /** Required. User-provided display name for the connected site tag. Must be less than 256 characters. */
569
618
  displayName?: string;
@@ -936,6 +985,12 @@ declare namespace gapi.client {
936
985
  /** Status of this setting. */
937
986
  state?: string;
938
987
  }
988
+ interface GoogleAnalyticsAdminV1alphaGroupingRule {
989
+ /** Required. Customer defined display name for the channel. */
990
+ displayName?: string;
991
+ /** Required. The Filter Expression that defines the Grouping Rule. */
992
+ expression?: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression;
993
+ }
939
994
  interface GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails {
940
995
  /** Output only. The source of this proposal. */
941
996
  linkProposalInitiatingProduct?: string;
@@ -974,6 +1029,12 @@ declare namespace gapi.client {
974
1029
  /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
975
1030
  nextPageToken?: string;
976
1031
  }
1032
+ interface GoogleAnalyticsAdminV1alphaListChannelGroupsResponse {
1033
+ /** List of ChannelGroup. These will be ordered stably, but in an arbitrary order. */
1034
+ channelGroups?: GoogleAnalyticsAdminV1alphaChannelGroup[];
1035
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1036
+ nextPageToken?: string;
1037
+ }
977
1038
  interface GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest {
978
1039
  /**
979
1040
  * The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. A maximum of 20 connected site tags will be returned. Example Format:
@@ -3375,6 +3436,218 @@ declare namespace gapi.client {
3375
3436
  uploadType?: string;
3376
3437
  }): Request<GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse>;
3377
3438
  }
3439
+ interface ChannelGroupsResource {
3440
+ /** Creates a ChannelGroup. */
3441
+ create(request: {
3442
+ /** V1 error format. */
3443
+ "$.xgafv"?: string;
3444
+ /** OAuth access token. */
3445
+ access_token?: string;
3446
+ /** Data format for response. */
3447
+ alt?: string;
3448
+ /** JSONP */
3449
+ callback?: string;
3450
+ /** Selector specifying which fields to include in a partial response. */
3451
+ fields?: string;
3452
+ /** 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. */
3453
+ key?: string;
3454
+ /** OAuth 2.0 token for the current user. */
3455
+ oauth_token?: string;
3456
+ /** Required. The property for which to create a ChannelGroup. Example format: properties/1234 */
3457
+ parent: string;
3458
+ /** Returns response with indentations and line breaks. */
3459
+ prettyPrint?: boolean;
3460
+ /** 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. */
3461
+ quotaUser?: string;
3462
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3463
+ upload_protocol?: string;
3464
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3465
+ uploadType?: string;
3466
+ /** Request body */
3467
+ resource: GoogleAnalyticsAdminV1alphaChannelGroup;
3468
+ }): Request<GoogleAnalyticsAdminV1alphaChannelGroup>;
3469
+ create(request: {
3470
+ /** V1 error format. */
3471
+ "$.xgafv"?: string;
3472
+ /** OAuth access token. */
3473
+ access_token?: string;
3474
+ /** Data format for response. */
3475
+ alt?: string;
3476
+ /** JSONP */
3477
+ callback?: string;
3478
+ /** Selector specifying which fields to include in a partial response. */
3479
+ fields?: string;
3480
+ /** 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. */
3481
+ key?: string;
3482
+ /** OAuth 2.0 token for the current user. */
3483
+ oauth_token?: string;
3484
+ /** Required. The property for which to create a ChannelGroup. Example format: properties/1234 */
3485
+ parent: string;
3486
+ /** Returns response with indentations and line breaks. */
3487
+ prettyPrint?: boolean;
3488
+ /** 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. */
3489
+ quotaUser?: string;
3490
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3491
+ upload_protocol?: string;
3492
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3493
+ uploadType?: string;
3494
+ },
3495
+ body: GoogleAnalyticsAdminV1alphaChannelGroup): Request<GoogleAnalyticsAdminV1alphaChannelGroup>;
3496
+ /** Deletes a ChannelGroup on a property. */
3497
+ delete(request?: {
3498
+ /** V1 error format. */
3499
+ "$.xgafv"?: string;
3500
+ /** OAuth access token. */
3501
+ access_token?: string;
3502
+ /** Data format for response. */
3503
+ alt?: string;
3504
+ /** JSONP */
3505
+ callback?: string;
3506
+ /** Selector specifying which fields to include in a partial response. */
3507
+ fields?: string;
3508
+ /** 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. */
3509
+ key?: string;
3510
+ /** Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678 */
3511
+ name: string;
3512
+ /** OAuth 2.0 token for the current user. */
3513
+ oauth_token?: string;
3514
+ /** Returns response with indentations and line breaks. */
3515
+ prettyPrint?: boolean;
3516
+ /** 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. */
3517
+ quotaUser?: string;
3518
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3519
+ upload_protocol?: string;
3520
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3521
+ uploadType?: string;
3522
+ }): Request<{}>;
3523
+ /** Lookup for a single ChannelGroup. */
3524
+ get(request?: {
3525
+ /** V1 error format. */
3526
+ "$.xgafv"?: string;
3527
+ /** OAuth access token. */
3528
+ access_token?: string;
3529
+ /** Data format for response. */
3530
+ alt?: string;
3531
+ /** JSONP */
3532
+ callback?: string;
3533
+ /** Selector specifying which fields to include in a partial response. */
3534
+ fields?: string;
3535
+ /** 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. */
3536
+ key?: string;
3537
+ /** Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678 */
3538
+ name: string;
3539
+ /** OAuth 2.0 token for the current user. */
3540
+ oauth_token?: string;
3541
+ /** Returns response with indentations and line breaks. */
3542
+ prettyPrint?: boolean;
3543
+ /** 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. */
3544
+ quotaUser?: string;
3545
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3546
+ upload_protocol?: string;
3547
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3548
+ uploadType?: string;
3549
+ }): Request<GoogleAnalyticsAdminV1alphaChannelGroup>;
3550
+ /** Lists ChannelGroups on a property. */
3551
+ list(request?: {
3552
+ /** V1 error format. */
3553
+ "$.xgafv"?: string;
3554
+ /** OAuth access token. */
3555
+ access_token?: string;
3556
+ /** Data format for response. */
3557
+ alt?: string;
3558
+ /** JSONP */
3559
+ callback?: string;
3560
+ /** Selector specifying which fields to include in a partial response. */
3561
+ fields?: string;
3562
+ /** 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. */
3563
+ key?: string;
3564
+ /** OAuth 2.0 token for the current user. */
3565
+ oauth_token?: string;
3566
+ /** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
3567
+ pageSize?: number;
3568
+ /**
3569
+ * A page token, received from a previous `ListChannelGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
3570
+ * `ListChannelGroups` must match the call that provided the page token.
3571
+ */
3572
+ pageToken?: string;
3573
+ /** Required. The property for which to list ChannelGroups. Example format: properties/1234 */
3574
+ parent: string;
3575
+ /** Returns response with indentations and line breaks. */
3576
+ prettyPrint?: boolean;
3577
+ /** 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. */
3578
+ quotaUser?: string;
3579
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3580
+ upload_protocol?: string;
3581
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3582
+ uploadType?: string;
3583
+ }): Request<GoogleAnalyticsAdminV1alphaListChannelGroupsResponse>;
3584
+ /** Updates a ChannelGroup. */
3585
+ patch(request: {
3586
+ /** V1 error format. */
3587
+ "$.xgafv"?: string;
3588
+ /** OAuth access token. */
3589
+ access_token?: string;
3590
+ /** Data format for response. */
3591
+ alt?: string;
3592
+ /** JSONP */
3593
+ callback?: string;
3594
+ /** Selector specifying which fields to include in a partial response. */
3595
+ fields?: string;
3596
+ /** 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. */
3597
+ key?: string;
3598
+ /** Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group} */
3599
+ name: string;
3600
+ /** OAuth 2.0 token for the current user. */
3601
+ oauth_token?: string;
3602
+ /** Returns response with indentations and line breaks. */
3603
+ prettyPrint?: boolean;
3604
+ /** 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. */
3605
+ quotaUser?: string;
3606
+ /**
3607
+ * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use
3608
+ * one path with the string "*" to match all fields.
3609
+ */
3610
+ updateMask?: string;
3611
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3612
+ upload_protocol?: string;
3613
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3614
+ uploadType?: string;
3615
+ /** Request body */
3616
+ resource: GoogleAnalyticsAdminV1alphaChannelGroup;
3617
+ }): Request<GoogleAnalyticsAdminV1alphaChannelGroup>;
3618
+ patch(request: {
3619
+ /** V1 error format. */
3620
+ "$.xgafv"?: string;
3621
+ /** OAuth access token. */
3622
+ access_token?: string;
3623
+ /** Data format for response. */
3624
+ alt?: string;
3625
+ /** JSONP */
3626
+ callback?: string;
3627
+ /** Selector specifying which fields to include in a partial response. */
3628
+ fields?: string;
3629
+ /** 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. */
3630
+ key?: string;
3631
+ /** Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group} */
3632
+ name: string;
3633
+ /** OAuth 2.0 token for the current user. */
3634
+ oauth_token?: string;
3635
+ /** Returns response with indentations and line breaks. */
3636
+ prettyPrint?: boolean;
3637
+ /** 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. */
3638
+ quotaUser?: string;
3639
+ /**
3640
+ * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use
3641
+ * one path with the string "*" to match all fields.
3642
+ */
3643
+ updateMask?: string;
3644
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3645
+ upload_protocol?: string;
3646
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3647
+ uploadType?: string;
3648
+ },
3649
+ body: GoogleAnalyticsAdminV1alphaChannelGroup): Request<GoogleAnalyticsAdminV1alphaChannelGroup>;
3650
+ }
3378
3651
  interface ConversionEventsResource {
3379
3652
  /** Creates a conversion event with the specified attributes. */
3380
3653
  create(request: {
@@ -7135,6 +7408,7 @@ declare namespace gapi.client {
7135
7408
  accessBindings: AccessBindingsResource;
7136
7409
  audiences: AudiencesResource;
7137
7410
  bigQueryLinks: BigQueryLinksResource;
7411
+ channelGroups: ChannelGroupsResource;
7138
7412
  conversionEvents: ConversionEventsResource;
7139
7413
  customDimensions: CustomDimensionsResource;
7140
7414
  customMetrics: CustomMetricsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.analyticsadmin-v1alpha",
3
- "version": "0.0.20230404",
3
+ "version": "0.0.20230405",
4
4
  "description": "TypeScript typings for Google Analytics Admin API v1alpha",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230404
6
+ // Revision: 20230405
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -1040,6 +1040,91 @@ gapi.load('client', async () => {
1040
1040
  pageToken: "Test string",
1041
1041
  parent: "Test string",
1042
1042
  });
1043
+ /** Creates a ChannelGroup. */
1044
+ await gapi.client.analyticsadmin.properties.channelGroups.create({
1045
+ parent: "Test string",
1046
+ }, {
1047
+ description: "Test string",
1048
+ displayName: "Test string",
1049
+ groupingRule: [
1050
+ {
1051
+ displayName: "Test string",
1052
+ expression: {
1053
+ andGroup: {
1054
+ filterExpressions: undefined,
1055
+ },
1056
+ filter: {
1057
+ fieldName: "Test string",
1058
+ inListFilter: {
1059
+ values: [
1060
+ "Test string"
1061
+ ],
1062
+ },
1063
+ stringFilter: {
1064
+ matchType: "Test string",
1065
+ value: "Test string",
1066
+ },
1067
+ },
1068
+ notExpression: undefined,
1069
+ orGroup: {
1070
+ filterExpressions: undefined,
1071
+ },
1072
+ },
1073
+ }
1074
+ ],
1075
+ name: "Test string",
1076
+ systemDefined: true,
1077
+ });
1078
+ /** Deletes a ChannelGroup on a property. */
1079
+ await gapi.client.analyticsadmin.properties.channelGroups.delete({
1080
+ name: "Test string",
1081
+ });
1082
+ /** Lookup for a single ChannelGroup. */
1083
+ await gapi.client.analyticsadmin.properties.channelGroups.get({
1084
+ name: "Test string",
1085
+ });
1086
+ /** Lists ChannelGroups on a property. */
1087
+ await gapi.client.analyticsadmin.properties.channelGroups.list({
1088
+ pageSize: 42,
1089
+ pageToken: "Test string",
1090
+ parent: "Test string",
1091
+ });
1092
+ /** Updates a ChannelGroup. */
1093
+ await gapi.client.analyticsadmin.properties.channelGroups.patch({
1094
+ name: "Test string",
1095
+ updateMask: "Test string",
1096
+ }, {
1097
+ description: "Test string",
1098
+ displayName: "Test string",
1099
+ groupingRule: [
1100
+ {
1101
+ displayName: "Test string",
1102
+ expression: {
1103
+ andGroup: {
1104
+ filterExpressions: undefined,
1105
+ },
1106
+ filter: {
1107
+ fieldName: "Test string",
1108
+ inListFilter: {
1109
+ values: [
1110
+ "Test string"
1111
+ ],
1112
+ },
1113
+ stringFilter: {
1114
+ matchType: "Test string",
1115
+ value: "Test string",
1116
+ },
1117
+ },
1118
+ notExpression: undefined,
1119
+ orGroup: {
1120
+ filterExpressions: undefined,
1121
+ },
1122
+ },
1123
+ }
1124
+ ],
1125
+ name: "Test string",
1126
+ systemDefined: true,
1127
+ });
1043
1128
  /** Creates a conversion event with the specified attributes. */
1044
1129
  await gapi.client.analyticsadmin.properties.conversionEvents.create({
1045
1130
  parent: "Test string",