google-analytics-admin-v1alpha 0.13.0 → 0.15.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.
@@ -69,6 +69,62 @@ module Google
69
69
  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
70
70
  }
71
71
 
72
+ default_config.rpcs.get_account.timeout = 60.0
73
+
74
+ default_config.rpcs.list_accounts.timeout = 60.0
75
+
76
+ default_config.rpcs.delete_account.timeout = 60.0
77
+
78
+ default_config.rpcs.update_account.timeout = 60.0
79
+
80
+ default_config.rpcs.provision_account_ticket.timeout = 60.0
81
+
82
+ default_config.rpcs.get_property.timeout = 60.0
83
+
84
+ default_config.rpcs.list_properties.timeout = 60.0
85
+
86
+ default_config.rpcs.create_property.timeout = 60.0
87
+
88
+ default_config.rpcs.delete_property.timeout = 60.0
89
+
90
+ default_config.rpcs.update_property.timeout = 60.0
91
+
92
+ default_config.rpcs.get_user_link.timeout = 60.0
93
+
94
+ default_config.rpcs.batch_get_user_links.timeout = 60.0
95
+
96
+ default_config.rpcs.list_user_links.timeout = 60.0
97
+
98
+ default_config.rpcs.audit_user_links.timeout = 60.0
99
+
100
+ default_config.rpcs.create_user_link.timeout = 60.0
101
+
102
+ default_config.rpcs.batch_create_user_links.timeout = 60.0
103
+
104
+ default_config.rpcs.update_user_link.timeout = 60.0
105
+
106
+ default_config.rpcs.batch_update_user_links.timeout = 60.0
107
+
108
+ default_config.rpcs.delete_user_link.timeout = 60.0
109
+
110
+ default_config.rpcs.batch_delete_user_links.timeout = 60.0
111
+
112
+ default_config.rpcs.create_firebase_link.timeout = 60.0
113
+
114
+ default_config.rpcs.delete_firebase_link.timeout = 60.0
115
+
116
+ default_config.rpcs.list_firebase_links.timeout = 60.0
117
+
118
+ default_config.rpcs.get_global_site_tag.timeout = 60.0
119
+
120
+ default_config.rpcs.create_google_ads_link.timeout = 60.0
121
+
122
+ default_config.rpcs.update_google_ads_link.timeout = 60.0
123
+
124
+ default_config.rpcs.delete_google_ads_link.timeout = 60.0
125
+
126
+ default_config.rpcs.list_google_ads_links.timeout = 60.0
127
+
72
128
  default_config
73
129
  end
74
130
  yield @configure if block_given?
@@ -293,13 +349,11 @@ module Google
293
349
  # # Call the list_accounts method.
294
350
  # result = client.list_accounts request
295
351
  #
296
- # # The returned object is of type Gapic::PagedEnumerable. You can
297
- # # iterate over all elements by calling #each, and the enumerable
298
- # # will lazily make API calls to fetch subsequent pages. Other
299
- # # methods are also available for managing paging directly.
300
- # result.each do |response|
352
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
353
+ # # over elements, and API calls will be issued to fetch pages as needed.
354
+ # result.each do |item|
301
355
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::Account.
302
- # p response
356
+ # p item
303
357
  # end
304
358
  #
305
359
  def list_accounts request, options = nil
@@ -455,9 +509,10 @@ module Google
455
509
  # Required. The account to update.
456
510
  # The account's `name` field is used to identify the account.
457
511
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
458
- # Required. The list of fields to be updated. Field names must be in snake case
459
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
460
- # the entire entity, use one path with the string "*" to match all fields.
512
+ # Required. The list of fields to be updated. Field names must be in snake
513
+ # case (for example, "field_to_update"). Omitted fields will not be updated.
514
+ # To replace the entire entity, use one path with the string "*" to match all
515
+ # fields.
461
516
  #
462
517
  # @yield [response, operation] Access the result along with the RPC operation
463
518
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::Account]
@@ -545,7 +600,7 @@ module Google
545
600
  # The account to create.
546
601
  # @param redirect_uri [::String]
547
602
  # Redirect URI where the user will be sent after accepting Terms of Service.
548
- # Must be configured in Developers Console as a Redirect URI
603
+ # Must be configured in Developers Console as a Redirect URI.
549
604
  #
550
605
  # @yield [response, operation] Access the result along with the RPC operation
551
606
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse]
@@ -652,13 +707,11 @@ module Google
652
707
  # # Call the list_account_summaries method.
653
708
  # result = client.list_account_summaries request
654
709
  #
655
- # # The returned object is of type Gapic::PagedEnumerable. You can
656
- # # iterate over all elements by calling #each, and the enumerable
657
- # # will lazily make API calls to fetch subsequent pages. Other
658
- # # methods are also available for managing paging directly.
659
- # result.each do |response|
710
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
711
+ # # over elements, and API calls will be issued to fetch pages as needed.
712
+ # result.each do |item|
660
713
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::AccountSummary.
661
- # p response
714
+ # p item
662
715
  # end
663
716
  #
664
717
  def list_account_summaries request, options = nil
@@ -857,13 +910,11 @@ module Google
857
910
  # # Call the list_properties method.
858
911
  # result = client.list_properties request
859
912
  #
860
- # # The returned object is of type Gapic::PagedEnumerable. You can
861
- # # iterate over all elements by calling #each, and the enumerable
862
- # # will lazily make API calls to fetch subsequent pages. Other
863
- # # methods are also available for managing paging directly.
864
- # result.each do |response|
913
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
914
+ # # over elements, and API calls will be issued to fetch pages as needed.
915
+ # result.each do |item|
865
916
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::Property.
866
- # p response
917
+ # p item
867
918
  # end
868
919
  #
869
920
  def list_properties request, options = nil
@@ -989,7 +1040,7 @@ module Google
989
1040
  # will be permanently purged.
990
1041
  # https://support.google.com/analytics/answer/6154772
991
1042
  #
992
- # Returns an error if the target is not found, or is not an GA4 Property.
1043
+ # Returns an error if the target is not found, or is not a GA4 Property.
993
1044
  #
994
1045
  # @overload delete_property(request, options = nil)
995
1046
  # Pass arguments to `delete_property` via a request object, either of type
@@ -1098,9 +1149,10 @@ module Google
1098
1149
  # The property's `name` field is used to identify the property to be
1099
1150
  # updated.
1100
1151
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1101
- # Required. The list of fields to be updated. Field names must be in snake case
1102
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
1103
- # the entire entity, use one path with the string "*" to match all fields.
1152
+ # Required. The list of fields to be updated. Field names must be in snake
1153
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
1154
+ # replace the entire entity, use one path with the string "*" to match all
1155
+ # fields.
1104
1156
  #
1105
1157
  # @yield [response, operation] Access the result along with the RPC operation
1106
1158
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::Property]
@@ -1394,13 +1446,11 @@ module Google
1394
1446
  # # Call the list_user_links method.
1395
1447
  # result = client.list_user_links request
1396
1448
  #
1397
- # # The returned object is of type Gapic::PagedEnumerable. You can
1398
- # # iterate over all elements by calling #each, and the enumerable
1399
- # # will lazily make API calls to fetch subsequent pages. Other
1400
- # # methods are also available for managing paging directly.
1401
- # result.each do |response|
1449
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1450
+ # # over elements, and API calls will be issued to fetch pages as needed.
1451
+ # result.each do |item|
1402
1452
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::UserLink.
1403
- # p response
1453
+ # p item
1404
1454
  # end
1405
1455
  #
1406
1456
  def list_user_links request, options = nil
@@ -1504,13 +1554,11 @@ module Google
1504
1554
  # # Call the audit_user_links method.
1505
1555
  # result = client.audit_user_links request
1506
1556
  #
1507
- # # The returned object is of type Gapic::PagedEnumerable. You can
1508
- # # iterate over all elements by calling #each, and the enumerable
1509
- # # will lazily make API calls to fetch subsequent pages. Other
1510
- # # methods are also available for managing paging directly.
1511
- # result.each do |response|
1557
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1558
+ # # over elements, and API calls will be issued to fetch pages as needed.
1559
+ # result.each do |item|
1512
1560
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::AuditUserLink.
1513
- # p response
1561
+ # p item
1514
1562
  # end
1515
1563
  #
1516
1564
  def audit_user_links request, options = nil
@@ -1580,8 +1628,8 @@ module Google
1580
1628
  # @param parent [::String]
1581
1629
  # Required. Example format: accounts/1234
1582
1630
  # @param notify_new_user [::Boolean]
1583
- # Optional. If set, then email the new user notifying them that they've been granted
1584
- # permissions to the resource.
1631
+ # Optional. If set, then email the new user notifying them that they've been
1632
+ # granted permissions to the resource.
1585
1633
  # @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
1586
1634
  # Required. The user link to create.
1587
1635
  #
@@ -1671,14 +1719,14 @@ module Google
1671
1719
  # the default parameter values, pass an empty Hash as a request object (see above).
1672
1720
  #
1673
1721
  # @param parent [::String]
1674
- # Required. The account or property that all user links in the request are for.
1675
- # This field is required. The parent field in the CreateUserLinkRequest
1722
+ # Required. The account or property that all user links in the request are
1723
+ # for. This field is required. The parent field in the CreateUserLinkRequest
1676
1724
  # messages must either be empty or match this field.
1677
1725
  # Example format: accounts/1234
1678
1726
  # @param notify_new_users [::Boolean]
1679
- # Optional. If set, then email the new users notifying them that they've been granted
1680
- # permissions to the resource. Regardless of whether this is set or not,
1681
- # notify_new_user field inside each individual request is ignored.
1727
+ # Optional. If set, then email the new users notifying them that they've been
1728
+ # granted permissions to the resource. Regardless of whether this is set or
1729
+ # not, notify_new_user field inside each individual request is ignored.
1682
1730
  # @param requests [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash>]
1683
1731
  # Required. The requests specifying the user links to create.
1684
1732
  # A maximum of 1000 user links can be created in a batch.
@@ -2305,7 +2353,7 @@ module Google
2305
2353
  # @param page_token [::String]
2306
2354
  # A page token, received from a previous `ListFirebaseLinks` call.
2307
2355
  # Provide this to retrieve the subsequent page.
2308
- # When paginating, all other parameters provided to `ListProperties` must
2356
+ # When paginating, all other parameters provided to `ListFirebaseLinks` must
2309
2357
  # match the call that provided the page token.
2310
2358
  #
2311
2359
  # @yield [response, operation] Access the result along with the RPC operation
@@ -2328,13 +2376,11 @@ module Google
2328
2376
  # # Call the list_firebase_links method.
2329
2377
  # result = client.list_firebase_links request
2330
2378
  #
2331
- # # The returned object is of type Gapic::PagedEnumerable. You can
2332
- # # iterate over all elements by calling #each, and the enumerable
2333
- # # will lazily make API calls to fetch subsequent pages. Other
2334
- # # methods are also available for managing paging directly.
2335
- # result.each do |response|
2379
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2380
+ # # over elements, and API calls will be issued to fetch pages as needed.
2381
+ # result.each do |item|
2336
2382
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::FirebaseLink.
2337
- # p response
2383
+ # p item
2338
2384
  # end
2339
2385
  #
2340
2386
  def list_firebase_links request, options = nil
@@ -2576,9 +2622,10 @@ module Google
2576
2622
  # @param google_ads_link [::Google::Analytics::Admin::V1alpha::GoogleAdsLink, ::Hash]
2577
2623
  # The GoogleAdsLink to update
2578
2624
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2579
- # Required. The list of fields to be updated. Field names must be in snake case
2580
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
2581
- # the entire entity, use one path with the string "*" to match all fields.
2625
+ # Required. The list of fields to be updated. Field names must be in snake
2626
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
2627
+ # replace the entire entity, use one path with the string "*" to match all
2628
+ # fields.
2582
2629
  #
2583
2630
  # @yield [response, operation] Access the result along with the RPC operation
2584
2631
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleAdsLink]
@@ -2780,13 +2827,11 @@ module Google
2780
2827
  # # Call the list_google_ads_links method.
2781
2828
  # result = client.list_google_ads_links request
2782
2829
  #
2783
- # # The returned object is of type Gapic::PagedEnumerable. You can
2784
- # # iterate over all elements by calling #each, and the enumerable
2785
- # # will lazily make API calls to fetch subsequent pages. Other
2786
- # # methods are also available for managing paging directly.
2787
- # result.each do |response|
2830
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2831
+ # # over elements, and API calls will be issued to fetch pages as needed.
2832
+ # result.each do |item|
2788
2833
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::GoogleAdsLink.
2789
- # p response
2834
+ # p item
2790
2835
  # end
2791
2836
  #
2792
2837
  def list_google_ads_links request, options = nil
@@ -3059,13 +3104,11 @@ module Google
3059
3104
  # # Call the list_measurement_protocol_secrets method.
3060
3105
  # result = client.list_measurement_protocol_secrets request
3061
3106
  #
3062
- # # The returned object is of type Gapic::PagedEnumerable. You can
3063
- # # iterate over all elements by calling #each, and the enumerable
3064
- # # will lazily make API calls to fetch subsequent pages. Other
3065
- # # methods are also available for managing paging directly.
3066
- # result.each do |response|
3107
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3108
+ # # over elements, and API calls will be issued to fetch pages as needed.
3109
+ # result.each do |item|
3067
3110
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret.
3068
- # p response
3111
+ # p item
3069
3112
  # end
3070
3113
  #
3071
3114
  def list_measurement_protocol_secrets request, options = nil
@@ -3376,7 +3419,8 @@ module Google
3376
3419
  # Acknowledges the terms of user data collection for the specified property.
3377
3420
  #
3378
3421
  # This acknowledgement must be completed (either in the Google Analytics UI
3379
- # or via this API) before MeasurementProtocolSecret resources may be created.
3422
+ # or through this API) before MeasurementProtocolSecret resources may be
3423
+ # created.
3380
3424
  #
3381
3425
  # @overload acknowledge_user_data_collection(request, options = nil)
3382
3426
  # Pass arguments to `acknowledge_user_data_collection` via a request object, either of type
@@ -3396,8 +3440,8 @@ module Google
3396
3440
  # @param property [::String]
3397
3441
  # Required. The property for which to acknowledge user data collection.
3398
3442
  # @param acknowledgement [::String]
3399
- # Required. An acknowledgement that the caller of this method understands the terms
3400
- # of user data collection.
3443
+ # Required. An acknowledgement that the caller of this method understands the
3444
+ # terms of user data collection.
3401
3445
  #
3402
3446
  # This field must contain the exact value:
3403
3447
  # "I acknowledge that I have the necessary privacy disclosures and rights
@@ -3489,18 +3533,20 @@ module Google
3489
3533
  # the default parameter values, pass an empty Hash as a request object (see above).
3490
3534
  #
3491
3535
  # @param account [::String]
3492
- # Required. The account resource for which to return change history resources.
3536
+ # Required. The account resource for which to return change history
3537
+ # resources.
3493
3538
  # @param property [::String]
3494
3539
  # Optional. Resource name for a child property. If set, only return changes
3495
3540
  # made to this property or its child resources.
3496
3541
  # @param resource_type [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
3497
- # Optional. If set, only return changes if they are for a resource that matches at
3498
- # least one of these types.
3542
+ # Optional. If set, only return changes if they are for a resource that
3543
+ # matches at least one of these types.
3499
3544
  # @param action [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
3500
- # Optional. If set, only return changes that match one or more of these types of
3501
- # actions.
3545
+ # Optional. If set, only return changes that match one or more of these types
3546
+ # of actions.
3502
3547
  # @param actor_email [::Array<::String>]
3503
- # Optional. If set, only return changes if they are made by a user in this list.
3548
+ # Optional. If set, only return changes if they are made by a user in this
3549
+ # list.
3504
3550
  # @param earliest_change_time [::Google::Protobuf::Timestamp, ::Hash]
3505
3551
  # Optional. If set, only return changes made after this time (inclusive).
3506
3552
  # @param latest_change_time [::Google::Protobuf::Timestamp, ::Hash]
@@ -3511,10 +3557,11 @@ module Google
3511
3557
  # pages. If unspecified, at most 50 items will be returned.
3512
3558
  # The maximum value is 200 (higher values will be coerced to the maximum).
3513
3559
  # @param page_token [::String]
3514
- # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
3515
- # Provide this to retrieve the subsequent page. When paginating, all other
3516
- # parameters provided to `SearchChangeHistoryEvents` must match the call that
3517
- # provided the page token.
3560
+ # Optional. A page token, received from a previous
3561
+ # `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent
3562
+ # page. When paginating, all other parameters provided to
3563
+ # `SearchChangeHistoryEvents` must match the call that provided the page
3564
+ # token.
3518
3565
  #
3519
3566
  # @yield [response, operation] Access the result along with the RPC operation
3520
3567
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
@@ -3536,13 +3583,11 @@ module Google
3536
3583
  # # Call the search_change_history_events method.
3537
3584
  # result = client.search_change_history_events request
3538
3585
  #
3539
- # # The returned object is of type Gapic::PagedEnumerable. You can
3540
- # # iterate over all elements by calling #each, and the enumerable
3541
- # # will lazily make API calls to fetch subsequent pages. Other
3542
- # # methods are also available for managing paging directly.
3543
- # result.each do |response|
3586
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3587
+ # # over elements, and API calls will be issued to fetch pages as needed.
3588
+ # result.each do |item|
3544
3589
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent.
3545
- # p response
3590
+ # p item
3546
3591
  # end
3547
3592
  #
3548
3593
  def search_change_history_events request, options = nil
@@ -3695,9 +3740,10 @@ module Google
3695
3740
  # Required. The settings to update.
3696
3741
  # The `name` field is used to identify the settings to be updated.
3697
3742
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
3698
- # Required. The list of fields to be updated. Field names must be in snake case
3699
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
3700
- # the entire entity, use one path with the string "*" to match all fields.
3743
+ # Required. The list of fields to be updated. Field names must be in snake
3744
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
3745
+ # replace the entire entity, use one path with the string "*" to match all
3746
+ # fields.
3701
3747
  #
3702
3748
  # @yield [response, operation] Access the result along with the RPC operation
3703
3749
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
@@ -3784,8 +3830,8 @@ module Google
3784
3830
  # @param conversion_event [::Google::Analytics::Admin::V1alpha::ConversionEvent, ::Hash]
3785
3831
  # Required. The conversion event to create.
3786
3832
  # @param parent [::String]
3787
- # Required. The resource name of the parent property where this conversion event will
3788
- # be created. Format: properties/123
3833
+ # Required. The resource name of the parent property where this conversion
3834
+ # event will be created. Format: properties/123
3789
3835
  #
3790
3836
  # @yield [response, operation] Access the result along with the RPC operation
3791
3837
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
@@ -4078,13 +4124,11 @@ module Google
4078
4124
  # # Call the list_conversion_events method.
