google-apis-analyticsadmin_v1alpha 0.33.0 → 0.34.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ecd22620440e4c85e144e1d6ec295e2a12c55952a98df7dc031f2181af242977
4
- data.tar.gz: b90edf3ac80b2eedd57ce53ac356927c5b9c9f3f645c0f438f4eab0c1cc30ca4
3
+ metadata.gz: 9e8df3f3bfcc3345c17e6f7428c0175b7dbe332958b4486b1882a3f56a06cecf
4
+ data.tar.gz: 6b1458f1a8a3ca3a0d2d907397bb77e22f0fb1bec019dddf47849e2935a12a38
5
5
  SHA512:
6
- metadata.gz: c8eec8c739b2ed0729625a670b8a861a98c8bd862bd57d02d90859436d8d0007f3e84a5d76076840f315a241917d92d3a4ab305d20c8da3be9618e4952360eb1
7
- data.tar.gz: 339be89c786ba11395ad9b57bcfa6e4ac12d0747d6b435f732375bb0f2ca3ce1acf27effec324f8873e26b1876dcc97b09028cb3589e051de1770794b49f3c31
6
+ metadata.gz: 763dc2e049cc338f1bf614ab6f76357b5459e980f94cbd4ca4d0020ca7430c24e4bd6a9b1e087bf4accd50b9243c71345b34c59024b3c20e1e00e56e617eac84
7
+ data.tar.gz: 2e14cd7230e0beb32fd3f9a730d7838fb6b09c2f7381f0c0f03352d875f4679432e3c9557fef9138c7031ed5d98479b4374ab168f1df57acb30e7264f95609fe
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-analyticsadmin_v1alpha
2
2
 
3
+ ### v0.34.0 (2022-07-27)
4
+
5
+ * Regenerated from discovery document revision 20220725
6
+
3
7
  ### v0.33.0 (2022-07-08)
4
8
 
5
9
  * Regenerated from discovery document revision 20220706
@@ -183,6 +183,19 @@ module Google
183
183
  end
184
184
  end
185
185
 
186
+ # Request message for ArchiveAudience RPC.
187
+ class GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
188
+ include Google::Apis::Core::Hashable
189
+
190
+ def initialize(**args)
191
+ update!(**args)
192
+ end
193
+
194
+ # Update properties of this object
195
+ def update!(**args)
196
+ end
197
+ end
198
+
186
199
  # Request message for ArchiveCustomDimension RPC.
187
200
  class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
188
201
  include Google::Apis::Core::Hashable
@@ -254,6 +267,534 @@ module Google
254
267
  end
255
268
  end
256
269
 
