google-analytics-admin-v1alpha 0.23.0 → 0.24.0

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.
@@ -448,6 +448,135 @@ module Google
448
448
  extend ::Google::Protobuf::MessageExts::ClassMethods
449
449
  end
450
450
 
451
+ # SKAdNetwork conversion value schema of an iOS stream.
452
+ # @!attribute [r] name
453
+ # @return [::String]
454
+ # Output only. Resource name of the schema. This will be child of ONLY an iOS
455
+ # stream, and there can be at most one such child under an iOS stream.
456
+ # Format:
457
+ # properties/\\{property}/dataStreams/\\{dataStream}/sKAdNetworkConversionValueSchema
458
+ # @!attribute [rw] postback_window_one
459
+ # @return [::Google::Analytics::Admin::V1alpha::PostbackWindow]
460
+ # Required. The conversion value settings for the first postback window.
461
+ # These differ from values for postback window two and three in that they
462
+ # contain a "Fine" grained conversion value (a numeric value).
463
+ #
464
+ # Conversion values for this postback window must be set. The other windows
465
+ # are optional and may inherit this window's settings if unset or disabled.
466
+ # @!attribute [rw] postback_window_two
467
+ # @return [::Google::Analytics::Admin::V1alpha::PostbackWindow]
468
+ # The conversion value settings for the second postback window.
469
+ #
470
+ # This field should only be configured if there is a need to define different
471
+ # conversion values for this postback window.
472
+ #
473
+ # If enable_postback_window_settings is set to false for this postback
474
+ # window, the values from postback_window_one will be used.
475
+ # @!attribute [rw] postback_window_three
476
+ # @return [::Google::Analytics::Admin::V1alpha::PostbackWindow]
477
+ # The conversion value settings for the third postback window.
478
+ #
479
+ # This field should only be set if the user chose to define different
480
+ # conversion values for this postback window. It is allowed to configure
481
+ # window 3 without setting window 2. In case window 1 & 2 settings are set
482
+ # and enable_postback_window_settings for this postback window is set to
483
+ # false, the schema will inherit settings from postback_window_two.
484
+ # @!attribute [rw] apply_conversion_values
485
+ # @return [::Boolean]
486
+ # If enabled, the GA SDK will set conversion values using this schema
487
+ # definition, and schema will be exported to any Google Ads accounts linked
488
+ # to this property. If disabled, the GA SDK will not automatically set
489
+ # conversion values, and also the schema will not be exported to Ads.
490
+ class SKAdNetworkConversionValueSchema
491
+ include ::Google::Protobuf::MessageExts
492
+ extend ::Google::Protobuf::MessageExts::ClassMethods
493
+ end
494
+
495
+ # Settings for a SKAdNetwork conversion postback window.
496
+ # @!attribute [rw] conversion_values
497
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::ConversionValues>]
498
+ # Ordering of the repeated field will be used to prioritize the conversion
499
+ # value settings. Lower indexed entries are prioritized higher. The first
500
+ # conversion value setting that evaluates to true will be selected. It must
501
+ # have at least one entry if enable_postback_window_settings is set to
502
+ # true. It can have maximum of 128 entries.
503
+ # @!attribute [rw] postback_window_settings_enabled
504
+ # @return [::Boolean]
505
+ # If enable_postback_window_settings is true, conversion_values
506
+ # must be populated and will be used for determining when and how to set the
507
+ # Conversion Value on a client device and exporting schema to linked Ads
508
+ # accounts. If false, the settings are not used, but are retained in case
509
+ # they may be used in the future. This must always be true for
510
+ # postback_window_one.
511
+ class PostbackWindow
512
+ include ::Google::Protobuf::MessageExts
513
+ extend ::Google::Protobuf::MessageExts::ClassMethods
514
+ end
515
+
516
+ # Conversion value settings for a postback window for SKAdNetwork conversion
517
+ # value schema.
518
+ # @!attribute [rw] display_name
519
+ # @return [::String]
520
+ # Display name of the SKAdNetwork conversion value.
521
+ # The max allowed display name length is 50 UTF-16 code units.
522
+ # @!attribute [rw] fine_value
523
+ # @return [::Integer]
524
+ # The fine-grained conversion value. This is applicable only to the first
525
+ # postback window. Its valid values are [0,63], both inclusive. It must be
526
+ # set for postback window 1, and must not be set for postback window 2 & 3.
527
+ # This value is not guaranteed to be unique.
528
+ #
529
+ # If the configuration for the first postback window is re-used for second or
530
+ # third postback windows this field has no effect.
531
+ # @!attribute [rw] coarse_value
532
+ # @return [::Google::Analytics::Admin::V1alpha::CoarseValue]
533
+ # Required. A coarse grained conversion value.
534
+ #
535
+ # This value is not guaranteed to be unique.
536
+ # @!attribute [rw] event_mappings
537
+ # @return [::Array<::Google::Analytics::Admin::V1alpha::EventMapping>]
538
+ # Event conditions that must be met for this Conversion Value to be achieved.
539
+ # The conditions in this list are ANDed together. It must have minimum of 1
540
+ # entry and maximum of 3 entries, if the postback window is enabled.
541
+ # @!attribute [rw] lock_enabled
542
+ # @return [::Boolean]
543
+ # If true, the SDK should lock to this conversion value for the current
544
+ # postback window.
545
+ class ConversionValues
546
+ include ::Google::Protobuf::MessageExts
547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
548
+ end
549
+
550
+ # Event setting conditions to match an event.
551
+ # @!attribute [rw] event_name
552
+ # @return [::String]
553
+ # Required. Name of the GA4 event. It must always be set.
554
+ # The max allowed display name length is 40 UTF-16 code units.
555
+ # @!attribute [rw] min_event_count
556
+ # @return [::Integer]
557
+ # At least one of the following four min/max values must be set. The
558
+ # values set will be ANDed together to qualify an event.
559
+ # The minimum number of times the event occurred. If not set, minimum event
560
+ # count won't be checked.
561
+ # @!attribute [rw] max_event_count
562
+ # @return [::Integer]
563
+ # The maximum number of times the event occurred. If not set, maximum event
564
+ # count won't be checked.
565
+ # @!attribute [rw] min_event_value
566
+ # @return [::Float]
567
+ # The minimum revenue generated due to the event. Revenue currency will be
568
+ # defined at the property level. If not set, minimum event value won't be
569
+ # checked.
570
+ # @!attribute [rw] max_event_value
571
+ # @return [::Float]
572
+ # The maximum revenue generated due to the event. Revenue currency will be
573
+ # defined at the property level. If not set, maximum event value won't be
574
+ # checked.
575
+ class EventMapping
576
+ include ::Google::Protobuf::MessageExts
577
+ extend ::Google::Protobuf::MessageExts::ClassMethods
578
+ end
579
+
451
580
  # A set of changes within a Google Analytics account or its child properties