4079
4125
  # result = client.list_conversion_events request
4080
4126
  #
4081
- # # The returned object is of type Gapic::PagedEnumerable. You can
4082
- # # iterate over all elements by calling #each, and the enumerable
4083
- # # will lazily make API calls to fetch subsequent pages. Other
4084
- # # methods are also available for managing paging directly.
4085
- # result.each do |response|
4127
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
4128
+ # # over elements, and API calls will be issued to fetch pages as needed.
4129
+ # result.each do |item|
4086
4130
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::ConversionEvent.
4087
- # p response
4131
+ # p item
4088
4132
  # end
4089
4133
  #
4090
4134
  def list_conversion_events request, options = nil
@@ -4267,13 +4311,11 @@ module Google
4267
4311
  # # Call the list_display_video360_advertiser_links method.
4268
4312
  # result = client.list_display_video360_advertiser_links request
4269
4313
  #
4270
- # # The returned object is of type Gapic::PagedEnumerable. You can
4271
- # # iterate over all elements by calling #each, and the enumerable
4272
- # # will lazily make API calls to fetch subsequent pages. Other
4273
- # # methods are also available for managing paging directly.
4274
- # result.each do |response|
4314
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
4315
+ # # over elements, and API calls will be issued to fetch pages as needed.
4316
+ # result.each do |item|
4275
4317
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink.
4276
- # p response
4318
+ # p item
4277
4319
  # end
4278
4320
  #
4279
4321
  def list_display_video360_advertiser_links request, options = nil
@@ -4516,9 +4558,9 @@ module Google
4516
4558
  # @param display_video_360_advertiser_link [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink, ::Hash]
4517
4559
  # The DisplayVideo360AdvertiserLink to update
4518
4560
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
4519
- # Required. The list of fields to be updated. Omitted fields will not be updated.
4520
- # To replace the entire entity, use one path with the string "*" to match
4521
- # all fields.
4561
+ # Required. The list of fields to be updated. Omitted fields will not be
4562
+ # updated. To replace the entire entity, use one path with the string "*" to
4563
+ # match all fields.
4522
4564
  #
4523
4565
  # @yield [response, operation] Access the result along with the RPC operation
4524
4566
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
@@ -4723,13 +4765,11 @@ module Google
4723
4765
  # # Call the list_display_video360_advertiser_link_proposals method.
4724
4766
  # result = client.list_display_video360_advertiser_link_proposals request
4725
4767
  #
4726
- # # The returned object is of type Gapic::PagedEnumerable. You can
4727
- # # iterate over all elements by calling #each, and the enumerable
4728
- # # will lazily make API calls to fetch subsequent pages. Other
4729
- # # methods are also available for managing paging directly.
4730
- # result.each do |response|
4768
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
4769
+ # # over elements, and API calls will be issued to fetch pages as needed.
4770
+ # result.each do |item|
4731
4771
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal.
4732
- # p response
4772
+ # p item
4733
4773
  # end
4734
4774
  #
4735
4775
  def list_display_video360_advertiser_link_proposals request, options = nil
@@ -5234,9 +5274,9 @@ module Google
5234
5274
  # @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
5235
5275
  # The CustomDimension to update
5236
5276
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
5237
- # Required. The list of fields to be updated. Omitted fields will not be updated.
5238
- # To replace the entire entity, use one path with the string "*" to match
5239
- # all fields.
5277
+ # Required. The list of fields to be updated. Omitted fields will not be
5278
+ # updated. To replace the entire entity, use one path with the string "*" to
5279
+ # match all fields.
5240
5280
  #
5241
5281
  # @yield [response, operation] Access the result along with the RPC operation
5242
5282
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
@@ -5353,13 +5393,11 @@ module Google
5353
5393
  # # Call the list_custom_dimensions method.
5354
5394
  # result = client.list_custom_dimensions request
5355
5395
  #
5356
- # # The returned object is of type Gapic::PagedEnumerable. You can
5357
- # # iterate over all elements by calling #each, and the enumerable
5358
- # # will lazily make API calls to fetch subsequent pages. Other
5359
- # # methods are also available for managing paging directly.
5360
- # result.each do |response|
5396
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
5397
+ # # over elements, and API calls will be issued to fetch pages as needed.
5398
+ # result.each do |item|
5361
5399
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomDimension.
5362
- # p response
5400
+ # p item
5363
5401
  # end
5364
5402
  #
5365
5403
  def list_custom_dimensions request, options = nil
@@ -5684,9 +5722,9 @@ module Google
5684
5722
  # @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
5685
5723
  # The CustomMetric to update
5686
5724
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
5687
- # Required. The list of fields to be updated. Omitted fields will not be updated.
5688
- # To replace the entire entity, use one path with the string "*" to match
5689
- # all fields.
5725
+ # Required. The list of fields to be updated. Omitted fields will not be
5726
+ # updated. To replace the entire entity, use one path with the string "*" to
5727
+ # match all fields.
5690
5728
  #
5691
5729
  # @yield [response, operation] Access the result along with the RPC operation
5692
5730
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
@@ -5803,13 +5841,11 @@ module Google
5803
5841
  # # Call the list_custom_metrics method.
5804
5842
  # result = client.list_custom_metrics request
5805
5843
  #
5806
- # # The returned object is of type Gapic::PagedEnumerable. You can
5807
- # # iterate over all elements by calling #each, and the enumerable
5808
- # # will lazily make API calls to fetch subsequent pages. Other
5809
- # # methods are also available for managing paging directly.
5810
- # result.each do |response|
5844
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
5845
+ # # over elements, and API calls will be issued to fetch pages as needed.
5846
+ # result.each do |item|
5811
5847
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomMetric.
5812
- # p response
5848
+ # p item
5813
5849
  # end
5814
5850
  #
5815
5851
  def list_custom_metrics request, options = nil
@@ -6136,9 +6172,10 @@ module Google
6136
6172
  # Required. The settings to update.
6137
6173
  # The `name` field is used to identify the settings to be updated.
6138
6174
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
6139
- # Required. The list of fields to be updated. Field names must be in snake case
6140
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
6141
- # the entire entity, use one path with the string "*" to match all fields.
6175
+ # Required. The list of fields to be updated. Field names must be in snake
6176
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
6177
+ # replace the entire entity, use one path with the string "*" to match all
6178
+ # fields.
6142
6179
  #
6143
6180
  # @yield [response, operation] Access the result along with the RPC operation
6144
6181
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
@@ -6398,9 +6435,9 @@ module Google
6398
6435
  # @param data_stream [::Google::Analytics::Admin::V1alpha::DataStream, ::Hash]
6399
6436
  # The DataStream to update
6400
6437
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
6401
- # Required. The list of fields to be updated. Omitted fields will not be updated.
6402
- # To replace the entire entity, use one path with the string "*" to match
6403
- # all fields.
6438
+ # Required. The list of fields to be updated. Omitted fields will not be
6439
+ # updated. To replace the entire entity, use one path with the string "*" to
6440
+ # match all fields.
6404
6441
  #
6405
6442
  # @yield [response, operation] Access the result along with the RPC operation
6406
6443
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::DataStream]
@@ -6517,13 +6554,11 @@ module Google
6517
6554
  # # Call the list_data_streams method.
6518
6555
  # result = client.list_data_streams request
6519
6556
  #
6520
- # # The returned object is of type Gapic::PagedEnumerable. You can
6521
- # # iterate over all elements by calling #each, and the enumerable
6522
- # # will lazily make API calls to fetch subsequent pages. Other
6523
- # # methods are also available for managing paging directly.
6524
- # result.each do |response|
6557
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
6558
+ # # over elements, and API calls will be issued to fetch pages as needed.
6559
+ # result.each do |item|
6525
6560
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::DataStream.
6526
- # p response
6561
+ # p item
6527
6562
  # end
6528
6563
  #
6529
6564
  def list_data_streams request, options = nil
@@ -6657,6 +6692,7 @@ module Google
6657
6692
  ##
6658
6693
  # Lookup for a single Audience.
6659
6694
  # Audiences created before 2020 may not be supported.
6695
+ # Default audiences will not show filter definitions.
6660
6696
  #
6661
6697
  # @overload get_audience(request, options = nil)
6662
6698
  # Pass arguments to `get_audience` via a request object, either of type
@@ -6744,6 +6780,7 @@ module Google
6744
6780
  ##
6745
6781
  # Lists Audiences on a property.
6746
6782
  # Audiences created before 2020 may not be supported.
6783
+ # Default audiences will not show filter definitions.
6747
6784
  #
6748
6785
  # @overload list_audiences(request, options = nil)
6749
6786
  # Pass arguments to `list_audiences` via a request object, either of type
@@ -6793,13 +6830,11 @@ module Google
6793
6830
  # # Call the list_audiences method.
6794
6831
  # result = client.list_audiences request
6795
6832
  #
6796
- # # The returned object is of type Gapic::PagedEnumerable. You can
6797
- # # iterate over all elements by calling #each, and the enumerable
6798
- # # will lazily make API calls to fetch subsequent pages. Other
6799
- # # methods are also available for managing paging directly.
6800
- # result.each do |response|
6833
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
6834
+ # # over elements, and API calls will be issued to fetch pages as needed.
6835
+ # result.each do |item|
6801
6836
  # # Each element is of type ::Google::Analytics::Admin::V1alpha::Audience.
6802
- # p response
6837
+ # p item
6803
6838
  # end
6804
6839
  #
6805
6840
  def list_audiences request, options = nil
@@ -6953,9 +6988,10 @@ module Google
6953
6988
  # Required. The audience to update.
6954
6989
  # The audience's `name` field is used to identify the audience to be updated.
6955
6990
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
6956
- # Required. The list of fields to be updated. Field names must be in snake case
6957
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
6958
- # the entire entity, use one path with the string "*" to match all fields.
6991
+ # Required. The list of fields to be updated. Field names must be in snake
6992
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
6993
+ # replace the entire entity, use one path with the string "*" to match all
6994
+ # fields.
6959
6995
  #
6960
6996
  # @yield [response, operation] Access the result along with the RPC operation
6961
6997
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::Audience]
@@ -7107,32 +7143,32 @@ module Google
7107
7143
  end
7108
7144
 
7109
7145
  ##
7110
- # Lookup for a AttributionSettings singleton.
7146
+ # Look up a single SearchAds360Link
7111
7147
  #
7112
- # @overload get_attribution_settings(request, options = nil)
7113
- # Pass arguments to `get_attribution_settings` via a request object, either of type
7114
- # {::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest} or an equivalent Hash.
7148
+ # @overload get_search_ads360_link(request, options = nil)
7149
+ # Pass arguments to `get_search_ads360_link` via a request object, either of type
7150
+ # {::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest} or an equivalent Hash.
7115
7151
  #
7116
- # @param request [::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest, ::Hash]
7152
+ # @param request [::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest, ::Hash]
7117
7153
  # A request object representing the call parameters. Required. To specify no
7118
7154
  # parameters, or to keep all the default parameter values, pass an empty Hash.
7119
7155
  # @param options [::Gapic::CallOptions, ::Hash]
7120
7156
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7121
7157
  #
7122
- # @overload get_attribution_settings(name: nil)
7123
- # Pass arguments to `get_attribution_settings` via keyword arguments. Note that at
7158
+ # @overload get_search_ads360_link(name: nil)
7159
+ # Pass arguments to `get_search_ads360_link` via keyword arguments. Note that at
7124
7160
  # least one keyword argument is required. To specify no parameters, or to keep all
7125
7161
  # the default parameter values, pass an empty Hash as a request object (see above).
7126
7162
  #
7127
7163
  # @param name [::String]
7128
- # Required. The name of the attribution settings to retrieve.
7129
- # Format: properties/\\{property}/attributionSettings
7164
+ # Required. The name of the SearchAds360Link to get.
7165
+ # Example format: properties/1234/SearchAds360Link/5678
7130
7166
  #
7131
7167
  # @yield [response, operation] Access the result along with the RPC operation
7132
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7168
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
7133
7169
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
7134
7170
  #
7135
- # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7171
+ # @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
7136
7172
  #
7137
7173
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
7138
7174
  #
@@ -7143,24 +7179,24 @@ module Google
7143
7179
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7144
7180
  #
7145
7181
  # # Create a request. To set request fields, pass in keyword arguments.
7146
- # request = Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest.new
7182
+ # request = Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest.new
7147
7183
  #
7148
- # # Call the get_attribution_settings method.
7149
- # result = client.get_attribution_settings request
7184
+ # # Call the get_search_ads360_link method.
7185
+ # result = client.get_search_ads360_link request
7150
7186
  #
7151
- # # The returned object is of type Google::Analytics::Admin::V1alpha::AttributionSettings.
7187
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::SearchAds360Link.
7152
7188
  # p result
7153
7189
  #
7154
- def get_attribution_settings request, options = nil
7190
+ def get_search_ads360_link request, options = nil
7155
7191
  raise ::ArgumentError, "request must be provided" if request.nil?
7156
7192
 
7157
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest
7193
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest
7158
7194
 
7159
7195
  # Converts hash and nil to an options object
7160
7196
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7161
7197
 
7162
7198
  # Customize the options with defaults
7163
- metadata = @config.rpcs.get_attribution_settings.metadata.to_h
7199
+ metadata = @config.rpcs.get_search_ads360_link.metadata.to_h
7164
7200
 
7165
7201
  # Set x-goog-api-client and x-goog-user-project headers
7166
7202
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -7176,15 +7212,15 @@ module Google
7176
7212
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7177
7213
  metadata[:"x-goog-request-params"] ||= request_params_header
7178
7214
 
7179
- options.apply_defaults timeout: @config.rpcs.get_attribution_settings.timeout,
7215
+ options.apply_defaults timeout: @config.rpcs.get_search_ads360_link.timeout,
7180
7216
  metadata: metadata,
7181
- retry_policy: @config.rpcs.get_attribution_settings.retry_policy
7217
+ retry_policy: @config.rpcs.get_search_ads360_link.retry_policy
7182
7218
 
7183
7219
  options.apply_defaults timeout: @config.timeout,
7184
7220
  metadata: @config.metadata,
7185
7221
  retry_policy: @config.retry_policy
7186
7222
 
7187
- @analytics_admin_service_stub.call_rpc :get_attribution_settings, request, options: options do |response, operation|
7223
+ @analytics_admin_service_stub.call_rpc :get_search_ads360_link, request, options: options do |response, operation|
7188
7224
  yield response, operation if block_given?
7189
7225
  return response
7190
7226
  end
@@ -7193,36 +7229,42 @@ module Google
7193
7229
  end
7194
7230
 
7195
7231
  ##
7196
- # Updates attribution settings on a property.
7232
+ # Lists all SearchAds360Links on a property.
7197
7233
  #
7198
- # @overload update_attribution_settings(request, options = nil)
7199
- # Pass arguments to `update_attribution_settings` via a request object, either of type
7200
- # {::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest} or an equivalent Hash.
7234
+ # @overload list_search_ads360_links(request, options = nil)
7235
+ # Pass arguments to `list_search_ads360_links` via a request object, either of type
7236
+ # {::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest} or an equivalent Hash.
7201
7237
  #
7202
- # @param request [::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest, ::Hash]
7238
+ # @param request [::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest, ::Hash]
7203
7239
  # A request object representing the call parameters. Required. To specify no
7204
7240
  # parameters, or to keep all the default parameter values, pass an empty Hash.
7205
7241
  # @param options [::Gapic::CallOptions, ::Hash]
7206
7242
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7207
7243
  #
7208
- # @overload update_attribution_settings(attribution_settings: nil, update_mask: nil)
7209
- # Pass arguments to `update_attribution_settings` via keyword arguments. Note that at
7244
+ # @overload list_search_ads360_links(parent: nil, page_size: nil, page_token: nil)
7245
+ # Pass arguments to `list_search_ads360_links` via keyword arguments. Note that at
7210
7246
  # least one keyword argument is required. To specify no parameters, or to keep all
7211
7247
  # the default parameter values, pass an empty Hash as a request object (see above).
7212
7248
  #
7213
- # @param attribution_settings [::Google::Analytics::Admin::V1alpha::AttributionSettings, ::Hash]
7214
- # Required. The attribution settings to update.
7215
- # The `name` field is used to identify the settings to be updated.
7216
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
7217
- # Required. The list of fields to be updated. Field names must be in snake case
7218
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
7219
- # the entire entity, use one path with the string "*" to match all fields.
7249
+ # @param parent [::String]
7250
+ # Required. Example format: properties/1234
7251
+ # @param page_size [::Integer]
7252
+ # The maximum number of resources to return.
7253
+ # If unspecified, at most 50 resources will be returned.
7254
+ # The maximum value is 200 (higher values will be coerced to the maximum).
7255
+ # @param page_token [::String]
7256
+ # A page token, received from a previous `ListSearchAds360Links`
7257
+ # call. Provide this to retrieve the subsequent page.
7258
+ #
7259
+ # When paginating, all other parameters provided to
7260
+ # `ListSearchAds360Links` must match the call that provided the
7261
+ # page token.
7220
7262
  #
7221
7263
  # @yield [response, operation] Access the result along with the RPC operation
7222
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7264
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>]
7223
7265
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
7224
7266
  #
7225
- # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7267
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>]
7226
7268
  #
7227
7269
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
7228
7270
  #
@@ -7233,24 +7275,28 @@ module Google
7233
7275
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7234
7276
  #
7235
7277
  # # Create a request. To set request fields, pass in keyword arguments.
7236
- # request = Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest.new
7278
+ # request = Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest.new
7237
7279
  #
7238
- # # Call the update_attribution_settings method.
7239
- # result = client.update_attribution_settings request
7280
+ # # Call the list_search_ads360_links method.
7281
+ # result = client.list_search_ads360_links request
7240
7282
  #
7241
- # # The returned object is of type Google::Analytics::Admin::V1alpha::AttributionSettings.
7242
- # p result
7283
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
7284
+ # # over elements, and API calls will be issued to fetch pages as needed.
7285
+ # result.each do |item|
7286
+ # # Each element is of type ::Google::Analytics::Admin::V1alpha::SearchAds360Link.
7287
+ # p item
7288
+ # end
7243
7289
  #
7244
- def update_attribution_settings request, options = nil
7290
+ def list_search_ads360_links request, options = nil
7245
7291
  raise ::ArgumentError, "request must be provided" if request.nil?
7246
7292
 
7247
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest
7293
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest
7248
7294
 
7249
7295
  # Converts hash and nil to an options object
7250
7296
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7251
7297
 
7252
7298
  # Customize the options with defaults
7253
- metadata = @config.rpcs.update_attribution_settings.metadata.to_h
7299
+ metadata = @config.rpcs.list_search_ads360_links.metadata.to_h
7254
7300
 
7255
7301
  # Set x-goog-api-client and x-goog-user-project headers
7256
7302
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -7259,22 +7305,23 @@ module Google
7259
7305
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7260
7306
 
