Google_AccountsAdunitsServiceResource

The "adunits" collection of methods.

Defined (2)

The class is defined in the following location(s).

/src/contrib/Google_AdsensehostService.php  
  1. class Google_AccountsAdunitsServiceResource extends Google_ServiceResource { 
  2.  
  3.   /** 
  4.    * Delete the specified ad unit from the specified publisher AdSense account. (adunits.delete) 
  5.    * 
  6.    * @param string $accountId Account which contains the ad unit. 
  7.    * @param string $adClientId Ad client for which to get ad unit. 
  8.    * @param string $adUnitId Ad unit to delete. 
  9.    * @param array $optParams Optional parameters. 
  10.    * @return Google_AdUnit 
  11.    */ 
  12.   public function delete($accountId, $adClientId, $adUnitId, $optParams = array()) { 
  13.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'adUnitId' => $adUnitId); 
  14.     $params = array_merge($params, $optParams); 
  15.     $data = $this->__call('delete', array($params)); 
  16.     if ($this->useObjects()) { 
  17.       return new Google_AdUnit($data); 
  18.     } else { 
  19.       return $data; 
  20.     } 
  21.   } 
  22.   /** 
  23.    * Get the specified host ad unit in this AdSense account. (adunits.get) 
  24.    * 
  25.    * @param string $accountId Account which contains the ad unit. 
  26.    * @param string $adClientId Ad client for which to get ad unit. 
  27.    * @param string $adUnitId Ad unit to get. 
  28.    * @param array $optParams Optional parameters. 
  29.    * @return Google_AdUnit 
  30.    */ 
  31.   public function get($accountId, $adClientId, $adUnitId, $optParams = array()) { 
  32.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'adUnitId' => $adUnitId); 
  33.     $params = array_merge($params, $optParams); 
  34.     $data = $this->__call('get', array($params)); 
  35.     if ($this->useObjects()) { 
  36.       return new Google_AdUnit($data); 
  37.     } else { 
  38.       return $data; 
  39.     } 
  40.   } 
  41.   /** 
  42.    * Get ad code for the specified ad unit, attaching the specified host custom channels. 
  43.    * (adunits.getAdCode) 
  44.    * 
  45.    * @param string $accountId Account which contains the ad client. 
  46.    * @param string $adClientId Ad client with contains the ad unit. 
  47.    * @param string $adUnitId Ad unit to get the code for. 
  48.    * @param array $optParams Optional parameters. 
  49.    * 
  50.    * @opt_param string hostCustomChannelId Host custom channel to attach to the ad code. 
  51.    * @return Google_AdCode 
  52.    */ 
  53.   public function getAdCode($accountId, $adClientId, $adUnitId, $optParams = array()) { 
  54.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'adUnitId' => $adUnitId); 
  55.     $params = array_merge($params, $optParams); 
  56.     $data = $this->__call('getAdCode', array($params)); 
  57.     if ($this->useObjects()) { 
  58.       return new Google_AdCode($data); 
  59.     } else { 
  60.       return $data; 
  61.     } 
  62.   } 
  63.   /** 
  64.    * Insert the supplied ad unit into the specified publisher AdSense account. (adunits.insert) 
  65.    * 
  66.    * @param string $accountId Account which will contain the ad unit. 
  67.    * @param string $adClientId Ad client into which to insert the ad unit. 
  68.    * @param Google_AdUnit $postBody 
  69.    * @param array $optParams Optional parameters. 
  70.    * @return Google_AdUnit 
  71.    */ 
  72.   public function insert($accountId, $adClientId, Google_AdUnit $postBody, $optParams = array()) { 
  73.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'postBody' => $postBody); 
  74.     $params = array_merge($params, $optParams); 
  75.     $data = $this->__call('insert', array($params)); 
  76.     if ($this->useObjects()) { 
  77.       return new Google_AdUnit($data); 
  78.     } else { 
  79.       return $data; 
  80.     } 
  81.   } 
  82.   /** 
  83.    * List all ad units in the specified publisher's AdSense account. (adunits.list) 
  84.    * 
  85.    * @param string $accountId Account which contains the ad client. 
  86.    * @param string $adClientId Ad client for which to list ad units. 
  87.    * @param array $optParams Optional parameters. 
  88.    * 
  89.    * @opt_param bool includeInactive Whether to include inactive ad units. Default: true. 
  90.    * @opt_param string maxResults The maximum number of ad units to include in the response, used for paging. 
  91.    * @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. 
  92.    * @return Google_AdUnits 
  93.    */ 
  94.   public function listAccountsAdunits($accountId, $adClientId, $optParams = array()) { 
  95.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId); 
  96.     $params = array_merge($params, $optParams); 
  97.     $data = $this->__call('list', array($params)); 
  98.     if ($this->useObjects()) { 
  99.       return new Google_AdUnits($data); 
  100.     } else { 
  101.       return $data; 
  102.     } 
  103.   } 
  104.   /** 
  105.    * Update the supplied ad unit in the specified publisher AdSense account. This method supports 
  106.    * patch semantics. (adunits.patch) 
  107.    * 
  108.    * @param string $accountId Account which contains the ad client. 
  109.    * @param string $adClientId Ad client which contains the ad unit. 
  110.    * @param string $adUnitId Ad unit to get. 
  111.    * @param Google_AdUnit $postBody 
  112.    * @param array $optParams Optional parameters. 
  113.    * @return Google_AdUnit 
  114.    */ 
  115.   public function patch($accountId, $adClientId, $adUnitId, Google_AdUnit $postBody, $optParams = array()) { 
  116.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'adUnitId' => $adUnitId, 'postBody' => $postBody); 
  117.     $params = array_merge($params, $optParams); 
  118.     $data = $this->__call('patch', array($params)); 
  119.     if ($this->useObjects()) { 
  120.       return new Google_AdUnit($data); 
  121.     } else { 
  122.       return $data; 
  123.     } 
  124.   } 
  125.   /** 
  126.    * Update the supplied ad unit in the specified publisher AdSense account. (adunits.update) 
  127.    * 
  128.    * @param string $accountId Account which contains the ad client. 
  129.    * @param string $adClientId Ad client which contains the ad unit. 
  130.    * @param Google_AdUnit $postBody 
  131.    * @param array $optParams Optional parameters. 
  132.    * @return Google_AdUnit 
  133.    */ 
  134.   public function update($accountId, $adClientId, Google_AdUnit $postBody, $optParams = array()) { 
  135.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'postBody' => $postBody); 
  136.     $params = array_merge($params, $optParams); 
  137.     $data = $this->__call('update', array($params)); 
  138.     if ($this->useObjects()) { 
  139.       return new Google_AdUnit($data); 
  140.     } else { 
  141.       return $data; 
  142.     } 
  143.   } 
  144. } 
