google-apis-youtube_analytics_v2 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-youtube_analytics_v2.rb +15 -0
- data/lib/google/apis/youtube_analytics_v2.rb +48 -0
- data/lib/google/apis/youtube_analytics_v2/classes.rb +505 -0
- data/lib/google/apis/youtube_analytics_v2/gem_version.rb +28 -0
- data/lib/google/apis/youtube_analytics_v2/representations.rb +232 -0
- data/lib/google/apis/youtube_analytics_v2/service.rb +460 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: eb3a2538733d318a0af1cb6d6f198943987795fa260acabb11f7f36bfbf2853b
|
4
|
+
data.tar.gz: 5571d72563e36d7e5ef400caa58bae45778de4d496a969b1de9e7a79fd722bf0
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: af0f4de2394e4dd92082c93ff3fa9bfd20161436b300f6bd37383627ad6dfa637b4b5c4b09228adcc53be9648d12bf76ef438c6fcbe2d8a9dd8fa22b1c7fe145
|
7
|
+
data.tar.gz: c7b4562429178a7c46fde16559087ce5deb88c8138008a53a2894e60062fa03506b0e97c2e754ecf44a79b6ec29b804a6077815163c48f12ac692371314c073f
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-youtube_analytics_v2
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/youtube_analytics_v2/*.rb
|
9
|
+
lib/google/apis/youtube_analytics_v2.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
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.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V2 of the YouTube Analytics API
|
2
|
+
|
3
|
+
This is a simple client library for version V2 of the YouTube Analytics API. It provides:
|
4
|
+
|
5
|
+
* A client object that connects to the HTTP/JSON REST endpoint for the service.
|
6
|
+
* Ruby objects for data structures related to the service.
|
7
|
+
* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
|
8
|
+
* Control of retry, pagination, and timeouts.
|
9
|
+
|
10
|
+
Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
|
11
|
+
|
12
|
+
## Getting started
|
13
|
+
|
14
|
+
### Before you begin
|
15
|
+
|
16
|
+
There are a few setup steps you need to complete before you can use this library:
|
17
|
+
|
18
|
+
1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
|
19
|
+
2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
|
20
|
+
3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/youtubeanalytics.googleapis.com) in the console.
|
21
|
+
|
22
|
+
### Installation
|
23
|
+
|
24
|
+
Add this line to your application's Gemfile:
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
gem 'google-apis-youtube_analytics_v2', '~> 0.1'
|
28
|
+
```
|
29
|
+
|
30
|
+
And then execute:
|
31
|
+
|
32
|
+
```
|
33
|
+
$ bundle
|
34
|
+
```
|
35
|
+
|
36
|
+
Or install it yourself as:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install google-apis-youtube_analytics_v2
|
40
|
+
```
|
41
|
+
|
42
|
+
### Creating a client object
|
43
|
+
|
44
|
+
Once the gem is installed, you can load the client code and instantiate a client.
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
# Load the client
|
48
|
+
require "google/apis/youtube_analytics_v2"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::YoutubeAnalyticsV2::YouTubeAnalyticsService.new
|
52
|
+
|
53
|
+
# Authenticate calls
|
54
|
+
client.authentication = # ... use the googleauth gem to create credentials
|
55
|
+
```
|
56
|
+
|
57
|
+
See the class reference docs for information on the methods you can call from a client.
|
58
|
+
|
59
|
+
## Documentation
|
60
|
+
|
61
|
+
More detailed descriptions of the Google simple REST clients are available in two documents.
|
62
|
+
|
63
|
+
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
|
64
|
+
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
|
65
|
+
|
66
|
+
(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the YoutubeAnalytics service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the YouTube Analytics API, see the {Google::Apis::YoutubeAnalyticsV2::YouTubeAnalyticsService class reference docs}.
|
69
|
+
|
70
|
+
## Which client should I use?
|
71
|
+
|
72
|
+
Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
|
73
|
+
|
74
|
+
This library, `google-apis-youtube_analytics_v2`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
|
75
|
+
|
76
|
+
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
|
77
|
+
|
78
|
+
Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
|
79
|
+
|
80
|
+
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
|
+
|
82
|
+
The [product documentation](https://developers.google.com/youtube/analytics) may provide guidance regarding the preferred client library to use.
|
83
|
+
|
84
|
+
## Supported Ruby versions
|
85
|
+
|
86
|
+
This library is supported on Ruby 2.5+.
|
87
|
+
|
88
|
+
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
|
93
|
+
|
94
|
+
## Support
|
95
|
+
|
96
|
+
Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "google/apis/youtube_analytics_v2"
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/youtube_analytics_v2/service.rb'
|
16
|
+
require 'google/apis/youtube_analytics_v2/classes.rb'
|
17
|
+
require 'google/apis/youtube_analytics_v2/representations.rb'
|
18
|
+
require 'google/apis/youtube_analytics_v2/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# YouTube Analytics API
|
23
|
+
#
|
24
|
+
# Retrieves your YouTube Analytics data.
|
25
|
+
#
|
26
|
+
# @see https://developers.google.com/youtube/analytics
|
27
|
+
module YoutubeAnalyticsV2
|
28
|
+
# Version of the YouTube Analytics API this client connects to.
|
29
|
+
# This is NOT the gem version.
|
30
|
+
VERSION = 'V2'
|
31
|
+
|
32
|
+
# Manage your YouTube account
|
33
|
+
AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'
|
34
|
+
|
35
|
+
# View your YouTube account
|
36
|
+
AUTH_YOUTUBE_READONLY = 'https://www.googleapis.com/auth/youtube.readonly'
|
37
|
+
|
38
|
+
# View and manage your assets and associated content on YouTube
|
39
|
+
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'
|
40
|
+
|
41
|
+
# View monetary and non-monetary YouTube Analytics reports for your YouTube content
|
42
|
+
AUTH_YT_ANALYTICS_MONETARY_READONLY = 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly'
|
43
|
+
|
44
|
+
# View YouTube Analytics reports for your YouTube content
|
45
|
+
AUTH_YT_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/yt-analytics.readonly'
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,505 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'date'
|
16
|
+
require 'google/apis/core/base_service'
|
17
|
+
require 'google/apis/core/json_representation'
|
18
|
+
require 'google/apis/core/hashable'
|
19
|
+
require 'google/apis/errors'
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Apis
|
23
|
+
module YoutubeAnalyticsV2
|
24
|
+
|
25
|
+
# Empty response.
|
26
|
+
class EmptyResponse
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# Request Error information. The presence of an error field signals that the
|
30
|
+
# operation has failed.
|
31
|
+
# Corresponds to the JSON property `errors`
|
32
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::Errors]
|
33
|
+
attr_accessor :errors
|
34
|
+
|
35
|
+
def initialize(**args)
|
36
|
+
update!(**args)
|
37
|
+
end
|
38
|
+
|
39
|
+
# Update properties of this object
|
40
|
+
def update!(**args)
|
41
|
+
@errors = args[:errors] if args.key?(:errors)
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
# Describes one specific error.
|
46
|
+
class ErrorProto
|
47
|
+
include Google::Apis::Core::Hashable
|
48
|
+
|
49
|
+
# Error arguments, to be used when building user-friendly error messages given
|
50
|
+
# the error domain and code. Different error codes require different arguments.
|
51
|
+
# Corresponds to the JSON property `argument`
|
52
|
+
# @return [Array<String>]
|
53
|
+
attr_accessor :argument
|
54
|
+
|
55
|
+
# Error code in the error domain. This should correspond to a value of the enum
|
56
|
+
# type whose name is in domain. See the core error domain in error_domain.proto.
|
57
|
+
# Corresponds to the JSON property `code`
|
58
|
+
# @return [String]
|
59
|
+
attr_accessor :code
|
60
|
+
|
61
|
+
# Debugging information, which should not be shared externally.
|
62
|
+
# Corresponds to the JSON property `debugInfo`
|
63
|
+
# @return [String]
|
64
|
+
attr_accessor :debug_info
|
65
|
+
|
66
|
+
# Error domain. RoSy services can define their own domain and error codes. This
|
67
|
+
# should normally be the name of an enum type, such as: gdata.CoreErrorDomain
|
68
|
+
# Corresponds to the JSON property `domain`
|
69
|
+
# @return [String]
|
70
|
+
attr_accessor :domain
|
71
|
+
|
72
|
+
# A short explanation for the error, which can be shared outside Google. Please
|
73
|
+
# set domain, code and arguments whenever possible instead of this error message
|
74
|
+
# so that external APIs can build safe error messages themselves. External
|
75
|
+
# messages built in a RoSy interface will most likely refer to information and
|
76
|
+
# concepts that are not available externally and should not be exposed. It is
|
77
|
+
# safer if external APIs can understand the errors and decide what the error
|
78
|
+
# message should look like.
|
79
|
+
# Corresponds to the JSON property `externalErrorMessage`
|
80
|
+
# @return [String]
|
81
|
+
attr_accessor :external_error_message
|
82
|
+
|
83
|
+
# Location of the error, as specified by the location type. If location_type is
|
84
|
+
# PATH, this should be a path to a field that's relative to the request, using
|
85
|
+
# FieldPath notation (net/proto2/util/public/field_path.h). Examples:
|
86
|
+
# authenticated_user.gaia_id resource.address[2].country
|
87
|
+
# Corresponds to the JSON property `location`
|
88
|
+
# @return [String]
|
89
|
+
attr_accessor :location
|
90
|
+
|
91
|
+
#
|
92
|
+
# Corresponds to the JSON property `locationType`
|
93
|
+
# @return [String]
|
94
|
+
attr_accessor :location_type
|
95
|
+
|
96
|
+
def initialize(**args)
|
97
|
+
update!(**args)
|
98
|
+
end
|
99
|
+
|
100
|
+
# Update properties of this object
|
101
|
+
def update!(**args)
|
102
|
+
@argument = args[:argument] if args.key?(:argument)
|
103
|
+
@code = args[:code] if args.key?(:code)
|
104
|
+
@debug_info = args[:debug_info] if args.key?(:debug_info)
|
105
|
+
@domain = args[:domain] if args.key?(:domain)
|
106
|
+
@external_error_message = args[:external_error_message] if args.key?(:external_error_message)
|
107
|
+
@location = args[:location] if args.key?(:location)
|
108
|
+
@location_type = args[:location_type] if args.key?(:location_type)
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
# Request Error information. The presence of an error field signals that the
|
113
|
+
# operation has failed.
|
114
|
+
class Errors
|
115
|
+
include Google::Apis::Core::Hashable
|
116
|
+
|
117
|
+
# Global error code. Deprecated and ignored. Set custom error codes in
|
118
|
+
# ErrorProto.domain and ErrorProto.code instead.
|
119
|
+
# Corresponds to the JSON property `code`
|
120
|
+
# @return [String]
|
121
|
+
attr_accessor :code
|
122
|
+
|
123
|
+
# Specific error description and codes
|
124
|
+
# Corresponds to the JSON property `error`
|
125
|
+
# @return [Array<Google::Apis::YoutubeAnalyticsV2::ErrorProto>]
|
126
|
+
attr_accessor :error
|
127
|
+
|
128
|
+
# Request identifier generated by the service, which can be used to identify the
|
129
|
+
# error in the logs
|
130
|
+
# Corresponds to the JSON property `requestId`
|
131
|
+
# @return [String]
|
132
|
+
attr_accessor :request_id
|
133
|
+
|
134
|
+
def initialize(**args)
|
135
|
+
update!(**args)
|
136
|
+
end
|
137
|
+
|
138
|
+
# Update properties of this object
|
139
|
+
def update!(**args)
|
140
|
+
@code = args[:code] if args.key?(:code)
|
141
|
+
@error = args[:error] if args.key?(:error)
|
142
|
+
@request_id = args[:request_id] if args.key?(:request_id)
|
143
|
+
end
|
144
|
+
end
|
145
|
+
|
146
|
+
# A group.
|
147
|
+
class Group
|
148
|
+
include Google::Apis::Core::Hashable
|
149
|
+
|
150
|
+
# A group's content details.
|
151
|
+
# Corresponds to the JSON property `contentDetails`
|
152
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::GroupContentDetails]
|
153
|
+
attr_accessor :content_details
|
154
|
+
|
155
|
+
# Request Error information. The presence of an error field signals that the
|
156
|
+
# operation has failed.
|
157
|
+
# Corresponds to the JSON property `errors`
|
158
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::Errors]
|
159
|
+
attr_accessor :errors
|
160
|
+
|
161
|
+
# The Etag of this resource.
|
162
|
+
# Corresponds to the JSON property `etag`
|
163
|
+
# @return [String]
|
164
|
+
attr_accessor :etag
|
165
|
+
|
166
|
+
# The ID that YouTube uses to uniquely identify the group.
|
167
|
+
# Corresponds to the JSON property `id`
|
168
|
+
# @return [String]
|
169
|
+
attr_accessor :id
|
170
|
+
|
171
|
+
# Identifies the API resource's type. The value will be `youtube#group`.
|
172
|
+
# Corresponds to the JSON property `kind`
|
173
|
+
# @return [String]
|
174
|
+
attr_accessor :kind
|
175
|
+
|
176
|
+
# A group snippet.
|
177
|
+
# Corresponds to the JSON property `snippet`
|
178
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::GroupSnippet]
|
179
|
+
attr_accessor :snippet
|
180
|
+
|
181
|
+
def initialize(**args)
|
182
|
+
update!(**args)
|
183
|
+
end
|
184
|
+
|
185
|
+
# Update properties of this object
|
186
|
+
def update!(**args)
|
187
|
+
@content_details = args[:content_details] if args.key?(:content_details)
|
188
|
+
@errors = args[:errors] if args.key?(:errors)
|
189
|
+
@etag = args[:etag] if args.key?(:etag)
|
190
|
+
@id = args[:id] if args.key?(:id)
|
191
|
+
@kind = args[:kind] if args.key?(:kind)
|
192
|
+
@snippet = args[:snippet] if args.key?(:snippet)
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
# A group's content details.
|
197
|
+
class GroupContentDetails
|
198
|
+
include Google::Apis::Core::Hashable
|
199
|
+
|
200
|
+
# The number of items in the group.
|
201
|
+
# Corresponds to the JSON property `itemCount`
|
202
|
+
# @return [Fixnum]
|
203
|
+
attr_accessor :item_count
|
204
|
+
|
205
|
+
# The type of resources that the group contains. Valid values for this property
|
206
|
+
# are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `
|
207
|
+
# youtubePartner#asset`
|
208
|
+
# Corresponds to the JSON property `itemType`
|
209
|
+
# @return [String]
|
210
|
+
attr_accessor :item_type
|
211
|
+
|
212
|
+
def initialize(**args)
|
213
|
+
update!(**args)
|
214
|
+
end
|
215
|
+
|
216
|
+
# Update properties of this object
|
217
|
+
def update!(**args)
|
218
|
+
@item_count = args[:item_count] if args.key?(:item_count)
|
219
|
+
@item_type = args[:item_type] if args.key?(:item_type)
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
# A group item.
|
224
|
+
class GroupItem
|
225
|
+
include Google::Apis::Core::Hashable
|
226
|
+
|
227
|
+
# Request Error information. The presence of an error field signals that the
|
228
|
+
# operation has failed.
|
229
|
+
# Corresponds to the JSON property `errors`
|
230
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::Errors]
|
231
|
+
attr_accessor :errors
|
232
|
+
|
233
|
+
# The Etag of this resource.
|
234
|
+
# Corresponds to the JSON property `etag`
|
235
|
+
# @return [String]
|
236
|
+
attr_accessor :etag
|
237
|
+
|
238
|
+
# The ID that YouTube uses to uniquely identify the group that contains the item.
|
239
|
+
# Corresponds to the JSON property `groupId`
|
240
|
+
# @return [String]
|
241
|
+
attr_accessor :group_id
|
242
|
+
|
243
|
+
# The ID that YouTube uses to uniquely identify the `channel`, `video`, `
|
244
|
+
# playlist`, or `asset` resource that is included in the group. Note that this
|
245
|
+
# ID refers specifically to the inclusion of that resource in a particular group
|
246
|
+
# and is different than the channel ID, video ID, playlist ID, or asset ID that
|
247
|
+
# uniquely identifies the resource itself. The `resource.id` property's value
|
248
|
+
# specifies the unique channel, video, playlist, or asset ID.
|
249
|
+
# Corresponds to the JSON property `id`
|
250
|
+
# @return [String]
|
251
|
+
attr_accessor :id
|
252
|
+
|
253
|
+
# Identifies the API resource's type. The value will be `youtube#groupItem`.
|
254
|
+
# Corresponds to the JSON property `kind`
|
255
|
+
# @return [String]
|
256
|
+
attr_accessor :kind
|
257
|
+
|
258
|
+
# The `resource` object contains information that identifies the item being
|
259
|
+
# added to the group.
|
260
|
+
# Corresponds to the JSON property `resource`
|
261
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::GroupItemResource]
|
262
|
+
attr_accessor :resource
|
263
|
+
|
264
|
+
def initialize(**args)
|
265
|
+
update!(**args)
|
266
|
+
end
|
267
|
+
|
268
|
+
# Update properties of this object
|
269
|
+
def update!(**args)
|
270
|
+
@errors = args[:errors] if args.key?(:errors)
|
271
|
+
@etag = args[:etag] if args.key?(:etag)
|
272
|
+
@group_id = args[:group_id] if args.key?(:group_id)
|
273
|
+
@id = args[:id] if args.key?(:id)
|
274
|
+
@kind = args[:kind] if args.key?(:kind)
|
275
|
+
@resource = args[:resource] if args.key?(:resource)
|
276
|
+
end
|
277
|
+
end
|
278
|
+
|
279
|
+
#
|
280
|
+
class GroupItemResource
|
281
|
+
include Google::Apis::Core::Hashable
|
282
|
+
|
283
|
+
# The channel, video, playlist, or asset ID that YouTube uses to uniquely
|
284
|
+
# identify the item that is being added to the group.
|
285
|
+
# Corresponds to the JSON property `id`
|
286
|
+
# @return [String]
|
287
|
+
attr_accessor :id
|
288
|
+
|
289
|
+
# Identifies the type of resource being added to the group. Valid values for
|
290
|
+
# this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` *
|
291
|
+
# `youtubePartner#asset`
|
292
|
+
# Corresponds to the JSON property `kind`
|
293
|
+
# @return [String]
|
294
|
+
attr_accessor :kind
|
295
|
+
|
296
|
+
def initialize(**args)
|
297
|
+
update!(**args)
|
298
|
+
end
|
299
|
+
|
300
|
+
# Update properties of this object
|
301
|
+
def update!(**args)
|
302
|
+
@id = args[:id] if args.key?(:id)
|
303
|
+
@kind = args[:kind] if args.key?(:kind)
|
304
|
+
end
|
305
|
+
end
|
306
|
+
|
307
|
+
# A group snippet.
|
308
|
+
class GroupSnippet
|
309
|
+
include Google::Apis::Core::Hashable
|
310
|
+
|
311
|
+
# The date and time that the group was created. The value is specified in ISO
|
312
|
+
# 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
|
313
|
+
# Corresponds to the JSON property `publishedAt`
|
314
|
+
# @return [String]
|
315
|
+
attr_accessor :published_at
|
316
|
+
|
317
|
+
# The group name. The value must be a non-empty string.
|
318
|
+
# Corresponds to the JSON property `title`
|
319
|
+
# @return [String]
|
320
|
+
attr_accessor :title
|
321
|
+
|
322
|
+
def initialize(**args)
|
323
|
+
update!(**args)
|
324
|
+
end
|
325
|
+
|
326
|
+
# Update properties of this object
|
327
|
+
def update!(**args)
|
328
|
+
@published_at = args[:published_at] if args.key?(:published_at)
|
329
|
+
@title = args[:title] if args.key?(:title)
|
330
|
+
end
|
331
|
+
end
|
332
|
+
|
333
|
+
# Response message for GroupsService.ListGroupItems.
|
334
|
+
class ListGroupItemsResponse
|
335
|
+
include Google::Apis::Core::Hashable
|
336
|
+
|
337
|
+
# Request Error information. The presence of an error field signals that the
|
338
|
+
# operation has failed.
|
339
|
+
# Corresponds to the JSON property `errors`
|
340
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::Errors]
|
341
|
+
attr_accessor :errors
|
342
|
+
|
343
|
+
# The Etag of this resource.
|
344
|
+
# Corresponds to the JSON property `etag`
|
345
|
+
# @return [String]
|
346
|
+
attr_accessor :etag
|
347
|
+
|
348
|
+
# A list of groups that match the API request parameters. Each item in the list
|
349
|
+
# represents a `groupItem` resource.
|
350
|
+
# Corresponds to the JSON property `items`
|
351
|
+
# @return [Array<Google::Apis::YoutubeAnalyticsV2::GroupItem>]
|
352
|
+
attr_accessor :items
|
353
|
+
|
354
|
+
# Identifies the API resource's type. The value will be `youtube#
|
355
|
+
# groupItemListResponse`.
|
356
|
+
# Corresponds to the JSON property `kind`
|
357
|
+
# @return [String]
|
358
|
+
attr_accessor :kind
|
359
|
+
|
360
|
+
def initialize(**args)
|
361
|
+
update!(**args)
|
362
|
+
end
|
363
|
+
|
364
|
+
# Update properties of this object
|
365
|
+
def update!(**args)
|
366
|
+
@errors = args[:errors] if args.key?(:errors)
|
367
|
+
@etag = args[:etag] if args.key?(:etag)
|
368
|
+
@items = args[:items] if args.key?(:items)
|
369
|
+
@kind = args[:kind] if args.key?(:kind)
|
370
|
+
end
|
371
|
+
end
|
372
|
+
|
373
|
+
# Response message for GroupsService.ListGroups.
|
374
|
+
class ListGroupsResponse
|
375
|
+
include Google::Apis::Core::Hashable
|
376
|
+
|
377
|
+
# Request Error information. The presence of an error field signals that the
|
378
|
+
# operation has failed.
|
379
|
+
# Corresponds to the JSON property `errors`
|
380
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::Errors]
|
381
|
+
attr_accessor :errors
|
382
|
+
|
383
|
+
# The Etag of this resource.
|
384
|
+
# Corresponds to the JSON property `etag`
|
385
|
+
# @return [String]
|
386
|
+
attr_accessor :etag
|
387
|
+
|
388
|
+
# A list of groups that match the API request parameters. Each item in the list
|
389
|
+
# represents a `group` resource.
|
390
|
+
# Corresponds to the JSON property `items`
|
391
|
+
# @return [Array<Google::Apis::YoutubeAnalyticsV2::Group>]
|
392
|
+
attr_accessor :items
|
393
|
+
|
394
|
+
# Identifies the API resource's type. The value will be `youtube#
|
395
|
+
# groupListResponse`.
|
396
|
+
# Corresponds to the JSON property `kind`
|
397
|
+
# @return [String]
|
398
|
+
attr_accessor :kind
|
399
|
+
|
400
|
+
# The token that can be used as the value of the `pageToken` parameter to
|
401
|
+
# retrieve the next page in the result set.
|
402
|
+
# Corresponds to the JSON property `nextPageToken`
|
403
|
+
# @return [String]
|
404
|
+
attr_accessor :next_page_token
|
405
|
+
|
406
|
+
def initialize(**args)
|
407
|
+
update!(**args)
|
408
|
+
end
|
409
|
+
|
410
|
+
# Update properties of this object
|
411
|
+
def update!(**args)
|
412
|
+
@errors = args[:errors] if args.key?(:errors)
|
413
|
+
@etag = args[:etag] if args.key?(:etag)
|
414
|
+
@items = args[:items] if args.key?(:items)
|
415
|
+
@kind = args[:kind] if args.key?(:kind)
|
416
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
417
|
+
end
|
418
|
+
end
|
419
|
+
|
420
|
+
# Response message for TargetedQueriesService.Query.
|
421
|
+
class QueryResponse
|
422
|
+
include Google::Apis::Core::Hashable
|
423
|
+
|
424
|
+
# This value specifies information about the data returned in the `rows` fields.
|
425
|
+
# Each item in the `columnHeaders` list identifies a field returned in the `rows`
|
426
|
+
# value, which contains a list of comma-delimited data. The `columnHeaders`
|
427
|
+
# list will begin with the dimensions specified in the API request, which will
|
428
|
+
# be followed by the metrics specified in the API request. The order of both
|
429
|
+
# dimensions and metrics will match the ordering in the API request. For example,
|
430
|
+
# if the API request contains the parameters `dimensions=ageGroup,gender&
|
431
|
+
# metrics=viewerPercentage`, the API response will return columns in this order:
|
432
|
+
# `ageGroup`, `gender`, `viewerPercentage`.
|
433
|
+
# Corresponds to the JSON property `columnHeaders`
|
434
|
+
# @return [Array<Google::Apis::YoutubeAnalyticsV2::ResultTableColumnHeader>]
|
435
|
+
attr_accessor :column_headers
|
436
|
+
|
437
|
+
# Request Error information. The presence of an error field signals that the
|
438
|
+
# operation has failed.
|
439
|
+
# Corresponds to the JSON property `errors`
|
440
|
+
# @return [Google::Apis::YoutubeAnalyticsV2::Errors]
|
441
|
+
attr_accessor :errors
|
442
|
+
|
443
|
+
# This value specifies the type of data included in the API response. For the
|
444
|
+
# query method, the kind property value will be `youtubeAnalytics#resultTable`.
|
445
|
+
# Corresponds to the JSON property `kind`
|
446
|
+
# @return [String]
|
447
|
+
attr_accessor :kind
|
448
|
+
|
449
|
+
# The list contains all rows of the result table. Each item in the list is an
|
450
|
+
# array that contains comma-delimited data corresponding to a single row of data.
|
451
|
+
# The order of the comma-delimited data fields will match the order of the
|
452
|
+
# columns listed in the `columnHeaders` field. If no data is available for the
|
453
|
+
# given query, the `rows` element will be omitted from the response. The
|
454
|
+
# response for a query with the `day` dimension will not contain rows for the
|
455
|
+
# most recent days.
|
456
|
+
# Corresponds to the JSON property `rows`
|
457
|
+
# @return [Array<Array<Object>>]
|
458
|
+
attr_accessor :rows
|
459
|
+
|
460
|
+
def initialize(**args)
|
461
|
+
update!(**args)
|
462
|
+
end
|
463
|
+
|
464
|
+
# Update properties of this object
|
465
|
+
def update!(**args)
|
466
|
+
@column_headers = args[:column_headers] if args.key?(:column_headers)
|
467
|
+
@errors = args[:errors] if args.key?(:errors)
|
468
|
+
@kind = args[:kind] if args.key?(:kind)
|
469
|
+
@rows = args[:rows] if args.key?(:rows)
|
470
|
+
end
|
471
|
+
end
|
472
|
+
|
473
|
+
# The description of a column of the result table.
|
474
|
+
class ResultTableColumnHeader
|
475
|
+
include Google::Apis::Core::Hashable
|
476
|
+
|
477
|
+
# The type of the column (`DIMENSION` or `METRIC`).
|
478
|
+
# Corresponds to the JSON property `columnType`
|
479
|
+
# @return [String]
|
480
|
+
attr_accessor :column_type
|
481
|
+
|
482
|
+
# The type of the data in the column (`STRING`, `INTEGER`, `FLOAT`, etc.).
|
483
|
+
# Corresponds to the JSON property `dataType`
|
484
|
+
# @return [String]
|
485
|
+
attr_accessor :data_type
|
486
|
+
|
487
|
+
# The name of the dimension or metric.
|
488
|
+
# Corresponds to the JSON property `name`
|
489
|
+
# @return [String]
|
490
|
+
attr_accessor :name
|
491
|
+
|
492
|
+
def initialize(**args)
|
493
|
+
update!(**args)
|
494
|
+
end
|
495
|
+
|
496
|
+
# Update properties of this object
|
497
|
+
def update!(**args)
|
498
|
+
@column_type = args[:column_type] if args.key?(:column_type)
|
499
|
+
@data_type = args[:data_type] if args.key?(:data_type)
|
500
|
+
@name = args[:name] if args.key?(:name)
|
501
|
+
end
|
502
|
+
end
|
503
|
+
end
|
504
|
+
end
|
505
|
+
end
|