7261
7307
  header_params = {}
7262
- if request.attribution_settings&.name
7263
- header_params["attribution_settings.name"] = request.attribution_settings.name
7308
+ if request.parent
7309
+ header_params["parent"] = request.parent
7264
7310
  end
7265
7311
 
7266
7312
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7267
7313
  metadata[:"x-goog-request-params"] ||= request_params_header
7268
7314
 
7269
- options.apply_defaults timeout: @config.rpcs.update_attribution_settings.timeout,
7315
+ options.apply_defaults timeout: @config.rpcs.list_search_ads360_links.timeout,
7270
7316
  metadata: metadata,
7271
- retry_policy: @config.rpcs.update_attribution_settings.retry_policy
7317
+ retry_policy: @config.rpcs.list_search_ads360_links.retry_policy
7272
7318
 
7273
7319
  options.apply_defaults timeout: @config.timeout,
7274
7320
  metadata: @config.metadata,
7275
7321
  retry_policy: @config.retry_policy
7276
7322
 
7277
- @analytics_admin_service_stub.call_rpc :update_attribution_settings, request, options: options do |response, operation|
7323
+ @analytics_admin_service_stub.call_rpc :list_search_ads360_links, request, options: options do |response, operation|
7324
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_search_ads360_links, request, response, operation, options
7278
7325
  yield response, operation if block_given?
7279
7326
  return response
7280
7327
  end
@@ -7283,101 +7330,33 @@ module Google
7283
7330
  end
7284
7331
 
7285
7332
  ##
7286
- # Returns a customized report of data access records. The report provides
7287
- # records of each time a user reads Google Analytics reporting data. Access
7288
- # records are retained for up to 2 years.
7289
- #
7290
- # Data Access Reports can be requested for a property. The property must be
7291
- # in Google Analytics 360. This method is only available to Administrators.
7292
- #
7293
- # These data access records include GA4 UI Reporting, GA4 UI Explorations,
7294
- # GA4 Data API, and other products like Firebase & Admob that can retrieve
7295
- # data from Google Analytics through a linkage. These records don't include
7296
- # property configuration changes like adding a stream or changing a
7297
- # property's time zone. For configuration change history, see
7298
- # [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
7333
+ # Creates a SearchAds360Link.
7299
7334
  #
7300
- # @overload run_access_report(request, options = nil)
7301
- # Pass arguments to `run_access_report` via a request object, either of type
7302
- # {::Google::Analytics::Admin::V1alpha::RunAccessReportRequest} or an equivalent Hash.
7335
+ # @overload create_search_ads360_link(request, options = nil)
7336
+ # Pass arguments to `create_search_ads360_link` via a request object, either of type
7337
+ # {::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest} or an equivalent Hash.
7303
7338
  #
7304
- # @param request [::Google::Analytics::Admin::V1alpha::RunAccessReportRequest, ::Hash]
7339
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest, ::Hash]
7305
7340
  # A request object representing the call parameters. Required. To specify no
7306
7341
  # parameters, or to keep all the default parameter values, pass an empty Hash.
7307
7342
  # @param options [::Gapic::CallOptions, ::Hash]
7308
7343
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7309
7344
  #
7310
- # @overload run_access_report(entity: nil, dimensions: nil, metrics: nil, date_ranges: nil, dimension_filter: nil, metric_filter: nil, offset: nil, limit: nil, time_zone: nil, order_bys: nil, return_entity_quota: nil)
7311
- # Pass arguments to `run_access_report` via keyword arguments. Note that at
7345
+ # @overload create_search_ads360_link(parent: nil, search_ads_360_link: nil)
7346
+ # Pass arguments to `create_search_ads360_link` via keyword arguments. Note that at
7312
7347
  # least one keyword argument is required. To specify no parameters, or to keep all
7313
7348
  # the default parameter values, pass an empty Hash as a request object (see above).
7314
7349
  #
7315
- # @param entity [::String]
7316
- # The Data Access Report is requested for this property.
7317
- # For example if "123" is your GA4 property ID, then entity should be
7318
- # "properties/123".
7319
- # @param dimensions [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension, ::Hash>]
7320
- # The dimensions requested and displayed in the response. Requests are
7321
- # allowed up to 9 dimensions.
7322
- # @param metrics [::Array<::Google::Analytics::Admin::V1alpha::AccessMetric, ::Hash>]
7323
- # The metrics requested and displayed in the response. Requests are allowed
7324
- # up to 10 metrics.
7325
- # @param date_ranges [::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange, ::Hash>]
7326
- # Date ranges of access records to read. If multiple date ranges are
7327
- # requested, each response row will contain a zero based date range index. If
7328
- # two date ranges overlap, the access records for the overlapping days is
7329
- # included in the response rows for both date ranges. Requests are allowed up
7330
- # to 2 date ranges.
7331
- # @param dimension_filter [::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash]
7332
- # Dimension filters allow you to restrict report response to specific
7333
- # dimension values which match the filter. For example, filtering on access
7334
- # records of a single user. To learn more, see [Fundamentals of Dimension
7335
- # Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
7336
- # for examples. Metrics cannot be used in this filter.
7337
- # @param metric_filter [::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash]
7338
- # Metric filters allow you to restrict report response to specific metric
7339
- # values which match the filter. Metric filters are applied after aggregating
7340
- # the report's rows, similar to SQL having-clause. Dimensions cannot be used
7341
- # in this filter.
7342
- # @param offset [::Integer]
7343
- # The row count of the start row. The first row is counted as row 0. If
7344
- # offset is unspecified, it is treated as 0. If offset is zero, then this
7345
- # method will return the first page of results with `limit` entries.
7346
- #
7347
- # To learn more about this pagination parameter, see
7348
- # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
7349
- # @param limit [::Integer]
7350
- # The number of rows to return. If unspecified, 10,000 rows are returned. The
7351
- # API returns a maximum of 100,000 rows per request, no matter how many you
7352
- # ask for. `limit` must be positive.
7353
- #
7354
- # The API may return fewer rows than the requested `limit`, if there aren't
7355
- # as many remaining rows as the `limit`. For instance, there are fewer than
7356
- # 300 possible values for the dimension `country`, so when reporting on only
7357
- # `country`, you can't get more than 300 rows, even if you set `limit` to a
7358
- # higher value.
7359
- #
7360
- # To learn more about this pagination parameter, see
7361
- # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
7362
- # @param time_zone [::String]
7363
- # This request's time zone if specified. If unspecified, the property's time
7364
- # zone is used. The request's time zone is used to interpret the start & end
7365
- # dates of the report.
7366
- #
7367
- # Formatted as strings from the IANA Time Zone database
7368
- # (https://www.iana.org/time-zones); for example "America/New_York" or
7369
- # "Asia/Tokyo".
7370
- # @param order_bys [::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy, ::Hash>]
7371
- # Specifies how rows are ordered in the response.
7372
- # @param return_entity_quota [::Boolean]
7373
- # Toggles whether to return the current state of this Analytics Property's
7374
- # quota. Quota is returned in [AccessQuota](#AccessQuota).
7350
+ # @param parent [::String]
7351
+ # Required. Example format: properties/1234
7352
+ # @param search_ads_360_link [::Google::Analytics::Admin::V1alpha::SearchAds360Link, ::Hash]
7353
+ # Required. The SearchAds360Link to create.
7375
7354
  #
7376
7355
  # @yield [response, operation] Access the result along with the RPC operation
7377
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
7356
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
7378
7357
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
7379
7358
  #
7380
- # @return [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
7359
+ # @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
7381
7360
  #
7382
7361
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
7383
7362
  #
@@ -7388,24 +7367,24 @@ module Google
7388
7367
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7389
7368
  #
7390
7369
  # # Create a request. To set request fields, pass in keyword arguments.
7391
- # request = Google::Analytics::Admin::V1alpha::RunAccessReportRequest.new
7370
+ # request = Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest.new
7392
7371
  #
7393
- # # Call the run_access_report method.
7394
- # result = client.run_access_report request
7372
+ # # Call the create_search_ads360_link method.
7373
+ # result = client.create_search_ads360_link request
7395
7374
  #
7396
- # # The returned object is of type Google::Analytics::Admin::V1alpha::RunAccessReportResponse.
7375
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::SearchAds360Link.
7397
7376
  # p result
7398
7377
  #
7399
- def run_access_report request, options = nil
7378
+ def create_search_ads360_link request, options = nil
7400
7379
  raise ::ArgumentError, "request must be provided" if request.nil?
7401
7380
 
7402
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::RunAccessReportRequest
7381
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest
7403
7382
 
7404
7383
  # Converts hash and nil to an options object
7405
7384
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7406
7385
 
7407
7386
  # Customize the options with defaults
7408
- metadata = @config.rpcs.run_access_report.metadata.to_h
7387
+ metadata = @config.rpcs.create_search_ads360_link.metadata.to_h
7409
7388
 
7410
7389
  # Set x-goog-api-client and x-goog-user-project headers
7411
7390
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -7414,22 +7393,22 @@ module Google
7414
7393
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7415
7394
 
7416
7395
  header_params = {}
7417
- if request.entity
7418
- header_params["entity"] = request.entity
7396
+ if request.parent
7397
+ header_params["parent"] = request.parent
7419
7398
  end
7420
7399
 
7421
7400
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7422
7401
  metadata[:"x-goog-request-params"] ||= request_params_header
7423
7402
 
7424
- options.apply_defaults timeout: @config.rpcs.run_access_report.timeout,
7403
+ options.apply_defaults timeout: @config.rpcs.create_search_ads360_link.timeout,
7425
7404
  metadata: metadata,
7426
- retry_policy: @config.rpcs.run_access_report.retry_policy
7405
+ retry_policy: @config.rpcs.create_search_ads360_link.retry_policy
7427
7406
 
7428
7407
  options.apply_defaults timeout: @config.timeout,
7429
7408
  metadata: @config.metadata,
7430
7409
  retry_policy: @config.retry_policy
7431
7410
 
7432
- @analytics_admin_service_stub.call_rpc :run_access_report, request, options: options do |response, operation|
7411
+ @analytics_admin_service_stub.call_rpc :create_search_ads360_link, request, options: options do |response, operation|
7433
7412
  yield response, operation if block_given?
7434
7413
  return response
7435
7414
  end
@@ -7438,70 +7417,2209 @@ module Google
7438
7417
  end
7439
7418
 
7440
7419
  ##
7441
- # Configuration class for the AnalyticsAdminService API.
7420
+ # Deletes a SearchAds360Link on a property.
7442
7421
  #
7443
- # This class represents the configuration for AnalyticsAdminService,
7444
- # providing control over timeouts, retry behavior, logging, transport
7445
- # parameters, and other low-level controls. Certain parameters can also be
7446
- # applied individually to specific RPCs. See
7447
- # {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
7448
- # for a list of RPCs that can be configured independently.
7422
+ # @overload delete_search_ads360_link(request, options = nil)
7423
+ # Pass arguments to `delete_search_ads360_link` via a request object, either of type
7424
+ # {::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest} or an equivalent Hash.
7449
7425
  #
7450
- # Configuration can be applied globally to all clients, or to a single client
7451
- # on construction.
7426
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest, ::Hash]
7427
+ # A request object representing the call parameters. Required. To specify no
7428
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
7429
+ # @param options [::Gapic::CallOptions, ::Hash]
7430
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7452
7431
  #
7453
- # @example
7432
+ # @overload delete_search_ads360_link(name: nil)
7433
+ # Pass arguments to `delete_search_ads360_link` via keyword arguments. Note that at
7434
+ # least one keyword argument is required. To specify no parameters, or to keep all
7435
+ # the default parameter values, pass an empty Hash as a request object (see above).
7454
7436
  #
7455
- # # Modify the global config, setting the timeout for
7456
- # # get_account to 20 seconds,
7457
- # # and all remaining timeouts to 10 seconds.
7458
- # ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
7459
- # config.timeout = 10.0
7460
- # config.rpcs.get_account.timeout = 20.0
7461
- # end
7437
+ # @param name [::String]
7438
+ # Required. The name of the SearchAds360Link to delete.
7439
+ # Example format: properties/1234/SearchAds360Links/5678
7462
7440
  #
7463
- # # Apply the above configuration only to a new client.
7464
- # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
7465
- # config.timeout = 10.0
7466
- # config.rpcs.get_account.timeout = 20.0
7467
- # end
7441
+ # @yield [response, operation] Access the result along with the RPC operation
7442
+ # @yieldparam response [::Google::Protobuf::Empty]
7443
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
7468
7444
  #
