google-apis-localservices_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 377834b38f530e43b7c3734d36b19f90534668ba4d4bf33eb6be9c0c10b61e46
4
+ data.tar.gz: 78b9683b10b95d36bc88c2ece7c5fd32aea02192111b8876c64faeadb3fa82e8
5
+ SHA512:
6
+ metadata.gz: e5f4a8e6dabcd081a2ea7feb385f8a70aaa9bfe7530dd704eb7d113bf03f00ebd772914974ebdbe5c363a6fa845b5edb475da1a563eb52fd91657f8e19649e33
7
+ data.tar.gz: ab17af5a2d4b4f3cfbf81aa8069b2e3a9f55b6233867e09d5f4334eb68477b99f72cb66d65a36608e569404133bf96dbc36f4f42515d7ec81e8a1be33d1d9c6e
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-localservices_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/localservices_v1/*.rb
9
+ lib/google/apis/localservices_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-localservices_v1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20201213
7
+
@@ -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.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the Local Services API
2
+
3
+ This is a simple client library for version V1 of the Local Services 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/localservices.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-localservices_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-localservices_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/localservices_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::LocalservicesV1::LocalservicesService.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 Localservices service in particular.)
67
+
68
+ For reference information on specific calls in the Local Services API, see the {Google::Apis::LocalservicesV1::LocalservicesService 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-localservices_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://ads.google.com/local-services-ads/) 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/localservices_v1"
@@ -0,0 +1,36 @@
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/localservices_v1/service.rb'
16
+ require 'google/apis/localservices_v1/classes.rb'
17
+ require 'google/apis/localservices_v1/representations.rb'
18
+ require 'google/apis/localservices_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Local Services API
23
+ #
24
+ #
25
+ #
26
+ # @see https://ads.google.com/local-services-ads/
27
+ module LocalservicesV1
28
+ # Version of the Local Services API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+
32
+ # Manage your AdWords campaigns
33
+ AUTH_ADWORDS = 'https://www.googleapis.com/auth/adwords'
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,426 @@
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 LocalservicesV1
24
+
25
+ # An Account Report of a GLS account identified by their account id containing
26
+ # aggregate data gathered from a particular date range.
27
+ class GoogleAdsHomeservicesLocalservicesV1AccountReport
28
+ include Google::Apis::Core::Hashable
29
+
30
+ # Unique identifier of the GLS account.
31
+ # Corresponds to the JSON property `accountId`
32
+ # @return [Fixnum]
33
+ attr_accessor :account_id
34
+
35
+ # Conatiner for aggregator specific information if lead is for an aggregator GLS
36
+ # account.
37
+ # Corresponds to the JSON property `aggregatorInfo`
38
+ # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo]
39
+ attr_accessor :aggregator_info
40
+
41
+ # Average review rating score from 1-5 stars.
42
+ # Corresponds to the JSON property `averageFiveStarRating`
43
+ # @return [Float]
44
+ attr_accessor :average_five_star_rating
45
+
46
+ # Average weekly budget in the currency code of the account.
47
+ # Corresponds to the JSON property `averageWeeklyBudget`
48
+ # @return [Float]
49
+ attr_accessor :average_weekly_budget
50
+
51
+ # Business name of the account.
52
+ # Corresponds to the JSON property `businessName`
53
+ # @return [String]
54
+ attr_accessor :business_name
55
+
56
+ # Currency code of the account.
57
+ # Corresponds to the JSON property `currencyCode`
58
+ # @return [String]
59
+ attr_accessor :currency_code
60
+
61
+ # Number of charged leads the account received in current specified period.
62
+ # Corresponds to the JSON property `currentPeriodChargedLeads`
63
+ # @return [Fixnum]
64
+ attr_accessor :current_period_charged_leads
65
+
66
+ # Number of connected phone calls (duration over 30s) in current specified
67
+ # period.
68
+ # Corresponds to the JSON property `currentPeriodConnectedPhoneCalls`
69
+ # @return [Fixnum]
70
+ attr_accessor :current_period_connected_phone_calls
71
+
72
+ # Number of phone calls in current specified period, including both connected
73
+ # and unconnected calls.
74
+ # Corresponds to the JSON property `currentPeriodPhoneCalls`
75
+ # @return [Fixnum]
76
+ attr_accessor :current_period_phone_calls
77
+
78
+ # Total cost of the account in current specified period in the account's
79
+ # specified currency.
80
+ # Corresponds to the JSON property `currentPeriodTotalCost`
81
+ # @return [Float]
82
+ attr_accessor :current_period_total_cost
83
+
84
+ # Phone lead responsiveness of the account for the past 90 days from current
85
+ # date. This is computed by taking the total number of connected calls from
86
+ # charged phone leads and dividing by the total number of calls received.
87
+ # Corresponds to the JSON property `phoneLeadResponsiveness`
88
+ # @return [Float]
89
+ attr_accessor :phone_lead_responsiveness
90
+
91
+ # Number of charged leads the account received in previous specified period.
92
+ # Corresponds to the JSON property `previousPeriodChargedLeads`
93
+ # @return [Fixnum]
94
+ attr_accessor :previous_period_charged_leads
95
+
96
+ # Number of connected phone calls (duration over 30s) in previous specified
97
+ # period.
98
+ # Corresponds to the JSON property `previousPeriodConnectedPhoneCalls`
99
+ # @return [Fixnum]
100
+ attr_accessor :previous_period_connected_phone_calls
101
+
102
+ # Number of phone calls in previous specified period, including both connected
103
+ # and unconnected calls.
104
+ # Corresponds to the JSON property `previousPeriodPhoneCalls`
105
+ # @return [Fixnum]
106
+ attr_accessor :previous_period_phone_calls
107
+
108
+ # Total cost of the account in previous specified period in the account's
109
+ # specified currency.
110
+ # Corresponds to the JSON property `previousPeriodTotalCost`
111
+ # @return [Float]
112
+ attr_accessor :previous_period_total_cost
113
+
114
+ # Total number of reviews the account has up to current date.
115
+ # Corresponds to the JSON property `totalReview`
116
+ # @return [Fixnum]
117
+ attr_accessor :total_review
118
+
119
+ def initialize(**args)
120
+ update!(**args)
121
+ end
122
+
123
+ # Update properties of this object
124
+ def update!(**args)
125
+ @account_id = args[:account_id] if args.key?(:account_id)
126
+ @aggregator_info = args[:aggregator_info] if args.key?(:aggregator_info)
127
+ @average_five_star_rating = args[:average_five_star_rating] if args.key?(:average_five_star_rating)
128
+ @average_weekly_budget = args[:average_weekly_budget] if args.key?(:average_weekly_budget)
129
+ @business_name = args[:business_name] if args.key?(:business_name)
130
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
131
+ @current_period_charged_leads = args[:current_period_charged_leads] if args.key?(:current_period_charged_leads)
132
+ @current_period_connected_phone_calls = args[:current_period_connected_phone_calls] if args.key?(:current_period_connected_phone_calls)
133
+ @current_period_phone_calls = args[:current_period_phone_calls] if args.key?(:current_period_phone_calls)
134
+ @current_period_total_cost = args[:current_period_total_cost] if args.key?(:current_period_total_cost)
135
+ @phone_lead_responsiveness = args[:phone_lead_responsiveness] if args.key?(:phone_lead_responsiveness)
136
+ @previous_period_charged_leads = args[:previous_period_charged_leads] if args.key?(:previous_period_charged_leads)
137
+ @previous_period_connected_phone_calls = args[:previous_period_connected_phone_calls] if args.key?(:previous_period_connected_phone_calls)
138
+ @previous_period_phone_calls = args[:previous_period_phone_calls] if args.key?(:previous_period_phone_calls)
139
+ @previous_period_total_cost = args[:previous_period_total_cost] if args.key?(:previous_period_total_cost)
140
+ @total_review = args[:total_review] if args.key?(:total_review)
141
+ end
142
+ end
143
+
144
+ # Conatiner for aggregator specific information if lead is for an aggregator GLS
145
+ # account.
146
+ class GoogleAdsHomeservicesLocalservicesV1AggregatorInfo
147
+ include Google::Apis::Core::Hashable
148
+
149
+ # Provider id (listed in aggregator system) which maps to a account id in GLS
150
+ # system.
151
+ # Corresponds to the JSON property `aggregatorProviderId`
152
+ # @return [String]
153
+ attr_accessor :aggregator_provider_id
154
+
155
+ def initialize(**args)
156
+ update!(**args)
157
+ end
158
+
159
+ # Update properties of this object
160
+ def update!(**args)
161
+ @aggregator_provider_id = args[:aggregator_provider_id] if args.key?(:aggregator_provider_id)
162
+ end
163
+ end
164
+
165
+ # A Detailed Lead Report of a lead identified by their lead id and contains
166
+ # consumer, account, monetization, and lead data.
167
+ class GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport
168
+ include Google::Apis::Core::Hashable
169
+
170
+ # Identifies account that received the lead.
171
+ # Corresponds to the JSON property `accountId`
172
+ # @return [Fixnum]
173
+ attr_accessor :account_id
174
+
175
+ # Conatiner for aggregator specific information if lead is for an aggregator GLS
176
+ # account.
177
+ # Corresponds to the JSON property `aggregatorInfo`
178
+ # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo]
179
+ attr_accessor :aggregator_info
180
+
181
+ # Business name associated to the account.
182
+ # Corresponds to the JSON property `businessName`
183
+ # @return [String]
184
+ attr_accessor :business_name
185
+
186
+ # Whether the lead has been charged.
187
+ # Corresponds to the JSON property `chargeStatus`
188
+ # @return [String]
189
+ attr_accessor :charge_status
190
+
191
+ # Currency code.
192
+ # Corresponds to the JSON property `currencyCode`
193
+ # @return [String]
194
+ attr_accessor :currency_code
195
+
196
+ # Dispute status related to the lead.
197
+ # Corresponds to the JSON property `disputeStatus`
198
+ # @return [String]
199
+ attr_accessor :dispute_status
200
+
201
+ # Location of the associated account's home city.
202
+ # Corresponds to the JSON property `geo`
203
+ # @return [String]
204
+ attr_accessor :geo
205
+
206
+ # Lead category (e.g. hvac, plumber)
207
+ # Corresponds to the JSON property `leadCategory`
208
+ # @return [String]
209
+ attr_accessor :lead_category
210
+
211
+ # Timestamp of when the lead was created.
212
+ # Corresponds to the JSON property `leadCreationTimestamp`
213
+ # @return [String]
214
+ attr_accessor :lead_creation_timestamp
215
+
216
+ # Unique identifier of a Detailed Lead Report.
217
+ # Corresponds to the JSON property `leadId`
218
+ # @return [Fixnum]
219
+ attr_accessor :lead_id
220
+
221
+ # Price of the lead (available only after it has been charged).
222
+ # Corresponds to the JSON property `leadPrice`
223
+ # @return [Float]
224
+ attr_accessor :lead_price
225
+
226
+ # Lead type.
227
+ # Corresponds to the JSON property `leadType`
228
+ # @return [String]
229
+ attr_accessor :lead_type
230
+
231
+ # Container for message lead specific information.
232
+ # Corresponds to the JSON property `messageLead`
233
+ # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1MessageLead]
234
+ attr_accessor :message_lead
235
+
236
+ # Container for phone lead specific information.
237
+ # Corresponds to the JSON property `phoneLead`
238
+ # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1PhoneLead]
239
+ attr_accessor :phone_lead
240
+
241
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
242
+ # time-zones).
243
+ # Corresponds to the JSON property `timezone`
244
+ # @return [Google::Apis::LocalservicesV1::GoogleTypeTimeZone]
245
+ attr_accessor :timezone
246
+
247
+ def initialize(**args)
248
+ update!(**args)
249
+ end
250
+
251
+ # Update properties of this object
252
+ def update!(**args)
253
+ @account_id = args[:account_id] if args.key?(:account_id)
254
+ @aggregator_info = args[:aggregator_info] if args.key?(:aggregator_info)
255
+ @business_name = args[:business_name] if args.key?(:business_name)
256
+ @charge_status = args[:charge_status] if args.key?(:charge_status)
257
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
258
+ @dispute_status = args[:dispute_status] if args.key?(:dispute_status)
259
+ @geo = args[:geo] if args.key?(:geo)
260
+ @lead_category = args[:lead_category] if args.key?(:lead_category)
261
+ @lead_creation_timestamp = args[:lead_creation_timestamp] if args.key?(:lead_creation_timestamp)
262
+ @lead_id = args[:lead_id] if args.key?(:lead_id)
263
+ @lead_price = args[:lead_price] if args.key?(:lead_price)
264
+ @lead_type = args[:lead_type] if args.key?(:lead_type)
265
+ @message_lead = args[:message_lead] if args.key?(:message_lead)
266
+ @phone_lead = args[:phone_lead] if args.key?(:phone_lead)
267
+ @timezone = args[:timezone] if args.key?(:timezone)
268
+ end
269
+ end
270
+
271
+ # Container for message lead specific information.
272
+ class GoogleAdsHomeservicesLocalservicesV1MessageLead
273
+ include Google::Apis::Core::Hashable
274
+
275
+ # Consumer phone number associated with the message lead.
276
+ # Corresponds to the JSON property `consumerPhoneNumber`
277
+ # @return [String]
278
+ attr_accessor :consumer_phone_number
279
+
280
+ # Name of the customer who created the lead.
281
+ # Corresponds to the JSON property `customerName`
282
+ # @return [String]
283
+ attr_accessor :customer_name
284
+
285
+ # The job type of the specified lead.
286
+ # Corresponds to the JSON property `jobType`
287
+ # @return [String]
288
+ attr_accessor :job_type
289
+
290
+ # The postal code of the customer who created the lead.
291
+ # Corresponds to the JSON property `postalCode`
292
+ # @return [String]
293
+ attr_accessor :postal_code
294
+
295
+ def initialize(**args)
296
+ update!(**args)
297
+ end
298
+
299
+ # Update properties of this object
300
+ def update!(**args)
301
+ @consumer_phone_number = args[:consumer_phone_number] if args.key?(:consumer_phone_number)
302
+ @customer_name = args[:customer_name] if args.key?(:customer_name)
303
+ @job_type = args[:job_type] if args.key?(:job_type)
304
+ @postal_code = args[:postal_code] if args.key?(:postal_code)
305
+ end
306
+ end
307
+
308
+ # Container for phone lead specific information.
309
+ class GoogleAdsHomeservicesLocalservicesV1PhoneLead
310
+ include Google::Apis::Core::Hashable
311
+
312
+ # Timestamp of the phone call which resulted in a charged phone lead.
313
+ # Corresponds to the JSON property `chargedCallTimestamp`
314
+ # @return [String]
315
+ attr_accessor :charged_call_timestamp
316
+
317
+ # Duration of the charged phone call in seconds.
318
+ # Corresponds to the JSON property `chargedConnectedCallDurationSeconds`
319
+ # @return [String]
320
+ attr_accessor :charged_connected_call_duration_seconds
321
+
322
+ # Consumer phone number associated with the phone lead.
323
+ # Corresponds to the JSON property `consumerPhoneNumber`
324
+ # @return [String]
325
+ attr_accessor :consumer_phone_number
326
+
327
+ def initialize(**args)
328
+ update!(**args)
329
+ end
330
+
331
+ # Update properties of this object
332
+ def update!(**args)
333
+ @charged_call_timestamp = args[:charged_call_timestamp] if args.key?(:charged_call_timestamp)
334
+ @charged_connected_call_duration_seconds = args[:charged_connected_call_duration_seconds] if args.key?(:charged_connected_call_duration_seconds)
335
+ @consumer_phone_number = args[:consumer_phone_number] if args.key?(:consumer_phone_number)
336
+ end
337
+ end
338
+
339
+ # A page of the response received from the SearchAccountReports method. A
340
+ # paginated response where more pages are available has `next_page_token` set.
341
+ # This token can be used in a subsequent request to retrieve the next request
342
+ # page.
343
+ class GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse
344
+ include Google::Apis::Core::Hashable
345
+
346
+ # List of account reports which maps 1:1 to a particular linked GLS account.
347
+ # Corresponds to the JSON property `accountReports`
348
+ # @return [Array<Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AccountReport>]
349
+ attr_accessor :account_reports
350
+
351
+ # Pagination token to retrieve the next page of results. When `next_page_token`
352
+ # is not filled in, there is no next page and the list returned is the last page
353
+ # in the result set.
354
+ # Corresponds to the JSON property `nextPageToken`
355
+ # @return [String]
356
+ attr_accessor :next_page_token
357
+
358
+ def initialize(**args)
359
+ update!(**args)
360
+ end
361
+
362
+ # Update properties of this object
363
+ def update!(**args)
364
+ @account_reports = args[:account_reports] if args.key?(:account_reports)
365
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
366
+ end
367
+ end
368
+
369
+ # A page of the response received from the SearchDetailedLeadReports method. A
370
+ # paginated response where more pages are available has `next_page_token` set.
371
+ # This token can be used in a subsequent request to retrieve the next request
372
+ # page.
373
+ class GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse
374
+ include Google::Apis::Core::Hashable
375
+
376
+ # List of detailed lead reports uniquely identified by external lead id.
377
+ # Corresponds to the JSON property `detailedLeadReports`
378
+ # @return [Array<Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport>]
379
+ attr_accessor :detailed_lead_reports
380
+
381
+ # Pagination token to retrieve the next page of results. When `next_page_token`
382
+ # is not filled in, there is no next page and the list returned is the last page
383
+ # in the result set.
384
+ # Corresponds to the JSON property `nextPageToken`
385
+ # @return [String]
386
+ attr_accessor :next_page_token
387
+
388
+ def initialize(**args)
389
+ update!(**args)
390
+ end
391
+
392
+ # Update properties of this object
393
+ def update!(**args)
394
+ @detailed_lead_reports = args[:detailed_lead_reports] if args.key?(:detailed_lead_reports)
395
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
396
+ end
397
+ end
398
+
399
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
400
+ # time-zones).
401
+ class GoogleTypeTimeZone
402
+ include Google::Apis::Core::Hashable
403
+
404
+ # IANA Time Zone Database time zone, e.g. "America/New_York".
405
+ # Corresponds to the JSON property `id`
406
+ # @return [String]
407
+ attr_accessor :id
408
+
409
+ # Optional. IANA Time Zone Database version number, e.g. "2019a".
410
+ # Corresponds to the JSON property `version`
411
+ # @return [String]
412
+ attr_accessor :version
413
+
414
+ def initialize(**args)
415
+ update!(**args)
416
+ end
417
+
418
+ # Update properties of this object
419
+ def update!(**args)
420
+ @id = args[:id] if args.key?(:id)
421
+ @version = args[:version] if args.key?(:version)
422
+ end
423
+ end
424
+ end
425
+ end
426
+ 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 LocalservicesV1
18
+ # Version of the google-apis-localservices_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.1.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20201213"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,174 @@
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 LocalservicesV1
24
+
25
+ class GoogleAdsHomeservicesLocalservicesV1AccountReport
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class GoogleAdsHomeservicesLocalservicesV1AggregatorInfo
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class GoogleAdsHomeservicesLocalservicesV1MessageLead
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class GoogleAdsHomeservicesLocalservicesV1PhoneLead
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class GoogleTypeTimeZone
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class GoogleAdsHomeservicesLocalservicesV1AccountReport
74
+ # @private
75
+ class Representation < Google::Apis::Core::JsonRepresentation
76
+ property :account_id, :numeric_string => true, as: 'accountId'
77
+ property :aggregator_info, as: 'aggregatorInfo', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo::Representation
78
+
79
+ property :average_five_star_rating, as: 'averageFiveStarRating'
80
+ property :average_weekly_budget, as: 'averageWeeklyBudget'
81
+ property :business_name, as: 'businessName'
82
+ property :currency_code, as: 'currencyCode'
83
+ property :current_period_charged_leads, :numeric_string => true, as: 'currentPeriodChargedLeads'
84
+ property :current_period_connected_phone_calls, :numeric_string => true, as: 'currentPeriodConnectedPhoneCalls'
85
+ property :current_period_phone_calls, :numeric_string => true, as: 'currentPeriodPhoneCalls'
86
+ property :current_period_total_cost, as: 'currentPeriodTotalCost'
87
+ property :phone_lead_responsiveness, as: 'phoneLeadResponsiveness'
88
+ property :previous_period_charged_leads, :numeric_string => true, as: 'previousPeriodChargedLeads'
89
+ property :previous_period_connected_phone_calls, :numeric_string => true, as: 'previousPeriodConnectedPhoneCalls'
90
+ property :previous_period_phone_calls, :numeric_string => true, as: 'previousPeriodPhoneCalls'
91
+ property :previous_period_total_cost, as: 'previousPeriodTotalCost'
92
+ property :total_review, as: 'totalReview'
93
+ end
94
+ end
95
+
96
+ class GoogleAdsHomeservicesLocalservicesV1AggregatorInfo
97
+ # @private
98
+ class Representation < Google::Apis::Core::JsonRepresentation
99
+ property :aggregator_provider_id, as: 'aggregatorProviderId'
100
+ end
101
+ end
102
+
103
+ class GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport
104
+ # @private
105
+ class Representation < Google::Apis::Core::JsonRepresentation
106
+ property :account_id, :numeric_string => true, as: 'accountId'
107
+ property :aggregator_info, as: 'aggregatorInfo', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo::Representation
108
+
109
+ property :business_name, as: 'businessName'
110
+ property :charge_status, as: 'chargeStatus'
111
+ property :currency_code, as: 'currencyCode'
112
+ property :dispute_status, as: 'disputeStatus'
113
+ property :geo, as: 'geo'
114
+ property :lead_category, as: 'leadCategory'
115
+ property :lead_creation_timestamp, as: 'leadCreationTimestamp'
116
+ property :lead_id, :numeric_string => true, as: 'leadId'
117
+ property :lead_price, as: 'leadPrice'
118
+ property :lead_type, as: 'leadType'
119
+ property :message_lead, as: 'messageLead', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1MessageLead, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1MessageLead::Representation
120
+
121
+ property :phone_lead, as: 'phoneLead', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1PhoneLead, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1PhoneLead::Representation
122
+
123
+ property :timezone, as: 'timezone', class: Google::Apis::LocalservicesV1::GoogleTypeTimeZone, decorator: Google::Apis::LocalservicesV1::GoogleTypeTimeZone::Representation
124
+
125
+ end
126
+ end
127
+
128
+ class GoogleAdsHomeservicesLocalservicesV1MessageLead
129
+ # @private
130
+ class Representation < Google::Apis::Core::JsonRepresentation
131
+ property :consumer_phone_number, as: 'consumerPhoneNumber'
132
+ property :customer_name, as: 'customerName'
133
+ property :job_type, as: 'jobType'
134
+ property :postal_code, as: 'postalCode'
135
+ end
136
+ end
137
+
138
+ class GoogleAdsHomeservicesLocalservicesV1PhoneLead
139
+ # @private
140
+ class Representation < Google::Apis::Core::JsonRepresentation
141
+ property :charged_call_timestamp, as: 'chargedCallTimestamp'
142
+ property :charged_connected_call_duration_seconds, as: 'chargedConnectedCallDurationSeconds'
143
+ property :consumer_phone_number, as: 'consumerPhoneNumber'
144
+ end
145
+ end
146
+
147
+ class GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse
148
+ # @private
149
+ class Representation < Google::Apis::Core::JsonRepresentation
150
+ collection :account_reports, as: 'accountReports', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AccountReport, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AccountReport::Representation
151
+
152
+ property :next_page_token, as: 'nextPageToken'
153
+ end
154
+ end
155
+
156
+ class GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse
157
+ # @private
158
+ class Representation < Google::Apis::Core::JsonRepresentation
159
+ collection :detailed_lead_reports, as: 'detailedLeadReports', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport::Representation
160
+
161
+ property :next_page_token, as: 'nextPageToken'
162
+ end
163
+ end
164
+
165
+ class GoogleTypeTimeZone
166
+ # @private
167
+ class Representation < Google::Apis::Core::JsonRepresentation
168
+ property :id, as: 'id'
169
+ property :version, as: 'version'
170
+ end
171
+ end
172
+ end
173
+ end
174
+ end
@@ -0,0 +1,201 @@
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 LocalservicesV1
23
+ # Local Services API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/localservices_v1'
29
+ #
30
+ # Localservices = Google::Apis::LocalservicesV1 # Alias the module
31
+ # service = Localservices::LocalservicesService.new
32
+ #
33
+ # @see https://ads.google.com/local-services-ads/
34
+ class LocalservicesService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://localservices.googleapis.com/', '',
47
+ client_name: 'google-apis-localservices_v1',
48
+ client_version: Google::Apis::LocalservicesV1::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Get account reports containing aggregate account data of all linked GLS
53
+ # accounts. Caller needs to provide their manager customer id and the associated
54
+ # auth credential that allows them read permissions on their linked accounts.
55
+ # @param [Fixnum] end_date_day
56
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
57
+ # specify a year by itself or a year and month where the day isn't significant.
58
+ # @param [Fixnum] end_date_month
59
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
60
+ # and day.
61
+ # @param [Fixnum] end_date_year
62
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
63
+ # year.
64
+ # @param [Fixnum] page_size
65
+ # The maximum number of accounts to return. If the page size is unset, page size
66
+ # will default to 1000. Maximum page_size is 10000. Optional.
67
+ # @param [String] page_token
68
+ # The `next_page_token` value returned from a previous request to
69
+ # SearchAccountReports that indicates where listing should continue. Optional.
70
+ # @param [String] query
71
+ # A query string for searching for account reports. Caller must provide a
72
+ # customer id of their MCC account with an associated Gaia Mint that allows read
73
+ # permission on their linked accounts. Search expressions are case insensitive.
74
+ # Example query: | Query | Description | |-------------------------|-------------
75
+ # ----------------------------------| | manager_customer_id:123 | Get Account
76
+ # Report for Manager with id 123. | Required.
77
+ # @param [Fixnum] start_date_day
78
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
79
+ # specify a year by itself or a year and month where the day isn't significant.
80
+ # @param [Fixnum] start_date_month
81
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
82
+ # and day.
83
+ # @param [Fixnum] start_date_year
84
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
85
+ # year.
86
+ # @param [String] fields
87
+ # Selector specifying which fields to include in a partial response.
88
+ # @param [String] quota_user
89
+ # Available to use for quota purposes for server-side applications. Can be any
90
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
91
+ # @param [Google::Apis::RequestOptions] options
92
+ # Request-specific options
93
+ #
94
+ # @yield [result, err] Result & error if block supplied
95
+ # @yieldparam result [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse] parsed result object
96
+ # @yieldparam err [StandardError] error object if request failed
97
+ #
98
+ # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse]
99
+ #
100
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
101
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
102
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
103
+ def search_account_reports(end_date_day: nil, end_date_month: nil, end_date_year: nil, page_size: nil, page_token: nil, query: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
104
+ command = make_simple_command(:get, 'v1/accountReports:search', options)
105
+ command.response_representation = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse::Representation
106
+ command.response_class = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse
107
+ command.query['endDate.day'] = end_date_day unless end_date_day.nil?
108
+ command.query['endDate.month'] = end_date_month unless end_date_month.nil?
109
+ command.query['endDate.year'] = end_date_year unless end_date_year.nil?
110
+ command.query['pageSize'] = page_size unless page_size.nil?
111
+ command.query['pageToken'] = page_token unless page_token.nil?
112
+ command.query['query'] = query unless query.nil?
113
+ command.query['startDate.day'] = start_date_day unless start_date_day.nil?
114
+ command.query['startDate.month'] = start_date_month unless start_date_month.nil?
115
+ command.query['startDate.year'] = start_date_year unless start_date_year.nil?
116
+ command.query['fields'] = fields unless fields.nil?
117
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
118
+ execute_or_queue_command(command, &block)
119
+ end
120
+
121
+ # Get detailed lead reports containing leads that have been received by all
122
+ # linked GLS accounts. Caller needs to provide their manager customer id and the
123
+ # associated auth credential that allows them read permissions on their linked
124
+ # accounts.
125
+ # @param [Fixnum] end_date_day
126
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
127
+ # specify a year by itself or a year and month where the day isn't significant.
128
+ # @param [Fixnum] end_date_month
129
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
130
+ # and day.
131
+ # @param [Fixnum] end_date_year
132
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
133
+ # year.
134
+ # @param [Fixnum] page_size
135
+ # The maximum number of accounts to return. If the page size is unset, page size
136
+ # will default to 1000. Maximum page_size is 10000. Optional.
137
+ # @param [String] page_token
138
+ # The `next_page_token` value returned from a previous request to
139
+ # SearchDetailedLeadReports that indicates where listing should continue.
140
+ # Optional.
141
+ # @param [String] query
142
+ # A query string for searching for account reports. Caller must provide a
143
+ # customer id of their MCC account with an associated Gaia Mint that allows read
144
+ # permission on their linked accounts. Search expressions are case insensitive.
145
+ # Example query: | Query | Description | |-------------------------|-------------
146
+ # ----------------------------------| | manager_customer_id:123 | Get Detailed
147
+ # Lead Report for Manager with id | | | 123. | Required.
148
+ # @param [Fixnum] start_date_day
149
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
150
+ # specify a year by itself or a year and month where the day isn't significant.
151
+ # @param [Fixnum] start_date_month
152
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
153
+ # and day.
154
+ # @param [Fixnum] start_date_year
155
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
156
+ # year.
157
+ # @param [String] fields
158
+ # Selector specifying which fields to include in a partial response.
159
+ # @param [String] quota_user
160
+ # Available to use for quota purposes for server-side applications. Can be any
161
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
162
+ # @param [Google::Apis::RequestOptions] options
163
+ # Request-specific options
164
+ #
165
+ # @yield [result, err] Result & error if block supplied
166
+ # @yieldparam result [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse] parsed result object
167
+ # @yieldparam err [StandardError] error object if request failed
168
+ #
169
+ # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse]
170
+ #
171
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
172
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
173
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
174
+ def search_detailed_lead_reports(end_date_day: nil, end_date_month: nil, end_date_year: nil, page_size: nil, page_token: nil, query: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
175
+ command = make_simple_command(:get, 'v1/detailedLeadReports:search', options)
176
+ command.response_representation = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse::Representation
177
+ command.response_class = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse
178
+ command.query['endDate.day'] = end_date_day unless end_date_day.nil?
179
+ command.query['endDate.month'] = end_date_month unless end_date_month.nil?
180
+ command.query['endDate.year'] = end_date_year unless end_date_year.nil?
181
+ command.query['pageSize'] = page_size unless page_size.nil?
182
+ command.query['pageToken'] = page_token unless page_token.nil?
183
+ command.query['query'] = query unless query.nil?
184
+ command.query['startDate.day'] = start_date_day unless start_date_day.nil?
185
+ command.query['startDate.month'] = start_date_month unless start_date_month.nil?
186
+ command.query['startDate.year'] = start_date_year unless start_date_year.nil?
187
+ command.query['fields'] = fields unless fields.nil?
188
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
189
+ execute_or_queue_command(command, &block)
190
+ end
191
+
192
+ protected
193
+
194
+ def apply_command_defaults(command)
195
+ command.query['key'] = key unless key.nil?
196
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
197
+ end
198
+ end
199
+ end
200
+ end
201
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-localservices_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: 2021-01-08 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.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ description: This is the simple REST client for Local Services API V1. Simple REST
28
+ clients are Ruby client libraries that provide access to Google services via their
29
+ HTTP REST API endpoints. These libraries are generated and updated automatically
30
+ based on the discovery documents published by the service, and they handle most
31
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
32
+ use this client to access the Local Services API, but note that some services may
33
+ provide a separate modern client that is easier to use.
34
+ email: googleapis-packages@google.com
35
+ executables: []
36
+ extensions: []
37
+ extra_rdoc_files: []
38
+ files:
39
+ - ".yardopts"
40
+ - CHANGELOG.md
41
+ - LICENSE.md
42
+ - OVERVIEW.md
43
+ - lib/google-apis-localservices_v1.rb
44
+ - lib/google/apis/localservices_v1.rb
45
+ - lib/google/apis/localservices_v1/classes.rb
46
+ - lib/google/apis/localservices_v1/gem_version.rb
47
+ - lib/google/apis/localservices_v1/representations.rb
48
+ - lib/google/apis/localservices_v1/service.rb
49
+ homepage: https://github.com/google/google-api-ruby-client
50
+ licenses:
51
+ - Apache-2.0
52
+ metadata:
53
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-localservices_v1/CHANGELOG.md
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-localservices_v1/v0.1.0
56
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-localservices_v1
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: '2.4'
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ requirements: []
72
+ rubygems_version: 3.1.4
73
+ signing_key:
74
+ specification_version: 4
75
+ summary: Simple REST client for Local Services API V1
76
+ test_files: []