270
+ # A resource message representing a GA4 Audience.
271
+ class GoogleAnalyticsAdminV1alphaAudience
272
+ include Google::Apis::Core::Hashable
273
+
274
+ # Output only. It is automatically set by GA to false if this is an NPA Audience
275
+ # and is excluded from ads personalization.
276
+ # Corresponds to the JSON property `adsPersonalizationEnabled`
277
+ # @return [Boolean]
278
+ attr_accessor :ads_personalization_enabled
279
+ alias_method :ads_personalization_enabled?, :ads_personalization_enabled
280
+
281
+ # Required. The description of the Audience.
282
+ # Corresponds to the JSON property `description`
283
+ # @return [String]
284
+ attr_accessor :description
285
+
286
+ # Required. The display name of the Audience.
287
+ # Corresponds to the JSON property `displayName`
288
+ # @return [String]
289
+ attr_accessor :display_name
290
+
291
+ # Specifies an event to log when a user joins the Audience.
292
+ # Corresponds to the JSON property `eventTrigger`
293
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger]
294
+ attr_accessor :event_trigger
295
+
296
+ # Immutable. Specifies how long an exclusion lasts for users that meet the
297
+ # exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored
298
+ # when there is no EXCLUDE filter clause in the Audience.
299
+ # Corresponds to the JSON property `exclusionDurationMode`
300
+ # @return [String]
301
+ attr_accessor :exclusion_duration_mode
302
+
303
+ # Required. Immutable. null Filter clauses that define the Audience. All clauses
304
+ # will be AND’ed together.
305
+ # Corresponds to the JSON property `filterClauses`
306
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause>]
307
+ attr_accessor :filter_clauses
308
+
309
+ # Required. Immutable. The duration a user should stay in an Audience. It cannot
310
+ # be set to more than 540 days.
311
+ # Corresponds to the JSON property `membershipDurationDays`
312
+ # @return [Fixnum]
313
+ attr_accessor :membership_duration_days
314
+
315
+ # Output only. The resource name for this Audience resource. Format: properties/`
316
+ # propertyId`/audiences/`audienceId`
317
+ # Corresponds to the JSON property `name`
318
+ # @return [String]
319
+ attr_accessor :name
320
+
321
+ def initialize(**args)
322
+ update!(**args)
323
+ end
324
+
325
+ # Update properties of this object
326
+ def update!(**args)
327
+ @ads_personalization_enabled = args[:ads_personalization_enabled] if args.key?(:ads_personalization_enabled)
328
+ @description = args[:description] if args.key?(:description)
329
+ @display_name = args[:display_name] if args.key?(:display_name)
330
+ @event_trigger = args[:event_trigger] if args.key?(:event_trigger)
331
+ @exclusion_duration_mode = args[:exclusion_duration_mode] if args.key?(:exclusion_duration_mode)
332
+ @filter_clauses = args[:filter_clauses] if args.key?(:filter_clauses)
333
+ @membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days)
334
+ @name = args[:name] if args.key?(:name)
335
+ end
336
+ end
337
+
338
+ # A specific filter for a single dimension or metric.
339
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
340
+ include Google::Apis::Core::Hashable
341
+
342
+ # Optional. Indicates whether this filter needs dynamic evaluation or not. If
343
+ # set to true, users join the Audience if they ever met the condition (static
344
+ # evaluation). If unset or set to false, user evaluation for an Audience is
345
+ # dynamic; users are added to an Audience when they meet the conditions and then
346
+ # removed when they no longer meet them. This can only be set when Audience
347
+ # scope is ACROSS_ALL_SESSIONS.
348
+ # Corresponds to the JSON property `atAnyPointInTime`
349
+ # @return [Boolean]
350
+ attr_accessor :at_any_point_in_time
351
+ alias_method :at_any_point_in_time?, :at_any_point_in_time
352
+
353
+ # A filter for numeric or date values between certain values on a dimension or
354
+ # metric.
355
+ # Corresponds to the JSON property `betweenFilter`
356
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter]
357
+ attr_accessor :between_filter
358
+
359
+ # Required. Immutable. The dimension name or metric name to filter.
360
+ # Corresponds to the JSON property `fieldName`
361
+ # @return [String]
362
+ attr_accessor :field_name
363
+
364
+ # Optional. If set, specifies the time window for which to evaluate data in
365
+ # number of days. If not set, then audience data is evaluated against lifetime
366
+ # data (i.e., infinite time window). For example, if set to 1 day, only the
367
+ # current day's data is evaluated. The reference point is the current day when
368
+ # at_any_point_in_time is unset or false. It can only be set when Audience scope
369
+ # is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
370
+ # Corresponds to the JSON property `inAnyNDayPeriod`
371
+ # @return [Fixnum]
372
+ attr_accessor :in_any_n_day_period
373
+
374
+ # A filter for a string dimension that matches a particular list of options.
375
+ # Corresponds to the JSON property `inListFilter`
376
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter]
377
+ attr_accessor :in_list_filter
378
+
379
+ # A filter for numeric or date values on a dimension or metric.
380
+ # Corresponds to the JSON property `numericFilter`
381
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter]
382
+ attr_accessor :numeric_filter
383
+
384
+ # A filter for a string-type dimension that matches a particular pattern.
385
+ # Corresponds to the JSON property `stringFilter`
386
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter]
387
+ attr_accessor :string_filter
388
+
389
+ def initialize(**args)
390
+ update!(**args)
391
+ end
392
+
393
+ # Update properties of this object
394
+ def update!(**args)
395
+ @at_any_point_in_time = args[:at_any_point_in_time] if args.key?(:at_any_point_in_time)
396
+ @between_filter = args[:between_filter] if args.key?(:between_filter)
397
+ @field_name = args[:field_name] if args.key?(:field_name)
398
+ @in_any_n_day_period = args[:in_any_n_day_period] if args.key?(:in_any_n_day_period)
399
+ @in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
400
+ @numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
401
+ @string_filter = args[:string_filter] if args.key?(:string_filter)
402
+ end
403
+ end
404
+
405
+ # A filter for numeric or date values between certain values on a dimension or
406
+ # metric.
407
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
408
+ include Google::Apis::Core::Hashable
409
+
410
+ # To represent a number.
411
+ # Corresponds to the JSON property `fromValue`
412
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
413
+ attr_accessor :from_value
414
+
415
+ # To represent a number.
416
+ # Corresponds to the JSON property `toValue`
417
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
418
+ attr_accessor :to_value
419
+
420
+ def initialize(**args)
421
+ update!(**args)
422
+ end
423
+
424
+ # Update properties of this object
425
+ def update!(**args)
426
+ @from_value = args[:from_value] if args.key?(:from_value)
427
+ @to_value = args[:to_value] if args.key?(:to_value)
428
+ end
429
+ end
430
+
431
+ # A filter for a string dimension that matches a particular list of options.
432
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
433
+ include Google::Apis::Core::Hashable
434
+
435
+ # Optional. If true, the match is case-sensitive. If false, the match is case-
436
+ # insensitive.
437
+ # Corresponds to the JSON property `caseSensitive`
438
+ # @return [Boolean]
439
+ attr_accessor :case_sensitive
440
+ alias_method :case_sensitive?, :case_sensitive
441
+
442
+ # Required. The list of possible string values to match against. Must be non-
443
+ # empty.
444
+ # Corresponds to the JSON property `values`
445
+ # @return [Array<String>]
446
+ attr_accessor :values
447
+
448
+ def initialize(**args)
449
+ update!(**args)
450
+ end
451
+
452
+ # Update properties of this object
453
+ def update!(**args)
454
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
455
+ @values = args[:values] if args.key?(:values)
456
+ end
457
+ end
458
+
459
+ # A filter for numeric or date values on a dimension or metric.
460
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
461
+ include Google::Apis::Core::Hashable
462
+
463
+ # Required. The operation applied to a numeric filter.
464
+ # Corresponds to the JSON property `operation`
465
+ # @return [String]
466
+ attr_accessor :operation
467
+
468
+ # To represent a number.
469
+ # Corresponds to the JSON property `value`
470
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue]
471
+ attr_accessor :value
472
+
473
+ def initialize(**args)
474
+ update!(**args)
475
+ end
476
+
477
+ # Update properties of this object
478
+ def update!(**args)
479
+ @operation = args[:operation] if args.key?(:operation)
480
+ @value = args[:value] if args.key?(:value)
481
+ end
482
+ end
483
+
484
+ # To represent a number.
485
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
486
+ include Google::Apis::Core::Hashable
487
+
488
+ # Double value.
489
+ # Corresponds to the JSON property `doubleValue`
490
+ # @return [Float]
491
+ attr_accessor :double_value
492
+
493
+ # Integer value.
494
+ # Corresponds to the JSON property `int64Value`
495
+ # @return [Fixnum]
496
+ attr_accessor :int64_value
497
+
498
+ def initialize(**args)
499
+ update!(**args)
500
+ end
501
+
502
+ # Update properties of this object
503
+ def update!(**args)
504
+ @double_value = args[:double_value] if args.key?(:double_value)
505
+ @int64_value = args[:int64_value] if args.key?(:int64_value)
506
+ end
507
+ end
508
+
509
+ # A filter for a string-type dimension that matches a particular pattern.
510
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
511
+ include Google::Apis::Core::Hashable
512
+
513
+ # Optional. If true, the match is case-sensitive. If false, the match is case-
514
+ # insensitive.
515
+ # Corresponds to the JSON property `caseSensitive`
516
+ # @return [Boolean]
517
+ attr_accessor :case_sensitive
518
+ alias_method :case_sensitive?, :case_sensitive
519
+
520
+ # Required. The match type for the string filter.
521
+ # Corresponds to the JSON property `matchType`
522
+ # @return [String]
523
+ attr_accessor :match_type
524
+
525
+ # Required. The string value to be matched against.
526
+ # Corresponds to the JSON property `value`
527
+ # @return [String]
528
+ attr_accessor :value
529
+
530
+ def initialize(**args)
531
+ update!(**args)
532
+ end
533
+
534
+ # Update properties of this object
535
+ def update!(**args)
536
+ @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive)
537
+ @match_type = args[:match_type] if args.key?(:match_type)
538
+ @value = args[:value] if args.key?(:value)
539
+ end
540
+ end
541
+
542
+ # A filter that matches events of a single event name. If an event parameter is
543
+ # specified, only the subset of events that match both the single event name and
544
+ # the parameter filter expressions match this event filter.
545
+ class GoogleAnalyticsAdminV1alphaAudienceEventFilter
546
+ include Google::Apis::Core::Hashable
547
+
548
+ # Required. Immutable. The name of the event to match against.
549
+ # Corresponds to the JSON property `eventName`
550
+ # @return [String]
551
+ attr_accessor :event_name
552
+
553
+ # A logical expression of Audience dimension, metric, or event filters.
554
+ # Corresponds to the JSON property `eventParameterFilterExpression`
555
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
556
+ attr_accessor :event_parameter_filter_expression
557
+
558
+ def initialize(**args)
559
+ update!(**args)
560
+ end
561
+
562
+ # Update properties of this object
563
+ def update!(**args)
564
+ @event_name = args[:event_name] if args.key?(:event_name)
565
+ @event_parameter_filter_expression = args[:event_parameter_filter_expression] if args.key?(:event_parameter_filter_expression)
566
+ end
567
+ end
568
+
569
+ # Specifies an event to log when a user joins the Audience.
570
+ class GoogleAnalyticsAdminV1alphaAudienceEventTrigger
571
+ include Google::Apis::Core::Hashable
572
+
573
+ # Required. The event name that will be logged.
574
+ # Corresponds to the JSON property `eventName`
575
+ # @return [String]
576
+ attr_accessor :event_name
577
+
578
+ # Required. When to log the event.
579
+ # Corresponds to the JSON property `logCondition`
580
+ # @return [String]
581
+ attr_accessor :log_condition
582
+
583
+ def initialize(**args)
584
+ update!(**args)
585
+ end
586
+
587
+ # Update properties of this object
588
+ def update!(**args)
589
+ @event_name = args[:event_name] if args.key?(:event_name)
590
+ @log_condition = args[:log_condition] if args.key?(:log_condition)
591
+ end
592
+ end
593
+
594
+ # A clause for defining either a simple or sequence filter. A filter can be
595
+ # inclusive (i.e., users satisfying the filter clause are included in the
596
+ # Audience) or exclusive (i.e., users satisfying the filter clause are excluded
597
+ # from the Audience).
598
+ class GoogleAnalyticsAdminV1alphaAudienceFilterClause
599
+ include Google::Apis::Core::Hashable
600
+
601
+ # Required. Specifies whether this is an include or exclude filter clause.
602
+ # Corresponds to the JSON property `clauseType`
603
+ # @return [String]
604
+ attr_accessor :clause_type
605
+
606
+ # Defines filters that must occur in a specific order for the user to be a
607
+ # member of the Audience.
608
+ # Corresponds to the JSON property `sequenceFilter`
609
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilter]
610
+ attr_accessor :sequence_filter
611
+
612
+ # Defines a simple filter that a user must satisfy to be a member of the
613
+ # Audience.
614
+ # Corresponds to the JSON property `simpleFilter`
615
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSimpleFilter]
616
+ attr_accessor :simple_filter
617
+
618
+ def initialize(**args)
619
+ update!(**args)
620
+ end
621
+
622
+ # Update properties of this object
623
+ def update!(**args)
624
+ @clause_type = args[:clause_type] if args.key?(:clause_type)
625
+ @sequence_filter = args[:sequence_filter] if args.key?(:sequence_filter)
626
+ @simple_filter = args[:simple_filter] if args.key?(:simple_filter)
627
+ end
628
+ end
629
+
630
+ # A logical expression of Audience dimension, metric, or event filters.
631
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpression
632
+ include Google::Apis::Core::Hashable
633
+
634
+ # A list of Audience filter expressions.
635
+ # Corresponds to the JSON property `andGroup`
636
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList]
637
+ attr_accessor :and_group
638
+
639
+ # A specific filter for a single dimension or metric.
640
+ # Corresponds to the JSON property `dimensionOrMetricFilter`
641
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter]
642
+ attr_accessor :dimension_or_metric_filter
643
+
644
+ # A filter that matches events of a single event name. If an event parameter is
645
+ # specified, only the subset of events that match both the single event name and
646
+ # the parameter filter expressions match this event filter.
647
+ # Corresponds to the JSON property `eventFilter`
648
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventFilter]
649
+ attr_accessor :event_filter
650
+
651
+ # A logical expression of Audience dimension, metric, or event filters.
652
+ # Corresponds to the JSON property `notExpression`
653
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
654
+ attr_accessor :not_expression
655
+
656
+ # A list of Audience filter expressions.
657
+ # Corresponds to the JSON property `orGroup`
658
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList]
659
+ attr_accessor :or_group
660
+
661
+ def initialize(**args)
662
+ update!(**args)
663
+ end
664
+
665
+ # Update properties of this object
666
+ def update!(**args)
667
+ @and_group = args[:and_group] if args.key?(:and_group)
668
+ @dimension_or_metric_filter = args[:dimension_or_metric_filter] if args.key?(:dimension_or_metric_filter)
669
+ @event_filter = args[:event_filter] if args.key?(:event_filter)
670
+ @not_expression = args[:not_expression] if args.key?(:not_expression)
671
+ @or_group = args[:or_group] if args.key?(:or_group)
672
+ end
673
+ end
674
+
675
+ # A list of Audience filter expressions.
676
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
677
+ include Google::Apis::Core::Hashable
678
+
679
+ # A list of Audience filter expressions.
680
+ # Corresponds to the JSON property `filterExpressions`
681
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression>]
682
+ attr_accessor :filter_expressions
683
+
684
+ def initialize(**args)
685
+ update!(**args)
686
+ end
687
+
688
+ # Update properties of this object
689
+ def update!(**args)
690
+ @filter_expressions = args[:filter_expressions] if args.key?(:filter_expressions)
691
+ end
692
+ end
693
+
694
+ # Defines filters that must occur in a specific order for the user to be a
695
+ # member of the Audience.
696
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
697
+ include Google::Apis::Core::Hashable
698
+
699
+ # Required. Immutable. Specifies the scope for this filter.
700
+ # Corresponds to the JSON property `scope`
701
+ # @return [String]
702
+ attr_accessor :scope
703
+
704
+ # Optional. Defines the time period in which the whole sequence must occur.
705
+ # Corresponds to the JSON property `sequenceMaximumDuration`
706
+ # @return [String]
707
+ attr_accessor :sequence_maximum_duration
708
+
709
+ # Required. An ordered sequence of steps. A user must complete each step in
710
+ # order to join the sequence filter.
711
+ # Corresponds to the JSON property `sequenceSteps`
712
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep>]
713
+ attr_accessor :sequence_steps
714
+
715
+ def initialize(**args)
716
+ update!(**args)
717
+ end
718
+
719
+ # Update properties of this object
720
+ def update!(**args)
721
+ @scope = args[:scope] if args.key?(:scope)
722
+ @sequence_maximum_duration = args[:sequence_maximum_duration] if args.key?(:sequence_maximum_duration)
723
+ @sequence_steps = args[:sequence_steps] if args.key?(:sequence_steps)
724
+ end
725
+ end
726
+
727
+ # A condition that must occur in the specified step order for this user to match
728
+ # the sequence.
729
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
730
+ include Google::Apis::Core::Hashable
731
+
732
+ # Optional. When set, this step must be satisfied within the constraint_duration
733
+ # of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set,
734
+ # there is no duration requirement (the duration is effectively unlimited). It
735
+ # is ignored for the first step.
736
+ # Corresponds to the JSON property `constraintDuration`
737
+ # @return [String]
738
+ attr_accessor :constraint_duration
739
+
740
+ # A logical expression of Audience dimension, metric, or event filters.
741
+ # Corresponds to the JSON property `filterExpression`
742
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
743
+ attr_accessor :filter_expression
744
+
745
+ # Optional. If true, the event satisfying this step must be the very next event
746
+ # after the event satisfying the last step. If unset or false, this step
747
+ # indirectly follows the prior step; for example, there may be events between
748
+ # the prior step and this step. It is ignored for the first step.
749
+ # Corresponds to the JSON property `immediatelyFollows`
750
+ # @return [Boolean]
751
+ attr_accessor :immediately_follows
752
+ alias_method :immediately_follows?, :immediately_follows
753
+
754
+ # Required. Immutable. Specifies the scope for this step.
755
+ # Corresponds to the JSON property `scope`
756
+ # @return [String]
757
+ attr_accessor :scope
758
+
759
+ def initialize(**args)
760
+ update!(**args)
761
+ end
762
+
763
+ # Update properties of this object
764
+ def update!(**args)
765
+ @constraint_duration = args[:constraint_duration] if args.key?(:constraint_duration)
766
+ @filter_expression = args[:filter_expression] if args.key?(:filter_expression)
767
+ @immediately_follows = args[:immediately_follows] if args.key?(:immediately_follows)
768
+ @scope = args[:scope] if args.key?(:scope)
769
+ end
770
+ end
771
+
772
+ # Defines a simple filter that a user must satisfy to be a member of the
773
+ # Audience.
774
+ class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
775
+ include Google::Apis::Core::Hashable
776
+
777
+ # A logical expression of Audience dimension, metric, or event filters.
778
+ # Corresponds to the JSON property `filterExpression`
779
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression]
780
+ attr_accessor :filter_expression
781
+
782
+ # Required. Immutable. Specifies the scope for this filter.
783
+ # Corresponds to the JSON property `scope`
784
+ # @return [String]
785
+ attr_accessor :scope
786
+
787
+ def initialize(**args)
788
+ update!(**args)
789
+ end
790
+
791
+ # Update properties of this object
792
+ def update!(**args)
793
+ @filter_expression = args[:filter_expression] if args.key?(:filter_expression)
794
+ @scope = args[:scope] if args.key?(:scope)
795
+ end
796
+ end
797
+
257
798
  # Read-only resource used to summarize a principal's effective roles.
