google-analytics-admin-v1alpha 0.10.0 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -69,86 +69,6 @@ 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.get_web_data_stream.timeout = 60.0
113
-
114
- default_config.rpcs.update_web_data_stream.timeout = 60.0
115
-
116
- default_config.rpcs.create_web_data_stream.timeout = 60.0
117
-
118
- default_config.rpcs.list_web_data_streams.timeout = 60.0
119
-
120
- default_config.rpcs.get_ios_app_data_stream.timeout = 60.0
121
-
122
- default_config.rpcs.delete_ios_app_data_stream.timeout = 60.0
123
-
124
- default_config.rpcs.update_ios_app_data_stream.timeout = 60.0
125
-
126
- default_config.rpcs.list_ios_app_data_streams.timeout = 60.0
127
-
128
- default_config.rpcs.get_android_app_data_stream.timeout = 60.0
129
-
130
- default_config.rpcs.delete_android_app_data_stream.timeout = 60.0
131
-
132
- default_config.rpcs.update_android_app_data_stream.timeout = 60.0
133
-
134
- default_config.rpcs.list_android_app_data_streams.timeout = 60.0
135
-
136
- default_config.rpcs.create_firebase_link.timeout = 60.0
137
-
138
- default_config.rpcs.delete_firebase_link.timeout = 60.0
139
-
140
- default_config.rpcs.list_firebase_links.timeout = 60.0
141
-
142
- default_config.rpcs.get_global_site_tag.timeout = 60.0
143
-
144
- default_config.rpcs.create_google_ads_link.timeout = 60.0
145
-
146
- default_config.rpcs.update_google_ads_link.timeout = 60.0
147
-
148
- default_config.rpcs.delete_google_ads_link.timeout = 60.0
149
-
150
- default_config.rpcs.list_google_ads_links.timeout = 60.0
151
-
152
72
  default_config
153
73
  end
154
74
  yield @configure if block_given?
@@ -888,14 +808,17 @@ module Google
888
808
  # @param filter [::String]
889
809
  # Required. An expression for filtering the results of the request.
890
810
  # Fields eligible for filtering are:
891
- # `parent:`(The resource name of the parent account) or
811
+ # `parent:`(The resource name of the parent account/property) or
812
+ # `ancestor:`(The resource name of the parent account) or
892
813
  # `firebase_project:`(The id or number of the linked firebase project).
893
814
  # Some examples of filters:
894
815
  #
895
816
  # ```
896
817
  # | Filter | Description |
897
818
  # |-----------------------------|-------------------------------------------|
898
- # | parent:accounts/123 | The account with account id: 123. |
819
+ # | parent:accounts/123 | The account with account id: 123. |
820
+ # | parent:properties/123 | The property with property id: 123. |
821
+ # | ancestor:accounts/123 | The account with account id: 123. |
899
822
  # | firebase_project:project-id | The firebase project with id: project-id. |
900
823
  # | firebase_project:123 | The firebase project with number: 123. |
901
824
  # ```
@@ -1615,1192 +1538,16 @@ module Google
1615
1538
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1616
1539
  metadata[:"x-goog-request-params"] ||= request_params_header
1617
1540
 
