PluginProbe
Authorizer / 2.6.17
Authorizer v2.6.17
3.15.3 3.15.2 3.15.1 3.15.0 3.14.3 3.14.4 3.14.2 3.14.1 2.8.1 2.8.2 2.8.3 2.8.4 2.8.5 2.8.6 2.8.7 2.8.8 2.9.0 2.9.1 2.9.10 2.9.11 2.9.12 2.9.13 2.9.2 2.9.3 2.9.6 All 126 releases
authorizer / vendor / google-api-php-client / src / Google / Service / AdExchangeSeller.php

AdExchangeSeller.php in Authorizer 2.6.17, at vendor/google-api-php-client/src/Google/Service/AdExchangeSeller.php

1,712 lines 45.0 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /*
3 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 * use this file except in compliance with the License. You may obtain a copy of
5 * 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, WITHOUT
11 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 * License for the specific language governing permissions and limitations under
13 * the License.
14 */
15
16 /**
17 * Service definition for AdExchangeSeller (v2.0).
18 *
19 * <p>
20 * Gives Ad Exchange seller users access to their inventory and the ability to
21 * generate reports</p>
22 *
23 * <p>
24 * For more information about this service, see the API
25 * <a href="https://developers.google.com/ad-exchange/seller-rest/" target="_blank">Documentation</a>
26 * </p>
27 *
28 * @author Google, Inc.
29 */
30 class Google_Service_AdExchangeSeller extends Google_Service
31 {
32 /** View and manage your Ad Exchange data. */
33 const ADEXCHANGE_SELLER =
34 "https://www.googleapis.com/auth/adexchange.seller";
35 /** View your Ad Exchange data. */
36 const ADEXCHANGE_SELLER_READONLY =
37 "https://www.googleapis.com/auth/adexchange.seller.readonly";
38
39 public $accounts;
40 public $accounts_adclients;
41 public $accounts_alerts;
42 public $accounts_customchannels;
43 public $accounts_metadata_dimensions;
44 public $accounts_metadata_metrics;
45 public $accounts_preferreddeals;
46 public $accounts_reports;
47 public $accounts_reports_saved;
48 public $accounts_urlchannels;
49
50
51 /**
52 * Constructs the internal representation of the AdExchangeSeller service.
53 *
54 * @param Google_Client $client
55 */
56 public function __construct(Google_Client $client)
57 {
58 parent::__construct($client);
59 $this->rootUrl = 'https://www.googleapis.com/';
60 $this->servicePath = 'adexchangeseller/v2.0/';
61 $this->version = 'v2.0';
62 $this->serviceName = 'adexchangeseller';
63
64 $this->accounts = new Google_Service_AdExchangeSeller_Accounts_Resource(
65 $this,
66 $this->serviceName,
67 'accounts',
68 array(
69 'methods' => array(
70 'get' => array(
71 'path' => 'accounts/{accountId}',
72 'httpMethod' => 'GET',
73 'parameters' => array(
74 'accountId' => array(
75 'location' => 'path',
76 'type' => 'string',
77 'required' => true,
78 ),
79 ),
80 ),'list' => array(
81 'path' => 'accounts',
82 'httpMethod' => 'GET',
83 'parameters' => array(
84 'maxResults' => array(
85 'location' => 'query',
86 'type' => 'integer',
87 ),
88 'pageToken' => array(
89 'location' => 'query',
90 'type' => 'string',
91 ),
92 ),
93 ),
94 )
95 )
96 );
97 $this->accounts_adclients = new Google_Service_AdExchangeSeller_AccountsAdclients_Resource(
98 $this,
99 $this->serviceName,
100 'adclients',
101 array(
102 'methods' => array(
103 'list' => array(
104 'path' => 'accounts/{accountId}/adclients',
105 'httpMethod' => 'GET',
106 'parameters' => array(
107 'accountId' => array(
108 'location' => 'path',
109 'type' => 'string',
110 'required' => true,
111 ),
112 'maxResults' => array(
113 'location' => 'query',
114 'type' => 'integer',
115 ),
116 'pageToken' => array(
117 'location' => 'query',
118 'type' => 'string',
119 ),
120 ),
121 ),
122 )
123 )
124 );
125 $this->accounts_alerts = new Google_Service_AdExchangeSeller_AccountsAlerts_Resource(
126 $this,
127 $this->serviceName,
128 'alerts',
129 array(
130 'methods' => array(
131 'list' => array(
132 'path' => 'accounts/{accountId}/alerts',
133 'httpMethod' => 'GET',
134 'parameters' => array(
135 'accountId' => array(
136 'location' => 'path',
137 'type' => 'string',
138 'required' => true,
139 ),
140 'locale' => array(
141 'location' => 'query',
142 'type' => 'string',
143 ),
144 ),
145 ),
146 )
147 )
148 );
149 $this->accounts_customchannels = new Google_Service_AdExchangeSeller_AccountsCustomchannels_Resource(
150 $this,
151 $this->serviceName,
152 'customchannels',
153 array(
154 'methods' => array(
155 'get' => array(
156 'path' => 'accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}',
157 'httpMethod' => 'GET',
158 'parameters' => array(
159 'accountId' => array(
160 'location' => 'path',
161 'type' => 'string',
162 'required' => true,
163 ),
164 'adClientId' => array(
165 'location' => 'path',
166 'type' => 'string',
167 'required' => true,
168 ),
169 'customChannelId' => array(
170 'location' => 'path',
171 'type' => 'string',
172 'required' => true,
173 ),
174 ),
175 ),'list' => array(
176 'path' => 'accounts/{accountId}/adclients/{adClientId}/customchannels',
177 'httpMethod' => 'GET',
178 'parameters' => array(
179 'accountId' => array(
180 'location' => 'path',
181 'type' => 'string',
182 'required' => true,
183 ),
184 'adClientId' => array(
185 'location' => 'path',
186 'type' => 'string',
187 'required' => true,
188 ),
189 'maxResults' => array(
190 'location' => 'query',
191 'type' => 'integer',
192 ),
193 'pageToken' => array(
194 'location' => 'query',
195 'type' => 'string',
196 ),
197 ),
198 ),
199 )
200 )
201 );
202 $this->accounts_metadata_dimensions = new Google_Service_AdExchangeSeller_AccountsMetadataDimensions_Resource(
203 $this,
204 $this->serviceName,
205 'dimensions',
206 array(
207 'methods' => array(
208 'list' => array(
209 'path' => 'accounts/{accountId}/metadata/dimensions',
210 'httpMethod' => 'GET',
211 'parameters' => array(
212 'accountId' => array(
213 'location' => 'path',
214 'type' => 'string',
215 'required' => true,
216 ),
217 ),
218 ),
219 )
220 )
221 );
222 $this->accounts_metadata_metrics = new Google_Service_AdExchangeSeller_AccountsMetadataMetrics_Resource(
223 $this,
224 $this->serviceName,
225 'metrics',
226 array(
227 'methods' => array(
228 'list' => array(
229 'path' => 'accounts/{accountId}/metadata/metrics',
230 'httpMethod' => 'GET',
231 'parameters' => array(
232 'accountId' => array(
233 'location' => 'path',
234 'type' => 'string',
235 'required' => true,
236 ),
237 ),
238 ),
239 )
240 )
241 );
242 $this->accounts_preferreddeals = new Google_Service_AdExchangeSeller_AccountsPreferreddeals_Resource(
243 $this,
244 $this->serviceName,
245 'preferreddeals',
246 array(
247 'methods' => array(
248 'get' => array(
249 'path' => 'accounts/{accountId}/preferreddeals/{dealId}',
250 'httpMethod' => 'GET',
251 'parameters' => array(
252 'accountId' => array(
253 'location' => 'path',
254 'type' => 'string',
255 'required' => true,
256 ),
257 'dealId' => array(
258 'location' => 'path',
259 'type' => 'string',
260 'required' => true,
261 ),
262 ),
263 ),'list' => array(
264 'path' => 'accounts/{accountId}/preferreddeals',
265 'httpMethod' => 'GET',
266 'parameters' => array(
267 'accountId' => array(
268 'location' => 'path',
269 'type' => 'string',
270 'required' => true,
271 ),
272 ),
273 ),
274 )
275 )
276 );
277 $this->accounts_reports = new Google_Service_AdExchangeSeller_AccountsReports_Resource(
278 $this,
279 $this->serviceName,
280 'reports',
281 array(
282 'methods' => array(
283 'generate' => array(
284 'path' => 'accounts/{accountId}/reports',
285 'httpMethod' => 'GET',
286 'parameters' => array(
287 'accountId' => array(
288 'location' => 'path',
289 'type' => 'string',
290 'required' => true,
291 ),
292 'startDate' => array(
293 'location' => 'query',
294 'type' => 'string',
295 'required' => true,
296 ),
297 'endDate' => array(
298 'location' => 'query',
299 'type' => 'string',
300 'required' => true,
301 ),
302 'dimension' => array(
303 'location' => 'query',
304 'type' => 'string',
305 'repeated' => true,
306 ),
307 'filter' => array(
308 'location' => 'query',
309 'type' => 'string',
310 'repeated' => true,
311 ),
312 'locale' => array(
313 'location' => 'query',
314 'type' => 'string',
315 ),
316 'maxResults' => array(
317 'location' => 'query',
318 'type' => 'integer',
319 ),
320 'metric' => array(
321 'location' => 'query',
322 'type' => 'string',
323 'repeated' => true,
324 ),
325 'sort' => array(
326 'location' => 'query',
327 'type' => 'string',
328 'repeated' => true,
329 ),
330 'startIndex' => array(
331 'location' => 'query',
332 'type' => 'integer',
333 ),
334 ),
335 ),
336 )
337 )
338 );
339 $this->accounts_reports_saved = new Google_Service_AdExchangeSeller_AccountsReportsSaved_Resource(
340 $this,
341 $this->serviceName,
342 'saved',
343 array(
344 'methods' => array(
345 'generate' => array(
346 'path' => 'accounts/{accountId}/reports/{savedReportId}',
347 'httpMethod' => 'GET',
348 'parameters' => array(
349 'accountId' => array(
350 'location' => 'path',
351 'type' => 'string',
352 'required' => true,
353 ),
354 'savedReportId' => array(
355 'location' => 'path',
356 'type' => 'string',
357 'required' => true,
358 ),
359 'locale' => array(
360 'location' => 'query',
361 'type' => 'string',
362 ),
363 'maxResults' => array(
364 'location' => 'query',
365 'type' => 'integer',
366 ),
367 'startIndex' => array(
368 'location' => 'query',
369 'type' => 'integer',
370 ),
371 ),
372 ),'list' => array(
373 'path' => 'accounts/{accountId}/reports/saved',
374 'httpMethod' => 'GET',
375 'parameters' => array(
376 'accountId' => array(
377 'location' => 'path',
378 'type' => 'string',
379 'required' => true,
380 ),
381 'maxResults' => array(
382 'location' => 'query',
383 'type' => 'integer',
384 ),
385 'pageToken' => array(
386 'location' => 'query',
387 'type' => 'string',
388 ),
389 ),
390 ),
391 )
392 )
393 );
394 $this->accounts_urlchannels = new Google_Service_AdExchangeSeller_AccountsUrlchannels_Resource(
395 $this,
396 $this->serviceName,
397 'urlchannels',
398 array(
399 'methods' => array(
400 'list' => array(
401 'path' => 'accounts/{accountId}/adclients/{adClientId}/urlchannels',
402 'httpMethod' => 'GET',
403 'parameters' => array(
404 'accountId' => array(
405 'location' => 'path',
406 'type' => 'string',
407 'required' => true,
408 ),
409 'adClientId' => array(
410 'location' => 'path',
411 'type' => 'string',
412 'required' => true,
413 ),
414 'maxResults' => array(
415 'location' => 'query',
416 'type' => 'integer',
417 ),
418 'pageToken' => array(
419 'location' => 'query',
420 'type' => 'string',
421 ),
422 ),
423 ),
424 )
425 )
426 );
427 }
428 }
429
430
431 /**
432 * The "accounts" collection of methods.
433 * Typical usage is:
434 * <code>
435 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
436 * $accounts = $adexchangesellerService->accounts;
437 * </code>
438 */
439 class Google_Service_AdExchangeSeller_Accounts_Resource extends Google_Service_Resource
440 {
441
442 /**
443 * Get information about the selected Ad Exchange account. (accounts.get)
444 *
445 * @param string $accountId Account to get information about. Tip: 'myaccount'
446 * is a valid ID.
447 * @param array $optParams Optional parameters.
448 * @return Google_Service_AdExchangeSeller_Account
449 */
450 public function get($accountId, $optParams = array())
451 {
452 $params = array('accountId' => $accountId);
453 $params = array_merge($params, $optParams);
454 return $this->call('get', array($params), "Google_Service_AdExchangeSeller_Account");
455 }
456
457 /**
458 * List all accounts available to this Ad Exchange account.
459 * (accounts.listAccounts)
460 *
461 * @param array $optParams Optional parameters.
462 *
463 * @opt_param int maxResults The maximum number of accounts to include in the
464 * response, used for paging.
465 * @opt_param string pageToken A continuation token, used to page through
466 * accounts. To retrieve the next page, set this parameter to the value of
467 * "nextPageToken" from the previous response.
468 * @return Google_Service_AdExchangeSeller_Accounts
469 */
470 public function listAccounts($optParams = array())
471 {
472 $params = array();
473 $params = array_merge($params, $optParams);
474 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_Accounts");
475 }
476 }
477
478 /**
479 * The "adclients" collection of methods.
480 * Typical usage is:
481 * <code>
482 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
483 * $adclients = $adexchangesellerService->adclients;
484 * </code>
485 */
486 class Google_Service_AdExchangeSeller_AccountsAdclients_Resource extends Google_Service_Resource
487 {
488
489 /**
490 * List all ad clients in this Ad Exchange account.
491 * (adclients.listAccountsAdclients)
492 *
493 * @param string $accountId Account to which the ad client belongs.
494 * @param array $optParams Optional parameters.
495 *
496 * @opt_param string maxResults The maximum number of ad clients to include in
497 * the response, used for paging.
498 * @opt_param string pageToken A continuation token, used to page through ad
499 * clients. To retrieve the next page, set this parameter to the value of
500 * "nextPageToken" from the previous response.
501 * @return Google_Service_AdExchangeSeller_AdClients
502 */
503 public function listAccountsAdclients($accountId, $optParams = array())
504 {
505 $params = array('accountId' => $accountId);
506 $params = array_merge($params, $optParams);
507 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_AdClients");
508 }
509 }
510 /**
511 * The "alerts" collection of methods.
512 * Typical usage is:
513 * <code>
514 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
515 * $alerts = $adexchangesellerService->alerts;
516 * </code>
517 */
518 class Google_Service_AdExchangeSeller_AccountsAlerts_Resource extends Google_Service_Resource
519 {
520
521 /**
522 * List the alerts for this Ad Exchange account. (alerts.listAccountsAlerts)
523 *
524 * @param string $accountId Account owning the alerts.
525 * @param array $optParams Optional parameters.
526 *
527 * @opt_param string locale The locale to use for translating alert messages.
528 * The account locale will be used if this is not supplied. The AdSense default
529 * (English) will be used if the supplied locale is invalid or unsupported.
530 * @return Google_Service_AdExchangeSeller_Alerts
531 */
532 public function listAccountsAlerts($accountId, $optParams = array())
533 {
534 $params = array('accountId' => $accountId);
535 $params = array_merge($params, $optParams);
536 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_Alerts");
537 }
538 }
539 /**
540 * The "customchannels" collection of methods.
541 * Typical usage is:
542 * <code>
543 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
544 * $customchannels = $adexchangesellerService->customchannels;
545 * </code>
546 */
547 class Google_Service_AdExchangeSeller_AccountsCustomchannels_Resource extends Google_Service_Resource
548 {
549
550 /**
551 * Get the specified custom channel from the specified ad client.
552 * (customchannels.get)
553 *
554 * @param string $accountId Account to which the ad client belongs.
555 * @param string $adClientId Ad client which contains the custom channel.
556 * @param string $customChannelId Custom channel to retrieve.
557 * @param array $optParams Optional parameters.
558 * @return Google_Service_AdExchangeSeller_CustomChannel
559 */
560 public function get($accountId, $adClientId, $customChannelId, $optParams = array())
561 {
562 $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'customChannelId' => $customChannelId);
563 $params = array_merge($params, $optParams);
564 return $this->call('get', array($params), "Google_Service_AdExchangeSeller_CustomChannel");
565 }
566
567 /**
568 * List all custom channels in the specified ad client for this Ad Exchange
569 * account. (customchannels.listAccountsCustomchannels)
570 *
571 * @param string $accountId Account to which the ad client belongs.
572 * @param string $adClientId Ad client for which to list custom channels.
573 * @param array $optParams Optional parameters.
574 *
575 * @opt_param string maxResults The maximum number of custom channels to include
576 * in the response, used for paging.
577 * @opt_param string pageToken A continuation token, used to page through custom
578 * channels. To retrieve the next page, set this parameter to the value of
579 * "nextPageToken" from the previous response.
580 * @return Google_Service_AdExchangeSeller_CustomChannels
581 */
582 public function listAccountsCustomchannels($accountId, $adClientId, $optParams = array())
583 {
584 $params = array('accountId' => $accountId, 'adClientId' => $adClientId);
585 $params = array_merge($params, $optParams);
586 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_CustomChannels");
587 }
588 }
589 /**
590 * The "metadata" collection of methods.
591 * Typical usage is:
592 * <code>
593 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
594 * $metadata = $adexchangesellerService->metadata;
595 * </code>
596 */
597 class Google_Service_AdExchangeSeller_AccountsMetadata_Resource extends Google_Service_Resource
598 {
599 }
600
601 /**
602 * The "dimensions" collection of methods.
603 * Typical usage is:
604 * <code>
605 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
606 * $dimensions = $adexchangesellerService->dimensions;
607 * </code>
608 */
609 class Google_Service_AdExchangeSeller_AccountsMetadataDimensions_Resource extends Google_Service_Resource
610 {
611
612 /**
613 * List the metadata for the dimensions available to this AdExchange account.
614 * (dimensions.listAccountsMetadataDimensions)
615 *
616 * @param string $accountId Account with visibility to the dimensions.
617 * @param array $optParams Optional parameters.
618 * @return Google_Service_AdExchangeSeller_Metadata
619 */
620 public function listAccountsMetadataDimensions($accountId, $optParams = array())
621 {
622 $params = array('accountId' => $accountId);
623 $params = array_merge($params, $optParams);
624 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_Metadata");
625 }
626 }
627 /**
628 * The "metrics" collection of methods.
629 * Typical usage is:
630 * <code>
631 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
632 * $metrics = $adexchangesellerService->metrics;
633 * </code>
634 */
635 class Google_Service_AdExchangeSeller_AccountsMetadataMetrics_Resource extends Google_Service_Resource
636 {
637
638 /**
639 * List the metadata for the metrics available to this AdExchange account.
640 * (metrics.listAccountsMetadataMetrics)
641 *
642 * @param string $accountId Account with visibility to the metrics.
643 * @param array $optParams Optional parameters.
644 * @return Google_Service_AdExchangeSeller_Metadata
645 */
646 public function listAccountsMetadataMetrics($accountId, $optParams = array())
647 {
648 $params = array('accountId' => $accountId);
649 $params = array_merge($params, $optParams);
650 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_Metadata");
651 }
652 }
653 /**
654 * The "preferreddeals" collection of methods.
655 * Typical usage is:
656 * <code>
657 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
658 * $preferreddeals = $adexchangesellerService->preferreddeals;
659 * </code>
660 */
661 class Google_Service_AdExchangeSeller_AccountsPreferreddeals_Resource extends Google_Service_Resource
662 {
663
664 /**
665 * Get information about the selected Ad Exchange Preferred Deal.
666 * (preferreddeals.get)
667 *
668 * @param string $accountId Account owning the deal.
669 * @param string $dealId Preferred deal to get information about.
670 * @param array $optParams Optional parameters.
671 * @return Google_Service_AdExchangeSeller_PreferredDeal
672 */
673 public function get($accountId, $dealId, $optParams = array())
674 {
675 $params = array('accountId' => $accountId, 'dealId' => $dealId);
676 $params = array_merge($params, $optParams);
677 return $this->call('get', array($params), "Google_Service_AdExchangeSeller_PreferredDeal");
678 }
679
680 /**
681 * List the preferred deals for this Ad Exchange account.
682 * (preferreddeals.listAccountsPreferreddeals)
683 *
684 * @param string $accountId Account owning the deals.
685 * @param array $optParams Optional parameters.
686 * @return Google_Service_AdExchangeSeller_PreferredDeals
687 */
688 public function listAccountsPreferreddeals($accountId, $optParams = array())
689 {
690 $params = array('accountId' => $accountId);
691 $params = array_merge($params, $optParams);
692 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_PreferredDeals");
693 }
694 }
695 /**
696 * The "reports" collection of methods.
697 * Typical usage is:
698 * <code>
699 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
700 * $reports = $adexchangesellerService->reports;
701 * </code>
702 */
703 class Google_Service_AdExchangeSeller_AccountsReports_Resource extends Google_Service_Resource
704 {
705
706 /**
707 * Generate an Ad Exchange report based on the report request sent in the query
708 * parameters. Returns the result as JSON; to retrieve output in CSV format
709 * specify "alt=csv" as a query parameter. (reports.generate)
710 *
711 * @param string $accountId Account which owns the generated report.
712 * @param string $startDate Start of the date range to report on in "YYYY-MM-DD"
713 * format, inclusive.
714 * @param string $endDate End of the date range to report on in "YYYY-MM-DD"
715 * format, inclusive.
716 * @param array $optParams Optional parameters.
717 *
718 * @opt_param string dimension Dimensions to base the report on.
719 * @opt_param string filter Filters to be run on the report.
720 * @opt_param string locale Optional locale to use for translating report output
721 * to a local language. Defaults to "en_US" if not specified.
722 * @opt_param string maxResults The maximum number of rows of report data to
723 * return.
724 * @opt_param string metric Numeric columns to include in the report.
725 * @opt_param string sort The name of a dimension or metric to sort the
726 * resulting report on, optionally prefixed with "+" to sort ascending or "-" to
727 * sort descending. If no prefix is specified, the column is sorted ascending.
728 * @opt_param string startIndex Index of the first row of report data to return.
729 * @return Google_Service_AdExchangeSeller_Report
730 */
731 public function generate($accountId, $startDate, $endDate, $optParams = array())
732 {
733 $params = array('accountId' => $accountId, 'startDate' => $startDate, 'endDate' => $endDate);
734 $params = array_merge($params, $optParams);
735 return $this->call('generate', array($params), "Google_Service_AdExchangeSeller_Report");
736 }
737 }
738
739 /**
740 * The "saved" collection of methods.
741 * Typical usage is:
742 * <code>
743 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
744 * $saved = $adexchangesellerService->saved;
745 * </code>
746 */
747 class Google_Service_AdExchangeSeller_AccountsReportsSaved_Resource extends Google_Service_Resource
748 {
749
750 /**
751 * Generate an Ad Exchange report based on the saved report ID sent in the query
752 * parameters. (saved.generate)
753 *
754 * @param string $accountId Account owning the saved report.
755 * @param string $savedReportId The saved report to retrieve.
756 * @param array $optParams Optional parameters.
757 *
758 * @opt_param string locale Optional locale to use for translating report output
759 * to a local language. Defaults to "en_US" if not specified.
760 * @opt_param int maxResults The maximum number of rows of report data to
761 * return.
762 * @opt_param int startIndex Index of the first row of report data to return.
763 * @return Google_Service_AdExchangeSeller_Report
764 */
765 public function generate($accountId, $savedReportId, $optParams = array())
766 {
767 $params = array('accountId' => $accountId, 'savedReportId' => $savedReportId);
768 $params = array_merge($params, $optParams);
769 return $this->call('generate', array($params), "Google_Service_AdExchangeSeller_Report");
770 }
771
772 /**
773 * List all saved reports in this Ad Exchange account.
774 * (saved.listAccountsReportsSaved)
775 *
776 * @param string $accountId Account owning the saved reports.
777 * @param array $optParams Optional parameters.
778 *
779 * @opt_param int maxResults The maximum number of saved reports to include in
780 * the response, used for paging.
781 * @opt_param string pageToken A continuation token, used to page through saved
782 * reports. To retrieve the next page, set this parameter to the value of
783 * "nextPageToken" from the previous response.
784 * @return Google_Service_AdExchangeSeller_SavedReports
785 */
786 public function listAccountsReportsSaved($accountId, $optParams = array())
787 {
788 $params = array('accountId' => $accountId);
789 $params = array_merge($params, $optParams);
790 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_SavedReports");
791 }
792 }
793 /**
794 * The "urlchannels" collection of methods.
795 * Typical usage is:
796 * <code>
797 * $adexchangesellerService = new Google_Service_AdExchangeSeller(...);
798 * $urlchannels = $adexchangesellerService->urlchannels;
799 * </code>
800 */
801 class Google_Service_AdExchangeSeller_AccountsUrlchannels_Resource extends Google_Service_Resource
802 {
803
804 /**
805 * List all URL channels in the specified ad client for this Ad Exchange
806 * account. (urlchannels.listAccountsUrlchannels)
807 *
808 * @param string $accountId Account to which the ad client belongs.
809 * @param string $adClientId Ad client for which to list URL channels.
810 * @param array $optParams Optional parameters.
811 *
812 * @opt_param string maxResults The maximum number of URL channels to include in
813 * the response, used for paging.
814 * @opt_param string pageToken A continuation token, used to page through URL
815 * channels. To retrieve the next page, set this parameter to the value of
816 * "nextPageToken" from the previous response.
817 * @return Google_Service_AdExchangeSeller_UrlChannels
818 */
819 public function listAccountsUrlchannels($accountId, $adClientId, $optParams = array())
820 {
821 $params = array('accountId' => $accountId, 'adClientId' => $adClientId);
822 $params = array_merge($params, $optParams);
823 return $this->call('list', array($params), "Google_Service_AdExchangeSeller_UrlChannels");
824 }
825 }
826
827
828
829
830 class Google_Service_AdExchangeSeller_Account extends Google_Model
831 {
832 protected $internal_gapi_mappings = array(
833 );
834 public $id;
835 public $kind;
836 public $name;
837
838
839 public function setId($id)
840 {
841 $this->id = $id;
842 }
843 public function getId()
844 {
845 return $this->id;
846 }
847 public function setKind($kind)
848 {
849 $this->kind = $kind;
850 }
851 public function getKind()
852 {
853 return $this->kind;
854 }
855 public function setName($name)
856 {
857 $this->name = $name;
858 }
859 public function getName()
860 {
861 return $this->name;
862 }
863 }
864
865 class Google_Service_AdExchangeSeller_Accounts extends Google_Collection
866 {
867 protected $collection_key = 'items';
868 protected $internal_gapi_mappings = array(
869 );
870 public $etag;
871 protected $itemsType = 'Google_Service_AdExchangeSeller_Account';
872 protected $itemsDataType = 'array';
873 public $kind;
874 public $nextPageToken;
875
876
877 public function setEtag($etag)
878 {
879 $this->etag = $etag;
880 }
881 public function getEtag()
882 {
883 return $this->etag;
884 }
885 public function setItems($items)
886 {
887 $this->items = $items;
888 }
889 public function getItems()
890 {
891 return $this->items;
892 }
893 public function setKind($kind)
894 {
895 $this->kind = $kind;
896 }
897 public function getKind()
898 {
899 return $this->kind;
900 }
901 public function setNextPageToken($nextPageToken)
902 {
903 $this->nextPageToken = $nextPageToken;
904 }
905 public function getNextPageToken()
906 {
907 return $this->nextPageToken;
908 }
909 }
910
911 class Google_Service_AdExchangeSeller_AdClient extends Google_Model
912 {
913 protected $internal_gapi_mappings = array(
914 );
915 public $arcOptIn;
916 public $id;
917 public $kind;
918 public $productCode;
919 public $supportsReporting;
920
921
922 public function setArcOptIn($arcOptIn)
923 {
924 $this->arcOptIn = $arcOptIn;
925 }
926 public function getArcOptIn()
927 {
928 return $this->arcOptIn;
929 }
930 public function setId($id)
931 {
932 $this->id = $id;
933 }
934 public function getId()
935 {
936 return $this->id;
937 }
938 public function setKind($kind)
939 {
940 $this->kind = $kind;
941 }
942 public function getKind()
943 {
944 return $this->kind;
945 }
946 public function setProductCode($productCode)
947 {
948 $this->productCode = $productCode;
949 }
950 public function getProductCode()
951 {
952 return $this->productCode;
953 }
954 public function setSupportsReporting($supportsReporting)
955 {
956 $this->supportsReporting = $supportsReporting;
957 }
958 public function getSupportsReporting()
959 {
960 return $this->supportsReporting;
961 }
962 }
963
964 class Google_Service_AdExchangeSeller_AdClients extends Google_Collection
965 {
966 protected $collection_key = 'items';
967 protected $internal_gapi_mappings = array(
968 );
969 public $etag;
970 protected $itemsType = 'Google_Service_AdExchangeSeller_AdClient';
971 protected $itemsDataType = 'array';
972 public $kind;
973 public $nextPageToken;
974
975
976 public function setEtag($etag)
977 {
978 $this->etag = $etag;
979 }
980 public function getEtag()
981 {
982 return $this->etag;
983 }
984 public function setItems($items)
985 {
986 $this->items = $items;
987 }
988 public function getItems()
989 {
990 return $this->items;
991 }
992 public function setKind($kind)
993 {
994 $this->kind = $kind;
995 }
996 public function getKind()
997 {
998 return $this->kind;
999 }
1000 public function setNextPageToken($nextPageToken)
1001 {
1002 $this->nextPageToken = $nextPageToken;
1003 }
1004 public function getNextPageToken()
1005 {
1006 return $this->nextPageToken;
1007 }
1008 }
1009
1010 class Google_Service_AdExchangeSeller_Alert extends Google_Model
1011 {
1012 protected $internal_gapi_mappings = array(
1013 );
1014 public $id;
1015 public $kind;
1016 public $message;
1017 public $severity;
1018 public $type;
1019
1020
1021 public function setId($id)
1022 {
1023 $this->id = $id;
1024 }
1025 public function getId()
1026 {
1027 return $this->id;
1028 }
1029 public function setKind($kind)
1030 {
1031 $this->kind = $kind;
1032 }
1033 public function getKind()
1034 {
1035 return $this->kind;
1036 }
1037 public function setMessage($message)
1038 {
1039 $this->message = $message;
1040 }
1041 public function getMessage()
1042 {
1043 return $this->message;
1044 }
1045 public function setSeverity($severity)
1046 {
1047 $this->severity = $severity;
1048 }
1049 public function getSeverity()
1050 {
1051 return $this->severity;
1052 }
1053 public function setType($type)
1054 {
1055 $this->type = $type;
1056 }
1057 public function getType()
1058 {
1059 return $this->type;
1060 }
1061 }
1062
1063 class Google_Service_AdExchangeSeller_Alerts extends Google_Collection
1064 {
1065 protected $collection_key = 'items';
1066 protected $internal_gapi_mappings = array(
1067 );
1068 protected $itemsType = 'Google_Service_AdExchangeSeller_Alert';
1069 protected $itemsDataType = 'array';
1070 public $kind;
1071
1072
1073 public function setItems($items)
1074 {
1075 $this->items = $items;
1076 }
1077 public function getItems()
1078 {
1079 return $this->items;
1080 }
1081 public function setKind($kind)
1082 {
1083 $this->kind = $kind;
1084 }
1085 public function getKind()
1086 {
1087 return $this->kind;
1088 }
1089 }
1090
1091 class Google_Service_AdExchangeSeller_CustomChannel extends Google_Model
1092 {
1093 protected $internal_gapi_mappings = array(
1094 );
1095 public $code;
1096 public $id;
1097 public $kind;
1098 public $name;
1099 protected $targetingInfoType = 'Google_Service_AdExchangeSeller_CustomChannelTargetingInfo';
1100 protected $targetingInfoDataType = '';
1101
1102
1103 public function setCode($code)
1104 {
1105 $this->code = $code;
1106 }
1107 public function getCode()
1108 {
1109 return $this->code;
1110 }
1111 public function setId($id)
1112 {
1113 $this->id = $id;
1114 }
1115 public function getId()
1116 {
1117 return $this->id;
1118 }
1119 public function setKind($kind)
1120 {
1121 $this->kind = $kind;
1122 }
1123 public function getKind()
1124 {
1125 return $this->kind;
1126 }
1127 public function setName($name)
1128 {
1129 $this->name = $name;
1130 }
1131 public function getName()
1132 {
1133 return $this->name;
1134 }
1135 public function setTargetingInfo(Google_Service_AdExchangeSeller_CustomChannelTargetingInfo $targetingInfo)
1136 {
1137 $this->targetingInfo = $targetingInfo;
1138 }
1139 public function getTargetingInfo()
1140 {
1141 return $this->targetingInfo;
1142 }
1143 }
1144
1145 class Google_Service_AdExchangeSeller_CustomChannelTargetingInfo extends Google_Model
1146 {
1147 protected $internal_gapi_mappings = array(
1148 );
1149 public $adsAppearOn;
1150 public $description;
1151 public $location;
1152 public $siteLanguage;
1153
1154
1155 public function setAdsAppearOn($adsAppearOn)
1156 {
1157 $this->adsAppearOn = $adsAppearOn;
1158 }
1159 public function getAdsAppearOn()
1160 {
1161 return $this->adsAppearOn;
1162 }
1163 public function setDescription($description)
1164 {
1165 $this->description = $description;
1166 }
1167 public function getDescription()
1168 {
1169 return $this->description;
1170 }
1171 public function setLocation($location)
1172 {
1173 $this->location = $location;
1174 }
1175 public function getLocation()
1176 {
1177 return $this->location;
1178 }
1179 public function setSiteLanguage($siteLanguage)
1180 {
1181 $this->siteLanguage = $siteLanguage;
1182 }
1183 public function getSiteLanguage()
1184 {
1185 return $this->siteLanguage;
1186 }
1187 }
1188
1189 class Google_Service_AdExchangeSeller_CustomChannels extends Google_Collection
1190 {
1191 protected $collection_key = 'items';
1192 protected $internal_gapi_mappings = array(
1193 );
1194 public $etag;
1195 protected $itemsType = 'Google_Service_AdExchangeSeller_CustomChannel';
1196 protected $itemsDataType = 'array';
1197 public $kind;
1198 public $nextPageToken;
1199
1200
1201 public function setEtag($etag)
1202 {
1203 $this->etag = $etag;
1204 }
1205 public function getEtag()
1206 {
1207 return $this->etag;
1208 }
1209 public function setItems($items)
1210 {
1211 $this->items = $items;
1212 }
1213 public function getItems()
1214 {
1215 return $this->items;
1216 }
1217 public function setKind($kind)
1218 {
1219 $this->kind = $kind;
1220 }
1221 public function getKind()
1222 {
1223 return $this->kind;
1224 }
1225 public function setNextPageToken($nextPageToken)
1226 {
1227 $this->nextPageToken = $nextPageToken;
1228 }
1229 public function getNextPageToken()
1230 {
1231 return $this->nextPageToken;
1232 }
1233 }
1234
1235 class Google_Service_AdExchangeSeller_Metadata extends Google_Collection
1236 {
1237 protected $collection_key = 'items';
1238 protected $internal_gapi_mappings = array(
1239 );
1240 protected $itemsType = 'Google_Service_AdExchangeSeller_ReportingMetadataEntry';
1241 protected $itemsDataType = 'array';
1242 public $kind;
1243
1244
1245 public function setItems($items)
1246 {
1247 $this->items = $items;
1248 }
1249 public function getItems()
1250 {
1251 return $this->items;
1252 }
1253 public function setKind($kind)
1254 {
1255 $this->kind = $kind;
1256 }
1257 public function getKind()
1258 {
1259 return $this->kind;
1260 }
1261 }
1262
1263 class Google_Service_AdExchangeSeller_PreferredDeal extends Google_Model
1264 {
1265 protected $internal_gapi_mappings = array(
1266 );
1267 public $advertiserName;
1268 public $buyerNetworkName;
1269 public $currencyCode;
1270 public $endTime;
1271 public $fixedCpm;
1272 public $id;
1273 public $kind;
1274 public $startTime;
1275
1276
1277 public function setAdvertiserName($advertiserName)
1278 {
1279 $this->advertiserName = $advertiserName;
1280 }
1281 public function getAdvertiserName()
1282 {
1283 return $this->advertiserName;
1284 }
1285 public function setBuyerNetworkName($buyerNetworkName)
1286 {
1287 $this->buyerNetworkName = $buyerNetworkName;
1288 }
1289 public function getBuyerNetworkName()
1290 {
1291 return $this->buyerNetworkName;
1292 }
1293 public function setCurrencyCode($currencyCode)
1294 {
1295 $this->currencyCode = $currencyCode;
1296 }
1297 public function getCurrencyCode()
1298 {
1299 return $this->currencyCode;
1300 }
1301 public function setEndTime($endTime)
1302 {
1303 $this->endTime = $endTime;
1304 }
1305 public function getEndTime()
1306 {
1307 return $this->endTime;
1308 }
1309 public function setFixedCpm($fixedCpm)
1310 {
1311 $this->fixedCpm = $fixedCpm;
1312 }
1313 public function getFixedCpm()
1314 {
1315 return $this->fixedCpm;
1316 }
1317 public function setId($id)
1318 {
1319 $this->id = $id;
1320 }
1321 public function getId()
1322 {
1323 return $this->id;
1324 }
1325 public function setKind($kind)
1326 {
1327 $this->kind = $kind;
1328 }
1329 public function getKind()
1330 {
1331 return $this->kind;
1332 }
1333 public function setStartTime($startTime)
1334 {
1335 $this->startTime = $startTime;
1336 }
1337 public function getStartTime()
1338 {
1339 return $this->startTime;
1340 }
1341 }
1342
1343 class Google_Service_AdExchangeSeller_PreferredDeals extends Google_Collection
1344 {
1345 protected $collection_key = 'items';
1346 protected $internal_gapi_mappings = array(
1347 );
1348 protected $itemsType = 'Google_Service_AdExchangeSeller_PreferredDeal';
1349 protected $itemsDataType = 'array';
1350 public $kind;
1351
1352
1353 public function setItems($items)
1354 {
1355 $this->items = $items;
1356 }
1357 public function getItems()
1358 {
1359 return $this->items;
1360 }
1361 public function setKind($kind)
1362 {
1363 $this->kind = $kind;
1364 }
1365 public function getKind()
1366 {
1367 return $this->kind;
1368 }
1369 }
1370
1371 class Google_Service_AdExchangeSeller_Report extends Google_Collection
1372 {
1373 protected $collection_key = 'warnings';
1374 protected $internal_gapi_mappings = array(
1375 );
1376 public $averages;
1377 protected $headersType = 'Google_Service_AdExchangeSeller_ReportHeaders';
1378 protected $headersDataType = 'array';
1379 public $kind;
1380 public $rows;
1381 public $totalMatchedRows;
1382 public $totals;
1383 public $warnings;
1384
1385
1386 public function setAverages($averages)
1387 {
1388 $this->averages = $averages;
1389 }
1390 public function getAverages()
1391 {
1392 return $this->averages;
1393 }
1394 public function setHeaders($headers)
1395 {
1396 $this->headers = $headers;
1397 }
1398 public function getHeaders()
1399 {
1400 return $this->headers;
1401 }
1402 public function setKind($kind)
1403 {
1404 $this->kind = $kind;
1405 }
1406 public function getKind()
1407 {
1408 return $this->kind;
1409 }
1410 public function setRows($rows)
1411 {
1412 $this->rows = $rows;
1413 }
1414 public function getRows()
1415 {
1416 return $this->rows;
1417 }
1418 public function setTotalMatchedRows($totalMatchedRows)
1419 {
1420 $this->totalMatchedRows = $totalMatchedRows;
1421 }
1422 public function getTotalMatchedRows()
1423 {
1424 return $this->totalMatchedRows;
1425 }
1426 public function setTotals($totals)
1427 {
1428 $this->totals = $totals;
1429 }
1430 public function getTotals()
1431 {
1432 return $this->totals;
1433 }
1434 public function setWarnings($warnings)
1435 {
1436 $this->warnings = $warnings;
1437 }
1438 public function getWarnings()
1439 {
1440 return $this->warnings;
1441 }
1442 }
1443
1444 class Google_Service_AdExchangeSeller_ReportHeaders extends Google_Model
1445 {
1446 protected $internal_gapi_mappings = array(
1447 );
1448 public $currency;
1449 public $name;
1450 public $type;
1451
1452
1453 public function setCurrency($currency)
1454 {
1455 $this->currency = $currency;
1456 }
1457 public function getCurrency()
1458 {
1459 return $this->currency;
1460 }
1461 public function setName($name)
1462 {
1463 $this->name = $name;
1464 }
1465 public function getName()
1466 {
1467 return $this->name;
1468 }
1469 public function setType($type)
1470 {
1471 $this->type = $type;
1472 }
1473 public function getType()
1474 {
1475 return $this->type;
1476 }
1477 }
1478
1479 class Google_Service_AdExchangeSeller_ReportingMetadataEntry extends Google_Collection
1480 {
1481 protected $collection_key = 'supportedProducts';
1482 protected $internal_gapi_mappings = array(
1483 );
1484 public $compatibleDimensions;
1485 public $compatibleMetrics;
1486 public $id;
1487 public $kind;
1488 public $requiredDimensions;
1489 public $requiredMetrics;
1490 public $supportedProducts;
1491
1492
1493 public function setCompatibleDimensions($compatibleDimensions)
1494 {
1495 $this->compatibleDimensions = $compatibleDimensions;
1496 }
1497 public function getCompatibleDimensions()
1498 {
1499 return $this->compatibleDimensions;
1500 }
1501 public function setCompatibleMetrics($compatibleMetrics)
1502 {
1503 $this->compatibleMetrics = $compatibleMetrics;
1504 }
1505 public function getCompatibleMetrics()
1506 {
1507 return $this->compatibleMetrics;
1508 }
1509 public function setId($id)
1510 {
1511 $this->id = $id;
1512 }
1513 public function getId()
1514 {
1515 return $this->id;
1516 }
1517 public function setKind($kind)
1518 {
1519 $this->kind = $kind;
1520 }
1521 public function getKind()
1522 {
1523 return $this->kind;
1524 }
1525 public function setRequiredDimensions($requiredDimensions)
1526 {
1527 $this->requiredDimensions = $requiredDimensions;
1528 }
1529 public function getRequiredDimensions()
1530 {
1531 return $this->requiredDimensions;
1532 }
1533 public function setRequiredMetrics($requiredMetrics)
1534 {
1535 $this->requiredMetrics = $requiredMetrics;
1536 }
1537 public function getRequiredMetrics()
1538 {
1539 return $this->requiredMetrics;
1540 }
1541 public function setSupportedProducts($supportedProducts)
1542 {
1543 $this->supportedProducts = $supportedProducts;
1544 }
1545 public function getSupportedProducts()
1546 {
1547 return $this->supportedProducts;
1548 }
1549 }
1550
1551 class Google_Service_AdExchangeSeller_SavedReport extends Google_Model
1552 {
1553 protected $internal_gapi_mappings = array(
1554 );
1555 public $id;
1556 public $kind;
1557 public $name;
1558
1559
1560 public function setId($id)
1561 {
1562 $this->id = $id;
1563 }
1564 public function getId()
1565 {
1566 return $this->id;
1567 }
1568 public function setKind($kind)
1569 {
1570 $this->kind = $kind;
1571 }
1572 public function getKind()
1573 {
1574 return $this->kind;
1575 }
1576 public function setName($name)
1577 {
1578 $this->name = $name;
1579 }
1580 public function getName()
1581 {
1582 return $this->name;
1583 }
1584 }
1585
1586 class Google_Service_AdExchangeSeller_SavedReports extends Google_Collection
1587 {
1588 protected $collection_key = 'items';
1589 protected $internal_gapi_mappings = array(
1590 );
1591 public $etag;
1592 protected $itemsType = 'Google_Service_AdExchangeSeller_SavedReport';
1593 protected $itemsDataType = 'array';
1594 public $kind;
1595 public $nextPageToken;
1596
1597
1598 public function setEtag($etag)
1599 {
1600 $this->etag = $etag;
1601 }
1602 public function getEtag()
1603 {
1604 return $this->etag;
1605 }
1606 public function setItems($items)
1607 {
1608 $this->items = $items;
1609 }
1610 public function getItems()
1611 {
1612 return $this->items;
1613 }
1614 public function setKind($kind)
1615 {
1616 $this->kind = $kind;
1617 }
1618 public function getKind()
1619 {
1620 return $this->kind;
1621 }
1622 public function setNextPageToken($nextPageToken)
1623 {
1624 $this->nextPageToken = $nextPageToken;
1625 }
1626 public function getNextPageToken()
1627 {
1628 return $this->nextPageToken;
1629 }
1630 }
1631
1632 class Google_Service_AdExchangeSeller_UrlChannel extends Google_Model
1633 {
1634 protected $internal_gapi_mappings = array(
1635 );
1636 public $id;
1637 public $kind;
1638 public $urlPattern;
1639
1640
1641 public function setId($id)
1642 {
1643 $this->id = $id;
1644 }
1645 public function getId()
1646 {
1647 return $this->id;
1648 }
1649 public function setKind($kind)
1650 {
1651 $this->kind = $kind;
1652 }
1653 public function getKind()
1654 {
1655 return $this->kind;
1656 }
1657 public function setUrlPattern($urlPattern)
1658 {
1659 $this->urlPattern = $urlPattern;
1660 }
1661 public function getUrlPattern()
1662 {
1663 return $this->urlPattern;
1664 }
1665 }
1666
1667 class Google_Service_AdExchangeSeller_UrlChannels extends Google_Collection
1668 {
1669 protected $collection_key = 'items';
1670 protected $internal_gapi_mappings = array(
1671 );
1672 public $etag;
1673 protected $itemsType = 'Google_Service_AdExchangeSeller_UrlChannel';
1674 protected $itemsDataType = 'array';
1675 public $kind;
1676 public $nextPageToken;
1677
1678
1679 public function setEtag($etag)
1680 {
1681 $this->etag = $etag;
1682 }
1683 public function getEtag()
1684 {
1685 return $this->etag;
1686 }
1687 public function setItems($items)
1688 {
1689 $this->items = $items;
1690 }
1691 public function getItems()
1692 {
1693 return $this->items;
1694 }
1695 public function setKind($kind)
1696 {
1697 $this->kind = $kind;
1698 }
1699 public function getKind()
1700 {
1701 return $this->kind;
1702 }
1703 public function setNextPageToken($nextPageToken)
1704 {
1705 $this->nextPageToken = $nextPageToken;
1706 }
1707 public function getNextPageToken()
1708 {
1709 return $this->nextPageToken;
1710 }
1711 }
1712