7469
- # @!attribute [rw] endpoint
7470
- # The hostname or hostname:port of the service endpoint.
7471
- # Defaults to `"analyticsadmin.googleapis.com"`.
7472
- # @return [::String]
7473
- # @!attribute [rw] credentials
7474
- # Credentials to send with calls. You may provide any of the following types:
7475
- # * (`String`) The path to a service account key file in JSON format
7476
- # * (`Hash`) A service account key as a Hash
7477
- # * (`Google::Auth::Credentials`) A googleauth credentials object
7478
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
7479
- # * (`Signet::OAuth2::Client`) A signet oauth2 client object
7480
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
7481
- # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
7482
- # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
7483
- # * (`nil`) indicating no credentials
7484
- # @return [::Object]
7485
- # @!attribute [rw] scope
7486
- # The OAuth scopes
7487
- # @return [::Array<::String>]
7488
- # @!attribute [rw] lib_name
7489
- # The library name as recorded in instrumentation and logging
7490
- # @return [::String]
7491
- # @!attribute [rw] lib_version
7492
- # The library version as recorded in instrumentation and logging
7493
- # @return [::String]
7494
- # @!attribute [rw] channel_args
7495
- # Extra parameters passed to the gRPC channel. Note: this is ignored if a
7496
- # `GRPC::Core::Channel` object is provided as the credential.
7497
- # @return [::Hash]
7498
- # @!attribute [rw] interceptors
7499
- # An array of interceptors that are run before calls are executed.
7500
- # @return [::Array<::GRPC::ClientInterceptor>]
7501
- # @!attribute [rw] timeout
7502
- # The call timeout in seconds.
7503
- # @return [::Numeric]
7504
- # @!attribute [rw] metadata
7445
+ # @return [::Google::Protobuf::Empty]
7446
+ #
7447
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
7448
+ #
7449
+ # @example Basic example
7450
+ # require "google/analytics/admin/v1alpha"
7451
+ #
7452
+ # # Create a client object. The client can be reused for multiple calls.
7453
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7454
+ #
7455
+ # # Create a request. To set request fields, pass in keyword arguments.
7456
+ # request = Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest.new
7457
+ #
7458
+ # # Call the delete_search_ads360_link method.
7459
+ # result = client.delete_search_ads360_link request
7460
+ #
7461
+ # # The returned object is of type Google::Protobuf::Empty.
7462
+ # p result
7463
+ #
7464
+ def delete_search_ads360_link request, options = nil
7465
+ raise ::ArgumentError, "request must be provided" if request.nil?
7466
+
7467
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest
7468
+
7469
+ # Converts hash and nil to an options object
7470
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7471
+
7472
+ # Customize the options with defaults
7473
+ metadata = @config.rpcs.delete_search_ads360_link.metadata.to_h
7474
+
7475
+ # Set x-goog-api-client and x-goog-user-project headers
7476
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
7477
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
7478
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
7479
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7480
+
7481
+ header_params = {}
7482
+ if request.name
7483
+ header_params["name"] = request.name
7484
+ end
7485
+
7486
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7487
+ metadata[:"x-goog-request-params"] ||= request_params_header
7488
+
7489
+ options.apply_defaults timeout: @config.rpcs.delete_search_ads360_link.timeout,
7490
+ metadata: metadata,
7491
+ retry_policy: @config.rpcs.delete_search_ads360_link.retry_policy
7492
+
7493
+ options.apply_defaults timeout: @config.timeout,
7494
+ metadata: @config.metadata,
7495
+ retry_policy: @config.retry_policy
7496
+
7497
+ @analytics_admin_service_stub.call_rpc :delete_search_ads360_link, request, options: options do |response, operation|
7498
+ yield response, operation if block_given?
7499
+ return response
7500
+ end
7501
+ rescue ::GRPC::BadStatus => e
7502
+ raise ::Google::Cloud::Error.from_error(e)
7503
+ end
7504
+
7505
+ ##
7506
+ # Updates a SearchAds360Link on a property.
7507
+ #
7508
+ # @overload update_search_ads360_link(request, options = nil)
7509
+ # Pass arguments to `update_search_ads360_link` via a request object, either of type
7510
+ # {::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest} or an equivalent Hash.
7511
+ #
7512
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest, ::Hash]
7513
+ # A request object representing the call parameters. Required. To specify no
7514
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
7515
+ # @param options [::Gapic::CallOptions, ::Hash]
7516
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7517
+ #
7518
+ # @overload update_search_ads360_link(search_ads_360_link: nil, update_mask: nil)
7519
+ # Pass arguments to `update_search_ads360_link` via keyword arguments. Note that at
7520
+ # least one keyword argument is required. To specify no parameters, or to keep all
7521
+ # the default parameter values, pass an empty Hash as a request object (see above).
7522
+ #
7523
+ # @param search_ads_360_link [::Google::Analytics::Admin::V1alpha::SearchAds360Link, ::Hash]
7524
+ # The SearchAds360Link to update
7525
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
7526
+ # Required. The list of fields to be updated. Omitted fields will not be
7527
+ # updated. To replace the entire entity, use one path with the string "*" to
7528
+ # match all fields.
7529
+ #
7530
+ # @yield [response, operation] Access the result along with the RPC operation
7531
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
7532
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
7533
+ #
7534
+ # @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
7535
+ #
7536
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
7537
+ #
7538
+ # @example Basic example
7539
+ # require "google/analytics/admin/v1alpha"
7540
+ #
7541
+ # # Create a client object. The client can be reused for multiple calls.
7542
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7543
+ #
7544
+ # # Create a request. To set request fields, pass in keyword arguments.
7545
+ # request = Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest.new
7546
+ #
7547
+ # # Call the update_search_ads360_link method.
7548
+ # result = client.update_search_ads360_link request
7549
+ #
7550
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::SearchAds360Link.
7551
+ # p result
7552
+ #
7553
+ def update_search_ads360_link request, options = nil
7554
+ raise ::ArgumentError, "request must be provided" if request.nil?
7555
+
7556
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest
7557
+
7558
+ # Converts hash and nil to an options object
7559
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7560
+
7561
+ # Customize the options with defaults
7562
+ metadata = @config.rpcs.update_search_ads360_link.metadata.to_h
7563
+
7564
+ # Set x-goog-api-client and x-goog-user-project headers
7565
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
7566
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
7567
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
7568
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7569
+
7570
+ header_params = {}
7571
+ if request.search_ads_360_link&.name
7572
+ header_params["search_ads_360_link.name"] = request.search_ads_360_link.name
7573
+ end
7574
+
7575
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7576
+ metadata[:"x-goog-request-params"] ||= request_params_header
7577
+
7578
+ options.apply_defaults timeout: @config.rpcs.update_search_ads360_link.timeout,
7579
+ metadata: metadata,
7580
+ retry_policy: @config.rpcs.update_search_ads360_link.retry_policy
7581
+
7582
+ options.apply_defaults timeout: @config.timeout,
7583
+ metadata: @config.metadata,
7584
+ retry_policy: @config.retry_policy
7585
+
7586
+ @analytics_admin_service_stub.call_rpc :update_search_ads360_link, request, options: options do |response, operation|
7587
+ yield response, operation if block_given?
7588
+ return response
7589
+ end
7590
+ rescue ::GRPC::BadStatus => e
7591
+ raise ::Google::Cloud::Error.from_error(e)
7592
+ end
7593
+
7594
+ ##
7595
+ # Lookup for a AttributionSettings singleton.
7596
+ #
7597
+ # @overload get_attribution_settings(request, options = nil)
7598
+ # Pass arguments to `get_attribution_settings` via a request object, either of type
7599
+ # {::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest} or an equivalent Hash.
7600
+ #
7601
+ # @param request [::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest, ::Hash]
7602
+ # A request object representing the call parameters. Required. To specify no
7603
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
7604
+ # @param options [::Gapic::CallOptions, ::Hash]
7605
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7606
+ #
7607
+ # @overload get_attribution_settings(name: nil)
7608
+ # Pass arguments to `get_attribution_settings` via keyword arguments. Note that at
7609
+ # least one keyword argument is required. To specify no parameters, or to keep all
7610
+ # the default parameter values, pass an empty Hash as a request object (see above).
7611
+ #
7612
+ # @param name [::String]
7613
+ # Required. The name of the attribution settings to retrieve.
7614
+ # Format: properties/\\{property}/attributionSettings
7615
+ #
7616
+ # @yield [response, operation] Access the result along with the RPC operation
7617
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7618
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
7619
+ #
7620
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7621
+ #
7622
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
7623
+ #
7624
+ # @example Basic example
7625
+ # require "google/analytics/admin/v1alpha"
7626
+ #
7627
+ # # Create a client object. The client can be reused for multiple calls.
7628
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7629
+ #
7630
+ # # Create a request. To set request fields, pass in keyword arguments.
7631
+ # request = Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest.new
7632
+ #
7633
+ # # Call the get_attribution_settings method.
7634
+ # result = client.get_attribution_settings request
7635
+ #
7636
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::AttributionSettings.
7637
+ # p result
7638
+ #
7639
+ def get_attribution_settings request, options = nil
7640
+ raise ::ArgumentError, "request must be provided" if request.nil?
7641
+
7642
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest
7643
+
7644
+ # Converts hash and nil to an options object
7645
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7646
+
7647
+ # Customize the options with defaults
7648
+ metadata = @config.rpcs.get_attribution_settings.metadata.to_h
7649
+
7650
+ # Set x-goog-api-client and x-goog-user-project headers
7651
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
7652
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
7653
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
7654
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7655
+
7656
+ header_params = {}
7657
+ if request.name
7658
+ header_params["name"] = request.name
7659
+ end
7660
+
7661
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7662
+ metadata[:"x-goog-request-params"] ||= request_params_header
7663
+
7664
+ options.apply_defaults timeout: @config.rpcs.get_attribution_settings.timeout,
7665
+ metadata: metadata,
7666
+ retry_policy: @config.rpcs.get_attribution_settings.retry_policy
7667
+
7668
+ options.apply_defaults timeout: @config.timeout,
7669
+ metadata: @config.metadata,
7670
+ retry_policy: @config.retry_policy
7671
+
7672
+ @analytics_admin_service_stub.call_rpc :get_attribution_settings, request, options: options do |response, operation|
7673
+ yield response, operation if block_given?
7674
+ return response
7675
+ end
7676
+ rescue ::GRPC::BadStatus => e
7677
+ raise ::Google::Cloud::Error.from_error(e)
7678
+ end
7679
+
7680
+ ##
7681
+ # Updates attribution settings on a property.
7682
+ #
7683
+ # @overload update_attribution_settings(request, options = nil)
7684
+ # Pass arguments to `update_attribution_settings` via a request object, either of type
7685
+ # {::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest} or an equivalent Hash.
7686
+ #
7687
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest, ::Hash]
7688
+ # A request object representing the call parameters. Required. To specify no
7689
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
7690
+ # @param options [::Gapic::CallOptions, ::Hash]
7691
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7692
+ #
7693
+ # @overload update_attribution_settings(attribution_settings: nil, update_mask: nil)
7694
+ # Pass arguments to `update_attribution_settings` via keyword arguments. Note that at
7695
+ # least one keyword argument is required. To specify no parameters, or to keep all
7696
+ # the default parameter values, pass an empty Hash as a request object (see above).
7697
+ #
7698
+ # @param attribution_settings [::Google::Analytics::Admin::V1alpha::AttributionSettings, ::Hash]
7699
+ # Required. The attribution settings to update.
7700
+ # The `name` field is used to identify the settings to be updated.
7701
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
7702
+ # Required. The list of fields to be updated. Field names must be in snake
7703
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
7704
+ # replace the entire entity, use one path with the string "*" to match all
7705
+ # fields.
7706
+ #
7707
+ # @yield [response, operation] Access the result along with the RPC operation
7708
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7709
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
7710
+ #
7711
+ # @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
7712
+ #
7713
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
7714
+ #
7715
+ # @example Basic example
7716
+ # require "google/analytics/admin/v1alpha"
7717
+ #
7718
+ # # Create a client object. The client can be reused for multiple calls.
7719
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7720
+ #
7721
+ # # Create a request. To set request fields, pass in keyword arguments.
7722
+ # request = Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest.new
7723
+ #
7724
+ # # Call the update_attribution_settings method.
7725
+ # result = client.update_attribution_settings request
7726
+ #
7727
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::AttributionSettings.
7728
+ # p result
7729
+ #
7730
+ def update_attribution_settings request, options = nil
7731
+ raise ::ArgumentError, "request must be provided" if request.nil?
7732
+
7733
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest
7734
+
7735
+ # Converts hash and nil to an options object
7736
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7737
+
7738
+ # Customize the options with defaults
7739
+ metadata = @config.rpcs.update_attribution_settings.metadata.to_h
7740
+
7741
+ # Set x-goog-api-client and x-goog-user-project headers
7742
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
7743
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
7744
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
7745
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7746
+
7747
+ header_params = {}
7748
+ if request.attribution_settings&.name
7749
+ header_params["attribution_settings.name"] = request.attribution_settings.name
7750
+ end
7751
+
7752
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7753
+ metadata[:"x-goog-request-params"] ||= request_params_header
7754
+
7755
+ options.apply_defaults timeout: @config.rpcs.update_attribution_settings.timeout,
7756
+ metadata: metadata,
7757
+ retry_policy: @config.rpcs.update_attribution_settings.retry_policy
7758
+
7759
+ options.apply_defaults timeout: @config.timeout,
7760
+ metadata: @config.metadata,
7761
+ retry_policy: @config.retry_policy
7762
+
7763
+ @analytics_admin_service_stub.call_rpc :update_attribution_settings, request, options: options do |response, operation|
7764
+ yield response, operation if block_given?
7765
+ return response
7766
+ end
7767
+ rescue ::GRPC::BadStatus => e
7768
+ raise ::Google::Cloud::Error.from_error(e)
7769
+ end
7770
+
7771
+ ##
7772
+ # Returns a customized report of data access records. The report provides
7773
+ # records of each time a user reads Google Analytics reporting data. Access
7774
+ # records are retained for up to 2 years.
7775
+ #
7776
+ # Data Access Reports can be requested for a property. The property must be
7777
+ # in Google Analytics 360. This method is only available to Administrators.
7778
+ #
7779
+ # These data access records include GA4 UI Reporting, GA4 UI Explorations,
7780
+ # GA4 Data API, and other products like Firebase & Admob that can retrieve
7781
+ # data from Google Analytics through a linkage. These records don't include
7782
+ # property configuration changes like adding a stream or changing a
7783
+ # property's time zone. For configuration change history, see
7784
+ # [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
7785
+ #
7786
+ # @overload run_access_report(request, options = nil)
7787
+ # Pass arguments to `run_access_report` via a request object, either of type
7788
+ # {::Google::Analytics::Admin::V1alpha::RunAccessReportRequest} or an equivalent Hash.
7789
+ #
7790
+ # @param request [::Google::Analytics::Admin::V1alpha::RunAccessReportRequest, ::Hash]
7791
+ # A request object representing the call parameters. Required. To specify no
7792
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
7793
+ # @param options [::Gapic::CallOptions, ::Hash]
7794
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7795
+ #
7796
+ # @overload run_access_report(entity: nil, dimensions: nil, metrics: nil, date_ranges: nil, dimension_filter: nil, metric_filter: nil, offset: nil, limit: nil, time_zone: nil, order_bys: nil, return_entity_quota: nil)
7797
+ # Pass arguments to `run_access_report` via keyword arguments. Note that at
7798
+ # least one keyword argument is required. To specify no parameters, or to keep all
7799
+ # the default parameter values, pass an empty Hash as a request object (see above).
7800
+ #
7801
+ # @param entity [::String]
7802
+ # The Data Access Report is requested for this property.
7803
+ # For example if "123" is your GA4 property ID, then entity should be
7804
+ # "properties/123".
7805
+ # @param dimensions [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension, ::Hash>]
7806
+ # The dimensions requested and displayed in the response. Requests are
7807
+ # allowed up to 9 dimensions.
7808
+ # @param metrics [::Array<::Google::Analytics::Admin::V1alpha::AccessMetric, ::Hash>]
7809
+ # The metrics requested and displayed in the response. Requests are allowed
7810
+ # up to 10 metrics.
7811
+ # @param date_ranges [::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange, ::Hash>]
7812
+ # Date ranges of access records to read. If multiple date ranges are
7813
+ # requested, each response row will contain a zero based date range index. If
7814
+ # two date ranges overlap, the access records for the overlapping days is
7815
+ # included in the response rows for both date ranges. Requests are allowed up
7816
+ # to 2 date ranges.
7817
+ # @param dimension_filter [::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash]
7818
+ # Dimension filters let you restrict report response to specific
7819
+ # dimension values which match the filter. For example, filtering on access
7820
+ # records of a single user. To learn more, see [Fundamentals of Dimension
7821
+ # Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
7822
+ # for examples. Metrics cannot be used in this filter.
7823
+ # @param metric_filter [::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash]
7824
+ # Metric filters allow you to restrict report response to specific metric
7825
+ # values which match the filter. Metric filters are applied after aggregating
7826
+ # the report's rows, similar to SQL having-clause. Dimensions cannot be used
7827
+ # in this filter.
7828
+ # @param offset [::Integer]
7829
+ # The row count of the start row. The first row is counted as row 0. If
7830
+ # offset is unspecified, it is treated as 0. If offset is zero, then this
7831
+ # method will return the first page of results with `limit` entries.
7832
+ #
7833
+ # To learn more about this pagination parameter, see
7834
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
7835
+ # @param limit [::Integer]
7836
+ # The number of rows to return. If unspecified, 10,000 rows are returned. The
7837
+ # API returns a maximum of 100,000 rows per request, no matter how many you
7838
+ # ask for. `limit` must be positive.
7839
+ #
7840
+ # The API may return fewer rows than the requested `limit`, if there aren't
7841
+ # as many remaining rows as the `limit`. For instance, there are fewer than
7842
+ # 300 possible values for the dimension `country`, so when reporting on only
7843
+ # `country`, you can't get more than 300 rows, even if you set `limit` to a
7844
+ # higher value.
7845
+ #
7846
+ # To learn more about this pagination parameter, see
7847
+ # [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
7848
+ # @param time_zone [::String]
7849
+ # This request's time zone if specified. If unspecified, the property's time
7850
+ # zone is used. The request's time zone is used to interpret the start & end
7851
+ # dates of the report.
7852
+ #
7853
+ # Formatted as strings from the IANA Time Zone database
7854
+ # (https://www.iana.org/time-zones); for example "America/New_York" or
7855
+ # "Asia/Tokyo".
7856
+ # @param order_bys [::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy, ::Hash>]
7857
+ # Specifies how rows are ordered in the response.
7858
+ # @param return_entity_quota [::Boolean]
7859
+ # Toggles whether to return the current state of this Analytics Property's
7860
+ # quota. Quota is returned in [AccessQuota](#AccessQuota).
7861
+ #
7862
+ # @yield [response, operation] Access the result along with the RPC operation
7863
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
7864
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
7865
+ #
7866
+ # @return [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
7867
+ #
7868
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
7869
+ #
7870
+ # @example Basic example
7871
+ # require "google/analytics/admin/v1alpha"
7872
+ #
7873
+ # # Create a client object. The client can be reused for multiple calls.
7874
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7875
+ #
7876
+ # # Create a request. To set request fields, pass in keyword arguments.
7877
+ # request = Google::Analytics::Admin::V1alpha::RunAccessReportRequest.new
7878
+ #
7879
+ # # Call the run_access_report method.
7880
+ # result = client.run_access_report request
7881
+ #
7882
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::RunAccessReportResponse.
7883
+ # p result
7884
+ #
7885
+ def run_access_report request, options = nil
7886
+ raise ::ArgumentError, "request must be provided" if request.nil?
7887
+
7888
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::RunAccessReportRequest
7889
+
7890
+ # Converts hash and nil to an options object
7891
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7892
+
7893
+ # Customize the options with defaults
7894
+ metadata = @config.rpcs.run_access_report.metadata.to_h
7895
+
7896
+ # Set x-goog-api-client and x-goog-user-project headers
7897
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
7898
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
7899
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
7900
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7901
+
7902
+ header_params = {}
7903
+ if request.entity
7904
+ header_params["entity"] = request.entity
7905
+ end
7906
+
7907
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7908
+ metadata[:"x-goog-request-params"] ||= request_params_header
7909
+
7910
+ options.apply_defaults timeout: @config.rpcs.run_access_report.timeout,
7911
+ metadata: metadata,
7912
+ retry_policy: @config.rpcs.run_access_report.retry_policy
7913
+
7914
+ options.apply_defaults timeout: @config.timeout,
7915
+ metadata: @config.metadata,
7916
+ retry_policy: @config.retry_policy
7917
+
7918
+ @analytics_admin_service_stub.call_rpc :run_access_report, request, options: options do |response, operation|
7919
+ yield response, operation if block_given?
7920
+ return response
7921
+ end
7922
+ rescue ::GRPC::BadStatus => e
7923
+ raise ::Google::Cloud::Error.from_error(e)
7924
+ end
7925
+
7926
+ ##
7927
+ # Creates an access binding on an account or property.
7928
+ #
7929
+ # @overload create_access_binding(request, options = nil)
7930
+ # Pass arguments to `create_access_binding` via a request object, either of type
7931
+ # {::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest} or an equivalent Hash.
7932
+ #
7933
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest, ::Hash]
7934
+ # A request object representing the call parameters. Required. To specify no
7935
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
7936
+ # @param options [::Gapic::CallOptions, ::Hash]
7937
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7938
+ #
7939
+ # @overload create_access_binding(parent: nil, access_binding: nil)
7940
+ # Pass arguments to `create_access_binding` via keyword arguments. Note that at
7941
+ # least one keyword argument is required. To specify no parameters, or to keep all
7942
+ # the default parameter values, pass an empty Hash as a request object (see above).
7943
+ #
7944
+ # @param parent [::String]
7945
+ # Required. Formats:
7946
+ # - accounts/\\{account}
7947
+ # - properties/\\{property}
7948
+ # @param access_binding [::Google::Analytics::Admin::V1alpha::AccessBinding, ::Hash]
7949
+ # Required. The access binding to create.
7950
+ #
7951
+ # @yield [response, operation] Access the result along with the RPC operation
7952
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::AccessBinding]
7953
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
7954
+ #
7955
+ # @return [::Google::Analytics::Admin::V1alpha::AccessBinding]
7956
+ #
7957
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
7958
+ #
7959
+ # @example Basic example
7960
+ # require "google/analytics/admin/v1alpha"
7961
+ #
7962
+ # # Create a client object. The client can be reused for multiple calls.
7963
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
7964
+ #
7965
+ # # Create a request. To set request fields, pass in keyword arguments.
7966
+ # request = Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest.new
7967
+ #
7968
+ # # Call the create_access_binding method.
7969
+ # result = client.create_access_binding request
7970
+ #
7971
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::AccessBinding.
7972
+ # p result
7973
+ #
7974
+ def create_access_binding request, options = nil
7975
+ raise ::ArgumentError, "request must be provided" if request.nil?
7976
+
7977
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest
7978
+
7979
+ # Converts hash and nil to an options object
7980
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7981
+
7982
+ # Customize the options with defaults
7983
+ metadata = @config.rpcs.create_access_binding.metadata.to_h
7984
+
7985
+ # Set x-goog-api-client and x-goog-user-project headers
7986
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
7987
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
7988
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
7989
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7990
+
7991
+ header_params = {}
7992
+ if request.parent
7993
+ header_params["parent"] = request.parent
7994
+ end
7995
+
7996
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7997
+ metadata[:"x-goog-request-params"] ||= request_params_header
7998
+
7999
+ options.apply_defaults timeout: @config.rpcs.create_access_binding.timeout,
8000
+ metadata: metadata,
8001
+ retry_policy: @config.rpcs.create_access_binding.retry_policy
8002
+
8003
+ options.apply_defaults timeout: @config.timeout,
8004
+ metadata: @config.metadata,
8005
+ retry_policy: @config.retry_policy
8006
+
8007
+ @analytics_admin_service_stub.call_rpc :create_access_binding, request, options: options do |response, operation|
8008
+ yield response, operation if block_given?
8009
+ return response
8010
+ end
8011
+ rescue ::GRPC::BadStatus => e
8012
+ raise ::Google::Cloud::Error.from_error(e)
8013
+ end
8014
+
8015
+ ##
8016
+ # Gets information about an access binding.
8017
+ #
8018
+ # @overload get_access_binding(request, options = nil)
8019
+ # Pass arguments to `get_access_binding` via a request object, either of type
8020
+ # {::Google::Analytics::Admin::V1alpha::GetAccessBindingRequest} or an equivalent Hash.
8021
+ #
8022
+ # @param request [::Google::Analytics::Admin::V1alpha::GetAccessBindingRequest, ::Hash]
8023
+ # A request object representing the call parameters. Required. To specify no
8024
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8025
+ # @param options [::Gapic::CallOptions, ::Hash]
8026
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8027
+ #
8028
+ # @overload get_access_binding(name: nil)
8029
+ # Pass arguments to `get_access_binding` via keyword arguments. Note that at
8030
+ # least one keyword argument is required. To specify no parameters, or to keep all
8031
+ # the default parameter values, pass an empty Hash as a request object (see above).
8032
+ #
8033
+ # @param name [::String]
8034
+ # Required. The name of the access binding to retrieve.
8035
+ # Formats:
8036
+ # - accounts/\\{account}/accessBindings/\\{accessBinding}
8037
+ # - properties/\\{property}/accessBindings/\\{accessBinding}
8038
+ #
8039
+ # @yield [response, operation] Access the result along with the RPC operation
8040
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::AccessBinding]
8041
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8042
+ #
8043
+ # @return [::Google::Analytics::Admin::V1alpha::AccessBinding]
8044
+ #
8045
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8046
+ #
8047
+ # @example Basic example
8048
+ # require "google/analytics/admin/v1alpha"
8049
+ #
8050
+ # # Create a client object. The client can be reused for multiple calls.
8051
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8052
+ #
8053
+ # # Create a request. To set request fields, pass in keyword arguments.
8054
+ # request = Google::Analytics::Admin::V1alpha::GetAccessBindingRequest.new
8055
+ #
8056
+ # # Call the get_access_binding method.
8057
+ # result = client.get_access_binding request
8058
+ #
8059
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::AccessBinding.
8060
+ # p result
8061
+ #
8062
+ def get_access_binding request, options = nil
8063
+ raise ::ArgumentError, "request must be provided" if request.nil?
8064
+
8065
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAccessBindingRequest
8066
+
8067
+ # Converts hash and nil to an options object
8068
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8069
+
8070
+ # Customize the options with defaults
8071
+ metadata = @config.rpcs.get_access_binding.metadata.to_h
8072
+
8073
+ # Set x-goog-api-client and x-goog-user-project headers
8074
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8075
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8076
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8077
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8078
+
8079
+ header_params = {}
8080
+ if request.name
8081
+ header_params["name"] = request.name
8082
+ end
8083
+
8084
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8085
+ metadata[:"x-goog-request-params"] ||= request_params_header
8086
+
8087
+ options.apply_defaults timeout: @config.rpcs.get_access_binding.timeout,
8088
+ metadata: metadata,
8089
+ retry_policy: @config.rpcs.get_access_binding.retry_policy
8090
+
8091
+ options.apply_defaults timeout: @config.timeout,
8092
+ metadata: @config.metadata,
8093
+ retry_policy: @config.retry_policy
8094
+
8095
+ @analytics_admin_service_stub.call_rpc :get_access_binding, request, options: options do |response, operation|
8096
+ yield response, operation if block_given?
8097
+ return response
8098
+ end
8099
+ rescue ::GRPC::BadStatus => e
8100
+ raise ::Google::Cloud::Error.from_error(e)
8101
+ end
8102
+
8103
+ ##
8104
+ # Updates an access binding on an account or property.
8105
+ #
8106
+ # @overload update_access_binding(request, options = nil)
8107
+ # Pass arguments to `update_access_binding` via a request object, either of type
8108
+ # {::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest} or an equivalent Hash.
8109
+ #
8110
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest, ::Hash]
8111
+ # A request object representing the call parameters. Required. To specify no
8112
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8113
+ # @param options [::Gapic::CallOptions, ::Hash]
8114
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8115
+ #
8116
+ # @overload update_access_binding(access_binding: nil)
8117
+ # Pass arguments to `update_access_binding` via keyword arguments. Note that at
8118
+ # least one keyword argument is required. To specify no parameters, or to keep all
8119
+ # the default parameter values, pass an empty Hash as a request object (see above).
8120
+ #
8121
+ # @param access_binding [::Google::Analytics::Admin::V1alpha::AccessBinding, ::Hash]
8122
+ # Required. The access binding to update.
8123
+ #
8124
+ # @yield [response, operation] Access the result along with the RPC operation
8125
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::AccessBinding]
8126
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8127
+ #
8128
+ # @return [::Google::Analytics::Admin::V1alpha::AccessBinding]
8129
+ #
8130
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8131
+ #
8132
+ # @example Basic example
8133
+ # require "google/analytics/admin/v1alpha"
8134
+ #
8135
+ # # Create a client object. The client can be reused for multiple calls.
8136
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8137
+ #
8138
+ # # Create a request. To set request fields, pass in keyword arguments.
8139
+ # request = Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest.new
8140
+ #
8141
+ # # Call the update_access_binding method.
8142
+ # result = client.update_access_binding request
8143
+ #
8144
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::AccessBinding.
8145
+ # p result
8146
+ #
8147
+ def update_access_binding request, options = nil
8148
+ raise ::ArgumentError, "request must be provided" if request.nil?
8149
+
8150
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest
8151
+
8152
+ # Converts hash and nil to an options object
8153
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8154
+
8155
+ # Customize the options with defaults
8156
+ metadata = @config.rpcs.update_access_binding.metadata.to_h
8157
+
8158
+ # Set x-goog-api-client and x-goog-user-project headers
8159
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8160
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8161
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8162
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8163
+
8164
+ header_params = {}
8165
+ if request.access_binding&.name
8166
+ header_params["access_binding.name"] = request.access_binding.name
8167
+ end
8168
+
8169
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8170
+ metadata[:"x-goog-request-params"] ||= request_params_header
8171
+
8172
+ options.apply_defaults timeout: @config.rpcs.update_access_binding.timeout,
8173
+ metadata: metadata,
8174
+ retry_policy: @config.rpcs.update_access_binding.retry_policy
8175
+
8176
+ options.apply_defaults timeout: @config.timeout,
8177
+ metadata: @config.metadata,
8178
+ retry_policy: @config.retry_policy
8179
+
8180
+ @analytics_admin_service_stub.call_rpc :update_access_binding, request, options: options do |response, operation|
8181
+ yield response, operation if block_given?
8182
+ return response
8183
+ end
8184
+ rescue ::GRPC::BadStatus => e
8185
+ raise ::Google::Cloud::Error.from_error(e)
8186
+ end
8187
+
8188
+ ##
8189
+ # Deletes an access binding on an account or property.
8190
+ #
8191
+ # @overload delete_access_binding(request, options = nil)
8192
+ # Pass arguments to `delete_access_binding` via a request object, either of type
8193
+ # {::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest} or an equivalent Hash.
8194
+ #
8195
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest, ::Hash]
8196
+ # A request object representing the call parameters. Required. To specify no
8197
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8198
+ # @param options [::Gapic::CallOptions, ::Hash]
8199
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8200
+ #
8201
+ # @overload delete_access_binding(name: nil)
8202
+ # Pass arguments to `delete_access_binding` via keyword arguments. Note that at
8203
+ # least one keyword argument is required. To specify no parameters, or to keep all
8204
+ # the default parameter values, pass an empty Hash as a request object (see above).
8205
+ #
8206
+ # @param name [::String]
8207
+ # Required. Formats:
8208
+ # - accounts/\\{account}/accessBindings/\\{accessBinding}
8209
+ # - properties/\\{property}/accessBindings/\\{accessBinding}
8210
+ #
8211
+ # @yield [response, operation] Access the result along with the RPC operation
8212
+ # @yieldparam response [::Google::Protobuf::Empty]
8213
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8214
+ #
8215
+ # @return [::Google::Protobuf::Empty]
8216
+ #
8217
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8218
+ #
8219
+ # @example Basic example
8220
+ # require "google/analytics/admin/v1alpha"
8221
+ #
8222
+ # # Create a client object. The client can be reused for multiple calls.
8223
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8224
+ #
8225
+ # # Create a request. To set request fields, pass in keyword arguments.
8226
+ # request = Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest.new
8227
+ #
8228
+ # # Call the delete_access_binding method.
8229
+ # result = client.delete_access_binding request
8230
+ #
8231
+ # # The returned object is of type Google::Protobuf::Empty.
8232
+ # p result
8233
+ #
8234
+ def delete_access_binding request, options = nil
8235
+ raise ::ArgumentError, "request must be provided" if request.nil?
8236
+
8237
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest
8238
+
8239
+ # Converts hash and nil to an options object
8240
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8241
+
8242
+ # Customize the options with defaults
8243
+ metadata = @config.rpcs.delete_access_binding.metadata.to_h
8244
+
8245
+ # Set x-goog-api-client and x-goog-user-project headers
8246
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8247
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8248
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8249
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8250
+
8251
+ header_params = {}
8252
+ if request.name
8253
+ header_params["name"] = request.name
8254
+ end
8255
+
8256
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8257
+ metadata[:"x-goog-request-params"] ||= request_params_header
8258
+
8259
+ options.apply_defaults timeout: @config.rpcs.delete_access_binding.timeout,
8260
+ metadata: metadata,
8261
+ retry_policy: @config.rpcs.delete_access_binding.retry_policy
8262
+
8263
+ options.apply_defaults timeout: @config.timeout,
8264
+ metadata: @config.metadata,
8265
+ retry_policy: @config.retry_policy
8266
+
8267
+ @analytics_admin_service_stub.call_rpc :delete_access_binding, request, options: options do |response, operation|
8268
+ yield response, operation if block_given?
8269
+ return response
8270
+ end
8271
+ rescue ::GRPC::BadStatus => e
8272
+ raise ::Google::Cloud::Error.from_error(e)
8273
+ end
8274
+
8275
+ ##
8276
+ # Lists all access bindings on an account or property.
8277
+ #
8278
+ # @overload list_access_bindings(request, options = nil)
8279
+ # Pass arguments to `list_access_bindings` via a request object, either of type
8280
+ # {::Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest} or an equivalent Hash.
8281
+ #
8282
+ # @param request [::Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest, ::Hash]
8283
+ # A request object representing the call parameters. Required. To specify no
8284
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8285
+ # @param options [::Gapic::CallOptions, ::Hash]
8286
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8287
+ #
8288
+ # @overload list_access_bindings(parent: nil, page_size: nil, page_token: nil)
8289
+ # Pass arguments to `list_access_bindings` via keyword arguments. Note that at
8290
+ # least one keyword argument is required. To specify no parameters, or to keep all
8291
+ # the default parameter values, pass an empty Hash as a request object (see above).
8292
+ #
8293
+ # @param parent [::String]
8294
+ # Required. Formats:
8295
+ # - accounts/\\{account}
8296
+ # - properties/\\{property}
8297
+ # @param page_size [::Integer]
8298
+ # The maximum number of access bindings to return.
8299
+ # The service may return fewer than this value.
8300
+ # If unspecified, at most 200 access bindings will be returned.
8301
+ # The maximum value is 500; values above 500 will be coerced to 500.
8302
+ # @param page_token [::String]
8303
+ # A page token, received from a previous `ListAccessBindings` call.
8304
+ # Provide this to retrieve the subsequent page.
8305
+ # When paginating, all other parameters provided to `ListAccessBindings` must
8306
+ # match the call that provided the page token.
8307
+ #
8308
+ # @yield [response, operation] Access the result along with the RPC operation
8309
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>]
8310
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8311
+ #
8312
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>]
8313
+ #
8314
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8315
+ #
8316
+ # @example Basic example
8317
+ # require "google/analytics/admin/v1alpha"
8318
+ #
8319
+ # # Create a client object. The client can be reused for multiple calls.
8320
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8321
+ #
8322
+ # # Create a request. To set request fields, pass in keyword arguments.
8323
+ # request = Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest.new
8324
+ #
8325
+ # # Call the list_access_bindings method.
8326
+ # result = client.list_access_bindings request
8327
+ #
8328
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
8329
+ # # over elements, and API calls will be issued to fetch pages as needed.
8330
+ # result.each do |item|
8331
+ # # Each element is of type ::Google::Analytics::Admin::V1alpha::AccessBinding.
8332
+ # p item
8333
+ # end
8334
+ #
8335
+ def list_access_bindings request, options = nil
8336
+ raise ::ArgumentError, "request must be provided" if request.nil?
8337
+
8338
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest
8339
+
8340
+ # Converts hash and nil to an options object
8341
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8342
+
8343
+ # Customize the options with defaults
8344
+ metadata = @config.rpcs.list_access_bindings.metadata.to_h
8345
+
8346
+ # Set x-goog-api-client and x-goog-user-project headers
8347
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8348
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8349
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8350
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8351
+
8352
+ header_params = {}
8353
+ if request.parent
8354
+ header_params["parent"] = request.parent
8355
+ end
8356
+
8357
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8358
+ metadata[:"x-goog-request-params"] ||= request_params_header
8359
+
8360
+ options.apply_defaults timeout: @config.rpcs.list_access_bindings.timeout,
8361
+ metadata: metadata,
8362
+ retry_policy: @config.rpcs.list_access_bindings.retry_policy
8363
+
8364
+ options.apply_defaults timeout: @config.timeout,
8365
+ metadata: @config.metadata,
8366
+ retry_policy: @config.retry_policy
8367
+
8368
+ @analytics_admin_service_stub.call_rpc :list_access_bindings, request, options: options do |response, operation|
8369
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_access_bindings, request, response, operation, options
8370
+ yield response, operation if block_given?
8371
+ return response
8372
+ end
8373
+ rescue ::GRPC::BadStatus => e
8374
+ raise ::Google::Cloud::Error.from_error(e)
8375
+ end
8376
+
8377
+ ##
8378
+ # Creates information about multiple access bindings to an account or
8379
+ # property.
8380
+ #
8381
+ # This method is transactional. If any AccessBinding cannot be created, none
8382
+ # of the AccessBindings will be created.
8383
+ #
8384
+ # @overload batch_create_access_bindings(request, options = nil)
8385
+ # Pass arguments to `batch_create_access_bindings` via a request object, either of type
8386
+ # {::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsRequest} or an equivalent Hash.
8387
+ #
8388
+ # @param request [::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsRequest, ::Hash]
8389
+ # A request object representing the call parameters. Required. To specify no
8390
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8391
+ # @param options [::Gapic::CallOptions, ::Hash]
8392
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8393
+ #
8394
+ # @overload batch_create_access_bindings(parent: nil, requests: nil)
8395
+ # Pass arguments to `batch_create_access_bindings` via keyword arguments. Note that at
8396
+ # least one keyword argument is required. To specify no parameters, or to keep all
8397
+ # the default parameter values, pass an empty Hash as a request object (see above).
8398
+ #
8399
+ # @param parent [::String]
8400
+ # Required. The account or property that owns the access bindings. The parent
8401
+ # field in the CreateAccessBindingRequest messages must either be empty or
8402
+ # match this field. Formats:
8403
+ # - accounts/\\{account}
8404
+ # - properties/\\{property}
8405
+ # @param requests [::Array<::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest, ::Hash>]
8406
+ # Required. The requests specifying the access bindings to create.
8407
+ # A maximum of 1000 access bindings can be created in a batch.
8408
+ #
8409
+ # @yield [response, operation] Access the result along with the RPC operation
8410
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse]
8411
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8412
+ #
8413
+ # @return [::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse]
8414
+ #
8415
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8416
+ #
8417
+ # @example Basic example
8418
+ # require "google/analytics/admin/v1alpha"
8419
+ #
8420
+ # # Create a client object. The client can be reused for multiple calls.
8421
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8422
+ #
8423
+ # # Create a request. To set request fields, pass in keyword arguments.
8424
+ # request = Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsRequest.new
8425
+ #
8426
+ # # Call the batch_create_access_bindings method.
8427
+ # result = client.batch_create_access_bindings request
8428
+ #
8429
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse.
8430
+ # p result
8431
+ #
8432
+ def batch_create_access_bindings request, options = nil
8433
+ raise ::ArgumentError, "request must be provided" if request.nil?
8434
+
8435
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsRequest
8436
+
8437
+ # Converts hash and nil to an options object
8438
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8439
+
8440
+ # Customize the options with defaults
8441
+ metadata = @config.rpcs.batch_create_access_bindings.metadata.to_h
8442
+
8443
+ # Set x-goog-api-client and x-goog-user-project headers
8444
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8445
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8446
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8447
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8448
+
8449
+ header_params = {}
8450
+ if request.parent
8451
+ header_params["parent"] = request.parent
8452
+ end
8453
+
8454
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8455
+ metadata[:"x-goog-request-params"] ||= request_params_header
8456
+
8457
+ options.apply_defaults timeout: @config.rpcs.batch_create_access_bindings.timeout,
8458
+ metadata: metadata,
8459
+ retry_policy: @config.rpcs.batch_create_access_bindings.retry_policy
8460
+
8461
+ options.apply_defaults timeout: @config.timeout,
8462
+ metadata: @config.metadata,
8463
+ retry_policy: @config.retry_policy
8464
+
8465
+ @analytics_admin_service_stub.call_rpc :batch_create_access_bindings, request, options: options do |response, operation|
8466
+ yield response, operation if block_given?
8467
+ return response
8468
+ end
8469
+ rescue ::GRPC::BadStatus => e
8470
+ raise ::Google::Cloud::Error.from_error(e)
8471
+ end
8472
+
8473
+ ##
8474
+ # Gets information about multiple access bindings to an account or property.
8475
+ #
8476
+ # @overload batch_get_access_bindings(request, options = nil)
8477
+ # Pass arguments to `batch_get_access_bindings` via a request object, either of type
8478
+ # {::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsRequest} or an equivalent Hash.
8479
+ #
8480
+ # @param request [::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsRequest, ::Hash]
8481
+ # A request object representing the call parameters. Required. To specify no
8482
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8483
+ # @param options [::Gapic::CallOptions, ::Hash]
8484
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8485
+ #
8486
+ # @overload batch_get_access_bindings(parent: nil, names: nil)
8487
+ # Pass arguments to `batch_get_access_bindings` via keyword arguments. Note that at
8488
+ # least one keyword argument is required. To specify no parameters, or to keep all
8489
+ # the default parameter values, pass an empty Hash as a request object (see above).
8490
+ #
8491
+ # @param parent [::String]
8492
+ # Required. The account or property that owns the access bindings. The parent
8493
+ # of all provided values for the 'names' field must match this field.
8494
+ # Formats:
8495
+ # - accounts/\\{account}
8496
+ # - properties/\\{property}
8497
+ # @param names [::Array<::String>]
8498
+ # Required. The names of the access bindings to retrieve.
8499
+ # A maximum of 1000 access bindings can be retrieved in a batch.
8500
+ # Formats:
8501
+ # - accounts/\\{account}/accessBindings/\\{accessBinding}
8502
+ # - properties/\\{property}/accessBindings/\\{accessBinding}
8503
+ #
8504
+ # @yield [response, operation] Access the result along with the RPC operation
8505
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse]
8506
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8507
+ #
8508
+ # @return [::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse]
8509
+ #
8510
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8511
+ #
8512
+ # @example Basic example
8513
+ # require "google/analytics/admin/v1alpha"
8514
+ #
8515
+ # # Create a client object. The client can be reused for multiple calls.
8516
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8517
+ #
8518
+ # # Create a request. To set request fields, pass in keyword arguments.
8519
+ # request = Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsRequest.new
8520
+ #
8521
+ # # Call the batch_get_access_bindings method.
8522
+ # result = client.batch_get_access_bindings request
8523
+ #
8524
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse.
8525
+ # p result
8526
+ #
8527
+ def batch_get_access_bindings request, options = nil
8528
+ raise ::ArgumentError, "request must be provided" if request.nil?
8529
+
8530
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsRequest
8531
+
8532
+ # Converts hash and nil to an options object
8533
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8534
+
8535
+ # Customize the options with defaults
8536
+ metadata = @config.rpcs.batch_get_access_bindings.metadata.to_h
8537
+
8538
+ # Set x-goog-api-client and x-goog-user-project headers
8539
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8540
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8541
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8542
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8543
+
8544
+ header_params = {}
8545
+ if request.parent
8546
+ header_params["parent"] = request.parent
8547
+ end
8548
+
8549
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8550
+ metadata[:"x-goog-request-params"] ||= request_params_header
8551
+
8552
+ options.apply_defaults timeout: @config.rpcs.batch_get_access_bindings.timeout,
8553
+ metadata: metadata,
8554
+ retry_policy: @config.rpcs.batch_get_access_bindings.retry_policy
8555
+
8556
+ options.apply_defaults timeout: @config.timeout,
8557
+ metadata: @config.metadata,
8558
+ retry_policy: @config.retry_policy
8559
+
8560
+ @analytics_admin_service_stub.call_rpc :batch_get_access_bindings, request, options: options do |response, operation|
8561
+ yield response, operation if block_given?
8562
+ return response
8563
+ end
8564
+ rescue ::GRPC::BadStatus => e
8565
+ raise ::Google::Cloud::Error.from_error(e)
8566
+ end
8567
+
8568
+ ##
8569
+ # Updates information about multiple access bindings to an account or
8570
+ # property.
8571
+ #
8572
+ # @overload batch_update_access_bindings(request, options = nil)
8573
+ # Pass arguments to `batch_update_access_bindings` via a request object, either of type
8574
+ # {::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsRequest} or an equivalent Hash.
8575
+ #
8576
+ # @param request [::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsRequest, ::Hash]
8577
+ # A request object representing the call parameters. Required. To specify no
8578
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8579
+ # @param options [::Gapic::CallOptions, ::Hash]
8580
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8581
+ #
8582
+ # @overload batch_update_access_bindings(parent: nil, requests: nil)
8583
+ # Pass arguments to `batch_update_access_bindings` via keyword arguments. Note that at
8584
+ # least one keyword argument is required. To specify no parameters, or to keep all
8585
+ # the default parameter values, pass an empty Hash as a request object (see above).
8586
+ #
8587
+ # @param parent [::String]
8588
+ # Required. The account or property that owns the access bindings. The parent
8589
+ # field in the UpdateAccessBindingRequest messages must either be empty or
8590
+ # match this field. Formats:
8591
+ # - accounts/\\{account}
8592
+ # - properties/\\{property}
8593
+ # @param requests [::Array<::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest, ::Hash>]
8594
+ # Required. The requests specifying the access bindings to update.
8595
+ # A maximum of 1000 access bindings can be updated in a batch.
8596
+ #
8597
+ # @yield [response, operation] Access the result along with the RPC operation
8598
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse]
8599
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8600
+ #
8601
+ # @return [::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse]
8602
+ #
8603
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8604
+ #
8605
+ # @example Basic example
8606
+ # require "google/analytics/admin/v1alpha"
8607
+ #
8608
+ # # Create a client object. The client can be reused for multiple calls.
8609
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8610
+ #
8611
+ # # Create a request. To set request fields, pass in keyword arguments.
8612
+ # request = Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsRequest.new
8613
+ #
8614
+ # # Call the batch_update_access_bindings method.
8615
+ # result = client.batch_update_access_bindings request
8616
+ #
8617
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse.
8618
+ # p result
8619
+ #
8620
+ def batch_update_access_bindings request, options = nil
8621
+ raise ::ArgumentError, "request must be provided" if request.nil?
8622
+
8623
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsRequest
8624
+
8625
+ # Converts hash and nil to an options object
8626
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8627
+
8628
+ # Customize the options with defaults
8629
+ metadata = @config.rpcs.batch_update_access_bindings.metadata.to_h
8630
+
8631
+ # Set x-goog-api-client and x-goog-user-project headers
8632
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8633
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8634
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8635
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8636
+
8637
+ header_params = {}
8638
+ if request.parent
8639
+ header_params["parent"] = request.parent
8640
+ end
8641
+
8642
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8643
+ metadata[:"x-goog-request-params"] ||= request_params_header
8644
+
8645
+ options.apply_defaults timeout: @config.rpcs.batch_update_access_bindings.timeout,
8646
+ metadata: metadata,
8647
+ retry_policy: @config.rpcs.batch_update_access_bindings.retry_policy
8648
+
8649
+ options.apply_defaults timeout: @config.timeout,
8650
+ metadata: @config.metadata,
8651
+ retry_policy: @config.retry_policy
8652
+
8653
+ @analytics_admin_service_stub.call_rpc :batch_update_access_bindings, request, options: options do |response, operation|
8654
+ yield response, operation if block_given?
8655
+ return response
8656
+ end
8657
+ rescue ::GRPC::BadStatus => e
8658
+ raise ::Google::Cloud::Error.from_error(e)
8659
+ end
8660
+
8661
+ ##
8662
+ # Deletes information about multiple users' links to an account or property.
8663
+ #
8664
+ # @overload batch_delete_access_bindings(request, options = nil)
8665
+ # Pass arguments to `batch_delete_access_bindings` via a request object, either of type
8666
+ # {::Google::Analytics::Admin::V1alpha::BatchDeleteAccessBindingsRequest} or an equivalent Hash.
8667
+ #
8668
+ # @param request [::Google::Analytics::Admin::V1alpha::BatchDeleteAccessBindingsRequest, ::Hash]
8669
+ # A request object representing the call parameters. Required. To specify no
8670
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8671
+ # @param options [::Gapic::CallOptions, ::Hash]
8672
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8673
+ #
8674
+ # @overload batch_delete_access_bindings(parent: nil, requests: nil)
8675
+ # Pass arguments to `batch_delete_access_bindings` via keyword arguments. Note that at
8676
+ # least one keyword argument is required. To specify no parameters, or to keep all
8677
+ # the default parameter values, pass an empty Hash as a request object (see above).
8678
+ #
8679
+ # @param parent [::String]
8680
+ # Required. The account or property that owns the access bindings. The parent
8681
+ # field in the DeleteAccessBindingRequest messages must either be empty or
8682
+ # match this field. Formats:
8683
+ # - accounts/\\{account}
8684
+ # - properties/\\{property}
8685
+ # @param requests [::Array<::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest, ::Hash>]
8686
+ # Required. The requests specifying the access bindings to delete.
8687
+ # A maximum of 1000 access bindings can be deleted in a batch.
8688
+ #
8689
+ # @yield [response, operation] Access the result along with the RPC operation
8690
+ # @yieldparam response [::Google::Protobuf::Empty]
8691
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8692
+ #
8693
+ # @return [::Google::Protobuf::Empty]
8694
+ #
8695
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8696
+ #
8697
+ # @example Basic example
8698
+ # require "google/analytics/admin/v1alpha"
8699
+ #
8700
+ # # Create a client object. The client can be reused for multiple calls.
8701
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8702
+ #
8703
+ # # Create a request. To set request fields, pass in keyword arguments.
8704
+ # request = Google::Analytics::Admin::V1alpha::BatchDeleteAccessBindingsRequest.new
8705
+ #
8706
+ # # Call the batch_delete_access_bindings method.
8707
+ # result = client.batch_delete_access_bindings request
8708
+ #
8709
+ # # The returned object is of type Google::Protobuf::Empty.
8710
+ # p result
8711
+ #
8712
+ def batch_delete_access_bindings request, options = nil
8713
+ raise ::ArgumentError, "request must be provided" if request.nil?
8714
+
8715
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchDeleteAccessBindingsRequest
8716
+
8717
+ # Converts hash and nil to an options object
8718
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8719
+
8720
+ # Customize the options with defaults
8721
+ metadata = @config.rpcs.batch_delete_access_bindings.metadata.to_h
8722
+
8723
+ # Set x-goog-api-client and x-goog-user-project headers
8724
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8725
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8726
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8727
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8728
+
8729
+ header_params = {}
8730
+ if request.parent
8731
+ header_params["parent"] = request.parent
8732
+ end
8733
+
8734
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8735
+ metadata[:"x-goog-request-params"] ||= request_params_header
8736
+
8737
+ options.apply_defaults timeout: @config.rpcs.batch_delete_access_bindings.timeout,
8738
+ metadata: metadata,
8739
+ retry_policy: @config.rpcs.batch_delete_access_bindings.retry_policy
8740
+
8741
+ options.apply_defaults timeout: @config.timeout,
8742
+ metadata: @config.metadata,
8743
+ retry_policy: @config.retry_policy
8744
+
8745
+ @analytics_admin_service_stub.call_rpc :batch_delete_access_bindings, request, options: options do |response, operation|
8746
+ yield response, operation if block_given?
8747
+ return response
8748
+ end
8749
+ rescue ::GRPC::BadStatus => e
8750
+ raise ::Google::Cloud::Error.from_error(e)
8751
+ end
8752
+
8753
+ ##
8754
+ # Lookup for a single ExpandedDataSet.
8755
+ #
8756
+ # @overload get_expanded_data_set(request, options = nil)
8757
+ # Pass arguments to `get_expanded_data_set` via a request object, either of type
8758
+ # {::Google::Analytics::Admin::V1alpha::GetExpandedDataSetRequest} or an equivalent Hash.
8759
+ #
8760
+ # @param request [::Google::Analytics::Admin::V1alpha::GetExpandedDataSetRequest, ::Hash]
8761
+ # A request object representing the call parameters. Required. To specify no
8762
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8763
+ # @param options [::Gapic::CallOptions, ::Hash]
8764
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8765
+ #
8766
+ # @overload get_expanded_data_set(name: nil)
8767
+ # Pass arguments to `get_expanded_data_set` via keyword arguments. Note that at
8768
+ # least one keyword argument is required. To specify no parameters, or to keep all
8769
+ # the default parameter values, pass an empty Hash as a request object (see above).
8770
+ #
8771
+ # @param name [::String]
8772
+ # Required. The name of the Audience to get.
8773
+ # Example format: properties/1234/expandedDataSets/5678
8774
+ #
8775
+ # @yield [response, operation] Access the result along with the RPC operation
8776
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
8777
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8778
+ #
8779
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
8780
+ #
8781
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8782
+ #
8783
+ # @example Basic example
8784
+ # require "google/analytics/admin/v1alpha"
8785
+ #
8786
+ # # Create a client object. The client can be reused for multiple calls.
8787
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8788
+ #
8789
+ # # Create a request. To set request fields, pass in keyword arguments.
8790
+ # request = Google::Analytics::Admin::V1alpha::GetExpandedDataSetRequest.new
8791
+ #
8792
+ # # Call the get_expanded_data_set method.
8793
+ # result = client.get_expanded_data_set request
8794
+ #
8795
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::ExpandedDataSet.
8796
+ # p result
8797
+ #
8798
+ def get_expanded_data_set request, options = nil
8799
+ raise ::ArgumentError, "request must be provided" if request.nil?
8800
+
8801
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetExpandedDataSetRequest
8802
+
8803
+ # Converts hash and nil to an options object
8804
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8805
+
8806
+ # Customize the options with defaults
8807
+ metadata = @config.rpcs.get_expanded_data_set.metadata.to_h
8808
+
8809
+ # Set x-goog-api-client and x-goog-user-project headers
8810
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8811
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8812
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8813
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8814
+
8815
+ header_params = {}
8816
+ if request.name
8817
+ header_params["name"] = request.name
8818
+ end
8819
+
8820
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8821
+ metadata[:"x-goog-request-params"] ||= request_params_header
8822
+
8823
+ options.apply_defaults timeout: @config.rpcs.get_expanded_data_set.timeout,
8824
+ metadata: metadata,
8825
+ retry_policy: @config.rpcs.get_expanded_data_set.retry_policy
8826
+
8827
+ options.apply_defaults timeout: @config.timeout,
8828
+ metadata: @config.metadata,
8829
+ retry_policy: @config.retry_policy
8830
+
8831
+ @analytics_admin_service_stub.call_rpc :get_expanded_data_set, request, options: options do |response, operation|
8832
+ yield response, operation if block_given?
8833
+ return response
8834
+ end
8835
+ rescue ::GRPC::BadStatus => e
8836
+ raise ::Google::Cloud::Error.from_error(e)
8837
+ end
8838
+
8839
+ ##
8840
+ # Lists ExpandedDataSets on a property.
8841
+ #
8842
+ # @overload list_expanded_data_sets(request, options = nil)
8843
+ # Pass arguments to `list_expanded_data_sets` via a request object, either of type
8844
+ # {::Google::Analytics::Admin::V1alpha::ListExpandedDataSetsRequest} or an equivalent Hash.
8845
+ #
8846
+ # @param request [::Google::Analytics::Admin::V1alpha::ListExpandedDataSetsRequest, ::Hash]
8847
+ # A request object representing the call parameters. Required. To specify no
8848
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8849
+ # @param options [::Gapic::CallOptions, ::Hash]
8850
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8851
+ #
8852
+ # @overload list_expanded_data_sets(parent: nil, page_size: nil, page_token: nil)
8853
+ # Pass arguments to `list_expanded_data_sets` via keyword arguments. Note that at
8854
+ # least one keyword argument is required. To specify no parameters, or to keep all
8855
+ # the default parameter values, pass an empty Hash as a request object (see above).
8856
+ #
8857
+ # @param parent [::String]
8858
+ # Required. Example format: properties/1234
8859
+ # @param page_size [::Integer]
8860
+ # The maximum number of resources to return.
8861
+ # If unspecified, at most 50 resources will be returned.
8862
+ # The maximum value is 200 (higher values will be coerced to the maximum).
8863
+ # @param page_token [::String]
8864
+ # A page token, received from a previous `ListExpandedDataSets` call. Provide
8865
+ # this to retrieve the subsequent page.
8866
+ #
8867
+ # When paginating, all other parameters provided to `ListExpandedDataSet`
8868
+ # must match the call that provided the page token.
8869
+ #
8870
+ # @yield [response, operation] Access the result along with the RPC operation
8871
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>]
8872
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8873
+ #
8874
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>]
8875
+ #
8876
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8877
+ #
8878
+ # @example Basic example
8879
+ # require "google/analytics/admin/v1alpha"
8880
+ #
8881
+ # # Create a client object. The client can be reused for multiple calls.
8882
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8883
+ #
8884
+ # # Create a request. To set request fields, pass in keyword arguments.
8885
+ # request = Google::Analytics::Admin::V1alpha::ListExpandedDataSetsRequest.new
8886
+ #
8887
+ # # Call the list_expanded_data_sets method.
8888
+ # result = client.list_expanded_data_sets request
8889
+ #
8890
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
8891
+ # # over elements, and API calls will be issued to fetch pages as needed.
8892
+ # result.each do |item|
8893
+ # # Each element is of type ::Google::Analytics::Admin::V1alpha::ExpandedDataSet.
8894
+ # p item
8895
+ # end
8896
+ #
8897
+ def list_expanded_data_sets request, options = nil
8898
+ raise ::ArgumentError, "request must be provided" if request.nil?
8899
+
8900
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListExpandedDataSetsRequest
8901
+
8902
+ # Converts hash and nil to an options object
8903
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8904
+
8905
+ # Customize the options with defaults
8906
+ metadata = @config.rpcs.list_expanded_data_sets.metadata.to_h
8907
+
8908
+ # Set x-goog-api-client and x-goog-user-project headers
8909
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8910
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8911
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
8912
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
8913
+
8914
+ header_params = {}
8915
+ if request.parent
8916
+ header_params["parent"] = request.parent
8917
+ end
8918
+
8919
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
8920
+ metadata[:"x-goog-request-params"] ||= request_params_header
8921
+
8922
+ options.apply_defaults timeout: @config.rpcs.list_expanded_data_sets.timeout,
8923
+ metadata: metadata,
8924
+ retry_policy: @config.rpcs.list_expanded_data_sets.retry_policy
8925
+
8926
+ options.apply_defaults timeout: @config.timeout,
8927
+ metadata: @config.metadata,
8928
+ retry_policy: @config.retry_policy
8929
+
8930
+ @analytics_admin_service_stub.call_rpc :list_expanded_data_sets, request, options: options do |response, operation|
8931
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_expanded_data_sets, request, response, operation, options
8932
+ yield response, operation if block_given?
8933
+ return response
8934
+ end
8935
+ rescue ::GRPC::BadStatus => e
8936
+ raise ::Google::Cloud::Error.from_error(e)
8937
+ end
8938
+
8939
+ ##
8940
+ # Creates a ExpandedDataSet.
8941
+ #
8942
+ # @overload create_expanded_data_set(request, options = nil)
8943
+ # Pass arguments to `create_expanded_data_set` via a request object, either of type
8944
+ # {::Google::Analytics::Admin::V1alpha::CreateExpandedDataSetRequest} or an equivalent Hash.
8945
+ #
8946
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateExpandedDataSetRequest, ::Hash]
8947
+ # A request object representing the call parameters. Required. To specify no
8948
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
8949
+ # @param options [::Gapic::CallOptions, ::Hash]
8950
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
8951
+ #
8952
+ # @overload create_expanded_data_set(parent: nil, expanded_data_set: nil)
8953
+ # Pass arguments to `create_expanded_data_set` via keyword arguments. Note that at
8954
+ # least one keyword argument is required. To specify no parameters, or to keep all
8955
+ # the default parameter values, pass an empty Hash as a request object (see above).
8956
+ #
8957
+ # @param parent [::String]
8958
+ # Required. Example format: properties/1234
8959
+ # @param expanded_data_set [::Google::Analytics::Admin::V1alpha::ExpandedDataSet, ::Hash]
8960
+ # Required. The ExpandedDataSet to create.
8961
+ #
8962
+ # @yield [response, operation] Access the result along with the RPC operation
8963
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
8964
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
8965
+ #
8966
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
8967
+ #
8968
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
8969
+ #
8970
+ # @example Basic example
8971
+ # require "google/analytics/admin/v1alpha"
8972
+ #
8973
+ # # Create a client object. The client can be reused for multiple calls.
8974
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
8975
+ #
8976
+ # # Create a request. To set request fields, pass in keyword arguments.
8977
+ # request = Google::Analytics::Admin::V1alpha::CreateExpandedDataSetRequest.new
8978
+ #
8979
+ # # Call the create_expanded_data_set method.
8980
+ # result = client.create_expanded_data_set request
8981
+ #
8982
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::ExpandedDataSet.
8983
+ # p result
8984
+ #
8985
+ def create_expanded_data_set request, options = nil
8986
+ raise ::ArgumentError, "request must be provided" if request.nil?
8987
+
8988
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateExpandedDataSetRequest
8989
+
8990
+ # Converts hash and nil to an options object
8991
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
8992
+
8993
+ # Customize the options with defaults
8994
+ metadata = @config.rpcs.create_expanded_data_set.metadata.to_h
8995
+
8996
+ # Set x-goog-api-client and x-goog-user-project headers
8997
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
8998
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
8999
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9000
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9001
+
9002
+ header_params = {}
9003
+ if request.parent
9004
+ header_params["parent"] = request.parent
9005
+ end
9006
+
9007
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
9008
+ metadata[:"x-goog-request-params"] ||= request_params_header
9009
+
9010
+ options.apply_defaults timeout: @config.rpcs.create_expanded_data_set.timeout,
9011
+ metadata: metadata,
9012
+ retry_policy: @config.rpcs.create_expanded_data_set.retry_policy
9013
+
9014
+ options.apply_defaults timeout: @config.timeout,
9015
+ metadata: @config.metadata,
9016
+ retry_policy: @config.retry_policy
9017
+
9018
+ @analytics_admin_service_stub.call_rpc :create_expanded_data_set, request, options: options do |response, operation|
9019
+ yield response, operation if block_given?
9020
+ return response
9021
+ end
9022
+ rescue ::GRPC::BadStatus => e
9023
+ raise ::Google::Cloud::Error.from_error(e)
9024
+ end
9025
+
9026
+ ##
9027
+ # Updates a ExpandedDataSet on a property.
9028
+ #
9029
+ # @overload update_expanded_data_set(request, options = nil)
9030
+ # Pass arguments to `update_expanded_data_set` via a request object, either of type
9031
+ # {::Google::Analytics::Admin::V1alpha::UpdateExpandedDataSetRequest} or an equivalent Hash.
9032
+ #
9033
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateExpandedDataSetRequest, ::Hash]
9034
+ # A request object representing the call parameters. Required. To specify no
9035
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
9036
+ # @param options [::Gapic::CallOptions, ::Hash]
9037
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9038
+ #
9039
+ # @overload update_expanded_data_set(expanded_data_set: nil, update_mask: nil)
9040
+ # Pass arguments to `update_expanded_data_set` via keyword arguments. Note that at
9041
+ # least one keyword argument is required. To specify no parameters, or to keep all
9042
+ # the default parameter values, pass an empty Hash as a request object (see above).
9043
+ #
9044
+ # @param expanded_data_set [::Google::Analytics::Admin::V1alpha::ExpandedDataSet, ::Hash]
9045
+ # Required. The ExpandedDataSet to update.
9046
+ # The resource's `name` field is used to identify the ExpandedDataSet to be
9047
+ # updated.
9048
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
9049
+ # Required. The list of fields to be updated. Field names must be in snake
9050
+ # case (e.g., "field_to_update"). Omitted fields will not be updated. To
9051
+ # replace the entire entity, use one path with the string "*" to match all
9052
+ # fields.
9053
+ #
9054
+ # @yield [response, operation] Access the result along with the RPC operation
9055
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
9056
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
9057
+ #
9058
+ # @return [::Google::Analytics::Admin::V1alpha::ExpandedDataSet]
9059
+ #
9060
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
9061
+ #
9062
+ # @example Basic example
9063
+ # require "google/analytics/admin/v1alpha"
9064
+ #
9065
+ # # Create a client object. The client can be reused for multiple calls.
9066
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9067
+ #
9068
+ # # Create a request. To set request fields, pass in keyword arguments.
9069
+ # request = Google::Analytics::Admin::V1alpha::UpdateExpandedDataSetRequest.new
9070
+ #
9071
+ # # Call the update_expanded_data_set method.
9072
+ # result = client.update_expanded_data_set request
9073
+ #
9074
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::ExpandedDataSet.
9075
+ # p result
9076
+ #
9077
+ def update_expanded_data_set request, options = nil
9078
+ raise ::ArgumentError, "request must be provided" if request.nil?
9079
+
9080
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateExpandedDataSetRequest
9081
+
9082
+ # Converts hash and nil to an options object
9083
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9084
+
9085
+ # Customize the options with defaults
9086
+ metadata = @config.rpcs.update_expanded_data_set.metadata.to_h
9087
+
9088
+ # Set x-goog-api-client and x-goog-user-project headers
9089
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9090
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
9091
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9092
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9093
+
9094
+ header_params = {}
9095
+ if request.expanded_data_set&.name
9096
+ header_params["expanded_data_set.name"] = request.expanded_data_set.name
9097
+ end
9098
+
9099
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
9100
+ metadata[:"x-goog-request-params"] ||= request_params_header
9101
+
9102
+ options.apply_defaults timeout: @config.rpcs.update_expanded_data_set.timeout,
9103
+ metadata: metadata,
9104
+ retry_policy: @config.rpcs.update_expanded_data_set.retry_policy
9105
+
9106
+ options.apply_defaults timeout: @config.timeout,
9107
+ metadata: @config.metadata,
9108
+ retry_policy: @config.retry_policy
9109
+
9110
+ @analytics_admin_service_stub.call_rpc :update_expanded_data_set, request, options: options do |response, operation|
9111
+ yield response, operation if block_given?
9112
+ return response
9113
+ end
9114
+ rescue ::GRPC::BadStatus => e
9115
+ raise ::Google::Cloud::Error.from_error(e)
9116
+ end
9117
+
9118
+ ##
9119
+ # Deletes a ExpandedDataSet on a property.
9120
+ #
9121
+ # @overload delete_expanded_data_set(request, options = nil)
9122
+ # Pass arguments to `delete_expanded_data_set` via a request object, either of type
9123
+ # {::Google::Analytics::Admin::V1alpha::DeleteExpandedDataSetRequest} or an equivalent Hash.
9124
+ #
9125
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteExpandedDataSetRequest, ::Hash]
9126
+ # A request object representing the call parameters. Required. To specify no
9127
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
9128
+ # @param options [::Gapic::CallOptions, ::Hash]
9129
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9130
+ #
9131
+ # @overload delete_expanded_data_set(name: nil)
9132
+ # Pass arguments to `delete_expanded_data_set` via keyword arguments. Note that at
9133
+ # least one keyword argument is required. To specify no parameters, or to keep all
9134
+ # the default parameter values, pass an empty Hash as a request object (see above).
9135
+ #
9136
+ # @param name [::String]
9137
+ # Required. Example format: properties/1234/expandedDataSets/5678
9138
+ #
9139
+ # @yield [response, operation] Access the result along with the RPC operation
9140
+ # @yieldparam response [::Google::Protobuf::Empty]
9141
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
9142
+ #
9143
+ # @return [::Google::Protobuf::Empty]
9144
+ #
9145
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
9146
+ #
9147
+ # @example Basic example
9148
+ # require "google/analytics/admin/v1alpha"
9149
+ #
9150
+ # # Create a client object. The client can be reused for multiple calls.
9151
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9152
+ #
9153
+ # # Create a request. To set request fields, pass in keyword arguments.
9154
+ # request = Google::Analytics::Admin::V1alpha::DeleteExpandedDataSetRequest.new
9155
+ #
9156
+ # # Call the delete_expanded_data_set method.
9157
+ # result = client.delete_expanded_data_set request
9158
+ #
9159
+ # # The returned object is of type Google::Protobuf::Empty.
9160
+ # p result
9161
+ #
9162
+ def delete_expanded_data_set request, options = nil
9163
+ raise ::ArgumentError, "request must be provided" if request.nil?
9164
+
9165
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteExpandedDataSetRequest
9166
+
9167
+ # Converts hash and nil to an options object
9168
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9169
+
9170
+ # Customize the options with defaults
9171
+ metadata = @config.rpcs.delete_expanded_data_set.metadata.to_h
9172
+
9173
+ # Set x-goog-api-client and x-goog-user-project headers
9174
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9175
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
9176
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9177
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9178
+
9179
+ header_params = {}
9180
+ if request.name
9181
+ header_params["name"] = request.name
9182
+ end
9183
+
9184
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
9185
+ metadata[:"x-goog-request-params"] ||= request_params_header
9186
+
9187
+ options.apply_defaults timeout: @config.rpcs.delete_expanded_data_set.timeout,
9188
+ metadata: metadata,
9189
+ retry_policy: @config.rpcs.delete_expanded_data_set.retry_policy
9190
+
9191
+ options.apply_defaults timeout: @config.timeout,
9192
+ metadata: @config.metadata,
9193
+ retry_policy: @config.retry_policy
9194
+
9195
+ @analytics_admin_service_stub.call_rpc :delete_expanded_data_set, request, options: options do |response, operation|
9196
+ yield response, operation if block_given?
9197
+ return response
9198
+ end
9199
+ rescue ::GRPC::BadStatus => e
9200
+ raise ::Google::Cloud::Error.from_error(e)
9201
+ end
9202
+
9203
+ ##
9204
+ # Sets the opt out status for the automated GA4 setup process for a UA
9205
+ # property.
9206
+ # Note: this has no effect on GA4 property.
9207
+ #
9208
+ # @overload set_automated_ga4_configuration_opt_out(request, options = nil)
9209
+ # Pass arguments to `set_automated_ga4_configuration_opt_out` via a request object, either of type
9210
+ # {::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
9211
+ #
9212
+ # @param request [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::Hash]
9213
+ # A request object representing the call parameters. Required. To specify no
9214
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
9215
+ # @param options [::Gapic::CallOptions, ::Hash]
9216
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9217
+ #
9218
+ # @overload set_automated_ga4_configuration_opt_out(property: nil, opt_out: nil)
9219
+ # Pass arguments to `set_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
9220
+ # least one keyword argument is required. To specify no parameters, or to keep all
9221
+ # the default parameter values, pass an empty Hash as a request object (see above).
9222
+ #
9223
+ # @param property [::String]
9224
+ # Required. The UA property to set the opt out status. Note this request uses
9225
+ # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
9226
+ # Format: properties/\\{internalWebPropertyId}
9227
+ # Example: properties/1234
9228
+ # @param opt_out [::Boolean]
9229
+ # The status to set.
9230
+ #
9231
+ # @yield [response, operation] Access the result along with the RPC operation
9232
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
9233
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
9234
+ #
9235
+ # @return [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
9236
+ #
9237
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
9238
+ #
9239
+ # @example Basic example
9240
+ # require "google/analytics/admin/v1alpha"
9241
+ #
9242
+ # # Create a client object. The client can be reused for multiple calls.
9243
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9244
+ #
9245
+ # # Create a request. To set request fields, pass in keyword arguments.
9246
+ # request = Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest.new
9247
+ #
9248
+ # # Call the set_automated_ga4_configuration_opt_out method.
9249
+ # result = client.set_automated_ga4_configuration_opt_out request
9250
+ #
9251
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse.
9252
+ # p result
9253
+ #
9254
+ def set_automated_ga4_configuration_opt_out request, options = nil
9255
+ raise ::ArgumentError, "request must be provided" if request.nil?
9256
+
9257
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest
9258
+
9259
+ # Converts hash and nil to an options object
9260
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9261
+
9262
+ # Customize the options with defaults
9263
+ metadata = @config.rpcs.set_automated_ga4_configuration_opt_out.metadata.to_h
9264
+
9265
+ # Set x-goog-api-client and x-goog-user-project headers
9266
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9267
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
9268
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9269
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9270
+
9271
+ options.apply_defaults timeout: @config.rpcs.set_automated_ga4_configuration_opt_out.timeout,
9272
+ metadata: metadata,
9273
+ retry_policy: @config.rpcs.set_automated_ga4_configuration_opt_out.retry_policy
9274
+
9275
+ options.apply_defaults timeout: @config.timeout,
9276
+ metadata: @config.metadata,
9277
+ retry_policy: @config.retry_policy
9278
+
9279
+ @analytics_admin_service_stub.call_rpc :set_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
9280
+ yield response, operation if block_given?
9281
+ return response
9282
+ end
9283
+ rescue ::GRPC::BadStatus => e
9284
+ raise ::Google::Cloud::Error.from_error(e)
9285
+ end
9286
+
9287
+ ##
9288
+ # Fetches the opt out status for the automated GA4 setup process for a UA
9289
+ # property.
9290
+ # Note: this has no effect on GA4 property.
9291
+ #
9292
+ # @overload fetch_automated_ga4_configuration_opt_out(request, options = nil)
9293
+ # Pass arguments to `fetch_automated_ga4_configuration_opt_out` via a request object, either of type
9294
+ # {::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
9295
+ #
9296
+ # @param request [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest, ::Hash]
9297
+ # A request object representing the call parameters. Required. To specify no
9298
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
9299
+ # @param options [::Gapic::CallOptions, ::Hash]
9300
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9301
+ #
9302
+ # @overload fetch_automated_ga4_configuration_opt_out(property: nil)
9303
+ # Pass arguments to `fetch_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
9304
+ # least one keyword argument is required. To specify no parameters, or to keep all
9305
+ # the default parameter values, pass an empty Hash as a request object (see above).
9306
+ #
9307
+ # @param property [::String]
9308
+ # Required. The UA property to get the opt out status. Note this request uses
9309
+ # the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
9310
+ # Format: properties/\\{internalWebPropertyId}
9311
+ # Example: properties/1234
9312
+ #
9313
+ # @yield [response, operation] Access the result along with the RPC operation
9314
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
9315
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
9316
+ #
9317
+ # @return [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
9318
+ #
9319
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
9320
+ #
9321
+ # @example Basic example
9322
+ # require "google/analytics/admin/v1alpha"
9323
+ #
9324
+ # # Create a client object. The client can be reused for multiple calls.
9325
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9326
+ #
9327
+ # # Create a request. To set request fields, pass in keyword arguments.
9328
+ # request = Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest.new
9329
+ #
9330
+ # # Call the fetch_automated_ga4_configuration_opt_out method.
9331
+ # result = client.fetch_automated_ga4_configuration_opt_out request
9332
+ #
9333
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse.
9334
+ # p result
9335
+ #
9336
+ def fetch_automated_ga4_configuration_opt_out request, options = nil
9337
+ raise ::ArgumentError, "request must be provided" if request.nil?
9338
+
9339
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest
9340
+
9341
+ # Converts hash and nil to an options object
9342
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9343
+
9344
+ # Customize the options with defaults
9345
+ metadata = @config.rpcs.fetch_automated_ga4_configuration_opt_out.metadata.to_h
9346
+
9347
+ # Set x-goog-api-client and x-goog-user-project headers
9348
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9349
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
9350
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9351
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9352
+
9353
+ options.apply_defaults timeout: @config.rpcs.fetch_automated_ga4_configuration_opt_out.timeout,
9354
+ metadata: metadata,
9355
+ retry_policy: @config.rpcs.fetch_automated_ga4_configuration_opt_out.retry_policy
9356
+
9357
+ options.apply_defaults timeout: @config.timeout,
9358
+ metadata: @config.metadata,
9359
+ retry_policy: @config.retry_policy
9360
+
9361
+ @analytics_admin_service_stub.call_rpc :fetch_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
9362
+ yield response, operation if block_given?
9363
+ return response
9364
+ end
9365
+ rescue ::GRPC::BadStatus => e
9366
+ raise ::Google::Cloud::Error.from_error(e)
9367
+ end
9368
+
9369
+ ##
9370
+ # Lookup for a single BigQuery Link.
9371
+ #
9372
+ # @overload get_big_query_link(request, options = nil)
9373
+ # Pass arguments to `get_big_query_link` via a request object, either of type
9374
+ # {::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest} or an equivalent Hash.
9375
+ #
9376
+ # @param request [::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest, ::Hash]
9377
+ # A request object representing the call parameters. Required. To specify no
9378
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
9379
+ # @param options [::Gapic::CallOptions, ::Hash]
9380
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9381
+ #
9382
+ # @overload get_big_query_link(name: nil)
9383
+ # Pass arguments to `get_big_query_link` via keyword arguments. Note that at
9384
+ # least one keyword argument is required. To specify no parameters, or to keep all
9385
+ # the default parameter values, pass an empty Hash as a request object (see above).
9386
+ #
9387
+ # @param name [::String]
9388
+ # Required. The name of the BigQuery link to lookup.
9389
+ # Format: properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id}
9390
+ # Example: properties/123/bigQueryLinks/456
9391
+ #
9392
+ # @yield [response, operation] Access the result along with the RPC operation
9393
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::BigQueryLink]
9394
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
9395
+ #
9396
+ # @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
9397
+ #
9398
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
9399
+ #
9400
+ # @example Basic example
9401
+ # require "google/analytics/admin/v1alpha"
9402
+ #
9403
+ # # Create a client object. The client can be reused for multiple calls.
9404
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9405
+ #
9406
+ # # Create a request. To set request fields, pass in keyword arguments.
9407
+ # request = Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest.new
9408
+ #
9409
+ # # Call the get_big_query_link method.
9410
+ # result = client.get_big_query_link request
9411
+ #
9412
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::BigQueryLink.
9413
+ # p result
9414
+ #
9415
+ def get_big_query_link request, options = nil
9416
+ raise ::ArgumentError, "request must be provided" if request.nil?
9417
+
9418
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest
9419
+
9420
+ # Converts hash and nil to an options object
9421
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9422
+
9423
+ # Customize the options with defaults
9424
+ metadata = @config.rpcs.get_big_query_link.metadata.to_h
9425
+
9426
+ # Set x-goog-api-client and x-goog-user-project headers
9427
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9428
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
9429
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9430
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9431
+
9432
+ header_params = {}
9433
+ if request.name
9434
+ header_params["name"] = request.name
9435
+ end
9436
+
9437
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
9438
+ metadata[:"x-goog-request-params"] ||= request_params_header
9439
+
9440
+ options.apply_defaults timeout: @config.rpcs.get_big_query_link.timeout,
9441
+ metadata: metadata,
9442
+ retry_policy: @config.rpcs.get_big_query_link.retry_policy
9443
+
9444
+ options.apply_defaults timeout: @config.timeout,
9445
+ metadata: @config.metadata,
9446
+ retry_policy: @config.retry_policy
9447
+
9448
+ @analytics_admin_service_stub.call_rpc :get_big_query_link, request, options: options do |response, operation|
9449
+ yield response, operation if block_given?
9450
+ return response
9451
+ end
9452
+ rescue ::GRPC::BadStatus => e
9453
+ raise ::Google::Cloud::Error.from_error(e)
9454
+ end
9455
+
9456
+ ##
9457
+ # Lists BigQuery Links on a property.
9458
+ #
9459
+ # @overload list_big_query_links(request, options = nil)
9460
+ # Pass arguments to `list_big_query_links` via a request object, either of type
9461
+ # {::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest} or an equivalent Hash.
9462
+ #
9463
+ # @param request [::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest, ::Hash]
9464
+ # A request object representing the call parameters. Required. To specify no
9465
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
9466
+ # @param options [::Gapic::CallOptions, ::Hash]
9467
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
9468
+ #
9469
+ # @overload list_big_query_links(parent: nil, page_size: nil, page_token: nil)
9470
+ # Pass arguments to `list_big_query_links` via keyword arguments. Note that at
9471
+ # least one keyword argument is required. To specify no parameters, or to keep all
9472
+ # the default parameter values, pass an empty Hash as a request object (see above).
9473
+ #
9474
+ # @param parent [::String]
9475
+ # Required. The name of the property to list BigQuery links under.
9476
+ # Format: properties/\\{property_id}
9477
+ # Example: properties/1234
9478
+ # @param page_size [::Integer]
9479
+ # The maximum number of resources to return. The service may return
9480
+ # fewer than this value, even if there are additional pages.
9481
+ # If unspecified, at most 50 resources will be returned.
9482
+ # The maximum value is 200; (higher values will be coerced to the maximum)
9483
+ # @param page_token [::String]
9484
+ # A page token, received from a previous `ListBigQueryLinks` call.
9485
+ # Provide this to retrieve the subsequent page.
9486
+ # When paginating, all other parameters provided to `ListBigQueryLinks` must
9487
+ # match the call that provided the page token.
9488
+ #
9489
+ # @yield [response, operation] Access the result along with the RPC operation
9490
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
9491
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
9492
+ #
9493
+ # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
9494
+ #
9495
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
9496
+ #
9497
+ # @example Basic example
9498
+ # require "google/analytics/admin/v1alpha"
9499
+ #
9500
+ # # Create a client object. The client can be reused for multiple calls.
9501
+ # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
9502
+ #
9503
+ # # Create a request. To set request fields, pass in keyword arguments.
9504
+ # request = Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest.new
9505
+ #
9506
+ # # Call the list_big_query_links method.
9507
+ # result = client.list_big_query_links request
9508
+ #
9509
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
9510
+ # # over elements, and API calls will be issued to fetch pages as needed.
9511
+ # result.each do |item|
9512
+ # # Each element is of type ::Google::Analytics::Admin::V1alpha::BigQueryLink.
9513
+ # p item
9514
+ # end
9515
+ #
9516
+ def list_big_query_links request, options = nil
9517
+ raise ::ArgumentError, "request must be provided" if request.nil?
9518
+
9519
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest
9520
+
9521
+ # Converts hash and nil to an options object
9522
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
9523
+
9524
+ # Customize the options with defaults
9525
+ metadata = @config.rpcs.list_big_query_links.metadata.to_h
9526
+
9527
+ # Set x-goog-api-client and x-goog-user-project headers
9528
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
9529
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
9530
+ gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
9531
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
9532
+
9533
+ header_params = {}
9534
+ if request.parent
9535
+ header_params["parent"] = request.parent
9536
+ end
9537
+
9538
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
9539
+ metadata[:"x-goog-request-params"] ||= request_params_header
9540
+
9541
+ options.apply_defaults timeout: @config.rpcs.list_big_query_links.timeout,
9542
+ metadata: metadata,
9543
+ retry_policy: @config.rpcs.list_big_query_links.retry_policy
9544
+
9545
+ options.apply_defaults timeout: @config.timeout,
9546
+ metadata: @config.metadata,
9547
+ retry_policy: @config.retry_policy
9548
+
9549
+ @analytics_admin_service_stub.call_rpc :list_big_query_links, request, options: options do |response, operation|
9550
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_big_query_links, request, response, operation, options
9551
+ yield response, operation if block_given?
9552
+ return response
9553
+ end
9554
+ rescue ::GRPC::BadStatus => e
9555
+ raise ::Google::Cloud::Error.from_error(e)
9556
+ end
9557
+
9558
+ ##
9559
+ # Configuration class for the AnalyticsAdminService API.
9560
+ #
9561
+ # This class represents the configuration for AnalyticsAdminService,
9562
+ # providing control over timeouts, retry behavior, logging, transport
9563
+ # parameters, and other low-level controls. Certain parameters can also be
9564
+ # applied individually to specific RPCs. See
9565
+ # {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
9566
+ # for a list of RPCs that can be configured independently.
9567
+ #
9568
+ # Configuration can be applied globally to all clients, or to a single client
9569
+ # on construction.
9570
+ #
9571
+ # @example
9572
+ #
9573
+ # # Modify the global config, setting the timeout for
9574
+ # # get_account to 20 seconds,
9575
+ # # and all remaining timeouts to 10 seconds.
9576
+ # ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
9577
+ # config.timeout = 10.0
9578
+ # config.rpcs.get_account.timeout = 20.0
9579
+ # end
9580
+ #
9581
+ # # Apply the above configuration only to a new client.
9582
+ # client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
9583
+ # config.timeout = 10.0
9584
+ # config.rpcs.get_account.timeout = 20.0
9585
+ # end
9586
+ #
9587
+ # @!attribute [rw] endpoint
9588
+ # The hostname or hostname:port of the service endpoint.
9589
+ # Defaults to `"analyticsadmin.googleapis.com"`.
9590
+ # @return [::String]
9591
+ # @!attribute [rw] credentials
9592
+ # Credentials to send with calls. You may provide any of the following types:
9593
+ # * (`String`) The path to a service account key file in JSON format
9594
+ # * (`Hash`) A service account key as a Hash
9595
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
9596
+ # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
9597
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
9598
+ # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
9599
+ # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
9600
+ # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
9601
+ # * (`nil`) indicating no credentials
9602
+ # @return [::Object]
9603
+ # @!attribute [rw] scope
9604
+ # The OAuth scopes
9605
+ # @return [::Array<::String>]
9606
+ # @!attribute [rw] lib_name
9607
+ # The library name as recorded in instrumentation and logging
9608
+ # @return [::String]
9609
+ # @!attribute [rw] lib_version
9610
+ # The library version as recorded in instrumentation and logging
9611
+ # @return [::String]
9612
+ # @!attribute [rw] channel_args
9613
+ # Extra parameters passed to the gRPC channel. Note: this is ignored if a
9614
+ # `GRPC::Core::Channel` object is provided as the credential.
9615
+ # @return [::Hash]
9616
+ # @!attribute [rw] interceptors
9617
+ # An array of interceptors that are run before calls are executed.
9618
+ # @return [::Array<::GRPC::ClientInterceptor>]
9619
+ # @!attribute [rw] timeout
9620
+ # The call timeout in seconds.
9621
+ # @return [::Numeric]
9622
+ # @!attribute [rw] metadata
7505
9623
  # Additional gRPC headers to be sent with the call.
