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