1618
- options.apply_defaults timeout: @config.rpcs.audit_user_links.timeout,
1619
- metadata: metadata,
1620
- retry_policy: @config.rpcs.audit_user_links.retry_policy
1621
-
1622
- options.apply_defaults timeout: @config.timeout,
1623
- metadata: @config.metadata,
1624
- retry_policy: @config.retry_policy
1625
-
1626
- @analytics_admin_service_stub.call_rpc :audit_user_links, request, options: options do |response, operation|
1627
- response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :audit_user_links, request, response, operation, options
1628
- yield response, operation if block_given?
1629
- return response
1630
- end
1631
- rescue ::GRPC::BadStatus => e
1632
- raise ::Google::Cloud::Error.from_error(e)
1633
- end
1634
-
1635
- ##
1636
- # Creates a user link on an account or property.
1637
- #
1638
- # If the user with the specified email already has permissions on the
1639
- # account or property, then the user's existing permissions will be unioned
1640
- # with the permissions specified in the new UserLink.
1641
- #
1642
- # @overload create_user_link(request, options = nil)
1643
- # Pass arguments to `create_user_link` via a request object, either of type
1644
- # {::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest} or an equivalent Hash.
1645
- #
1646
- # @param request [::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash]
1647
- # A request object representing the call parameters. Required. To specify no
1648
- # parameters, or to keep all the default parameter values, pass an empty Hash.
1649
- # @param options [::Gapic::CallOptions, ::Hash]
1650
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1651
- #
1652
- # @overload create_user_link(parent: nil, notify_new_user: nil, user_link: nil)
1653
- # Pass arguments to `create_user_link` via keyword arguments. Note that at
1654
- # least one keyword argument is required. To specify no parameters, or to keep all
1655
- # the default parameter values, pass an empty Hash as a request object (see above).
1656
- #
1657
- # @param parent [::String]
1658
- # Required. Example format: accounts/1234
1659
- # @param notify_new_user [::Boolean]
1660
- # Optional. If set, then email the new user notifying them that they've been granted
1661
- # permissions to the resource.
1662
- # @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
1663
- # Required. The user link to create.
1664
- #
1665
- # @yield [response, operation] Access the result along with the RPC operation
1666
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::UserLink]
1667
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
1668
- #
1669
- # @return [::Google::Analytics::Admin::V1alpha::UserLink]
1670
- #
1671
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
1672
- #
1673
- # @example Basic example
1674
- # require "google/analytics/admin/v1alpha"
1675
- #
1676
- # # Create a client object. The client can be reused for multiple calls.
1677
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
1678
- #
1679
- # # Create a request. To set request fields, pass in keyword arguments.
1680
- # request = Google::Analytics::Admin::V1alpha::CreateUserLinkRequest.new
1681
- #
1682
- # # Call the create_user_link method.
1683
- # result = client.create_user_link request
1684
- #
1685
- # # The returned object is of type Google::Analytics::Admin::V1alpha::UserLink.
1686
- # p result
1687
- #
1688
- def create_user_link request, options = nil
1689
- raise ::ArgumentError, "request must be provided" if request.nil?
1690
-
1691
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest
1692
-
1693
- # Converts hash and nil to an options object
1694
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1695
-
1696
- # Customize the options with defaults
1697
- metadata = @config.rpcs.create_user_link.metadata.to_h
1698
-
1699
- # Set x-goog-api-client and x-goog-user-project headers
1700
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1701
- lib_name: @config.lib_name, lib_version: @config.lib_version,
1702
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
1703
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1704
-
1705
- header_params = {}
1706
- if request.parent
1707
- header_params["parent"] = request.parent
1708
- end
1709
-
1710
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1711
- metadata[:"x-goog-request-params"] ||= request_params_header
1712
-
1713
- options.apply_defaults timeout: @config.rpcs.create_user_link.timeout,
1714
- metadata: metadata,
1715
- retry_policy: @config.rpcs.create_user_link.retry_policy
1716
-
1717
- options.apply_defaults timeout: @config.timeout,
1718
- metadata: @config.metadata,
1719
- retry_policy: @config.retry_policy
1720
-
1721
- @analytics_admin_service_stub.call_rpc :create_user_link, request, options: options do |response, operation|
1722
- yield response, operation if block_given?
1723
- return response
1724
- end
1725
- rescue ::GRPC::BadStatus => e
1726
- raise ::Google::Cloud::Error.from_error(e)
1727
- end
1728
-
1729
- ##
1730
- # Creates information about multiple users' links to an account or property.
1731
- #
1732
- # This method is transactional. If any UserLink cannot be created, none of
1733
- # the UserLinks will be created.
1734
- #
1735
- # @overload batch_create_user_links(request, options = nil)
1736
- # Pass arguments to `batch_create_user_links` via a request object, either of type
1737
- # {::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest} or an equivalent Hash.
1738
- #
1739
- # @param request [::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest, ::Hash]
1740
- # A request object representing the call parameters. Required. To specify no
1741
- # parameters, or to keep all the default parameter values, pass an empty Hash.
1742
- # @param options [::Gapic::CallOptions, ::Hash]
1743
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1744
- #
1745
- # @overload batch_create_user_links(parent: nil, notify_new_users: nil, requests: nil)
1746
- # Pass arguments to `batch_create_user_links` via keyword arguments. Note that at
1747
- # least one keyword argument is required. To specify no parameters, or to keep all
1748
- # the default parameter values, pass an empty Hash as a request object (see above).
1749
- #
1750
- # @param parent [::String]
1751
- # Required. The account or property that all user links in the request are for.
1752
- # This field is required. The parent field in the CreateUserLinkRequest
1753
- # messages must either be empty or match this field.
1754
- # Example format: accounts/1234
1755
- # @param notify_new_users [::Boolean]
1756
- # Optional. If set, then email the new users notifying them that they've been granted
1757
- # permissions to the resource. Regardless of whether this is set or not,
1758
- # notify_new_user field inside each individual request is ignored.
1759
- # @param requests [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash>]
1760
- # Required. The requests specifying the user links to create.
1761
- # A maximum of 1000 user links can be created in a batch.
1762
- #
1763
- # @yield [response, operation] Access the result along with the RPC operation
1764
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse]
1765
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
1766
- #
1767
- # @return [::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse]
1768
- #
1769
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
1770
- #
1771
- # @example Basic example
1772
- # require "google/analytics/admin/v1alpha"
1773
- #
1774
- # # Create a client object. The client can be reused for multiple calls.
1775
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
1776
- #
1777
- # # Create a request. To set request fields, pass in keyword arguments.
1778
- # request = Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest.new
1779
- #
1780
- # # Call the batch_create_user_links method.
1781
- # result = client.batch_create_user_links request
1782
- #
1783
- # # The returned object is of type Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse.
1784
- # p result
1785
- #
1786
- def batch_create_user_links request, options = nil
1787
- raise ::ArgumentError, "request must be provided" if request.nil?
1788
-
1789
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest
1790
-
1791
- # Converts hash and nil to an options object
1792
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1793
-
1794
- # Customize the options with defaults
1795
- metadata = @config.rpcs.batch_create_user_links.metadata.to_h
1796
-
1797
- # Set x-goog-api-client and x-goog-user-project headers
1798
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1799
- lib_name: @config.lib_name, lib_version: @config.lib_version,
1800
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
1801
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1802
-
1803
- header_params = {}
1804
- if request.parent
1805
- header_params["parent"] = request.parent
1806
- end
1807
-
1808
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1809
- metadata[:"x-goog-request-params"] ||= request_params_header
1810
-
1811
- options.apply_defaults timeout: @config.rpcs.batch_create_user_links.timeout,
1812
- metadata: metadata,
1813
- retry_policy: @config.rpcs.batch_create_user_links.retry_policy
1814
-
1815
- options.apply_defaults timeout: @config.timeout,
1816
- metadata: @config.metadata,
1817
- retry_policy: @config.retry_policy
1818
-
1819
- @analytics_admin_service_stub.call_rpc :batch_create_user_links, request, options: options do |response, operation|
1820
- yield response, operation if block_given?
1821
- return response
1822
- end
1823
- rescue ::GRPC::BadStatus => e
1824
- raise ::Google::Cloud::Error.from_error(e)
1825
- end
1826
-
1827
- ##
1828
- # Updates a user link on an account or property.
1829
- #
1830
- # @overload update_user_link(request, options = nil)
1831
- # Pass arguments to `update_user_link` via a request object, either of type
1832
- # {::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest} or an equivalent Hash.
1833
- #
1834
- # @param request [::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash]
1835
- # A request object representing the call parameters. Required. To specify no
1836
- # parameters, or to keep all the default parameter values, pass an empty Hash.
1837
- # @param options [::Gapic::CallOptions, ::Hash]
1838
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1839
- #
1840
- # @overload update_user_link(user_link: nil)
1841
- # Pass arguments to `update_user_link` via keyword arguments. Note that at
1842
- # least one keyword argument is required. To specify no parameters, or to keep all
1843
- # the default parameter values, pass an empty Hash as a request object (see above).
1844
- #
1845
- # @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
1846
- # Required. The user link to update.
1847
- #
1848
- # @yield [response, operation] Access the result along with the RPC operation
1849
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::UserLink]
1850
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
1851
- #
1852
- # @return [::Google::Analytics::Admin::V1alpha::UserLink]
1853
- #
1854
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
1855
- #
1856
- # @example Basic example
1857
- # require "google/analytics/admin/v1alpha"
1858
- #
1859
- # # Create a client object. The client can be reused for multiple calls.
1860
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
1861
- #
1862
- # # Create a request. To set request fields, pass in keyword arguments.
1863
- # request = Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest.new
1864
- #
1865
- # # Call the update_user_link method.
1866
- # result = client.update_user_link request
1867
- #
1868
- # # The returned object is of type Google::Analytics::Admin::V1alpha::UserLink.
1869
- # p result
1870
- #
1871
- def update_user_link request, options = nil
1872
- raise ::ArgumentError, "request must be provided" if request.nil?
1873
-
1874
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest
1875
-
1876
- # Converts hash and nil to an options object
1877
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1878
-
1879
- # Customize the options with defaults
1880
- metadata = @config.rpcs.update_user_link.metadata.to_h
1881
-
1882
- # Set x-goog-api-client and x-goog-user-project headers
1883
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1884
- lib_name: @config.lib_name, lib_version: @config.lib_version,
1885
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
1886
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1887
-
1888
- header_params = {}
1889
- if request.user_link&.name
1890
- header_params["user_link.name"] = request.user_link.name
1891
- end
1892
-
1893
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1894
- metadata[:"x-goog-request-params"] ||= request_params_header
1895
-
1896
- options.apply_defaults timeout: @config.rpcs.update_user_link.timeout,
1897
- metadata: metadata,
1898
- retry_policy: @config.rpcs.update_user_link.retry_policy
1899
-
1900
- options.apply_defaults timeout: @config.timeout,
1901
- metadata: @config.metadata,
1902
- retry_policy: @config.retry_policy
1903
-
1904
- @analytics_admin_service_stub.call_rpc :update_user_link, request, options: options do |response, operation|
1905
- yield response, operation if block_given?
1906
- return response
1907
- end
1908
- rescue ::GRPC::BadStatus => e
1909
- raise ::Google::Cloud::Error.from_error(e)
1910
- end
1911
-
1912
- ##
1913
- # Updates information about multiple users' links to an account or property.
1914
- #
1915
- # @overload batch_update_user_links(request, options = nil)
1916
- # Pass arguments to `batch_update_user_links` via a request object, either of type
1917
- # {::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest} or an equivalent Hash.
1918
- #
1919
- # @param request [::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest, ::Hash]
1920
- # A request object representing the call parameters. Required. To specify no
1921
- # parameters, or to keep all the default parameter values, pass an empty Hash.
1922
- # @param options [::Gapic::CallOptions, ::Hash]
1923
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1924
- #
1925
- # @overload batch_update_user_links(parent: nil, requests: nil)
1926
- # Pass arguments to `batch_update_user_links` via keyword arguments. Note that at
1927
- # least one keyword argument is required. To specify no parameters, or to keep all
1928
- # the default parameter values, pass an empty Hash as a request object (see above).
1929
- #
1930
- # @param parent [::String]
1931
- # Required. The account or property that all user links in the request are
1932
- # for. The parent field in the UpdateUserLinkRequest messages must either be
1933
- # empty or match this field.
1934
- # Example format: accounts/1234
1935
- # @param requests [::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash>]
1936
- # Required. The requests specifying the user links to update.
1937
- # A maximum of 1000 user links can be updated in a batch.
1938
- #
1939
- # @yield [response, operation] Access the result along with the RPC operation
1940
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse]
1941
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
1942
- #
1943
- # @return [::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse]
1944
- #
1945
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
1946
- #
1947
- # @example Basic example
1948
- # require "google/analytics/admin/v1alpha"
1949
- #
1950
- # # Create a client object. The client can be reused for multiple calls.
1951
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
1952
- #
1953
- # # Create a request. To set request fields, pass in keyword arguments.
1954
- # request = Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest.new
1955
- #
1956
- # # Call the batch_update_user_links method.
1957
- # result = client.batch_update_user_links request
1958
- #
1959
- # # The returned object is of type Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse.
1960
- # p result
1961
- #
1962
- def batch_update_user_links request, options = nil
1963
- raise ::ArgumentError, "request must be provided" if request.nil?
1964
-
1965
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest
1966
-
1967
- # Converts hash and nil to an options object
1968
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1969
-
1970
- # Customize the options with defaults
1971
- metadata = @config.rpcs.batch_update_user_links.metadata.to_h
1972
-
1973
- # Set x-goog-api-client and x-goog-user-project headers
1974
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1975
- lib_name: @config.lib_name, lib_version: @config.lib_version,
1976
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
1977
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1978
-
1979
- header_params = {}
1980
- if request.parent
1981
- header_params["parent"] = request.parent
1982
- end
1983
-
1984
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1985
- metadata[:"x-goog-request-params"] ||= request_params_header
1986
-
1987
- options.apply_defaults timeout: @config.rpcs.batch_update_user_links.timeout,
1988
- metadata: metadata,
1989
- retry_policy: @config.rpcs.batch_update_user_links.retry_policy
1990
-
1991
- options.apply_defaults timeout: @config.timeout,
1992
- metadata: @config.metadata,
1993
- retry_policy: @config.retry_policy
1994
-
1995
- @analytics_admin_service_stub.call_rpc :batch_update_user_links, request, options: options do |response, operation|
1996
- yield response, operation if block_given?
1997
- return response
1998
- end
1999
- rescue ::GRPC::BadStatus => e
2000
- raise ::Google::Cloud::Error.from_error(e)
2001
- end
2002
-
2003
- ##
2004
- # Deletes a user link on an account or property.
2005
- #
2006
- # @overload delete_user_link(request, options = nil)
2007
- # Pass arguments to `delete_user_link` via a request object, either of type
2008
- # {::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest} or an equivalent Hash.
2009
- #
2010
- # @param request [::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash]
2011
- # A request object representing the call parameters. Required. To specify no
2012
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2013
- # @param options [::Gapic::CallOptions, ::Hash]
2014
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2015
- #
2016
- # @overload delete_user_link(name: nil)
2017
- # Pass arguments to `delete_user_link` via keyword arguments. Note that at
2018
- # least one keyword argument is required. To specify no parameters, or to keep all
2019
- # the default parameter values, pass an empty Hash as a request object (see above).
2020
- #
2021
- # @param name [::String]
2022
- # Required. Example format: accounts/1234/userLinks/5678
2023
- #
2024
- # @yield [response, operation] Access the result along with the RPC operation
2025
- # @yieldparam response [::Google::Protobuf::Empty]
2026
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2027
- #
2028
- # @return [::Google::Protobuf::Empty]
2029
- #
2030
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2031
- #
2032
- # @example Basic example
2033
- # require "google/analytics/admin/v1alpha"
2034
- #
2035
- # # Create a client object. The client can be reused for multiple calls.
2036
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2037
- #
2038
- # # Create a request. To set request fields, pass in keyword arguments.
2039
- # request = Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest.new
2040
- #
2041
- # # Call the delete_user_link method.
2042
- # result = client.delete_user_link request
2043
- #
2044
- # # The returned object is of type Google::Protobuf::Empty.
2045
- # p result
2046
- #
2047
- def delete_user_link request, options = nil
2048
- raise ::ArgumentError, "request must be provided" if request.nil?
2049
-
2050
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest
2051
-
2052
- # Converts hash and nil to an options object
2053
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2054
-
2055
- # Customize the options with defaults
2056
- metadata = @config.rpcs.delete_user_link.metadata.to_h
2057
-
2058
- # Set x-goog-api-client and x-goog-user-project headers
2059
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2060
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2061
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2062
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2063
-
2064
- header_params = {}
2065
- if request.name
2066
- header_params["name"] = request.name
2067
- end
2068
-
2069
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2070
- metadata[:"x-goog-request-params"] ||= request_params_header
2071
-
2072
- options.apply_defaults timeout: @config.rpcs.delete_user_link.timeout,
2073
- metadata: metadata,
2074
- retry_policy: @config.rpcs.delete_user_link.retry_policy
2075
-
2076
- options.apply_defaults timeout: @config.timeout,
2077
- metadata: @config.metadata,
2078
- retry_policy: @config.retry_policy
2079
-
2080
- @analytics_admin_service_stub.call_rpc :delete_user_link, request, options: options do |response, operation|
2081
- yield response, operation if block_given?
2082
- return response
2083
- end
2084
- rescue ::GRPC::BadStatus => e
2085
- raise ::Google::Cloud::Error.from_error(e)
2086
- end
2087
-
2088
- ##
2089
- # Deletes information about multiple users' links to an account or property.
2090
- #
2091
- # @overload batch_delete_user_links(request, options = nil)
2092
- # Pass arguments to `batch_delete_user_links` via a request object, either of type
2093
- # {::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest} or an equivalent Hash.
2094
- #
2095
- # @param request [::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest, ::Hash]
2096
- # A request object representing the call parameters. Required. To specify no
2097
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2098
- # @param options [::Gapic::CallOptions, ::Hash]
2099
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2100
- #
2101
- # @overload batch_delete_user_links(parent: nil, requests: nil)
2102
- # Pass arguments to `batch_delete_user_links` via keyword arguments. Note that at
2103
- # least one keyword argument is required. To specify no parameters, or to keep all
2104
- # the default parameter values, pass an empty Hash as a request object (see above).
2105
- #
2106
- # @param parent [::String]
2107
- # Required. The account or property that all user links in the request are
2108
- # for. The parent of all values for user link names to delete must match this
2109
- # field.
2110
- # Example format: accounts/1234
2111
- # @param requests [::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash>]
2112
- # Required. The requests specifying the user links to update.
2113
- # A maximum of 1000 user links can be updated in a batch.
2114
- #
2115
- # @yield [response, operation] Access the result along with the RPC operation
2116
- # @yieldparam response [::Google::Protobuf::Empty]
2117
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2118
- #
2119
- # @return [::Google::Protobuf::Empty]
2120
- #
2121
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2122
- #
2123
- # @example Basic example
2124
- # require "google/analytics/admin/v1alpha"
2125
- #
2126
- # # Create a client object. The client can be reused for multiple calls.
2127
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2128
- #
2129
- # # Create a request. To set request fields, pass in keyword arguments.
2130
- # request = Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest.new
2131
- #
2132
- # # Call the batch_delete_user_links method.
2133
- # result = client.batch_delete_user_links request
2134
- #
2135
- # # The returned object is of type Google::Protobuf::Empty.
2136
- # p result
2137
- #
2138
- def batch_delete_user_links request, options = nil
2139
- raise ::ArgumentError, "request must be provided" if request.nil?
2140
-
2141
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest
2142
-
2143
- # Converts hash and nil to an options object
2144
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2145
-
2146
- # Customize the options with defaults
2147
- metadata = @config.rpcs.batch_delete_user_links.metadata.to_h
2148
-
2149
- # Set x-goog-api-client and x-goog-user-project headers
2150
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2151
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2152
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2153
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2154
-
2155
- header_params = {}
2156
- if request.parent
2157
- header_params["parent"] = request.parent
2158
- end
2159
-
2160
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2161
- metadata[:"x-goog-request-params"] ||= request_params_header
2162
-
2163
- options.apply_defaults timeout: @config.rpcs.batch_delete_user_links.timeout,
2164
- metadata: metadata,
2165
- retry_policy: @config.rpcs.batch_delete_user_links.retry_policy
2166
-
2167
- options.apply_defaults timeout: @config.timeout,
2168
- metadata: @config.metadata,
2169
- retry_policy: @config.retry_policy
2170
-
2171
- @analytics_admin_service_stub.call_rpc :batch_delete_user_links, request, options: options do |response, operation|
2172
- yield response, operation if block_given?
2173
- return response
2174
- end
2175
- rescue ::GRPC::BadStatus => e
2176
- raise ::Google::Cloud::Error.from_error(e)
2177
- end
2178
-
2179
- ##
2180
- # Lookup for a single WebDataStream
2181
- #
2182
- # @overload get_web_data_stream(request, options = nil)
2183
- # Pass arguments to `get_web_data_stream` via a request object, either of type
2184
- # {::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest} or an equivalent Hash.
2185
- #
2186
- # @param request [::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest, ::Hash]
2187
- # A request object representing the call parameters. Required. To specify no
2188
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2189
- # @param options [::Gapic::CallOptions, ::Hash]
2190
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2191
- #
2192
- # @overload get_web_data_stream(name: nil)
2193
- # Pass arguments to `get_web_data_stream` via keyword arguments. Note that at
2194
- # least one keyword argument is required. To specify no parameters, or to keep all
2195
- # the default parameter values, pass an empty Hash as a request object (see above).
2196
- #
2197
- # @param name [::String]
2198
- # Required. The name of the web data stream to lookup.
2199
- # Format: properties/\\{property_id}/webDataStreams/\\{stream_id}
2200
- # Example: "properties/123/webDataStreams/456"
2201
- #
2202
- # @yield [response, operation] Access the result along with the RPC operation
2203
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::WebDataStream]
2204
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2205
- #
2206
- # @return [::Google::Analytics::Admin::V1alpha::WebDataStream]
2207
- #
2208
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2209
- #
2210
- # @example Basic example
2211
- # require "google/analytics/admin/v1alpha"
2212
- #
2213
- # # Create a client object. The client can be reused for multiple calls.
2214
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2215
- #
2216
- # # Create a request. To set request fields, pass in keyword arguments.
2217
- # request = Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest.new
2218
- #
2219
- # # Call the get_web_data_stream method.
2220
- # result = client.get_web_data_stream request
2221
- #
2222
- # # The returned object is of type Google::Analytics::Admin::V1alpha::WebDataStream.
2223
- # p result
2224
- #
2225
- def get_web_data_stream request, options = nil
2226
- raise ::ArgumentError, "request must be provided" if request.nil?
2227
-
2228
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest
2229
-
2230
- # Converts hash and nil to an options object
2231
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2232
-
2233
- # Customize the options with defaults
2234
- metadata = @config.rpcs.get_web_data_stream.metadata.to_h
2235
-
2236
- # Set x-goog-api-client and x-goog-user-project headers
2237
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2238
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2239
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2240
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2241
-
2242
- header_params = {}
2243
- if request.name
2244
- header_params["name"] = request.name
2245
- end
2246
-
2247
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2248
- metadata[:"x-goog-request-params"] ||= request_params_header
2249
-
2250
- options.apply_defaults timeout: @config.rpcs.get_web_data_stream.timeout,
2251
- metadata: metadata,
2252
- retry_policy: @config.rpcs.get_web_data_stream.retry_policy
2253
-
2254
- options.apply_defaults timeout: @config.timeout,
2255
- metadata: @config.metadata,
2256
- retry_policy: @config.retry_policy
2257
-
2258
- @analytics_admin_service_stub.call_rpc :get_web_data_stream, request, options: options do |response, operation|
2259
- yield response, operation if block_given?
2260
- return response
2261
- end
2262
- rescue ::GRPC::BadStatus => e
2263
- raise ::Google::Cloud::Error.from_error(e)
2264
- end
2265
-
2266
- ##
2267
- # Deletes a web stream on a property.
2268
- #
2269
- # @overload delete_web_data_stream(request, options = nil)
2270
- # Pass arguments to `delete_web_data_stream` via a request object, either of type
2271
- # {::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest} or an equivalent Hash.
2272
- #
2273
- # @param request [::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest, ::Hash]
2274
- # A request object representing the call parameters. Required. To specify no
2275
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2276
- # @param options [::Gapic::CallOptions, ::Hash]
2277
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2278
- #
2279
- # @overload delete_web_data_stream(name: nil)
2280
- # Pass arguments to `delete_web_data_stream` via keyword arguments. Note that at
2281
- # least one keyword argument is required. To specify no parameters, or to keep all
2282
- # the default parameter values, pass an empty Hash as a request object (see above).
2283
- #
2284
- # @param name [::String]
2285
- # Required. The name of the web data stream to delete.
2286
- # Format: properties/\\{property_id}/webDataStreams/\\{stream_id}
2287
- # Example: "properties/123/webDataStreams/456"
2288
- #
2289
- # @yield [response, operation] Access the result along with the RPC operation
2290
- # @yieldparam response [::Google::Protobuf::Empty]
2291
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2292
- #
2293
- # @return [::Google::Protobuf::Empty]
2294
- #
2295
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2296
- #
2297
- # @example Basic example
2298
- # require "google/analytics/admin/v1alpha"
2299
- #
2300
- # # Create a client object. The client can be reused for multiple calls.
2301
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2302
- #
2303
- # # Create a request. To set request fields, pass in keyword arguments.
2304
- # request = Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest.new
2305
- #
2306
- # # Call the delete_web_data_stream method.
2307
- # result = client.delete_web_data_stream request
2308
- #
2309
- # # The returned object is of type Google::Protobuf::Empty.
2310
- # p result
2311
- #
2312
- def delete_web_data_stream request, options = nil
2313
- raise ::ArgumentError, "request must be provided" if request.nil?
2314
-
2315
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest
2316
-
2317
- # Converts hash and nil to an options object
2318
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2319
-
2320
- # Customize the options with defaults
2321
- metadata = @config.rpcs.delete_web_data_stream.metadata.to_h
2322
-
2323
- # Set x-goog-api-client and x-goog-user-project headers
2324
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2325
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2326
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2327
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2328
-
2329
- header_params = {}
2330
- if request.name
2331
- header_params["name"] = request.name
2332
- end
2333
-
2334
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2335
- metadata[:"x-goog-request-params"] ||= request_params_header
2336
-
2337
- options.apply_defaults timeout: @config.rpcs.delete_web_data_stream.timeout,
2338
- metadata: metadata,
2339
- retry_policy: @config.rpcs.delete_web_data_stream.retry_policy
2340
-
2341
- options.apply_defaults timeout: @config.timeout,
2342
- metadata: @config.metadata,
2343
- retry_policy: @config.retry_policy
2344
-
2345
- @analytics_admin_service_stub.call_rpc :delete_web_data_stream, request, options: options do |response, operation|
2346
- yield response, operation if block_given?
2347
- return response
2348
- end
2349
- rescue ::GRPC::BadStatus => e
2350
- raise ::Google::Cloud::Error.from_error(e)
2351
- end
2352
-
2353
- ##
2354
- # Updates a web stream on a property.
2355
- #
2356
- # @overload update_web_data_stream(request, options = nil)
2357
- # Pass arguments to `update_web_data_stream` via a request object, either of type
2358
- # {::Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest} or an equivalent Hash.
2359
- #
2360
- # @param request [::Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest, ::Hash]
2361
- # A request object representing the call parameters. Required. To specify no
2362
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2363
- # @param options [::Gapic::CallOptions, ::Hash]
2364
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2365
- #
2366
- # @overload update_web_data_stream(web_data_stream: nil, update_mask: nil)
2367
- # Pass arguments to `update_web_data_stream` via keyword arguments. Note that at
2368
- # least one keyword argument is required. To specify no parameters, or to keep all
2369
- # the default parameter values, pass an empty Hash as a request object (see above).
2370
- #
2371
- # @param web_data_stream [::Google::Analytics::Admin::V1alpha::WebDataStream, ::Hash]
2372
- # Required. The web stream to update.
2373
- # The `name` field is used to identify the web stream to be updated.
2374
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2375
- # Required. The list of fields to be updated. Field names must be in snake case
2376
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
2377
- # the entire entity, use one path with the string "*" to match all fields.
2378
- #
2379
- # @yield [response, operation] Access the result along with the RPC operation
2380
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::WebDataStream]
2381
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2382
- #
2383
- # @return [::Google::Analytics::Admin::V1alpha::WebDataStream]
2384
- #
2385
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2386
- #
2387
- # @example Basic example
2388
- # require "google/analytics/admin/v1alpha"
2389
- #
2390
- # # Create a client object. The client can be reused for multiple calls.
2391
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2392
- #
2393
- # # Create a request. To set request fields, pass in keyword arguments.
2394
- # request = Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest.new
2395
- #
2396
- # # Call the update_web_data_stream method.
2397
- # result = client.update_web_data_stream request
2398
- #
2399
- # # The returned object is of type Google::Analytics::Admin::V1alpha::WebDataStream.
2400
- # p result
2401
- #
2402
- def update_web_data_stream request, options = nil
2403
- raise ::ArgumentError, "request must be provided" if request.nil?
2404
-
2405
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest
2406
-
2407
- # Converts hash and nil to an options object
2408
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2409
-
2410
- # Customize the options with defaults
2411
- metadata = @config.rpcs.update_web_data_stream.metadata.to_h
2412
-
2413
- # Set x-goog-api-client and x-goog-user-project headers
2414
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2415
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2416
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2417
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2418
-
2419
- header_params = {}
2420
- if request.web_data_stream&.name
2421
- header_params["web_data_stream.name"] = request.web_data_stream.name
2422
- end
2423
-
2424
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2425
- metadata[:"x-goog-request-params"] ||= request_params_header
2426
-
2427
- options.apply_defaults timeout: @config.rpcs.update_web_data_stream.timeout,
2428
- metadata: metadata,
2429
- retry_policy: @config.rpcs.update_web_data_stream.retry_policy
2430
-
2431
- options.apply_defaults timeout: @config.timeout,
2432
- metadata: @config.metadata,
2433
- retry_policy: @config.retry_policy
2434
-
2435
- @analytics_admin_service_stub.call_rpc :update_web_data_stream, request, options: options do |response, operation|
2436
- yield response, operation if block_given?
2437
- return response
2438
- end
2439
- rescue ::GRPC::BadStatus => e
2440
- raise ::Google::Cloud::Error.from_error(e)
2441
- end
2442
-
2443
- ##
2444
- # Creates a web stream with the specified location and attributes.
2445
- #
2446
- # @overload create_web_data_stream(request, options = nil)
2447
- # Pass arguments to `create_web_data_stream` via a request object, either of type
2448
- # {::Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest} or an equivalent Hash.
2449
- #
2450
- # @param request [::Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest, ::Hash]
2451
- # A request object representing the call parameters. Required. To specify no
2452
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2453
- # @param options [::Gapic::CallOptions, ::Hash]
2454
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2455
- #
2456
- # @overload create_web_data_stream(web_data_stream: nil, parent: nil)
2457
- # Pass arguments to `create_web_data_stream` via keyword arguments. Note that at
2458
- # least one keyword argument is required. To specify no parameters, or to keep all
2459
- # the default parameter values, pass an empty Hash as a request object (see above).
2460
- #
2461
- # @param web_data_stream [::Google::Analytics::Admin::V1alpha::WebDataStream, ::Hash]
2462
- # Required. The web stream to create.
2463
- # @param parent [::String]
2464
- # Required. The parent resource where this web data stream will be created.
2465
- # Format: properties/123
2466
- #
2467
- # @yield [response, operation] Access the result along with the RPC operation
2468
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::WebDataStream]
2469
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2470
- #
2471
- # @return [::Google::Analytics::Admin::V1alpha::WebDataStream]
2472
- #
2473
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2474
- #
2475
- # @example Basic example
2476
- # require "google/analytics/admin/v1alpha"
2477
- #
2478
- # # Create a client object. The client can be reused for multiple calls.
2479
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2480
- #
2481
- # # Create a request. To set request fields, pass in keyword arguments.
2482
- # request = Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest.new
2483
- #
2484
- # # Call the create_web_data_stream method.
2485
- # result = client.create_web_data_stream request
2486
- #
2487
- # # The returned object is of type Google::Analytics::Admin::V1alpha::WebDataStream.
2488
- # p result
2489
- #
2490
- def create_web_data_stream request, options = nil
2491
- raise ::ArgumentError, "request must be provided" if request.nil?
2492
-
2493
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest
2494
-
2495
- # Converts hash and nil to an options object
2496
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2497
-
2498
- # Customize the options with defaults
2499
- metadata = @config.rpcs.create_web_data_stream.metadata.to_h
2500
-
2501
- # Set x-goog-api-client and x-goog-user-project headers
2502
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2503
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2504
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2505
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2506
-
2507
- header_params = {}
2508
- if request.parent
2509
- header_params["parent"] = request.parent
2510
- end
2511
-
2512
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2513
- metadata[:"x-goog-request-params"] ||= request_params_header
2514
-
2515
- options.apply_defaults timeout: @config.rpcs.create_web_data_stream.timeout,
2516
- metadata: metadata,
2517
- retry_policy: @config.rpcs.create_web_data_stream.retry_policy
2518
-
2519
- options.apply_defaults timeout: @config.timeout,
2520
- metadata: @config.metadata,
2521
- retry_policy: @config.retry_policy
2522
-
2523
- @analytics_admin_service_stub.call_rpc :create_web_data_stream, request, options: options do |response, operation|
2524
- yield response, operation if block_given?
2525
- return response
2526
- end
2527
- rescue ::GRPC::BadStatus => e
2528
- raise ::Google::Cloud::Error.from_error(e)
2529
- end
2530
-
2531
- ##
2532
- # Returns child web data streams under the specified parent property.
2533
- #
2534
- # Web data streams will be excluded if the caller does not have access.
2535
- # Returns an empty list if no relevant web data streams are found.
2536
- #
2537
- # @overload list_web_data_streams(request, options = nil)
2538
- # Pass arguments to `list_web_data_streams` via a request object, either of type
2539
- # {::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest} or an equivalent Hash.
2540
- #
2541
- # @param request [::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest, ::Hash]
2542
- # A request object representing the call parameters. Required. To specify no
2543
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2544
- # @param options [::Gapic::CallOptions, ::Hash]
2545
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2546
- #
2547
- # @overload list_web_data_streams(parent: nil, page_size: nil, page_token: nil)
2548
- # Pass arguments to `list_web_data_streams` via keyword arguments. Note that at
2549
- # least one keyword argument is required. To specify no parameters, or to keep all
2550
- # the default parameter values, pass an empty Hash as a request object (see above).
2551
- #
2552
- # @param parent [::String]
2553
- # Required. The name of the parent property.
2554
- # For example, to list results of web streams under the property with Id
2555
- # 123: "properties/123"
2556
- # @param page_size [::Integer]
2557
- # The maximum number of resources to return.
2558
- # If unspecified, at most 50 resources will be returned.
2559
- # The maximum value is 200; (higher values will be coerced to the maximum)
2560
- # @param page_token [::String]
2561
- # A page token, received from a previous `ListWebDataStreams` call.
2562
- # Provide this to retrieve the subsequent page.
2563
- # When paginating, all other parameters provided to `ListWebDataStreams` must
2564
- # match the call that provided the page token.
2565
- #
2566
- # @yield [response, operation] Access the result along with the RPC operation
2567
- # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>]
2568
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2569
- #
2570
- # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>]
2571
- #
2572
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2573
- #
2574
- # @example Basic example
2575
- # require "google/analytics/admin/v1alpha"
2576
- #
2577
- # # Create a client object. The client can be reused for multiple calls.
2578
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2579
- #
2580
- # # Create a request. To set request fields, pass in keyword arguments.
2581
- # request = Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest.new
2582
- #
2583
- # # Call the list_web_data_streams method.
2584
- # result = client.list_web_data_streams request
2585
- #
2586
- # # The returned object is of type Gapic::PagedEnumerable. You can
2587
- # # iterate over all elements by calling #each, and the enumerable
2588
- # # will lazily make API calls to fetch subsequent pages. Other
2589
- # # methods are also available for managing paging directly.
2590
- # result.each do |response|
2591
- # # Each element is of type ::Google::Analytics::Admin::V1alpha::WebDataStream.
2592
- # p response
2593
- # end
2594
- #
2595
- def list_web_data_streams request, options = nil
2596
- raise ::ArgumentError, "request must be provided" if request.nil?
2597
-
2598
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest
2599
-
2600
- # Converts hash and nil to an options object
2601
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2602
-
2603
- # Customize the options with defaults
2604
- metadata = @config.rpcs.list_web_data_streams.metadata.to_h
2605
-
2606
- # Set x-goog-api-client and x-goog-user-project headers
2607
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2608
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2609
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2610
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2611
-
2612
- header_params = {}
2613
- if request.parent
2614
- header_params["parent"] = request.parent
2615
- end
2616
-
2617
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2618
- metadata[:"x-goog-request-params"] ||= request_params_header
2619
-
2620
- options.apply_defaults timeout: @config.rpcs.list_web_data_streams.timeout,
2621
- metadata: metadata,
2622
- retry_policy: @config.rpcs.list_web_data_streams.retry_policy
2623
-
2624
- options.apply_defaults timeout: @config.timeout,
2625
- metadata: @config.metadata,
2626
- retry_policy: @config.retry_policy
2627
-
2628
- @analytics_admin_service_stub.call_rpc :list_web_data_streams, request, options: options do |response, operation|
2629
- response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_web_data_streams, request, response, operation, options
2630
- yield response, operation if block_given?
2631
- return response
2632
- end
2633
- rescue ::GRPC::BadStatus => e
2634
- raise ::Google::Cloud::Error.from_error(e)
2635
- end
2636
-
2637
- ##
2638
- # Lookup for a single IosAppDataStream
2639
- #
2640
- # @overload get_ios_app_data_stream(request, options = nil)
2641
- # Pass arguments to `get_ios_app_data_stream` via a request object, either of type
2642
- # {::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest} or an equivalent Hash.
2643
- #
2644
- # @param request [::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest, ::Hash]
2645
- # A request object representing the call parameters. Required. To specify no
2646
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2647
- # @param options [::Gapic::CallOptions, ::Hash]
2648
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2649
- #
2650
- # @overload get_ios_app_data_stream(name: nil)
2651
- # Pass arguments to `get_ios_app_data_stream` via keyword arguments. Note that at
2652
- # least one keyword argument is required. To specify no parameters, or to keep all
2653
- # the default parameter values, pass an empty Hash as a request object (see above).
2654
- #
2655
- # @param name [::String]
2656
- # Required. The name of the iOS app data stream to lookup.
2657
- # Format: properties/\\{property_id}/iosAppDataStreams/\\{stream_id}
2658
- # Example: "properties/123/iosAppDataStreams/456"
2659
- #
2660
- # @yield [response, operation] Access the result along with the RPC operation
2661
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
2662
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2663
- #
2664
- # @return [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
2665
- #
2666
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2667
- #
2668
- # @example Basic example
2669
- # require "google/analytics/admin/v1alpha"
2670
- #
2671
- # # Create a client object. The client can be reused for multiple calls.
2672
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2673
- #
2674
- # # Create a request. To set request fields, pass in keyword arguments.
2675
- # request = Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest.new
2676
- #
2677
- # # Call the get_ios_app_data_stream method.
2678
- # result = client.get_ios_app_data_stream request
2679
- #
2680
- # # The returned object is of type Google::Analytics::Admin::V1alpha::IosAppDataStream.
2681
- # p result
2682
- #
2683
- def get_ios_app_data_stream request, options = nil
2684
- raise ::ArgumentError, "request must be provided" if request.nil?
2685
-
2686
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest
2687
-
2688
- # Converts hash and nil to an options object
2689
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2690
-
2691
- # Customize the options with defaults
2692
- metadata = @config.rpcs.get_ios_app_data_stream.metadata.to_h
2693
-
2694
- # Set x-goog-api-client and x-goog-user-project headers
2695
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2696
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2697
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2698
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2699
-
2700
- header_params = {}
2701
- if request.name
2702
- header_params["name"] = request.name
2703
- end
2704
-
2705
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2706
- metadata[:"x-goog-request-params"] ||= request_params_header
2707
-
2708
- options.apply_defaults timeout: @config.rpcs.get_ios_app_data_stream.timeout,
2709
- metadata: metadata,
2710
- retry_policy: @config.rpcs.get_ios_app_data_stream.retry_policy
2711
-
2712
- options.apply_defaults timeout: @config.timeout,
2713
- metadata: @config.metadata,
2714
- retry_policy: @config.retry_policy
2715
-
2716
- @analytics_admin_service_stub.call_rpc :get_ios_app_data_stream, request, options: options do |response, operation|
2717
- yield response, operation if block_given?
2718
- return response
2719
- end
2720
- rescue ::GRPC::BadStatus => e
2721
- raise ::Google::Cloud::Error.from_error(e)
2722
- end
2723
-
2724
- ##
2725
- # Deletes an iOS app stream on a property.
2726
- #
2727
- # @overload delete_ios_app_data_stream(request, options = nil)
2728
- # Pass arguments to `delete_ios_app_data_stream` via a request object, either of type
2729
- # {::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest} or an equivalent Hash.
2730
- #
2731
- # @param request [::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest, ::Hash]
2732
- # A request object representing the call parameters. Required. To specify no
2733
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2734
- # @param options [::Gapic::CallOptions, ::Hash]
2735
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2736
- #
2737
- # @overload delete_ios_app_data_stream(name: nil)
2738
- # Pass arguments to `delete_ios_app_data_stream` via keyword arguments. Note that at
2739
- # least one keyword argument is required. To specify no parameters, or to keep all
2740
- # the default parameter values, pass an empty Hash as a request object (see above).
2741
- #
2742
- # @param name [::String]
2743
- # Required. The name of the iOS app data stream to delete.
2744
- # Format: properties/\\{property_id}/iosAppDataStreams/\\{stream_id}
2745
- # Example: "properties/123/iosAppDataStreams/456"
2746
- #
2747
- # @yield [response, operation] Access the result along with the RPC operation
2748
- # @yieldparam response [::Google::Protobuf::Empty]
2749
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
2750
- #
2751
- # @return [::Google::Protobuf::Empty]
2752
- #
2753
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
2754
- #
2755
- # @example Basic example
2756
- # require "google/analytics/admin/v1alpha"
2757
- #
2758
- # # Create a client object. The client can be reused for multiple calls.
2759
- # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2760
- #
2761
- # # Create a request. To set request fields, pass in keyword arguments.
2762
- # request = Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest.new
2763
- #
2764
- # # Call the delete_ios_app_data_stream method.
2765
- # result = client.delete_ios_app_data_stream request
2766
- #
2767
- # # The returned object is of type Google::Protobuf::Empty.
2768
- # p result
2769
- #
2770
- def delete_ios_app_data_stream request, options = nil
2771
- raise ::ArgumentError, "request must be provided" if request.nil?
2772
-
2773
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest
2774
-
2775
- # Converts hash and nil to an options object
2776
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2777
-
2778
- # Customize the options with defaults
2779
- metadata = @config.rpcs.delete_ios_app_data_stream.metadata.to_h
2780
-
2781
- # Set x-goog-api-client and x-goog-user-project headers
2782
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2783
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2784
- gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
2785
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2786
-
2787
- header_params = {}
2788
- if request.name
2789
- header_params["name"] = request.name
2790
- end
2791
-
2792
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2793
- metadata[:"x-goog-request-params"] ||= request_params_header
2794
-
2795
- options.apply_defaults timeout: @config.rpcs.delete_ios_app_data_stream.timeout,
1541
+ options.apply_defaults timeout: @config.rpcs.audit_user_links.timeout,
2796
1542
  metadata: metadata,
