google-apis-adexchangebuyer_v1_2 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-adexchangebuyer_v1_2.rb +15 -0
- data/lib/google/apis/adexchangebuyer_v1_2.rb +37 -0
- data/lib/google/apis/adexchangebuyer_v1_2/classes.rb +457 -0
- data/lib/google/apis/adexchangebuyer_v1_2/gem_version.rb +28 -0
- data/lib/google/apis/adexchangebuyer_v1_2/representations.rb +189 -0
- data/lib/google/apis/adexchangebuyer_v1_2/service.rb +315 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4f741496a68a0cf4df38f28b3db6198b302c37ce2725d0339b0cd9d887f612a8
|
4
|
+
data.tar.gz: 60c1fb31e5219939550eeefd3c2346a5edaba73c39af948b694e3688b8f155eb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9693ff07515e84d45e9e7a5ba4d992bf83fc0040f348d3c3ed320c1cca19b98a946ce611b8f9d899ceaea137d22c229db07bfe8ab6e98e2e51ac2f455774c309
|
7
|
+
data.tar.gz: 4fd1f64a148fc8c132080df4fad144739f4655a4466bfd6dddb29f837c8047787f561a9756ef1471f5ccdbcb96eade5ae7478094b89bd542365a47767adb16ab
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-adexchangebuyer_v1_2
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/adexchangebuyer_v1_2/*.rb
|
9
|
+
lib/google/apis/adexchangebuyer_v1_2.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V1_2 of the Ad Exchange Buyer API
|
2
|
+
|
3
|
+
This is a simple client library for version V1_2 of the Ad Exchange Buyer 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/adexchangebuyer.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-adexchangebuyer_v1_2', '~> 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-adexchangebuyer_v1_2
|
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/adexchangebuyer_v1_2"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::AdexchangebuyerV1_2::AdExchangeBuyerService.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 Adexchangebuyer service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Ad Exchange Buyer API, see the {Google::Apis::AdexchangebuyerV1_2::AdExchangeBuyerService 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-adexchangebuyer_v1_2`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
|
75
|
+
|
76
|
+
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
|
77
|
+
|
78
|
+
Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
|
79
|
+
|
80
|
+
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
|
+
|
82
|
+
The [product documentation](https://developers.google.com/ad-exchange/buyer-rest) 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/adexchangebuyer_v1_2"
|
@@ -0,0 +1,37 @@
|
|
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/adexchangebuyer_v1_2/service.rb'
|
16
|
+
require 'google/apis/adexchangebuyer_v1_2/classes.rb'
|
17
|
+
require 'google/apis/adexchangebuyer_v1_2/representations.rb'
|
18
|
+
require 'google/apis/adexchangebuyer_v1_2/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Ad Exchange Buyer API
|
23
|
+
#
|
24
|
+
# Accesses your bidding-account information, submits creatives for validation,
|
25
|
+
# finds available direct deals, and retrieves performance reports.
|
26
|
+
#
|
27
|
+
# @see https://developers.google.com/ad-exchange/buyer-rest
|
28
|
+
module AdexchangebuyerV1_2
|
29
|
+
# Version of the Ad Exchange Buyer API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1_2'
|
32
|
+
|
33
|
+
# Manage your Ad Exchange buyer account configuration
|
34
|
+
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,457 @@
|
|
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 AdexchangebuyerV1_2
|
24
|
+
|
25
|
+
# Configuration data for an Ad Exchange buyer account.
|
26
|
+
class Account
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# Your bidder locations that have distinct URLs.
|
30
|
+
# Corresponds to the JSON property `bidderLocation`
|
31
|
+
# @return [Array<Google::Apis::AdexchangebuyerV1_2::Account::BidderLocation>]
|
32
|
+
attr_accessor :bidder_location
|
33
|
+
|
34
|
+
# The nid parameter value used in cookie match requests. Please contact your
|
35
|
+
# technical account manager if you need to change this.
|
36
|
+
# Corresponds to the JSON property `cookieMatchingNid`
|
37
|
+
# @return [String]
|
38
|
+
attr_accessor :cookie_matching_nid
|
39
|
+
|
40
|
+
# The base URL used in cookie match requests.
|
41
|
+
# Corresponds to the JSON property `cookieMatchingUrl`
|
42
|
+
# @return [String]
|
43
|
+
attr_accessor :cookie_matching_url
|
44
|
+
|
45
|
+
# Account id.
|
46
|
+
# Corresponds to the JSON property `id`
|
47
|
+
# @return [Fixnum]
|
48
|
+
attr_accessor :id
|
49
|
+
|
50
|
+
# Resource type.
|
51
|
+
# Corresponds to the JSON property `kind`
|
52
|
+
# @return [String]
|
53
|
+
attr_accessor :kind
|
54
|
+
|
55
|
+
# The maximum number of active creatives that an account can have, where a
|
56
|
+
# creative is active if it was inserted or bid with in the last 30 days. Please
|
57
|
+
# contact your technical account manager if you need to change this.
|
58
|
+
# Corresponds to the JSON property `maximumActiveCreatives`
|
59
|
+
# @return [Fixnum]
|
60
|
+
attr_accessor :maximum_active_creatives
|
61
|
+
|
62
|
+
# The sum of all bidderLocation.maximumQps values cannot exceed this. Please
|
63
|
+
# contact your technical account manager if you need to change this.
|
64
|
+
# Corresponds to the JSON property `maximumTotalQps`
|
65
|
+
# @return [Fixnum]
|
66
|
+
attr_accessor :maximum_total_qps
|
67
|
+
|
68
|
+
# The number of creatives that this account inserted or bid with in the last 30
|
69
|
+
# days.
|
70
|
+
# Corresponds to the JSON property `numberActiveCreatives`
|
71
|
+
# @return [Fixnum]
|
72
|
+
attr_accessor :number_active_creatives
|
73
|
+
|
74
|
+
def initialize(**args)
|
75
|
+
update!(**args)
|
76
|
+
end
|
77
|
+
|
78
|
+
# Update properties of this object
|
79
|
+
def update!(**args)
|
80
|
+
@bidder_location = args[:bidder_location] if args.key?(:bidder_location)
|
81
|
+
@cookie_matching_nid = args[:cookie_matching_nid] if args.key?(:cookie_matching_nid)
|
82
|
+
@cookie_matching_url = args[:cookie_matching_url] if args.key?(:cookie_matching_url)
|
83
|
+
@id = args[:id] if args.key?(:id)
|
84
|
+
@kind = args[:kind] if args.key?(:kind)
|
85
|
+
@maximum_active_creatives = args[:maximum_active_creatives] if args.key?(:maximum_active_creatives)
|
86
|
+
@maximum_total_qps = args[:maximum_total_qps] if args.key?(:maximum_total_qps)
|
87
|
+
@number_active_creatives = args[:number_active_creatives] if args.key?(:number_active_creatives)
|
88
|
+
end
|
89
|
+
|
90
|
+
#
|
91
|
+
class BidderLocation
|
92
|
+
include Google::Apis::Core::Hashable
|
93
|
+
|
94
|
+
# The maximum queries per second the Ad Exchange will send.
|
95
|
+
# Corresponds to the JSON property `maximumQps`
|
96
|
+
# @return [Fixnum]
|
97
|
+
attr_accessor :maximum_qps
|
98
|
+
|
99
|
+
# The geographical region the Ad Exchange should send requests from. Only used
|
100
|
+
# by some quota systems, but always setting the value is recommended. Allowed
|
101
|
+
# values:
|
102
|
+
# - ASIA
|
103
|
+
# - EUROPE
|
104
|
+
# - US_EAST
|
105
|
+
# - US_WEST
|
106
|
+
# Corresponds to the JSON property `region`
|
107
|
+
# @return [String]
|
108
|
+
attr_accessor :region
|
109
|
+
|
110
|
+
# The URL to which the Ad Exchange will send bid requests.
|
111
|
+
# Corresponds to the JSON property `url`
|
112
|
+
# @return [String]
|
113
|
+
attr_accessor :url
|
114
|
+
|
115
|
+
def initialize(**args)
|
116
|
+
update!(**args)
|
117
|
+
end
|
118
|
+
|
119
|
+
# Update properties of this object
|
120
|
+
def update!(**args)
|
121
|
+
@maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps)
|
122
|
+
@region = args[:region] if args.key?(:region)
|
123
|
+
@url = args[:url] if args.key?(:url)
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
128
|
+
# An account feed lists Ad Exchange buyer accounts that the user has access to.
|
129
|
+
# Each entry in the feed corresponds to a single buyer account.
|
130
|
+
class AccountsList
|
131
|
+
include Google::Apis::Core::Hashable
|
132
|
+
|
133
|
+
# A list of accounts.
|
134
|
+
# Corresponds to the JSON property `items`
|
135
|
+
# @return [Array<Google::Apis::AdexchangebuyerV1_2::Account>]
|
136
|
+
attr_accessor :items
|
137
|
+
|
138
|
+
# Resource type.
|
139
|
+
# Corresponds to the JSON property `kind`
|
140
|
+
# @return [String]
|
141
|
+
attr_accessor :kind
|
142
|
+
|
143
|
+
def initialize(**args)
|
144
|
+
update!(**args)
|
145
|
+
end
|
146
|
+
|
147
|
+
# Update properties of this object
|
148
|
+
def update!(**args)
|
149
|
+
@items = args[:items] if args.key?(:items)
|
150
|
+
@kind = args[:kind] if args.key?(:kind)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
# A creative and its classification data.
|
155
|
+
class Creative
|
156
|
+
include Google::Apis::Core::Hashable
|
157
|
+
|
158
|
+
# The HTML snippet that displays the ad when inserted in the web page. If set,
|
159
|
+
# videoURL should not be set.
|
160
|
+
# Corresponds to the JSON property `HTMLSnippet`
|
161
|
+
# @return [String]
|
162
|
+
attr_accessor :html_snippet
|
163
|
+
|
164
|
+
# Account id.
|
165
|
+
# Corresponds to the JSON property `accountId`
|
166
|
+
# @return [Fixnum]
|
167
|
+
attr_accessor :account_id
|
168
|
+
|
169
|
+
# Detected advertiser id, if any. Read-only. This field should not be set in
|
170
|
+
# requests.
|
171
|
+
# Corresponds to the JSON property `advertiserId`
|
172
|
+
# @return [Array<Fixnum>]
|
173
|
+
attr_accessor :advertiser_id
|
174
|
+
|
175
|
+
# The name of the company being advertised in the creative.
|
176
|
+
# Corresponds to the JSON property `advertiserName`
|
177
|
+
# @return [String]
|
178
|
+
attr_accessor :advertiser_name
|
179
|
+
|
180
|
+
# The agency id for this creative.
|
181
|
+
# Corresponds to the JSON property `agencyId`
|
182
|
+
# @return [Fixnum]
|
183
|
+
attr_accessor :agency_id
|
184
|
+
|
185
|
+
# The last upload timestamp of this creative if it was uploaded via API. Read-
|
186
|
+
# only. The value of this field is generated, and will be ignored for uploads. (
|
187
|
+
# formatted RFC 3339 timestamp).
|
188
|
+
# Corresponds to the JSON property `apiUploadTimestamp`
|
189
|
+
# @return [DateTime]
|
190
|
+
attr_accessor :api_upload_timestamp
|
191
|
+
|
192
|
+
# All attributes for the ads that may be shown from this snippet.
|
193
|
+
# Corresponds to the JSON property `attribute`
|
194
|
+
# @return [Array<Fixnum>]
|
195
|
+
attr_accessor :attribute
|
196
|
+
|
197
|
+
# A buyer-specific id identifying the creative in this ad.
|
198
|
+
# Corresponds to the JSON property `buyerCreativeId`
|
199
|
+
# @return [String]
|
200
|
+
attr_accessor :buyer_creative_id
|
201
|
+
|
202
|
+
# The set of destination urls for the snippet.
|
203
|
+
# Corresponds to the JSON property `clickThroughUrl`
|
204
|
+
# @return [Array<String>]
|
205
|
+
attr_accessor :click_through_url
|
206
|
+
|
207
|
+
# Shows any corrections that were applied to this creative. Read-only. This
|
208
|
+
# field should not be set in requests.
|
209
|
+
# Corresponds to the JSON property `corrections`
|
210
|
+
# @return [Array<Google::Apis::AdexchangebuyerV1_2::Creative::Correction>]
|
211
|
+
attr_accessor :corrections
|
212
|
+
|
213
|
+
# The reasons for disapproval, if any. Note that not all disapproval reasons may
|
214
|
+
# be categorized, so it is possible for the creative to have a status of
|
215
|
+
# DISAPPROVED with an empty list for disapproval_reasons. In this case, please
|
216
|
+
# reach out to your TAM to help debug the issue. Read-only. This field should
|
217
|
+
# not be set in requests.
|
218
|
+
# Corresponds to the JSON property `disapprovalReasons`
|
219
|
+
# @return [Array<Google::Apis::AdexchangebuyerV1_2::Creative::DisapprovalReason>]
|
220
|
+
attr_accessor :disapproval_reasons
|
221
|
+
|
222
|
+
# The filtering reasons for the creative. Read-only. This field should not be
|
223
|
+
# set in requests.
|
224
|
+
# Corresponds to the JSON property `filteringReasons`
|
225
|
+
# @return [Google::Apis::AdexchangebuyerV1_2::Creative::FilteringReasons]
|
226
|
+
attr_accessor :filtering_reasons
|
227
|
+
|
228
|
+
# Ad height.
|
229
|
+
# Corresponds to the JSON property `height`
|
230
|
+
# @return [Fixnum]
|
231
|
+
attr_accessor :height
|
232
|
+
|
233
|
+
# The set of urls to be called to record an impression.
|
234
|
+
# Corresponds to the JSON property `impressionTrackingUrl`
|
235
|
+
# @return [Array<String>]
|
236
|
+
attr_accessor :impression_tracking_url
|
237
|
+
|
238
|
+
# Resource type.
|
239
|
+
# Corresponds to the JSON property `kind`
|
240
|
+
# @return [String]
|
241
|
+
attr_accessor :kind
|
242
|
+
|
243
|
+
# Detected product categories, if any. Read-only. This field should not be set
|
244
|
+
# in requests.
|
245
|
+
# Corresponds to the JSON property `productCategories`
|
246
|
+
# @return [Array<Fixnum>]
|
247
|
+
attr_accessor :product_categories
|
248
|
+
|
249
|
+
# All restricted categories for the ads that may be shown from this snippet.
|
250
|
+
# Corresponds to the JSON property `restrictedCategories`
|
251
|
+
# @return [Array<Fixnum>]
|
252
|
+
attr_accessor :restricted_categories
|
253
|
+
|
254
|
+
# Detected sensitive categories, if any. Read-only. This field should not be set
|
255
|
+
# in requests.
|
256
|
+
# Corresponds to the JSON property `sensitiveCategories`
|
257
|
+
# @return [Array<Fixnum>]
|
258
|
+
attr_accessor :sensitive_categories
|
259
|
+
|
260
|
+
# Creative serving status. Read-only. This field should not be set in requests.
|
261
|
+
# Corresponds to the JSON property `status`
|
262
|
+
# @return [String]
|
263
|
+
attr_accessor :status
|
264
|
+
|
265
|
+
# All vendor types for the ads that may be shown from this snippet.
|
266
|
+
# Corresponds to the JSON property `vendorType`
|
267
|
+
# @return [Array<Fixnum>]
|
268
|
+
attr_accessor :vendor_type
|
269
|
+
|
270
|
+
# The version for this creative. Read-only. This field should not be set in
|
271
|
+
# requests.
|
272
|
+
# Corresponds to the JSON property `version`
|
273
|
+
# @return [Fixnum]
|
274
|
+
attr_accessor :version
|
275
|
+
|
276
|
+
# The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
277
|
+
# Corresponds to the JSON property `videoURL`
|
278
|
+
# @return [String]
|
279
|
+
attr_accessor :video_url
|
280
|
+
|
281
|
+
# Ad width.
|
282
|
+
# Corresponds to the JSON property `width`
|
283
|
+
# @return [Fixnum]
|
284
|
+
attr_accessor :width
|
285
|
+
|
286
|
+
def initialize(**args)
|
287
|
+
update!(**args)
|
288
|
+
end
|
289
|
+
|
290
|
+
# Update properties of this object
|
291
|
+
def update!(**args)
|
292
|
+
@html_snippet = args[:html_snippet] if args.key?(:html_snippet)
|
293
|
+
@account_id = args[:account_id] if args.key?(:account_id)
|
294
|
+
@advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
|
295
|
+
@advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
|
296
|
+
@agency_id = args[:agency_id] if args.key?(:agency_id)
|
297
|
+
@api_upload_timestamp = args[:api_upload_timestamp] if args.key?(:api_upload_timestamp)
|
298
|
+
@attribute = args[:attribute] if args.key?(:attribute)
|
299
|
+
@buyer_creative_id = args[:buyer_creative_id] if args.key?(:buyer_creative_id)
|
300
|
+
@click_through_url = args[:click_through_url] if args.key?(:click_through_url)
|
301
|
+
@corrections = args[:corrections] if args.key?(:corrections)
|
302
|
+
@disapproval_reasons = args[:disapproval_reasons] if args.key?(:disapproval_reasons)
|
303
|
+
@filtering_reasons = args[:filtering_reasons] if args.key?(:filtering_reasons)
|
304
|
+
@height = args[:height] if args.key?(:height)
|
305
|
+
@impression_tracking_url = args[:impression_tracking_url] if args.key?(:impression_tracking_url)
|
306
|
+
@kind = args[:kind] if args.key?(:kind)
|
307
|
+
@product_categories = args[:product_categories] if args.key?(:product_categories)
|
308
|
+
@restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
|
309
|
+
@sensitive_categories = args[:sensitive_categories] if args.key?(:sensitive_categories)
|
310
|
+
@status = args[:status] if args.key?(:status)
|
311
|
+
@vendor_type = args[:vendor_type] if args.key?(:vendor_type)
|
312
|
+
@version = args[:version] if args.key?(:version)
|
313
|
+
@video_url = args[:video_url] if args.key?(:video_url)
|
314
|
+
@width = args[:width] if args.key?(:width)
|
315
|
+
end
|
316
|
+
|
317
|
+
#
|
318
|
+
class Correction
|
319
|
+
include Google::Apis::Core::Hashable
|
320
|
+
|
321
|
+
# Additional details about the correction.
|
322
|
+
# Corresponds to the JSON property `details`
|
323
|
+
# @return [Array<String>]
|
324
|
+
attr_accessor :details
|
325
|
+
|
326
|
+
# The type of correction that was applied to the creative.
|
327
|
+
# Corresponds to the JSON property `reason`
|
328
|
+
# @return [String]
|
329
|
+
attr_accessor :reason
|
330
|
+
|
331
|
+
def initialize(**args)
|
332
|
+
update!(**args)
|
333
|
+
end
|
334
|
+
|
335
|
+
# Update properties of this object
|
336
|
+
def update!(**args)
|
337
|
+
@details = args[:details] if args.key?(:details)
|
338
|
+
@reason = args[:reason] if args.key?(:reason)
|
339
|
+
end
|
340
|
+
end
|
341
|
+
|
342
|
+
#
|
343
|
+
class DisapprovalReason
|
344
|
+
include Google::Apis::Core::Hashable
|
345
|
+
|
346
|
+
# Additional details about the reason for disapproval.
|
347
|
+
# Corresponds to the JSON property `details`
|
348
|
+
# @return [Array<String>]
|
349
|
+
attr_accessor :details
|
350
|
+
|
351
|
+
# The categorized reason for disapproval.
|
352
|
+
# Corresponds to the JSON property `reason`
|
353
|
+
# @return [String]
|
354
|
+
attr_accessor :reason
|
355
|
+
|
356
|
+
def initialize(**args)
|
357
|
+
update!(**args)
|
358
|
+
end
|
359
|
+
|
360
|
+
# Update properties of this object
|
361
|
+
def update!(**args)
|
362
|
+
@details = args[:details] if args.key?(:details)
|
363
|
+
@reason = args[:reason] if args.key?(:reason)
|
364
|
+
end
|
365
|
+
end
|
366
|
+
|
367
|
+
# The filtering reasons for the creative. Read-only. This field should not be
|
368
|
+
# set in requests.
|
369
|
+
class FilteringReasons
|
370
|
+
include Google::Apis::Core::Hashable
|
371
|
+
|
372
|
+
# The date in ISO 8601 format for the data. The data is collected from 00:00:00
|
373
|
+
# to 23:59:59 in PST.
|
374
|
+
# Corresponds to the JSON property `date`
|
375
|
+
# @return [String]
|
376
|
+
attr_accessor :date
|
377
|
+
|
378
|
+
# The filtering reasons.
|
379
|
+
# Corresponds to the JSON property `reasons`
|
380
|
+
# @return [Array<Google::Apis::AdexchangebuyerV1_2::Creative::FilteringReasons::Reason>]
|
381
|
+
attr_accessor :reasons
|
382
|
+
|
383
|
+
def initialize(**args)
|
384
|
+
update!(**args)
|
385
|
+
end
|
386
|
+
|
387
|
+
# Update properties of this object
|
388
|
+
def update!(**args)
|
389
|
+
@date = args[:date] if args.key?(:date)
|
390
|
+
@reasons = args[:reasons] if args.key?(:reasons)
|
391
|
+
end
|
392
|
+
|
393
|
+
#
|
394
|
+
class Reason
|
395
|
+
include Google::Apis::Core::Hashable
|
396
|
+
|
397
|
+
# The number of times the creative was filtered for the status. The count is
|
398
|
+
# aggregated across all publishers on the exchange.
|
399
|
+
# Corresponds to the JSON property `filteringCount`
|
400
|
+
# @return [Fixnum]
|
401
|
+
attr_accessor :filtering_count
|
402
|
+
|
403
|
+
# The filtering status code. Please refer to the creative-status-codes.txt file
|
404
|
+
# for different statuses.
|
405
|
+
# Corresponds to the JSON property `filteringStatus`
|
406
|
+
# @return [Fixnum]
|
407
|
+
attr_accessor :filtering_status
|
408
|
+
|
409
|
+
def initialize(**args)
|
410
|
+
update!(**args)
|
411
|
+
end
|
412
|
+
|
413
|
+
# Update properties of this object
|
414
|
+
def update!(**args)
|
415
|
+
@filtering_count = args[:filtering_count] if args.key?(:filtering_count)
|
416
|
+
@filtering_status = args[:filtering_status] if args.key?(:filtering_status)
|
417
|
+
end
|
418
|
+
end
|
419
|
+
end
|
420
|
+
end
|
421
|
+
|
422
|
+
# The creatives feed lists the active creatives for the Ad Exchange buyer
|
423
|
+
# accounts that the user has access to. Each entry in the feed corresponds to a
|
424
|
+
# single creative.
|
425
|
+
class CreativesList
|
426
|
+
include Google::Apis::Core::Hashable
|
427
|
+
|
428
|
+
# A list of creatives.
|
429
|
+
# Corresponds to the JSON property `items`
|
430
|
+
# @return [Array<Google::Apis::AdexchangebuyerV1_2::Creative>]
|
431
|
+
attr_accessor :items
|
432
|
+
|
433
|
+
# Resource type.
|
434
|
+
# Corresponds to the JSON property `kind`
|
435
|
+
# @return [String]
|
436
|
+
attr_accessor :kind
|
437
|
+
|
438
|
+
# Continuation token used to page through creatives. To retrieve the next page
|
439
|
+
# of results, set the next request's "pageToken" value to this.
|
440
|
+
# Corresponds to the JSON property `nextPageToken`
|
441
|
+
# @return [String]
|
442
|
+
attr_accessor :next_page_token
|
443
|
+
|
444
|
+
def initialize(**args)
|
445
|
+
update!(**args)
|
446
|
+
end
|
447
|
+
|
448
|
+
# Update properties of this object
|
449
|
+
def update!(**args)
|
450
|
+
@items = args[:items] if args.key?(:items)
|
451
|
+
@kind = args[:kind] if args.key?(:kind)
|
452
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
453
|
+
end
|
454
|
+
end
|
455
|
+
end
|
456
|
+
end
|
457
|
+
end
|