452
581
  # that resulted from the same cause. Common causes would be updates made in the
453
582
  # Google Analytics UI, changes from customer support, or automatic Google
@@ -559,6 +688,10 @@ module Google
559
688
  # @!attribute [rw] enhanced_measurement_settings
560
689
  # @return [::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings]
561
690
  # A snapshot of EnhancedMeasurementSettings resource in change history.
691
+ # @!attribute [rw] skadnetwork_conversion_value_schema
692
+ # @return [::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema]
693
+ # A snapshot of SKAdNetworkConversionValueSchema resource in change
694
+ # history.
562
695
  # @!attribute [rw] adsense_link
563
696
  # @return [::Google::Analytics::Admin::V1alpha::AdSenseLink]
564
697
  # A snapshot of an AdSenseLink resource in change history.
@@ -1195,9 +1328,9 @@ module Google
1195
1328
  # @!attribute [rw] streaming_export_enabled
1196
1329
  # @return [::Boolean]
1197
1330
  # If set true, enables streaming export to the linked Google Cloud project.
1198
- # @!attribute [rw] enterprise_export_enabled
1331
+ # @!attribute [rw] fresh_daily_export_enabled
1199
1332
  # @return [::Boolean]
1200
- # If set true, enables enterprise export to the linked Google Cloud project.
1333
+ # If set true, enables fresh daily export to the linked Google Cloud project.
1201
1334
  # @!attribute [rw] include_advertising_id
1202
1335
  # @return [::Boolean]
1203
1336
  # If set true, exported data will include advertising identifiers for mobile
@@ -1488,6 +1621,9 @@ module Google
1488
1621
  # EnhancedMeasurementSettings resource
1489
1622
  ENHANCED_MEASUREMENT_SETTINGS = 24
1490
1623
 
1624
+ # SKAdNetworkConversionValueSchema resource
1625
+ SKADNETWORK_CONVERSION_VALUE_SCHEMA = 26
1626
+
1491
1627
  # AdSenseLink resource
1492
1628
  ADSENSE_LINK = 27
1493
1629
 
@@ -1584,6 +1720,24 @@ module Google
1584
1720
  # GA4 rollup property
1585
1721
  PROPERTY_TYPE_ROLLUP = 3
1586
1722
  end
1723
+
1724
+ # The coarse conversion value set on the updatePostbackConversionValue SDK call
1725
+ # when a ConversionValues.event_mappings conditions are satisfied. For
1726
+ # more information, see
1727
+ # [SKAdNetwork.CoarseConversionValue](https://developer.apple.com/documentation/storekit/skadnetwork/coarseconversionvalue).
1728
+ module CoarseValue
1729
+ # Coarse value not specified.
1730
+ COARSE_VALUE_UNSPECIFIED = 0
1731
+
1732
+ # Coarse value of low.
1733
+ COARSE_VALUE_LOW = 1
1734
+
1735
+ # Coarse value of medium.
1736
+ COARSE_VALUE_MEDIUM = 2
1737
+
1738
+ # Coarse value of high.
1739
+ COARSE_VALUE_HIGH = 3
1740
+ end
1587
1741
  end
1588
1742
  end
1589
1743
  end
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-analytics-admin-v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.23.0
4
+ version: 0.24.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: 2023-08-15 00:00:00.000000000 Z
11
+ date: 2023-09-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
225
225
  - !ruby/object:Gem::Version
226
226
  version: '0'
227
227
  requirements: []
228
- rubygems_version: 3.4.2
228
+ rubygems_version: 3.4.19
229
229
  signing_key:
230
230
  specification_version: 4
231
231
  summary: 'Manage properties in Google Analytics. Warning: Creating multiple Customer