2797
- retry_policy: @config.rpcs.delete_ios_app_data_stream.retry_policy
1543
+ retry_policy: @config.rpcs.audit_user_links.retry_policy
2798
1544
 
2799
1545
  options.apply_defaults timeout: @config.timeout,
2800
1546
  metadata: @config.metadata,
2801
1547
  retry_policy: @config.retry_policy
2802
1548
 
2803
- @analytics_admin_service_stub.call_rpc :delete_ios_app_data_stream, request, options: options do |response, operation|
1549
+ @analytics_admin_service_stub.call_rpc :audit_user_links, request, options: options do |response, operation|
1550
+ response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :audit_user_links, request, response, operation, options
2804
1551
  yield response, operation if block_given?
2805
1552
  return response
2806
1553
  end
@@ -2809,36 +1556,40 @@ module Google
2809
1556
  end
2810
1557
 
2811
1558
  ##
2812
- # Updates an iOS app stream on a property.
1559
+ # Creates a user link on an account or property.
1560
+ #
1561
+ # If the user with the specified email already has permissions on the
1562
+ # account or property, then the user's existing permissions will be unioned
1563
+ # with the permissions specified in the new UserLink.
2813
1564
  #
2814
- # @overload update_ios_app_data_stream(request, options = nil)
2815
- # Pass arguments to `update_ios_app_data_stream` via a request object, either of type
2816
- # {::Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest} or an equivalent Hash.
1565
+ # @overload create_user_link(request, options = nil)
1566
+ # Pass arguments to `create_user_link` via a request object, either of type
1567
+ # {::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest} or an equivalent Hash.
2817
1568
  #