258
799
  class GoogleAnalyticsAdminV1alphaAuditUserLink
259
800
  include Google::Apis::Core::Hashable
@@ -1552,6 +2093,32 @@ module Google
1552
2093
  end
1553
2094
  end
1554
2095
 
2096
+ # Response message for ListAudiences RPC.
2097
+ class GoogleAnalyticsAdminV1alphaListAudiencesResponse
2098
+ include Google::Apis::Core::Hashable
2099
+
2100
+ # List of Audiences.
2101
+ # Corresponds to the JSON property `audiences`
2102
+ # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience>]
2103
+ attr_accessor :audiences
2104
+
2105
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
2106
+ # field is omitted, there are no subsequent pages.
2107
+ # Corresponds to the JSON property `nextPageToken`
2108
+ # @return [String]
2109
+ attr_accessor :next_page_token
2110
+
2111
+ def initialize(**args)
2112
+ update!(**args)
2113
+ end
2114
+
2115
+ # Update properties of this object
2116
+ def update!(**args)
2117
+ @audiences = args[:audiences] if args.key?(:audiences)
2118
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2119
+ end
2120
+ end
2121
+
1555
2122
  # Response message for ListConversionEvents RPC.
1556
2123
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
1557
2124
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AnalyticsadminV1alpha
18
18
  # Version of the google-apis-analyticsadmin_v1alpha gem
