google-apis-analyticsdata_v1beta 0.30.0 → 0.32.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/analyticsdata_v1beta/classes.rb +397 -2
- data/lib/google/apis/analyticsdata_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/analyticsdata_v1beta/representations.rb +158 -0
- data/lib/google/apis/analyticsdata_v1beta/service.rb +189 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4a973a5d0cebc05b0c7ea297daa6479dd5d7218c4865e538475c665bf4fe9aae
|
4
|
+
data.tar.gz: a7df927367a62236b8062d8f782771378c1e4dae79fb53ba6394d53a67559a89
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bb8fea9eb10a5f40600a145de68641a74be022d72ac02bc6aa134502a6fc7a974fcc49611796fbb4073d4535cf2c4ac2d4671cea088bab856cab30cb2f5f66fa
|
7
|
+
data.tar.gz: 6377e9a1d86045a3c110d1328ab133a04f945b9a9e2997bad9d8fd7d079687ee7491b51e877e36d51f6dd5e89b68c47ccd850f693d972b33e40476eac51ff685
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-analyticsdata_v1beta
|
2
2
|
|
3
|
+
### v0.32.0 (2023-12-10)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20231203
|
6
|
+
|
7
|
+
### v0.31.0 (2023-11-12)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20231105
|
10
|
+
|
3
11
|
### v0.30.0 (2023-09-24)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20230917
|
@@ -47,6 +47,92 @@ module Google
|
|
47
47
|
end
|
48
48
|
end
|
49
49
|
|
50
|
+
# An audience export is a list of users in an audience at the time of the list's
|
51
|
+
# creation. One audience may have multiple audience exports created for
|
52
|
+
# different days.
|
53
|
+
class AudienceExport
|
54
|
+
include Google::Apis::Core::Hashable
|
55
|
+
|
56
|
+
# Required. The audience resource name. This resource name identifies the
|
57
|
+
# audience being listed and is shared between the Analytics Data & Admin APIs.
|
58
|
+
# Format: `properties/`property`/audiences/`audience``
|
59
|
+
# Corresponds to the JSON property `audience`
|
60
|
+
# @return [String]
|
61
|
+
attr_accessor :audience
|
62
|
+
|
63
|
+
# Output only. The descriptive display name for this audience. For example, "
|
64
|
+
# Purchasers".
|
65
|
+
# Corresponds to the JSON property `audienceDisplayName`
|
66
|
+
# @return [String]
|
67
|
+
attr_accessor :audience_display_name
|
68
|
+
|
69
|
+
# Output only. The time when CreateAudienceExport was called and the
|
70
|
+
# AudienceExport began the `CREATING` state.
|
71
|
+
# Corresponds to the JSON property `beginCreatingTime`
|
72
|
+
# @return [String]
|
73
|
+
attr_accessor :begin_creating_time
|
74
|
+
|
75
|
+
# Output only. The total quota tokens charged during creation of the
|
76
|
+
# AudienceExport. Because this token count is based on activity from the `
|
77
|
+
# CREATING` state, this tokens charged will be fixed once an AudienceExport
|
78
|
+
# enters the `ACTIVE` or `FAILED` states.
|
79
|
+
# Corresponds to the JSON property `creationQuotaTokensCharged`
|
80
|
+
# @return [Fixnum]
|
81
|
+
attr_accessor :creation_quota_tokens_charged
|
82
|
+
|
83
|
+
# Required. The dimensions requested and displayed in the query response.
|
84
|
+
# Corresponds to the JSON property `dimensions`
|
85
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::V1betaAudienceDimension>]
|
86
|
+
attr_accessor :dimensions
|
87
|
+
|
88
|
+
# Output only. Error message is populated when an audience export fails during
|
89
|
+
# creation. A common reason for such a failure is quota exhaustion.
|
90
|
+
# Corresponds to the JSON property `errorMessage`
|
91
|
+
# @return [String]
|
92
|
+
attr_accessor :error_message
|
93
|
+
|
94
|
+
# Output only. Identifier. The audience export resource name assigned during
|
95
|
+
# creation. This resource name identifies this `AudienceExport`. Format: `
|
96
|
+
# properties/`property`/audienceExports/`audience_export``
|
97
|
+
# Corresponds to the JSON property `name`
|
98
|
+
# @return [String]
|
99
|
+
attr_accessor :name
|
100
|
+
|
101
|
+
# Output only. The percentage completed for this audience export ranging between
|
102
|
+
# 0 to 100.
|
103
|
+
# Corresponds to the JSON property `percentageCompleted`
|
104
|
+
# @return [Float]
|
105
|
+
attr_accessor :percentage_completed
|
106
|
+
|
107
|
+
# Output only. The total number of rows in the AudienceExport result.
|
108
|
+
# Corresponds to the JSON property `rowCount`
|
109
|
+
# @return [Fixnum]
|
110
|
+
attr_accessor :row_count
|
111
|
+
|
112
|
+
# Output only. The current state for this AudienceExport.
|
113
|
+
# Corresponds to the JSON property `state`
|
114
|
+
# @return [String]
|
115
|
+
attr_accessor :state
|
116
|
+
|
117
|
+
def initialize(**args)
|
118
|
+
update!(**args)
|
119
|
+
end
|
120
|
+
|
121
|
+
# Update properties of this object
|
122
|
+
def update!(**args)
|
123
|
+
@audience = args[:audience] if args.key?(:audience)
|
124
|
+
@audience_display_name = args[:audience_display_name] if args.key?(:audience_display_name)
|
125
|
+
@begin_creating_time = args[:begin_creating_time] if args.key?(:begin_creating_time)
|
126
|
+
@creation_quota_tokens_charged = args[:creation_quota_tokens_charged] if args.key?(:creation_quota_tokens_charged)
|
127
|
+
@dimensions = args[:dimensions] if args.key?(:dimensions)
|
128
|
+
@error_message = args[:error_message] if args.key?(:error_message)
|
129
|
+
@name = args[:name] if args.key?(:name)
|
130
|
+
@percentage_completed = args[:percentage_completed] if args.key?(:percentage_completed)
|
131
|
+
@row_count = args[:row_count] if args.key?(:row_count)
|
132
|
+
@state = args[:state] if args.key?(:state)
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
50
136
|
# This metadata is currently blank.
|
51
137
|
class AudienceListMetadata
|
52
138
|
include Google::Apis::Core::Hashable
|
@@ -854,6 +940,32 @@ module Google
|
|
854
940
|
end
|
855
941
|
end
|
856
942
|
|
943
|
+
# A list of all audience exports for a property.
|
944
|
+
class ListAudienceExportsResponse
|
945
|
+
include Google::Apis::Core::Hashable
|
946
|
+
|
947
|
+
# Each audience export for a property.
|
948
|
+
# Corresponds to the JSON property `audienceExports`
|
949
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::AudienceExport>]
|
950
|
+
attr_accessor :audience_exports
|
951
|
+
|
952
|
+
# A token, which can be sent as `page_token` to retrieve the next page. If this
|
953
|
+
# field is omitted, there are no subsequent pages.
|
954
|
+
# Corresponds to the JSON property `nextPageToken`
|
955
|
+
# @return [String]
|
956
|
+
attr_accessor :next_page_token
|
957
|
+
|
958
|
+
def initialize(**args)
|
959
|
+
update!(**args)
|
960
|
+
end
|
961
|
+
|
962
|
+
# Update properties of this object
|
963
|
+
def update!(**args)
|
964
|
+
@audience_exports = args[:audience_exports] if args.key?(:audience_exports)
|
965
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
966
|
+
end
|
967
|
+
end
|
968
|
+
|
857
969
|
# The dimensions, metrics and comparisons currently accepted in reporting
|
858
970
|
# methods.
|
859
971
|
class Metadata
|
@@ -1205,6 +1317,68 @@ module Google
|
|
1205
1317
|
end
|
1206
1318
|
end
|
1207
1319
|
|
1320
|
+
# This resource represents a long-running operation that is the result of a
|
1321
|
+
# network API call.
|
1322
|
+
class Operation
|
1323
|
+
include Google::Apis::Core::Hashable
|
1324
|
+
|
1325
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
1326
|
+
# , the operation is completed, and either `error` or `response` is available.
|
1327
|
+
# Corresponds to the JSON property `done`
|
1328
|
+
# @return [Boolean]
|
1329
|
+
attr_accessor :done
|
1330
|
+
alias_method :done?, :done
|
1331
|
+
|
1332
|
+
# The `Status` type defines a logical error model that is suitable for different
|
1333
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
1334
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
1335
|
+
# data: error code, error message, and error details. You can find out more
|
1336
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
1337
|
+
# //cloud.google.com/apis/design/errors).
|
1338
|
+
# Corresponds to the JSON property `error`
|
1339
|
+
# @return [Google::Apis::AnalyticsdataV1beta::Status]
|
1340
|
+
attr_accessor :error
|
1341
|
+
|
1342
|
+
# Service-specific metadata associated with the operation. It typically contains
|
1343
|
+
# progress information and common metadata such as create time. Some services
|
1344
|
+
# might not provide such metadata. Any method that returns a long-running
|
1345
|
+
# operation should document the metadata type, if any.
|
1346
|
+
# Corresponds to the JSON property `metadata`
|
1347
|
+
# @return [Hash<String,Object>]
|
1348
|
+
attr_accessor :metadata
|
1349
|
+
|
1350
|
+
# The server-assigned name, which is only unique within the same service that
|
1351
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
1352
|
+
# be a resource name ending with `operations/`unique_id``.
|
1353
|
+
# Corresponds to the JSON property `name`
|
1354
|
+
# @return [String]
|
1355
|
+
attr_accessor :name
|
1356
|
+
|
1357
|
+
# The normal, successful response of the operation. If the original method
|
1358
|
+
# returns no data on success, such as `Delete`, the response is `google.protobuf.
|
1359
|
+
# Empty`. If the original method is standard `Get`/`Create`/`Update`, the
|
1360
|
+
# response should be the resource. For other methods, the response should have
|
1361
|
+
# the type `XxxResponse`, where `Xxx` is the original method name. For example,
|
1362
|
+
# if the original method name is `TakeSnapshot()`, the inferred response type is
|
1363
|
+
# `TakeSnapshotResponse`.
|
1364
|
+
# Corresponds to the JSON property `response`
|
1365
|
+
# @return [Hash<String,Object>]
|
1366
|
+
attr_accessor :response
|
1367
|
+
|
1368
|
+
def initialize(**args)
|
1369
|
+
update!(**args)
|
1370
|
+
end
|
1371
|
+
|
1372
|
+
# Update properties of this object
|
1373
|
+
def update!(**args)
|
1374
|
+
@done = args[:done] if args.key?(:done)
|
1375
|
+
@error = args[:error] if args.key?(:error)
|
1376
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
1377
|
+
@name = args[:name] if args.key?(:name)
|
1378
|
+
@response = args[:response] if args.key?(:response)
|
1379
|
+
end
|
1380
|
+
end
|
1381
|
+
|
1208
1382
|
# Order bys define how rows will be sorted in the response. For example,
|
1209
1383
|
# ordering rows by descending event count is one ordering, and ordering rows by
|
1210
1384
|
# the event name string is a different ordering.
|
@@ -1460,6 +1634,83 @@ module Google
|
|
1460
1634
|
end
|
1461
1635
|
end
|
1462
1636
|
|
1637
|
+
# A request to list users in an audience export.
|
1638
|
+
class QueryAudienceExportRequest
|
1639
|
+
include Google::Apis::Core::Hashable
|
1640
|
+
|
1641
|
+
# Optional. The number of rows to return. If unspecified, 10,000 rows are
|
1642
|
+
# returned. The API returns a maximum of 250,000 rows per request, no matter how
|
1643
|
+
# many you ask for. `limit` must be positive. The API can also return fewer rows
|
1644
|
+
# than the requested `limit`, if there aren't as many dimension values as the `
|
1645
|
+
# limit`. To learn more about this pagination parameter, see [Pagination](https:/
|
1646
|
+
# /developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination)
|
1647
|
+
# .
|
1648
|
+
# Corresponds to the JSON property `limit`
|
1649
|
+
# @return [Fixnum]
|
1650
|
+
attr_accessor :limit
|
1651
|
+
|
1652
|
+
# Optional. The row count of the start row. The first row is counted as row 0.
|
1653
|
+
# When paging, the first request does not specify offset; or equivalently, sets
|
1654
|
+
# offset to 0; the first request returns the first `limit` of rows. The second
|
1655
|
+
# request sets offset to the `limit` of the first request; the second request
|
1656
|
+
# returns the second `limit` of rows. To learn more about this pagination
|
1657
|
+
# parameter, see [Pagination](https://developers.google.com/analytics/devguides/
|
1658
|
+
# reporting/data/v1/basics#pagination).
|
1659
|
+
# Corresponds to the JSON property `offset`
|
1660
|
+
# @return [Fixnum]
|
1661
|
+
attr_accessor :offset
|
1662
|
+
|
1663
|
+
def initialize(**args)
|
1664
|
+
update!(**args)
|
1665
|
+
end
|
1666
|
+
|
1667
|
+
# Update properties of this object
|
1668
|
+
def update!(**args)
|
1669
|
+
@limit = args[:limit] if args.key?(:limit)
|
1670
|
+
@offset = args[:offset] if args.key?(:offset)
|
1671
|
+
end
|
1672
|
+
end
|
1673
|
+
|
1674
|
+
# A list of users in an audience export.
|
1675
|
+
class QueryAudienceExportResponse
|
1676
|
+
include Google::Apis::Core::Hashable
|
1677
|
+
|
1678
|
+
# An audience export is a list of users in an audience at the time of the list's
|
1679
|
+
# creation. One audience may have multiple audience exports created for
|
1680
|
+
# different days.
|
1681
|
+
# Corresponds to the JSON property `audienceExport`
|
1682
|
+
# @return [Google::Apis::AnalyticsdataV1beta::AudienceExport]
|
1683
|
+
attr_accessor :audience_export
|
1684
|
+
|
1685
|
+
# Rows for each user in an audience export. The number of rows in this response
|
1686
|
+
# will be less than or equal to request's page size.
|
1687
|
+
# Corresponds to the JSON property `audienceRows`
|
1688
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::V1betaAudienceRow>]
|
1689
|
+
attr_accessor :audience_rows
|
1690
|
+
|
1691
|
+
# The total number of rows in the AudienceExport result. `rowCount` is
|
1692
|
+
# independent of the number of rows returned in the response, the `limit`
|
1693
|
+
# request parameter, and the `offset` request parameter. For example if a query
|
1694
|
+
# returns 175 rows and includes `limit` of 50 in the API request, the response
|
1695
|
+
# will contain `rowCount` of 175 but only 50 rows. To learn more about this
|
1696
|
+
# pagination parameter, see [Pagination](https://developers.google.com/analytics/
|
1697
|
+
# devguides/reporting/data/v1/basics#pagination).
|
1698
|
+
# Corresponds to the JSON property `rowCount`
|
1699
|
+
# @return [Fixnum]
|
1700
|
+
attr_accessor :row_count
|
1701
|
+
|
1702
|
+
def initialize(**args)
|
1703
|
+
update!(**args)
|
1704
|
+
end
|
1705
|
+
|
1706
|
+
# Update properties of this object
|
1707
|
+
def update!(**args)
|
1708
|
+
@audience_export = args[:audience_export] if args.key?(:audience_export)
|
1709
|
+
@audience_rows = args[:audience_rows] if args.key?(:audience_rows)
|
1710
|
+
@row_count = args[:row_count] if args.key?(:row_count)
|
1711
|
+
end
|
1712
|
+
end
|
1713
|
+
|
1463
1714
|
# Current state for a particular quota group.
|
1464
1715
|
class QuotaStatus
|
1465
1716
|
include Google::Apis::Core::Hashable
|
@@ -1521,6 +1772,16 @@ module Google
|
|
1521
1772
|
# @return [String]
|
1522
1773
|
attr_accessor :empty_reason
|
1523
1774
|
|
1775
|
+
# If this report results is [sampled](https://support.google.com/analytics/
|
1776
|
+
# answer/13331292), this describes the percentage of events used in this report.
|
1777
|
+
# One `samplingMetadatas` is populated for each date range. Each `
|
1778
|
+
# samplingMetadatas` corresponds to a date range in order that date ranges were
|
1779
|
+
# specified in the request. However if the results are not sampled, this field
|
1780
|
+
# will not be defined.
|
1781
|
+
# Corresponds to the JSON property `samplingMetadatas`
|
1782
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::SamplingMetadata>]
|
1783
|
+
attr_accessor :sampling_metadatas
|
1784
|
+
|
1524
1785
|
# The schema restrictions actively enforced in creating this report. To learn
|
1525
1786
|
# more, see [Access and data-restriction management](https://support.google.com/
|
1526
1787
|
# analytics/answer/10851388).
|
@@ -1533,8 +1794,7 @@ module Google
|
|
1533
1794
|
# possible for a request to be subject to thresholding thresholding and no data
|
1534
1795
|
# is absent from the report, and this happens when all data is above the
|
1535
1796
|
# thresholds. To learn more, see [Data thresholds](https://support.google.com/
|
1536
|
-
# analytics/answer/9383630)
|
1537
|
-
# support.google.com/analytics/answer/2799357).
|
1797
|
+
# analytics/answer/9383630).
|
1538
1798
|
# Corresponds to the JSON property `subjectToThresholding`
|
1539
1799
|
# @return [Boolean]
|
1540
1800
|
attr_accessor :subject_to_thresholding
|
@@ -1557,6 +1817,7 @@ module Google
|
|
1557
1817
|
@currency_code = args[:currency_code] if args.key?(:currency_code)
|
1558
1818
|
@data_loss_from_other_row = args[:data_loss_from_other_row] if args.key?(:data_loss_from_other_row)
|
1559
1819
|
@empty_reason = args[:empty_reason] if args.key?(:empty_reason)
|
1820
|
+
@sampling_metadatas = args[:sampling_metadatas] if args.key?(:sampling_metadatas)
|
1560
1821
|
@schema_restriction_response = args[:schema_restriction_response] if args.key?(:schema_restriction_response)
|
1561
1822
|
@subject_to_thresholding = args[:subject_to_thresholding] if args.key?(:subject_to_thresholding)
|
1562
1823
|
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
@@ -2175,6 +2436,40 @@ module Google
|
|
2175
2436
|
end
|
2176
2437
|
end
|
2177
2438
|
|
2439
|
+
# If this report results is [sampled](https://support.google.com/analytics/
|
2440
|
+
# answer/13331292), this describes the percentage of events used in this report.
|
2441
|
+
# Sampling is the practice of analyzing a subset of all data in order to uncover
|
2442
|
+
# the meaningful information in the larger data set.
|
2443
|
+
class SamplingMetadata
|
2444
|
+
include Google::Apis::Core::Hashable
|
2445
|
+
|
2446
|
+
# The total number of events read in this sampled report for a date range. This
|
2447
|
+
# is the size of the subset this property's data that was analyzed in this
|
2448
|
+
# report.
|
2449
|
+
# Corresponds to the JSON property `samplesReadCount`
|
2450
|
+
# @return [Fixnum]
|
2451
|
+
attr_accessor :samples_read_count
|
2452
|
+
|
2453
|
+
# The total number of events present in this property's data that could have
|
2454
|
+
# been analyzed in this report for a date range. Sampling uncovers the
|
2455
|
+
# meaningful information about the larger data set, and this is the size of the
|
2456
|
+
# larger data set. To calculate the percentage of available data that was used
|
2457
|
+
# in this report, compute `samplesReadCount/samplingSpaceSize`.
|
2458
|
+
# Corresponds to the JSON property `samplingSpaceSize`
|
2459
|
+
# @return [Fixnum]
|
2460
|
+
attr_accessor :sampling_space_size
|
2461
|
+
|
2462
|
+
def initialize(**args)
|
2463
|
+
update!(**args)
|
2464
|
+
end
|
2465
|
+
|
2466
|
+
# Update properties of this object
|
2467
|
+
def update!(**args)
|
2468
|
+
@samples_read_count = args[:samples_read_count] if args.key?(:samples_read_count)
|
2469
|
+
@sampling_space_size = args[:sampling_space_size] if args.key?(:sampling_space_size)
|
2470
|
+
end
|
2471
|
+
end
|
2472
|
+
|
2178
2473
|
# The schema restrictions actively enforced in creating this report. To learn
|
2179
2474
|
# more, see [Access and data-restriction management](https://support.google.com/
|
2180
2475
|
# analytics/answer/10851388).
|
@@ -2199,6 +2494,45 @@ module Google
|
|
2199
2494
|
end
|
2200
2495
|
end
|
2201
2496
|
|
2497
|
+
# The `Status` type defines a logical error model that is suitable for different
|
2498
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
2499
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
2500
|
+
# data: error code, error message, and error details. You can find out more
|
2501
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
2502
|
+
# //cloud.google.com/apis/design/errors).
|
2503
|
+
class Status
|
2504
|
+
include Google::Apis::Core::Hashable
|
2505
|
+
|
2506
|
+
# The status code, which should be an enum value of google.rpc.Code.
|
2507
|
+
# Corresponds to the JSON property `code`
|
2508
|
+
# @return [Fixnum]
|
2509
|
+
attr_accessor :code
|
2510
|
+
|
2511
|
+
# A list of messages that carry the error details. There is a common set of
|
2512
|
+
# message types for APIs to use.
|
2513
|
+
# Corresponds to the JSON property `details`
|
2514
|
+
# @return [Array<Hash<String,Object>>]
|
2515
|
+
attr_accessor :details
|
2516
|
+
|
2517
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
2518
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
2519
|
+
# field, or localized by the client.
|
2520
|
+
# Corresponds to the JSON property `message`
|
2521
|
+
# @return [String]
|
2522
|
+
attr_accessor :message
|
2523
|
+
|
2524
|
+
def initialize(**args)
|
2525
|
+
update!(**args)
|
2526
|
+
end
|
2527
|
+
|
2528
|
+
# Update properties of this object
|
2529
|
+
def update!(**args)
|
2530
|
+
@code = args[:code] if args.key?(:code)
|
2531
|
+
@details = args[:details] if args.key?(:details)
|
2532
|
+
@message = args[:message] if args.key?(:message)
|
2533
|
+
end
|
2534
|
+
end
|
2535
|
+
|
2202
2536
|
# The filter for string
|
2203
2537
|
class StringFilter
|
2204
2538
|
include Google::Apis::Core::Hashable
|
@@ -2230,6 +2564,67 @@ module Google
|
|
2230
2564
|
@value = args[:value] if args.key?(:value)
|
2231
2565
|
end
|
2232
2566
|
end
|
2567
|
+
|
2568
|
+
# An audience dimension is a user attribute. Specific user attributed are
|
2569
|
+
# requested and then later returned in the `QueryAudienceExportResponse`.
|
2570
|
+
class V1betaAudienceDimension
|
2571
|
+
include Google::Apis::Core::Hashable
|
2572
|
+
|
2573
|
+
# Optional. The API name of the dimension. See the [API Dimensions](https://
|
2574
|
+
# developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-
|
2575
|
+
# schema#dimensions) for the list of dimension names.
|
2576
|
+
# Corresponds to the JSON property `dimensionName`
|
2577
|
+
# @return [String]
|
2578
|
+
attr_accessor :dimension_name
|
2579
|
+
|
2580
|
+
def initialize(**args)
|
2581
|
+
update!(**args)
|
2582
|
+
end
|
2583
|
+
|
2584
|
+
# Update properties of this object
|
2585
|
+
def update!(**args)
|
2586
|
+
@dimension_name = args[:dimension_name] if args.key?(:dimension_name)
|
2587
|
+
end
|
2588
|
+
end
|
2589
|
+
|
2590
|
+
# The value of a dimension.
|
2591
|
+
class V1betaAudienceDimensionValue
|
2592
|
+
include Google::Apis::Core::Hashable
|
2593
|
+
|
2594
|
+
# Value as a string if the dimension type is a string.
|
2595
|
+
# Corresponds to the JSON property `value`
|
2596
|
+
# @return [String]
|
2597
|
+
attr_accessor :value
|
2598
|
+
|
2599
|
+
def initialize(**args)
|
2600
|
+
update!(**args)
|
2601
|
+
end
|
2602
|
+
|
2603
|
+
# Update properties of this object
|
2604
|
+
def update!(**args)
|
2605
|
+
@value = args[:value] if args.key?(:value)
|
2606
|
+
end
|
2607
|
+
end
|
2608
|
+
|
2609
|
+
# Dimension value attributes for the audience user row.
|
2610
|
+
class V1betaAudienceRow
|
2611
|
+
include Google::Apis::Core::Hashable
|
2612
|
+
|
2613
|
+
# Each dimension value attribute for an audience user. One dimension value will
|
2614
|
+
# be added for each dimension column requested.
|
2615
|
+
# Corresponds to the JSON property `dimensionValues`
|
2616
|
+
# @return [Array<Google::Apis::AnalyticsdataV1beta::V1betaAudienceDimensionValue>]
|
2617
|
+
attr_accessor :dimension_values
|
2618
|
+
|
2619
|
+
def initialize(**args)
|
2620
|
+
update!(**args)
|
2621
|
+
end
|
2622
|
+
|
2623
|
+
# Update properties of this object
|
2624
|
+
def update!(**args)
|
2625
|
+
@dimension_values = args[:dimension_values] if args.key?(:dimension_values)
|
2626
|
+
end
|
2627
|
+
end
|
2233
2628
|
end
|
2234
2629
|
end
|
2235
2630
|
end
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module AnalyticsdataV1beta
|
18
18
|
# Version of the google-apis-analyticsdata_v1beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.32.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20231203"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -28,6 +28,12 @@ module Google
|
|
28
28
|
include Google::Apis::Core::JsonObjectSupport
|
29
29
|
end
|
30
30
|
|
31
|
+
class AudienceExport
|
32
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
33
|
+
|
34
|
+
include Google::Apis::Core::JsonObjectSupport
|
35
|
+
end
|
36
|
+
|
31
37
|
class AudienceListMetadata
|
32
38
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
33
39
|
|
@@ -184,6 +190,12 @@ module Google
|
|
184
190
|
include Google::Apis::Core::JsonObjectSupport
|
185
191
|
end
|
186
192
|
|
193
|
+
class ListAudienceExportsResponse
|
194
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
195
|
+
|
196
|
+
include Google::Apis::Core::JsonObjectSupport
|
197
|
+
end
|
198
|
+
|
187
199
|
class Metadata
|
188
200
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
189
201
|
|
@@ -244,6 +256,12 @@ module Google
|
|
244
256
|
include Google::Apis::Core::JsonObjectSupport
|
245
257
|
end
|
246
258
|
|
259
|
+
class Operation
|
260
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
261
|
+
|
262
|
+
include Google::Apis::Core::JsonObjectSupport
|
263
|
+
end
|
264
|
+
|
247
265
|
class OrderBy
|
248
266
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
249
267
|
|
@@ -286,6 +304,18 @@ module Google
|
|
286
304
|
include Google::Apis::Core::JsonObjectSupport
|
287
305
|
end
|
288
306
|
|
307
|
+
class QueryAudienceExportRequest
|
308
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
309
|
+
|
310
|
+
include Google::Apis::Core::JsonObjectSupport
|
311
|
+
end
|
312
|
+
|
313
|
+
class QueryAudienceExportResponse
|
314
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
315
|
+
|
316
|
+
include Google::Apis::Core::JsonObjectSupport
|
317
|
+
end
|
318
|
+
|
289
319
|
class QuotaStatus
|
290
320
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
291
321
|
|
@@ -340,18 +370,48 @@ module Google
|
|
340
370
|
include Google::Apis::Core::JsonObjectSupport
|
341
371
|
end
|
342
372
|
|
373
|
+
class SamplingMetadata
|
374
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
375
|
+
|
376
|
+
include Google::Apis::Core::JsonObjectSupport
|
377
|
+
end
|
378
|
+
|
343
379
|
class SchemaRestrictionResponse
|
344
380
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
345
381
|
|
346
382
|
include Google::Apis::Core::JsonObjectSupport
|
347
383
|
end
|
348
384
|
|
385
|
+
class Status
|
386
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
387
|
+
|
388
|
+
include Google::Apis::Core::JsonObjectSupport
|
389
|
+
end
|
390
|
+
|
349
391
|
class StringFilter
|
350
392
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
351
393
|
|
352
394
|
include Google::Apis::Core::JsonObjectSupport
|
353
395
|
end
|
354
396
|
|
397
|
+
class V1betaAudienceDimension
|
398
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
399
|
+
|
400
|
+
include Google::Apis::Core::JsonObjectSupport
|
401
|
+
end
|
402
|
+
|
403
|
+
class V1betaAudienceDimensionValue
|
404
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
405
|
+
|
406
|
+
include Google::Apis::Core::JsonObjectSupport
|
407
|
+
end
|
408
|
+
|
409
|
+
class V1betaAudienceRow
|
410
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
411
|
+
|
412
|
+
include Google::Apis::Core::JsonObjectSupport
|
413
|
+
end
|
414
|
+
|
355
415
|
class ActiveMetricRestriction
|
356
416
|
# @private
|
357
417
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -360,6 +420,23 @@ module Google
|
|
360
420
|
end
|
361
421
|
end
|
362
422
|
|
423
|
+
class AudienceExport
|
424
|
+
# @private
|
425
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
426
|
+
property :audience, as: 'audience'
|
427
|
+
property :audience_display_name, as: 'audienceDisplayName'
|
428
|
+
property :begin_creating_time, as: 'beginCreatingTime'
|
429
|
+
property :creation_quota_tokens_charged, as: 'creationQuotaTokensCharged'
|
430
|
+
collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1beta::V1betaAudienceDimension, decorator: Google::Apis::AnalyticsdataV1beta::V1betaAudienceDimension::Representation
|
431
|
+
|
432
|
+
property :error_message, as: 'errorMessage'
|
433
|
+
property :name, as: 'name'
|
434
|
+
property :percentage_completed, as: 'percentageCompleted'
|
435
|
+
property :row_count, as: 'rowCount'
|
436
|
+
property :state, as: 'state'
|
437
|
+
end
|
438
|
+
end
|
439
|
+
|
363
440
|
class AudienceListMetadata
|
364
441
|
# @private
|
365
442
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -606,6 +683,15 @@ module Google
|
|
606
683
|
end
|
607
684
|
end
|
608
685
|
|
686
|
+
class ListAudienceExportsResponse
|
687
|
+
# @private
|
688
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
689
|
+
collection :audience_exports, as: 'audienceExports', class: Google::Apis::AnalyticsdataV1beta::AudienceExport, decorator: Google::Apis::AnalyticsdataV1beta::AudienceExport::Representation
|
690
|
+
|
691
|
+
property :next_page_token, as: 'nextPageToken'
|
692
|
+
end
|
693
|
+
end
|
694
|
+
|
609
695
|
class Metadata
|
610
696
|
# @private
|
611
697
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -698,6 +784,18 @@ module Google
|
|
698
784
|
end
|
699
785
|
end
|
700
786
|
|
787
|
+
class Operation
|
788
|
+
# @private
|
789
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
790
|
+
property :done, as: 'done'
|
791
|
+
property :error, as: 'error', class: Google::Apis::AnalyticsdataV1beta::Status, decorator: Google::Apis::AnalyticsdataV1beta::Status::Representation
|
792
|
+
|
793
|
+
hash :metadata, as: 'metadata'
|
794
|
+
property :name, as: 'name'
|
795
|
+
hash :response, as: 'response'
|
796
|
+
end
|
797
|
+
end
|
798
|
+
|
701
799
|
class OrderBy
|
702
800
|
# @private
|
703
801
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -775,6 +873,25 @@ module Google
|
|
775
873
|
end
|
776
874
|
end
|
777
875
|
|
876
|
+
class QueryAudienceExportRequest
|
877
|
+
# @private
|
878
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
879
|
+
property :limit, :numeric_string => true, as: 'limit'
|
880
|
+
property :offset, :numeric_string => true, as: 'offset'
|
881
|
+
end
|
882
|
+
end
|
883
|
+
|
884
|
+
class QueryAudienceExportResponse
|
885
|
+
# @private
|
886
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
887
|
+
property :audience_export, as: 'audienceExport', class: Google::Apis::AnalyticsdataV1beta::AudienceExport, decorator: Google::Apis::AnalyticsdataV1beta::AudienceExport::Representation
|
888
|
+
|
889
|
+
collection :audience_rows, as: 'audienceRows', class: Google::Apis::AnalyticsdataV1beta::V1betaAudienceRow, decorator: Google::Apis::AnalyticsdataV1beta::V1betaAudienceRow::Representation
|
890
|
+
|
891
|
+
property :row_count, as: 'rowCount'
|
892
|
+
end
|
893
|
+
end
|
894
|
+
|
778
895
|
class QuotaStatus
|
779
896
|
# @private
|
780
897
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -789,6 +906,8 @@ module Google
|
|
789
906
|
property :currency_code, as: 'currencyCode'
|
790
907
|
property :data_loss_from_other_row, as: 'dataLossFromOtherRow'
|
791
908
|
property :empty_reason, as: 'emptyReason'
|
909
|
+
collection :sampling_metadatas, as: 'samplingMetadatas', class: Google::Apis::AnalyticsdataV1beta::SamplingMetadata, decorator: Google::Apis::AnalyticsdataV1beta::SamplingMetadata::Representation
|
910
|
+
|
792
911
|
property :schema_restriction_response, as: 'schemaRestrictionResponse', class: Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse, decorator: Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse::Representation
|
793
912
|
|
794
913
|
property :subject_to_thresholding, as: 'subjectToThresholding'
|
@@ -945,6 +1064,14 @@ module Google
|
|
945
1064
|
end
|
946
1065
|
end
|
947
1066
|
|
1067
|
+
class SamplingMetadata
|
1068
|
+
# @private
|
1069
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1070
|
+
property :samples_read_count, :numeric_string => true, as: 'samplesReadCount'
|
1071
|
+
property :sampling_space_size, :numeric_string => true, as: 'samplingSpaceSize'
|
1072
|
+
end
|
1073
|
+
end
|
1074
|
+
|
948
1075
|
class SchemaRestrictionResponse
|
949
1076
|
# @private
|
950
1077
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -953,6 +1080,15 @@ module Google
|
|
953
1080
|
end
|
954
1081
|
end
|
955
1082
|
|
1083
|
+
class Status
|
1084
|
+
# @private
|
1085
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1086
|
+
property :code, as: 'code'
|
1087
|
+
collection :details, as: 'details'
|
1088
|
+
property :message, as: 'message'
|
1089
|
+
end
|
1090
|
+
end
|
1091
|
+
|
956
1092
|
class StringFilter
|
957
1093
|
# @private
|
958
1094
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -961,6 +1097,28 @@ module Google
|
|
961
1097
|
property :value, as: 'value'
|
962
1098
|
end
|
963
1099
|
end
|
1100
|
+
|
1101
|
+
class V1betaAudienceDimension
|
1102
|
+
# @private
|
1103
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1104
|
+
property :dimension_name, as: 'dimensionName'
|
1105
|
+
end
|
1106
|
+
end
|
1107
|
+
|
1108
|
+
class V1betaAudienceDimensionValue
|
1109
|
+
# @private
|
1110
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1111
|
+
property :value, as: 'value'
|
1112
|
+
end
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
class V1betaAudienceRow
|
1116
|
+
# @private
|
1117
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1118
|
+
collection :dimension_values, as: 'dimensionValues', class: Google::Apis::AnalyticsdataV1beta::V1betaAudienceDimensionValue, decorator: Google::Apis::AnalyticsdataV1beta::V1betaAudienceDimensionValue::Representation
|
1119
|
+
|
1120
|
+
end
|
1121
|
+
end
|
964
1122
|
end
|
965
1123
|
end
|
966
1124
|
end
|
@@ -345,6 +345,195 @@ module Google
|
|
345
345
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
346
346
|
execute_or_queue_command(command, &block)
|
347
347
|
end
|
348
|
+
|
349
|
+
# Creates an audience export for later retrieval. This method quickly returns
|
350
|
+
# the audience export's resource name and initiates a long running asynchronous
|
351
|
+
# request to form an audience export. To export the users in an audience export,
|
352
|
+
# first create the audience export through this method and then send the
|
353
|
+
# audience resource name to the `QueryAudienceExport` method. See [Creating an
|
354
|
+
# Audience Export](https://developers.google.com/analytics/devguides/reporting/
|
355
|
+
# data/v1/audience-list-basics) for an introduction to Audience Exports with
|
356
|
+
# examples. An audience export is a snapshot of the users currently in the
|
357
|
+
# audience at the time of audience export creation. Creating audience exports
|
358
|
+
# for one audience on different days will return different results as users
|
359
|
+
# enter and exit the audience. Audiences in Google Analytics 4 allow you to
|
360
|
+
# segment your users in the ways that are important to your business. To learn
|
361
|
+
# more, see https://support.google.com/analytics/answer/9267572. Audience
|
362
|
+
# exports contain the users in each audience. Audience Export APIs have some
|
363
|
+
# methods at alpha and other methods at beta stability. The intention is to
|
364
|
+
# advance methods to beta stability after some feedback and adoption. To give
|
365
|
+
# your feedback on this API, complete the [Google Analytics Audience Export API
|
366
|
+
# Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
|
367
|
+
# @param [String] parent
|
368
|
+
# Required. The parent resource where this audience export will be created.
|
369
|
+
# Format: `properties/`property``
|
370
|
+
# @param [Google::Apis::AnalyticsdataV1beta::AudienceExport] audience_export_object
|
371
|
+
# @param [String] fields
|
372
|
+
# Selector specifying which fields to include in a partial response.
|
373
|
+
# @param [String] quota_user
|
374
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
375
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
376
|
+
# @param [Google::Apis::RequestOptions] options
|
377
|
+
# Request-specific options
|
378
|
+
#
|
379
|
+
# @yield [result, err] Result & error if block supplied
|
380
|
+
# @yieldparam result [Google::Apis::AnalyticsdataV1beta::Operation] parsed result object
|
381
|
+
# @yieldparam err [StandardError] error object if request failed
|
382
|
+
#
|
383
|
+
# @return [Google::Apis::AnalyticsdataV1beta::Operation]
|
384
|
+
#
|
385
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
386
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
387
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
388
|
+
def create_property_audience_export(parent, audience_export_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
389
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/audienceExports', options)
|
390
|
+
command.request_representation = Google::Apis::AnalyticsdataV1beta::AudienceExport::Representation
|
391
|
+
command.request_object = audience_export_object
|
392
|
+
command.response_representation = Google::Apis::AnalyticsdataV1beta::Operation::Representation
|
393
|
+
command.response_class = Google::Apis::AnalyticsdataV1beta::Operation
|
394
|
+
command.params['parent'] = parent unless parent.nil?
|
395
|
+
command.query['fields'] = fields unless fields.nil?
|
396
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
397
|
+
execute_or_queue_command(command, &block)
|
398
|
+
end
|
399
|
+
|
400
|
+
# Gets configuration metadata about a specific audience export. This method can
|
401
|
+
# be used to understand an audience export after it has been created. See [
|
402
|
+
# Creating an Audience Export](https://developers.google.com/analytics/devguides/
|
403
|
+
# reporting/data/v1/audience-list-basics) for an introduction to Audience
|
404
|
+
# Exports with examples. Audience Export APIs have some methods at alpha and
|
405
|
+
# other methods at beta stability. The intention is to advance methods to beta
|
406
|
+
# stability after some feedback and adoption. To give your feedback on this API,
|
407
|
+
# complete the [Google Analytics Audience Export API Feedback](https://forms.gle/
|
408
|
+
# EeA5u5LW6PEggtCEA) form.
|
409
|
+
# @param [String] name
|
410
|
+
# Required. The audience export resource name. Format: `properties/`property`/
|
411
|
+
# audienceExports/`audience_export``
|
412
|
+
# @param [String] fields
|
413
|
+
# Selector specifying which fields to include in a partial response.
|
414
|
+
# @param [String] quota_user
|
415
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
416
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
417
|
+
# @param [Google::Apis::RequestOptions] options
|
418
|
+
# Request-specific options
|
419
|
+
#
|
420
|
+
# @yield [result, err] Result & error if block supplied
|
421
|
+
# @yieldparam result [Google::Apis::AnalyticsdataV1beta::AudienceExport] parsed result object
|
422
|
+
# @yieldparam err [StandardError] error object if request failed
|
423
|
+
#
|
424
|
+
# @return [Google::Apis::AnalyticsdataV1beta::AudienceExport]
|
425
|
+
#
|
426
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
427
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
428
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
429
|
+
def get_property_audience_export(name, fields: nil, quota_user: nil, options: nil, &block)
|
430
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
431
|
+
command.response_representation = Google::Apis::AnalyticsdataV1beta::AudienceExport::Representation
|
432
|
+
command.response_class = Google::Apis::AnalyticsdataV1beta::AudienceExport
|
433
|
+
command.params['name'] = name unless name.nil?
|
434
|
+
command.query['fields'] = fields unless fields.nil?
|
435
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
436
|
+
execute_or_queue_command(command, &block)
|
437
|
+
end
|
438
|
+
|
439
|
+
# Lists all audience exports for a property. This method can be used for you to
|
440
|
+
# find and reuse existing audience exports rather than creating unnecessary new
|
441
|
+
# audience exports. The same audience can have multiple audience exports that
|
442
|
+
# represent the export of users that were in an audience on different days. See [
|
443
|
+
# Creating an Audience Export](https://developers.google.com/analytics/devguides/
|
444
|
+
# reporting/data/v1/audience-list-basics) for an introduction to Audience
|
445
|
+
# Exports with examples. Audience Export APIs have some methods at alpha and
|
446
|
+
# other methods at beta stability. The intention is to advance methods to beta
|
447
|
+
# stability after some feedback and adoption. To give your feedback on this API,
|
448
|
+
# complete the [Google Analytics Audience Export API Feedback](https://forms.gle/
|
449
|
+
# EeA5u5LW6PEggtCEA) form.
|
450
|
+
# @param [String] parent
|
451
|
+
# Required. All audience exports for this property will be listed in the
|
452
|
+
# response. Format: `properties/`property``
|
453
|
+
# @param [Fixnum] page_size
|
454
|
+
# Optional. The maximum number of audience exports to return. The service may
|
455
|
+
# return fewer than this value. If unspecified, at most 200 audience exports
|
456
|
+
# will be returned. The maximum value is 1000 (higher values will be coerced to
|
457
|
+
# the maximum).
|
458
|
+
# @param [String] page_token
|
459
|
+
# Optional. A page token, received from a previous `ListAudienceExports` call.
|
460
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
461
|
+
# parameters provided to `ListAudienceExports` must match the call that provided
|
462
|
+
# the page token.
|
463
|
+
# @param [String] fields
|
464
|
+
# Selector specifying which fields to include in a partial response.
|
465
|
+
# @param [String] quota_user
|
466
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
467
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
468
|
+
# @param [Google::Apis::RequestOptions] options
|
469
|
+
# Request-specific options
|
470
|
+
#
|
471
|
+
# @yield [result, err] Result & error if block supplied
|
472
|
+
# @yieldparam result [Google::Apis::AnalyticsdataV1beta::ListAudienceExportsResponse] parsed result object
|
473
|
+
# @yieldparam err [StandardError] error object if request failed
|
474
|
+
#
|
475
|
+
# @return [Google::Apis::AnalyticsdataV1beta::ListAudienceExportsResponse]
|
476
|
+
#
|
477
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
478
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
479
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
480
|
+
def list_property_audience_exports(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
481
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/audienceExports', options)
|
482
|
+
command.response_representation = Google::Apis::AnalyticsdataV1beta::ListAudienceExportsResponse::Representation
|
483
|
+
command.response_class = Google::Apis::AnalyticsdataV1beta::ListAudienceExportsResponse
|
484
|
+
command.params['parent'] = parent unless parent.nil?
|
485
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
486
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
487
|
+
command.query['fields'] = fields unless fields.nil?
|
488
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
489
|
+
execute_or_queue_command(command, &block)
|
490
|
+
end
|
491
|
+
|
492
|
+
# Retrieves an audience export of users. After creating an audience, the users
|
493
|
+
# are not immediately available for exporting. First, a request to `
|
494
|
+
# CreateAudienceExport` is necessary to create an audience export of users, and
|
495
|
+
# then second, this method is used to retrieve the users in the audience export.
|
496
|
+
# See [Creating an Audience Export](https://developers.google.com/analytics/
|
497
|
+
# devguides/reporting/data/v1/audience-list-basics) for an introduction to
|
498
|
+
# Audience Exports with examples. Audiences in Google Analytics 4 allow you to
|
499
|
+
# segment your users in the ways that are important to your business. To learn
|
500
|
+
# more, see https://support.google.com/analytics/answer/9267572. Audience Export
|
501
|
+
# APIs have some methods at alpha and other methods at beta stability. The
|
502
|
+
# intention is to advance methods to beta stability after some feedback and
|
503
|
+
# adoption. To give your feedback on this API, complete the [Google Analytics
|
504
|
+
# Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
|
505
|
+
# @param [String] name
|
506
|
+
# Required. The name of the audience export to retrieve users from. Format: `
|
507
|
+
# properties/`property`/audienceExports/`audience_export``
|
508
|
+
# @param [Google::Apis::AnalyticsdataV1beta::QueryAudienceExportRequest] query_audience_export_request_object
|
509
|
+
# @param [String] fields
|
510
|
+
# Selector specifying which fields to include in a partial response.
|
511
|
+
# @param [String] quota_user
|
512
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
513
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
514
|
+
# @param [Google::Apis::RequestOptions] options
|
515
|
+
# Request-specific options
|
516
|
+
#
|
517
|
+
# @yield [result, err] Result & error if block supplied
|
518
|
+
# @yieldparam result [Google::Apis::AnalyticsdataV1beta::QueryAudienceExportResponse] parsed result object
|
519
|
+
# @yieldparam err [StandardError] error object if request failed
|
520
|
+
#
|
521
|
+
# @return [Google::Apis::AnalyticsdataV1beta::QueryAudienceExportResponse]
|
522
|
+
#
|
523
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
524
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
525
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
526
|
+
def query_audience_export(name, query_audience_export_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
527
|
+
command = make_simple_command(:post, 'v1beta/{+name}:query', options)
|
528
|
+
command.request_representation = Google::Apis::AnalyticsdataV1beta::QueryAudienceExportRequest::Representation
|
529
|
+
command.request_object = query_audience_export_request_object
|
530
|
+
command.response_representation = Google::Apis::AnalyticsdataV1beta::QueryAudienceExportResponse::Representation
|
531
|
+
command.response_class = Google::Apis::AnalyticsdataV1beta::QueryAudienceExportResponse
|
532
|
+
command.params['name'] = name unless name.nil?
|
533
|
+
command.query['fields'] = fields unless fields.nil?
|
534
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
535
|
+
execute_or_queue_command(command, &block)
|
536
|
+
end
|
348
537
|
|
349
538
|
protected
|
350
539
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-analyticsdata_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.32.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-12-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-analyticsdata_v1beta/v0.32.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-analyticsdata_v1beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|