2818
- # @param request [::Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest, ::Hash]
1569
+ # @param request [::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash]
2819
1570
  # A request object representing the call parameters. Required. To specify no
2820
1571
  # parameters, or to keep all the default parameter values, pass an empty Hash.
2821
1572
  # @param options [::Gapic::CallOptions, ::Hash]
2822
1573
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2823
1574
  #
2824
- # @overload update_ios_app_data_stream(ios_app_data_stream: nil, update_mask: nil)
2825
- # Pass arguments to `update_ios_app_data_stream` via keyword arguments. Note that at
1575
+ # @overload create_user_link(parent: nil, notify_new_user: nil, user_link: nil)
1576
+ # Pass arguments to `create_user_link` via keyword arguments. Note that at
2826
1577
  # least one keyword argument is required. To specify no parameters, or to keep all
2827
1578
  # the default parameter values, pass an empty Hash as a request object (see above).
2828
1579
  #
2829
- # @param ios_app_data_stream [::Google::Analytics::Admin::V1alpha::IosAppDataStream, ::Hash]
2830
- # Required. The iOS app stream to update.
2831
- # The `name` field is used to identify the iOS app stream to be updated.
2832
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2833
- # Required. The list of fields to be updated. Field names must be in snake case
2834
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
2835
- # the entire entity, use one path with the string "*" to match all fields.
1580
+ # @param parent [::String]
1581
+ # Required. Example format: accounts/1234
1582
+ # @param notify_new_user [::Boolean]
1583
+ # Optional. If set, then email the new user notifying them that they've been granted
1584
+ # permissions to the resource.
1585
+ # @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
1586
+ # Required. The user link to create.
2836
1587
  #