19
- GEM_VERSION = "0.33.0"
19
+ GEM_VERSION = "0.34.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.9.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220706"
25
+ REVISION = "20220725"
26
26
  end
27
27
  end
28
28
  end
@@ -58,6 +58,12 @@ module Google
58
58
  include Google::Apis::Core::JsonObjectSupport
59
59
  end
60
60
 
61
+ class GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
61
67
  class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
62
68
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
69
 
@@ -76,6 +82,96 @@ module Google
76
82
  include Google::Apis::Core::JsonObjectSupport
77
83
  end
78
84
 
85
+ class GoogleAnalyticsAdminV1alphaAudience
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
103
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
109
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
115
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
121
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
127
+ class GoogleAnalyticsAdminV1alphaAudienceEventFilter
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
133
+ class GoogleAnalyticsAdminV1alphaAudienceEventTrigger
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleAnalyticsAdminV1alphaAudienceFilterClause
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
145
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpression
146
+ class Representation < Google::Apis::Core::JsonRepresentation; end
147
+
148
+ include Google::Apis::Core::JsonObjectSupport
149
+ end
150
+
151
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
152
+ class Representation < Google::Apis::Core::JsonRepresentation; end
153
+
154
+ include Google::Apis::Core::JsonObjectSupport
155
+ end
156
+
157
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
158
+ class Representation < Google::Apis::Core::JsonRepresentation; end
159
+
160
+ include Google::Apis::Core::JsonObjectSupport
161
+ end
162
+
163
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
169
+ class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
170
+ class Representation < Google::Apis::Core::JsonRepresentation; end
171
+
172
+ include Google::Apis::Core::JsonObjectSupport
173
+ end
174
+
79
175
  class GoogleAnalyticsAdminV1alphaAuditUserLink
