google-apis-merchantapi_conversions_v1beta 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 7a1b477030d6397d27632bcf2fe1e3c1e747a1a78213cb21aa87050842ec9883
4
+ data.tar.gz: bd4733d59741c00161e674a325ced5c01fd1e663c3d168741761b67be15896c6
5
+ SHA512:
6
+ metadata.gz: 74d9f8e6726a9446195120c13006dc9eb38d80afcff7984b6aa12b3d7aa251eecc66dab523c78547f80172f5b6948d485354e4c7e526f93bfa130248f5608ad1
7
+ data.tar.gz: 8c60c184ef4e8d37ce724026a754fac24bda8377fc926cf909da47abc69a3c0da5c9f38e8ffeb9be229bb5ea0bc48393649b81ee5af6a1cf416e8fe10d70a337
data/.yardopts ADDED
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-merchantapi_conversions_v1beta
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/merchantapi_conversions_v1beta/*.rb
9
+ lib/google/apis/merchantapi_conversions_v1beta.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-merchantapi_conversions_v1beta
2
+
3
+ ### v0.1.0 (2024-06-27)
4
+
5
+ * Regenerated from discovery document revision 20240611
6
+ * Regenerated using generator version 0.15.0
7
+
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 ConversionsV1beta of the Merchant API
2
+
3
+ This is a simple client library for version ConversionsV1beta of the Merchant 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/merchantapi.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-merchantapi_conversions_v1beta', '~> 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-merchantapi_conversions_v1beta
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/merchantapi_conversions_v1beta"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::MerchantapiConversionsV1beta::MerchantService.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 Merchantapi service in particular.)
67
+
68
+ For reference information on specific calls in the Merchant API, see the {Google::Apis::MerchantapiConversionsV1beta::MerchantService 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-merchantapi_conversions_v1beta`, 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.devsite.corp.google.com/merchant/api) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.7+.
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. 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,379 @@
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 MerchantapiConversionsV1beta
24
+
25
+ # Represents attribution settings for conversion sources receiving pre-
26
+ # attribution data.
27
+ class AttributionSettings
28
+ include Google::Apis::Core::Hashable
29
+
30
+ # Required. Lookback windows (in days) used for attribution in this source.
31
+ # Supported values are 7, 30, 40.
32
+ # Corresponds to the JSON property `attributionLookbackWindowDays`
33
+ # @return [Fixnum]
34
+ attr_accessor :attribution_lookback_window_days
35
+
36
+ # Required. Attribution model.
37
+ # Corresponds to the JSON property `attributionModel`
38
+ # @return [String]
39
+ attr_accessor :attribution_model
40
+
41
+ # Immutable. Unordered list. List of different conversion types a conversion
42
+ # event can be classified as. A standard "purchase" type will be automatically
43
+ # created if this list is empty at creation time.
44
+ # Corresponds to the JSON property `conversionType`
45
+ # @return [Array<Google::Apis::MerchantapiConversionsV1beta::ConversionType>]
46
+ attr_accessor :conversion_type
47
+
48
+ def initialize(**args)
49
+ update!(**args)
50
+ end
51
+
52
+ # Update properties of this object
53
+ def update!(**args)
54
+ @attribution_lookback_window_days = args[:attribution_lookback_window_days] if args.key?(:attribution_lookback_window_days)
55
+ @attribution_model = args[:attribution_model] if args.key?(:attribution_model)
56
+ @conversion_type = args[:conversion_type] if args.key?(:conversion_type)
57
+ end
58
+ end
59
+
60
+ # Represents a conversion source owned by a Merchant account. A merchant account
61
+ # can have up to 200 conversion sources.
62
+ class ConversionSource
63
+ include Google::Apis::Core::Hashable
64
+
65
+ # Output only. Controller of the conversion source.
66
+ # Corresponds to the JSON property `controller`
67
+ # @return [String]
68
+ attr_accessor :controller
69
+
70
+ # Output only. The time when an archived conversion source becomes permanently
71
+ # deleted and is no longer available to undelete.
72
+ # Corresponds to the JSON property `expireTime`
73
+ # @return [String]
74
+ attr_accessor :expire_time
75
+
76
+ # "Google Analytics Link" sources can be used to get conversion data from an
77
+ # existing Google Analytics property into the linked Merchant Center account.
78
+ # Corresponds to the JSON property `googleAnalyticsLink`
79
+ # @return [Google::Apis::MerchantapiConversionsV1beta::GoogleAnalyticsLink]
80
+ attr_accessor :google_analytics_link
81
+
82
+ # "Merchant Center Destination" sources can be used to send conversion events
83
+ # from an online store using a Google tag directly to a Merchant Center account
84
+ # where the source is created.
85
+ # Corresponds to the JSON property `merchantCenterDestination`
86
+ # @return [Google::Apis::MerchantapiConversionsV1beta::MerchantCenterDestination]
87
+ attr_accessor :merchant_center_destination
88
+
89
+ # Output only. Identifier. Generated by the Content API upon creation of a new `
90
+ # ConversionSource`. Format: [a-z]`4`:.+ The four characters before the colon
91
+ # represent the type of conversio source. Content after the colon represents the
92
+ # ID of the conversion source within that type. The ID of two different
93
+ # conversion sources might be the same across different types. The following
94
+ # type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn:
95
+ # For MerchantCenterDestination sources.
96
+ # Corresponds to the JSON property `name`
97
+ # @return [String]
98
+ attr_accessor :name
99
+
100
+ # Output only. Current state of this conversion source. Can't be edited through
101
+ # the API.
102
+ # Corresponds to the JSON property `state`
103
+ # @return [String]
104
+ attr_accessor :state
105
+
106
+ def initialize(**args)
107
+ update!(**args)
108
+ end
109
+
110
+ # Update properties of this object
111
+ def update!(**args)
112
+ @controller = args[:controller] if args.key?(:controller)
113
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
114
+ @google_analytics_link = args[:google_analytics_link] if args.key?(:google_analytics_link)
115
+ @merchant_center_destination = args[:merchant_center_destination] if args.key?(:merchant_center_destination)
116
+ @name = args[:name] if args.key?(:name)
117
+ @state = args[:state] if args.key?(:state)
118
+ end
119
+ end
120
+
121
+ # Message representing a types of conversion events
122
+ class ConversionType
123
+ include Google::Apis::Core::Hashable
124
+
125
+ # Output only. Conversion event name, as it'll be reported by the client.
126
+ # Corresponds to the JSON property `name`
127
+ # @return [String]
128
+ attr_accessor :name
129
+
130
+ # Output only. Option indicating if the type should be included in Merchant
131
+ # Center reporting.
132
+ # Corresponds to the JSON property `report`
133
+ # @return [Boolean]
134
+ attr_accessor :report
135
+ alias_method :report?, :report
136
+
137
+ def initialize(**args)
138
+ update!(**args)
139
+ end
140
+
141
+ # Update properties of this object
142
+ def update!(**args)
143
+ @name = args[:name] if args.key?(:name)
144
+ @report = args[:report] if args.key?(:report)
145
+ end
146
+ end
147
+
148
+ # A generic empty message that you can re-use to avoid defining duplicated empty
149
+ # messages in your APIs. A typical example is to use it as the request or the
150
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
151
+ # protobuf.Empty) returns (google.protobuf.Empty); `
152
+ class Empty
153
+ include Google::Apis::Core::Hashable
154
+
155
+ def initialize(**args)
156
+ update!(**args)
157
+ end
158
+
159
+ # Update properties of this object
160
+ def update!(**args)
161
+ end
162
+ end
163
+
164
+ # "Google Analytics Link" sources can be used to get conversion data from an
165
+ # existing Google Analytics property into the linked Merchant Center account.
166
+ class GoogleAnalyticsLink
167
+ include Google::Apis::Core::Hashable
168
+
169
+ # Represents attribution settings for conversion sources receiving pre-
170
+ # attribution data.
171
+ # Corresponds to the JSON property `attributionSettings`
172
+ # @return [Google::Apis::MerchantapiConversionsV1beta::AttributionSettings]
173
+ attr_accessor :attribution_settings
174
+
175
+ # Output only. Name of the Google Analytics property the merchant is linked to.
176
+ # Corresponds to the JSON property `property`
177
+ # @return [String]
178
+ attr_accessor :property
179
+
180
+ # Required. Immutable. ID of the Google Analytics property the merchant is
181
+ # linked to.
182
+ # Corresponds to the JSON property `propertyId`
183
+ # @return [Fixnum]
184
+ attr_accessor :property_id
185
+
186
+ def initialize(**args)
187
+ update!(**args)
188
+ end
189
+
190
+ # Update properties of this object
191
+ def update!(**args)
192
+ @attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
193
+ @property = args[:property] if args.key?(:property)
194
+ @property_id = args[:property_id] if args.key?(:property_id)
195
+ end
196
+ end
197
+
198
+ # Response message for the ListConversionSources method.
199
+ class ListConversionSourcesResponse
200
+ include Google::Apis::Core::Hashable
201
+
202
+ # List of conversion sources.
203
+ # Corresponds to the JSON property `conversionSources`
204
+ # @return [Array<Google::Apis::MerchantapiConversionsV1beta::ConversionSource>]
205
+ attr_accessor :conversion_sources
206
+
207
+ # Token to be used to fetch the next results page.
208
+ # Corresponds to the JSON property `nextPageToken`
209
+ # @return [String]
210
+ attr_accessor :next_page_token
211
+
212
+ def initialize(**args)
213
+ update!(**args)
214
+ end
215
+
216
+ # Update properties of this object
217
+ def update!(**args)
218
+ @conversion_sources = args[:conversion_sources] if args.key?(:conversion_sources)
219
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
220
+ end
221
+ end
222
+
223
+ # "Merchant Center Destination" sources can be used to send conversion events
224
+ # from an online store using a Google tag directly to a Merchant Center account
225
+ # where the source is created.
226
+ class MerchantCenterDestination
227
+ include Google::Apis::Core::Hashable
228
+
229
+ # Represents attribution settings for conversion sources receiving pre-
230
+ # attribution data.
231
+ # Corresponds to the JSON property `attributionSettings`
232
+ # @return [Google::Apis::MerchantapiConversionsV1beta::AttributionSettings]
233
+ attr_accessor :attribution_settings
234
+
235
+ # Required. Three-letter currency code (ISO 4217). The currency code defines in
236
+ # which currency the conversions sent to this destination will be reported in
237
+ # Merchant Center.
238
+ # Corresponds to the JSON property `currencyCode`
239
+ # @return [String]
240
+ attr_accessor :currency_code
241
+
242
+ # Output only. Merchant Center Destination ID.
243
+ # Corresponds to the JSON property `destination`
244
+ # @return [String]
245
+ attr_accessor :destination
246
+
247
+ # Required. Merchant-specified display name for the destination. This is the
248
+ # name that identifies the conversion source within the Merchant Center UI.
249
+ # Limited to 64 characters.
250
+ # Corresponds to the JSON property `displayName`
251
+ # @return [String]
252
+ attr_accessor :display_name
253
+
254
+ def initialize(**args)
255
+ update!(**args)
256
+ end
257
+
258
+ # Update properties of this object
259
+ def update!(**args)
260
+ @attribution_settings = args[:attribution_settings] if args.key?(:attribution_settings)
261
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
262
+ @destination = args[:destination] if args.key?(:destination)
263
+ @display_name = args[:display_name] if args.key?(:display_name)
264
+ end
265
+ end
266
+
267
+ # The change that happened to the product including old value, new value,
268
+ # country code as the region code and reporting context.
269
+ class ProductChange
270
+ include Google::Apis::Core::Hashable
271
+
272
+ # The new value of the changed resource or attribute.
273
+ # Corresponds to the JSON property `newValue`
274
+ # @return [String]
275
+ attr_accessor :new_value
276
+
277
+ # The old value of the changed resource or attribute.
278
+ # Corresponds to the JSON property `oldValue`
279
+ # @return [String]
280
+ attr_accessor :old_value
281
+
282
+ # Countries that have the change (if applicable)
283
+ # Corresponds to the JSON property `regionCode`
284
+ # @return [String]
285
+ attr_accessor :region_code
286
+
287
+ # Reporting contexts that have the change (if applicable)
288
+ # Corresponds to the JSON property `reportingContext`
289
+ # @return [String]
290
+ attr_accessor :reporting_context
291
+
292
+ def initialize(**args)
293
+ update!(**args)
294
+ end
295
+
296
+ # Update properties of this object
297
+ def update!(**args)
298
+ @new_value = args[:new_value] if args.key?(:new_value)
299
+ @old_value = args[:old_value] if args.key?(:old_value)
300
+ @region_code = args[:region_code] if args.key?(:region_code)
301
+ @reporting_context = args[:reporting_context] if args.key?(:reporting_context)
302
+ end
303
+ end
304
+
305
+ # The message that the merchant will receive to notify about product status
306
+ # change event
307
+ class ProductStatusChangeMessage
308
+ include Google::Apis::Core::Hashable
309
+
310
+ # The target account that owns the entity that changed. Format : `accounts/`
311
+ # merchant_id``
312
+ # Corresponds to the JSON property `account`
313
+ # @return [String]
314
+ attr_accessor :account
315
+
316
+ # The attribute in the resource that changed, in this case it will be always `
317
+ # Status`.
318
+ # Corresponds to the JSON property `attribute`
319
+ # @return [String]
320
+ attr_accessor :attribute
321
+
322
+ # A message to describe the change that happened to the product
323
+ # Corresponds to the JSON property `changes`
324
+ # @return [Array<Google::Apis::MerchantapiConversionsV1beta::ProductChange>]
325
+ attr_accessor :changes
326
+
327
+ # The account that manages the merchant's account. can be the same as merchant
328
+ # id if it is standalone account. Format : `accounts/`service_provider_id``
329
+ # Corresponds to the JSON property `managingAccount`
330
+ # @return [String]
331
+ attr_accessor :managing_account
332
+
333
+ # The product name. Format: ``product.name=accounts/`account`/products/`product``
334
+ # `
335
+ # Corresponds to the JSON property `resource`
336
+ # @return [String]
337
+ attr_accessor :resource
338
+
339
+ # The product id.
340
+ # Corresponds to the JSON property `resourceId`
341
+ # @return [String]
342
+ attr_accessor :resource_id
343
+
344
+ # The resource that changed, in this case it will always be `Product`.
345
+ # Corresponds to the JSON property `resourceType`
346
+ # @return [String]
347
+ attr_accessor :resource_type
348
+
349
+ def initialize(**args)
350
+ update!(**args)
351
+ end
352
+
353
+ # Update properties of this object
354
+ def update!(**args)
355
+ @account = args[:account] if args.key?(:account)
356
+ @attribute = args[:attribute] if args.key?(:attribute)
357
+ @changes = args[:changes] if args.key?(:changes)
358
+ @managing_account = args[:managing_account] if args.key?(:managing_account)
359
+ @resource = args[:resource] if args.key?(:resource)
360
+ @resource_id = args[:resource_id] if args.key?(:resource_id)
361
+ @resource_type = args[:resource_type] if args.key?(:resource_type)
362
+ end
363
+ end
364
+
365
+ # Request message for the UndeleteConversionSource method.
366
+ class UndeleteConversionSourceRequest
367
+ include Google::Apis::Core::Hashable
368
+
369
+ def initialize(**args)
370
+ update!(**args)
371
+ end
372
+
373
+ # Update properties of this object
374
+ def update!(**args)
375
+ end
376
+ end
377
+ end
378
+ end
379
+ 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 MerchantapiConversionsV1beta
18
+ # Version of the google-apis-merchantapi_conversions_v1beta gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.15.0"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20240611"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,184 @@
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 MerchantapiConversionsV1beta
24
+
25
+ class AttributionSettings
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class ConversionSource
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class ConversionType
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class Empty
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class GoogleAnalyticsLink
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class ListConversionSourcesResponse
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class MerchantCenterDestination
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class ProductChange
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class ProductStatusChangeMessage
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class UndeleteConversionSourceRequest
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class AttributionSettings
86
+ # @private
87
+ class Representation < Google::Apis::Core::JsonRepresentation
88
+ property :attribution_lookback_window_days, as: 'attributionLookbackWindowDays'
89
+ property :attribution_model, as: 'attributionModel'
90
+ collection :conversion_type, as: 'conversionType', class: Google::Apis::MerchantapiConversionsV1beta::ConversionType, decorator: Google::Apis::MerchantapiConversionsV1beta::ConversionType::Representation
91
+
92
+ end
93
+ end
94
+
95
+ class ConversionSource
96
+ # @private
97
+ class Representation < Google::Apis::Core::JsonRepresentation
98
+ property :controller, as: 'controller'
99
+ property :expire_time, as: 'expireTime'
100
+ property :google_analytics_link, as: 'googleAnalyticsLink', class: Google::Apis::MerchantapiConversionsV1beta::GoogleAnalyticsLink, decorator: Google::Apis::MerchantapiConversionsV1beta::GoogleAnalyticsLink::Representation
101
+
102
+ property :merchant_center_destination, as: 'merchantCenterDestination', class: Google::Apis::MerchantapiConversionsV1beta::MerchantCenterDestination, decorator: Google::Apis::MerchantapiConversionsV1beta::MerchantCenterDestination::Representation
103
+
104
+ property :name, as: 'name'
105
+ property :state, as: 'state'
106
+ end
107
+ end
108
+
109
+ class ConversionType
110
+ # @private
111
+ class Representation < Google::Apis::Core::JsonRepresentation
112
+ property :name, as: 'name'
113
+ property :report, as: 'report'
114
+ end
115
+ end
116
+
117
+ class Empty
118
+ # @private
119
+ class Representation < Google::Apis::Core::JsonRepresentation
120
+ end
121
+ end
122
+
123
+ class GoogleAnalyticsLink
124
+ # @private
125
+ class Representation < Google::Apis::Core::JsonRepresentation
126
+ property :attribution_settings, as: 'attributionSettings', class: Google::Apis::MerchantapiConversionsV1beta::AttributionSettings, decorator: Google::Apis::MerchantapiConversionsV1beta::AttributionSettings::Representation
127
+
128
+ property :property, as: 'property'
129
+ property :property_id, :numeric_string => true, as: 'propertyId'
130
+ end
131
+ end
132
+
133
+ class ListConversionSourcesResponse
134
+ # @private
135
+ class Representation < Google::Apis::Core::JsonRepresentation
136
+ collection :conversion_sources, as: 'conversionSources', class: Google::Apis::MerchantapiConversionsV1beta::ConversionSource, decorator: Google::Apis::MerchantapiConversionsV1beta::ConversionSource::Representation
137
+
138
+ property :next_page_token, as: 'nextPageToken'
139
+ end
140
+ end
141
+
142
+ class MerchantCenterDestination
143
+ # @private
144
+ class Representation < Google::Apis::Core::JsonRepresentation
145
+ property :attribution_settings, as: 'attributionSettings', class: Google::Apis::MerchantapiConversionsV1beta::AttributionSettings, decorator: Google::Apis::MerchantapiConversionsV1beta::AttributionSettings::Representation
146
+
147
+ property :currency_code, as: 'currencyCode'
148
+ property :destination, as: 'destination'
149
+ property :display_name, as: 'displayName'
150
+ end
151
+ end
152
+
153
+ class ProductChange
154
+ # @private
155
+ class Representation < Google::Apis::Core::JsonRepresentation
156
+ property :new_value, as: 'newValue'
157
+ property :old_value, as: 'oldValue'
158
+ property :region_code, as: 'regionCode'
159
+ property :reporting_context, as: 'reportingContext'
160
+ end
161
+ end
162
+
163
+ class ProductStatusChangeMessage
164
+ # @private
165
+ class Representation < Google::Apis::Core::JsonRepresentation
166
+ property :account, as: 'account'
167
+ property :attribute, as: 'attribute'
168
+ collection :changes, as: 'changes', class: Google::Apis::MerchantapiConversionsV1beta::ProductChange, decorator: Google::Apis::MerchantapiConversionsV1beta::ProductChange::Representation
169
+
170
+ property :managing_account, as: 'managingAccount'
171
+ property :resource, as: 'resource'
172
+ property :resource_id, as: 'resourceId'
173
+ property :resource_type, as: 'resourceType'
174
+ end
175
+ end
176
+
177
+ class UndeleteConversionSourceRequest
178
+ # @private
179
+ class Representation < Google::Apis::Core::JsonRepresentation
180
+ end
181
+ end
182
+ end
183
+ end
184
+ end
@@ -0,0 +1,283 @@
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 MerchantapiConversionsV1beta
23
+ # Merchant API
24
+ #
25
+ # Programmatically manage your Merchant Center Accounts.
26
+ #
27
+ # @example
28
+ # require 'google/apis/merchantapi_conversions_v1beta'
29
+ #
30
+ # Merchantapi = Google::Apis::MerchantapiConversionsV1beta # Alias the module
31
+ # service = Merchantapi::MerchantService.new
32
+ #
33
+ # @see https://developers.devsite.corp.google.com/merchant/api
34
+ class MerchantService < Google::Apis::Core::BaseService
35
+ DEFAULT_ENDPOINT_TEMPLATE = "https://merchantapi.$UNIVERSE_DOMAIN$/"
36
+
37
+ # @return [String]
38
+ # API key. Your API key identifies your project and provides you with API access,
39
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
40
+ attr_accessor :key
41
+
42
+ # @return [String]
43
+ # Available to use for quota purposes for server-side applications. Can be any
44
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
45
+ attr_accessor :quota_user
46
+
47
+ def initialize
48
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
49
+ client_name: 'google-apis-merchantapi_conversions_v1beta',
50
+ client_version: Google::Apis::MerchantapiConversionsV1beta::GEM_VERSION)
51
+ @batch_path = 'batch'
52
+ end
53
+
54
+ # Creates a new conversion source.
55
+ # @param [String] parent
56
+ # Required. The merchant account that will own the new conversion source. Format:
57
+ # accounts/`account`
58
+ # @param [Google::Apis::MerchantapiConversionsV1beta::ConversionSource] conversion_source_object
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [Google::Apis::RequestOptions] options
65
+ # Request-specific options
66
+ #
67
+ # @yield [result, err] Result & error if block supplied
68
+ # @yieldparam result [Google::Apis::MerchantapiConversionsV1beta::ConversionSource] parsed result object
69
+ # @yieldparam err [StandardError] error object if request failed
70
+ #
71
+ # @return [Google::Apis::MerchantapiConversionsV1beta::ConversionSource]
72
+ #
73
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
76
+ def create_account_conversion_source(parent, conversion_source_object = nil, fields: nil, quota_user: nil, options: nil, &block)
77
+ command = make_simple_command(:post, 'conversions/v1beta/{+parent}/conversionSources', options)
78
+ command.request_representation = Google::Apis::MerchantapiConversionsV1beta::ConversionSource::Representation
79
+ command.request_object = conversion_source_object
80
+ command.response_representation = Google::Apis::MerchantapiConversionsV1beta::ConversionSource::Representation
81
+ command.response_class = Google::Apis::MerchantapiConversionsV1beta::ConversionSource
82
+ command.params['parent'] = parent unless parent.nil?
83
+ command.query['fields'] = fields unless fields.nil?
84
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
85
+ execute_or_queue_command(command, &block)
86
+ end
87
+
88
+ # Archives an existing conversion source. If the conversion source is a Merchant
89
+ # Center Destination, it will be recoverable for 30 days. If the conversion
90
+ # source is a Google Analytics Link, it will be deleted immediately and can be
91
+ # restored by creating a new one.
92
+ # @param [String] name
93
+ # Required. The name of the conversion source to be deleted. Format: accounts/`
94
+ # account`/conversionSources/`conversion_source`
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::MerchantapiConversionsV1beta::Empty] parsed result object
105
+ # @yieldparam err [StandardError] error object if request failed
106
+ #
107
+ # @return [Google::Apis::MerchantapiConversionsV1beta::Empty]
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 delete_account_conversion_source(name, fields: nil, quota_user: nil, options: nil, &block)
113
+ command = make_simple_command(:delete, 'conversions/v1beta/{+name}', options)
114
+ command.response_representation = Google::Apis::MerchantapiConversionsV1beta::Empty::Representation
115
+ command.response_class = Google::Apis::MerchantapiConversionsV1beta::Empty
116
+ command.params['name'] = name unless name.nil?
117
+ command.query['fields'] = fields unless fields.nil?
118
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
119
+ execute_or_queue_command(command, &block)
120
+ end
121
+
122
+ # Fetches a conversion source.
123
+ # @param [String] name
124
+ # Required. The name of the conversion source to be fetched. Format: accounts/`
125
+ # account`/conversionsources/`conversion_source`
126
+ # @param [String] fields
127
+ # Selector specifying which fields to include in a partial response.
128
+ # @param [String] quota_user
129
+ # Available to use for quota purposes for server-side applications. Can be any
130
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
131
+ # @param [Google::Apis::RequestOptions] options
132
+ # Request-specific options
133
+ #
134
+ # @yield [result, err] Result & error if block supplied
135
+ # @yieldparam result [Google::Apis::MerchantapiConversionsV1beta::ConversionSource] parsed result object
136
+ # @yieldparam err [StandardError] error object if request failed
137
+ #
138
+ # @return [Google::Apis::MerchantapiConversionsV1beta::ConversionSource]
139
+ #
140
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
141
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
142
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
143
+ def get_account_conversion_source(name, fields: nil, quota_user: nil, options: nil, &block)
144
+ command = make_simple_command(:get, 'conversions/v1beta/{+name}', options)
145
+ command.response_representation = Google::Apis::MerchantapiConversionsV1beta::ConversionSource::Representation
146
+ command.response_class = Google::Apis::MerchantapiConversionsV1beta::ConversionSource
147
+ command.params['name'] = name unless name.nil?
148
+ command.query['fields'] = fields unless fields.nil?
149
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
150
+ execute_or_queue_command(command, &block)
151
+ end
152
+
153
+ # Retrieves the list of conversion sources the caller has access to.
154
+ # @param [String] parent
155
+ # Required. The merchant account who owns the collection of conversion sources.
156
+ # Format: accounts/`account`
157
+ # @param [Fixnum] page_size
158
+ # Optional. The maximum number of conversion sources to return in a page. If no `
159
+ # page_size` is specified, `100` is used as the default value. The maximum value
160
+ # is `200`. Values above `200` will be coerced to `200`. Regardless of
161
+ # pagination, at most `200` conversion sources are returned in total.
162
+ # @param [String] page_token
163
+ # Optional. Page token.
164
+ # @param [Boolean] show_deleted
165
+ # Optional. Show deleted (archived) option.
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::MerchantapiConversionsV1beta::ListConversionSourcesResponse] parsed result object
176
+ # @yieldparam err [StandardError] error object if request failed
177
+ #
178
+ # @return [Google::Apis::MerchantapiConversionsV1beta::ListConversionSourcesResponse]
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_account_conversion_sources(parent, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
184
+ command = make_simple_command(:get, 'conversions/v1beta/{+parent}/conversionSources', options)
185
+ command.response_representation = Google::Apis::MerchantapiConversionsV1beta::ListConversionSourcesResponse::Representation
186
+ command.response_class = Google::Apis::MerchantapiConversionsV1beta::ListConversionSourcesResponse
187
+ command.params['parent'] = parent unless parent.nil?
188
+ command.query['pageSize'] = page_size unless page_size.nil?
189
+ command.query['pageToken'] = page_token unless page_token.nil?
190
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
191
+ command.query['fields'] = fields unless fields.nil?
192
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
193
+ execute_or_queue_command(command, &block)
194
+ end
195
+
196
+ # Updates information of an existing conversion source. Available only for
197
+ # Merchant Center Destination conversion sources.
198
+ # @param [String] name
199
+ # Output only. Identifier. Generated by the Content API upon creation of a new `
200
+ # ConversionSource`. Format: [a-z]`4`:.+ The four characters before the colon
201
+ # represent the type of conversio source. Content after the colon represents the
202
+ # ID of the conversion source within that type. The ID of two different
203
+ # conversion sources might be the same across different types. The following
204
+ # type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn:
205
+ # For MerchantCenterDestination sources.
206
+ # @param [Google::Apis::MerchantapiConversionsV1beta::ConversionSource] conversion_source_object
207
+ # @param [String] update_mask
208
+ # Required. List of fields being updated.
209
+ # @param [String] fields
210
+ # Selector specifying which fields to include in a partial response.
211
+ # @param [String] quota_user
212
+ # Available to use for quota purposes for server-side applications. Can be any
213
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
214
+ # @param [Google::Apis::RequestOptions] options
215
+ # Request-specific options
216
+ #
217
+ # @yield [result, err] Result & error if block supplied
218
+ # @yieldparam result [Google::Apis::MerchantapiConversionsV1beta::ConversionSource] parsed result object
219
+ # @yieldparam err [StandardError] error object if request failed
220
+ #
221
+ # @return [Google::Apis::MerchantapiConversionsV1beta::ConversionSource]
222
+ #
223
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
224
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
225
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
226
+ def patch_account_conversion_source(name, conversion_source_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
227
+ command = make_simple_command(:patch, 'conversions/v1beta/{+name}', options)
228
+ command.request_representation = Google::Apis::MerchantapiConversionsV1beta::ConversionSource::Representation
229
+ command.request_object = conversion_source_object
230
+ command.response_representation = Google::Apis::MerchantapiConversionsV1beta::ConversionSource::Representation
231
+ command.response_class = Google::Apis::MerchantapiConversionsV1beta::ConversionSource
232
+ command.params['name'] = name unless name.nil?
233
+ command.query['updateMask'] = update_mask unless update_mask.nil?
234
+ command.query['fields'] = fields unless fields.nil?
235
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
236
+ execute_or_queue_command(command, &block)
237
+ end
238
+
239
+ # Re-enables an archived conversion source. Only Available for Merchant Center
240
+ # Destination conversion sources.
241
+ # @param [String] name
242
+ # Required. The name of the conversion source to be undeleted. Format: accounts/`
243
+ # account`/conversionSources/`conversion_source`
244
+ # @param [Google::Apis::MerchantapiConversionsV1beta::UndeleteConversionSourceRequest] undelete_conversion_source_request_object
245
+ # @param [String] fields
246
+ # Selector specifying which fields to include in a partial response.
247
+ # @param [String] quota_user
248
+ # Available to use for quota purposes for server-side applications. Can be any
249
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
250
+ # @param [Google::Apis::RequestOptions] options
251
+ # Request-specific options
252
+ #
253
+ # @yield [result, err] Result & error if block supplied
254
+ # @yieldparam result [Google::Apis::MerchantapiConversionsV1beta::ConversionSource] parsed result object
255
+ # @yieldparam err [StandardError] error object if request failed
256
+ #
257
+ # @return [Google::Apis::MerchantapiConversionsV1beta::ConversionSource]
258
+ #
259
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
260
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
261
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
262
+ def undelete_conversion_source(name, undelete_conversion_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
263
+ command = make_simple_command(:post, 'conversions/v1beta/{+name}:undelete', options)
264
+ command.request_representation = Google::Apis::MerchantapiConversionsV1beta::UndeleteConversionSourceRequest::Representation
265
+ command.request_object = undelete_conversion_source_request_object
266
+ command.response_representation = Google::Apis::MerchantapiConversionsV1beta::ConversionSource::Representation
267
+ command.response_class = Google::Apis::MerchantapiConversionsV1beta::ConversionSource
268
+ command.params['name'] = name unless name.nil?
269
+ command.query['fields'] = fields unless fields.nil?
270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
271
+ execute_or_queue_command(command, &block)
272
+ end
273
+
274
+ protected
275
+
276
+ def apply_command_defaults(command)
277
+ command.query['key'] = key unless key.nil?
278
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
279
+ end
280
+ end
281
+ end
282
+ end
283
+ end
@@ -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/merchantapi_conversions_v1beta/service.rb'
16
+ require 'google/apis/merchantapi_conversions_v1beta/classes.rb'
17
+ require 'google/apis/merchantapi_conversions_v1beta/representations.rb'
18
+ require 'google/apis/merchantapi_conversions_v1beta/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Merchant API
23
+ #
24
+ # Programmatically manage your Merchant Center Accounts.
25
+ #
26
+ # @see https://developers.devsite.corp.google.com/merchant/api
27
+ module MerchantapiConversionsV1beta
28
+ # Version of the Merchant API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'ConversionsV1beta'
31
+
32
+ # Manage your product listings and accounts for Google Shopping
33
+ AUTH_CONTENT = 'https://www.googleapis.com/auth/content'
34
+ end
35
+ end
36
+ 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/merchantapi_conversions_v1beta"
metadata ADDED
@@ -0,0 +1,82 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-merchantapi_conversions_v1beta
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: 2024-06-27 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.15.0
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.15.0
30
+ - - "<"
31
+ - !ruby/object:Gem::Version
32
+ version: 2.a
33
+ description: This is the simple REST client for Merchant API ConversionsV1beta. Simple
34
+ REST clients are Ruby client libraries that provide access to Google services via
35
+ 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 Merchant API, but note that some services may provide
39
+ 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-merchantapi_conversions_v1beta.rb
50
+ - lib/google/apis/merchantapi_conversions_v1beta.rb
51
+ - lib/google/apis/merchantapi_conversions_v1beta/classes.rb
52
+ - lib/google/apis/merchantapi_conversions_v1beta/gem_version.rb
53
+ - lib/google/apis/merchantapi_conversions_v1beta/representations.rb
54
+ - lib/google/apis/merchantapi_conversions_v1beta/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-merchantapi_conversions_v1beta/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-merchantapi_conversions_v1beta/v0.1.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-merchantapi_conversions_v1beta
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.7'
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.5.6
79
+ signing_key:
80
+ specification_version: 4
81
+ summary: Simple REST client for Merchant API ConversionsV1beta
82
+ test_files: []