2837
1588
  # @yield [response, operation] Access the result along with the RPC operation
2838
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
1589
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::UserLink]
2839
1590
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
2840
1591
  #
2841
- # @return [::Google::Analytics::Admin::V1alpha::IosAppDataStream]
1592
+ # @return [::Google::Analytics::Admin::V1alpha::UserLink]
2842
1593
  #
2843
1594
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2844
1595
  #
@@ -2849,24 +1600,24 @@ module Google
2849
1600
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2850
1601
  #
2851
1602
  # # Create a request. To set request fields, pass in keyword arguments.
2852
- # request = Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest.new
1603
+ # request = Google::Analytics::Admin::V1alpha::CreateUserLinkRequest.new
2853
1604
  #
2854
- # # Call the update_ios_app_data_stream method.
2855
- # result = client.update_ios_app_data_stream request
1605
+ # # Call the create_user_link method.
1606
+ # result = client.create_user_link request
2856
1607
  #
2857
- # # The returned object is of type Google::Analytics::Admin::V1alpha::IosAppDataStream.
1608
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::UserLink.
2858
1609
  # p result
2859
1610
  #
2860
- def update_ios_app_data_stream request, options = nil
1611
+ def create_user_link request, options = nil
2861
1612
  raise ::ArgumentError, "request must be provided" if request.nil?
2862
1613
 
2863
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest
1614
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest
2864
1615
 
2865
1616
  # Converts hash and nil to an options object
2866
1617
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2867
1618
 
2868
1619
  # Customize the options with defaults
2869
- metadata = @config.rpcs.update_ios_app_data_stream.metadata.to_h
1620
+ metadata = @config.rpcs.create_user_link.metadata.to_h
2870
1621
 
2871
1622
  # Set x-goog-api-client and x-goog-user-project headers
2872
1623
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -2875,22 +1626,22 @@ module Google
2875
1626
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2876
1627
 
2877
1628
  header_params = {}
2878
- if request.ios_app_data_stream&.name
2879
- header_params["ios_app_data_stream.name"] = request.ios_app_data_stream.name
1629
+ if request.parent
1630
+ header_params["parent"] = request.parent
2880
1631
  end
2881
1632
 
2882
1633
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2883
1634
  metadata[:"x-goog-request-params"] ||= request_params_header
2884
1635
 
2885
- options.apply_defaults timeout: @config.rpcs.update_ios_app_data_stream.timeout,
1636
+ options.apply_defaults timeout: @config.rpcs.create_user_link.timeout,
2886
1637
  metadata: metadata,
2887
- retry_policy: @config.rpcs.update_ios_app_data_stream.retry_policy
1638
+ retry_policy: @config.rpcs.create_user_link.retry_policy
2888
1639
 
2889
1640
  options.apply_defaults timeout: @config.timeout,
2890
1641
  metadata: @config.metadata,
2891
1642
  retry_policy: @config.retry_policy
2892
1643
 
2893
- @analytics_admin_service_stub.call_rpc :update_ios_app_data_stream, request, options: options do |response, operation|
1644
+ @analytics_admin_service_stub.call_rpc :create_user_link, request, options: options do |response, operation|
2894
1645
  yield response, operation if block_given?
2895
1646
  return response
2896
1647
  end
@@ -2899,45 +1650,44 @@ module Google
2899
1650
  end
2900
1651
 
2901
1652
  ##
2902
- # Returns child iOS app data streams under the specified parent property.
1653
+ # Creates information about multiple users' links to an account or property.
2903
1654
  #
2904
- # iOS app data streams will be excluded if the caller does not have access.
2905
- # Returns an empty list if no relevant iOS app data streams are found.
1655
+ # This method is transactional. If any UserLink cannot be created, none of
1656
+ # the UserLinks will be created.
2906
1657
  #
2907
- # @overload list_ios_app_data_streams(request, options = nil)
2908
- # Pass arguments to `list_ios_app_data_streams` via a request object, either of type
2909
- # {::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest} or an equivalent Hash.
1658
+ # @overload batch_create_user_links(request, options = nil)
1659
+ # Pass arguments to `batch_create_user_links` via a request object, either of type
1660
+ # {::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest} or an equivalent Hash.
2910
1661
  #
2911
- # @param request [::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest, ::Hash]
1662
+ # @param request [::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest, ::Hash]
2912
1663
  # A request object representing the call parameters. Required. To specify no
2913
1664
  # parameters, or to keep all the default parameter values, pass an empty Hash.
2914
1665
  # @param options [::Gapic::CallOptions, ::Hash]
2915
1666
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2916
1667
  #
2917
- # @overload list_ios_app_data_streams(parent: nil, page_size: nil, page_token: nil)
2918
- # Pass arguments to `list_ios_app_data_streams` via keyword arguments. Note that at
1668
+ # @overload batch_create_user_links(parent: nil, notify_new_users: nil, requests: nil)
1669
+ # Pass arguments to `batch_create_user_links` via keyword arguments. Note that at
2919
1670
  # least one keyword argument is required. To specify no parameters, or to keep all
2920
1671
  # the default parameter values, pass an empty Hash as a request object (see above).
2921
1672
  #
2922
1673
  # @param parent [::String]
2923
- # Required. The name of the parent property.
2924
- # For example, to list results of app streams under the property with Id
2925
- # 123: "properties/123"
2926
- # @param page_size [::Integer]
2927
- # The maximum number of resources to return.
2928
- # If unspecified, at most 50 resources will be returned.
2929
- # The maximum value is 200; (higher values will be coerced to the maximum)
2930
- # @param page_token [::String]
2931
- # A page token, received from a previous `ListIosAppDataStreams`
2932
- # call. Provide this to retrieve the subsequent page.
2933
- # When paginating, all other parameters provided to `ListIosAppDataStreams`
2934
- # must match the call that provided the page token.
1674
+ # Required. The account or property that all user links in the request are for.
1675
+ # This field is required. The parent field in the CreateUserLinkRequest
1676
+ # messages must either be empty or match this field.
1677
+ # Example format: accounts/1234
1678
+ # @param notify_new_users [::Boolean]
1679
+ # Optional. If set, then email the new users notifying them that they've been granted
1680
+ # permissions to the resource. Regardless of whether this is set or not,
1681
+ # notify_new_user field inside each individual request is ignored.
1682
+ # @param requests [::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash>]
1683
+ # Required. The requests specifying the user links to create.
1684
+ # A maximum of 1000 user links can be created in a batch.
2935
1685
  #
