google-analytics-admin-v1alpha 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +1 -1
- data/lib/google/analytics/admin/v1alpha/access_report_pb.rb +159 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_pb.rb +122 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb +1941 -163
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service/paths.rb +65 -0
- data/lib/google/analytics/admin/v1alpha/analytics_admin_service.rb +1 -1
- data/lib/google/analytics/admin/v1alpha/analytics_admin_services_pb.rb +55 -1
- data/lib/google/analytics/admin/v1alpha/audience_pb.rb +164 -0
- data/lib/google/analytics/admin/v1alpha/expanded_data_set_pb.rb +69 -0
- data/lib/google/analytics/admin/v1alpha/resources_pb.rb +71 -0
- data/lib/google/analytics/admin/v1alpha/version.rb +1 -1
- data/lib/google/analytics/admin/v1alpha.rb +2 -2
- data/proto_docs/google/analytics/admin/v1alpha/access_report.rb +389 -0
- data/proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb +445 -49
- data/proto_docs/google/analytics/admin/v1alpha/audience.rb +413 -0
- data/proto_docs/google/analytics/admin/v1alpha/expanded_data_set.rb +156 -0
- data/proto_docs/google/analytics/admin/v1alpha/resources.rb +294 -56
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +0 -2
- metadata +14 -5
@@ -69,6 +69,62 @@ module Google
|
|
69
69
|
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
|
70
70
|
}
|
71
71
|
|
72
|
+
default_config.rpcs.get_account.timeout = 60.0
|
73
|
+
|
74
|
+
default_config.rpcs.list_accounts.timeout = 60.0
|
75
|
+
|
76
|
+
default_config.rpcs.delete_account.timeout = 60.0
|
77
|
+
|
78
|
+
default_config.rpcs.update_account.timeout = 60.0
|
79
|
+
|
80
|
+
default_config.rpcs.provision_account_ticket.timeout = 60.0
|
81
|
+
|
82
|
+
default_config.rpcs.get_property.timeout = 60.0
|
83
|
+
|
84
|
+
default_config.rpcs.list_properties.timeout = 60.0
|
85
|
+
|
86
|
+
default_config.rpcs.create_property.timeout = 60.0
|
87
|
+
|
88
|
+
default_config.rpcs.delete_property.timeout = 60.0
|
89
|
+
|
90
|
+
default_config.rpcs.update_property.timeout = 60.0
|
91
|
+
|
92
|
+
default_config.rpcs.get_user_link.timeout = 60.0
|
93
|
+
|
94
|
+
default_config.rpcs.batch_get_user_links.timeout = 60.0
|
95
|
+
|
96
|
+
default_config.rpcs.list_user_links.timeout = 60.0
|
97
|
+
|
98
|
+
default_config.rpcs.audit_user_links.timeout = 60.0
|
99
|
+
|
100
|
+
default_config.rpcs.create_user_link.timeout = 60.0
|
101
|
+
|
102
|
+
default_config.rpcs.batch_create_user_links.timeout = 60.0
|
103
|
+
|
104
|
+
default_config.rpcs.update_user_link.timeout = 60.0
|
105
|
+
|
106
|
+
default_config.rpcs.batch_update_user_links.timeout = 60.0
|
107
|
+
|
108
|
+
default_config.rpcs.delete_user_link.timeout = 60.0
|
109
|
+
|
110
|
+
default_config.rpcs.batch_delete_user_links.timeout = 60.0
|
111
|
+
|
112
|
+
default_config.rpcs.create_firebase_link.timeout = 60.0
|
113
|
+
|
114
|
+
default_config.rpcs.delete_firebase_link.timeout = 60.0
|
115
|
+
|
116
|
+
default_config.rpcs.list_firebase_links.timeout = 60.0
|
117
|
+
|
118
|
+
default_config.rpcs.get_global_site_tag.timeout = 60.0
|
119
|
+
|
120
|
+
default_config.rpcs.create_google_ads_link.timeout = 60.0
|
121
|
+
|
122
|
+
default_config.rpcs.update_google_ads_link.timeout = 60.0
|
123
|
+
|
124
|
+
default_config.rpcs.delete_google_ads_link.timeout = 60.0
|
125
|
+
|
126
|
+
default_config.rpcs.list_google_ads_links.timeout = 60.0
|
127
|
+
|
72
128
|
default_config
|
73
129
|
end
|
74
130
|
yield @configure if block_given?
|
@@ -455,9 +511,10 @@ module Google
|
|
455
511
|
# Required. The account to update.
|
456
512
|
# The account's `name` field is used to identify the account.
|
457
513
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
458
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
459
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
460
|
-
# the entire entity, use one path with the string "*" to match all
|
514
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
515
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
516
|
+
# replace the entire entity, use one path with the string "*" to match all
|
517
|
+
# fields.
|
461
518
|
#
|
462
519
|
# @yield [response, operation] Access the result along with the RPC operation
|
463
520
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Account]
|
@@ -989,7 +1046,7 @@ module Google
|
|
989
1046
|
# will be permanently purged.
|
990
1047
|
# https://support.google.com/analytics/answer/6154772
|
991
1048
|
#
|
992
|
-
# Returns an error if the target is not found, or is not
|
1049
|
+
# Returns an error if the target is not found, or is not a GA4 Property.
|
993
1050
|
#
|
994
1051
|
# @overload delete_property(request, options = nil)
|
995
1052
|
# Pass arguments to `delete_property` via a request object, either of type
|
@@ -1098,9 +1155,10 @@ module Google
|
|
1098
1155
|
# The property's `name` field is used to identify the property to be
|
1099
1156
|
# updated.
|
1100
1157
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1101
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
1102
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
1103
|
-
# the entire entity, use one path with the string "*" to match all
|
1158
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
1159
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
1160
|
+
# replace the entire entity, use one path with the string "*" to match all
|
1161
|
+
# fields.
|
1104
1162
|
#
|
1105
1163
|
# @yield [response, operation] Access the result along with the RPC operation
|
1106
1164
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Property]
|
@@ -1580,8 +1638,8 @@ module Google
|
|
1580
1638
|
# @param parent [::String]
|
1581
1639
|
# Required. Example format: accounts/1234
|
1582
1640
|
# @param notify_new_user [::Boolean]
|
1583
|
-
# Optional. If set, then email the new user notifying them that they've been
|
1584
|
-
# permissions to the resource.
|
1641
|
+
# Optional. If set, then email the new user notifying them that they've been
|
1642
|
+
# granted permissions to the resource.
|
1585
1643
|
# @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
|
1586
1644
|
# Required. The user link to create.
|
1587
1645
|
#
|
@@ -1671,14 +1729,14 @@ module Google
|
|
1671
1729
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1672
1730
|
#
|
1673
1731
|
# @param parent [::String]
|
1674
|
-
# Required. The account or property that all user links in the request are
|
1675
|
-
# This field is required. The parent field in the CreateUserLinkRequest
|
1732
|
+
# Required. The account or property that all user links in the request are
|
1733
|
+
# for. This field is required. The parent field in the CreateUserLinkRequest
|
1676
1734
|
# messages must either be empty or match this field.
|
1677
1735
|
# Example format: accounts/1234
|
1678
1736
|
# @param notify_new_users [::Boolean]
|
1679
|
-
# Optional. If set, then email the new users notifying them that they've been
|
1680
|
-
# permissions to the resource. Regardless of whether this is set or
|
1681
|
-
# notify_new_user field inside each individual request is ignored.
|
1737
|
+
# Optional. If set, then email the new users notifying them that they've been
|
1738
|
+
# granted permissions to the resource. Regardless of whether this is set or
|
1739
|
+
# not, notify_new_user field inside each individual request is ignored.
|
1682
1740
|
# @param requests [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash>]
|
1683
1741
|
# Required. The requests specifying the user links to create.
|
1684
1742
|
# A maximum of 1000 user links can be created in a batch.
|
@@ -2305,7 +2363,7 @@ module Google
|
|
2305
2363
|
# @param page_token [::String]
|
2306
2364
|
# A page token, received from a previous `ListFirebaseLinks` call.
|
2307
2365
|
# Provide this to retrieve the subsequent page.
|
2308
|
-
# When paginating, all other parameters provided to `
|
2366
|
+
# When paginating, all other parameters provided to `ListFirebaseLinks` must
|
2309
2367
|
# match the call that provided the page token.
|
2310
2368
|
#
|
2311
2369
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -2576,9 +2634,10 @@ module Google
|
|
2576
2634
|
# @param google_ads_link [::Google::Analytics::Admin::V1alpha::GoogleAdsLink, ::Hash]
|
2577
2635
|
# The GoogleAdsLink to update
|
2578
2636
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2579
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
2580
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
2581
|
-
# the entire entity, use one path with the string "*" to match all
|
2637
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
2638
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
2639
|
+
# replace the entire entity, use one path with the string "*" to match all
|
2640
|
+
# fields.
|
2582
2641
|
#
|
2583
2642
|
# @yield [response, operation] Access the result along with the RPC operation
|
2584
2643
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleAdsLink]
|
@@ -3396,8 +3455,8 @@ module Google
|
|
3396
3455
|
# @param property [::String]
|
3397
3456
|
# Required. The property for which to acknowledge user data collection.
|
3398
3457
|
# @param acknowledgement [::String]
|
3399
|
-
# Required. An acknowledgement that the caller of this method understands the
|
3400
|
-
# of user data collection.
|
3458
|
+
# Required. An acknowledgement that the caller of this method understands the
|
3459
|
+
# terms of user data collection.
|
3401
3460
|
#
|
3402
3461
|
# This field must contain the exact value:
|
3403
3462
|
# "I acknowledge that I have the necessary privacy disclosures and rights
|
@@ -3489,18 +3548,20 @@ module Google
|
|
3489
3548
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
3490
3549
|
#
|
3491
3550
|
# @param account [::String]
|
3492
|
-
# Required. The account resource for which to return change history
|
3551
|
+
# Required. The account resource for which to return change history
|
3552
|
+
# resources.
|
3493
3553
|
# @param property [::String]
|
3494
3554
|
# Optional. Resource name for a child property. If set, only return changes
|
3495
3555
|
# made to this property or its child resources.
|
3496
3556
|
# @param resource_type [::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>]
|
3497
|
-
# Optional. If set, only return changes if they are for a resource that
|
3498
|
-
# least one of these types.
|
3557
|
+
# Optional. If set, only return changes if they are for a resource that
|
3558
|
+
# matches at least one of these types.
|
3499
3559
|
# @param action [::Array<::Google::Analytics::Admin::V1alpha::ActionType>]
|
3500
|
-
# Optional. If set, only return changes that match one or more of these types
|
3501
|
-
# actions.
|
3560
|
+
# Optional. If set, only return changes that match one or more of these types
|
3561
|
+
# of actions.
|
3502
3562
|
# @param actor_email [::Array<::String>]
|
3503
|
-
# Optional. If set, only return changes if they are made by a user in this
|
3563
|
+
# Optional. If set, only return changes if they are made by a user in this
|
3564
|
+
# list.
|
3504
3565
|
# @param earliest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
3505
3566
|
# Optional. If set, only return changes made after this time (inclusive).
|
3506
3567
|
# @param latest_change_time [::Google::Protobuf::Timestamp, ::Hash]
|
@@ -3511,10 +3572,11 @@ module Google
|
|
3511
3572
|
# pages. If unspecified, at most 50 items will be returned.
|
3512
3573
|
# The maximum value is 200 (higher values will be coerced to the maximum).
|
3513
3574
|
# @param page_token [::String]
|
3514
|
-
# Optional. A page token, received from a previous
|
3515
|
-
# Provide this to retrieve the subsequent
|
3516
|
-
#
|
3517
|
-
# provided the page
|
3575
|
+
# Optional. A page token, received from a previous
|
3576
|
+
# `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent
|
3577
|
+
# page. When paginating, all other parameters provided to
|
3578
|
+
# `SearchChangeHistoryEvents` must match the call that provided the page
|
3579
|
+
# token.
|
3518
3580
|
#
|
3519
3581
|
# @yield [response, operation] Access the result along with the RPC operation
|
3520
3582
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>]
|
@@ -3695,9 +3757,10 @@ module Google
|
|
3695
3757
|
# Required. The settings to update.
|
3696
3758
|
# The `name` field is used to identify the settings to be updated.
|
3697
3759
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
3698
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
3699
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
3700
|
-
# the entire entity, use one path with the string "*" to match all
|
3760
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
3761
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
3762
|
+
# replace the entire entity, use one path with the string "*" to match all
|
3763
|
+
# fields.
|
3701
3764
|
#
|
3702
3765
|
# @yield [response, operation] Access the result along with the RPC operation
|
3703
3766
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings]
|
@@ -3784,8 +3847,8 @@ module Google
|
|
3784
3847
|
# @param conversion_event [::Google::Analytics::Admin::V1alpha::ConversionEvent, ::Hash]
|
3785
3848
|
# Required. The conversion event to create.
|
3786
3849
|
# @param parent [::String]
|
3787
|
-
# Required. The resource name of the parent property where this conversion
|
3788
|
-
# be created. Format: properties/123
|
3850
|
+
# Required. The resource name of the parent property where this conversion
|
3851
|
+
# event will be created. Format: properties/123
|
3789
3852
|
#
|
3790
3853
|
# @yield [response, operation] Access the result along with the RPC operation
|
3791
3854
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::ConversionEvent]
|
@@ -4516,9 +4579,9 @@ module Google
|
|
4516
4579
|
# @param display_video_360_advertiser_link [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink, ::Hash]
|
4517
4580
|
# The DisplayVideo360AdvertiserLink to update
|
4518
4581
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
4519
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
4520
|
-
# To replace the entire entity, use one path with the string "*" to
|
4521
|
-
# all fields.
|
4582
|
+
# Required. The list of fields to be updated. Omitted fields will not be
|
4583
|
+
# updated. To replace the entire entity, use one path with the string "*" to
|
4584
|
+
# match all fields.
|
4522
4585
|
#
|
4523
4586
|
# @yield [response, operation] Access the result along with the RPC operation
|
4524
4587
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink]
|
@@ -5234,9 +5297,9 @@ module Google
|
|
5234
5297
|
# @param custom_dimension [::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash]
|
5235
5298
|
# The CustomDimension to update
|
5236
5299
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
5237
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
5238
|
-
# To replace the entire entity, use one path with the string "*" to
|
5239
|
-
# all fields.
|
5300
|
+
# Required. The list of fields to be updated. Omitted fields will not be
|
5301
|
+
# updated. To replace the entire entity, use one path with the string "*" to
|
5302
|
+
# match all fields.
|
5240
5303
|
#
|
5241
5304
|
# @yield [response, operation] Access the result along with the RPC operation
|
5242
5305
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomDimension]
|
@@ -5684,9 +5747,9 @@ module Google
|
|
5684
5747
|
# @param custom_metric [::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash]
|
5685
5748
|
# The CustomMetric to update
|
5686
5749
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
5687
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
5688
|
-
# To replace the entire entity, use one path with the string "*" to
|
5689
|
-
# all fields.
|
5750
|
+
# Required. The list of fields to be updated. Omitted fields will not be
|
5751
|
+
# updated. To replace the entire entity, use one path with the string "*" to
|
5752
|
+
# match all fields.
|
5690
5753
|
#
|
5691
5754
|
# @yield [response, operation] Access the result along with the RPC operation
|
5692
5755
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::CustomMetric]
|
@@ -6136,9 +6199,10 @@ module Google
|
|
6136
6199
|
# Required. The settings to update.
|
6137
6200
|
# The `name` field is used to identify the settings to be updated.
|
6138
6201
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
6139
|
-
# Required. The list of fields to be updated. Field names must be in snake
|
6140
|
-
# (e.g., "field_to_update"). Omitted fields will not be updated. To
|
6141
|
-
# the entire entity, use one path with the string "*" to match all
|
6202
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
6203
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
6204
|
+
# replace the entire entity, use one path with the string "*" to match all
|
6205
|
+
# fields.
|
6142
6206
|
#
|
6143
6207
|
# @yield [response, operation] Access the result along with the RPC operation
|
6144
6208
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::DataRetentionSettings]
|
@@ -6398,9 +6462,9 @@ module Google
|
|
6398
6462
|
# @param data_stream [::Google::Analytics::Admin::V1alpha::DataStream, ::Hash]
|
6399
6463
|
# The DataStream to update
|
6400
6464
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
6401
|
-
# Required. The list of fields to be updated. Omitted fields will not be
|
6402
|
-
# To replace the entire entity, use one path with the string "*" to
|
6403
|
-
# all fields.
|
6465
|
+
# Required. The list of fields to be updated. Omitted fields will not be
|
6466
|
+
# updated. To replace the entire entity, use one path with the string "*" to
|
6467
|
+
# match all fields.
|
6404
6468
|
#
|
6405
6469
|
# @yield [response, operation] Access the result along with the RPC operation
|
6406
6470
|
# @yieldparam response [::Google::Analytics::Admin::V1alpha::DataStream]
|
@@ -6655,134 +6719,1729 @@ module Google
|
|
6655
6719
|
end
|
6656
6720
|
|
6657
6721
|
##
|
6658
|
-
#
|
6722
|
+
# Lookup for a single Audience.
|
6723
|
+
# Audiences created before 2020 may not be supported.
|
6724
|
+
# Default audiences will not show filter definitions.
|
6659
6725
|
#
|
6660
|
-
#
|
6661
|
-
#
|
6662
|
-
#
|
6663
|
-
# applied individually to specific RPCs. See
|
6664
|
-
# {::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client::Configuration::Rpcs}
|
6665
|
-
# for a list of RPCs that can be configured independently.
|
6726
|
+
# @overload get_audience(request, options = nil)
|
6727
|
+
# Pass arguments to `get_audience` via a request object, either of type
|
6728
|
+
# {::Google::Analytics::Admin::V1alpha::GetAudienceRequest} or an equivalent Hash.
|
6666
6729
|
#
|
6667
|
-
#
|
6668
|
-
#
|
6730
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetAudienceRequest, ::Hash]
|
6731
|
+
# A request object representing the call parameters. Required. To specify no
|
6732
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
6733
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
6734
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
6669
6735
|
#
|
6670
|
-
# @
|
6736
|
+
# @overload get_audience(name: nil)
|
6737
|
+
# Pass arguments to `get_audience` via keyword arguments. Note that at
|
6738
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
6739
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
6671
6740
|
#
|
6672
|
-
#
|
6673
|
-
#
|
6674
|
-
#
|
6675
|
-
# ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
|
6676
|
-
# config.timeout = 10.0
|
6677
|
-
# config.rpcs.get_account.timeout = 20.0
|
6678
|
-
# end
|
6741
|
+
# @param name [::String]
|
6742
|
+
# Required. The name of the Audience to get.
|
6743
|
+
# Example format: properties/1234/audiences/5678
|
6679
6744
|
#
|
6680
|
-
#
|
6681
|
-
#
|
6682
|
-
#
|
6683
|
-
# config.rpcs.get_account.timeout = 20.0
|
6684
|
-
# end
|
6745
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
6746
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Audience]
|
6747
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
6685
6748
|
#
|
6686
|
-
#
|
6687
|
-
# The hostname or hostname:port of the service endpoint.
|
6688
|
-
# Defaults to `"analyticsadmin.googleapis.com"`.
|
6689
|
-
# @return [::String]
|
6690
|
-
# @!attribute [rw] credentials
|
6691
|
-
# Credentials to send with calls. You may provide any of the following types:
|
6692
|
-
# * (`String`) The path to a service account key file in JSON format
|
6693
|
-
# * (`Hash`) A service account key as a Hash
|
6694
|
-
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
6695
|
-
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
6696
|
-
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
6697
|
-
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
6698
|
-
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
6699
|
-
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
6700
|
-
# * (`nil`) indicating no credentials
|
6701
|
-
# @return [::Object]
|
6702
|
-
# @!attribute [rw] scope
|
6703
|
-
# The OAuth scopes
|
6704
|
-
# @return [::Array<::String>]
|
6705
|
-
# @!attribute [rw] lib_name
|
6706
|
-
# The library name as recorded in instrumentation and logging
|
6707
|
-
# @return [::String]
|
6708
|
-
# @!attribute [rw] lib_version
|
6709
|
-
# The library version as recorded in instrumentation and logging
|
6710
|
-
# @return [::String]
|
6711
|
-
# @!attribute [rw] channel_args
|
6712
|
-
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
6713
|
-
# `GRPC::Core::Channel` object is provided as the credential.
|
6714
|
-
# @return [::Hash]
|
6715
|
-
# @!attribute [rw] interceptors
|
6716
|
-
# An array of interceptors that are run before calls are executed.
|
6717
|
-
# @return [::Array<::GRPC::ClientInterceptor>]
|
6718
|
-
# @!attribute [rw] timeout
|
6719
|
-
# The call timeout in seconds.
|
6720
|
-
# @return [::Numeric]
|
6721
|
-
# @!attribute [rw] metadata
|
6722
|
-
# Additional gRPC headers to be sent with the call.
|
6723
|
-
# @return [::Hash{::Symbol=>::String}]
|
6724
|
-
# @!attribute [rw] retry_policy
|
6725
|
-
# The retry policy. The value is a hash with the following keys:
|
6726
|
-
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
6727
|
-
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
6728
|
-
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
6729
|
-
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
6730
|
-
# trigger a retry.
|
6731
|
-
# @return [::Hash]
|
6732
|
-
# @!attribute [rw] quota_project
|
6733
|
-
# A separate project against which to charge quota.
|
6734
|
-
# @return [::String]
|
6749
|
+
# @return [::Google::Analytics::Admin::V1alpha::Audience]
|
6735
6750
|
#
|
6736
|
-
|
6737
|
-
|
6751
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
6752
|
+
#
|
6753
|
+
# @example Basic example
|
6754
|
+
# require "google/analytics/admin/v1alpha"
|
6755
|
+
#
|
6756
|
+
# # Create a client object. The client can be reused for multiple calls.
|
6757
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
6758
|
+
#
|
6759
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
6760
|
+
# request = Google::Analytics::Admin::V1alpha::GetAudienceRequest.new
|
6761
|
+
#
|
6762
|
+
# # Call the get_audience method.
|
6763
|
+
# result = client.get_audience request
|
6764
|
+
#
|
6765
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::Audience.
|
6766
|
+
# p result
|
6767
|
+
#
|
6768
|
+
def get_audience request, options = nil
|
6769
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
6738
6770
|
|
6739
|
-
|
6740
|
-
|
6741
|
-
|
6742
|
-
|
6743
|
-
|
6771
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAudienceRequest
|
6772
|
+
|
6773
|
+
# Converts hash and nil to an options object
|
6774
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
6775
|
+
|
6776
|
+
# Customize the options with defaults
|
6777
|
+
metadata = @config.rpcs.get_audience.metadata.to_h
|
6778
|
+
|
6779
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
6780
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
6781
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
6782
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
6783
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
6784
|
+
|
6785
|
+
header_params = {}
|
6786
|
+
if request.name
|
6787
|
+
header_params["name"] = request.name
|
6744
6788
|
end
|
6745
|
-
config_attr :scope, nil, ::String, ::Array, nil
|
6746
|
-
config_attr :lib_name, nil, ::String, nil
|
6747
|
-
config_attr :lib_version, nil, ::String, nil
|
6748
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
6749
|
-
config_attr :interceptors, nil, ::Array, nil
|
6750
|
-
config_attr :timeout, nil, ::Numeric, nil
|
6751
|
-
config_attr :metadata, nil, ::Hash, nil
|
6752
|
-
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
6753
|
-
config_attr :quota_project, nil, ::String, nil
|
6754
6789
|
|
6755
|
-
#
|
6756
|
-
|
6757
|
-
@parent_config = parent_config unless parent_config.nil?
|
6790
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
6791
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
6758
6792
|
|
6759
|
-
|
6793
|
+
options.apply_defaults timeout: @config.rpcs.get_audience.timeout,
|
6794
|
+
metadata: metadata,
|
6795
|
+
retry_policy: @config.rpcs.get_audience.retry_policy
|
6796
|
+
|
6797
|
+
options.apply_defaults timeout: @config.timeout,
|
6798
|
+
metadata: @config.metadata,
|
6799
|
+
retry_policy: @config.retry_policy
|
6800
|
+
|
6801
|
+
@analytics_admin_service_stub.call_rpc :get_audience, request, options: options do |response, operation|
|
6802
|
+
yield response, operation if block_given?
|
6803
|
+
return response
|
6760
6804
|
end
|
6805
|
+
rescue ::GRPC::BadStatus => e
|
6806
|
+
raise ::Google::Cloud::Error.from_error(e)
|
6807
|
+
end
|
6761
6808
|
|
6762
|
-
|
6763
|
-
|
6764
|
-
|
6765
|
-
|
6766
|
-
|
6767
|
-
|
6768
|
-
|
6769
|
-
|
6770
|
-
|
6771
|
-
|
6809
|
+
##
|
6810
|
+
# Lists Audiences on a property.
|
6811
|
+
# Audiences created before 2020 may not be supported.
|
6812
|
+
# Default audiences will not show filter definitions.
|
6813
|
+
#
|
6814
|
+
# @overload list_audiences(request, options = nil)
|
6815
|
+
# Pass arguments to `list_audiences` via a request object, either of type
|
6816
|
+
# {::Google::Analytics::Admin::V1alpha::ListAudiencesRequest} or an equivalent Hash.
|
6817
|
+
#
|
6818
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListAudiencesRequest, ::Hash]
|
6819
|
+
# A request object representing the call parameters. Required. To specify no
|
6820
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
6821
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
6822
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
6823
|
+
#
|
6824
|
+
# @overload list_audiences(parent: nil, page_size: nil, page_token: nil)
|
6825
|
+
# Pass arguments to `list_audiences` via keyword arguments. Note that at
|
6826
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
6827
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
6828
|
+
#
|
6829
|
+
# @param parent [::String]
|
6830
|
+
# Required. Example format: properties/1234
|
6831
|
+
# @param page_size [::Integer]
|
6832
|
+
# The maximum number of resources to return.
|
6833
|
+
# If unspecified, at most 50 resources will be returned.
|
6834
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
6835
|
+
# @param page_token [::String]
|
6836
|
+
# A page token, received from a previous `ListAudiences` call. Provide this
|
6837
|
+
# to retrieve the subsequent page.
|
6838
|
+
#
|
6839
|
+
# When paginating, all other parameters provided to `ListAudiences` must
|
6840
|
+
# match the call that provided the page token.
|
6841
|
+
#
|
6842
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
6843
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Audience>]
|
6844
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
6845
|
+
#
|
6846
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Audience>]
|
6847
|
+
#
|
6848
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
6849
|
+
#
|
6850
|
+
# @example Basic example
|
6851
|
+
# require "google/analytics/admin/v1alpha"
|
6852
|
+
#
|
6853
|
+
# # Create a client object. The client can be reused for multiple calls.
|
6854
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
6855
|
+
#
|
6856
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
6857
|
+
# request = Google::Analytics::Admin::V1alpha::ListAudiencesRequest.new
|
6858
|
+
#
|
6859
|
+
# # Call the list_audiences method.
|
6860
|
+
# result = client.list_audiences request
|
6861
|
+
#
|
6862
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
6863
|
+
# # iterate over all elements by calling #each, and the enumerable
|
6864
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
6865
|
+
# # methods are also available for managing paging directly.
|
6866
|
+
# result.each do |response|
|
6867
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::Audience.
|
6868
|
+
# p response
|
6869
|
+
# end
|
6870
|
+
#
|
6871
|
+
def list_audiences request, options = nil
|
6872
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
6873
|
+
|
6874
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAudiencesRequest
|
6875
|
+
|
6876
|
+
# Converts hash and nil to an options object
|
6877
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
6878
|
+
|
6879
|
+
# Customize the options with defaults
|
6880
|
+
metadata = @config.rpcs.list_audiences.metadata.to_h
|
6881
|
+
|
6882
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
6883
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
6884
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
6885
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
6886
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
6887
|
+
|
6888
|
+
header_params = {}
|
6889
|
+
if request.parent
|
6890
|
+
header_params["parent"] = request.parent
|
6772
6891
|
end
|
6773
6892
|
|
6774
|
-
|
6775
|
-
|
6776
|
-
|
6777
|
-
|
6778
|
-
|
6779
|
-
|
6780
|
-
|
6781
|
-
|
6782
|
-
|
6783
|
-
|
6784
|
-
|
6785
|
-
|
6893
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
6894
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
6895
|
+
|
6896
|
+
options.apply_defaults timeout: @config.rpcs.list_audiences.timeout,
|
6897
|
+
metadata: metadata,
|
6898
|
+
retry_policy: @config.rpcs.list_audiences.retry_policy
|
6899
|
+
|
6900
|
+
options.apply_defaults timeout: @config.timeout,
|
6901
|
+
metadata: @config.metadata,
|
6902
|
+
retry_policy: @config.retry_policy
|
6903
|
+
|
6904
|
+
@analytics_admin_service_stub.call_rpc :list_audiences, request, options: options do |response, operation|
|
6905
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_audiences, request, response, operation, options
|
6906
|
+
yield response, operation if block_given?
|
6907
|
+
return response
|
6908
|
+
end
|
6909
|
+
rescue ::GRPC::BadStatus => e
|
6910
|
+
raise ::Google::Cloud::Error.from_error(e)
|
6911
|
+
end
|
6912
|
+
|
6913
|
+
##
|
6914
|
+
# Creates an Audience.
|
6915
|
+
#
|
6916
|
+
# @overload create_audience(request, options = nil)
|
6917
|
+
# Pass arguments to `create_audience` via a request object, either of type
|
6918
|
+
# {::Google::Analytics::Admin::V1alpha::CreateAudienceRequest} or an equivalent Hash.
|
6919
|
+
#
|
6920
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateAudienceRequest, ::Hash]
|
6921
|
+
# A request object representing the call parameters. Required. To specify no
|
6922
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
6923
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
6924
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
6925
|
+
#
|
6926
|
+
# @overload create_audience(parent: nil, audience: nil)
|
6927
|
+
# Pass arguments to `create_audience` via keyword arguments. Note that at
|
6928
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
6929
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
6930
|
+
#
|
6931
|
+
# @param parent [::String]
|
6932
|
+
# Required. Example format: properties/1234
|
6933
|
+
# @param audience [::Google::Analytics::Admin::V1alpha::Audience, ::Hash]
|
6934
|
+
# Required. The audience to create.
|
6935
|
+
#
|
6936
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
6937
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Audience]
|
6938
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
6939
|
+
#
|
6940
|
+
# @return [::Google::Analytics::Admin::V1alpha::Audience]
|
6941
|
+
#
|
6942
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
6943
|
+
#
|
6944
|
+
# @example Basic example
|
6945
|
+
# require "google/analytics/admin/v1alpha"
|
6946
|
+
#
|
6947
|
+
# # Create a client object. The client can be reused for multiple calls.
|
6948
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
6949
|
+
#
|
6950
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
6951
|
+
# request = Google::Analytics::Admin::V1alpha::CreateAudienceRequest.new
|
6952
|
+
#
|
6953
|
+
# # Call the create_audience method.
|
6954
|
+
# result = client.create_audience request
|
6955
|
+
#
|
6956
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::Audience.
|
6957
|
+
# p result
|
6958
|
+
#
|
6959
|
+
def create_audience request, options = nil
|
6960
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
6961
|
+
|
6962
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateAudienceRequest
|
6963
|
+
|
6964
|
+
# Converts hash and nil to an options object
|
6965
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
6966
|
+
|
6967
|
+
# Customize the options with defaults
|
6968
|
+
metadata = @config.rpcs.create_audience.metadata.to_h
|
6969
|
+
|
6970
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
6971
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
6972
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
6973
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
6974
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
6975
|
+
|
6976
|
+
header_params = {}
|
6977
|
+
if request.parent
|
6978
|
+
header_params["parent"] = request.parent
|
6979
|
+
end
|
6980
|
+
|
6981
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
6982
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
6983
|
+
|
6984
|
+
options.apply_defaults timeout: @config.rpcs.create_audience.timeout,
|
6985
|
+
metadata: metadata,
|
6986
|
+
retry_policy: @config.rpcs.create_audience.retry_policy
|
6987
|
+
|
6988
|
+
options.apply_defaults timeout: @config.timeout,
|
6989
|
+
metadata: @config.metadata,
|
6990
|
+
retry_policy: @config.retry_policy
|
6991
|
+
|
6992
|
+
@analytics_admin_service_stub.call_rpc :create_audience, request, options: options do |response, operation|
|
6993
|
+
yield response, operation if block_given?
|
6994
|
+
return response
|
6995
|
+
end
|
6996
|
+
rescue ::GRPC::BadStatus => e
|
6997
|
+
raise ::Google::Cloud::Error.from_error(e)
|
6998
|
+
end
|
6999
|
+
|
7000
|
+
##
|
7001
|
+
# Updates an Audience on a property.
|
7002
|
+
#
|
7003
|
+
# @overload update_audience(request, options = nil)
|
7004
|
+
# Pass arguments to `update_audience` via a request object, either of type
|
7005
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateAudienceRequest} or an equivalent Hash.
|
7006
|
+
#
|
7007
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateAudienceRequest, ::Hash]
|
7008
|
+
# A request object representing the call parameters. Required. To specify no
|
7009
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7010
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7011
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7012
|
+
#
|
7013
|
+
# @overload update_audience(audience: nil, update_mask: nil)
|
7014
|
+
# Pass arguments to `update_audience` via keyword arguments. Note that at
|
7015
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7016
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7017
|
+
#
|
7018
|
+
# @param audience [::Google::Analytics::Admin::V1alpha::Audience, ::Hash]
|
7019
|
+
# Required. The audience to update.
|
7020
|
+
# The audience's `name` field is used to identify the audience to be updated.
|
7021
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
7022
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
7023
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
7024
|
+
# replace the entire entity, use one path with the string "*" to match all
|
7025
|
+
# fields.
|
7026
|
+
#
|
7027
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7028
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::Audience]
|
7029
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7030
|
+
#
|
7031
|
+
# @return [::Google::Analytics::Admin::V1alpha::Audience]
|
7032
|
+
#
|
7033
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7034
|
+
#
|
7035
|
+
# @example Basic example
|
7036
|
+
# require "google/analytics/admin/v1alpha"
|
7037
|
+
#
|
7038
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7039
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7040
|
+
#
|
7041
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7042
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateAudienceRequest.new
|
7043
|
+
#
|
7044
|
+
# # Call the update_audience method.
|
7045
|
+
# result = client.update_audience request
|
7046
|
+
#
|
7047
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::Audience.
|
7048
|
+
# p result
|
7049
|
+
#
|
7050
|
+
def update_audience request, options = nil
|
7051
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7052
|
+
|
7053
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAudienceRequest
|
7054
|
+
|
7055
|
+
# Converts hash and nil to an options object
|
7056
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7057
|
+
|
7058
|
+
# Customize the options with defaults
|
7059
|
+
metadata = @config.rpcs.update_audience.metadata.to_h
|
7060
|
+
|
7061
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7062
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7063
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7064
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7065
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7066
|
+
|
7067
|
+
header_params = {}
|
7068
|
+
if request.audience&.name
|
7069
|
+
header_params["audience.name"] = request.audience.name
|
7070
|
+
end
|
7071
|
+
|
7072
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7073
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7074
|
+
|
7075
|
+
options.apply_defaults timeout: @config.rpcs.update_audience.timeout,
|
7076
|
+
metadata: metadata,
|
7077
|
+
retry_policy: @config.rpcs.update_audience.retry_policy
|
7078
|
+
|
7079
|
+
options.apply_defaults timeout: @config.timeout,
|
7080
|
+
metadata: @config.metadata,
|
7081
|
+
retry_policy: @config.retry_policy
|
7082
|
+
|
7083
|
+
@analytics_admin_service_stub.call_rpc :update_audience, request, options: options do |response, operation|
|
7084
|
+
yield response, operation if block_given?
|
7085
|
+
return response
|
7086
|
+
end
|
7087
|
+
rescue ::GRPC::BadStatus => e
|
7088
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7089
|
+
end
|
7090
|
+
|
7091
|
+
##
|
7092
|
+
# Archives an Audience on a property.
|
7093
|
+
#
|
7094
|
+
# @overload archive_audience(request, options = nil)
|
7095
|
+
# Pass arguments to `archive_audience` via a request object, either of type
|
7096
|
+
# {::Google::Analytics::Admin::V1alpha::ArchiveAudienceRequest} or an equivalent Hash.
|
7097
|
+
#
|
7098
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ArchiveAudienceRequest, ::Hash]
|
7099
|
+
# A request object representing the call parameters. Required. To specify no
|
7100
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7101
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7102
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7103
|
+
#
|
7104
|
+
# @overload archive_audience(name: nil)
|
7105
|
+
# Pass arguments to `archive_audience` via keyword arguments. Note that at
|
7106
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7107
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7108
|
+
#
|
7109
|
+
# @param name [::String]
|
7110
|
+
# Required. Example format: properties/1234/audiences/5678
|
7111
|
+
#
|
7112
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7113
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
7114
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7115
|
+
#
|
7116
|
+
# @return [::Google::Protobuf::Empty]
|
7117
|
+
#
|
7118
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7119
|
+
#
|
7120
|
+
# @example Basic example
|
7121
|
+
# require "google/analytics/admin/v1alpha"
|
7122
|
+
#
|
7123
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7124
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7125
|
+
#
|
7126
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7127
|
+
# request = Google::Analytics::Admin::V1alpha::ArchiveAudienceRequest.new
|
7128
|
+
#
|
7129
|
+
# # Call the archive_audience method.
|
7130
|
+
# result = client.archive_audience request
|
7131
|
+
#
|
7132
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
7133
|
+
# p result
|
7134
|
+
#
|
7135
|
+
def archive_audience request, options = nil
|
7136
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7137
|
+
|
7138
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveAudienceRequest
|
7139
|
+
|
7140
|
+
# Converts hash and nil to an options object
|
7141
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7142
|
+
|
7143
|
+
# Customize the options with defaults
|
7144
|
+
metadata = @config.rpcs.archive_audience.metadata.to_h
|
7145
|
+
|
7146
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7147
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7148
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7149
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7150
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7151
|
+
|
7152
|
+
header_params = {}
|
7153
|
+
if request.name
|
7154
|
+
header_params["name"] = request.name
|
7155
|
+
end
|
7156
|
+
|
7157
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7158
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7159
|
+
|
7160
|
+
options.apply_defaults timeout: @config.rpcs.archive_audience.timeout,
|
7161
|
+
metadata: metadata,
|
7162
|
+
retry_policy: @config.rpcs.archive_audience.retry_policy
|
7163
|
+
|
7164
|
+
options.apply_defaults timeout: @config.timeout,
|
7165
|
+
metadata: @config.metadata,
|
7166
|
+
retry_policy: @config.retry_policy
|
7167
|
+
|
7168
|
+
@analytics_admin_service_stub.call_rpc :archive_audience, request, options: options do |response, operation|
|
7169
|
+
yield response, operation if block_given?
|
7170
|
+
return response
|
7171
|
+
end
|
7172
|
+
rescue ::GRPC::BadStatus => e
|
7173
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7174
|
+
end
|
7175
|
+
|
7176
|
+
##
|
7177
|
+
# Look up a single SearchAds360Link
|
7178
|
+
#
|
7179
|
+
# @overload get_search_ads360_link(request, options = nil)
|
7180
|
+
# Pass arguments to `get_search_ads360_link` via a request object, either of type
|
7181
|
+
# {::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest} or an equivalent Hash.
|
7182
|
+
#
|
7183
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest, ::Hash]
|
7184
|
+
# A request object representing the call parameters. Required. To specify no
|
7185
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7186
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7187
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7188
|
+
#
|
7189
|
+
# @overload get_search_ads360_link(name: nil)
|
7190
|
+
# Pass arguments to `get_search_ads360_link` via keyword arguments. Note that at
|
7191
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7192
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7193
|
+
#
|
7194
|
+
# @param name [::String]
|
7195
|
+
# Required. The name of the SearchAds360Link to get.
|
7196
|
+
# Example format: properties/1234/SearchAds360Link/5678
|
7197
|
+
#
|
7198
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7199
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
7200
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7201
|
+
#
|
7202
|
+
# @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
7203
|
+
#
|
7204
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7205
|
+
#
|
7206
|
+
# @example Basic example
|
7207
|
+
# require "google/analytics/admin/v1alpha"
|
7208
|
+
#
|
7209
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7210
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7211
|
+
#
|
7212
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7213
|
+
# request = Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest.new
|
7214
|
+
#
|
7215
|
+
# # Call the get_search_ads360_link method.
|
7216
|
+
# result = client.get_search_ads360_link request
|
7217
|
+
#
|
7218
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::SearchAds360Link.
|
7219
|
+
# p result
|
7220
|
+
#
|
7221
|
+
def get_search_ads360_link request, options = nil
|
7222
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7223
|
+
|
7224
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest
|
7225
|
+
|
7226
|
+
# Converts hash and nil to an options object
|
7227
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7228
|
+
|
7229
|
+
# Customize the options with defaults
|
7230
|
+
metadata = @config.rpcs.get_search_ads360_link.metadata.to_h
|
7231
|
+
|
7232
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7233
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7234
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7235
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7236
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7237
|
+
|
7238
|
+
header_params = {}
|
7239
|
+
if request.name
|
7240
|
+
header_params["name"] = request.name
|
7241
|
+
end
|
7242
|
+
|
7243
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7244
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7245
|
+
|
7246
|
+
options.apply_defaults timeout: @config.rpcs.get_search_ads360_link.timeout,
|
7247
|
+
metadata: metadata,
|
7248
|
+
retry_policy: @config.rpcs.get_search_ads360_link.retry_policy
|
7249
|
+
|
7250
|
+
options.apply_defaults timeout: @config.timeout,
|
7251
|
+
metadata: @config.metadata,
|
7252
|
+
retry_policy: @config.retry_policy
|
7253
|
+
|
7254
|
+
@analytics_admin_service_stub.call_rpc :get_search_ads360_link, request, options: options do |response, operation|
|
7255
|
+
yield response, operation if block_given?
|
7256
|
+
return response
|
7257
|
+
end
|
7258
|
+
rescue ::GRPC::BadStatus => e
|
7259
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7260
|
+
end
|
7261
|
+
|
7262
|
+
##
|
7263
|
+
# Lists all SearchAds360Links on a property.
|
7264
|
+
#
|
7265
|
+
# @overload list_search_ads360_links(request, options = nil)
|
7266
|
+
# Pass arguments to `list_search_ads360_links` via a request object, either of type
|
7267
|
+
# {::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest} or an equivalent Hash.
|
7268
|
+
#
|
7269
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest, ::Hash]
|
7270
|
+
# A request object representing the call parameters. Required. To specify no
|
7271
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7272
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7273
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7274
|
+
#
|
7275
|
+
# @overload list_search_ads360_links(parent: nil, page_size: nil, page_token: nil)
|
7276
|
+
# Pass arguments to `list_search_ads360_links` via keyword arguments. Note that at
|
7277
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7278
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7279
|
+
#
|
7280
|
+
# @param parent [::String]
|
7281
|
+
# Required. Example format: properties/1234
|
7282
|
+
# @param page_size [::Integer]
|
7283
|
+
# The maximum number of resources to return.
|
7284
|
+
# If unspecified, at most 50 resources will be returned.
|
7285
|
+
# The maximum value is 200 (higher values will be coerced to the maximum).
|
7286
|
+
# @param page_token [::String]
|
7287
|
+
# A page token, received from a previous `ListSearchAds360Links`
|
7288
|
+
# call. Provide this to retrieve the subsequent page.
|
7289
|
+
#
|
7290
|
+
# When paginating, all other parameters provided to
|
7291
|
+
# `ListSearchAds360Links` must match the call that provided the
|
7292
|
+
# page token.
|
7293
|
+
#
|
7294
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7295
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>]
|
7296
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7297
|
+
#
|
7298
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>]
|
7299
|
+
#
|
7300
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7301
|
+
#
|
7302
|
+
# @example Basic example
|
7303
|
+
# require "google/analytics/admin/v1alpha"
|
7304
|
+
#
|
7305
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7306
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7307
|
+
#
|
7308
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7309
|
+
# request = Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest.new
|
7310
|
+
#
|
7311
|
+
# # Call the list_search_ads360_links method.
|
7312
|
+
# result = client.list_search_ads360_links request
|
7313
|
+
#
|
7314
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
7315
|
+
# # iterate over all elements by calling #each, and the enumerable
|
7316
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
7317
|
+
# # methods are also available for managing paging directly.
|
7318
|
+
# result.each do |response|
|
7319
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::SearchAds360Link.
|
7320
|
+
# p response
|
7321
|
+
# end
|
7322
|
+
#
|
7323
|
+
def list_search_ads360_links request, options = nil
|
7324
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7325
|
+
|
7326
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest
|
7327
|
+
|
7328
|
+
# Converts hash and nil to an options object
|
7329
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7330
|
+
|
7331
|
+
# Customize the options with defaults
|
7332
|
+
metadata = @config.rpcs.list_search_ads360_links.metadata.to_h
|
7333
|
+
|
7334
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7335
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7336
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7337
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7338
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7339
|
+
|
7340
|
+
header_params = {}
|
7341
|
+
if request.parent
|
7342
|
+
header_params["parent"] = request.parent
|
7343
|
+
end
|
7344
|
+
|
7345
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7346
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7347
|
+
|
7348
|
+
options.apply_defaults timeout: @config.rpcs.list_search_ads360_links.timeout,
|
7349
|
+
metadata: metadata,
|
7350
|
+
retry_policy: @config.rpcs.list_search_ads360_links.retry_policy
|
7351
|
+
|
7352
|
+
options.apply_defaults timeout: @config.timeout,
|
7353
|
+
metadata: @config.metadata,
|
7354
|
+
retry_policy: @config.retry_policy
|
7355
|
+
|
7356
|
+
@analytics_admin_service_stub.call_rpc :list_search_ads360_links, request, options: options do |response, operation|
|
7357
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_search_ads360_links, request, response, operation, options
|
7358
|
+
yield response, operation if block_given?
|
7359
|
+
return response
|
7360
|
+
end
|
7361
|
+
rescue ::GRPC::BadStatus => e
|
7362
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7363
|
+
end
|
7364
|
+
|
7365
|
+
##
|
7366
|
+
# Creates a SearchAds360Link.
|
7367
|
+
#
|
7368
|
+
# @overload create_search_ads360_link(request, options = nil)
|
7369
|
+
# Pass arguments to `create_search_ads360_link` via a request object, either of type
|
7370
|
+
# {::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest} or an equivalent Hash.
|
7371
|
+
#
|
7372
|
+
# @param request [::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest, ::Hash]
|
7373
|
+
# A request object representing the call parameters. Required. To specify no
|
7374
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7375
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7376
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7377
|
+
#
|
7378
|
+
# @overload create_search_ads360_link(parent: nil, search_ads_360_link: nil)
|
7379
|
+
# Pass arguments to `create_search_ads360_link` via keyword arguments. Note that at
|
7380
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7381
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7382
|
+
#
|
7383
|
+
# @param parent [::String]
|
7384
|
+
# Required. Example format: properties/1234
|
7385
|
+
# @param search_ads_360_link [::Google::Analytics::Admin::V1alpha::SearchAds360Link, ::Hash]
|
7386
|
+
# Required. The SearchAds360Link to create.
|
7387
|
+
#
|
7388
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7389
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
7390
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7391
|
+
#
|
7392
|
+
# @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
7393
|
+
#
|
7394
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7395
|
+
#
|
7396
|
+
# @example Basic example
|
7397
|
+
# require "google/analytics/admin/v1alpha"
|
7398
|
+
#
|
7399
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7400
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7401
|
+
#
|
7402
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7403
|
+
# request = Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest.new
|
7404
|
+
#
|
7405
|
+
# # Call the create_search_ads360_link method.
|
7406
|
+
# result = client.create_search_ads360_link request
|
7407
|
+
#
|
7408
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::SearchAds360Link.
|
7409
|
+
# p result
|
7410
|
+
#
|
7411
|
+
def create_search_ads360_link request, options = nil
|
7412
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7413
|
+
|
7414
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest
|
7415
|
+
|
7416
|
+
# Converts hash and nil to an options object
|
7417
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7418
|
+
|
7419
|
+
# Customize the options with defaults
|
7420
|
+
metadata = @config.rpcs.create_search_ads360_link.metadata.to_h
|
7421
|
+
|
7422
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7423
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7424
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7425
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7426
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7427
|
+
|
7428
|
+
header_params = {}
|
7429
|
+
if request.parent
|
7430
|
+
header_params["parent"] = request.parent
|
7431
|
+
end
|
7432
|
+
|
7433
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7434
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7435
|
+
|
7436
|
+
options.apply_defaults timeout: @config.rpcs.create_search_ads360_link.timeout,
|
7437
|
+
metadata: metadata,
|
7438
|
+
retry_policy: @config.rpcs.create_search_ads360_link.retry_policy
|
7439
|
+
|
7440
|
+
options.apply_defaults timeout: @config.timeout,
|
7441
|
+
metadata: @config.metadata,
|
7442
|
+
retry_policy: @config.retry_policy
|
7443
|
+
|
7444
|
+
@analytics_admin_service_stub.call_rpc :create_search_ads360_link, request, options: options do |response, operation|
|
7445
|
+
yield response, operation if block_given?
|
7446
|
+
return response
|
7447
|
+
end
|
7448
|
+
rescue ::GRPC::BadStatus => e
|
7449
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7450
|
+
end
|
7451
|
+
|
7452
|
+
##
|
7453
|
+
# Deletes a SearchAds360Link on a property.
|
7454
|
+
#
|
7455
|
+
# @overload delete_search_ads360_link(request, options = nil)
|
7456
|
+
# Pass arguments to `delete_search_ads360_link` via a request object, either of type
|
7457
|
+
# {::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest} or an equivalent Hash.
|
7458
|
+
#
|
7459
|
+
# @param request [::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest, ::Hash]
|
7460
|
+
# A request object representing the call parameters. Required. To specify no
|
7461
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7462
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7463
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7464
|
+
#
|
7465
|
+
# @overload delete_search_ads360_link(name: nil)
|
7466
|
+
# Pass arguments to `delete_search_ads360_link` via keyword arguments. Note that at
|
7467
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7468
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7469
|
+
#
|
7470
|
+
# @param name [::String]
|
7471
|
+
# Required. The name of the SearchAds360Link to delete.
|
7472
|
+
# Example format: properties/1234/SearchAds360Links/5678
|
7473
|
+
#
|
7474
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7475
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
7476
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7477
|
+
#
|
7478
|
+
# @return [::Google::Protobuf::Empty]
|
7479
|
+
#
|
7480
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7481
|
+
#
|
7482
|
+
# @example Basic example
|
7483
|
+
# require "google/analytics/admin/v1alpha"
|
7484
|
+
#
|
7485
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7486
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7487
|
+
#
|
7488
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7489
|
+
# request = Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest.new
|
7490
|
+
#
|
7491
|
+
# # Call the delete_search_ads360_link method.
|
7492
|
+
# result = client.delete_search_ads360_link request
|
7493
|
+
#
|
7494
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
7495
|
+
# p result
|
7496
|
+
#
|
7497
|
+
def delete_search_ads360_link request, options = nil
|
7498
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7499
|
+
|
7500
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest
|
7501
|
+
|
7502
|
+
# Converts hash and nil to an options object
|
7503
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7504
|
+
|
7505
|
+
# Customize the options with defaults
|
7506
|
+
metadata = @config.rpcs.delete_search_ads360_link.metadata.to_h
|
7507
|
+
|
7508
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7509
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7510
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7511
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7512
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7513
|
+
|
7514
|
+
header_params = {}
|
7515
|
+
if request.name
|
7516
|
+
header_params["name"] = request.name
|
7517
|
+
end
|
7518
|
+
|
7519
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7520
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7521
|
+
|
7522
|
+
options.apply_defaults timeout: @config.rpcs.delete_search_ads360_link.timeout,
|
7523
|
+
metadata: metadata,
|
7524
|
+
retry_policy: @config.rpcs.delete_search_ads360_link.retry_policy
|
7525
|
+
|
7526
|
+
options.apply_defaults timeout: @config.timeout,
|
7527
|
+
metadata: @config.metadata,
|
7528
|
+
retry_policy: @config.retry_policy
|
7529
|
+
|
7530
|
+
@analytics_admin_service_stub.call_rpc :delete_search_ads360_link, request, options: options do |response, operation|
|
7531
|
+
yield response, operation if block_given?
|
7532
|
+
return response
|
7533
|
+
end
|
7534
|
+
rescue ::GRPC::BadStatus => e
|
7535
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7536
|
+
end
|
7537
|
+
|
7538
|
+
##
|
7539
|
+
# Updates a SearchAds360Link on a property.
|
7540
|
+
#
|
7541
|
+
# @overload update_search_ads360_link(request, options = nil)
|
7542
|
+
# Pass arguments to `update_search_ads360_link` via a request object, either of type
|
7543
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest} or an equivalent Hash.
|
7544
|
+
#
|
7545
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest, ::Hash]
|
7546
|
+
# A request object representing the call parameters. Required. To specify no
|
7547
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7548
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7549
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7550
|
+
#
|
7551
|
+
# @overload update_search_ads360_link(search_ads_360_link: nil, update_mask: nil)
|
7552
|
+
# Pass arguments to `update_search_ads360_link` via keyword arguments. Note that at
|
7553
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7554
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7555
|
+
#
|
7556
|
+
# @param search_ads_360_link [::Google::Analytics::Admin::V1alpha::SearchAds360Link, ::Hash]
|
7557
|
+
# The SearchAds360Link to update
|
7558
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
7559
|
+
# Required. The list of fields to be updated. Omitted fields will not be
|
7560
|
+
# updated. To replace the entire entity, use one path with the string "*" to
|
7561
|
+
# match all fields.
|
7562
|
+
#
|
7563
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7564
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
7565
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7566
|
+
#
|
7567
|
+
# @return [::Google::Analytics::Admin::V1alpha::SearchAds360Link]
|
7568
|
+
#
|
7569
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7570
|
+
#
|
7571
|
+
# @example Basic example
|
7572
|
+
# require "google/analytics/admin/v1alpha"
|
7573
|
+
#
|
7574
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7575
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7576
|
+
#
|
7577
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7578
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest.new
|
7579
|
+
#
|
7580
|
+
# # Call the update_search_ads360_link method.
|
7581
|
+
# result = client.update_search_ads360_link request
|
7582
|
+
#
|
7583
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::SearchAds360Link.
|
7584
|
+
# p result
|
7585
|
+
#
|
7586
|
+
def update_search_ads360_link request, options = nil
|
7587
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7588
|
+
|
7589
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest
|
7590
|
+
|
7591
|
+
# Converts hash and nil to an options object
|
7592
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7593
|
+
|
7594
|
+
# Customize the options with defaults
|
7595
|
+
metadata = @config.rpcs.update_search_ads360_link.metadata.to_h
|
7596
|
+
|
7597
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7598
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7599
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7600
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7601
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7602
|
+
|
7603
|
+
header_params = {}
|
7604
|
+
if request.search_ads_360_link&.name
|
7605
|
+
header_params["search_ads_360_link.name"] = request.search_ads_360_link.name
|
7606
|
+
end
|
7607
|
+
|
7608
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7609
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7610
|
+
|
7611
|
+
options.apply_defaults timeout: @config.rpcs.update_search_ads360_link.timeout,
|
7612
|
+
metadata: metadata,
|
7613
|
+
retry_policy: @config.rpcs.update_search_ads360_link.retry_policy
|
7614
|
+
|
7615
|
+
options.apply_defaults timeout: @config.timeout,
|
7616
|
+
metadata: @config.metadata,
|
7617
|
+
retry_policy: @config.retry_policy
|
7618
|
+
|
7619
|
+
@analytics_admin_service_stub.call_rpc :update_search_ads360_link, request, options: options do |response, operation|
|
7620
|
+
yield response, operation if block_given?
|
7621
|
+
return response
|
7622
|
+
end
|
7623
|
+
rescue ::GRPC::BadStatus => e
|
7624
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7625
|
+
end
|
7626
|
+
|
7627
|
+
##
|
7628
|
+
# Lookup for a AttributionSettings singleton.
|
7629
|
+
#
|
7630
|
+
# @overload get_attribution_settings(request, options = nil)
|
7631
|
+
# Pass arguments to `get_attribution_settings` via a request object, either of type
|
7632
|
+
# {::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest} or an equivalent Hash.
|
7633
|
+
#
|
7634
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest, ::Hash]
|
7635
|
+
# A request object representing the call parameters. Required. To specify no
|
7636
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7637
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7638
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7639
|
+
#
|
7640
|
+
# @overload get_attribution_settings(name: nil)
|
7641
|
+
# Pass arguments to `get_attribution_settings` via keyword arguments. Note that at
|
7642
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7643
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7644
|
+
#
|
7645
|
+
# @param name [::String]
|
7646
|
+
# Required. The name of the attribution settings to retrieve.
|
7647
|
+
# Format: properties/\\{property}/attributionSettings
|
7648
|
+
#
|
7649
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7650
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AttributionSettings]
|
7651
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7652
|
+
#
|
7653
|
+
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
|
7654
|
+
#
|
7655
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7656
|
+
#
|
7657
|
+
# @example Basic example
|
7658
|
+
# require "google/analytics/admin/v1alpha"
|
7659
|
+
#
|
7660
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7661
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7662
|
+
#
|
7663
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7664
|
+
# request = Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest.new
|
7665
|
+
#
|
7666
|
+
# # Call the get_attribution_settings method.
|
7667
|
+
# result = client.get_attribution_settings request
|
7668
|
+
#
|
7669
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::AttributionSettings.
|
7670
|
+
# p result
|
7671
|
+
#
|
7672
|
+
def get_attribution_settings request, options = nil
|
7673
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7674
|
+
|
7675
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest
|
7676
|
+
|
7677
|
+
# Converts hash and nil to an options object
|
7678
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7679
|
+
|
7680
|
+
# Customize the options with defaults
|
7681
|
+
metadata = @config.rpcs.get_attribution_settings.metadata.to_h
|
7682
|
+
|
7683
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7684
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7685
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7686
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7687
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7688
|
+
|
7689
|
+
header_params = {}
|
7690
|
+
if request.name
|
7691
|
+
header_params["name"] = request.name
|
7692
|
+
end
|
7693
|
+
|
7694
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7695
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7696
|
+
|
7697
|
+
options.apply_defaults timeout: @config.rpcs.get_attribution_settings.timeout,
|
7698
|
+
metadata: metadata,
|
7699
|
+
retry_policy: @config.rpcs.get_attribution_settings.retry_policy
|
7700
|
+
|
7701
|
+
options.apply_defaults timeout: @config.timeout,
|
7702
|
+
metadata: @config.metadata,
|
7703
|
+
retry_policy: @config.retry_policy
|
7704
|
+
|
7705
|
+
@analytics_admin_service_stub.call_rpc :get_attribution_settings, request, options: options do |response, operation|
|
7706
|
+
yield response, operation if block_given?
|
7707
|
+
return response
|
7708
|
+
end
|
7709
|
+
rescue ::GRPC::BadStatus => e
|
7710
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7711
|
+
end
|
7712
|
+
|
7713
|
+
##
|
7714
|
+
# Updates attribution settings on a property.
|
7715
|
+
#
|
7716
|
+
# @overload update_attribution_settings(request, options = nil)
|
7717
|
+
# Pass arguments to `update_attribution_settings` via a request object, either of type
|
7718
|
+
# {::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest} or an equivalent Hash.
|
7719
|
+
#
|
7720
|
+
# @param request [::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest, ::Hash]
|
7721
|
+
# A request object representing the call parameters. Required. To specify no
|
7722
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7723
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7724
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7725
|
+
#
|
7726
|
+
# @overload update_attribution_settings(attribution_settings: nil, update_mask: nil)
|
7727
|
+
# Pass arguments to `update_attribution_settings` via keyword arguments. Note that at
|
7728
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7729
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7730
|
+
#
|
7731
|
+
# @param attribution_settings [::Google::Analytics::Admin::V1alpha::AttributionSettings, ::Hash]
|
7732
|
+
# Required. The attribution settings to update.
|
7733
|
+
# The `name` field is used to identify the settings to be updated.
|
7734
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
7735
|
+
# Required. The list of fields to be updated. Field names must be in snake
|
7736
|
+
# case (e.g., "field_to_update"). Omitted fields will not be updated. To
|
7737
|
+
# replace the entire entity, use one path with the string "*" to match all
|
7738
|
+
# fields.
|
7739
|
+
#
|
7740
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7741
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::AttributionSettings]
|
7742
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7743
|
+
#
|
7744
|
+
# @return [::Google::Analytics::Admin::V1alpha::AttributionSettings]
|
7745
|
+
#
|
7746
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7747
|
+
#
|
7748
|
+
# @example Basic example
|
7749
|
+
# require "google/analytics/admin/v1alpha"
|
7750
|
+
#
|
7751
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7752
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7753
|
+
#
|
7754
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7755
|
+
# request = Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest.new
|
7756
|
+
#
|
7757
|
+
# # Call the update_attribution_settings method.
|
7758
|
+
# result = client.update_attribution_settings request
|
7759
|
+
#
|
7760
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::AttributionSettings.
|
7761
|
+
# p result
|
7762
|
+
#
|
7763
|
+
def update_attribution_settings request, options = nil
|
7764
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7765
|
+
|
7766
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest
|
7767
|
+
|
7768
|
+
# Converts hash and nil to an options object
|
7769
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7770
|
+
|
7771
|
+
# Customize the options with defaults
|
7772
|
+
metadata = @config.rpcs.update_attribution_settings.metadata.to_h
|
7773
|
+
|
7774
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7775
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7776
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7777
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7778
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7779
|
+
|
7780
|
+
header_params = {}
|
7781
|
+
if request.attribution_settings&.name
|
7782
|
+
header_params["attribution_settings.name"] = request.attribution_settings.name
|
7783
|
+
end
|
7784
|
+
|
7785
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7786
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7787
|
+
|
7788
|
+
options.apply_defaults timeout: @config.rpcs.update_attribution_settings.timeout,
|
7789
|
+
metadata: metadata,
|
7790
|
+
retry_policy: @config.rpcs.update_attribution_settings.retry_policy
|
7791
|
+
|
7792
|
+
options.apply_defaults timeout: @config.timeout,
|
7793
|
+
metadata: @config.metadata,
|
7794
|
+
retry_policy: @config.retry_policy
|
7795
|
+
|
7796
|
+
@analytics_admin_service_stub.call_rpc :update_attribution_settings, request, options: options do |response, operation|
|
7797
|
+
yield response, operation if block_given?
|
7798
|
+
return response
|
7799
|
+
end
|
7800
|
+
rescue ::GRPC::BadStatus => e
|
7801
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7802
|
+
end
|
7803
|
+
|
7804
|
+
##
|
7805
|
+
# Returns a customized report of data access records. The report provides
|
7806
|
+
# records of each time a user reads Google Analytics reporting data. Access
|
7807
|
+
# records are retained for up to 2 years.
|
7808
|
+
#
|
7809
|
+
# Data Access Reports can be requested for a property. The property must be
|
7810
|
+
# in Google Analytics 360. This method is only available to Administrators.
|
7811
|
+
#
|
7812
|
+
# These data access records include GA4 UI Reporting, GA4 UI Explorations,
|
7813
|
+
# GA4 Data API, and other products like Firebase & Admob that can retrieve
|
7814
|
+
# data from Google Analytics through a linkage. These records don't include
|
7815
|
+
# property configuration changes like adding a stream or changing a
|
7816
|
+
# property's time zone. For configuration change history, see
|
7817
|
+
# [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
|
7818
|
+
#
|
7819
|
+
# @overload run_access_report(request, options = nil)
|
7820
|
+
# Pass arguments to `run_access_report` via a request object, either of type
|
7821
|
+
# {::Google::Analytics::Admin::V1alpha::RunAccessReportRequest} or an equivalent Hash.
|
7822
|
+
#
|
7823
|
+
# @param request [::Google::Analytics::Admin::V1alpha::RunAccessReportRequest, ::Hash]
|
7824
|
+
# A request object representing the call parameters. Required. To specify no
|
7825
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7826
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7827
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7828
|
+
#
|
7829
|
+
# @overload run_access_report(entity: nil, dimensions: nil, metrics: nil, date_ranges: nil, dimension_filter: nil, metric_filter: nil, offset: nil, limit: nil, time_zone: nil, order_bys: nil, return_entity_quota: nil)
|
7830
|
+
# Pass arguments to `run_access_report` via keyword arguments. Note that at
|
7831
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7832
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7833
|
+
#
|
7834
|
+
# @param entity [::String]
|
7835
|
+
# The Data Access Report is requested for this property.
|
7836
|
+
# For example if "123" is your GA4 property ID, then entity should be
|
7837
|
+
# "properties/123".
|
7838
|
+
# @param dimensions [::Array<::Google::Analytics::Admin::V1alpha::AccessDimension, ::Hash>]
|
7839
|
+
# The dimensions requested and displayed in the response. Requests are
|
7840
|
+
# allowed up to 9 dimensions.
|
7841
|
+
# @param metrics [::Array<::Google::Analytics::Admin::V1alpha::AccessMetric, ::Hash>]
|
7842
|
+
# The metrics requested and displayed in the response. Requests are allowed
|
7843
|
+
# up to 10 metrics.
|
7844
|
+
# @param date_ranges [::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange, ::Hash>]
|
7845
|
+
# Date ranges of access records to read. If multiple date ranges are
|
7846
|
+
# requested, each response row will contain a zero based date range index. If
|
7847
|
+
# two date ranges overlap, the access records for the overlapping days is
|
7848
|
+
# included in the response rows for both date ranges. Requests are allowed up
|
7849
|
+
# to 2 date ranges.
|
7850
|
+
# @param dimension_filter [::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash]
|
7851
|
+
# Dimension filters allow you to restrict report response to specific
|
7852
|
+
# dimension values which match the filter. For example, filtering on access
|
7853
|
+
# records of a single user. To learn more, see [Fundamentals of Dimension
|
7854
|
+
# Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
|
7855
|
+
# for examples. Metrics cannot be used in this filter.
|
7856
|
+
# @param metric_filter [::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash]
|
7857
|
+
# Metric filters allow you to restrict report response to specific metric
|
7858
|
+
# values which match the filter. Metric filters are applied after aggregating
|
7859
|
+
# the report's rows, similar to SQL having-clause. Dimensions cannot be used
|
7860
|
+
# in this filter.
|
7861
|
+
# @param offset [::Integer]
|
7862
|
+
# The row count of the start row. The first row is counted as row 0. If
|
7863
|
+
# offset is unspecified, it is treated as 0. If offset is zero, then this
|
7864
|
+
# method will return the first page of results with `limit` entries.
|
7865
|
+
#
|
7866
|
+
# To learn more about this pagination parameter, see
|
7867
|
+
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
7868
|
+
# @param limit [::Integer]
|
7869
|
+
# The number of rows to return. If unspecified, 10,000 rows are returned. The
|
7870
|
+
# API returns a maximum of 100,000 rows per request, no matter how many you
|
7871
|
+
# ask for. `limit` must be positive.
|
7872
|
+
#
|
7873
|
+
# The API may return fewer rows than the requested `limit`, if there aren't
|
7874
|
+
# as many remaining rows as the `limit`. For instance, there are fewer than
|
7875
|
+
# 300 possible values for the dimension `country`, so when reporting on only
|
7876
|
+
# `country`, you can't get more than 300 rows, even if you set `limit` to a
|
7877
|
+
# higher value.
|
7878
|
+
#
|
7879
|
+
# To learn more about this pagination parameter, see
|
7880
|
+
# [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
7881
|
+
# @param time_zone [::String]
|
7882
|
+
# This request's time zone if specified. If unspecified, the property's time
|
7883
|
+
# zone is used. The request's time zone is used to interpret the start & end
|
7884
|
+
# dates of the report.
|
7885
|
+
#
|
7886
|
+
# Formatted as strings from the IANA Time Zone database
|
7887
|
+
# (https://www.iana.org/time-zones); for example "America/New_York" or
|
7888
|
+
# "Asia/Tokyo".
|
7889
|
+
# @param order_bys [::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy, ::Hash>]
|
7890
|
+
# Specifies how rows are ordered in the response.
|
7891
|
+
# @param return_entity_quota [::Boolean]
|
7892
|
+
# Toggles whether to return the current state of this Analytics Property's
|
7893
|
+
# quota. Quota is returned in [AccessQuota](#AccessQuota).
|
7894
|
+
#
|
7895
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7896
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
|
7897
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7898
|
+
#
|
7899
|
+
# @return [::Google::Analytics::Admin::V1alpha::RunAccessReportResponse]
|
7900
|
+
#
|
7901
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7902
|
+
#
|
7903
|
+
# @example Basic example
|
7904
|
+
# require "google/analytics/admin/v1alpha"
|
7905
|
+
#
|
7906
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7907
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
7908
|
+
#
|
7909
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
7910
|
+
# request = Google::Analytics::Admin::V1alpha::RunAccessReportRequest.new
|
7911
|
+
#
|
7912
|
+
# # Call the run_access_report method.
|
7913
|
+
# result = client.run_access_report request
|
7914
|
+
#
|
7915
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::RunAccessReportResponse.
|
7916
|
+
# p result
|
7917
|
+
#
|
7918
|
+
def run_access_report request, options = nil
|
7919
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
7920
|
+
|
7921
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::RunAccessReportRequest
|
7922
|
+
|
7923
|
+
# Converts hash and nil to an options object
|
7924
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
7925
|
+
|
7926
|
+
# Customize the options with defaults
|
7927
|
+
metadata = @config.rpcs.run_access_report.metadata.to_h
|
7928
|
+
|
7929
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
7930
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
7931
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
7932
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
7933
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
7934
|
+
|
7935
|
+
header_params = {}
|
7936
|
+
if request.entity
|
7937
|
+
header_params["entity"] = request.entity
|
7938
|
+
end
|
7939
|
+
|
7940
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
7941
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
7942
|
+
|
7943
|
+
options.apply_defaults timeout: @config.rpcs.run_access_report.timeout,
|
7944
|
+
metadata: metadata,
|
7945
|
+
retry_policy: @config.rpcs.run_access_report.retry_policy
|
7946
|
+
|
7947
|
+
options.apply_defaults timeout: @config.timeout,
|
7948
|
+
metadata: @config.metadata,
|
7949
|
+
retry_policy: @config.retry_policy
|
7950
|
+
|
7951
|
+
@analytics_admin_service_stub.call_rpc :run_access_report, request, options: options do |response, operation|
|
7952
|
+
yield response, operation if block_given?
|
7953
|
+
return response
|
7954
|
+
end
|
7955
|
+
rescue ::GRPC::BadStatus => e
|
7956
|
+
raise ::Google::Cloud::Error.from_error(e)
|
7957
|
+
end
|
7958
|
+
|
7959
|
+
##
|
7960
|
+
# Sets the opt out status for the automated GA4 setup process for a UA
|
7961
|
+
# property.
|
7962
|
+
# Note: this has no effect on GA4 property.
|
7963
|
+
#
|
7964
|
+
# @overload set_automated_ga4_configuration_opt_out(request, options = nil)
|
7965
|
+
# Pass arguments to `set_automated_ga4_configuration_opt_out` via a request object, either of type
|
7966
|
+
# {::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
|
7967
|
+
#
|
7968
|
+
# @param request [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::Hash]
|
7969
|
+
# A request object representing the call parameters. Required. To specify no
|
7970
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
7971
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
7972
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
7973
|
+
#
|
7974
|
+
# @overload set_automated_ga4_configuration_opt_out(property: nil, opt_out: nil)
|
7975
|
+
# Pass arguments to `set_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
|
7976
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
7977
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
7978
|
+
#
|
7979
|
+
# @param property [::String]
|
7980
|
+
# Required. The UA property to set the opt out status. Note this request uses
|
7981
|
+
# the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
7982
|
+
# Format: properties/\\{internalWebPropertyId}
|
7983
|
+
# Example: properties/1234
|
7984
|
+
# @param opt_out [::Boolean]
|
7985
|
+
# The status to set.
|
7986
|
+
#
|
7987
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
7988
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
|
7989
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
7990
|
+
#
|
7991
|
+
# @return [::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse]
|
7992
|
+
#
|
7993
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
7994
|
+
#
|
7995
|
+
# @example Basic example
|
7996
|
+
# require "google/analytics/admin/v1alpha"
|
7997
|
+
#
|
7998
|
+
# # Create a client object. The client can be reused for multiple calls.
|
7999
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8000
|
+
#
|
8001
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
8002
|
+
# request = Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest.new
|
8003
|
+
#
|
8004
|
+
# # Call the set_automated_ga4_configuration_opt_out method.
|
8005
|
+
# result = client.set_automated_ga4_configuration_opt_out request
|
8006
|
+
#
|
8007
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse.
|
8008
|
+
# p result
|
8009
|
+
#
|
8010
|
+
def set_automated_ga4_configuration_opt_out request, options = nil
|
8011
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8012
|
+
|
8013
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest
|
8014
|
+
|
8015
|
+
# Converts hash and nil to an options object
|
8016
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8017
|
+
|
8018
|
+
# Customize the options with defaults
|
8019
|
+
metadata = @config.rpcs.set_automated_ga4_configuration_opt_out.metadata.to_h
|
8020
|
+
|
8021
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8022
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8023
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8024
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
8025
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8026
|
+
|
8027
|
+
options.apply_defaults timeout: @config.rpcs.set_automated_ga4_configuration_opt_out.timeout,
|
8028
|
+
metadata: metadata,
|
8029
|
+
retry_policy: @config.rpcs.set_automated_ga4_configuration_opt_out.retry_policy
|
8030
|
+
|
8031
|
+
options.apply_defaults timeout: @config.timeout,
|
8032
|
+
metadata: @config.metadata,
|
8033
|
+
retry_policy: @config.retry_policy
|
8034
|
+
|
8035
|
+
@analytics_admin_service_stub.call_rpc :set_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
|
8036
|
+
yield response, operation if block_given?
|
8037
|
+
return response
|
8038
|
+
end
|
8039
|
+
rescue ::GRPC::BadStatus => e
|
8040
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8041
|
+
end
|
8042
|
+
|
8043
|
+
##
|
8044
|
+
# Fetches the opt out status for the automated GA4 setup process for a UA
|
8045
|
+
# property.
|
8046
|
+
# Note: this has no effect on GA4 property.
|
8047
|
+
#
|
8048
|
+
# @overload fetch_automated_ga4_configuration_opt_out(request, options = nil)
|
8049
|
+
# Pass arguments to `fetch_automated_ga4_configuration_opt_out` via a request object, either of type
|
8050
|
+
# {::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest} or an equivalent Hash.
|
8051
|
+
#
|
8052
|
+
# @param request [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest, ::Hash]
|
8053
|
+
# A request object representing the call parameters. Required. To specify no
|
8054
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8055
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8056
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
8057
|
+
#
|
8058
|
+
# @overload fetch_automated_ga4_configuration_opt_out(property: nil)
|
8059
|
+
# Pass arguments to `fetch_automated_ga4_configuration_opt_out` via keyword arguments. Note that at
|
8060
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8061
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8062
|
+
#
|
8063
|
+
# @param property [::String]
|
8064
|
+
# Required. The UA property to get the opt out status. Note this request uses
|
8065
|
+
# the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
|
8066
|
+
# Format: properties/\\{internalWebPropertyId}
|
8067
|
+
# Example: properties/1234
|
8068
|
+
#
|
8069
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
8070
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
|
8071
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
8072
|
+
#
|
8073
|
+
# @return [::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse]
|
8074
|
+
#
|
8075
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
8076
|
+
#
|
8077
|
+
# @example Basic example
|
8078
|
+
# require "google/analytics/admin/v1alpha"
|
8079
|
+
#
|
8080
|
+
# # Create a client object. The client can be reused for multiple calls.
|
8081
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8082
|
+
#
|
8083
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
8084
|
+
# request = Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest.new
|
8085
|
+
#
|
8086
|
+
# # Call the fetch_automated_ga4_configuration_opt_out method.
|
8087
|
+
# result = client.fetch_automated_ga4_configuration_opt_out request
|
8088
|
+
#
|
8089
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse.
|
8090
|
+
# p result
|
8091
|
+
#
|
8092
|
+
def fetch_automated_ga4_configuration_opt_out request, options = nil
|
8093
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8094
|
+
|
8095
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest
|
8096
|
+
|
8097
|
+
# Converts hash and nil to an options object
|
8098
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8099
|
+
|
8100
|
+
# Customize the options with defaults
|
8101
|
+
metadata = @config.rpcs.fetch_automated_ga4_configuration_opt_out.metadata.to_h
|
8102
|
+
|
8103
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8104
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8105
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8106
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
8107
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8108
|
+
|
8109
|
+
options.apply_defaults timeout: @config.rpcs.fetch_automated_ga4_configuration_opt_out.timeout,
|
8110
|
+
metadata: metadata,
|
8111
|
+
retry_policy: @config.rpcs.fetch_automated_ga4_configuration_opt_out.retry_policy
|
8112
|
+
|
8113
|
+
options.apply_defaults timeout: @config.timeout,
|
8114
|
+
metadata: @config.metadata,
|
8115
|
+
retry_policy: @config.retry_policy
|
8116
|
+
|
8117
|
+
@analytics_admin_service_stub.call_rpc :fetch_automated_ga4_configuration_opt_out, request, options: options do |response, operation|
|
8118
|
+
yield response, operation if block_given?
|
8119
|
+
return response
|
8120
|
+
end
|
8121
|
+
rescue ::GRPC::BadStatus => e
|
8122
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8123
|
+
end
|
8124
|
+
|
8125
|
+
##
|
8126
|
+
# Lookup for a single BigQuery Link.
|
8127
|
+
#
|
8128
|
+
# @overload get_big_query_link(request, options = nil)
|
8129
|
+
# Pass arguments to `get_big_query_link` via a request object, either of type
|
8130
|
+
# {::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest} or an equivalent Hash.
|
8131
|
+
#
|
8132
|
+
# @param request [::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest, ::Hash]
|
8133
|
+
# A request object representing the call parameters. Required. To specify no
|
8134
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8135
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8136
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
8137
|
+
#
|
8138
|
+
# @overload get_big_query_link(name: nil)
|
8139
|
+
# Pass arguments to `get_big_query_link` via keyword arguments. Note that at
|
8140
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8141
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8142
|
+
#
|
8143
|
+
# @param name [::String]
|
8144
|
+
# Required. The name of the BigQuery link to lookup.
|
8145
|
+
# Format: properties/\\{property_id}/bigQueryLinks/\\{bigquery_link_id}
|
8146
|
+
# Example: properties/123/bigQueryLinks/456
|
8147
|
+
#
|
8148
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
8149
|
+
# @yieldparam response [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
8150
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
8151
|
+
#
|
8152
|
+
# @return [::Google::Analytics::Admin::V1alpha::BigQueryLink]
|
8153
|
+
#
|
8154
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
8155
|
+
#
|
8156
|
+
# @example Basic example
|
8157
|
+
# require "google/analytics/admin/v1alpha"
|
8158
|
+
#
|
8159
|
+
# # Create a client object. The client can be reused for multiple calls.
|
8160
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8161
|
+
#
|
8162
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
8163
|
+
# request = Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest.new
|
8164
|
+
#
|
8165
|
+
# # Call the get_big_query_link method.
|
8166
|
+
# result = client.get_big_query_link request
|
8167
|
+
#
|
8168
|
+
# # The returned object is of type Google::Analytics::Admin::V1alpha::BigQueryLink.
|
8169
|
+
# p result
|
8170
|
+
#
|
8171
|
+
def get_big_query_link request, options = nil
|
8172
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8173
|
+
|
8174
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest
|
8175
|
+
|
8176
|
+
# Converts hash and nil to an options object
|
8177
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8178
|
+
|
8179
|
+
# Customize the options with defaults
|
8180
|
+
metadata = @config.rpcs.get_big_query_link.metadata.to_h
|
8181
|
+
|
8182
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8183
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8184
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8185
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
8186
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8187
|
+
|
8188
|
+
header_params = {}
|
8189
|
+
if request.name
|
8190
|
+
header_params["name"] = request.name
|
8191
|
+
end
|
8192
|
+
|
8193
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
8194
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
8195
|
+
|
8196
|
+
options.apply_defaults timeout: @config.rpcs.get_big_query_link.timeout,
|
8197
|
+
metadata: metadata,
|
8198
|
+
retry_policy: @config.rpcs.get_big_query_link.retry_policy
|
8199
|
+
|
8200
|
+
options.apply_defaults timeout: @config.timeout,
|
8201
|
+
metadata: @config.metadata,
|
8202
|
+
retry_policy: @config.retry_policy
|
8203
|
+
|
8204
|
+
@analytics_admin_service_stub.call_rpc :get_big_query_link, request, options: options do |response, operation|
|
8205
|
+
yield response, operation if block_given?
|
8206
|
+
return response
|
8207
|
+
end
|
8208
|
+
rescue ::GRPC::BadStatus => e
|
8209
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8210
|
+
end
|
8211
|
+
|
8212
|
+
##
|
8213
|
+
# Lists BigQuery Links on a property.
|
8214
|
+
#
|
8215
|
+
# @overload list_big_query_links(request, options = nil)
|
8216
|
+
# Pass arguments to `list_big_query_links` via a request object, either of type
|
8217
|
+
# {::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest} or an equivalent Hash.
|
8218
|
+
#
|
8219
|
+
# @param request [::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest, ::Hash]
|
8220
|
+
# A request object representing the call parameters. Required. To specify no
|
8221
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
8222
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
8223
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
8224
|
+
#
|
8225
|
+
# @overload list_big_query_links(parent: nil, page_size: nil, page_token: nil)
|
8226
|
+
# Pass arguments to `list_big_query_links` via keyword arguments. Note that at
|
8227
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
8228
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
8229
|
+
#
|
8230
|
+
# @param parent [::String]
|
8231
|
+
# Required. The name of the property to list BigQuery links under.
|
8232
|
+
# Format: properties/\\{property_id}
|
8233
|
+
# Example: properties/1234
|
8234
|
+
# @param page_size [::Integer]
|
8235
|
+
# The maximum number of resources to return. The service may return
|
8236
|
+
# fewer than this value, even if there are additional pages.
|
8237
|
+
# If unspecified, at most 50 resources will be returned.
|
8238
|
+
# The maximum value is 200; (higher values will be coerced to the maximum)
|
8239
|
+
# @param page_token [::String]
|
8240
|
+
# A page token, received from a previous `ListBigQueryLinks` call.
|
8241
|
+
# Provide this to retrieve the subsequent page.
|
8242
|
+
# When paginating, all other parameters provided to `ListBigQueryLinks` must
|
8243
|
+
# match the call that provided the page token.
|
8244
|
+
#
|
8245
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
8246
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
|
8247
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
8248
|
+
#
|
8249
|
+
# @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>]
|
8250
|
+
#
|
8251
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
8252
|
+
#
|
8253
|
+
# @example Basic example
|
8254
|
+
# require "google/analytics/admin/v1alpha"
|
8255
|
+
#
|
8256
|
+
# # Create a client object. The client can be reused for multiple calls.
|
8257
|
+
# client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
|
8258
|
+
#
|
8259
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
8260
|
+
# request = Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest.new
|
8261
|
+
#
|
8262
|
+
# # Call the list_big_query_links method.
|
8263
|
+
# result = client.list_big_query_links request
|
8264
|
+
#
|
8265
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
8266
|
+
# # iterate over all elements by calling #each, and the enumerable
|
8267
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
8268
|
+
# # methods are also available for managing paging directly.
|
8269
|
+
# result.each do |response|
|
8270
|
+
# # Each element is of type ::Google::Analytics::Admin::V1alpha::BigQueryLink.
|
8271
|
+
# p response
|
8272
|
+
# end
|
8273
|
+
#
|
8274
|
+
def list_big_query_links request, options = nil
|
8275
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
8276
|
+
|
8277
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest
|
8278
|
+
|
8279
|
+
# Converts hash and nil to an options object
|
8280
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
8281
|
+
|
8282
|
+
# Customize the options with defaults
|
8283
|
+
metadata = @config.rpcs.list_big_query_links.metadata.to_h
|
8284
|
+
|
8285
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
8286
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
8287
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
8288
|
+
gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
|
8289
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
8290
|
+
|
8291
|
+
header_params = {}
|
8292
|
+
if request.parent
|
8293
|
+
header_params["parent"] = request.parent
|
8294
|
+
end
|
8295
|
+
|
8296
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
8297
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
8298
|
+
|
8299
|
+
options.apply_defaults timeout: @config.rpcs.list_big_query_links.timeout,
|
8300
|
+
metadata: metadata,
|
8301
|
+
retry_policy: @config.rpcs.list_big_query_links.retry_policy
|
8302
|
+
|
8303
|
+
options.apply_defaults timeout: @config.timeout,
|
8304
|
+
metadata: @config.metadata,
|
8305
|
+
retry_policy: @config.retry_policy
|
8306
|
+
|
8307
|
+
@analytics_admin_service_stub.call_rpc :list_big_query_links, request, options: options do |response, operation|
|
8308
|
+
response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_big_query_links, request, response, operation, options
|
8309
|
+
yield response, operation if block_given?
|
8310
|
+
return response
|
8311
|
+
end
|
8312
|
+
rescue ::GRPC::BadStatus => e
|
8313
|
+
raise ::Google::Cloud::Error.from_error(e)
|
8314
|
+
end
|
8315
|
+
|
8316
|
+
##
|
8317
|
+
# Configuration class for the AnalyticsAdminService API.
|
8318
|
+
#
|
8319
|
+
# This class represents the configuration for AnalyticsAdminService,
|
8320
|
+
# providing control over timeouts, retry behavior, logging, transport
|
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.
|
8325
|
+
#
|
8326
|
+
# Configuration can be applied globally to all clients, or to a single client
|
8327
|
+
# on construction.
|
8328
|
+
#
|
8329
|
+
# @example
|
8330
|
+
#
|
8331
|
+
# # Modify the global config, setting the timeout for
|
8332
|
+
# # get_account to 20 seconds,
|
8333
|
+
# # and all remaining timeouts to 10 seconds.
|
8334
|
+
# ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
|
8335
|
+
# config.timeout = 10.0
|
8336
|
+
# config.rpcs.get_account.timeout = 20.0
|
8337
|
+
# end
|
8338
|
+
#
|
8339
|
+
# # Apply the above configuration only to a new client.
|
8340
|
+
# client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
|
8341
|
+
# config.timeout = 10.0
|
8342
|
+
# config.rpcs.get_account.timeout = 20.0
|
8343
|
+
# end
|
8344
|
+
#
|
8345
|
+
# @!attribute [rw] endpoint
|
8346
|
+
# The hostname or hostname:port of the service endpoint.
|
8347
|
+
# Defaults to `"analyticsadmin.googleapis.com"`.
|
8348
|
+
# @return [::String]
|
8349
|
+
# @!attribute [rw] credentials
|
8350
|
+
# Credentials to send with calls. You may provide any of the following types:
|
8351
|
+
# * (`String`) The path to a service account key file in JSON format
|
8352
|
+
# * (`Hash`) A service account key as a Hash
|
8353
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
8354
|
+
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
8355
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
8356
|
+
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
8357
|
+
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
8358
|
+
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
8359
|
+
# * (`nil`) indicating no credentials
|
8360
|
+
# @return [::Object]
|
8361
|
+
# @!attribute [rw] scope
|
8362
|
+
# The OAuth scopes
|
8363
|
+
# @return [::Array<::String>]
|
8364
|
+
# @!attribute [rw] lib_name
|
8365
|
+
# The library name as recorded in instrumentation and logging
|
8366
|
+
# @return [::String]
|
8367
|
+
# @!attribute [rw] lib_version
|
8368
|
+
# The library version as recorded in instrumentation and logging
|
8369
|
+
# @return [::String]
|
8370
|
+
# @!attribute [rw] channel_args
|
8371
|
+
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
8372
|
+
# `GRPC::Core::Channel` object is provided as the credential.
|
8373
|
+
# @return [::Hash]
|
8374
|
+
# @!attribute [rw] interceptors
|
8375
|
+
# An array of interceptors that are run before calls are executed.
|
8376
|
+
# @return [::Array<::GRPC::ClientInterceptor>]
|
8377
|
+
# @!attribute [rw] timeout
|
8378
|
+
# The call timeout in seconds.
|
8379
|
+
# @return [::Numeric]
|
8380
|
+
# @!attribute [rw] metadata
|
8381
|
+
# Additional gRPC headers to be sent with the call.
|
8382
|
+
# @return [::Hash{::Symbol=>::String}]
|
8383
|
+
# @!attribute [rw] retry_policy
|
8384
|
+
# The retry policy. The value is a hash with the following keys:
|
8385
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
8386
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
8387
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
8388
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
8389
|
+
# trigger a retry.
|
8390
|
+
# @return [::Hash]
|
8391
|
+
# @!attribute [rw] quota_project
|
8392
|
+
# A separate project against which to charge quota.
|
8393
|
+
# @return [::String]
|
8394
|
+
#
|
8395
|
+
class Configuration
|
8396
|
+
extend ::Gapic::Config
|
8397
|
+
|
8398
|
+
config_attr :endpoint, "analyticsadmin.googleapis.com", ::String
|
8399
|
+
config_attr :credentials, nil do |value|
|
8400
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
8401
|
+
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
8402
|
+
allowed.any? { |klass| klass === value }
|
8403
|
+
end
|
8404
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
8405
|
+
config_attr :lib_name, nil, ::String, nil
|
8406
|
+
config_attr :lib_version, nil, ::String, nil
|
8407
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
8408
|
+
config_attr :interceptors, nil, ::Array, nil
|
8409
|
+
config_attr :timeout, nil, ::Numeric, nil
|
8410
|
+
config_attr :metadata, nil, ::Hash, nil
|
8411
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
8412
|
+
config_attr :quota_project, nil, ::String, nil
|
8413
|
+
|
8414
|
+
# @private
|
8415
|
+
def initialize parent_config = nil
|
8416
|
+
@parent_config = parent_config unless parent_config.nil?
|
8417
|
+
|
8418
|
+
yield self if block_given?
|
8419
|
+
end
|
8420
|
+
|
8421
|
+
##
|
8422
|
+
# Configurations for individual RPCs
|
8423
|
+
# @return [Rpcs]
|
8424
|
+
#
|
8425
|
+
def rpcs
|
8426
|
+
@rpcs ||= begin
|
8427
|
+
parent_rpcs = nil
|
8428
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
8429
|
+
Rpcs.new parent_rpcs
|
8430
|
+
end
|
8431
|
+
end
|
8432
|
+
|
8433
|
+
##
|
8434
|
+
# Configuration RPC class for the AnalyticsAdminService API.
|
8435
|
+
#
|
8436
|
+
# Includes fields providing the configuration for each RPC in this service.
|
8437
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
8438
|
+
# the following configuration fields:
|
8439
|
+
#
|
8440
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
8441
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
8442
|
+
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
8443
|
+
# include the following keys:
|
8444
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
6786
8445
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
6787
8446
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
6788
8447
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
@@ -7144,6 +8803,91 @@ module Google
|
|
7144
8803
|
# @return [::Gapic::Config::Method]
|
7145
8804
|
#
|
7146
8805
|
attr_reader :get_data_stream
|
8806
|
+
##
|
8807
|
+
# RPC-specific configuration for `get_audience`
|
8808
|
+
# @return [::Gapic::Config::Method]
|
8809
|
+
#
|
8810
|
+
attr_reader :get_audience
|
8811
|
+
##
|
8812
|
+
# RPC-specific configuration for `list_audiences`
|
8813
|
+
# @return [::Gapic::Config::Method]
|
8814
|
+
#
|
8815
|
+
attr_reader :list_audiences
|
8816
|
+
##
|
8817
|
+
# RPC-specific configuration for `create_audience`
|
8818
|
+
# @return [::Gapic::Config::Method]
|
8819
|
+
#
|
8820
|
+
attr_reader :create_audience
|
8821
|
+
##
|
8822
|
+
# RPC-specific configuration for `update_audience`
|
8823
|
+
# @return [::Gapic::Config::Method]
|
8824
|
+
#
|
8825
|
+
attr_reader :update_audience
|
8826
|
+
##
|
8827
|
+
# RPC-specific configuration for `archive_audience`
|
8828
|
+
# @return [::Gapic::Config::Method]
|
8829
|
+
#
|
8830
|
+
attr_reader :archive_audience
|
8831
|
+
##
|
8832
|
+
# RPC-specific configuration for `get_search_ads360_link`
|
8833
|
+
# @return [::Gapic::Config::Method]
|
8834
|
+
#
|
8835
|
+
attr_reader :get_search_ads360_link
|
8836
|
+
##
|
8837
|
+
# RPC-specific configuration for `list_search_ads360_links`
|
8838
|
+
# @return [::Gapic::Config::Method]
|
8839
|
+
#
|
8840
|
+
attr_reader :list_search_ads360_links
|
8841
|
+
##
|
8842
|
+
# RPC-specific configuration for `create_search_ads360_link`
|
8843
|
+
# @return [::Gapic::Config::Method]
|
8844
|
+
#
|
8845
|
+
attr_reader :create_search_ads360_link
|
8846
|
+
##
|
8847
|
+
# RPC-specific configuration for `delete_search_ads360_link`
|
8848
|
+
# @return [::Gapic::Config::Method]
|
8849
|
+
#
|
8850
|
+
attr_reader :delete_search_ads360_link
|
8851
|
+
##
|
8852
|
+
# RPC-specific configuration for `update_search_ads360_link`
|
8853
|
+
# @return [::Gapic::Config::Method]
|
8854
|
+
#
|
8855
|
+
attr_reader :update_search_ads360_link
|
8856
|
+
##
|
8857
|
+
# RPC-specific configuration for `get_attribution_settings`
|
8858
|
+
# @return [::Gapic::Config::Method]
|
8859
|
+
#
|
8860
|
+
attr_reader :get_attribution_settings
|
8861
|
+
##
|
8862
|
+
# RPC-specific configuration for `update_attribution_settings`
|
8863
|
+
# @return [::Gapic::Config::Method]
|
8864
|
+
#
|
8865
|
+
attr_reader :update_attribution_settings
|
8866
|
+
##
|
8867
|
+
# RPC-specific configuration for `run_access_report`
|
8868
|
+
# @return [::Gapic::Config::Method]
|
8869
|
+
#
|
8870
|
+
attr_reader :run_access_report
|
8871
|
+
##
|
8872
|
+
# RPC-specific configuration for `set_automated_ga4_configuration_opt_out`
|
8873
|
+
# @return [::Gapic::Config::Method]
|
8874
|
+
#
|
8875
|
+
attr_reader :set_automated_ga4_configuration_opt_out
|
8876
|
+
##
|
8877
|
+
# RPC-specific configuration for `fetch_automated_ga4_configuration_opt_out`
|
8878
|
+
# @return [::Gapic::Config::Method]
|
8879
|
+
#
|
8880
|
+
attr_reader :fetch_automated_ga4_configuration_opt_out
|
8881
|
+
##
|
8882
|
+
# RPC-specific configuration for `get_big_query_link`
|
8883
|
+
# @return [::Gapic::Config::Method]
|
8884
|
+
#
|
8885
|
+
attr_reader :get_big_query_link
|
8886
|
+
##
|
8887
|
+
# RPC-specific configuration for `list_big_query_links`
|
8888
|
+
# @return [::Gapic::Config::Method]
|
8889
|
+
#
|
8890
|
+
attr_reader :list_big_query_links
|
7147
8891
|
|
7148
8892
|
# @private
|
7149
8893
|
def initialize parent_rpcs = nil
|
@@ -7289,6 +9033,40 @@ module Google
|
|
7289
9033
|
@list_data_streams = ::Gapic::Config::Method.new list_data_streams_config
|
7290
9034
|
get_data_stream_config = parent_rpcs.get_data_stream if parent_rpcs.respond_to? :get_data_stream
|
7291
9035
|
@get_data_stream = ::Gapic::Config::Method.new get_data_stream_config
|
9036
|
+
get_audience_config = parent_rpcs.get_audience if parent_rpcs.respond_to? :get_audience
|
9037
|
+
@get_audience = ::Gapic::Config::Method.new get_audience_config
|
9038
|
+
list_audiences_config = parent_rpcs.list_audiences if parent_rpcs.respond_to? :list_audiences
|
9039
|
+
@list_audiences = ::Gapic::Config::Method.new list_audiences_config
|
9040
|
+
create_audience_config = parent_rpcs.create_audience if parent_rpcs.respond_to? :create_audience
|
9041
|
+
@create_audience = ::Gapic::Config::Method.new create_audience_config
|
9042
|
+
update_audience_config = parent_rpcs.update_audience if parent_rpcs.respond_to? :update_audience
|
9043
|
+
@update_audience = ::Gapic::Config::Method.new update_audience_config
|
9044
|
+
archive_audience_config = parent_rpcs.archive_audience if parent_rpcs.respond_to? :archive_audience
|
9045
|
+
@archive_audience = ::Gapic::Config::Method.new archive_audience_config
|
9046
|
+
get_search_ads360_link_config = parent_rpcs.get_search_ads360_link if parent_rpcs.respond_to? :get_search_ads360_link
|
9047
|
+
@get_search_ads360_link = ::Gapic::Config::Method.new get_search_ads360_link_config
|
9048
|
+
list_search_ads360_links_config = parent_rpcs.list_search_ads360_links if parent_rpcs.respond_to? :list_search_ads360_links
|
9049
|
+
@list_search_ads360_links = ::Gapic::Config::Method.new list_search_ads360_links_config
|
9050
|
+
create_search_ads360_link_config = parent_rpcs.create_search_ads360_link if parent_rpcs.respond_to? :create_search_ads360_link
|
9051
|
+
@create_search_ads360_link = ::Gapic::Config::Method.new create_search_ads360_link_config
|
9052
|
+
delete_search_ads360_link_config = parent_rpcs.delete_search_ads360_link if parent_rpcs.respond_to? :delete_search_ads360_link
|
9053
|
+
@delete_search_ads360_link = ::Gapic::Config::Method.new delete_search_ads360_link_config
|
9054
|
+
update_search_ads360_link_config = parent_rpcs.update_search_ads360_link if parent_rpcs.respond_to? :update_search_ads360_link
|
9055
|
+
@update_search_ads360_link = ::Gapic::Config::Method.new update_search_ads360_link_config
|
9056
|
+
get_attribution_settings_config = parent_rpcs.get_attribution_settings if parent_rpcs.respond_to? :get_attribution_settings
|
9057
|
+
@get_attribution_settings = ::Gapic::Config::Method.new get_attribution_settings_config
|
9058
|
+
update_attribution_settings_config = parent_rpcs.update_attribution_settings if parent_rpcs.respond_to? :update_attribution_settings
|
9059
|
+
@update_attribution_settings = ::Gapic::Config::Method.new update_attribution_settings_config
|
9060
|
+
run_access_report_config = parent_rpcs.run_access_report if parent_rpcs.respond_to? :run_access_report
|
9061
|
+
@run_access_report = ::Gapic::Config::Method.new run_access_report_config
|
9062
|
+
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
|
+
@set_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new set_automated_ga4_configuration_opt_out_config
|
9064
|
+
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
|
9065
|
+
@fetch_automated_ga4_configuration_opt_out = ::Gapic::Config::Method.new fetch_automated_ga4_configuration_opt_out_config
|
9066
|
+
get_big_query_link_config = parent_rpcs.get_big_query_link if parent_rpcs.respond_to? :get_big_query_link
|
9067
|
+
@get_big_query_link = ::Gapic::Config::Method.new get_big_query_link_config
|
9068
|
+
list_big_query_links_config = parent_rpcs.list_big_query_links if parent_rpcs.respond_to? :list_big_query_links
|
9069
|
+
@list_big_query_links = ::Gapic::Config::Method.new list_big_query_links_config
|
7292
9070
|
|
7293
9071
|
yield self if block_given?
|
7294
9072
|
end
|