7506
9624
  # @return [::Hash{::Symbol=>::String}]
7507
9625
  # @!attribute [rw] retry_policy
@@ -7953,6 +10071,31 @@ module Google
7953
10071
  #
7954
10072
  attr_reader :archive_audience
7955
10073
  ##
10074
+ # RPC-specific configuration for `get_search_ads360_link`
10075
+ # @return [::Gapic::Config::Method]
10076
+ #
10077
+ attr_reader :get_search_ads360_link
10078
+ ##
10079
+ # RPC-specific configuration for `list_search_ads360_links`
10080
+ # @return [::Gapic::Config::Method]
10081
+ #
10082
+ attr_reader :list_search_ads360_links
10083
+ ##
10084
+ # RPC-specific configuration for `create_search_ads360_link`
10085
+ # @return [::Gapic::Config::Method]
10086
+ #
10087
+ attr_reader :create_search_ads360_link
10088
+ ##
10089
+ # RPC-specific configuration for `delete_search_ads360_link`
10090
+ # @return [::Gapic::Config::Method]
10091
+ #
10092
+ attr_reader :delete_search_ads360_link
10093
+ ##
10094
+ # RPC-specific configuration for `update_search_ads360_link`
10095
+ # @return [::Gapic::Config::Method]
10096
+ #
10097
+ attr_reader :update_search_ads360_link
10098
+ ##
7956
10099
  # RPC-specific configuration for `get_attribution_settings`