2936
1686
  # @yield [response, operation] Access the result along with the RPC operation
2937
- # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>]
1687
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse]
2938
1688
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
2939
1689
  #
2940
- # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>]
1690
+ # @return [::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse]
2941
1691
  #
2942
1692
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2943
1693
  #
@@ -2948,30 +1698,24 @@ module Google
2948
1698
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
2949
1699
  #
2950
1700
  # # Create a request. To set request fields, pass in keyword arguments.
2951
- # request = Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest.new
1701
+ # request = Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest.new
2952
1702
  #
2953
- # # Call the list_ios_app_data_streams method.
2954
- # result = client.list_ios_app_data_streams request
1703
+ # # Call the batch_create_user_links method.
1704
+ # result = client.batch_create_user_links request
2955
1705
  #
2956
- # # The returned object is of type Gapic::PagedEnumerable. You can
2957
- # # iterate over all elements by calling #each, and the enumerable
2958
- # # will lazily make API calls to fetch subsequent pages. Other
2959
- # # methods are also available for managing paging directly.
2960
- # result.each do |response|
2961
- # # Each element is of type ::Google::Analytics::Admin::V1alpha::IosAppDataStream.
2962
- # p response
2963
- # end
1706
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse.
1707
+ # p result
2964
1708
  #
2965
- def list_ios_app_data_streams request, options = nil
1709
+ def batch_create_user_links request, options = nil
2966
1710
  raise ::ArgumentError, "request must be provided" if request.nil?
2967
1711
 
2968
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest
1712
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest
2969
1713
 
2970
1714
  # Converts hash and nil to an options object
2971
1715
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2972
1716
 
2973
1717
  # Customize the options with defaults
2974
- metadata = @config.rpcs.list_ios_app_data_streams.metadata.to_h
1718
+ metadata = @config.rpcs.batch_create_user_links.metadata.to_h
2975
1719
 
2976
1720
  # Set x-goog-api-client and x-goog-user-project headers
2977
1721
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -2987,16 +1731,15 @@ module Google
2987
1731
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2988
1732
  metadata[:"x-goog-request-params"] ||= request_params_header
2989
1733
 
2990
- options.apply_defaults timeout: @config.rpcs.list_ios_app_data_streams.timeout,
1734
+ options.apply_defaults timeout: @config.rpcs.batch_create_user_links.timeout,
2991
1735
  metadata: metadata,
2992
- retry_policy: @config.rpcs.list_ios_app_data_streams.retry_policy
1736
+ retry_policy: @config.rpcs.batch_create_user_links.retry_policy
2993
1737
 
2994
1738
  options.apply_defaults timeout: @config.timeout,
2995
1739
  metadata: @config.metadata,
2996
1740
  retry_policy: @config.retry_policy
2997
1741
 
2998
- @analytics_admin_service_stub.call_rpc :list_ios_app_data_streams, request, options: options do |response, operation|
2999
- response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_ios_app_data_streams, request, response, operation, options
1742
+ @analytics_admin_service_stub.call_rpc :batch_create_user_links, request, options: options do |response, operation|
3000
1743
  yield response, operation if block_given?
3001
1744
  return response
3002
1745
  end
@@ -3005,33 +1748,31 @@ module Google
3005
1748
  end
3006
1749
 
3007
1750
  ##
3008
- # Lookup for a single AndroidAppDataStream
1751
+ # Updates a user link on an account or property.
3009
1752
  #
3010
- # @overload get_android_app_data_stream(request, options = nil)
3011
- # Pass arguments to `get_android_app_data_stream` via a request object, either of type
3012
- # {::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest} or an equivalent Hash.
1753
+ # @overload update_user_link(request, options = nil)
1754
+ # Pass arguments to `update_user_link` via a request object, either of type
1755
+ # {::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest} or an equivalent Hash.
3013
1756
  #
3014
- # @param request [::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest, ::Hash]
1757
+ # @param request [::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash]
3015
1758
  # A request object representing the call parameters. Required. To specify no
3016
1759
  # parameters, or to keep all the default parameter values, pass an empty Hash.
3017
1760
  # @param options [::Gapic::CallOptions, ::Hash]
3018
1761
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3019
1762
  #
3020
- # @overload get_android_app_data_stream(name: nil)
3021
- # Pass arguments to `get_android_app_data_stream` via keyword arguments. Note that at
1763
+ # @overload update_user_link(user_link: nil)
1764
+ # Pass arguments to `update_user_link` via keyword arguments. Note that at
3022
1765
  # least one keyword argument is required. To specify no parameters, or to keep all
3023
1766
  # the default parameter values, pass an empty Hash as a request object (see above).
3024
1767
  #
3025
- # @param name [::String]
3026
- # Required. The name of the android app data stream to lookup.
3027
- # Format: properties/\\{property_id}/androidAppDataStreams/\\{stream_id}
3028
- # Example: "properties/123/androidAppDataStreams/456"
1768
+ # @param user_link [::Google::Analytics::Admin::V1alpha::UserLink, ::Hash]
1769
+ # Required. The user link to update.
3029
1770
  #
3030
1771
  # @yield [response, operation] Access the result along with the RPC operation
3031
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
1772
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::UserLink]
3032
1773
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
3033
1774
  #
3034
- # @return [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
1775
+ # @return [::Google::Analytics::Admin::V1alpha::UserLink]
3035
1776
  #
3036
1777
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3037
1778
  #
@@ -3042,24 +1783,24 @@ module Google
3042
1783
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
3043
1784
  #
3044
1785
  # # Create a request. To set request fields, pass in keyword arguments.
3045
- # request = Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest.new
1786
+ # request = Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest.new
3046
1787
  #
3047
- # # Call the get_android_app_data_stream method.
3048
- # result = client.get_android_app_data_stream request
1788
+ # # Call the update_user_link method.
1789
+ # result = client.update_user_link request
3049
1790
  #
3050
- # # The returned object is of type Google::Analytics::Admin::V1alpha::AndroidAppDataStream.
1791
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::UserLink.
3051
1792
  # p result
3052
1793
  #
3053
- def get_android_app_data_stream request, options = nil
1794
+ def update_user_link request, options = nil
3054
1795
  raise ::ArgumentError, "request must be provided" if request.nil?
3055
1796
 
3056
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest
1797
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest
3057
1798
 
3058
1799
  # Converts hash and nil to an options object
3059
1800
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3060
1801
 
3061
1802
  # Customize the options with defaults
3062
- metadata = @config.rpcs.get_android_app_data_stream.metadata.to_h
1803
+ metadata = @config.rpcs.update_user_link.metadata.to_h
3063
1804
 
3064
1805
  # Set x-goog-api-client and x-goog-user-project headers
3065
1806
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -3068,22 +1809,22 @@ module Google
3068
1809
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3069
1810
 
3070
1811
  header_params = {}
3071
- if request.name
3072
- header_params["name"] = request.name
1812
+ if request.user_link&.name
1813
+ header_params["user_link.name"] = request.user_link.name
3073
1814
  end
3074
1815
 
3075
1816
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3076
1817
  metadata[:"x-goog-request-params"] ||= request_params_header
3077
1818
 
3078
- options.apply_defaults timeout: @config.rpcs.get_android_app_data_stream.timeout,
1819
+ options.apply_defaults timeout: @config.rpcs.update_user_link.timeout,
3079
1820
  metadata: metadata,
3080
- retry_policy: @config.rpcs.get_android_app_data_stream.retry_policy
1821
+ retry_policy: @config.rpcs.update_user_link.retry_policy
3081
1822
 
3082
1823
  options.apply_defaults timeout: @config.timeout,
3083
1824
  metadata: @config.metadata,
3084
1825
  retry_policy: @config.retry_policy
3085
1826
 
3086
- @analytics_admin_service_stub.call_rpc :get_android_app_data_stream, request, options: options do |response, operation|
1827
+ @analytics_admin_service_stub.call_rpc :update_user_link, request, options: options do |response, operation|
3087
1828
  yield response, operation if block_given?
3088
1829
  return response
3089
1830
  end
@@ -3092,33 +1833,37 @@ module Google
3092
1833
  end
3093
1834
 
3094
1835
  ##
3095
- # Deletes an android app stream on a property.
1836
+ # Updates information about multiple users' links to an account or property.
3096
1837
  #
3097
- # @overload delete_android_app_data_stream(request, options = nil)
3098
- # Pass arguments to `delete_android_app_data_stream` via a request object, either of type
3099
- # {::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest} or an equivalent Hash.
1838
+ # @overload batch_update_user_links(request, options = nil)
1839
+ # Pass arguments to `batch_update_user_links` via a request object, either of type
1840
+ # {::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest} or an equivalent Hash.
3100
1841
  #
3101
- # @param request [::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest, ::Hash]
1842
+ # @param request [::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest, ::Hash]
3102
1843
  # A request object representing the call parameters. Required. To specify no
3103
1844
  # parameters, or to keep all the default parameter values, pass an empty Hash.
3104
1845
  # @param options [::Gapic::CallOptions, ::Hash]
3105
1846
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3106
1847
  #
3107
- # @overload delete_android_app_data_stream(name: nil)
3108
- # Pass arguments to `delete_android_app_data_stream` via keyword arguments. Note that at
1848
+ # @overload batch_update_user_links(parent: nil, requests: nil)
1849
+ # Pass arguments to `batch_update_user_links` via keyword arguments. Note that at
3109
1850
  # least one keyword argument is required. To specify no parameters, or to keep all
3110
1851
  # the default parameter values, pass an empty Hash as a request object (see above).
3111
1852
  #
3112
- # @param name [::String]
3113
- # Required. The name of the android app data stream to delete.
3114
- # Format: properties/\\{property_id}/androidAppDataStreams/\\{stream_id}
3115
- # Example: "properties/123/androidAppDataStreams/456"
1853
+ # @param parent [::String]
1854
+ # Required. The account or property that all user links in the request are
1855
+ # for. The parent field in the UpdateUserLinkRequest messages must either be
1856
+ # empty or match this field.
1857
+ # Example format: accounts/1234
1858
+ # @param requests [::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash>]
1859
+ # Required. The requests specifying the user links to update.
1860
+ # A maximum of 1000 user links can be updated in a batch.
3116
1861
  #
3117
1862
  # @yield [response, operation] Access the result along with the RPC operation
3118
- # @yieldparam response [::Google::Protobuf::Empty]
1863
+ # @yieldparam response [::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse]
3119
1864
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
3120
1865
  #
3121
- # @return [::Google::Protobuf::Empty]
1866
+ # @return [::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse]
3122
1867
  #
3123
1868
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3124
1869
  #
@@ -3129,24 +1874,24 @@ module Google
3129
1874
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
3130
1875
  #
3131
1876
  # # Create a request. To set request fields, pass in keyword arguments.
3132
- # request = Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest.new
1877
+ # request = Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest.new
3133
1878
  #
3134
- # # Call the delete_android_app_data_stream method.
3135
- # result = client.delete_android_app_data_stream request
1879
+ # # Call the batch_update_user_links method.
1880
+ # result = client.batch_update_user_links request
3136
1881
  #
3137
- # # The returned object is of type Google::Protobuf::Empty.
1882
+ # # The returned object is of type Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse.
3138
1883
  # p result
3139
1884
  #
3140
- def delete_android_app_data_stream request, options = nil
1885
+ def batch_update_user_links request, options = nil
3141
1886
  raise ::ArgumentError, "request must be provided" if request.nil?
3142
1887
 
3143
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest
1888
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest
3144
1889
 
