google-analytics-admin-v1alpha 0.14.0 → 0.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +90 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1614 -274
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +56 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +35 -1
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +8 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +268 -4
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +33 -0
- metadata +6 -6
@@ -349,13 +349,11 @@ module Google
|
|
349
349
|
# # Call the list_accounts method.
|
350
350
|
# result = client.list_accounts request
|
351
351
|
#
|
352
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
353
|
-
# #
|
354
|
-
#
|
355
|
-
# # methods are also available for managing paging directly.
|
356
|
-
# 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|
|
357
355
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::Account.
|
358
|
-
# p
|
356
|
+
# p item
|
359
357
|
# end
|
360
358
|
#
|
361
359
|
def list_accounts request, options = nil
|
@@ -512,8 +510,8 @@ module Google
|
|
512
510
|
# The account's `name` field is used to identify the account.
|
513
511
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
514
512
|
# Required. The list of fields to be updated. Field names must be in snake
|
515
|
-
# case (
|
516
|
-
# replace the entire entity, use one path with the string "*" to match all
|
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
|
517
515
|
# fields.
|
518
516
|
#
|
519
517
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -602,7 +600,7 @@ module Google
|
|
602
600
|
# The account to create.
|
603
601
|
# @param redirect_uri [::String]
|
604
602
|
# Redirect URI where the user will be sent after accepting Terms of Service.
|
605
|
-
# Must be configured in Developers Console as a Redirect URI
|
603
|
+
# Must be configured in Developers Console as a Redirect URI.
|
606
604
|
#
|
607
605
|
# @yield [response, operation] Access the result along with the RPC operation
|
608
606
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse]
|
@@ -709,13 +707,11 @@ module Google
|
|
709
707
|
# # Call the list_account_summaries method.
|
710
708
|
# result = client.list_account_summaries request
|
711
709
|
#
|
712
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
713
|
-
# #
|
714
|
-
#
|
715
|
-
# # methods are also available for managing paging directly.
|
716
|
-
# 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|
|
717
713
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::AccountSummary.
|
718
|
-
# p
|
714
|
+
# p item
|
719
715
|
# end
|
720
716
|
#
|
721
717
|
def list_account_summaries request, options = nil
|
@@ -914,13 +910,11 @@ module Google
|
|
914
910
|
# # Call the list_properties method.
|
915
911
|
# result = client.list_properties request
|
916
912
|
#
|
917
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
918
|
-
# #
|
919
|
-
#
|
920
|
-
# # methods are also available for managing paging directly.
|
921
|
-
# 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|
|
922
916
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::Property.
|
923
|
-
# p
|
917
|
+
# p item
|
924
918
|
# end
|
925
919
|
#
|
926
920
|
def list_properties request, options = nil
|
@@ -1452,13 +1446,11 @@ module Google
|
|
1452
1446
|
# # Call the list_user_links method.
|
1453
1447
|
# result = client.list_user_links request
|
1454
1448
|
#
|
1455
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
1456
|
-
# #
|
1457
|
-
#
|
1458
|
-
# # methods are also available for managing paging directly.
|
1459
|
-
# 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|
|
1460
1452
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::UserLink.
|
1461
|
-
# p
|
1453
|
+
# p item
|
1462
1454
|
# end
|
1463
1455
|
#
|
1464
1456
|
def list_user_links request, options = nil
|
@@ -1562,13 +1554,11 @@ module Google
|
|
1562
1554
|
# # Call the audit_user_links method.
|
1563
1555
|
# result = client.audit_user_links request
|
1564
1556
|
#
|
1565
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
1566
|
-
# #
|
1567
|
-
#
|
1568
|
-
# # methods are also available for managing paging directly.
|
1569
|
-
# 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|
|
1570
1560
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::AuditUserLink.
|
1571
|
-
# p
|
1561
|
+
# p item
|
1572
1562
|
# end
|
1573
1563
|
#
|
1574
1564
|
def audit_user_links request, options = nil
|
@@ -2386,13 +2376,11 @@ module Google
|
|
2386
2376
|
# # Call the list_firebase_links method.
|
2387
2377
|
# result = client.list_firebase_links request
|
2388
2378
|
#
|
2389
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
2390
|
-
# #
|
2391
|
-
#
|
2392
|
-
# # methods are also available for managing paging directly.
|
2393
|
-
# 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|
|
2394
2382
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::FirebaseLink.
|
2395
|
-
# p
|
2383
|
+
# p item
|
2396
2384
|
# end
|
2397
2385
|
#
|
2398
2386
|
def list_firebase_links request, options = nil
|
@@ -2839,13 +2827,11 @@ module Google
|
|
2839
2827
|
# # Call the list_google_ads_links method.
|
2840
2828
|
# result = client.list_google_ads_links request
|
2841
2829
|
#
|
2842
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
2843
|
-
# #
|
2844
|
-
#
|
2845
|
-
# # methods are also available for managing paging directly.
|
2846
|
-
# 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|
|
2847
2833
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::GoogleAdsLink.
|
2848
|
-
# p
|
2834
|
+
# p item
|
2849
2835
|
# end
|
2850
2836
|
#
|
2851
2837
|
def list_google_ads_links request, options = nil
|
@@ -3118,13 +3104,11 @@ module Google
|
|
3118
3104
|
# # Call the list_measurement_protocol_secrets method.
|
3119
3105
|
# result = client.list_measurement_protocol_secrets request
|
3120
3106
|
#
|
3121
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
3122
|
-
# #
|
3123
|
-
#
|
3124
|
-
# # methods are also available for managing paging directly.
|
3125
|
-
# 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|
|
3126
3110
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret.
|
3127
|
-
# p
|
3111
|
+
# p item
|
3128
3112
|
# end
|
3129
3113
|
#
|
3130
3114
|
def list_measurement_protocol_secrets request, options = nil
|
@@ -3435,7 +3419,8 @@ module Google
|
|
3435
3419
|
# Acknowledges the terms of user data collection for the specified property.
|
3436
3420
|
#
|
3437
3421
|
# This acknowledgement must be completed (either in the Google Analytics UI
|
3438
|
-
# or
|
3422
|
+
# or through this API) before MeasurementProtocolSecret resources may be
|
3423
|
+
# created.
|
3439
3424
|
#
|
3440
3425
|
# @overload acknowledge_user_data_collection(request, options = nil)
|
3441
3426
|
# Pass arguments to `acknowledge_user_data_collection` via a request object, either of type
|
@@ -3598,13 +3583,11 @@ module Google
|
|
3598
3583
|
# # Call the search_change_history_events method.
|
3599
3584
|
# result = client.search_change_history_events request
|
3600
3585
|
#
|
3601
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
3602
|
-
# #
|
3603
|
-
#
|
3604
|
-
# # methods are also available for managing paging directly.
|
3605
|
-
# 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|
|
3606
3589
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent.
|
3607
|
-
# p
|
3590
|
+
# p item
|
3608
3591
|
# end
|
3609
3592
|
#
|
3610
3593
|
def search_change_history_events request, options = nil
|
@@ -4141,13 +4124,11 @@ module Google
|
|
4141
4124
|
# # Call the list_conversion_events method.
|
4142
4125
|
# result = client.list_conversion_events request
|
4143
4126
|
#
|
4144
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
4145
|
-
# #
|
4146
|
-
#
|
4147
|
-
# # methods are also available for managing paging directly.
|
4148
|
-
# 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|
|
4149
4130
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::ConversionEvent.
|
4150
|
-
# p
|
4131
|
+
# p item
|
4151
4132
|
# end
|
4152
4133
|
#
|
4153
4134
|
def list_conversion_events request, options = nil
|
@@ -4330,13 +4311,11 @@ module Google
|
|
4330
4311
|
# # Call the list_display_video360_advertiser_links method.
|
4331
4312
|
# result = client.list_display_video360_advertiser_links request
|
4332
4313
|
#
|
4333
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
4334
|
-
# #
|
4335
|
-
#
|
4336
|
-
# # methods are also available for managing paging directly.
|
4337
|
-
# 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|
|
4338
4317
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink.
|
4339
|
-
# p
|
4318
|
+
# p item
|
4340
4319
|
# end
|
4341
4320
|
#
|
4342
4321
|
def list_display_video360_advertiser_links request, options = nil
|
@@ -4786,13 +4765,11 @@ module Google
|
|
4786
4765
|
# # Call the list_display_video360_advertiser_link_proposals method.
|
4787
4766
|
# result = client.list_display_video360_advertiser_link_proposals request
|
4788
4767
|
#
|
4789
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
4790
|
-
# #
|
4791
|
-
#
|
4792
|
-
# # methods are also available for managing paging directly.
|
4793
|
-
# 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|
|
4794
4771
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal.
|
4795
|
-
# p
|
4772
|
+
# p item
|
4796
4773
|
# end
|
4797
4774
|
#
|
4798
4775
|
def list_display_video360_advertiser_link_proposals request, options = nil
|
@@ -5416,13 +5393,11 @@ module Google
|
|
5416
5393
|
# # Call the list_custom_dimensions method.
|
5417
5394
|
# result = client.list_custom_dimensions request
|
5418
5395
|
#
|
5419
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
5420
|
-
# #
|
5421
|
-
#
|
5422
|
-
# # methods are also available for managing paging directly.
|
5423
|
-
# 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|
|
5424
5399
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomDimension.
|
5425
|
-
# p
|
5400
|
+
# p item
|
5426
5401
|
# end
|
5427
5402
|
#
|
5428
5403
|
def list_custom_dimensions request, options = nil
|
@@ -5866,13 +5841,11 @@ module Google
|
|
5866
5841
|
# # Call the list_custom_metrics method.
|
5867
5842
|
# result = client.list_custom_metrics request
|
5868
5843
|
#
|
5869
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
5870
|
-
# #
|
5871
|
-
#
|
5872
|
-
# # methods are also available for managing paging directly.
|
5873
|
-
# 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|
|
5874
5847
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomMetric.
|
5875
|
-
# p
|
5848
|
+
# p item
|
5876
5849
|
# end
|
5877
5850
|
#
|
5878
5851
|
def list_custom_metrics request, options = nil
|
@@ -6581,13 +6554,11 @@ module Google
|
|
6581
6554
|
# # Call the list_data_streams method.
|
6582
6555
|
# result = client.list_data_streams request
|
6583
6556
|
#
|
6584
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
6585
|
-
# #
|
6586
|
-
#
|
6587
|
-
# # methods are also available for managing paging directly.
|
6588
|
-
# 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|
|
6589
6560
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::DataStream.
|
6590
|
-
# p
|
6561
|
+
# p item
|
6591
6562
|
# end
|
6592
6563
|
#
|
6593
6564
|
def list_data_streams request, options = nil
|
@@ -6859,13 +6830,11 @@ module Google
|
|
6859
6830
|
# # Call the list_audiences method.
|
6860
6831
|
# result = client.list_audiences request
|
6861
6832
|
#
|
6862
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
6863
|
-
# #
|
6864
|
-
#
|
6865
|
-
# # methods are also available for managing paging directly.
|
6866
|
-
# 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|
|
6867
6836
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::Audience.
|
6868
|
-
# p
|
6837
|
+
# p item
|
6869
6838
|
# end
|
6870
6839
|
#
|
6871
6840
|
def list_audiences request, options = nil
|
@@ -7311,13 +7280,11 @@ module Google
|
|
7311
7280
|
# # Call the list_search_ads360_links method.
|
7312
7281
|
# result = client.list_search_ads360_links request
|
7313
7282
|
#
|
7314
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
7315
|
-
# #
|
7316
|
-
#
|
7317
|
-
# # methods are also available for managing paging directly.
|
7318
|
-
# result.each do |response|
|
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|
|
7319
7286
|
# # Each element is of type ::Google::Analytics::Admin::V1alpha::SearchAds360Link.
|
7320
|
-
# p
|
7287
|
+
# p item
|
7321
7288
|
# end
|
7322
7289
|
#
|
7323
7290
|
def list_search_ads360_links request, options = nil
|
@@ -7848,7 +7815,7 @@ module Google
|
|
7848
7815
|
# included in the response rows for both date ranges. Requests are allowed up
|
7849
7816
|
# to 2 date ranges.
|
7850
7817
|
# @param dimension_filter [::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash]
|
7851
|
-
# Dimension filters
|
7818
|
+
# Dimension filters let you restrict report response to specific
|
7852
7819
|
# dimension values which match the filter. For example, filtering on access
|
7853
7820
|
# records of a single user. To learn more, see [Fundamentals of Dimension
|
7854
7821
|
# Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
|
@@ -7957,38 +7924,35 @@ module Google
|
|
7957
7924
|
end
|
7958
7925
|
|
7959
7926
|
##
|
7960
|
-
#
|
7961
|
-
# property.
|
7962
|
-
# Note: this has no effect on GA4 property.
|
7927
|
+
# Creates an access binding on an account or property.
|
7963
7928
|
#
|
7964
|
-
# @overload
|
7965
|
-
# Pass arguments to `
|
7966
|
-
# {::Google::Analytics::Admin::V1alpha::
|
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.
|
7967
7932
|
#
|
7968
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
7933
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest, ::Hash]
|
7969
7934
|
# A request object representing the call parameters. Required. To specify no
|
7970
7935
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7971
7936
|
# @param options [::Gapic::CallOptions, ::Hash]
|
7972
7937
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7973
7938
|
#
|
7974
|
-
# @overload
|
7975
|
-
# Pass arguments to `
|
7939
|
+
# @overload create_access_binding(parent: nil, access_binding: nil)
|
7940
|
+
# Pass arguments to `create_access_binding` via keyword arguments. Note that at
|
7976
7941
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
7977
7942
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
7978
7943
|
#
|
7979
|
-
# @param
|
7980
|
-
# Required.
|
7981
|
-
#
|
7982
|
-
#
|
7983
|
-
#
|
7984
|
-
#
|
7985
|
-
# The status to set.
|
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.
|
7986
7950
|
#
|
7987
7951
|
# @yield [response, operation] Access the result along with the RPC operation
|
7988
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
7952
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AccessBinding]
|
7989
7953
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7990
7954
|
#
|
7991
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
7955
|
+
# @return [::Google::Analytics::Admin::V1alpha::AccessBinding]
|
7992
7956
|
#
|
7993
7957
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7994
7958
|
#
|
@@ -7999,24 +7963,24 @@ module Google
|
|
7999
7963
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8000
7964
|
#
|
8001
7965
|
# # Create a request. To set request fields, pass in keyword arguments.
|
8002
|
-
# request = Google::Analytics::Admin::V1alpha::
|
7966
|
+
# request = Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest.new
|
8003
7967
|
#
|
8004
|
-
# # Call the
|
8005
|
-
# result = client.
|
7968
|
+
# # Call the create_access_binding method.
|
7969
|
+
# result = client.create_access_binding request
|
8006
7970
|
#
|
8007
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::
|
7971
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::AccessBinding.
|
8008
7972
|
# p result
|
8009
7973
|
#
|
8010
|
-
def
|
7974
|
+
def create_access_binding request, options = nil
|
8011
7975
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
8012
7976
|
|
8013
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
7977
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest
|
8014
7978
|
|
8015
7979
|
# Converts hash and nil to an options object
|
8016
7980
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8017
7981
|
|
8018
7982
|
# Customize the options with defaults
|
8019
|
-
metadata = @config.rpcs.
|
7983
|
+
metadata = @config.rpcs.create_access_binding.metadata.to_h
|
8020
7984
|
|
8021
7985
|
# Set x-goog-api-client and x-goog-user-project headers
|
8022
7986
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -8024,15 +7988,23 @@ module Google
|
|
8024
7988
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
8025
7989
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8026
7990
|
|
8027
|
-
|
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,
|
8028
8000
|
metadata: metadata,
|
8029
|
-
retry_policy: @config.rpcs.
|
8001
|
+
retry_policy: @config.rpcs.create_access_binding.retry_policy
|
8030
8002
|
|
8031
8003
|
options.apply_defaults timeout: @config.timeout,
|
8032
8004
|
metadata: @config.metadata,
|
8033
8005
|
retry_policy: @config.retry_policy
|
8034
8006
|
|
8035
|
-
@analytics_admin_service_stub.call_rpc :
|
8007
|
+
@analytics_admin_service_stub.call_rpc :create_access_binding, request, options: options do |response, operation|
|
8036
8008
|
yield response, operation if block_given?
|
8037
8009
|
return response
|
8038
8010
|
end
|
@@ -8041,36 +8013,34 @@ module Google
|
|
8041
8013
|
end
|
8042
8014
|
|
8043
8015
|
##
|
8044
|
-
#
|
8045
|
-
# property.
|
8046
|
-
# Note: this has no effect on GA4 property.
|
8016
|
+
# Gets information about an access binding.
|
8047
8017
|
#
|
8048
|
-
# @overload
|
8049
|
-
# Pass arguments to `
|
8050
|
-
# {::Google::Analytics::Admin::V1alpha::
|
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.
|
8051
8021
|
#
|
8052
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
8022
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetAccessBindingRequest, ::Hash]
|
8053
8023
|
# A request object representing the call parameters. Required. To specify no
|
8054
8024
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8055
8025
|
# @param options [::Gapic::CallOptions, ::Hash]
|
8056
8026
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
8057
8027
|
#
|
8058
|
-
# @overload
|
8059
|
-
# Pass arguments to `
|
8028
|
+
# @overload get_access_binding(name: nil)
|
8029
|
+
# Pass arguments to `get_access_binding` via keyword arguments. Note that at
|
8060
8030
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
8061
8031
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
8062
8032
|
#
|
8063
|
-
# @param
|
8064
|
-
# Required. The
|
8065
|
-
#
|
8066
|
-
#
|
8067
|
-
#
|
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}
|
8068
8038
|
#
|
8069
8039
|
# @yield [response, operation] Access the result along with the RPC operation
|
8070
|
-
# @yieldparam response [::Google::Analytics::Admin::V1alpha::
|
8040
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AccessBinding]
|
8071
8041
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
8072
8042
|
#
|
8073
|
-
# @return [::Google::Analytics::Admin::V1alpha::
|
8043
|
+
# @return [::Google::Analytics::Admin::V1alpha::AccessBinding]
|
8074
8044
|
#
|
8075
8045
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
8076
8046
|
#
|
@@ -8081,24 +8051,24 @@ module Google
|
|
8081
8051
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8082
8052
|
#
|
8083
8053
|
# # Create a request. To set request fields, pass in keyword arguments.
|
8084
|
-
# request = Google::Analytics::Admin::V1alpha::
|
8054
|
+
# request = Google::Analytics::Admin::V1alpha::GetAccessBindingRequest.new
|
8085
8055
|
#
|
8086
|
-
# # Call the
|
8087
|
-
# result = client.
|
8056
|
+
# # Call the get_access_binding method.
|
8057
|
+
# result = client.get_access_binding request
|
8088
8058
|
#
|
8089
|
-
# # The returned object is of type Google::Analytics::Admin::V1alpha::
|
8059
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::AccessBinding.
|
8090
8060
|
# p result
|
8091
8061
|
#
|
8092
|
-
def
|
8062
|
+
def get_access_binding request, options = nil
|
8093
8063
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
8094
8064
|
|
8095
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
8065
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAccessBindingRequest
|
8096
8066
|
|
8097
8067
|
# Converts hash and nil to an options object
|
8098
8068
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8099
8069
|
|
8100
8070
|
# Customize the options with defaults
|
8101
|
-
metadata = @config.rpcs.
|
8071
|
+
metadata = @config.rpcs.get_access_binding.metadata.to_h
|
8102
8072
|
|
8103
8073
|
# Set x-goog-api-client and x-goog-user-project headers
|
8104
8074
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -8106,15 +8076,23 @@ module Google
|
|
8106
8076
|
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
8107
8077
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8108
8078
|
|
8109
|
-
|
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,
|
8110
8088
|
metadata: metadata,
|
8111
|
-
retry_policy: @config.rpcs.
|
8089
|
+
retry_policy: @config.rpcs.get_access_binding.retry_policy
|
8112
8090
|
|
8113
8091
|
options.apply_defaults timeout: @config.timeout,
|
8114
8092
|
metadata: @config.metadata,
|
8115
8093
|
retry_policy: @config.retry_policy
|
8116
8094
|
|
8117
|
-
@analytics_admin_service_stub.call_rpc :
|
8095
|
+
@analytics_admin_service_stub.call_rpc :get_access_binding, request, options: options do |response, operation|
|
8118
8096
|
yield response, operation if block_given?
|
8119
8097
|
return response
|
8120
8098
|
end
|
@@ -8123,33 +8101,118 @@ module Google
|
|
8123
8101
|
end
|
8124
8102
|
|
8125
8103
|
##
|
8126
|
-
#
|
8104
|
+
# Updates an access binding on an account or property.
|
8127
8105
|
#
|
8128
|
-
# @overload
|
8129
|
-
# Pass arguments to `
|
8130
|
-
# {::Google::Analytics::Admin::V1alpha::
|
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.
|
8131
8109
|
#
|
8132
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
8110
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest, ::Hash]
|
8133
8111
|
# A request object representing the call parameters. Required. To specify no
|
8134
8112
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8135
8113
|
# @param options [::Gapic::CallOptions, ::Hash]
|
8136
8114
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
8137
8115
|
#
|
8138
|
-
# @overload
|
8139
|
-
# Pass arguments to `
|
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
|
8140
8203
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
8141
8204
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
8142
8205
|
#
|
8143
8206
|
# @param name [::String]
|
8144
|
-
# Required.
|
8145
|
-
#
|
8146
|
-
#
|
8207
|
+
# Required. Formats:
|
8208
|
+
# - accounts/\\{account}/accessBindings/\\{accessBinding}
|
8209
|
+
# - properties/\\{property}/accessBindings/\\{accessBinding}
|
8147
8210
|
#
|
8148
8211
|
# @yield [response, operation] Access the result along with the RPC operation
|
8149
|
-
# @yieldparam response [::Google::
|
8212
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
8150
8213
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
8151
8214
|
#
|
8152
|
-
# @return [::Google::
|
8215
|
+
# @return [::Google::Protobuf::Empty]
|
8153
8216
|
#
|
8154
8217
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
8155
8218
|
#
|
@@ -8160,24 +8223,24 @@ module Google
|
|
8160
8223
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8161
8224
|
#
|
8162
8225
|
# # Create a request. To set request fields, pass in keyword arguments.
|
8163
|
-
# request = Google::Analytics::Admin::V1alpha::
|
8226
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest.new
|
8164
8227
|
#
|
8165
|
-
# # Call the
|
8166
|
-
# result = client.
|
8228
|
+
# # Call the delete_access_binding method.
|
8229
|
+
# result = client.delete_access_binding request
|
8167
8230
|
#
|
8168
|
-
# # The returned object is of type Google::
|
8231
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
8169
8232
|
# p result
|
8170
8233
|
#
|
8171
|
-
def
|
8234
|
+
def delete_access_binding request, options = nil
|
8172
8235
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
8173
8236
|
|
8174
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
8237
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest
|
8175
8238
|
|
8176
8239
|
# Converts hash and nil to an options object
|
8177
8240
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8178
8241
|
|
8179
8242
|
# Customize the options with defaults
|
8180
|
-
metadata = @config.rpcs.
|
8243
|
+
metadata = @config.rpcs.delete_access_binding.metadata.to_h
|
8181
8244
|
|
8182
8245
|
# Set x-goog-api-client and x-goog-user-project headers
|
8183
8246
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -8193,15 +8256,15 @@ module Google
|
|
8193
8256
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
8194
8257
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
8195
8258
|
|
8196
|
-
options.apply_defaults timeout: @config.rpcs.
|
8259
|
+
options.apply_defaults timeout: @config.rpcs.delete_access_binding.timeout,
|
8197
8260
|
metadata: metadata,
|
8198
|
-
retry_policy: @config.rpcs.
|
8261
|
+
retry_policy: @config.rpcs.delete_access_binding.retry_policy
|
8199
8262
|
|
8200
8263
|
options.apply_defaults timeout: @config.timeout,
|
8201
8264
|
metadata: @config.metadata,
|
8202
8265
|
retry_policy: @config.retry_policy
|
8203
8266
|
|
8204
|
-
@analytics_admin_service_stub.call_rpc :
|
8267
|
+
@analytics_admin_service_stub.call_rpc :delete_access_binding, request, options: options do |response, operation|
|
8205
8268
|
yield response, operation if block_given?
|
8206
8269
|
return response
|
8207
8270
|
end
|
@@ -8210,43 +8273,43 @@ module Google
|
|
8210
8273
|
end
|
8211
8274
|
|
8212
8275
|
##
|
8213
|
-
# Lists
|
8276
|
+
# Lists all access bindings on an account or property.
|
8214
8277
|
#
|
8215
|
-
# @overload
|
8216
|
-
# Pass arguments to `
|
8217
|
-
# {::Google::Analytics::Admin::V1alpha::
|
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.
|
8218
8281
|
#
|
8219
|
-
# @param request [::Google::Analytics::Admin::V1alpha::
|
8282
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest, ::Hash]
|
8220
8283
|
# A request object representing the call parameters. Required. To specify no
|
8221
8284
|
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8222
8285
|
# @param options [::Gapic::CallOptions, ::Hash]
|
8223
8286
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
8224
8287
|
#
|
8225
|
-
# @overload
|
8226
|
-
# Pass arguments to `
|
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
|
8227
8290
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
8228
8291
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
8229
8292
|
#
|
8230
8293
|
# @param parent [::String]
|
8231
|
-
# Required.
|
8232
|
-
#
|
8233
|
-
#
|
8294
|
+
# Required. Formats:
|
8295
|
+
# - accounts/\\{account}
|
8296
|
+
# - properties/\\{property}
|
8234
8297
|
# @param page_size [::Integer]
|
8235
|
-
# The maximum number of
|
8236
|
-
# fewer than this value
|
8237
|
-
# If unspecified, at most
|
8238
|
-
# The maximum value is
|
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.
|
8239
8302
|
# @param page_token [::String]
|
8240
|
-
# A page token, received from a previous `
|
8303
|
+
# A page token, received from a previous `ListAccessBindings` call.
|
8241
8304
|
# Provide this to retrieve the subsequent page.
|
8242
|
-
# When paginating, all other parameters provided to `
|
8305
|
+
# When paginating, all other parameters provided to `ListAccessBindings` must
|
8243
8306
|
# match the call that provided the page token.
|
8244
8307
|
#
|
8245
8308
|
# @yield [response, operation] Access the result along with the RPC operation
|
8246
|
-
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::
|
8309
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>]
|
8247
8310
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
8248
8311
|
#
|
8249
|
-
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::
|
8312
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>]
|
8250
8313
|
#
|
8251
8314
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
8252
8315
|
#
|
@@ -8257,30 +8320,28 @@ module Google
|
|
8257
8320
|
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8258
8321
|
#
|
8259
8322
|
# # Create a request. To set request fields, pass in keyword arguments.
|
8260
|
-
# request = Google::Analytics::Admin::V1alpha::
|
8323
|
+
# request = Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest.new
|
8261
8324
|
#
|
8262
|
-
# # Call the
|
8263
|
-
# result = client.
|
8325
|
+
# # Call the list_access_bindings method.
|
8326
|
+
# result = client.list_access_bindings request
|
8264
8327
|
#
|
8265
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
8266
|
-
# #
|
8267
|
-
#
|
8268
|
-
#
|
8269
|
-
#
|
8270
|
-
# # Each element is of type ::Google::Analytics::Admin::V1alpha::BigQueryLink.
|
8271
|
-
# p response
|
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
|
8272
8333
|
# end
|
8273
8334
|
#
|
8274
|
-
def
|
8335
|
+
def list_access_bindings request, options = nil
|
8275
8336
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
8276
8337
|
|
8277
|
-
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::
|
8338
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest
|
8278
8339
|
|
8279
8340
|
# Converts hash and nil to an options object
|
8280
8341
|
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8281
8342
|
|
8282
8343
|
# Customize the options with defaults
|
8283
|
-
metadata = @config.rpcs.
|
8344
|
+
metadata = @config.rpcs.list_access_bindings.metadata.to_h
|
8284
8345
|
|
8285
8346
|
# Set x-goog-api-client and x-goog-user-project headers
|
8286
8347
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
@@ -8296,16 +8357,16 @@ module Google
|
|
8296
8357
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
8297
8358
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
8298
8359
|
|
8299
|
-
options.apply_defaults timeout: @config.rpcs.
|
8360
|
+
options.apply_defaults timeout: @config.rpcs.list_access_bindings.timeout,
|
8300
8361
|
metadata: metadata,
|
8301
|
-
retry_policy: @config.rpcs.
|
8362
|
+
retry_policy: @config.rpcs.list_access_bindings.retry_policy
|
8302
8363
|
|
8303
8364
|
options.apply_defaults timeout: @config.timeout,
|
8304
8365
|
metadata: @config.metadata,
|
8305
8366
|
retry_policy: @config.retry_policy
|
8306
8367
|
|
8307
|
-
@analytics_admin_service_stub.call_rpc :
|
8308
|
-
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :
|
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
|
8309
8370
|
yield response, operation if block_given?
|
8310
8371
|
return response
|
8311
8372
|
end
|
@@ -8314,68 +8375,1249 @@ module Google
|
|
8314
8375
|
end
|
8315
8376
|
|
8316
8377
|
##
|
8317
|
-
#
|
8378
|
+
# Creates information about multiple access bindings to an account or
|
8379
|
+
# property.
|
8318
8380
|
#
|
8319
|
-
# This
|
8320
|
-
#
|
8321
|
-
# parameters, and other low-level controls. Certain parameters can also be
|
8322
|
-
# applied individually to specific RPCs. See
|
8323
|
-
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
8324
|
-
# for a list of RPCs that can be configured independently.
|
8381
|
+
# This method is transactional. If any AccessBinding cannot be created, none
|
8382
|
+
# of the AccessBindings will be created.
|
8325
8383
|
#
|
8326
|
-
#
|
8327
|
-
#
|
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.
|
8328
8387
|
#
|
8329
|
-
#
|
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.
|
8330
8393
|
#
|
8331
|
-
#
|
8332
|
-
#
|
8333
|
-
#
|
8334
|
-
#
|
8335
|
-
# config.timeout = 10.0
|
8336
|
-
# config.rpcs.get_account.timeout = 20.0
|
8337
|
-
# end
|
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).
|
8338
8398
|
#
|
8339
|
-
#
|
8340
|
-
#
|
8341
|
-
#
|
8342
|
-
#
|
8343
|
-
#
|
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.
|
8344
8408
|
#
|
8345
|
-
#
|
8346
|
-
#
|
8347
|
-
#
|
8348
|
-
#
|
8349
|
-
#
|
8350
|
-
#
|
8351
|
-
#
|
8352
|
-
#
|
8353
|
-
#
|
8354
|
-
#
|
8355
|
-
#
|
8356
|
-
#
|
8357
|
-
#
|
8358
|
-
#
|
8359
|
-
#
|
8360
|
-
#
|
8361
|
-
#
|
8362
|
-
#
|
8363
|
-
#
|
8364
|
-
#
|
8365
|
-
# The
|
8366
|
-
#
|
8367
|
-
#
|
8368
|
-
|
8369
|
-
|
8370
|
-
|
8371
|
-
|
8372
|
-
|
8373
|
-
|
8374
|
-
|
8375
|
-
|
8376
|
-
|
8377
|
-
|
8378
|
-
|
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.
|
8379
9621
|
# @return [::Numeric]
|
8380
9622
|
# @!attribute [rw] metadata
|
8381
9623
|
# Additional gRPC headers to be sent with the call.
|
@@ -8869,6 +10111,76 @@ module Google
|
|
8869
10111
|
#
|
8870
10112
|
attr_reader :run_access_report
|
8871
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
|
+
##
|
8872
10184
|
# RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
|
8873
10185
|
# @return [::Gapic::Config::Method]
|
8874
10186
|
#
|
@@ -9059,6 +10371,34 @@ module Google
|
|
9059
10371
|
@update_attribution_settings = ::Gapic::Config::Method.new update_attribution_settings_config
|
9060
10372
|
run_access_report_config = parent_rpcs.run_access_report if parent_rpcs.respond_to? :run_access_report
|
9061
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
|
9062
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
|
9063
10403
|
@set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
|
9064
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
|