7957
10100
  # @return [::Gapic::Config::Method]
7958
10101
  #
@@ -7967,6 +10110,96 @@ module Google
7967
10110
  # @return [::Gapic::Config::Method]
7968
10111
  #
7969
10112
  attr_reader :run_access_report
10113
+ ##
10114
+ # RPC-specific configuration for `create_access_binding`
10115
+ # @return [::Gapic::Config::Method]
10116
+ #
10117
+ attr_reader :create_access_binding
10118
+ ##
10119
+ # RPC-specific configuration for `get_access_binding`
10120
+ # @return [::Gapic::Config::Method]
10121
+ #
10122
+ attr_reader :get_access_binding
10123
+ ##
10124
+ # RPC-specific configuration for `update_access_binding`
10125
+ # @return [::Gapic::Config::Method]
10126
+ #
10127
+ attr_reader :update_access_binding
10128
+ ##
10129
+ # RPC-specific configuration for `delete_access_binding`
10130
+ # @return [::Gapic::Config::Method]
10131
+ #
10132
+ attr_reader :delete_access_binding
10133
+ ##
10134
+ # RPC-specific configuration for `list_access_bindings`
10135
+ # @return [::Gapic::Config::Method]
10136
+ #
10137
+ attr_reader :list_access_bindings
10138
+ ##
10139
+ # RPC-specific configuration for `batch_create_access_bindings`
10140
+ # @return [::Gapic::Config::Method]
10141
+ #
10142
+ attr_reader :batch_create_access_bindings
10143
+ ##
10144
+ # RPC-specific configuration for `batch_get_access_bindings`
10145
+ # @return [::Gapic::Config::Method]
10146
+ #
10147
+ attr_reader :batch_get_access_bindings
10148
+ ##
10149
+ # RPC-specific configuration for `batch_update_access_bindings`
10150
+ # @return [::Gapic::Config::Method]
10151
+ #
10152
+ attr_reader :batch_update_access_bindings
10153
+ ##
10154
+ # RPC-specific configuration for `batch_delete_access_bindings`
10155
+ # @return [::Gapic::Config::Method]
10156
+ #
10157
+ attr_reader :batch_delete_access_bindings
10158
+ ##
10159
+ # RPC-specific configuration for `get_expanded_data_set`
10160
+ # @return [::Gapic::Config::Method]
10161
+ #
10162
+ attr_reader :get_expanded_data_set
10163
+ ##
10164
+ # RPC-specific configuration for `list_expanded_data_sets`
10165
+ # @return [::Gapic::Config::Method]
10166
+ #
10167
+ attr_reader :list_expanded_data_sets
10168
+ ##
10169
+ # RPC-specific configuration for `create_expanded_data_set`
10170
+ # @return [::Gapic::Config::Method]
10171
+ #
10172
+ attr_reader :create_expanded_data_set
10173
+ ##
10174
+ # RPC-specific configuration for `update_expanded_data_set`
10175
+ # @return [::Gapic::Config::Method]
10176
+ #
10177
+ attr_reader :update_expanded_data_set
10178
+ ##
10179
+ # RPC-specific configuration for `delete_expanded_data_set`
10180
+ # @return [::Gapic::Config::Method]
10181
+ #
10182
+ attr_reader :delete_expanded_data_set
10183
+ ##
10184
+ # RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
10185
+ # @return [::Gapic::Config::Method]
10186
+ #
10187
+ attr_reader :set_automated_ga4_configuration_opt_out
10188
+ ##
10189
+ # RPC-specific configuration for `fetch_automated_ga4_configuration_opt_out`
10190
+ # @return [::Gapic::Config::Method]
10191
+ #
10192
+ attr_reader :fetch_automated_ga4_configuration_opt_out
10193
+ ##
10194
+ # RPC-specific configuration for `get_big_query_link`
10195
+ # @return [::Gapic::Config::Method]
10196
+ #
10197
+ attr_reader :get_big_query_link
10198
+ ##
10199
+ # RPC-specific configuration for `list_big_query_links`
10200
+ # @return [::Gapic::Config::Method]
10201
+ #
10202
+ attr_reader :list_big_query_links
7970
10203
 