3145
1890
  # Converts hash and nil to an options object
3146
1891
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3147
1892
 
3148
1893
  # Customize the options with defaults
3149
- metadata = @config.rpcs.delete_android_app_data_stream.metadata.to_h
1894
+ metadata = @config.rpcs.batch_update_user_links.metadata.to_h
3150
1895
 
3151
1896
  # Set x-goog-api-client and x-goog-user-project headers
3152
1897
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -3155,22 +1900,22 @@ module Google
3155
1900
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3156
1901
 
3157
1902
  header_params = {}
3158
- if request.name
3159
- header_params["name"] = request.name
1903
+ if request.parent
1904
+ header_params["parent"] = request.parent
3160
1905
  end
3161
1906
 
3162
1907
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3163
1908
  metadata[:"x-goog-request-params"] ||= request_params_header
3164
1909
 
3165
- options.apply_defaults timeout: @config.rpcs.delete_android_app_data_stream.timeout,
1910
+ options.apply_defaults timeout: @config.rpcs.batch_update_user_links.timeout,
3166
1911
  metadata: metadata,
3167
- retry_policy: @config.rpcs.delete_android_app_data_stream.retry_policy
1912
+ retry_policy: @config.rpcs.batch_update_user_links.retry_policy
3168
1913
 
3169
1914
  options.apply_defaults timeout: @config.timeout,
3170
1915
  metadata: @config.metadata,
3171
1916
  retry_policy: @config.retry_policy
3172
1917
 
3173
- @analytics_admin_service_stub.call_rpc :delete_android_app_data_stream, request, options: options do |response, operation|
1918
+ @analytics_admin_service_stub.call_rpc :batch_update_user_links, request, options: options do |response, operation|
3174
1919
  yield response, operation if block_given?
3175
1920
  return response
3176
1921
  end
@@ -3179,36 +1924,31 @@ module Google
3179
1924
  end
3180
1925
 
3181
1926
  ##
3182
- # Updates an android app stream on a property.
1927
+ # Deletes a user link on an account or property.
3183
1928
  #
3184
- # @overload update_android_app_data_stream(request, options = nil)
3185
- # Pass arguments to `update_android_app_data_stream` via a request object, either of type
3186
- # {::Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest} or an equivalent Hash.
1929
+ # @overload delete_user_link(request, options = nil)
1930
+ # Pass arguments to `delete_user_link` via a request object, either of type
1931
+ # {::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest} or an equivalent Hash.
3187
1932
  #
3188
- # @param request [::Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest, ::Hash]
1933
+ # @param request [::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash]
3189
1934
  # A request object representing the call parameters. Required. To specify no
3190
1935
  # parameters, or to keep all the default parameter values, pass an empty Hash.
3191
1936
  # @param options [::Gapic::CallOptions, ::Hash]
3192
1937
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3193
1938
  #
3194
- # @overload update_android_app_data_stream(android_app_data_stream: nil, update_mask: nil)
3195
- # Pass arguments to `update_android_app_data_stream` via keyword arguments. Note that at
1939
+ # @overload delete_user_link(name: nil)
1940
+ # Pass arguments to `delete_user_link` via keyword arguments. Note that at
3196
1941
  # least one keyword argument is required. To specify no parameters, or to keep all
3197
1942
  # the default parameter values, pass an empty Hash as a request object (see above).
3198
1943
  #
3199
- # @param android_app_data_stream [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream, ::Hash]
3200
- # Required. The android app stream to update.
3201
- # The `name` field is used to identify the android app stream to be updated.
3202
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
3203
- # Required. The list of fields to be updated. Field names must be in snake case
3204
- # (e.g., "field_to_update"). Omitted fields will not be updated. To replace
3205
- # the entire entity, use one path with the string "*" to match all fields.
1944
+ # @param name [::String]
1945
+ # Required. Example format: accounts/1234/userLinks/5678
3206
1946
  #
3207
1947
  # @yield [response, operation] Access the result along with the RPC operation
3208
- # @yieldparam response [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
1948
+ # @yieldparam response [::Google::Protobuf::Empty]
3209
1949
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
3210
1950
  #
3211
- # @return [::Google::Analytics::Admin::V1alpha::AndroidAppDataStream]
1951
+ # @return [::Google::Protobuf::Empty]
3212
1952
  #
3213
1953
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3214
1954
  #
@@ -3219,24 +1959,24 @@ module Google
3219
1959
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
3220
1960
  #
3221
1961
  # # Create a request. To set request fields, pass in keyword arguments.
3222
- # request = Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest.new
1962
+ # request = Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest.new
3223
1963
  #
3224
- # # Call the update_android_app_data_stream method.
3225
- # result = client.update_android_app_data_stream request
1964
+ # # Call the delete_user_link method.
1965
+ # result = client.delete_user_link request
3226
1966
  #
3227
- # # The returned object is of type Google::Analytics::Admin::V1alpha::AndroidAppDataStream.
1967
+ # # The returned object is of type Google::Protobuf::Empty.
3228
1968
  # p result
3229
1969
  #
3230
- def update_android_app_data_stream request, options = nil
1970
+ def delete_user_link request, options = nil
3231
1971
  raise ::ArgumentError, "request must be provided" if request.nil?
3232
1972
 
3233
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest
1973
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest
3234
1974
 
3235
1975
  # Converts hash and nil to an options object
3236
1976
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3237
1977
 
3238
1978
  # Customize the options with defaults
3239
- metadata = @config.rpcs.update_android_app_data_stream.metadata.to_h
1979
+ metadata = @config.rpcs.delete_user_link.metadata.to_h
3240
1980
 
3241
1981
  # Set x-goog-api-client and x-goog-user-project headers
3242
1982
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -3245,22 +1985,22 @@ module Google
3245
1985
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3246
1986
 
3247
1987
  header_params = {}
3248
- if request.android_app_data_stream&.name
3249
- header_params["android_app_data_stream.name"] = request.android_app_data_stream.name
1988
+ if request.name
1989
+ header_params["name"] = request.name
3250
1990
  end
3251
1991
 
3252
1992
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3253
1993
  metadata[:"x-goog-request-params"] ||= request_params_header
3254
1994
 
3255
- options.apply_defaults timeout: @config.rpcs.update_android_app_data_stream.timeout,
1995
+ options.apply_defaults timeout: @config.rpcs.delete_user_link.timeout,
3256
1996
  metadata: metadata,
3257
- retry_policy: @config.rpcs.update_android_app_data_stream.retry_policy
1997
+ retry_policy: @config.rpcs.delete_user_link.retry_policy
3258
1998
 
3259
1999
  options.apply_defaults timeout: @config.timeout,
3260
2000
  metadata: @config.metadata,
3261
2001
  retry_policy: @config.retry_policy
3262
2002
 
3263
- @analytics_admin_service_stub.call_rpc :update_android_app_data_stream, request, options: options do |response, operation|
2003
+ @analytics_admin_service_stub.call_rpc :delete_user_link, request, options: options do |response, operation|
3264
2004
  yield response, operation if block_given?
3265
2005
  return response
3266
2006
  end
@@ -3269,47 +2009,37 @@ module Google
3269
2009
  end
3270
2010
 
3271
2011
  ##
3272
- # Returns child android app streams under the specified parent property.
3273
- #
3274
- # Android app streams will be excluded if the caller does not have access.
3275
- # Returns an empty list if no relevant android app streams are found.
2012
+ # Deletes information about multiple users' links to an account or property.
3276
2013
  #
3277
- # @overload list_android_app_data_streams(request, options = nil)
3278
- # Pass arguments to `list_android_app_data_streams` via a request object, either of type
3279
- # {::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest} or an equivalent Hash.
2014
+ # @overload batch_delete_user_links(request, options = nil)
2015
+ # Pass arguments to `batch_delete_user_links` via a request object, either of type
2016
+ # {::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest} or an equivalent Hash.
3280
2017
  #
3281
- # @param request [::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest, ::Hash]
2018
+ # @param request [::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest, ::Hash]
3282
2019
  # A request object representing the call parameters. Required. To specify no
3283
2020
  # parameters, or to keep all the default parameter values, pass an empty Hash.
3284
2021
  # @param options [::Gapic::CallOptions, ::Hash]
3285
2022
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3286
2023
  #
3287
- # @overload list_android_app_data_streams(parent: nil, page_size: nil, page_token: nil)
3288
- # Pass arguments to `list_android_app_data_streams` via keyword arguments. Note that at
2024
+ # @overload batch_delete_user_links(parent: nil, requests: nil)
2025
+ # Pass arguments to `batch_delete_user_links` via keyword arguments. Note that at
3289
2026
  # least one keyword argument is required. To specify no parameters, or to keep all
3290
2027
  # the default parameter values, pass an empty Hash as a request object (see above).
3291
2028
  #
3292
2029
  # @param parent [::String]
3293
- # Required. The name of the parent property.
3294
- # For example, to limit results to app streams under the property with Id
3295
- # 123: "properties/123"
3296
- # @param page_size [::Integer]
3297
- # The maximum number of resources to return.
3298
- #
3299
- # If unspecified, at most 50 resources will be returned.
3300
- # The maximum value is 200; (higher values will be coerced to the maximum)
3301
- # @param page_token [::String]
3302
- # A page token, received from a previous call. Provide this to
3303
- # retrieve the subsequent page.
3304
- # When paginating, all other parameters provided to
3305
- # `ListAndroidAppDataStreams` must match the call that provided the page
3306
- # token.
2030
+ # Required. The account or property that all user links in the request are
2031
+ # for. The parent of all values for user link names to delete must match this
2032
+ # field.
2033
+ # Example format: accounts/1234
2034
+ # @param requests [::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash>]
2035
+ # Required. The requests specifying the user links to update.
2036
+ # A maximum of 1000 user links can be updated in a batch.
3307
2037
  #
3308
2038
  # @yield [response, operation] Access the result along with the RPC operation
3309
- # @yieldparam response [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>]
2039
+ # @yieldparam response [::Google::Protobuf::Empty]
3310
2040
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
3311
2041
  #
3312
- # @return [::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>]
2042
+ # @return [::Google::Protobuf::Empty]
3313
2043
  #
3314
2044
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
3315
2045
  #
@@ -3320,30 +2050,24 @@ module Google
3320
2050
  # client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new
3321
2051
  #
3322
2052
  # # Create a request. To set request fields, pass in keyword arguments.
3323
- # request = Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest.new
2053
+ # request = Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest.new
3324
2054
  #
3325
- # # Call the list_android_app_data_streams method.
3326
- # result = client.list_android_app_data_streams request
2055
+ # # Call the batch_delete_user_links method.
2056
+ # result = client.batch_delete_user_links request
3327
2057
  #
3328
- # # The returned object is of type Gapic::PagedEnumerable. You can
3329
- # # iterate over all elements by calling #each, and the enumerable
3330
- # # will lazily make API calls to fetch subsequent pages. Other
3331
- # # methods are also available for managing paging directly.
3332
- # result.each do |response|
3333
- # # Each element is of type ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream.
3334
- # p response
3335
- # end
2058
+ # # The returned object is of type Google::Protobuf::Empty.
2059
+ # p result
3336
2060
  #
3337
- def list_android_app_data_streams request, options = nil
2061
+ def batch_delete_user_links request, options = nil
3338
2062
  raise ::ArgumentError, "request must be provided" if request.nil?
3339
2063
 
3340
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest
2064
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest
3341
2065
 
3342
2066
  # Converts hash and nil to an options object