80
176
  class Representation < Google::Apis::Core::JsonRepresentation; end
81
177
 
@@ -274,6 +370,12 @@ module Google
274
370
  include Google::Apis::Core::JsonObjectSupport
275
371
  end
276
372
 
373
+ class GoogleAnalyticsAdminV1alphaListAudiencesResponse
374
+ class Representation < Google::Apis::Core::JsonRepresentation; end
375
+
376
+ include Google::Apis::Core::JsonObjectSupport
377
+ end
378
+
277
379
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
278
380
  class Representation < Google::Apis::Core::JsonRepresentation; end
279
381
 
@@ -450,6 +552,12 @@ module Google
450
552
  end
451
553
  end
452
554
 
555
+ class GoogleAnalyticsAdminV1alphaArchiveAudienceRequest
556
+ # @private
557
+ class Representation < Google::Apis::Core::JsonRepresentation
558
+ end
559
+ end
560
+
453
561
  class GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
454
562
  # @private
455
563
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -472,6 +580,165 @@ module Google
472
580
  end
473
581
  end
474
582
 
583
+ class GoogleAnalyticsAdminV1alphaAudience
584
+ # @private
585
+ class Representation < Google::Apis::Core::JsonRepresentation
586
+ property :ads_personalization_enabled, as: 'adsPersonalizationEnabled'
587
+ property :description, as: 'description'
588
+ property :display_name, as: 'displayName'
589
+ property :event_trigger, as: 'eventTrigger', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventTrigger::Representation
590
+
591
+ property :exclusion_duration_mode, as: 'exclusionDurationMode'
592
+ collection :filter_clauses, as: 'filterClauses', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterClause::Representation
593
+
594
+ property :membership_duration_days, as: 'membershipDurationDays'
595
+ property :name, as: 'name'
596
+ end
597
+ end
598
+
599
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter
600
+ # @private
601
+ class Representation < Google::Apis::Core::JsonRepresentation
602
+ property :at_any_point_in_time, as: 'atAnyPointInTime'
603
+ property :between_filter, as: 'betweenFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter::Representation
604
+
605
+ property :field_name, as: 'fieldName'
606
+ property :in_any_n_day_period, as: 'inAnyNDayPeriod'
607
+ property :in_list_filter, as: 'inListFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter::Representation
608
+
609
+ property :numeric_filter, as: 'numericFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter::Representation
610
+
611
+ property :string_filter, as: 'stringFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter::Representation
612
+
613
+ end
614
+ end
615
+
616
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter
617
+ # @private
618
+ class Representation < Google::Apis::Core::JsonRepresentation
619
+ property :from_value, as: 'fromValue', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue::Representation
620
+
621
+ property :to_value, as: 'toValue', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue::Representation
622
+
623
+ end
624
+ end
625
+
626
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter
627
+ # @private
628
+ class Representation < Google::Apis::Core::JsonRepresentation
629
+ property :case_sensitive, as: 'caseSensitive'
630
+ collection :values, as: 'values'
631
+ end
632
+ end
633
+
634
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter
635
+ # @private
636
+ class Representation < Google::Apis::Core::JsonRepresentation
637
+ property :operation, as: 'operation'
638
+ property :value, as: 'value', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue::Representation
639
+
640
+ end
641
+ end
642
+
643
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue
644
+ # @private
645
+ class Representation < Google::Apis::Core::JsonRepresentation
646
+ property :double_value, as: 'doubleValue'
647
+ property :int64_value, :numeric_string => true, as: 'int64Value'
648
+ end
649
+ end
650
+
651
+ class GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter
652
+ # @private
653
+ class Representation < Google::Apis::Core::JsonRepresentation
654
+ property :case_sensitive, as: 'caseSensitive'
655
+ property :match_type, as: 'matchType'
656
+ property :value, as: 'value'
657
+ end
658
+ end
659
+
660
+ class GoogleAnalyticsAdminV1alphaAudienceEventFilter
661
+ # @private
662
+ class Representation < Google::Apis::Core::JsonRepresentation
663
+ property :event_name, as: 'eventName'
664
+ property :event_parameter_filter_expression, as: 'eventParameterFilterExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
665
+
666
+ end
667
+ end
668
+
669
+ class GoogleAnalyticsAdminV1alphaAudienceEventTrigger
670
+ # @private
671
+ class Representation < Google::Apis::Core::JsonRepresentation
672
+ property :event_name, as: 'eventName'
673
+ property :log_condition, as: 'logCondition'
674
+ end
675
+ end
676
+
677
+ class GoogleAnalyticsAdminV1alphaAudienceFilterClause
678
+ # @private
679
+ class Representation < Google::Apis::Core::JsonRepresentation
680
+ property :clause_type, as: 'clauseType'
681
+ property :sequence_filter, as: 'sequenceFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilter::Representation
682
+
683
+ property :simple_filter, as: 'simpleFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSimpleFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSimpleFilter::Representation
684
+
685
+ end
686
+ end
687
+
688
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpression
689
+ # @private
690
+ class Representation < Google::Apis::Core::JsonRepresentation
691
+ property :and_group, as: 'andGroup', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList::Representation
692
+
693
+ property :dimension_or_metric_filter, as: 'dimensionOrMetricFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter::Representation
694
+
695
+ property :event_filter, as: 'eventFilter', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventFilter, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceEventFilter::Representation
696
+
697
+ property :not_expression, as: 'notExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
698
+
699
+ property :or_group, as: 'orGroup', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList::Representation
700
+
701
+ end
702
+ end
703
+
704
+ class GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList
705
+ # @private
706
+ class Representation < Google::Apis::Core::JsonRepresentation
707
+ collection :filter_expressions, as: 'filterExpressions', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
708
+
709
+ end
710
+ end
711
+
712
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilter
713
+ # @private
714
+ class Representation < Google::Apis::Core::JsonRepresentation
715
+ property :scope, as: 'scope'
716
+ property :sequence_maximum_duration, as: 'sequenceMaximumDuration'
717
+ collection :sequence_steps, as: 'sequenceSteps', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep::Representation
718
+
719
+ end
720
+ end
721
+
722
+ class GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep
723
+ # @private
724
+ class Representation < Google::Apis::Core::JsonRepresentation
725
+ property :constraint_duration, as: 'constraintDuration'
726
+ property :filter_expression, as: 'filterExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
727
+
728
+ property :immediately_follows, as: 'immediatelyFollows'
729
+ property :scope, as: 'scope'
730
+ end
731
+ end
732
+
733
+ class GoogleAnalyticsAdminV1alphaAudienceSimpleFilter
734
+ # @private
735
+ class Representation < Google::Apis::Core::JsonRepresentation
736
+ property :filter_expression, as: 'filterExpression', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceFilterExpression::Representation
737
+
738
+ property :scope, as: 'scope'
739
+ end
740
+ end
741
+
475
742
  class GoogleAnalyticsAdminV1alphaAuditUserLink