7971
10204
  # @private
7972
10205
  def initialize parent_rpcs = nil
@@ -8122,12 +10355,58 @@ module Google
8122
10355
  @update_audience = ::Gapic::Config::Method.new update_audience_config
8123
10356
  archive_audience_config = parent_rpcs.archive_audience if parent_rpcs.respond_to? :archive_audience
8124
10357
  @archive_audience = ::Gapic::Config::Method.new archive_audience_config
10358
+ get_search_ads360_link_config = parent_rpcs.get_search_ads360_link if parent_rpcs.respond_to? :get_search_ads360_link
10359
+ @get_search_ads360_link = ::Gapic::Config::Method.new get_search_ads360_link_config
10360
+ list_search_ads360_links_config = parent_rpcs.list_search_ads360_links if parent_rpcs.respond_to? :list_search_ads360_links
10361
+ @list_search_ads360_links = ::Gapic::Config::Method.new list_search_ads360_links_config
10362
+ create_search_ads360_link_config = parent_rpcs.create_search_ads360_link if parent_rpcs.respond_to? :create_search_ads360_link
10363
+ @create_search_ads360_link = ::Gapic::Config::Method.new create_search_ads360_link_config
10364
+ delete_search_ads360_link_config = parent_rpcs.delete_search_ads360_link if parent_rpcs.respond_to? :delete_search_ads360_link
10365
+ @delete_search_ads360_link = ::Gapic::Config::Method.new delete_search_ads360_link_config
10366
+ update_search_ads360_link_config = parent_rpcs.update_search_ads360_link if parent_rpcs.respond_to? :update_search_ads360_link
10367
+ @update_search_ads360_link = ::Gapic::Config::Method.new update_search_ads360_link_config
8125
10368
  get_attribution_settings_config = parent_rpcs.get_attribution_settings if parent_rpcs.respond_to? :get_attribution_settings
