google-apis-businessprofileperformance_v1 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/businessprofileperformance_v1/classes.rb +217 -0
- data/lib/google/apis/businessprofileperformance_v1/gem_version.rb +28 -0
- data/lib/google/apis/businessprofileperformance_v1/representations.rb +128 -0
- data/lib/google/apis/businessprofileperformance_v1/service.rb +210 -0
- data/lib/google/apis/businessprofileperformance_v1.rb +34 -0
- data/lib/google-apis-businessprofileperformance_v1.rb +15 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: fffae2c68ca375ec808dc0383b78866c168f4f17baead5c6423b0fad0f6f2893
|
4
|
+
data.tar.gz: 353d3a60db42583c320110e07a0b47655ad78ec112d2112cac6065455ce866d1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 002c3702a18406b7518e069d8d29891afdd906e9765ac765f659893f242c877add0ce75a3dd97dc72a37970838fc3769ac360bc3350e83d56a853dbd883590be
|
7
|
+
data.tar.gz: 336fbb59c240529de495caf7a1cc793b98ae2293e0cdbf614bb30d391b2b1e0eaea6a5f261c46a2324bead9ea63264c34bc4eff54b1a999ced1da80c5bb34b46
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-businessprofileperformance_v1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/businessprofileperformance_v1/*.rb
|
9
|
+
lib/google/apis/businessprofileperformance_v1.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 V1 of the Business Profile Performance API
|
2
|
+
|
3
|
+
This is a simple client library for version V1 of the Business Profile Performance 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/businessprofileperformance.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-businessprofileperformance_v1', '~> 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-businessprofileperformance_v1
|
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/businessprofileperformance_v1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::BusinessprofileperformanceV1::BusinessProfilePerformanceService.new
|
52
|
+
|
53
|
+
# Authenticate calls
|
54
|
+
client.authorization = # ... 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/main/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/main/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 Businessprofileperformance service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Business Profile Performance API, see the {Google::Apis::BusinessprofileperformanceV1::BusinessProfilePerformanceService 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-businessprofileperformance_v1`, 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/my-business/) 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,217 @@
|
|
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 BusinessprofileperformanceV1
|
24
|
+
|
25
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
26
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
27
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
28
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
29
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
30
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
31
|
+
# example, a credit card expiration date). Related types: * google.type.
|
32
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
33
|
+
class Date
|
34
|
+
include Google::Apis::Core::Hashable
|
35
|
+
|
36
|
+
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
|
37
|
+
# specify a year by itself or a year and month where the day isn't significant.
|
38
|
+
# Corresponds to the JSON property `day`
|
39
|
+
# @return [Fixnum]
|
40
|
+
attr_accessor :day
|
41
|
+
|
42
|
+
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
|
43
|
+
# and day.
|
44
|
+
# Corresponds to the JSON property `month`
|
45
|
+
# @return [Fixnum]
|
46
|
+
attr_accessor :month
|
47
|
+
|
48
|
+
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
|
49
|
+
# year.
|
50
|
+
# Corresponds to the JSON property `year`
|
51
|
+
# @return [Fixnum]
|
52
|
+
attr_accessor :year
|
53
|
+
|
54
|
+
def initialize(**args)
|
55
|
+
update!(**args)
|
56
|
+
end
|
57
|
+
|
58
|
+
# Update properties of this object
|
59
|
+
def update!(**args)
|
60
|
+
@day = args[:day] if args.key?(:day)
|
61
|
+
@month = args[:month] if args.key?(:month)
|
62
|
+
@year = args[:year] if args.key?(:year)
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
# Represents a single datapoint in the timeseries, where each datapoint is a
|
67
|
+
# date-value pair.
|
68
|
+
class DatedValue
|
69
|
+
include Google::Apis::Core::Hashable
|
70
|
+
|
71
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
72
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
73
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
74
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
75
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
76
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
77
|
+
# example, a credit card expiration date). Related types: * google.type.
|
78
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
79
|
+
# Corresponds to the JSON property `date`
|
80
|
+
# @return [Google::Apis::BusinessprofileperformanceV1::Date]
|
81
|
+
attr_accessor :date
|
82
|
+
|
83
|
+
# The value of the datapoint.
|
84
|
+
# Corresponds to the JSON property `value`
|
85
|
+
# @return [Fixnum]
|
86
|
+
attr_accessor :value
|
87
|
+
|
88
|
+
def initialize(**args)
|
89
|
+
update!(**args)
|
90
|
+
end
|
91
|
+
|
92
|
+
# Update properties of this object
|
93
|
+
def update!(**args)
|
94
|
+
@date = args[:date] if args.key?(:date)
|
95
|
+
@value = args[:value] if args.key?(:value)
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
# Represents the response for GetDailyMetricsTimeSeries.
|
100
|
+
class GetDailyMetricsTimeSeriesResponse
|
101
|
+
include Google::Apis::Core::Hashable
|
102
|
+
|
103
|
+
# Represents a timeseries.
|
104
|
+
# Corresponds to the JSON property `timeSeries`
|
105
|
+
# @return [Google::Apis::BusinessprofileperformanceV1::TimeSeries]
|
106
|
+
attr_accessor :time_series
|
107
|
+
|
108
|
+
def initialize(**args)
|
109
|
+
update!(**args)
|
110
|
+
end
|
111
|
+
|
112
|
+
# Update properties of this object
|
113
|
+
def update!(**args)
|
114
|
+
@time_series = args[:time_series] if args.key?(:time_series)
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
# Represents an insights value.
|
119
|
+
class InsightsValue
|
120
|
+
include Google::Apis::Core::Hashable
|
121
|
+
|
122
|
+
# Represents the threshold below which the actual value falls.
|
123
|
+
# Corresponds to the JSON property `threshold`
|
124
|
+
# @return [Fixnum]
|
125
|
+
attr_accessor :threshold
|
126
|
+
|
127
|
+
# Represents the actual value.
|
128
|
+
# Corresponds to the JSON property `value`
|
129
|
+
# @return [Fixnum]
|
130
|
+
attr_accessor :value
|
131
|
+
|
132
|
+
def initialize(**args)
|
133
|
+
update!(**args)
|
134
|
+
end
|
135
|
+
|
136
|
+
# Update properties of this object
|
137
|
+
def update!(**args)
|
138
|
+
@threshold = args[:threshold] if args.key?(:threshold)
|
139
|
+
@value = args[:value] if args.key?(:value)
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
# Represents the response for ListSearchKeywordImpressionsMonthly.
|
144
|
+
class ListSearchKeywordImpressionsMonthlyResponse
|
145
|
+
include Google::Apis::Core::Hashable
|
146
|
+
|
147
|
+
# A token indicating the last paginated result returned. This can be used by
|
148
|
+
# succeeding requests to get the next "page" of keywords. It will only be
|
149
|
+
# present when there are more results to be returned.
|
150
|
+
# Corresponds to the JSON property `nextPageToken`
|
151
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
152
|
+
# @return [String]
|
153
|
+
attr_accessor :next_page_token
|
154
|
+
|
155
|
+
# Search terms which have been used to find a business.
|
156
|
+
# Corresponds to the JSON property `searchKeywordsCounts`
|
157
|
+
# @return [Array<Google::Apis::BusinessprofileperformanceV1::SearchKeywordCount>]
|
158
|
+
attr_accessor :search_keywords_counts
|
159
|
+
|
160
|
+
def initialize(**args)
|
161
|
+
update!(**args)
|
162
|
+
end
|
163
|
+
|
164
|
+
# Update properties of this object
|
165
|
+
def update!(**args)
|
166
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
167
|
+
@search_keywords_counts = args[:search_keywords_counts] if args.key?(:search_keywords_counts)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
# Represents a single search keyword and its value.
|
172
|
+
class SearchKeywordCount
|
173
|
+
include Google::Apis::Core::Hashable
|
174
|
+
|
175
|
+
# Represents an insights value.
|
176
|
+
# Corresponds to the JSON property `insightsValue`
|
177
|
+
# @return [Google::Apis::BusinessprofileperformanceV1::InsightsValue]
|
178
|
+
attr_accessor :insights_value
|
179
|
+
|
180
|
+
# The lower-cased string that the user entered.
|
181
|
+
# Corresponds to the JSON property `searchKeyword`
|
182
|
+
# @return [String]
|
183
|
+
attr_accessor :search_keyword
|
184
|
+
|
185
|
+
def initialize(**args)
|
186
|
+
update!(**args)
|
187
|
+
end
|
188
|
+
|
189
|
+
# Update properties of this object
|
190
|
+
def update!(**args)
|
191
|
+
@insights_value = args[:insights_value] if args.key?(:insights_value)
|
192
|
+
@search_keyword = args[:search_keyword] if args.key?(:search_keyword)
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
# Represents a timeseries.
|
197
|
+
class TimeSeries
|
198
|
+
include Google::Apis::Core::Hashable
|
199
|
+
|
200
|
+
# List of datapoints in the timeseries, where each datapoint is a date-value
|
201
|
+
# pair.
|
202
|
+
# Corresponds to the JSON property `datedValues`
|
203
|
+
# @return [Array<Google::Apis::BusinessprofileperformanceV1::DatedValue>]
|
204
|
+
attr_accessor :dated_values
|
205
|
+
|
206
|
+
def initialize(**args)
|
207
|
+
update!(**args)
|
208
|
+
end
|
209
|
+
|
210
|
+
# Update properties of this object
|
211
|
+
def update!(**args)
|
212
|
+
@dated_values = args[:dated_values] if args.key?(:dated_values)
|
213
|
+
end
|
214
|
+
end
|
215
|
+
end
|
216
|
+
end
|
217
|
+
end
|
@@ -0,0 +1,28 @@
|
|
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
|
+
module Google
|
16
|
+
module Apis
|
17
|
+
module BusinessprofileperformanceV1
|
18
|
+
# Version of the google-apis-businessprofileperformance_v1 gem
|
19
|
+
GEM_VERSION = "0.1.0"
|
20
|
+
|
21
|
+
# Version of the code generator used to generate this client
|
22
|
+
GENERATOR_VERSION = "0.5.0"
|
23
|
+
|
24
|
+
# Revision of the discovery document this client was generated from
|
25
|
+
REVISION = "20220604"
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,128 @@
|
|
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 BusinessprofileperformanceV1
|
24
|
+
|
25
|
+
class Date
|
26
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
27
|
+
|
28
|
+
include Google::Apis::Core::JsonObjectSupport
|
29
|
+
end
|
30
|
+
|
31
|
+
class DatedValue
|
32
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
33
|
+
|
34
|
+
include Google::Apis::Core::JsonObjectSupport
|
35
|
+
end
|
36
|
+
|
37
|
+
class GetDailyMetricsTimeSeriesResponse
|
38
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
39
|
+
|
40
|
+
include Google::Apis::Core::JsonObjectSupport
|
41
|
+
end
|
42
|
+
|
43
|
+
class InsightsValue
|
44
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
45
|
+
|
46
|
+
include Google::Apis::Core::JsonObjectSupport
|
47
|
+
end
|
48
|
+
|
49
|
+
class ListSearchKeywordImpressionsMonthlyResponse
|
50
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
51
|
+
|
52
|
+
include Google::Apis::Core::JsonObjectSupport
|
53
|
+
end
|
54
|
+
|
55
|
+
class SearchKeywordCount
|
56
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
57
|
+
|
58
|
+
include Google::Apis::Core::JsonObjectSupport
|
59
|
+
end
|
60
|
+
|
61
|
+
class TimeSeries
|
62
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
63
|
+
|
64
|
+
include Google::Apis::Core::JsonObjectSupport
|
65
|
+
end
|
66
|
+
|
67
|
+
class Date
|
68
|
+
# @private
|
69
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
70
|
+
property :day, as: 'day'
|
71
|
+
property :month, as: 'month'
|
72
|
+
property :year, as: 'year'
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
class DatedValue
|
77
|
+
# @private
|
78
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
79
|
+
property :date, as: 'date', class: Google::Apis::BusinessprofileperformanceV1::Date, decorator: Google::Apis::BusinessprofileperformanceV1::Date::Representation
|
80
|
+
|
81
|
+
property :value, :numeric_string => true, as: 'value'
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
class GetDailyMetricsTimeSeriesResponse
|
86
|
+
# @private
|
87
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
88
|
+
property :time_series, as: 'timeSeries', class: Google::Apis::BusinessprofileperformanceV1::TimeSeries, decorator: Google::Apis::BusinessprofileperformanceV1::TimeSeries::Representation
|
89
|
+
|
90
|
+
end
|
91
|
+
end
|
92
|
+
|
93
|
+
class InsightsValue
|
94
|
+
# @private
|
95
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
96
|
+
property :threshold, :numeric_string => true, as: 'threshold'
|
97
|
+
property :value, :numeric_string => true, as: 'value'
|
98
|
+
end
|
99
|
+
end
|
100
|
+
|
101
|
+
class ListSearchKeywordImpressionsMonthlyResponse
|
102
|
+
# @private
|
103
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
104
|
+
property :next_page_token, :base64 => true, as: 'nextPageToken'
|
105
|
+
collection :search_keywords_counts, as: 'searchKeywordsCounts', class: Google::Apis::BusinessprofileperformanceV1::SearchKeywordCount, decorator: Google::Apis::BusinessprofileperformanceV1::SearchKeywordCount::Representation
|
106
|
+
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
class SearchKeywordCount
|
111
|
+
# @private
|
112
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
113
|
+
property :insights_value, as: 'insightsValue', class: Google::Apis::BusinessprofileperformanceV1::InsightsValue, decorator: Google::Apis::BusinessprofileperformanceV1::InsightsValue::Representation
|
114
|
+
|
115
|
+
property :search_keyword, as: 'searchKeyword'
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
119
|
+
class TimeSeries
|
120
|
+
# @private
|
121
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
122
|
+
collection :dated_values, as: 'datedValues', class: Google::Apis::BusinessprofileperformanceV1::DatedValue, decorator: Google::Apis::BusinessprofileperformanceV1::DatedValue::Representation
|
123
|
+
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
128
|
+
end
|
@@ -0,0 +1,210 @@
|
|
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/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module BusinessprofileperformanceV1
|
23
|
+
# Business Profile Performance API
|
24
|
+
#
|
25
|
+
# The Business Profile Performance API allows merchants to fetch performance
|
26
|
+
# reports about their business profile on Google.
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# require 'google/apis/businessprofileperformance_v1'
|
30
|
+
#
|
31
|
+
# Businessprofileperformance = Google::Apis::BusinessprofileperformanceV1 # Alias the module
|
32
|
+
# service = Businessprofileperformance::BusinessProfilePerformanceService.new
|
33
|
+
#
|
34
|
+
# @see https://developers.google.com/my-business/
|
35
|
+
class BusinessProfilePerformanceService < Google::Apis::Core::BaseService
|
36
|
+
# @return [String]
|
37
|
+
# API key. Your API key identifies your project and provides you with API access,
|
38
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
39
|
+
attr_accessor :key
|
40
|
+
|
41
|
+
# @return [String]
|
42
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
43
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
44
|
+
attr_accessor :quota_user
|
45
|
+
|
46
|
+
def initialize
|
47
|
+
super('https://businessprofileperformance.googleapis.com/', '',
|
48
|
+
client_name: 'google-apis-businessprofileperformance_v1',
|
49
|
+
client_version: Google::Apis::BusinessprofileperformanceV1::GEM_VERSION)
|
50
|
+
@batch_path = 'batch'
|
51
|
+
end
|
52
|
+
|
53
|
+
# Returns the values for each date from a given time range that are associated
|
54
|
+
# with the specific daily metric. Example request: `GET https://
|
55
|
+
# businessprofileperformance.googleapis.com/v1/locations/12345:
|
56
|
+
# getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.
|
57
|
+
# year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&
|
58
|
+
# daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.
|
59
|
+
# end_date.day=31`
|
60
|
+
# @param [String] name
|
61
|
+
# Required. The location for which the time series should be fetched. Format:
|
62
|
+
# locations/`location_id` where location_id is an unobfuscated listing id.
|
63
|
+
# @param [String] daily_metric
|
64
|
+
# Required. The metric to retrieve time series.
|
65
|
+
# @param [Fixnum] daily_range_end_date_day
|
66
|
+
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
|
67
|
+
# specify a year by itself or a year and month where the day isn't significant.
|
68
|
+
# @param [Fixnum] daily_range_end_date_month
|
69
|
+
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
|
70
|
+
# and day.
|
71
|
+
# @param [Fixnum] daily_range_end_date_year
|
72
|
+
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
|
73
|
+
# year.
|
74
|
+
# @param [Fixnum] daily_range_start_date_day
|
75
|
+
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
|
76
|
+
# specify a year by itself or a year and month where the day isn't significant.
|
77
|
+
# @param [Fixnum] daily_range_start_date_month
|
78
|
+
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
|
79
|
+
# and day.
|
80
|
+
# @param [Fixnum] daily_range_start_date_year
|
81
|
+
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
|
82
|
+
# year.
|
83
|
+
# @param [String] daily_sub_entity_type_day_of_week
|
84
|
+
# Represents the day of the week. Eg: MONDAY.
|
85
|
+
# @param [Fixnum] daily_sub_entity_type_time_of_day_hours
|
86
|
+
# Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to
|
87
|
+
# allow the value "24:00:00" for scenarios like business closing time.
|
88
|
+
# @param [Fixnum] daily_sub_entity_type_time_of_day_minutes
|
89
|
+
# Minutes of hour of day. Must be from 0 to 59.
|
90
|
+
# @param [Fixnum] daily_sub_entity_type_time_of_day_nanos
|
91
|
+
# Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
|
92
|
+
# @param [Fixnum] daily_sub_entity_type_time_of_day_seconds
|
93
|
+
# Seconds of minutes of the time. Must normally be from 0 to 59. An API may
|
94
|
+
# allow the value 60 if it allows leap-seconds.
|
95
|
+
# @param [String] fields
|
96
|
+
# Selector specifying which fields to include in a partial response.
|
97
|
+
# @param [String] quota_user
|
98
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
99
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
100
|
+
# @param [Google::Apis::RequestOptions] options
|
101
|
+
# Request-specific options
|
102
|
+
#
|
103
|
+
# @yield [result, err] Result & error if block supplied
|
104
|
+
# @yieldparam result [Google::Apis::BusinessprofileperformanceV1::GetDailyMetricsTimeSeriesResponse] parsed result object
|
105
|
+
# @yieldparam err [StandardError] error object if request failed
|
106
|
+
#
|
107
|
+
# @return [Google::Apis::BusinessprofileperformanceV1::GetDailyMetricsTimeSeriesResponse]
|
108
|
+
#
|
109
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
110
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
111
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
112
|
+
def get_location_daily_metrics_time_series(name, daily_metric: nil, daily_range_end_date_day: nil, daily_range_end_date_month: nil, daily_range_end_date_year: nil, daily_range_start_date_day: nil, daily_range_start_date_month: nil, daily_range_start_date_year: nil, daily_sub_entity_type_day_of_week: nil, daily_sub_entity_type_time_of_day_hours: nil, daily_sub_entity_type_time_of_day_minutes: nil, daily_sub_entity_type_time_of_day_nanos: nil, daily_sub_entity_type_time_of_day_seconds: nil, fields: nil, quota_user: nil, options: nil, &block)
|
113
|
+
command = make_simple_command(:get, 'v1/{+name}:getDailyMetricsTimeSeries', options)
|
114
|
+
command.response_representation = Google::Apis::BusinessprofileperformanceV1::GetDailyMetricsTimeSeriesResponse::Representation
|
115
|
+
command.response_class = Google::Apis::BusinessprofileperformanceV1::GetDailyMetricsTimeSeriesResponse
|
116
|
+
command.params['name'] = name unless name.nil?
|
117
|
+
command.query['dailyMetric'] = daily_metric unless daily_metric.nil?
|
118
|
+
command.query['dailyRange.endDate.day'] = daily_range_end_date_day unless daily_range_end_date_day.nil?
|
119
|
+
command.query['dailyRange.endDate.month'] = daily_range_end_date_month unless daily_range_end_date_month.nil?
|
120
|
+
command.query['dailyRange.endDate.year'] = daily_range_end_date_year unless daily_range_end_date_year.nil?
|
121
|
+
command.query['dailyRange.startDate.day'] = daily_range_start_date_day unless daily_range_start_date_day.nil?
|
122
|
+
command.query['dailyRange.startDate.month'] = daily_range_start_date_month unless daily_range_start_date_month.nil?
|
123
|
+
command.query['dailyRange.startDate.year'] = daily_range_start_date_year unless daily_range_start_date_year.nil?
|
124
|
+
command.query['dailySubEntityType.dayOfWeek'] = daily_sub_entity_type_day_of_week unless daily_sub_entity_type_day_of_week.nil?
|
125
|
+
command.query['dailySubEntityType.timeOfDay.hours'] = daily_sub_entity_type_time_of_day_hours unless daily_sub_entity_type_time_of_day_hours.nil?
|
126
|
+
command.query['dailySubEntityType.timeOfDay.minutes'] = daily_sub_entity_type_time_of_day_minutes unless daily_sub_entity_type_time_of_day_minutes.nil?
|
127
|
+
command.query['dailySubEntityType.timeOfDay.nanos'] = daily_sub_entity_type_time_of_day_nanos unless daily_sub_entity_type_time_of_day_nanos.nil?
|
128
|
+
command.query['dailySubEntityType.timeOfDay.seconds'] = daily_sub_entity_type_time_of_day_seconds unless daily_sub_entity_type_time_of_day_seconds.nil?
|
129
|
+
command.query['fields'] = fields unless fields.nil?
|
130
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
131
|
+
execute_or_queue_command(command, &block)
|
132
|
+
end
|
133
|
+
|
134
|
+
# Returns the search keywords used to find a business in search or maps. Each
|
135
|
+
# search keyword is accompanied by impressions which are aggregated on a monthly
|
136
|
+
# basis. Example request: `GET https://businessprofileperformance.googleapis.com/
|
137
|
+
# v1/locations/12345/searchkeywords/impressions/monthly?monthly_range.
|
138
|
+
# start_month.year=2022&monthly_range.start_month.month=1&monthly_range.
|
139
|
+
# end_month.year=2022&monthly_range.end_month.month=3`
|
140
|
+
# @param [String] parent
|
141
|
+
# Required. The location for which the time series should be fetched. Format:
|
142
|
+
# locations/`location_id` where location_id is an unobfuscated listing id.
|
143
|
+
# @param [Fixnum] monthly_range_end_month_day
|
144
|
+
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
|
145
|
+
# specify a year by itself or a year and month where the day isn't significant.
|
146
|
+
# @param [Fixnum] monthly_range_end_month_month
|
147
|
+
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
|
148
|
+
# and day.
|
149
|
+
# @param [Fixnum] monthly_range_end_month_year
|
150
|
+
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
|
151
|
+
# year.
|
152
|
+
# @param [Fixnum] monthly_range_start_month_day
|
153
|
+
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
|
154
|
+
# specify a year by itself or a year and month where the day isn't significant.
|
155
|
+
# @param [Fixnum] monthly_range_start_month_month
|
156
|
+
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
|
157
|
+
# and day.
|
158
|
+
# @param [Fixnum] monthly_range_start_month_year
|
159
|
+
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
|
160
|
+
# year.
|
161
|
+
# @param [Fixnum] page_size
|
162
|
+
# Optional. The number of results requested. The default page size is 100. Page
|
163
|
+
# size can be set to a maximum of 100.
|
164
|
+
# @param [String] page_token
|
165
|
+
# Optional. A token indicating the next paginated result to be returned.
|
166
|
+
# @param [String] fields
|
167
|
+
# Selector specifying which fields to include in a partial response.
|
168
|
+
# @param [String] quota_user
|
169
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
170
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
171
|
+
# @param [Google::Apis::RequestOptions] options
|
172
|
+
# Request-specific options
|
173
|
+
#
|
174
|
+
# @yield [result, err] Result & error if block supplied
|
175
|
+
# @yieldparam result [Google::Apis::BusinessprofileperformanceV1::ListSearchKeywordImpressionsMonthlyResponse] parsed result object
|
176
|
+
# @yieldparam err [StandardError] error object if request failed
|
177
|
+
#
|
178
|
+
# @return [Google::Apis::BusinessprofileperformanceV1::ListSearchKeywordImpressionsMonthlyResponse]
|
179
|
+
#
|
180
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
181
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
182
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
183
|
+
def list_location_searchkeyword_impression_monthlies(parent, monthly_range_end_month_day: nil, monthly_range_end_month_month: nil, monthly_range_end_month_year: nil, monthly_range_start_month_day: nil, monthly_range_start_month_month: nil, monthly_range_start_month_year: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
184
|
+
command = make_simple_command(:get, 'v1/{+parent}/searchkeywords/impressions/monthly', options)
|
185
|
+
command.response_representation = Google::Apis::BusinessprofileperformanceV1::ListSearchKeywordImpressionsMonthlyResponse::Representation
|
186
|
+
command.response_class = Google::Apis::BusinessprofileperformanceV1::ListSearchKeywordImpressionsMonthlyResponse
|
187
|
+
command.params['parent'] = parent unless parent.nil?
|
188
|
+
command.query['monthlyRange.endMonth.day'] = monthly_range_end_month_day unless monthly_range_end_month_day.nil?
|
189
|
+
command.query['monthlyRange.endMonth.month'] = monthly_range_end_month_month unless monthly_range_end_month_month.nil?
|
190
|
+
command.query['monthlyRange.endMonth.year'] = monthly_range_end_month_year unless monthly_range_end_month_year.nil?
|
191
|
+
command.query['monthlyRange.startMonth.day'] = monthly_range_start_month_day unless monthly_range_start_month_day.nil?
|
192
|
+
command.query['monthlyRange.startMonth.month'] = monthly_range_start_month_month unless monthly_range_start_month_month.nil?
|
193
|
+
command.query['monthlyRange.startMonth.year'] = monthly_range_start_month_year unless monthly_range_start_month_year.nil?
|
194
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
195
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
196
|
+
command.query['fields'] = fields unless fields.nil?
|
197
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
198
|
+
execute_or_queue_command(command, &block)
|
199
|
+
end
|
200
|
+
|
201
|
+
protected
|
202
|
+
|
203
|
+
def apply_command_defaults(command)
|
204
|
+
command.query['key'] = key unless key.nil?
|
205
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
210
|
+
end
|
@@ -0,0 +1,34 @@
|
|
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/businessprofileperformance_v1/service.rb'
|
16
|
+
require 'google/apis/businessprofileperformance_v1/classes.rb'
|
17
|
+
require 'google/apis/businessprofileperformance_v1/representations.rb'
|
18
|
+
require 'google/apis/businessprofileperformance_v1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Business Profile Performance API
|
23
|
+
#
|
24
|
+
# The Business Profile Performance API allows merchants to fetch performance
|
25
|
+
# reports about their business profile on Google.
|
26
|
+
#
|
27
|
+
# @see https://developers.google.com/my-business/
|
28
|
+
module BusinessprofileperformanceV1
|
29
|
+
# Version of the Business Profile Performance API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1'
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -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/businessprofileperformance_v1"
|
metadata
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-apis-businessprofileperformance_v1
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-06-13 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: google-apis-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.5'
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 2.a
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0.5'
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 2.a
|
33
|
+
description: This is the simple REST client for Business Profile Performance API V1.
|
34
|
+
Simple REST clients are Ruby client libraries that provide access to Google services
|
35
|
+
via their HTTP REST API endpoints. These libraries are generated and updated automatically
|
36
|
+
based on the discovery documents published by the service, and they handle most
|
37
|
+
concerns such as authentication, pagination, retry, timeouts, and logging. You can
|
38
|
+
use this client to access the Business Profile Performance API, but note that some
|
39
|
+
services may provide a separate modern client that is easier to use.
|
40
|
+
email: googleapis-packages@google.com
|
41
|
+
executables: []
|
42
|
+
extensions: []
|
43
|
+
extra_rdoc_files: []
|
44
|
+
files:
|
45
|
+
- ".yardopts"
|
46
|
+
- CHANGELOG.md
|
47
|
+
- LICENSE.md
|
48
|
+
- OVERVIEW.md
|
49
|
+
- lib/google-apis-businessprofileperformance_v1.rb
|
50
|
+
- lib/google/apis/businessprofileperformance_v1.rb
|
51
|
+
- lib/google/apis/businessprofileperformance_v1/classes.rb
|
52
|
+
- lib/google/apis/businessprofileperformance_v1/gem_version.rb
|
53
|
+
- lib/google/apis/businessprofileperformance_v1/representations.rb
|
54
|
+
- lib/google/apis/businessprofileperformance_v1/service.rb
|
55
|
+
homepage: https://github.com/google/google-api-ruby-client
|
56
|
+
licenses:
|
57
|
+
- Apache-2.0
|
58
|
+
metadata:
|
59
|
+
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
|
+
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-businessprofileperformance_v1/CHANGELOG.md
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-businessprofileperformance_v1/v0.1.0
|
62
|
+
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-businessprofileperformance_v1
|
63
|
+
post_install_message:
|
64
|
+
rdoc_options: []
|
65
|
+
require_paths:
|
66
|
+
- lib
|
67
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - ">="
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: '2.5'
|
72
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
requirements: []
|
78
|
+
rubygems_version: 3.3.14
|
79
|
+
signing_key:
|
80
|
+
specification_version: 4
|
81
|
+
summary: Simple REST client for Business Profile Performance API V1
|
82
|
+
test_files: []
|