/src/contrib/Google_AdSenseService.php  
  1. class Google_AccountsAdunitsServiceResource extends Google_ServiceResource { 
  2.  
  3.   /** 
  4.    * Gets the specified ad unit in the specified ad client for the specified account. (adunits.get) 
  5.    * 
  6.    * @param string $accountId Account to which the ad client belongs. 
  7.    * @param string $adClientId Ad client for which to get the ad unit. 
  8.    * @param string $adUnitId Ad unit to retrieve. 
  9.    * @param array $optParams Optional parameters. 
  10.    * @return Google_AdUnit 
  11.    */ 
  12.   public function get($accountId, $adClientId, $adUnitId, $optParams = array()) { 
  13.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'adUnitId' => $adUnitId); 
  14.     $params = array_merge($params, $optParams); 
  15.     $data = $this->__call('get', array($params)); 
  16.     if ($this->useObjects()) { 
  17.       return new Google_AdUnit($data); 
  18.     } else { 
  19.       return $data; 
  20.     } 
  21.   } 
  22.   /** 
  23.    * Get ad code for the specified ad unit. (adunits.getAdCode) 
  24.    * 
  25.    * @param string $accountId Account which contains the ad client. 
  26.    * @param string $adClientId Ad client with contains the ad unit. 
  27.    * @param string $adUnitId Ad unit to get the code for. 
  28.    * @param array $optParams Optional parameters. 
  29.    * @return Google_AdCode 
  30.    */ 
  31.   public function getAdCode($accountId, $adClientId, $adUnitId, $optParams = array()) { 
  32.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId, 'adUnitId' => $adUnitId); 
  33.     $params = array_merge($params, $optParams); 
  34.     $data = $this->__call('getAdCode', array($params)); 
  35.     if ($this->useObjects()) { 
  36.       return new Google_AdCode($data); 
  37.     } else { 
  38.       return $data; 
  39.     } 
  40.   } 
  41.   /** 
  42.    * List all ad units in the specified ad client for the specified account. (adunits.list) 
  43.    * 
  44.    * @param string $accountId Account to which the ad client belongs. 
  45.    * @param string $adClientId Ad client for which to list ad units. 
  46.    * @param array $optParams Optional parameters. 
  47.    * 
  48.    * @opt_param bool includeInactive Whether to include inactive ad units. Default: true. 
  49.    * @opt_param int maxResults The maximum number of ad units to include in the response, used for paging. 
  50.    * @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. 
  51.    * @return Google_AdUnits 
  52.    */ 
  53.   public function listAccountsAdunits($accountId, $adClientId, $optParams = array()) { 
  54.     $params = array('accountId' => $accountId, 'adClientId' => $adClientId); 
  55.     $params = array_merge($params, $optParams); 
  56.     $data = $this->__call('list', array($params)); 
  57.     if ($this->useObjects()) { 
  58.       return new Google_AdUnits($data); 
  59.     } else { 
  60.       return $data; 
  61.     } 
  62.   } 
  63. }