8126
10369
  @get_attribution_settings = ::Gapic::Config::Method.new get_attribution_settings_config
8127
10370
  update_attribution_settings_config = parent_rpcs.update_attribution_settings if parent_rpcs.respond_to? :update_attribution_settings
8128
10371
  @update_attribution_settings = ::Gapic::Config::Method.new update_attribution_settings_config
8129
10372
  run_access_report_config = parent_rpcs.run_access_report if parent_rpcs.respond_to? :run_access_report
8130
10373
  @run_access_report = ::Gapic::Config::Method.new run_access_report_config
10374
+ create_access_binding_config = parent_rpcs.create_access_binding if parent_rpcs.respond_to? :create_access_binding
10375
+ @create_access_binding = ::Gapic::Config::Method.new create_access_binding_config
10376
+ get_access_binding_config = parent_rpcs.get_access_binding if parent_rpcs.respond_to? :get_access_binding
10377
+ @get_access_binding = ::Gapic::Config::Method.new get_access_binding_config
10378
+ update_access_binding_config = parent_rpcs.update_access_binding if parent_rpcs.respond_to? :update_access_binding
10379
+ @update_access_binding = ::Gapic::Config::Method.new update_access_binding_config
10380
+ delete_access_binding_config = parent_rpcs.delete_access_binding if parent_rpcs.respond_to? :delete_access_binding
10381
+ @delete_access_binding = ::Gapic::Config::Method.new delete_access_binding_config
10382
+ list_access_bindings_config = parent_rpcs.list_access_bindings if parent_rpcs.respond_to? :list_access_bindings
10383
+ @list_access_bindings = ::Gapic::Config::Method.new list_access_bindings_config
10384
+ batch_create_access_bindings_config = parent_rpcs.batch_create_access_bindings if parent_rpcs.respond_to? :batch_create_access_bindings
10385
+ @batch_create_access_bindings = ::Gapic::Config::Method.new batch_create_access_bindings_config
10386
+ batch_get_access_bindings_config = parent_rpcs.batch_get_access_bindings if parent_rpcs.respond_to? :batch_get_access_bindings
10387
+ @batch_get_access_bindings = ::Gapic::Config::Method.new batch_get_access_bindings_config
10388
+ batch_update_access_bindings_config = parent_rpcs.batch_update_access_bindings if parent_rpcs.respond_to? :batch_update_access_bindings
10389
+ @batch_update_access_bindings = ::Gapic::Config::Method.new batch_update_access_bindings_config
10390
+ batch_delete_access_bindings_config = parent_rpcs.batch_delete_access_bindings if parent_rpcs.respond_to? :batch_delete_access_bindings
10391
+ @batch_delete_access_bindings = ::Gapic::Config::Method.new batch_delete_access_bindings_config
10392
+ get_expanded_data_set_config = parent_rpcs.get_expanded_data_set if parent_rpcs.respond_to? :get_expanded_data_set
10393
+ @get_expanded_data_set = ::Gapic::Config::Method.new get_expanded_data_set_config
10394
+ list_expanded_data_sets_config = parent_rpcs.list_expanded_data_sets if parent_rpcs.respond_to? :list_expanded_data_sets
10395
+ @list_expanded_data_sets = ::Gapic::Config::Method.new list_expanded_data_sets_config
10396
+ create_expanded_data_set_config = parent_rpcs.create_expanded_data_set if parent_rpcs.respond_to? :create_expanded_data_set
10397
+ @create_expanded_data_set = ::Gapic::Config::Method.new create_expanded_data_set_config
10398
+ update_expanded_data_set_config = parent_rpcs.update_expanded_data_set if parent_rpcs.respond_to? :update_expanded_data_set
10399
+ @update_expanded_data_set = ::Gapic::Config::Method.new update_expanded_data_set_config
10400
+ delete_expanded_data_set_config = parent_rpcs.delete_expanded_data_set if parent_rpcs.respond_to? :delete_expanded_data_set
10401
+ @delete_expanded_data_set = ::Gapic::Config::Method.new delete_expanded_data_set_config
10402
+ set_automated_ga4_configuration_opt_out_config = parent_rpcs.set_automated_ga4_configuration_opt_out if parent_rpcs.respond_to? :set_automated_ga4_configuration_opt_out
10403
+ @set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
10404
+ fetch_automated_ga4_configuration_opt_out_config = parent_rpcs.fetch_automated_ga4_configuration_opt_out if parent_rpcs.respond_to? :fetch_automated_ga4_configuration_opt_out
10405
+ @fetch_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new fetch_automated_ga4_configuration_opt_out_config
10406
+ get_big_query_link_config = parent_rpcs.get_big_query_link if parent_rpcs.respond_to? :get_big_query_link
10407
+ @get_big_query_link = ::Gapic::Config::Method.new get_big_query_link_config
10408
+ list_big_query_links_config = parent_rpcs.list_big_query_links if parent_rpcs.respond_to? :list_big_query_links
10409
+ @list_big_query_links = ::Gapic::Config::Method.new list_big_query_links_config
8131
10410
 
8132
10411
  yield self if block_given?
8133
10412
  end