@puppi/adapter-google-analytics 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +29 -2
- package/dist/define.d.ts +19 -0
- package/dist/define.d.ts.map +1 -0
- package/dist/define.js +12 -0
- package/dist/define.js.map +1 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +135 -0
- package/dist/index.js.map +1 -0
- package/dist/openapi.d.ts +613 -0
- package/dist/openapi.d.ts.map +1 -0
- package/dist/openapi.js +6 -0
- package/dist/openapi.js.map +1 -0
- package/dist/operations.d.ts +14 -0
- package/dist/operations.d.ts.map +1 -0
- package/dist/operations.js +14 -0
- package/dist/operations.js.map +1 -0
- package/package.json +47 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,30 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @puppi/adapter-google-analytics
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Source connector for the Google Analytics Data API. It reads a GA4 property's metadata and pages a core report. Auth is a bearer access token. The token needs `https://www.googleapis.com/auth/analytics.readonly`, and the Google account that minted it needs access to the property.
|
|
4
|
+
|
|
5
|
+
The API version is the `v1beta` prefix of the base URL. `base_url` defaults to `https://analyticsdata.googleapis.com`. A binding that omits `api_version` uses `v1beta`. `property_id` is the numeric property id, such as `123456789`.
|
|
6
|
+
|
|
7
|
+
The spec is the discovery document <https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta> revision `20261111`, trimmed to `properties.runReport` and `properties.getMetadata`. Google publishes that discovery document, not OpenAPI. Paths are its `flatPath` with the `v1beta` prefix removed. The path parameter is the numeric id (`{propertiesId}` on the flat path).
|
|
8
|
+
|
|
9
|
+
`check()` and `getMetadata()` call `GET /v1beta/properties/{property}/metadata`. `getMetadata()` returns the property's dimensions, metrics, and comparisons.
|
|
10
|
+
|
|
11
|
+
`runReport({ body, cursor })` calls `POST /v1beta/properties/{property}:runReport`. `body` is a run-report request without `offset`. `limit` is an int64 string and is sent only when `body` includes it. The API's default limit is 10,000 rows and the maximum is 250,000. `cursor` is the next row offset, a decimal string, or null on the last page. The first request omits `offset`. The next offset is the offset this request sent plus the number of rows it returned. The walk stops when that reaches `rowCount`. A page with no rows, or a response without `rowCount`, ends the walk.
|
|
12
|
+
|
|
13
|
+
A row is an object keyed by the dimension names, then the metric names. Values are the strings the API sent. A missing cell is null.
|
|
14
|
+
|
|
15
|
+
The walk does not return `metadata`. A report can be sampled (`metadata.samplingMetadatas`), thresholded (`metadata.subjectToThresholding`), or roll dimension combinations into an `(other)` row (`metadata.dataLossFromOtherRow`). Those flags stay on the raw response.
|
|
16
|
+
|
|
17
|
+
Quotas are in the [Data API quotas](https://developers.google.com/analytics/devguides/reporting/data/v1/quotas). `runReport` and `getMetadata` both spend Core tokens. A standard property allows 200,000 core tokens a day, 40,000 an hour, 14,000 an hour for one Cloud project on that property, and 10 concurrent requests. Analytics 360 allows 2,000,000 a day, 400,000 an hour, 140,000 an hour per project, and 50 concurrent requests. Most requests cost 10 tokens or fewer. The cost depends on the row count, the dimensions and metrics, the filters, the date range, cardinality, and how many events the property has. Daily quotas refresh at midnight Pacific. A request past a token or concurrency quota is `429`. A standard property also allows 10 server errors (`500` and `503`) per project per hour, and 360 allows 50. Properties allow 120 potentially thresholded requests an hour. `userAgeBracket`, `userGender`, `brandingInterest`, `audienceId`, and `audienceName` count toward that limit.
|
|
18
|
+
|
|
19
|
+
The product docs call this the Data API v1. The reporting methods are on the `v1beta` discovery document, which is the channel where Google does not expect breaking changes. `v1alpha` is a separate document and can break. A discovery document named `v1` lists long-running operations only, not `runReport` or `getMetadata`. This package sends `v1beta`.
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"google-analytics": {
|
|
24
|
+
"config": { "property_id": "123456789" },
|
|
25
|
+
"secret_refs": { "access_token": "ga_access_token" }
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Reference: <https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport>
|
package/dist/define.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
declare const _default: {
|
|
2
|
+
readonly type: "google-analytics";
|
|
3
|
+
readonly docs: "https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties";
|
|
4
|
+
readonly configSchema: {
|
|
5
|
+
readonly property_id: "string";
|
|
6
|
+
readonly base_url: "string";
|
|
7
|
+
readonly api_version: "string";
|
|
8
|
+
};
|
|
9
|
+
readonly secretFields: readonly ["access_token"];
|
|
10
|
+
readonly auth: {
|
|
11
|
+
readonly scheme: "bearer";
|
|
12
|
+
readonly secret: "access_token";
|
|
13
|
+
};
|
|
14
|
+
readonly apiVersions: readonly ["v1beta"];
|
|
15
|
+
readonly defaultApiVersion: "v1beta";
|
|
16
|
+
readonly defaultBaseUrl: "https://analyticsdata.googleapis.com";
|
|
17
|
+
};
|
|
18
|
+
export default _default;
|
|
19
|
+
//# sourceMappingURL=define.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define.d.ts","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,wBASG"}
|
package/dist/define.js
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { defineConnector } from "@puppi/sdk";
|
|
2
|
+
export default defineConnector({
|
|
3
|
+
type: "google-analytics",
|
|
4
|
+
docs: "https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties",
|
|
5
|
+
configSchema: { property_id: "string", base_url: "string", api_version: "string" },
|
|
6
|
+
secretFields: ["access_token"],
|
|
7
|
+
auth: { scheme: "bearer", secret: "access_token" },
|
|
8
|
+
apiVersions: ["v1beta"],
|
|
9
|
+
defaultApiVersion: "v1beta",
|
|
10
|
+
defaultBaseUrl: "https://analyticsdata.googleapis.com",
|
|
11
|
+
});
|
|
12
|
+
//# sourceMappingURL=define.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define.js","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,eAAe,eAAe,CAAC;IAC7B,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,4FAA4F;IAClG,YAAY,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE;IAClF,YAAY,EAAE,CAAC,cAAc,CAAC;IAC9B,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE;IAClD,WAAW,EAAE,CAAC,QAAQ,CAAC;IACvB,iBAAiB,EAAE,QAAQ;IAC3B,cAAc,EAAE,sCAAsC;CACvD,CAAC,CAAC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { type CredentialCheck, type ClientOptions, OpenApiClient } from "@puppi/sdk";
|
|
2
|
+
import connector from "./define.js";
|
|
3
|
+
import type { SchemaRunReportRequest } from "./openapi.js";
|
|
4
|
+
import { type Api } from "./operations.js";
|
|
5
|
+
export type RunReportBody = Omit<SchemaRunReportRequest, "offset">;
|
|
6
|
+
/** Keys are the dimension names, then the metric names. A missing cell is null. */
|
|
7
|
+
export type ReportRow = Record<string, string | null>;
|
|
8
|
+
export default connector;
|
|
9
|
+
export declare class Client extends OpenApiClient<Api> {
|
|
10
|
+
private readonly propertyId;
|
|
11
|
+
constructor(config: Record<string, unknown>, secrets?: Record<string, string>, options?: ClientOptions);
|
|
12
|
+
check(): Promise<CredentialCheck>;
|
|
13
|
+
getMetadata(): Promise<{
|
|
14
|
+
dimensions?: import("./openapi.js").components["schemas"]["DimensionMetadata"][];
|
|
15
|
+
metrics?: import("./openapi.js").components["schemas"]["MetricMetadata"][];
|
|
16
|
+
comparisons?: import("./openapi.js").components["schemas"]["ComparisonMetadata"][];
|
|
17
|
+
name?: string;
|
|
18
|
+
}>;
|
|
19
|
+
runReport(args?: {
|
|
20
|
+
body?: RunReportBody;
|
|
21
|
+
cursor?: string | null;
|
|
22
|
+
}): AsyncGenerator<import("@puppi/sdk").Page<ReportRow, string>, any, any>;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,aAAa,EAGd,MAAM,YAAY,CAAC;AAEpB,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,KAAK,EAAE,sBAAsB,EAA2B,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,KAAK,GAAG,EAAc,MAAM,iBAAiB,CAAC;AAEvD,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;AAEnE,mFAAmF;AACnF,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;AAEtD,eAAe,SAAS,CAAC;AAMzB,qBAAa,MAAO,SAAQ,aAAa,CAAC,GAAG,CAAC;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAGlC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACpC,OAAO,GAAE,aAAkB;IAWpB,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK1C,WAAW;qBAqFgwb,4CAAsB;kBAA2F,4CAAsB;sBAAgG,4CAAsB;;;IAhFxgc,SAAS,CAAC,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,aAAa,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAO;CAgBtE"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
|
|
2
|
+
var useValue = arguments.length > 2;
|
|
3
|
+
for (var i = 0; i < initializers.length; i++) {
|
|
4
|
+
value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
|
|
5
|
+
}
|
|
6
|
+
return useValue ? value : void 0;
|
|
7
|
+
};
|
|
8
|
+
var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
|
|
9
|
+
function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
|
|
10
|
+
var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
|
|
11
|
+
var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
|
|
12
|
+
var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
|
|
13
|
+
var _, done = false;
|
|
14
|
+
for (var i = decorators.length - 1; i >= 0; i--) {
|
|
15
|
+
var context = {};
|
|
16
|
+
for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
|
|
17
|
+
for (var p in contextIn.access) context.access[p] = contextIn.access[p];
|
|
18
|
+
context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
|
|
19
|
+
var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
|
|
20
|
+
if (kind === "accessor") {
|
|
21
|
+
if (result === void 0) continue;
|
|
22
|
+
if (result === null || typeof result !== "object") throw new TypeError("Object expected");
|
|
23
|
+
if (_ = accept(result.get)) descriptor.get = _;
|
|
24
|
+
if (_ = accept(result.set)) descriptor.set = _;
|
|
25
|
+
if (_ = accept(result.init)) initializers.unshift(_);
|
|
26
|
+
}
|
|
27
|
+
else if (_ = accept(result)) {
|
|
28
|
+
if (kind === "field") initializers.unshift(_);
|
|
29
|
+
else descriptor[key] = _;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
if (target) Object.defineProperty(target, contextIn.name, descriptor);
|
|
33
|
+
done = true;
|
|
34
|
+
};
|
|
35
|
+
import { eachPage, read, OpenApiClient, openApiClientOptions, trimSlash, } from "@puppi/sdk";
|
|
36
|
+
import connector from "./define.js";
|
|
37
|
+
import { operations } from "./operations.js";
|
|
38
|
+
export default connector;
|
|
39
|
+
const type = connector.type;
|
|
40
|
+
const auth = connector.auth;
|
|
41
|
+
const defaultBaseUrl = connector.defaultBaseUrl;
|
|
42
|
+
let Client = (() => {
|
|
43
|
+
let _classSuper = OpenApiClient;
|
|
44
|
+
let _instanceExtraInitializers = [];
|
|
45
|
+
let _getMetadata_decorators;
|
|
46
|
+
let _runReport_decorators;
|
|
47
|
+
return class Client extends _classSuper {
|
|
48
|
+
static {
|
|
49
|
+
const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
|
|
50
|
+
_getMetadata_decorators = [read];
|
|
51
|
+
_runReport_decorators = [read];
|
|
52
|
+
__esDecorate(this, null, _getMetadata_decorators, { kind: "method", name: "getMetadata", static: false, private: false, access: { has: obj => "getMetadata" in obj, get: obj => obj.getMetadata }, metadata: _metadata }, null, _instanceExtraInitializers);
|
|
53
|
+
__esDecorate(this, null, _runReport_decorators, { kind: "method", name: "runReport", static: false, private: false, access: { has: obj => "runReport" in obj, get: obj => obj.runReport }, metadata: _metadata }, null, _instanceExtraInitializers);
|
|
54
|
+
if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
|
|
55
|
+
}
|
|
56
|
+
propertyId = __runInitializers(this, _instanceExtraInitializers);
|
|
57
|
+
constructor(config, secrets = {}, options = {}) {
|
|
58
|
+
const id = propertyId(config);
|
|
59
|
+
const [defaults, openApi] = openApiClientOptions(connector, config, secrets, operations, {
|
|
60
|
+
baseUrl: (version) => baseUrl(config, version),
|
|
61
|
+
});
|
|
62
|
+
super({ ...config, base_url: defaults.baseUrl }, options, defaults, openApi);
|
|
63
|
+
this.propertyId = id;
|
|
64
|
+
}
|
|
65
|
+
check() {
|
|
66
|
+
return this.prove(`/properties/${encodeURIComponent(this.propertyId)}/metadata`, auth.secret);
|
|
67
|
+
}
|
|
68
|
+
getMetadata() {
|
|
69
|
+
return this.read("properties.getMetadata", { path: { property: this.propertyId } });
|
|
70
|
+
}
|
|
71
|
+
runReport(args = {}) {
|
|
72
|
+
const body = args.body ?? {};
|
|
73
|
+
return eachPage({
|
|
74
|
+
cursor: args.cursor ?? null,
|
|
75
|
+
fetchPage: async (cursor) => {
|
|
76
|
+
const start = rowOffset(cursor);
|
|
77
|
+
const report = await this.read("properties.runReport", {
|
|
78
|
+
path: { property: this.propertyId },
|
|
79
|
+
body: cursor === null ? body : { ...body, offset: cursor },
|
|
80
|
+
});
|
|
81
|
+
return { data: reportRows(report), next: nextOffset(report, start) };
|
|
82
|
+
},
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
};
|
|
86
|
+
})();
|
|
87
|
+
export { Client };
|
|
88
|
+
function baseUrl(config, version) {
|
|
89
|
+
const override = config["base_url"];
|
|
90
|
+
const host = typeof override === "string" && override !== "" ? override : defaultBaseUrl;
|
|
91
|
+
return `${trimSlash(host)}/${version}`;
|
|
92
|
+
}
|
|
93
|
+
function propertyId(config) {
|
|
94
|
+
const id = config["property_id"];
|
|
95
|
+
if (typeof id !== "string" || id === "" || id.includes("/")) {
|
|
96
|
+
throw new Error(`${type} requires property_id`);
|
|
97
|
+
}
|
|
98
|
+
return id;
|
|
99
|
+
}
|
|
100
|
+
function rowOffset(cursor) {
|
|
101
|
+
if (cursor === null)
|
|
102
|
+
return 0;
|
|
103
|
+
const offset = Number(cursor);
|
|
104
|
+
if (!Number.isSafeInteger(offset) || offset < 0) {
|
|
105
|
+
throw new Error(`${type} offset ${JSON.stringify(cursor)} is not a row index`);
|
|
106
|
+
}
|
|
107
|
+
return offset;
|
|
108
|
+
}
|
|
109
|
+
/** The response does not echo offset, so the next offset is sent + returned, and the walk stops at rowCount. */
|
|
110
|
+
function nextOffset(report, start) {
|
|
111
|
+
const returned = report.rows?.length ?? 0;
|
|
112
|
+
const total = report.rowCount;
|
|
113
|
+
const advance = start + returned;
|
|
114
|
+
if (returned === 0 || typeof total !== "number" || advance >= total)
|
|
115
|
+
return null;
|
|
116
|
+
return String(advance);
|
|
117
|
+
}
|
|
118
|
+
function reportRows(report) {
|
|
119
|
+
const dimensions = columnNames(report.dimensionHeaders);
|
|
120
|
+
const metrics = columnNames(report.metricHeaders);
|
|
121
|
+
return (report.rows ?? []).map((row) => {
|
|
122
|
+
const record = {};
|
|
123
|
+
for (const [index, name] of dimensions.entries()) {
|
|
124
|
+
record[name] = row.dimensionValues?.[index]?.value ?? null;
|
|
125
|
+
}
|
|
126
|
+
for (const [index, name] of metrics.entries()) {
|
|
127
|
+
record[name] = row.metricValues?.[index]?.value ?? null;
|
|
128
|
+
}
|
|
129
|
+
return record;
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
function columnNames(headers) {
|
|
133
|
+
return (headers ?? []).map((header) => header.name ?? "");
|
|
134
|
+
}
|
|
135
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,QAAQ,EACR,IAAI,EAGJ,aAAa,EACb,oBAAoB,EACpB,SAAS,GACV,MAAM,YAAY,CAAC;AAEpB,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAOvD,eAAe,SAAS,CAAC;AAEzB,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;AAC5B,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;AAC5B,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;IAEnC,MAAM;sBAAS,aAAa;;;;iBAA5B,MAAO,SAAQ,WAAkB;;;uCAqB3C,IAAI;qCAKJ,IAAI;YAJL,oLAAA,WAAW,6DAEV;YAGD,8KAAA,SAAS,6DAeR;;;QAzCgB,UAAU,GADhB,mDAAM,CACmB;QAEpC,YACE,MAA+B,EAC/B,UAAkC,EAAE,EACpC,UAAyB,EAAE;YAE3B,MAAM,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9B,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE;gBACvF,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC;aAC/C,CAAC,CAAC;YAEH,KAAK,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC7E,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACvB,CAAC;QAEQ,KAAK;YACZ,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAChG,CAAC;QAGD,WAAW;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACtF,CAAC;QAGD,SAAS,CAAC,OAAyD,EAAE;YACnE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAE7B,OAAO,QAAQ,CAAC;gBACd,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI;gBAC3B,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;oBAC1B,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;oBAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE;wBACrD,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE;wBACnC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE;qBAC3D,CAAC,CAAC;oBAEH,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBACvE,CAAC;aACF,CAAC,CAAC;QACL,CAAC;;;SA1CU,MAAM;AA6CnB,SAAS,OAAO,CAAC,MAA+B,EAAE,OAAe;IAC/D,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC;IAEzF,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,OAAO,EAAE,CAAC;AACzC,CAAC;AAED,SAAS,UAAU,CAAC,MAA+B;IACjD,MAAM,EAAE,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IAEjC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,uBAAuB,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,SAAS,CAAC,MAAqB;IACtC,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,CAAC,CAAC;IAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAE9B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,WAAW,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IACjF,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,gHAAgH;AAChH,SAAS,UAAU,CAAC,MAA+B,EAAE,KAAa;IAChE,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC;IAC9B,MAAM,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;IAEjC,IAAI,QAAQ,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK;QAAE,OAAO,IAAI,CAAC;IAEjF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,UAAU,CAAC,MAA+B;IACjD,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAElD,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACrC,MAAM,MAAM,GAAc,EAAE,CAAC;QAE7B,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC;QAC7D,CAAC;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9C,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC;QAC1D,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,OAAwC;IAC3D,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;AAC5D,CAAC"}
|
|
@@ -0,0 +1,613 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export type paths = {
|
|
6
|
+
"/properties/{property}:runReport": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
get?: never;
|
|
14
|
+
put?: never;
|
|
15
|
+
/** @description Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). */
|
|
16
|
+
post: operations["properties.runReport"];
|
|
17
|
+
delete?: never;
|
|
18
|
+
options?: never;
|
|
19
|
+
head?: never;
|
|
20
|
+
patch?: never;
|
|
21
|
+
trace?: never;
|
|
22
|
+
};
|
|
23
|
+
"/properties/{property}/metadata": {
|
|
24
|
+
parameters: {
|
|
25
|
+
query?: never;
|
|
26
|
+
header?: never;
|
|
27
|
+
path?: never;
|
|
28
|
+
cookie?: never;
|
|
29
|
+
};
|
|
30
|
+
/** @description Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`. */
|
|
31
|
+
get: operations["properties.getMetadata"];
|
|
32
|
+
put?: never;
|
|
33
|
+
post?: never;
|
|
34
|
+
delete?: never;
|
|
35
|
+
options?: never;
|
|
36
|
+
head?: never;
|
|
37
|
+
patch?: never;
|
|
38
|
+
trace?: never;
|
|
39
|
+
};
|
|
40
|
+
};
|
|
41
|
+
export type webhooks = Record<string, never>;
|
|
42
|
+
export type components = {
|
|
43
|
+
schemas: {
|
|
44
|
+
/** @description Current state for a particular quota group. */
|
|
45
|
+
QuotaStatus: {
|
|
46
|
+
/**
|
|
47
|
+
* Format: int32
|
|
48
|
+
* @description Quota consumed by this request.
|
|
49
|
+
*/
|
|
50
|
+
consumed?: number;
|
|
51
|
+
/**
|
|
52
|
+
* Format: int32
|
|
53
|
+
* @description Quota remaining after this request.
|
|
54
|
+
*/
|
|
55
|
+
remaining?: number;
|
|
56
|
+
};
|
|
57
|
+
/** @description Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers. */
|
|
58
|
+
DimensionHeader: {
|
|
59
|
+
/** @description The dimension's name. */
|
|
60
|
+
name?: string;
|
|
61
|
+
};
|
|
62
|
+
/** @description To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. */
|
|
63
|
+
FilterExpression: {
|
|
64
|
+
/** @description The FilterExpressions in or_group have an OR relationship. */
|
|
65
|
+
orGroup?: components["schemas"]["FilterExpressionList"];
|
|
66
|
+
/** @description The FilterExpression is NOT of not_expression. */
|
|
67
|
+
notExpression?: components["schemas"]["FilterExpression"];
|
|
68
|
+
/** @description A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. */
|
|
69
|
+
filter?: components["schemas"]["Filter"];
|
|
70
|
+
/** @description The FilterExpressions in and_group have an AND relationship. */
|
|
71
|
+
andGroup?: components["schemas"]["FilterExpressionList"];
|
|
72
|
+
};
|
|
73
|
+
/** @description Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ``` */
|
|
74
|
+
Row: {
|
|
75
|
+
/** @description List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot. */
|
|
76
|
+
dimensionValues?: components["schemas"]["DimensionValue"][];
|
|
77
|
+
/** @description List of requested visible metric values. */
|
|
78
|
+
metricValues?: components["schemas"]["MetricValue"][];
|
|
79
|
+
};
|
|
80
|
+
/** @description To represent a number. */
|
|
81
|
+
NumericValue: {
|
|
82
|
+
/**
|
|
83
|
+
* Format: int64
|
|
84
|
+
* @description Integer value
|
|
85
|
+
*/
|
|
86
|
+
int64Value?: string;
|
|
87
|
+
/**
|
|
88
|
+
* Format: double
|
|
89
|
+
* @description Double value
|
|
90
|
+
*/
|
|
91
|
+
doubleValue?: number;
|
|
92
|
+
};
|
|
93
|
+
/** @description Optional settings of a cohort report. */
|
|
94
|
+
CohortReportSettings: {
|
|
95
|
+
/** @description If true, accumulates the result from first touch day to the end day. Not supported in `RunReportRequest`. */
|
|
96
|
+
accumulate?: boolean;
|
|
97
|
+
};
|
|
98
|
+
/** @description A list of filter expressions. */
|
|
99
|
+
FilterExpressionList: {
|
|
100
|
+
/** @description A list of filter expressions. */
|
|
101
|
+
expressions?: components["schemas"]["FilterExpression"][];
|
|
102
|
+
};
|
|
103
|
+
/** @description Sorts by a pivot column group. */
|
|
104
|
+
PivotOrderBy: {
|
|
105
|
+
/** @description In the response to order by, order rows by this column. Must be a metric name from the request. */
|
|
106
|
+
metricName?: string;
|
|
107
|
+
/** @description Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair. */
|
|
108
|
+
pivotSelections?: components["schemas"]["PivotSelection"][];
|
|
109
|
+
};
|
|
110
|
+
/** @description The value of a metric. */
|
|
111
|
+
MetricValue: {
|
|
112
|
+
/** @description Measurement value. See MetricHeader for type. */
|
|
113
|
+
value?: string;
|
|
114
|
+
};
|
|
115
|
+
/** @description If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set. */
|
|
116
|
+
SamplingMetadata: {
|
|
117
|
+
/**
|
|
118
|
+
* Format: int64
|
|
119
|
+
* @description The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this report.
|
|
120
|
+
*/
|
|
121
|
+
samplesReadCount?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Format: int64
|
|
124
|
+
* @description The total number of events present in this property's data that could have been analyzed in this report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set. To calculate the percentage of available data that was used in this report, compute `samplesReadCount/samplingSpaceSize`.
|
|
125
|
+
*/
|
|
126
|
+
samplingSpaceSize?: string;
|
|
127
|
+
};
|
|
128
|
+
/** @description Filter for empty values. Matches dimension values that are `""` or `(not set)` values. Use this filter to match rows with missing or unpopulated dimension values, or combine it with `not_expression` to exclude them from a report without filtering for both `""` and `(not set)` separately. */
|
|
129
|
+
EmptyFilter: Record<string, unknown>;
|
|
130
|
+
/** @description Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort. */
|
|
131
|
+
Cohort: {
|
|
132
|
+
/** @description Dimension used by the cohort. Required and only supports `firstSessionDate`. */
|
|
133
|
+
dimension?: string;
|
|
134
|
+
/** @description The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`. This `dateRange` does not specify the full date range of event data that is present in a cohort report. In a cohort report, this `dateRange` is extended by the granularity and offset present in the `cohortsRange`; event data for the extended reporting date range is present in a cohort report. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. This `dateRange` should generally be aligned with the cohort's granularity. If `CohortsRange` uses daily granularity, this `dateRange` can be a single day. If `CohortsRange` uses weekly granularity, this `dateRange` can be aligned to a week boundary, starting at Sunday and ending Saturday. If `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to a month, starting at the first and ending on the last day of the month. */
|
|
135
|
+
dateRange?: components["schemas"]["DateRange"];
|
|
136
|
+
/** @description Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc. */
|
|
137
|
+
name?: string;
|
|
138
|
+
};
|
|
139
|
+
/** @description The request to generate a report. */
|
|
140
|
+
RunReportRequest: {
|
|
141
|
+
/** @description Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). */
|
|
142
|
+
returnPropertyQuota?: boolean;
|
|
143
|
+
/** @description Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. */
|
|
144
|
+
dimensionFilter?: components["schemas"]["FilterExpression"];
|
|
145
|
+
/** @description If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0. */
|
|
146
|
+
keepEmptyRows?: boolean;
|
|
147
|
+
/** @description Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. */
|
|
148
|
+
cohortSpec?: components["schemas"]["CohortSpec"];
|
|
149
|
+
/** @description Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified. */
|
|
150
|
+
dateRanges?: components["schemas"]["DateRange"][];
|
|
151
|
+
/**
|
|
152
|
+
* Format: int64
|
|
153
|
+
* @description The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
154
|
+
*/
|
|
155
|
+
offset?: string;
|
|
156
|
+
/** @description The dimensions requested and displayed. */
|
|
157
|
+
dimensions?: components["schemas"]["Dimension"][];
|
|
158
|
+
/** @description A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234 */
|
|
159
|
+
property?: string;
|
|
160
|
+
/** @description Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response. */
|
|
161
|
+
comparisons?: components["schemas"]["Comparison"][];
|
|
162
|
+
/** @description The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. */
|
|
163
|
+
metricFilter?: components["schemas"]["FilterExpression"];
|
|
164
|
+
/** @description A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. */
|
|
165
|
+
currencyCode?: string;
|
|
166
|
+
/** @description Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges. */
|
|
167
|
+
metricAggregations?: ("METRIC_AGGREGATION_UNSPECIFIED" | "TOTAL" | "MINIMUM" | "MAXIMUM" | "COUNT")[];
|
|
168
|
+
/** @description The metrics requested and displayed. */
|
|
169
|
+
metrics?: components["schemas"]["Metric"][];
|
|
170
|
+
/**
|
|
171
|
+
* Format: int64
|
|
172
|
+
* @description The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
173
|
+
*/
|
|
174
|
+
limit?: string;
|
|
175
|
+
/** @description Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons. */
|
|
176
|
+
orderBys?: components["schemas"]["OrderBy"][];
|
|
177
|
+
};
|
|
178
|
+
/** @description Filters for numeric or date values. */
|
|
179
|
+
NumericFilter: {
|
|
180
|
+
/** @description A numeric value or a date value. */
|
|
181
|
+
value?: components["schemas"]["NumericValue"];
|
|
182
|
+
/**
|
|
183
|
+
* @description The operation type for this filter.
|
|
184
|
+
* @enum {string}
|
|
185
|
+
*/
|
|
186
|
+
operation?: "OPERATION_UNSPECIFIED" | "EQUAL" | "LESS_THAN" | "LESS_THAN_OR_EQUAL" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL";
|
|
187
|
+
};
|
|
188
|
+
/** @description Sorts by dimension values. */
|
|
189
|
+
DimensionOrderBy: {
|
|
190
|
+
/** @description A dimension name in the request to order by. */
|
|
191
|
+
dimensionName?: string;
|
|
192
|
+
/**
|
|
193
|
+
* @description Controls the rule for dimension value ordering.
|
|
194
|
+
* @enum {string}
|
|
195
|
+
*/
|
|
196
|
+
orderType?: "ORDER_TYPE_UNSPECIFIED" | "ALPHANUMERIC" | "CASE_INSENSITIVE_ALPHANUMERIC" | "NUMERIC";
|
|
197
|
+
};
|
|
198
|
+
/** @description Define the truncated date range from start_date to end_date. */
|
|
199
|
+
DataTruncationDateRange: {
|
|
200
|
+
/** @description The start date in the format YYYY-MM-DD (inclusive). */
|
|
201
|
+
startDate?: string;
|
|
202
|
+
/** @description The end date in the format YYYY-MM-DD (inclusive). */
|
|
203
|
+
endDate?: string;
|
|
204
|
+
};
|
|
205
|
+
/** @description A metric actively restricted in creating the report. */
|
|
206
|
+
ActiveMetricRestriction: {
|
|
207
|
+
/** @description The reason for this metric's restriction. */
|
|
208
|
+
restrictedMetricTypes?: ("RESTRICTED_METRIC_TYPE_UNSPECIFIED" | "COST_DATA" | "REVENUE_DATA")[];
|
|
209
|
+
/** @description The name of the restricted metric. */
|
|
210
|
+
metricName?: string;
|
|
211
|
+
};
|
|
212
|
+
/** @description Describes a reason for data truncation in the report. */
|
|
213
|
+
DataTruncationReason: {
|
|
214
|
+
/** @description The truncated date ranges. */
|
|
215
|
+
dataTruncationDateRanges?: components["schemas"]["DataTruncationDateRange"][];
|
|
216
|
+
/** @description The data truncation date in the format YYYY-MM-DD. Indicates data before this date is truncated. */
|
|
217
|
+
dataTruncationDate?: string;
|
|
218
|
+
/** @description A descriptive message explaining the data truncation. */
|
|
219
|
+
dataTruncationMessage?: string;
|
|
220
|
+
/**
|
|
221
|
+
* @description The type of data truncation.
|
|
222
|
+
* @enum {string}
|
|
223
|
+
*/
|
|
224
|
+
dataTruncationType?: "DATA_TRUNCATION_TYPE_UNSPECIFIED" | "DATA_TRUNCATION_TYPE_RULES_BASED_MODELS" | "DATA_TRUNCATION_TYPE_DATA_DRIVEN_ATTRIBUTION" | "DATA_TRUNCATION_TYPE_DV360" | "DATA_TRUNCATION_TYPE_CM360" | "DATA_TRUNCATION_TYPE_ITEM_SCOPED_ECOMMERCE_METRICS" | "DATA_TRUNCATION_TYPE_EVENT_SCOPED_ECOMMERCE_METRICS" | "DATA_TRUNCATION_TYPE_DATE_RANGE" | "DATA_TRUNCATION_TYPE_PROPERTY" | "DATA_TRUNCATION_TYPE_CONVERSIONS" | "DATA_TRUNCATION_TYPE_GOOGLE_ADS";
|
|
225
|
+
};
|
|
226
|
+
/** @description Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering. */
|
|
227
|
+
OrderBy: {
|
|
228
|
+
/** @description Sorts results by a dimension's values. */
|
|
229
|
+
dimension?: components["schemas"]["DimensionOrderBy"];
|
|
230
|
+
/** @description Sorts results by a metric's values. */
|
|
231
|
+
metric?: components["schemas"]["MetricOrderBy"];
|
|
232
|
+
/** @description If true, sorts by descending order. */
|
|
233
|
+
desc?: boolean;
|
|
234
|
+
/** @description Sorts results by a metric's values within a pivot column group. */
|
|
235
|
+
pivot?: components["schemas"]["PivotOrderBy"];
|
|
236
|
+
};
|
|
237
|
+
/** @description The dimensions, metrics and comparisons currently accepted in reporting methods. */
|
|
238
|
+
Metadata: {
|
|
239
|
+
/** @description The dimension descriptions. */
|
|
240
|
+
dimensions?: components["schemas"]["DimensionMetadata"][];
|
|
241
|
+
/** @description The metric descriptions. */
|
|
242
|
+
metrics?: components["schemas"]["MetricMetadata"][];
|
|
243
|
+
/** @description The comparison descriptions. */
|
|
244
|
+
comparisons?: components["schemas"]["ComparisonMetadata"][];
|
|
245
|
+
/** @description Resource name of this metadata. */
|
|
246
|
+
name?: string;
|
|
247
|
+
};
|
|
248
|
+
/** @description To express that the result needs to be between two numbers (inclusive). */
|
|
249
|
+
BetweenFilter: {
|
|
250
|
+
/** @description Ends with this number. */
|
|
251
|
+
toValue?: components["schemas"]["NumericValue"];
|
|
252
|
+
/** @description Begins with this number. */
|
|
253
|
+
fromValue?: components["schemas"]["NumericValue"];
|
|
254
|
+
};
|
|
255
|
+
/** @description Explains a metric. */
|
|
256
|
+
MetricMetadata: {
|
|
257
|
+
/** @description A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`. */
|
|
258
|
+
apiName?: string;
|
|
259
|
+
/** @description True if the metric is a custom metric for this property. */
|
|
260
|
+
customDefinition?: boolean;
|
|
261
|
+
/** @description The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together. */
|
|
262
|
+
category?: string;
|
|
263
|
+
/** @description If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). */
|
|
264
|
+
blockedReasons?: ("BLOCKED_REASON_UNSPECIFIED" | "NO_REVENUE_METRICS" | "NO_COST_METRICS")[];
|
|
265
|
+
/** @description The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty. */
|
|
266
|
+
expression?: string;
|
|
267
|
+
/** @description Description of how this metric is used and calculated. */
|
|
268
|
+
description?: string;
|
|
269
|
+
/**
|
|
270
|
+
* @description The type of this metric.
|
|
271
|
+
* @enum {string}
|
|
272
|
+
*/
|
|
273
|
+
type?: "METRIC_TYPE_UNSPECIFIED" | "TYPE_INTEGER" | "TYPE_FLOAT" | "TYPE_SECONDS" | "TYPE_MILLISECONDS" | "TYPE_MINUTES" | "TYPE_HOURS" | "TYPE_STANDARD" | "TYPE_CURRENCY" | "TYPE_FEET" | "TYPE_MILES" | "TYPE_METERS" | "TYPE_KILOMETERS";
|
|
274
|
+
/** @description This metric's name within the Google Analytics user interface. For example, `Event count`. */
|
|
275
|
+
uiName?: string;
|
|
276
|
+
/** @description Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`. */
|
|
277
|
+
deprecatedApiNames?: string[];
|
|
278
|
+
};
|
|
279
|
+
/** @description A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`. Requests are allowed up to 4 date ranges. */
|
|
280
|
+
DateRange: {
|
|
281
|
+
/** @description Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc. */
|
|
282
|
+
name?: string;
|
|
283
|
+
/** @description The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone. */
|
|
284
|
+
endDate?: string;
|
|
285
|
+
/** @description The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone. */
|
|
286
|
+
startDate?: string;
|
|
287
|
+
};
|
|
288
|
+
/** @description The response report table corresponding to a request. */
|
|
289
|
+
RunReportResponse: {
|
|
290
|
+
/** @description If requested, the maximum values of metrics. */
|
|
291
|
+
maximums?: components["schemas"]["Row"][];
|
|
292
|
+
/** @description If requested, the minimum values of metrics. */
|
|
293
|
+
minimums?: components["schemas"]["Row"][];
|
|
294
|
+
/**
|
|
295
|
+
* Format: int32
|
|
296
|
+
* @description The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
|
|
297
|
+
*/
|
|
298
|
+
rowCount?: number;
|
|
299
|
+
/** @description Metadata for the report. */
|
|
300
|
+
metadata?: components["schemas"]["ResponseMetaData"];
|
|
301
|
+
/** @description Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runReport". Useful to distinguish between response types in JSON. */
|
|
302
|
+
kind?: string;
|
|
303
|
+
/** @description This Google Analytics property's quota state including this request. */
|
|
304
|
+
propertyQuota?: components["schemas"]["PropertyQuota"];
|
|
305
|
+
/** @description Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. */
|
|
306
|
+
metricHeaders?: components["schemas"]["MetricHeader"][];
|
|
307
|
+
/** @description Rows of dimension value combinations and metric values in the report. */
|
|
308
|
+
rows?: components["schemas"]["Row"][];
|
|
309
|
+
/** @description If requested, the totaled values of metrics. */
|
|
310
|
+
totals?: components["schemas"]["Row"][];
|
|
311
|
+
/** @description Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. */
|
|
312
|
+
dimensionHeaders?: components["schemas"]["DimensionHeader"][];
|
|
313
|
+
};
|
|
314
|
+
/** @description The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object. For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report. */
|
|
315
|
+
CohortSpec: {
|
|
316
|
+
/** @description Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name. */
|
|
317
|
+
cohorts?: components["schemas"]["Cohort"][];
|
|
318
|
+
/** @description Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over. */
|
|
319
|
+
cohortsRange?: components["schemas"]["CohortsRange"];
|
|
320
|
+
/** @description Optional settings for a cohort report. */
|
|
321
|
+
cohortReportSettings?: components["schemas"]["CohortReportSettings"];
|
|
322
|
+
};
|
|
323
|
+
/** @description A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|---------------- */
|
|
324
|
+
PivotSelection: {
|
|
325
|
+
/** @description Must be a dimension name from the request. */
|
|
326
|
+
dimensionName?: string;
|
|
327
|
+
/** @description Order by only when the named dimension is this value. */
|
|
328
|
+
dimensionValue?: string;
|
|
329
|
+
};
|
|
330
|
+
/** @description The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). */
|
|
331
|
+
SchemaRestrictionResponse: {
|
|
332
|
+
/** @description All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`. */
|
|
333
|
+
activeMetricRestrictions?: components["schemas"]["ActiveMetricRestriction"][];
|
|
334
|
+
};
|
|
335
|
+
/** @description Used to combine dimension values to a single dimension. */
|
|
336
|
+
ConcatenateExpression: {
|
|
337
|
+
/** @description Names of dimensions. The names must refer back to names in the dimensions field of the request. */
|
|
338
|
+
dimensionNames?: string[];
|
|
339
|
+
/** @description The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". */
|
|
340
|
+
delimiter?: string;
|
|
341
|
+
};
|
|
342
|
+
/** @description Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over. */
|
|
343
|
+
CohortsRange: {
|
|
344
|
+
/**
|
|
345
|
+
* Format: int32
|
|
346
|
+
* @description `startOffset` specifies the start date of the extended reporting date range for a cohort report. `startOffset` is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If `granularity` is `DAILY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is `MONTHLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days.
|
|
347
|
+
*/
|
|
348
|
+
startOffset?: number;
|
|
349
|
+
/**
|
|
350
|
+
* Format: int32
|
|
351
|
+
* @description Required. `endOffset` specifies the end date of the extended reporting date range for a cohort report. `endOffset` can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If `granularity` is `DAILY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 30` days.
|
|
352
|
+
*/
|
|
353
|
+
endOffset?: number;
|
|
354
|
+
/**
|
|
355
|
+
* @description Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report.
|
|
356
|
+
* @enum {string}
|
|
357
|
+
*/
|
|
358
|
+
granularity?: "GRANULARITY_UNSPECIFIED" | "DAILY" | "WEEKLY" | "MONTHLY";
|
|
359
|
+
};
|
|
360
|
+
/** @description Defines an individual comparison. Most requests will include multiple comparisons so that the report compares between the comparisons. */
|
|
361
|
+
Comparison: {
|
|
362
|
+
/** @description A basic comparison. */
|
|
363
|
+
dimensionFilter?: components["schemas"]["FilterExpression"];
|
|
364
|
+
/** @description A saved comparison identified by the comparison's resource name. For example, 'comparisons/1234'. */
|
|
365
|
+
comparison?: string;
|
|
366
|
+
/** @description Each comparison produces separate rows in the response. In the response, this comparison is identified by this name. If name is unspecified, we will use the saved comparisons display name. */
|
|
367
|
+
name?: string;
|
|
368
|
+
};
|
|
369
|
+
/** @description Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). */
|
|
370
|
+
DimensionExpression: {
|
|
371
|
+
/** @description Used to convert a dimension value to lower case. */
|
|
372
|
+
lowerCase?: components["schemas"]["CaseExpression"];
|
|
373
|
+
/** @description Used to convert a dimension value to upper case. */
|
|
374
|
+
upperCase?: components["schemas"]["CaseExpression"];
|
|
375
|
+
/** @description Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city). */
|
|
376
|
+
concatenate?: components["schemas"]["ConcatenateExpression"];
|
|
377
|
+
};
|
|
378
|
+
/** @description Explains a dimension. */
|
|
379
|
+
DimensionMetadata: {
|
|
380
|
+
/** @description True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316. */
|
|
381
|
+
customDefinition?: boolean;
|
|
382
|
+
/** @description The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together. */
|
|
383
|
+
category?: string;
|
|
384
|
+
/** @description Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`. */
|
|
385
|
+
deprecatedApiNames?: string[];
|
|
386
|
+
/** @description This dimension's name within the Google Analytics user interface. For example, `Event name`. */
|
|
387
|
+
uiName?: string;
|
|
388
|
+
/** @description Description of how this dimension is used and calculated. */
|
|
389
|
+
description?: string;
|
|
390
|
+
/** @description This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`. */
|
|
391
|
+
apiName?: string;
|
|
392
|
+
};
|
|
393
|
+
/** @description Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. */
|
|
394
|
+
PropertyQuota: {
|
|
395
|
+
/** @description Analytics Properties can use up to 35% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 14,000 tokens per project per hour, and Analytics 360 Properties can use 140,000 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas. */
|
|
396
|
+
tokensPerProjectPerHour?: components["schemas"]["QuotaStatus"];
|
|
397
|
+
/** @description Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests. */
|
|
398
|
+
concurrentRequests?: components["schemas"]["QuotaStatus"];
|
|
399
|
+
/** @description Standard Analytics Properties can use up to 200,000 tokens per day; Analytics 360 Properties can use 2,000,000 tokens per day. Most requests consume fewer than 10 tokens. */
|
|
400
|
+
tokensPerDay?: components["schemas"]["QuotaStatus"];
|
|
401
|
+
/** @description Standard Analytics Properties can use up to 40,000 tokens per hour; Analytics 360 Properties can use 400,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas. */
|
|
402
|
+
tokensPerHour?: components["schemas"]["QuotaStatus"];
|
|
403
|
+
/** @description Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour. */
|
|
404
|
+
serverErrorsPerProjectPerHour?: components["schemas"]["QuotaStatus"];
|
|
405
|
+
/** @description Analytics Properties can send up to 120 requests with potentially thresholded dimensions per hour. In a batch request, each report request is individually counted for this quota if the request contains potentially thresholded dimensions. */
|
|
406
|
+
potentiallyThresholdedRequestsPerHour?: components["schemas"]["QuotaStatus"];
|
|
407
|
+
};
|
|
408
|
+
/** @description Sorts by metric values. */
|
|
409
|
+
MetricOrderBy: {
|
|
410
|
+
/** @description A metric name in the request to order by. */
|
|
411
|
+
metricName?: string;
|
|
412
|
+
};
|
|
413
|
+
/** @description The value of a dimension. */
|
|
414
|
+
DimensionValue: {
|
|
415
|
+
/** @description Value as a string if the dimension type is a string. */
|
|
416
|
+
value?: string;
|
|
417
|
+
};
|
|
418
|
+
/** @description The metadata for a single comparison. */
|
|
419
|
+
ComparisonMetadata: {
|
|
420
|
+
/** @description This comparison's resource name. Useable in [Comparison](#Comparison)'s `comparison` field. For example, 'comparisons/1234'. */
|
|
421
|
+
apiName?: string;
|
|
422
|
+
/** @description This comparison's description. */
|
|
423
|
+
description?: string;
|
|
424
|
+
/** @description This comparison's name within the Google Analytics user interface. */
|
|
425
|
+
uiName?: string;
|
|
426
|
+
};
|
|
427
|
+
/** @description The filter for string */
|
|
428
|
+
StringFilter: {
|
|
429
|
+
/**
|
|
430
|
+
* @description The match type for this filter.
|
|
431
|
+
* @enum {string}
|
|
432
|
+
*/
|
|
433
|
+
matchType?: "MATCH_TYPE_UNSPECIFIED" | "EXACT" | "BEGINS_WITH" | "ENDS_WITH" | "CONTAINS" | "FULL_REGEXP" | "PARTIAL_REGEXP";
|
|
434
|
+
/** @description If true, the string value is case sensitive. */
|
|
435
|
+
caseSensitive?: boolean;
|
|
436
|
+
/** @description The string value used for the matching. */
|
|
437
|
+
value?: string;
|
|
438
|
+
};
|
|
439
|
+
/** @description Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers. */
|
|
440
|
+
MetricHeader: {
|
|
441
|
+
/** @description The metric's name. */
|
|
442
|
+
name?: string;
|
|
443
|
+
/**
|
|
444
|
+
* @description The metric's data type.
|
|
445
|
+
* @enum {string}
|
|
446
|
+
*/
|
|
447
|
+
type?: "METRIC_TYPE_UNSPECIFIED" | "TYPE_INTEGER" | "TYPE_FLOAT" | "TYPE_SECONDS" | "TYPE_MILLISECONDS" | "TYPE_MINUTES" | "TYPE_HOURS" | "TYPE_STANDARD" | "TYPE_CURRENCY" | "TYPE_FEET" | "TYPE_MILES" | "TYPE_METERS" | "TYPE_KILOMETERS";
|
|
448
|
+
};
|
|
449
|
+
/** @description The result needs to be in a list of string values. */
|
|
450
|
+
InListFilter: {
|
|
451
|
+
/** @description The list of string values. Must be non-empty. */
|
|
452
|
+
values?: string[];
|
|
453
|
+
/** @description If true, the string value is case sensitive. */
|
|
454
|
+
caseSensitive?: boolean;
|
|
455
|
+
};
|
|
456
|
+
/** @description An expression to filter dimension or metric values. */
|
|
457
|
+
Filter: {
|
|
458
|
+
/** @description The dimension name or metric name. In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics. */
|
|
459
|
+
fieldName?: string;
|
|
460
|
+
/** @description A filter for in list values. */
|
|
461
|
+
inListFilter?: components["schemas"]["InListFilter"];
|
|
462
|
+
/** @description A filter for numeric or date values. */
|
|
463
|
+
numericFilter?: components["schemas"]["NumericFilter"];
|
|
464
|
+
/** @description A filter for empty values such as `(not set)` and `""` values. */
|
|
465
|
+
emptyFilter?: components["schemas"]["EmptyFilter"];
|
|
466
|
+
/** @description Strings related filter. */
|
|
467
|
+
stringFilter?: components["schemas"]["StringFilter"];
|
|
468
|
+
/** @description A filter for two values. */
|
|
469
|
+
betweenFilter?: components["schemas"]["BetweenFilter"];
|
|
470
|
+
};
|
|
471
|
+
/** @description The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics. */
|
|
472
|
+
Metric: {
|
|
473
|
+
/** @description Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`. */
|
|
474
|
+
invisible?: boolean;
|
|
475
|
+
/** @description The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics) for the list of metric names supported by the `runRealtimeReport` method. See [Funnel Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics) for the list of metric names supported by the `runFunnelReport` method. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`. */
|
|
476
|
+
name?: string;
|
|
477
|
+
/** @description A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`. */
|
|
478
|
+
expression?: string;
|
|
479
|
+
};
|
|
480
|
+
/** @description Used to convert a dimension value to a single case. */
|
|
481
|
+
CaseExpression: {
|
|
482
|
+
/** @description Name of a dimension. The name must refer back to a name in dimensions field of the request. */
|
|
483
|
+
dimensionName?: string;
|
|
484
|
+
};
|
|
485
|
+
/** @description Response's metadata carrying additional information about the report content. */
|
|
486
|
+
ResponseMetaData: {
|
|
487
|
+
/** @description If empty reason is specified, the report is empty for this reason. */
|
|
488
|
+
emptyReason?: string;
|
|
489
|
+
/** @description The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". */
|
|
490
|
+
timeZone?: string;
|
|
491
|
+
/** @description If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. */
|
|
492
|
+
samplingMetadatas?: components["schemas"]["SamplingMetadata"][];
|
|
493
|
+
/** @description If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). */
|
|
494
|
+
dataLossFromOtherRow?: boolean;
|
|
495
|
+
/** @description If set, indicate there is data truncation in the report. */
|
|
496
|
+
dataTruncationReasons?: components["schemas"]["DataTruncationReason"][];
|
|
497
|
+
/** @description The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179. */
|
|
498
|
+
currencyCode?: string;
|
|
499
|
+
/** @description Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). */
|
|
500
|
+
schemaRestrictionResponse?: components["schemas"]["SchemaRestrictionResponse"];
|
|
501
|
+
/** @description If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630). */
|
|
502
|
+
subjectToThresholding?: boolean;
|
|
503
|
+
};
|
|
504
|
+
/** @description Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. */
|
|
505
|
+
Dimension: {
|
|
506
|
+
/** @description One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city). */
|
|
507
|
+
dimensionExpression?: components["schemas"]["DimensionExpression"];
|
|
508
|
+
/** @description The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions) for the list of dimension names supported by the `runRealtimeReport` method. See [Funnel Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions) for the list of dimension names supported by the `runFunnelReport` method. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`. */
|
|
509
|
+
name?: string;
|
|
510
|
+
};
|
|
511
|
+
};
|
|
512
|
+
responses: never;
|
|
513
|
+
parameters: never;
|
|
514
|
+
requestBodies: never;
|
|
515
|
+
headers: never;
|
|
516
|
+
pathItems: never;
|
|
517
|
+
};
|
|
518
|
+
export type SchemaQuotaStatus = components["schemas"]["QuotaStatus"];
|
|
519
|
+
export type SchemaDimensionHeader = components["schemas"]["DimensionHeader"];
|
|
520
|
+
export type SchemaFilterExpression = components["schemas"]["FilterExpression"];
|
|
521
|
+
export type SchemaRow = components["schemas"]["Row"];
|
|
522
|
+
export type SchemaNumericValue = components["schemas"]["NumericValue"];
|
|
523
|
+
export type SchemaCohortReportSettings = components["schemas"]["CohortReportSettings"];
|
|
524
|
+
export type SchemaFilterExpressionList = components["schemas"]["FilterExpressionList"];
|
|
525
|
+
export type SchemaPivotOrderBy = components["schemas"]["PivotOrderBy"];
|
|
526
|
+
export type SchemaMetricValue = components["schemas"]["MetricValue"];
|
|
527
|
+
export type SchemaSamplingMetadata = components["schemas"]["SamplingMetadata"];
|
|
528
|
+
export type SchemaEmptyFilter = components["schemas"]["EmptyFilter"];
|
|
529
|
+
export type SchemaCohort = components["schemas"]["Cohort"];
|
|
530
|
+
export type SchemaRunReportRequest = components["schemas"]["RunReportRequest"];
|
|
531
|
+
export type SchemaNumericFilter = components["schemas"]["NumericFilter"];
|
|
532
|
+
export type SchemaDimensionOrderBy = components["schemas"]["DimensionOrderBy"];
|
|
533
|
+
export type SchemaDataTruncationDateRange = components["schemas"]["DataTruncationDateRange"];
|
|
534
|
+
export type SchemaActiveMetricRestriction = components["schemas"]["ActiveMetricRestriction"];
|
|
535
|
+
export type SchemaDataTruncationReason = components["schemas"]["DataTruncationReason"];
|
|
536
|
+
export type SchemaOrderBy = components["schemas"]["OrderBy"];
|
|
537
|
+
export type SchemaMetadata = components["schemas"]["Metadata"];
|
|
538
|
+
export type SchemaBetweenFilter = components["schemas"]["BetweenFilter"];
|
|
539
|
+
export type SchemaMetricMetadata = components["schemas"]["MetricMetadata"];
|
|
540
|
+
export type SchemaDateRange = components["schemas"]["DateRange"];
|
|
541
|
+
export type SchemaRunReportResponse = components["schemas"]["RunReportResponse"];
|
|
542
|
+
export type SchemaCohortSpec = components["schemas"]["CohortSpec"];
|
|
543
|
+
export type SchemaPivotSelection = components["schemas"]["PivotSelection"];
|
|
544
|
+
export type SchemaSchemaRestrictionResponse = components["schemas"]["SchemaRestrictionResponse"];
|
|
545
|
+
export type SchemaConcatenateExpression = components["schemas"]["ConcatenateExpression"];
|
|
546
|
+
export type SchemaCohortsRange = components["schemas"]["CohortsRange"];
|
|
547
|
+
export type SchemaComparison = components["schemas"]["Comparison"];
|
|
548
|
+
export type SchemaDimensionExpression = components["schemas"]["DimensionExpression"];
|
|
549
|
+
export type SchemaDimensionMetadata = components["schemas"]["DimensionMetadata"];
|
|
550
|
+
export type SchemaPropertyQuota = components["schemas"]["PropertyQuota"];
|
|
551
|
+
export type SchemaMetricOrderBy = components["schemas"]["MetricOrderBy"];
|
|
552
|
+
export type SchemaDimensionValue = components["schemas"]["DimensionValue"];
|
|
553
|
+
export type SchemaComparisonMetadata = components["schemas"]["ComparisonMetadata"];
|
|
554
|
+
export type SchemaStringFilter = components["schemas"]["StringFilter"];
|
|
555
|
+
export type SchemaMetricHeader = components["schemas"]["MetricHeader"];
|
|
556
|
+
export type SchemaInListFilter = components["schemas"]["InListFilter"];
|
|
557
|
+
export type SchemaFilter = components["schemas"]["Filter"];
|
|
558
|
+
export type SchemaMetric = components["schemas"]["Metric"];
|
|
559
|
+
export type SchemaCaseExpression = components["schemas"]["CaseExpression"];
|
|
560
|
+
export type SchemaResponseMetaData = components["schemas"]["ResponseMetaData"];
|
|
561
|
+
export type SchemaDimension = components["schemas"]["Dimension"];
|
|
562
|
+
export type $defs = Record<string, never>;
|
|
563
|
+
export interface operations {
|
|
564
|
+
"properties.runReport": {
|
|
565
|
+
parameters: {
|
|
566
|
+
query?: never;
|
|
567
|
+
header?: never;
|
|
568
|
+
path: {
|
|
569
|
+
property: string;
|
|
570
|
+
};
|
|
571
|
+
cookie?: never;
|
|
572
|
+
};
|
|
573
|
+
requestBody: {
|
|
574
|
+
content: {
|
|
575
|
+
"application/json": components["schemas"]["RunReportRequest"];
|
|
576
|
+
};
|
|
577
|
+
};
|
|
578
|
+
responses: {
|
|
579
|
+
/** @description A successful response. */
|
|
580
|
+
200: {
|
|
581
|
+
headers: {
|
|
582
|
+
[name: string]: unknown;
|
|
583
|
+
};
|
|
584
|
+
content: {
|
|
585
|
+
"application/json": components["schemas"]["RunReportResponse"];
|
|
586
|
+
};
|
|
587
|
+
};
|
|
588
|
+
};
|
|
589
|
+
};
|
|
590
|
+
"properties.getMetadata": {
|
|
591
|
+
parameters: {
|
|
592
|
+
query?: never;
|
|
593
|
+
header?: never;
|
|
594
|
+
path: {
|
|
595
|
+
property: string;
|
|
596
|
+
};
|
|
597
|
+
cookie?: never;
|
|
598
|
+
};
|
|
599
|
+
requestBody?: never;
|
|
600
|
+
responses: {
|
|
601
|
+
/** @description A successful response. */
|
|
602
|
+
200: {
|
|
603
|
+
headers: {
|
|
604
|
+
[name: string]: unknown;
|
|
605
|
+
};
|
|
606
|
+
content: {
|
|
607
|
+
"application/json": components["schemas"]["Metadata"];
|
|
608
|
+
};
|
|
609
|
+
};
|
|
610
|
+
};
|
|
611
|
+
};
|
|
612
|
+
}
|
|
613
|
+
//# sourceMappingURL=openapi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,MAAM,KAAK,GAAG;IAClB,kCAAkC,EAAE;QAClC,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,ioBAAioB;QACjoB,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;QACzC,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,OAAO,CAAC,EAAE,KAAK,CAAC;QAChB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;IACF,iCAAiC,EAAE;QACjC,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF,glBAAglB;QAChlB,GAAG,EAAE,UAAU,CAAC,wBAAwB,CAAC,CAAC;QAC1C,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,OAAO,CAAC,EAAE,KAAK,CAAC;QAChB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;CACH,CAAC;AACF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC7C,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE;QACP,+DAA+D;QAC/D,WAAW,EAAE;YACX;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,CAAC;QACF,0TAA0T;QAC1T,eAAe,EAAE;YACf,yCAAyC;YACzC,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QACF,oJAAoJ;QACpJ,gBAAgB,EAAE;YAChB,8EAA8E;YAC9E,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;YACxD,kEAAkE;YAClE,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;YAC1D,sJAAsJ;YACtJ,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;YACzC,gFAAgF;YAChF,QAAQ,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;SAC1D,CAAC;QACF,ubAAub;QACvb,GAAG,EAAE;YACH,8IAA8I;YAC9I,eAAe,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC5D,4DAA4D;YAC5D,YAAY,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC;SACvD,CAAC;QACF,0CAA0C;QAC1C,YAAY,EAAE;YACZ;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,yDAAyD;QACzD,oBAAoB,EAAE;YACpB,6HAA6H;YAC7H,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB,CAAC;QACF,iDAAiD;QACjD,oBAAoB,EAAE;YACpB,iDAAiD;YACjD,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC;SAC3D,CAAC;QACF,kDAAkD;QAClD,YAAY,EAAE;YACZ,mHAAmH;YACnH,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,4OAA4O;YAC5O,eAAe,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC;SAC7D,CAAC;QACF,0CAA0C;QAC1C,WAAW,EAAE;YACX,iEAAiE;YACjE,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,6SAA6S;QAC7S,gBAAgB,EAAE;YAChB;;;eAGG;YACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAC1B;;;eAGG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;SAC5B,CAAC;QACF,oTAAoT;QACpT,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACrC,uMAAuM;QACvM,MAAM,EAAE;YACN,gGAAgG;YAChG,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,m/BAAm/B;YACn/B,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;YAC/C,+PAA+P;YAC/P,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QACF,qDAAqD;QACrD,gBAAgB,EAAE;YAChB,gKAAgK;YAChK,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAC9B,6SAA6S;YAC7S,eAAe,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;YAC5D,qfAAqf;YACrf,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,gJAAgJ;YAChJ,UAAU,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;YACjD,4UAA4U;YAC5U,UAAU,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;YAClD;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,2DAA2D;YAC3D,UAAU,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;YAClD,+YAA+Y;YAC/Y,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,8LAA8L;YAC9L,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC;YACpD,sKAAsK;YACtK,YAAY,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;YACzD,2JAA2J;YAC3J,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,4QAA4Q;YAC5Q,kBAAkB,CAAC,EAAE,CACjB,gCAAgC,GAChC,OAAO,GACP,SAAS,GACT,SAAS,GACT,OAAO,CACV,EAAE,CAAC;YACJ,wDAAwD;YACxD,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,gLAAgL;YAChL,QAAQ,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;SAC/C,CAAC;QACF,uDAAuD;QACvD,aAAa,EAAE;YACb,oDAAoD;YACpD,KAAK,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;YAC9C;;;eAGG;YACH,SAAS,CAAC,EACN,uBAAuB,GACvB,OAAO,GACP,WAAW,GACX,oBAAoB,GACpB,cAAc,GACd,uBAAuB,CAAC;SAC7B,CAAC;QACF,8CAA8C;QAC9C,gBAAgB,EAAE;YAChB,gEAAgE;YAChE,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB;;;eAGG;YACH,SAAS,CAAC,EACN,wBAAwB,GACxB,cAAc,GACd,+BAA+B,GAC/B,SAAS,CAAC;SACf,CAAC;QACF,gFAAgF;QAChF,uBAAuB,EAAE;YACvB,wEAAwE;YACxE,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,sEAAsE;YACtE,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,wEAAwE;QACxE,uBAAuB,EAAE;YACvB,6DAA6D;YAC7D,qBAAqB,CAAC,EAAE,CACpB,oCAAoC,GACpC,WAAW,GACX,cAAc,CACjB,EAAE,CAAC;YACJ,sDAAsD;YACtD,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,yEAAyE;QACzE,oBAAoB,EAAE;YACpB,8CAA8C;YAC9C,wBAAwB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,EAAE,CAAC;YAC9E,oHAAoH;YACpH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAC5B,yEAAyE;YACzE,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAC/B;;;eAGG;YACH,kBAAkB,CAAC,EACf,kCAAkC,GAClC,yCAAyC,GACzC,8CAA8C,GAC9C,4BAA4B,GAC5B,4BAA4B,GAC5B,oDAAoD,GACpD,qDAAqD,GACrD,iCAAiC,GACjC,+BAA+B,GAC/B,kCAAkC,GAClC,iCAAiC,CAAC;SACvC,CAAC;QACF,uNAAuN;QACvN,OAAO,EAAE;YACP,0DAA0D;YAC1D,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;YACtD,uDAAuD;YACvD,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;YAChD,uDAAuD;YACvD,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,mFAAmF;YACnF,KAAK,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;SAC/C,CAAC;QACF,oGAAoG;QACpG,QAAQ,EAAE;YACR,+CAA+C;YAC/C,UAAU,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC1D,4CAA4C;YAC5C,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpD,gDAAgD;YAChD,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC5D,mDAAmD;YACnD,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QACF,2FAA2F;QAC3F,aAAa,EAAE;YACb,0CAA0C;YAC1C,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;YAChD,4CAA4C;YAC5C,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;SACnD,CAAC;QACF,sCAAsC;QACtC,cAAc,EAAE;YACd,oGAAoG;YACpG,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,4EAA4E;YAC5E,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAC3B,2IAA2I;YAC3I,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,gdAAgd;YAChd,cAAc,CAAC,EAAE,CAAC,4BAA4B,GAAG,oBAAoB,GAAG,iBAAiB,CAAC,EAAE,CAAC;YAC7F,sOAAsO;YACtO,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,0EAA0E;YAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB;;;eAGG;YACH,IAAI,CAAC,EACD,yBAAyB,GACzB,cAAc,GACd,YAAY,GACZ,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,YAAY,GACZ,eAAe,GACf,eAAe,GACf,WAAW,GACX,YAAY,GACZ,aAAa,GACb,iBAAiB,CAAC;YACtB,8GAA8G;YAC9G,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,oQAAoQ;YACpQ,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;SAC/B,CAAC;QACF,qIAAqI;QACrI,SAAS,EAAE;YACT,sSAAsS;YACtS,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,wQAAwQ;YACxQ,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,uQAAuQ;YACvQ,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,CAAC;QACF,yEAAyE;QACzE,iBAAiB,EAAE;YACjB,gEAAgE;YAChE,QAAQ,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1C,gEAAgE;YAChE,QAAQ,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1C;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,4CAA4C;YAC5C,QAAQ,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;YACrD,6LAA6L;YAC7L,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,wFAAwF;YACxF,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;YACvD,4IAA4I;YAC5I,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC;YACxD,yFAAyF;YACzF,IAAI,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,gEAAgE;YAChE,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,wJAAwJ;YACxJ,gBAAgB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,EAAE,CAAC;SAC/D,CAAC;QACF,o5BAAo5B;QACp5B,UAAU,EAAE;YACV,8NAA8N;YAC9N,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,4JAA4J;YAC5J,YAAY,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;YACrD,0DAA0D;YAC1D,oBAAoB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;SACtE,CAAC;QACF,guBAAguB;QAChuB,cAAc,EAAE;YACd,8DAA8D;YAC9D,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,yEAAyE;YACzE,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB,CAAC;QACF,yMAAyM;QACzM,yBAAyB,EAAE;YACzB,uRAAuR;YACvR,wBAAwB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,EAAE,CAAC;SAC/E,CAAC;QACF,2EAA2E;QAC3E,qBAAqB,EAAE;YACrB,mHAAmH;YACnH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;YAC1B,+XAA+X;YAC/X,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,CAAC;QACF,8IAA8I;QAC9I,YAAY,EAAE;YACZ;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB;;;eAGG;YACH,WAAW,CAAC,EAAE,yBAAyB,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;SAC1E,CAAC;QACF,0JAA0J;QAC1J,UAAU,EAAE;YACV,uCAAuC;YACvC,eAAe,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;YAC5D,qHAAqH;YACrH,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,gNAAgN;YAChN,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QACF,iMAAiM;QACjM,mBAAmB,EAAE;YACnB,oEAAoE;YACpE,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;YACpD,oEAAoE;YACpE,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;YACpD,qJAAqJ;YACrJ,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;SAC9D,CAAC;QACF,yCAAyC;QACzC,iBAAiB,EAAE;YACjB,gXAAgX;YAChX,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAC3B,6IAA6I;YAC7I,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,6QAA6Q;YAC7Q,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;YAC9B,gHAAgH;YAChH,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,6EAA6E;YAC7E,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,iHAAiH;YACjH,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,2LAA2L;QAC3L,aAAa,EAAE;YACb,uZAAuZ;YACvZ,uBAAuB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;YAC/D,uJAAuJ;YACvJ,kBAAkB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;YAC1D,8LAA8L;YAC9L,YAAY,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;YACpD,8RAA8R;YAC9R,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;YACrD,8MAA8M;YAC9M,6BAA6B,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;YACrE,iQAAiQ;YACjQ,qCAAqC,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;SAC9E,CAAC;QACF,2CAA2C;QAC3C,aAAa,EAAE;YACb,6DAA6D;YAC7D,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,6CAA6C;QAC7C,cAAc,EAAE;YACd,wEAAwE;YACxE,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,yDAAyD;QACzD,kBAAkB,EAAE;YAClB,gJAAgJ;YAChJ,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,kDAAkD;YAClD,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,sFAAsF;YACtF,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,yCAAyC;QACzC,YAAY,EAAE;YACZ;;;eAGG;YACH,SAAS,CAAC,EACN,wBAAwB,GACxB,OAAO,GACP,aAAa,GACb,WAAW,GACX,UAAU,GACV,aAAa,GACb,gBAAgB,CAAC;YACrB,gEAAgE;YAChE,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,2DAA2D;YAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,mTAAmT;QACnT,YAAY,EAAE;YACZ,sCAAsC;YACtC,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;;eAGG;YACH,IAAI,CAAC,EACD,yBAAyB,GACzB,cAAc,GACd,YAAY,GACZ,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,YAAY,GACZ,eAAe,GACf,eAAe,GACf,WAAW,GACX,YAAY,GACZ,aAAa,GACb,iBAAiB,CAAC;SACvB,CAAC;QACF,sEAAsE;QACtE,YAAY,EAAE;YACZ,iEAAiE;YACjE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;YAClB,gEAAgE;YAChE,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,CAAC;QACF,uEAAuE;QACvE,MAAM,EAAE;YACN,sRAAsR;YACtR,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,gDAAgD;YAChD,YAAY,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;YACrD,wDAAwD;YACxD,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;YACvD,kFAAkF;YAClF,WAAW,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;YACnD,2CAA2C;YAC3C,YAAY,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;YACrD,4CAA4C;YAC5C,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;SACxD,CAAC;QACF,yKAAyK;QACzK,MAAM,EAAE;YACN,uOAAuO;YACvO,SAAS,CAAC,EAAE,OAAO,CAAC;YACpB,ihCAAihC;YACjhC,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,2IAA2I;YAC3I,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,uEAAuE;QACvE,cAAc,EAAE;YACd,+GAA+G;YAC/G,aAAa,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;QACF,iGAAiG;QACjG,gBAAgB,EAAE;YAChB,sFAAsF;YACtF,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,8QAA8Q;YAC9Q,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,2ZAA2Z;YAC3Z,iBAAiB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAChE,6uBAA6uB;YAC7uB,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAC/B,4EAA4E;YAC5E,qBAAqB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,EAAE,CAAC;YACxE,+iBAA+iB;YAC/iB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,mNAAmN;YACnN,yBAAyB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,2BAA2B,CAAC,CAAC;YAC/E,qaAAqa;YACra,qBAAqB,CAAC,EAAE,OAAO,CAAC;SACjC,CAAC;QACF,+RAA+R;QAC/R,SAAS,EAAE;YACT,sKAAsK;YACtK,mBAAmB,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC;YACnE,qlCAAqlC;YACrlC,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,SAAS,EAAE,KAAK,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;IAClB,aAAa,EAAE,KAAK,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,KAAK,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AACrE,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC;AAC7E,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAC/E,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC;AACrD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACvE,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AACvF,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AACvF,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACvE,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AACrE,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAC/E,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AACrE,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AAC3D,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAC/E,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACzE,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAC/E,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AAC7F,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAAC,CAAC;AAC7F,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC;AACvF,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AAC7D,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AAC/D,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACzE,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAC3E,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AACjF,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AACnE,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAC3E,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,2BAA2B,CAAC,CAAC;AACjG,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AACzF,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACvE,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AACnE,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC;AACrF,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AACjF,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACzE,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACzE,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAC3E,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AACnF,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACvE,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACvE,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AACvE,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AAC3D,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AAC3D,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAC3E,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAC/E,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AACjE,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,WAAW,UAAU;IACzB,sBAAsB,EAAE;QACtB,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,EAAE;gBACJ,QAAQ,EAAE,MAAM,CAAC;aAClB,CAAC;YACF,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF,WAAW,EAAE;YACX,OAAO,EAAE;gBACP,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;aAC/D,CAAC;SACH,CAAC;QACF,SAAS,EAAE;YACT,0CAA0C;YAC1C,GAAG,EAAE;gBACH,OAAO,EAAE;oBACP,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;iBACzB,CAAC;gBACF,OAAO,EAAE;oBACP,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;iBAChE,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,wBAAwB,EAAE;QACxB,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,EAAE;gBACJ,QAAQ,EAAE,MAAM,CAAC;aAClB,CAAC;YACF,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF,WAAW,CAAC,EAAE,KAAK,CAAC;QACpB,SAAS,EAAE;YACT,0CAA0C;YAC1C,GAAG,EAAE;gBACH,OAAO,EAAE;oBACP,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;iBACzB,CAAC;gBACF,OAAO,EAAE;oBACP,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;iBACvD,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;CACH"}
|
package/dist/openapi.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/** Generated from openapi.json. Do not edit. */
|
|
2
|
+
import type { BodyOf, Operation, RequestOf } from "@puppi/sdk";
|
|
3
|
+
import type { operations as spec } from "./openapi.js";
|
|
4
|
+
export type Api = {
|
|
5
|
+
responses: {
|
|
6
|
+
"properties.runReport": BodyOf<spec["properties.runReport"]>;
|
|
7
|
+
"properties.getMetadata": BodyOf<spec["properties.getMetadata"]>;
|
|
8
|
+
};
|
|
9
|
+
requests: {
|
|
10
|
+
"properties.runReport": RequestOf<spec["properties.runReport"]>;
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export declare const operations: Record<keyof Api["responses"], Operation>;
|
|
14
|
+
//# sourceMappingURL=operations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../src/operations.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAEhD,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE/D,OAAO,KAAK,EAAE,UAAU,IAAI,IAAI,EAAE,MAAM,cAAc,CAAC;AAEvD,MAAM,MAAM,GAAG,GAAG;IAChB,SAAS,EAAE;QACT,sBAAsB,EAAE,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC7D,wBAAwB,EAAE,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC;KAClE,CAAC;IACF,QAAQ,EAAE;QACR,sBAAsB,EAAE,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;KACjE,CAAC;CACH,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,WAAW,CAAC,EAAE,SAAS,CAWhE,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/** Generated from openapi.json. Do not edit. */
|
|
2
|
+
export const operations = {
|
|
3
|
+
"properties.runReport": {
|
|
4
|
+
method: "post",
|
|
5
|
+
path: "/properties/{property}:runReport",
|
|
6
|
+
query: [],
|
|
7
|
+
},
|
|
8
|
+
"properties.getMetadata": {
|
|
9
|
+
method: "get",
|
|
10
|
+
path: "/properties/{property}/metadata",
|
|
11
|
+
query: [],
|
|
12
|
+
},
|
|
13
|
+
};
|
|
14
|
+
//# sourceMappingURL=operations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"operations.js","sourceRoot":"","sources":["../src/operations.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAgBhD,MAAM,CAAC,MAAM,UAAU,GAA8C;IACnE,sBAAsB,EAAE;QACtB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,kCAAkC;QACxC,KAAK,EAAE,EAAE;KACV;IACD,wBAAwB,EAAE;QACxB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,iCAAiC;QACvC,KAAK,EAAE,EAAE;KACV;CACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,50 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@puppi/adapter-google-analytics",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Source connector for the Google Analytics Data API: bearer access token, property metadata, and paged core reports.",
|
|
5
|
+
"homepage": "https://github.com/DashJump/puppi",
|
|
6
|
+
"bugs": {
|
|
7
|
+
"url": "https://github.com/DashJump/puppi/issues"
|
|
8
|
+
},
|
|
9
|
+
"license": "Apache-2.0",
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git+https://github.com/DashJump/puppi.git",
|
|
13
|
+
"directory": "connectors/google-analytics"
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
18
|
+
],
|
|
19
|
+
"type": "module",
|
|
20
|
+
"main": "./dist/index.js",
|
|
21
|
+
"types": "./dist/index.d.ts",
|
|
22
|
+
"exports": {
|
|
23
|
+
".": {
|
|
24
|
+
"types": "./dist/index.d.ts",
|
|
25
|
+
"default": "./dist/index.js"
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"publishConfig": {
|
|
29
|
+
"access": "public"
|
|
30
|
+
},
|
|
31
|
+
"dependencies": {
|
|
32
|
+
"@puppi/sdk": "0.3.0"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"@puppi/conformance": "0.1.0",
|
|
36
|
+
"@types/node": "^26.6.5",
|
|
37
|
+
"openapi-typescript": "7.13.0",
|
|
38
|
+
"typescript": "^5.6.3",
|
|
39
|
+
"vite-plus": "1.7.0"
|
|
40
|
+
},
|
|
41
|
+
"engines": {
|
|
42
|
+
"node": ">=26"
|
|
43
|
+
},
|
|
44
|
+
"scripts": {
|
|
45
|
+
"generate": "openapi-typescript openapi.json -o src/openapi.ts --export-type --root-types --empty-objects-unknown --default-non-nullable=false && puppi-write-operations openapi.json src/operations.ts && vp fmt --write src/openapi.ts src/operations.ts",
|
|
46
|
+
"build": "tsc -p tsconfig.json",
|
|
47
|
+
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p test/tsconfig.json",
|
|
48
|
+
"test": "vp test run --config ../../vite.config.ts"
|
|
49
|
+
}
|
|
6
50
|
}
|