source: vendor/google/apiclient-services/src/RealTimeBidding.php@ e3d4e0a

Last change on this file since e3d4e0a was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 7 days ago

Upload project files
  • Property mode set to 100644
File size: 19.7 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service;
19
20use Google\Client;
21
22/**
23 * Service definition for RealTimeBidding (v1).
24 *
25 * <p>
26 * Allows external bidders to manage their RTB integration with Google. This
27 * includes managing bidder endpoints, QPS quotas, configuring what ad inventory
28 * to receive via pretargeting, submitting creatives for verification, and
29 * accessing creative metadata such as approval status.</p>
30 *
31 * <p>
32 * For more information about this service, see the API
33 * <a href="https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/" target="_blank">Documentation</a>
34 * </p>
35 *
36 * @author Google, Inc.
37 */
38class RealTimeBidding extends \Google\Service
39{
40 /** See, create, edit, and delete your Authorized Buyers and Open Bidding account entities. */
41 const REALTIME_BIDDING =
42 "https://www.googleapis.com/auth/realtime-bidding";
43
44 public $bidders;
45 public $bidders_creatives;
46 public $bidders_endpoints;
47 public $bidders_pretargetingConfigs;
48 public $bidders_publisherConnections;
49 public $buyers;
50 public $buyers_creatives;
51 public $buyers_userLists;
52 public $rootUrlTemplate;
53
54 /**
55 * Constructs the internal representation of the RealTimeBidding service.
56 *
57 * @param Client|array $clientOrConfig The client used to deliver requests, or a
58 * config array to pass to a new Client instance.
59 * @param string $rootUrl The root URL used for requests to the service.
60 */
61 public function __construct($clientOrConfig = [], $rootUrl = null)
62 {
63 parent::__construct($clientOrConfig);
64 $this->rootUrl = $rootUrl ?: 'https://realtimebidding.googleapis.com/';
65 $this->rootUrlTemplate = $rootUrl ?: 'https://realtimebidding.UNIVERSE_DOMAIN/';
66 $this->servicePath = '';
67 $this->batchPath = 'batch';
68 $this->version = 'v1';
69 $this->serviceName = 'realtimebidding';
70
71 $this->bidders = new RealTimeBidding\Resource\Bidders(
72 $this,
73 $this->serviceName,
74 'bidders',
75 [
76 'methods' => [
77 'get' => [
78 'path' => 'v1/{+name}',
79 'httpMethod' => 'GET',
80 'parameters' => [
81 'name' => [
82 'location' => 'path',
83 'type' => 'string',
84 'required' => true,
85 ],
86 ],
87 ],'list' => [
88 'path' => 'v1/bidders',
89 'httpMethod' => 'GET',
90 'parameters' => [
91 'pageSize' => [
92 'location' => 'query',
93 'type' => 'integer',
94 ],
95 'pageToken' => [
96 'location' => 'query',
97 'type' => 'string',
98 ],
99 ],
100 ],
101 ]
102 ]
103 );
104 $this->bidders_creatives = new RealTimeBidding\Resource\BiddersCreatives(
105 $this,
106 $this->serviceName,
107 'creatives',
108 [
109 'methods' => [
110 'list' => [
111 'path' => 'v1/{+parent}/creatives',
112 'httpMethod' => 'GET',
113 'parameters' => [
114 'parent' => [
115 'location' => 'path',
116 'type' => 'string',
117 'required' => true,
118 ],
119 'filter' => [
120 'location' => 'query',
121 'type' => 'string',
122 ],
123 'pageSize' => [
124 'location' => 'query',
125 'type' => 'integer',
126 ],
127 'pageToken' => [
128 'location' => 'query',
129 'type' => 'string',
130 ],
131 'view' => [
132 'location' => 'query',
133 'type' => 'string',
134 ],
135 ],
136 ],'watch' => [
137 'path' => 'v1/{+parent}/creatives:watch',
138 'httpMethod' => 'POST',
139 'parameters' => [
140 'parent' => [
141 'location' => 'path',
142 'type' => 'string',
143 'required' => true,
144 ],
145 ],
146 ],
147 ]
148 ]
149 );
150 $this->bidders_endpoints = new RealTimeBidding\Resource\BiddersEndpoints(
151 $this,
152 $this->serviceName,
153 'endpoints',
154 [
155 'methods' => [
156 'get' => [
157 'path' => 'v1/{+name}',
158 'httpMethod' => 'GET',
159 'parameters' => [
160 'name' => [
161 'location' => 'path',
162 'type' => 'string',
163 'required' => true,
164 ],
165 ],
166 ],'list' => [
167 'path' => 'v1/{+parent}/endpoints',
168 'httpMethod' => 'GET',
169 'parameters' => [
170 'parent' => [
171 'location' => 'path',
172 'type' => 'string',
173 'required' => true,
174 ],
175 'pageSize' => [
176 'location' => 'query',
177 'type' => 'integer',
178 ],
179 'pageToken' => [
180 'location' => 'query',
181 'type' => 'string',
182 ],
183 ],
184 ],'patch' => [
185 'path' => 'v1/{+name}',
186 'httpMethod' => 'PATCH',
187 'parameters' => [
188 'name' => [
189 'location' => 'path',
190 'type' => 'string',
191 'required' => true,
192 ],
193 'updateMask' => [
194 'location' => 'query',
195 'type' => 'string',
196 ],
197 ],
198 ],
199 ]
200 ]
201 );
202 $this->bidders_pretargetingConfigs = new RealTimeBidding\Resource\BiddersPretargetingConfigs(
203 $this,
204 $this->serviceName,
205 'pretargetingConfigs',
206 [
207 'methods' => [
208 'activate' => [
209 'path' => 'v1/{+name}:activate',
210 'httpMethod' => 'POST',
211 'parameters' => [
212 'name' => [
213 'location' => 'path',
214 'type' => 'string',
215 'required' => true,
216 ],
217 ],
218 ],'addTargetedApps' => [
219 'path' => 'v1/{+pretargetingConfig}:addTargetedApps',
220 'httpMethod' => 'POST',
221 'parameters' => [
222 'pretargetingConfig' => [
223 'location' => 'path',
224 'type' => 'string',
225 'required' => true,
226 ],
227 ],
228 ],'addTargetedPublishers' => [
229 'path' => 'v1/{+pretargetingConfig}:addTargetedPublishers',
230 'httpMethod' => 'POST',
231 'parameters' => [
232 'pretargetingConfig' => [
233 'location' => 'path',
234 'type' => 'string',
235 'required' => true,
236 ],
237 ],
238 ],'addTargetedSites' => [
239 'path' => 'v1/{+pretargetingConfig}:addTargetedSites',
240 'httpMethod' => 'POST',
241 'parameters' => [
242 'pretargetingConfig' => [
243 'location' => 'path',
244 'type' => 'string',
245 'required' => true,
246 ],
247 ],
248 ],'create' => [
249 'path' => 'v1/{+parent}/pretargetingConfigs',
250 'httpMethod' => 'POST',
251 'parameters' => [
252 'parent' => [
253 'location' => 'path',
254 'type' => 'string',
255 'required' => true,
256 ],
257 ],
258 ],'delete' => [
259 'path' => 'v1/{+name}',
260 'httpMethod' => 'DELETE',
261 'parameters' => [
262 'name' => [
263 'location' => 'path',
264 'type' => 'string',
265 'required' => true,
266 ],
267 ],
268 ],'get' => [
269 'path' => 'v1/{+name}',
270 'httpMethod' => 'GET',
271 'parameters' => [
272 'name' => [
273 'location' => 'path',
274 'type' => 'string',
275 'required' => true,
276 ],
277 ],
278 ],'list' => [
279 'path' => 'v1/{+parent}/pretargetingConfigs',
280 'httpMethod' => 'GET',
281 'parameters' => [
282 'parent' => [
283 'location' => 'path',
284 'type' => 'string',
285 'required' => true,
286 ],
287 'pageSize' => [
288 'location' => 'query',
289 'type' => 'integer',
290 ],
291 'pageToken' => [
292 'location' => 'query',
293 'type' => 'string',
294 ],
295 ],
296 ],'patch' => [
297 'path' => 'v1/{+name}',
298 'httpMethod' => 'PATCH',
299 'parameters' => [
300 'name' => [
301 'location' => 'path',
302 'type' => 'string',
303 'required' => true,
304 ],
305 'updateMask' => [
306 'location' => 'query',
307 'type' => 'string',
308 ],
309 ],
310 ],'removeTargetedApps' => [
311 'path' => 'v1/{+pretargetingConfig}:removeTargetedApps',
312 'httpMethod' => 'POST',
313 'parameters' => [
314 'pretargetingConfig' => [
315 'location' => 'path',
316 'type' => 'string',
317 'required' => true,
318 ],
319 ],
320 ],'removeTargetedPublishers' => [
321 'path' => 'v1/{+pretargetingConfig}:removeTargetedPublishers',
322 'httpMethod' => 'POST',
323 'parameters' => [
324 'pretargetingConfig' => [
325 'location' => 'path',
326 'type' => 'string',
327 'required' => true,
328 ],
329 ],
330 ],'removeTargetedSites' => [
331 'path' => 'v1/{+pretargetingConfig}:removeTargetedSites',
332 'httpMethod' => 'POST',
333 'parameters' => [
334 'pretargetingConfig' => [
335 'location' => 'path',
336 'type' => 'string',
337 'required' => true,
338 ],
339 ],
340 ],'suspend' => [
341 'path' => 'v1/{+name}:suspend',
342 'httpMethod' => 'POST',
343 'parameters' => [
344 'name' => [
345 'location' => 'path',
346 'type' => 'string',
347 'required' => true,
348 ],
349 ],
350 ],
351 ]
352 ]
353 );
354 $this->bidders_publisherConnections = new RealTimeBidding\Resource\BiddersPublisherConnections(
355 $this,
356 $this->serviceName,
357 'publisherConnections',
358 [
359 'methods' => [
360 'batchApprove' => [
361 'path' => 'v1/{+parent}/publisherConnections:batchApprove',
362 'httpMethod' => 'POST',
363 'parameters' => [
364 'parent' => [
365 'location' => 'path',
366 'type' => 'string',
367 'required' => true,
368 ],
369 ],
370 ],'batchReject' => [
371 'path' => 'v1/{+parent}/publisherConnections:batchReject',
372 'httpMethod' => 'POST',
373 'parameters' => [
374 'parent' => [
375 'location' => 'path',
376 'type' => 'string',
377 'required' => true,
378 ],
379 ],
380 ],'get' => [
381 'path' => 'v1/{+name}',
382 'httpMethod' => 'GET',
383 'parameters' => [
384 'name' => [
385 'location' => 'path',
386 'type' => 'string',
387 'required' => true,
388 ],
389 ],
390 ],'list' => [
391 'path' => 'v1/{+parent}/publisherConnections',
392 'httpMethod' => 'GET',
393 'parameters' => [
394 'parent' => [
395 'location' => 'path',
396 'type' => 'string',
397 'required' => true,
398 ],
399 'filter' => [
400 'location' => 'query',
401 'type' => 'string',
402 ],
403 'orderBy' => [
404 'location' => 'query',
405 'type' => 'string',
406 ],
407 'pageSize' => [
408 'location' => 'query',
409 'type' => 'integer',
410 ],
411 'pageToken' => [
412 'location' => 'query',
413 'type' => 'string',
414 ],
415 ],
416 ],
417 ]
418 ]
419 );
420 $this->buyers = new RealTimeBidding\Resource\Buyers(
421 $this,
422 $this->serviceName,
423 'buyers',
424 [
425 'methods' => [
426 'get' => [
427 'path' => 'v1/{+name}',
428 'httpMethod' => 'GET',
429 'parameters' => [
430 'name' => [
431 'location' => 'path',
432 'type' => 'string',
433 'required' => true,
434 ],
435 ],
436 ],'getRemarketingTag' => [
437 'path' => 'v1/{+name}:getRemarketingTag',
438 'httpMethod' => 'GET',
439 'parameters' => [
440 'name' => [
441 'location' => 'path',
442 'type' => 'string',
443 'required' => true,
444 ],
445 ],
446 ],'list' => [
447 'path' => 'v1/buyers',
448 'httpMethod' => 'GET',
449 'parameters' => [
450 'pageSize' => [
451 'location' => 'query',
452 'type' => 'integer',
453 ],
454 'pageToken' => [
455 'location' => 'query',
456 'type' => 'string',
457 ],
458 ],
459 ],
460 ]
461 ]
462 );
463 $this->buyers_creatives = new RealTimeBidding\Resource\BuyersCreatives(
464 $this,
465 $this->serviceName,
466 'creatives',
467 [
468 'methods' => [
469 'create' => [
470 'path' => 'v1/{+parent}/creatives',
471 'httpMethod' => 'POST',
472 'parameters' => [
473 'parent' => [
474 'location' => 'path',
475 'type' => 'string',
476 'required' => true,
477 ],
478 ],
479 ],'get' => [
480 'path' => 'v1/{+name}',
481 'httpMethod' => 'GET',
482 'parameters' => [
483 'name' => [
484 'location' => 'path',
485 'type' => 'string',
486 'required' => true,
487 ],
488 'view' => [
489 'location' => 'query',
490 'type' => 'string',
491 ],
492 ],
493 ],'list' => [
494 'path' => 'v1/{+parent}/creatives',
495 'httpMethod' => 'GET',
496 'parameters' => [
497 'parent' => [
498 'location' => 'path',
499 'type' => 'string',
500 'required' => true,
501 ],
502 'filter' => [
503 'location' => 'query',
504 'type' => 'string',
505 ],
506 'pageSize' => [
507 'location' => 'query',
508 'type' => 'integer',
509 ],
510 'pageToken' => [
511 'location' => 'query',
512 'type' => 'string',
513 ],
514 'view' => [
515 'location' => 'query',
516 'type' => 'string',
517 ],
518 ],
519 ],'patch' => [
520 'path' => 'v1/{+name}',
521 'httpMethod' => 'PATCH',
522 'parameters' => [
523 'name' => [
524 'location' => 'path',
525 'type' => 'string',
526 'required' => true,
527 ],
528 'updateMask' => [
529 'location' => 'query',
530 'type' => 'string',
531 ],
532 ],
533 ],
534 ]
535 ]
536 );
537 $this->buyers_userLists = new RealTimeBidding\Resource\BuyersUserLists(
538 $this,
539 $this->serviceName,
540 'userLists',
541 [
542 'methods' => [
543 'close' => [
544 'path' => 'v1/{+name}:close',
545 'httpMethod' => 'POST',
546 'parameters' => [
547 'name' => [
548 'location' => 'path',
549 'type' => 'string',
550 'required' => true,
551 ],
552 ],
553 ],'create' => [
554 'path' => 'v1/{+parent}/userLists',
555 'httpMethod' => 'POST',
556 'parameters' => [
557 'parent' => [
558 'location' => 'path',
559 'type' => 'string',
560 'required' => true,
561 ],
562 ],
563 ],'get' => [
564 'path' => 'v1/{+name}',
565 'httpMethod' => 'GET',
566 'parameters' => [
567 'name' => [
568 'location' => 'path',
569 'type' => 'string',
570 'required' => true,
571 ],
572 ],
573 ],'getRemarketingTag' => [
574 'path' => 'v1/{+name}:getRemarketingTag',
575 'httpMethod' => 'GET',
576 'parameters' => [
577 'name' => [
578 'location' => 'path',
579 'type' => 'string',
580 'required' => true,
581 ],
582 ],
583 ],'list' => [
584 'path' => 'v1/{+parent}/userLists',
585 'httpMethod' => 'GET',
586 'parameters' => [
587 'parent' => [
588 'location' => 'path',
589 'type' => 'string',
590 'required' => true,
591 ],
592 'pageSize' => [
593 'location' => 'query',
594 'type' => 'integer',
595 ],
596 'pageToken' => [
597 'location' => 'query',
598 'type' => 'string',
599 ],
600 ],
601 ],'open' => [
602 'path' => 'v1/{+name}:open',
603 'httpMethod' => 'POST',
604 'parameters' => [
605 'name' => [
606 'location' => 'path',
607 'type' => 'string',
608 'required' => true,
609 ],
610 ],
611 ],'update' => [
612 'path' => 'v1/{+name}',
613 'httpMethod' => 'PUT',
614 'parameters' => [
615 'name' => [
616 'location' => 'path',
617 'type' => 'string',
618 'required' => true,
619 ],
620 ],
621 ],
622 ]
623 ]
624 );
625 }
626}
627
628// Adding a class alias for backwards compatibility with the previous class name.
629class_alias(RealTimeBidding::class, 'Google_Service_RealTimeBidding');
Note: See TracBrowser for help on using the repository browser.