3343
2067
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3344
2068
 
3345
2069
  # Customize the options with defaults
3346
- metadata = @config.rpcs.list_android_app_data_streams.metadata.to_h
2070
+ metadata = @config.rpcs.batch_delete_user_links.metadata.to_h
3347
2071
 
3348
2072
  # Set x-goog-api-client and x-goog-user-project headers
3349
2073
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -3359,16 +2083,15 @@ module Google
3359
2083
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3360
2084
  metadata[:"x-goog-request-params"] ||= request_params_header
3361
2085
 
3362
- options.apply_defaults timeout: @config.rpcs.list_android_app_data_streams.timeout,
2086
+ options.apply_defaults timeout: @config.rpcs.batch_delete_user_links.timeout,
3363
2087
  metadata: metadata,
3364
- retry_policy: @config.rpcs.list_android_app_data_streams.retry_policy
2088
+ retry_policy: @config.rpcs.batch_delete_user_links.retry_policy
3365
2089
 
3366
2090
  options.apply_defaults timeout: @config.timeout,
3367
2091
  metadata: @config.metadata,
3368
2092
  retry_policy: @config.retry_policy
3369
2093
 
3370
- @analytics_admin_service_stub.call_rpc :list_android_app_data_streams, request, options: options do |response, operation|
3371
- response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_android_app_data_streams, request, response, operation, options
2094
+ @analytics_admin_service_stub.call_rpc :batch_delete_user_links, request, options: options do |response, operation|
3372
2095
  yield response, operation if block_given?
3373
2096
  return response
3374
2097
  end
@@ -3678,8 +2401,8 @@ module Google
3678
2401
  # @param name [::String]
3679
2402
  # Required. The name of the site tag to lookup.
3680
2403
  # Note that site tags are singletons and do not have unique IDs.
3681
- # Format: properties/\\{property_id}/webDataStreams/\\{stream_id}/globalSiteTag
3682
- # Example: "properties/123/webDataStreams/456/globalSiteTag"
2404
+ # Format: properties/\\{property_id}/dataStreams/\\{stream_id}/globalSiteTag
2405
+ # Example: "properties/123/dataStreams/456/globalSiteTag"
3683
2406
  #
3684
2407
  # @yield [response, operation] Access the result along with the RPC operation
3685
2408
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::GlobalSiteTag]
@@ -4217,9 +2940,7 @@ module Google
4217
2940
  # @param name [::String]
4218
2941
  # Required. The name of the measurement protocol secret to lookup.
4219
2942
  # Format:
4220
- # properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
4221
- # Note: Any type of stream (WebDataStream, IosAppDataStream,
4222
- # AndroidAppDataStream) may be a parent.
2943
+ # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
4223
2944
  #
4224
2945
  # @yield [response, operation] Access the result along with the RPC operation
4225
2946
  # @yieldparam response [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret]
@@ -4306,10 +3027,8 @@ module Google
4306
3027
  #
4307
3028
  # @param parent [::String]
4308
3029
  # Required. The resource name of the parent stream.
4309
- # Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
4310
- # may be a parent.
4311
3030
  # Format:
4312
- # properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets
3031
+ # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets
4313
3032
  # @param page_size [::Integer]
4314
3033
  # The maximum number of resources to return.
4315
3034
  # If unspecified, at most 10 resources will be returned.
@@ -4411,9 +3130,7 @@ module Google
4411
3130
  #
4412
3131
  # @param parent [::String]
4413
3132
  # Required. The parent resource where this secret will be created.
4414
- # Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream)
4415
- # may be a parent.
4416
- # Format: properties/\\{property}/webDataStreams/\\{webDataStream}
3133
+ # Format: properties/\\{property}/dataStreams/\\{dataStream}
4417
3134
  # @param measurement_protocol_secret [::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash]
4418
3135
  # Required. The measurement protocol secret to create.
4419
3136
  #
@@ -4502,9 +3219,7 @@ module Google
4502
3219
  # @param name [::String]
4503
3220
  # Required. The name of the MeasurementProtocolSecret to delete.
4504
3221
  # Format:
4505
- # properties/\\{property}/webDataStreams/\\{webDataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
4506
- # Note: Any type of stream (WebDataStream, IosAppDataStream,
4507
- # AndroidAppDataStream) may be a parent.
3222
+ # properties/\\{property}/dataStreams/\\{dataStream}/measurementProtocolSecrets/\\{measurementProtocolSecret}
4508
3223
  #
4509
3224
  # @yield [response, operation] Access the result along with the RPC operation
4510
3225
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -8180,71 +6895,6 @@ module Google
8180
6895
  #
8181
6896
  attr_reader :batch_delete_user_links
8182
6897
  ##
8183
- # RPC-specific configuration for `get_web_data_stream`
8184
- # @return [::Gapic::Config::Method]
8185
- #
8186
- attr_reader :get_web_data_stream
8187
- ##
8188
- # RPC-specific configuration for `delete_web_data_stream`
8189
- # @return [::Gapic::Config::Method]
8190
- #
8191
- attr_reader :delete_web_data_stream
8192
- ##
8193
- # RPC-specific configuration for `update_web_data_stream`
8194
- # @return [::Gapic::Config::Method]
8195
- #
8196
- attr_reader :update_web_data_stream
8197
- ##
8198
- # RPC-specific configuration for `create_web_data_stream`
8199
- # @return [::Gapic::Config::Method]
8200
- #
8201
- attr_reader :create_web_data_stream
8202
- ##
8203
- # RPC-specific configuration for `list_web_data_streams`
8204
- # @return [::Gapic::Config::Method]
8205
- #
8206
- attr_reader :list_web_data_streams
8207
- ##
8208
- # RPC-specific configuration for `get_ios_app_data_stream`
8209
- # @return [::Gapic::Config::Method]
8210
- #
8211
- attr_reader :get_ios_app_data_stream
8212
- ##
8213
- # RPC-specific configuration for `delete_ios_app_data_stream`
8214
- # @return [::Gapic::Config::Method]
8215
- #
8216
- attr_reader :delete_ios_app_data_stream
8217
- ##
8218
- # RPC-specific configuration for `update_ios_app_data_stream`
8219
- # @return [::Gapic::Config::Method]
8220
- #
8221
- attr_reader :update_ios_app_data_stream
8222
- ##
8223
- # RPC-specific configuration for `list_ios_app_data_streams`
8224
- # @return [::Gapic::Config::Method]
8225
- #
8226
- attr_reader :list_ios_app_data_streams
8227
- ##
8228
- # RPC-specific configuration for `get_android_app_data_stream`
8229
- # @return [::Gapic::Config::Method]
8230
- #
8231
- attr_reader :get_android_app_data_stream
8232
- ##
8233
- # RPC-specific configuration for `delete_android_app_data_stream`
8234
- # @return [::Gapic::Config::Method]
8235
- #
8236
- attr_reader :delete_android_app_data_stream
8237
- ##
8238
- # RPC-specific configuration for `update_android_app_data_stream`
8239
- # @return [::Gapic::Config::Method]
8240
- #
8241
- attr_reader :update_android_app_data_stream
8242
- ##
8243
- # RPC-specific configuration for `list_android_app_data_streams`
8244
- # @return [::Gapic::Config::Method]
8245
- #
8246
- attr_reader :list_android_app_data_streams
8247
- ##
8248
6898
  # RPC-specific configuration for `create_firebase_link`
8249
6899
  # @return [::Gapic::Config::Method]
8250
6900
  #
@@ -8539,32 +7189,6 @@ module Google
8539
7189
  @delete_user_link = ::Gapic::Config::Method.new delete_user_link_config
8540
7190
  batch_delete_user_links_config = parent_rpcs.batch_delete_user_links if parent_rpcs.respond_to? :batch_delete_user_links
8541
7191
  @batch_delete_user_links = ::Gapic::Config::Method.new batch_delete_user_links_config
8542
- get_web_data_stream_config = parent_rpcs.get_web_data_stream if parent_rpcs.respond_to? :get_web_data_stream
8543
- @get_web_data_stream = ::Gapic::Config::Method.new get_web_data_stream_config
8544
- delete_web_data_stream_config = parent_rpcs.delete_web_data_stream if parent_rpcs.respond_to? :delete_web_data_stream
8545
- @delete_web_data_stream = ::Gapic::Config::Method.new delete_web_data_stream_config
8546
- update_web_data_stream_config = parent_rpcs.update_web_data_stream if parent_rpcs.respond_to? :update_web_data_stream
8547
- @update_web_data_stream = ::Gapic::Config::Method.new update_web_data_stream_config
8548
- create_web_data_stream_config = parent_rpcs.create_web_data_stream if parent_rpcs.respond_to? :create_web_data_stream
8549
- @create_web_data_stream = ::Gapic::Config::Method.new create_web_data_stream_config
8550
- list_web_data_streams_config = parent_rpcs.list_web_data_streams if parent_rpcs.respond_to? :list_web_data_streams
8551
- @list_web_data_streams = ::Gapic::Config::Method.new list_web_data_streams_config
8552
- get_ios_app_data_stream_config = parent_rpcs.get_ios_app_data_stream if parent_rpcs.respond_to? :get_ios_app_data_stream
8553
- @get_ios_app_data_stream = ::Gapic::Config::Method.new get_ios_app_data_stream_config
8554
- delete_ios_app_data_stream_config = parent_rpcs.delete_ios_app_data_stream if parent_rpcs.respond_to? :delete_ios_app_data_stream
8555
- @delete_ios_app_data_stream = ::Gapic::Config::Method.new delete_ios_app_data_stream_config
8556
- update_ios_app_data_stream_config = parent_rpcs.update_ios_app_data_stream if parent_rpcs.respond_to? :update_ios_app_data_stream
8557
- @update_ios_app_data_stream = ::Gapic::Config::Method.new update_ios_app_data_stream_config
8558
- list_ios_app_data_streams_config = parent_rpcs.list_ios_app_data_streams if parent_rpcs.respond_to? :list_ios_app_data_streams
8559
- @list_ios_app_data_streams = ::Gapic::Config::Method.new list_ios_app_data_streams_config
8560
- get_android_app_data_stream_config = parent_rpcs.get_android_app_data_stream if parent_rpcs.respond_to? :get_android_app_data_stream
8561
- @get_android_app_data_stream = ::Gapic::Config::Method.new get_android_app_data_stream_config
8562
- delete_android_app_data_stream_config = parent_rpcs.delete_android_app_data_stream if parent_rpcs.respond_to? :delete_android_app_data_stream
8563
- @delete_android_app_data_stream = ::Gapic::Config::Method.new delete_android_app_data_stream_config
8564
- update_android_app_data_stream_config = parent_rpcs.update_android_app_data_stream if parent_rpcs.respond_to? :update_android_app_data_stream
8565
- @update_android_app_data_stream = ::Gapic::Config::Method.new update_android_app_data_stream_config
8566
- list_android_app_data_streams_config = parent_rpcs.list_android_app_data_streams if parent_rpcs.respond_to? :list_android_app_data_streams
8567
- @list_android_app_data_streams = ::Gapic::Config::Method.new list_android_app_data_streams_config
8568
7192
  create_firebase_link_config = parent_rpcs.create_firebase_link if parent_rpcs.respond_to? :create_firebase_link
8569
7193
  @create_firebase_link = ::Gapic::Config::Method.new create_firebase_link_config
8570
7194
  delete_firebase_link_config = parent_rpcs.delete_firebase_link if parent_rpcs.respond_to? :delete_firebase_link