476
743
  # @private
477
744
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -822,6 +1089,15 @@ module Google
822
1089
  end
823
1090
  end
824
1091
 
1092
+ class GoogleAnalyticsAdminV1alphaListAudiencesResponse
1093
+ # @private
1094
+ class Representation < Google::Apis::Core::JsonRepresentation
1095
+ collection :audiences, as: 'audiences', class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience, decorator: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1096
+
1097
+ property :next_page_token, as: 'nextPageToken'
1098
+ end
1099
+ end
1100
+
825
1101
  class GoogleAnalyticsAdminV1alphaListConversionEventsResponse
826
1102
  # @private
827
1103
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1129,6 +1129,182 @@ module Google
1129
1129
  execute_or_queue_command(command, &block)
1130
1130
  end
1131
1131
 
1132
+ # Archives an Audience on a property.
1133
+ # @param [String] name
1134
+ # Required. Example format: properties/1234/audiences/5678
1135
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveAudienceRequest] google_analytics_admin_v1alpha_archive_audience_request_object
1136
+ # @param [String] fields
1137
+ # Selector specifying which fields to include in a partial response.
1138
+ # @param [String] quota_user
1139
+ # Available to use for quota purposes for server-side applications. Can be any
1140
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1141
+ # @param [Google::Apis::RequestOptions] options
1142
+ # Request-specific options
1143
+ #
1144
+ # @yield [result, err] Result & error if block supplied
1145
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1146
+ # @yieldparam err [StandardError] error object if request failed
1147
+ #
1148
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1149
+ #
1150
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1151
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1152
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1153
+ def archive_property_audience(name, google_analytics_admin_v1alpha_archive_audience_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1154
+ command = make_simple_command(:post, 'v1alpha/{+name}:archive', options)
1155
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaArchiveAudienceRequest::Representation
1156
+ command.request_object = google_analytics_admin_v1alpha_archive_audience_request_object
1157
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1158
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1159
+ command.params['name'] = name unless name.nil?
1160
+ command.query['fields'] = fields unless fields.nil?
1161
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1162
+ execute_or_queue_command(command, &block)
1163
+ end
1164
+
1165
+ # Creates an Audience.
1166
+ # @param [String] parent
1167
+ # Required. Example format: properties/1234
1168
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] google_analytics_admin_v1alpha_audience_object
1169
+ # @param [String] fields
1170
+ # Selector specifying which fields to include in a partial response.
1171
+ # @param [String] quota_user
1172
+ # Available to use for quota purposes for server-side applications. Can be any
1173
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1174
+ # @param [Google::Apis::RequestOptions] options
1175
+ # Request-specific options
1176
+ #
1177
+ # @yield [result, err] Result & error if block supplied
1178
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] parsed result object
1179
+ # @yieldparam err [StandardError] error object if request failed
1180
+ #
1181
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience]
1182
+ #
1183
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1184
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1185
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1186
+ def create_property_audience(parent, google_analytics_admin_v1alpha_audience_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1187
+ command = make_simple_command(:post, 'v1alpha/{+parent}/audiences', options)
1188
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1189
+ command.request_object = google_analytics_admin_v1alpha_audience_object
1190
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1191
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience
1192
+ command.params['parent'] = parent unless parent.nil?
1193
+ command.query['fields'] = fields unless fields.nil?
1194
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1195
+ execute_or_queue_command(command, &block)
1196
+ end
1197
+
1198
+ # Lookup for a single Audience.
1199
+ # @param [String] name
1200
+ # Required. The name of the Audience to get. Example format: properties/1234/
1201
+ # audiences/5678
1202
+ # @param [String] fields
1203
+ # Selector specifying which fields to include in a partial response.
1204
+ # @param [String] quota_user
1205
+ # Available to use for quota purposes for server-side applications. Can be any
1206
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1207
+ # @param [Google::Apis::RequestOptions] options
1208
+ # Request-specific options
1209
+ #
1210
+ # @yield [result, err] Result & error if block supplied
1211
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] parsed result object
1212
+ # @yieldparam err [StandardError] error object if request failed
1213
+ #
1214
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience]
1215
+ #
1216
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1217
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1218
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1219
+ def get_property_audience(name, fields: nil, quota_user: nil, options: nil, &block)
1220
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1221
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1222
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience
1223
+ command.params['name'] = name unless name.nil?
1224
+ command.query['fields'] = fields unless fields.nil?
1225
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1226
+ execute_or_queue_command(command, &block)
1227
+ end
1228
+
1229
+ # Lists Audiences on a property.
1230
+ # @param [String] parent
1231
+ # Required. Example format: properties/1234
1232
+ # @param [Fixnum] page_size
1233
+ # The maximum number of resources to return. If unspecified, at most 50
1234
+ # resources will be returned. The maximum value is 200 (higher values will be
1235
+ # coerced to the maximum).
1236
+ # @param [String] page_token
1237
+ # A page token, received from a previous `ListAudiences` call. Provide this to
1238
+ # retrieve the subsequent page. When paginating, all other parameters provided
1239
+ # to `ListAudiences` must match the call that provided the page token.
1240
+ # @param [String] fields
1241
+ # Selector specifying which fields to include in a partial response.
1242
+ # @param [String] quota_user
1243
+ # Available to use for quota purposes for server-side applications. Can be any
1244
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1245
+ # @param [Google::Apis::RequestOptions] options
1246
+ # Request-specific options
1247
+ #
1248
+ # @yield [result, err] Result & error if block supplied
1249
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse] parsed result object
1250
+ # @yieldparam err [StandardError] error object if request failed
1251
+ #
1252
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse]
1253
+ #
1254
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1255
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1256
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1257
+ def list_property_audiences(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1258
+ command = make_simple_command(:get, 'v1alpha/{+parent}/audiences', options)
1259
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse::Representation
1260
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAudiencesResponse
1261
+ command.params['parent'] = parent unless parent.nil?
1262
+ command.query['pageSize'] = page_size unless page_size.nil?
1263
+ command.query['pageToken'] = page_token unless page_token.nil?
1264
+ command.query['fields'] = fields unless fields.nil?
1265
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1266
+ execute_or_queue_command(command, &block)
1267
+ end
1268
+
1269
+ # Updates an Audience on a property.
1270
+ # @param [String] name
1271
+ # Output only. The resource name for this Audience resource. Format: properties/`
1272
+ # propertyId`/audiences/`audienceId`
1273
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] google_analytics_admin_v1alpha_audience_object
1274
+ # @param [String] update_mask
1275
+ # Required. The list of fields to be updated. Field names must be in snake case (
1276
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1277
+ # entire entity, use one path with the string "*" to match all fields.
1278
+ # @param [String] fields
1279
+ # Selector specifying which fields to include in a partial response.
1280
+ # @param [String] quota_user
1281
+ # Available to use for quota purposes for server-side applications. Can be any
1282
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1283
+ # @param [Google::Apis::RequestOptions] options
1284
+ # Request-specific options
1285
+ #
1286
+ # @yield [result, err] Result & error if block supplied
1287
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience] parsed result object
1288
+ # @yieldparam err [StandardError] error object if request failed
1289
+ #
1290
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience]
1291
+ #
1292
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1293
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1294
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1295
+ def patch_property_audience(name, google_analytics_admin_v1alpha_audience_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1296
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1297
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1298
+ command.request_object = google_analytics_admin_v1alpha_audience_object
1299
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience::Representation
1300
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudience
1301
+ command.params['name'] = name unless name.nil?
1302
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1303
+ command.query['fields'] = fields unless fields.nil?
1304
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1305
+ execute_or_queue_command(command, &block)
1306
+ end
1307
+
1132
1308
  # Creates a conversion event with the specified attributes.
1133
1309
  # @param [String] parent
1134
1310
  # Required. The resource name of the parent property where this conversion event
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-analyticsadmin_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.33.0
4
+ version: 0.34.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-11 00:00:00.000000000 Z
11
+ date: 2022-08-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.33.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsadmin_v1alpha/v0.34.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsadmin_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []