google_AdunitsServiceResource
The "adunits" collection of methods.
Defined (2)
The class is defined in the following location(s).
- /src/contrib/Google_AdExchangeSellerService.php
- class google_AdunitsServiceResource extends Google_ServiceResource {
- /**
- * Gets the specified ad unit in the specified ad client. (adunits.get)
- *
- * @param string $adClientId Ad client for which to get the ad unit.
- * @param string $adUnitId Ad unit to retrieve.
- * @param array $optParams Optional parameters.
- * @return google_AdUnit
- */
- public function get($adClientId, $adUnitId, $optParams = array()) {
- $params = array('adClientId' => $adClientId, 'adUnitId' => $adUnitId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new google_AdUnit($data);
- } else {
- return $data;
- }
- }
- /**
- * List all ad units in the specified ad client for this Ad Exchange account.
- * (adunits.list)
- *
- * @param string $adClientId Ad client for which to list ad units.
- * @param array $optParams Optional parameters.
- *
- * @opt_param bool includeInactive Whether to include inactive ad units. Default: true.
- * @opt_param string maxResults The maximum number of ad units to include in the response, used for paging.
- * @opt_param string pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- * @return google_AdUnits
- */
- public function listAdunits($adClientId, $optParams = array()) {
- $params = array('adClientId' => $adClientId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new google_AdUnits($data);
- } else {
- return $data;
- }
- }
- }
- /src/contrib/Google_AdSenseService.php
- class Google_AdunitsServiceResource extends Google_ServiceResource {
- /**
- * Gets the specified ad unit in the specified ad client. (adunits.get)
- *
- * @param string $adClientId Ad client for which to get the ad unit.
- * @param string $adUnitId Ad unit to retrieve.
- * @param array $optParams Optional parameters.
- * @return Google_AdUnit
- */
- public function get($adClientId, $adUnitId, $optParams = array()) {
- $params = array('adClientId' => $adClientId, 'adUnitId' => $adUnitId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Google_AdUnit($data);
- } else {
- return $data;
- }
- }
- /**
- * Get ad code for the specified ad unit. (adunits.getAdCode)
- *
- * @param string $adClientId Ad client with contains the ad unit.
- * @param string $adUnitId Ad unit to get the code for.
- * @param array $optParams Optional parameters.
- * @return Google_AdCode
- */
- public function getAdCode($adClientId, $adUnitId, $optParams = array()) {
- $params = array('adClientId' => $adClientId, 'adUnitId' => $adUnitId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('getAdCode', array($params));
- if ($this->useObjects()) {
- return new Google_AdCode($data);
- } else {
- return $data;
- }
- }
- /**
- * List all ad units in the specified ad client for this AdSense account. (adunits.list)
- *
- * @param string $adClientId Ad client for which to list ad units.
- * @param array $optParams Optional parameters.
- *
- * @opt_param bool includeInactive Whether to include inactive ad units. Default: true.
- * @opt_param int maxResults The maximum number of ad units to include in the response, used for paging.
- * @opt_param string pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- * @return Google_AdUnits
- */
- public function listAdunits($adClientId, $optParams = array()) {
- $params = array('adClientId' => $adClientId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_AdUnits($data);
- } else {
- return $data;
- }
- }
- }