1 <?php
  2 /**
  3  * @package     Joomla.Platform
  4  * @subpackage  Google
  5  *
  6  * @copyright   Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved
  7  * @license     GNU General Public License version 2 or later; see LICENSE
  8  */
  9 
 10 defined('JPATH_PLATFORM') or die;
 11 
 12 use Joomla\Registry\Registry;
 13 
 14 /**
 15  * Google Adsense data class for the Joomla Platform.
 16  *
 17  * @since       12.3
 18  * @deprecated  4.0  Use the `joomla/google` package via Composer instead
 19  */
 20 class JGoogleDataAdsense extends JGoogleData
 21 {
 22     /**
 23      * Constructor.
 24      *
 25      * @param   Registry     $options  Google options object
 26      * @param   JGoogleAuth  $auth     Google data http client object
 27      *
 28      * @since   12.3
 29      */
 30     public function __construct(Registry $options = null, JGoogleAuth $auth = null)
 31     {
 32         parent::__construct($options, $auth);
 33 
 34         if (isset($this->auth) && !$this->auth->getOption('scope'))
 35         {
 36             $this->auth->setOption('scope', 'https://www.googleapis.com/auth/adsense');
 37         }
 38     }
 39 
 40     /**
 41      * Method to get an Adsense account's settings from Google
 42      *
 43      * @param   string   $accountID    ID of account to get
 44      * @param   boolean  $subaccounts  Include list of subaccounts
 45      *
 46      * @return  mixed  Data from Google
 47      *
 48      * @since   12.3
 49      * @throws  UnexpectedValueException
 50      */
 51     public function getAccount($accountID, $subaccounts = true)
 52     {
 53         if ($this->isAuthenticated())
 54         {
 55             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID) . ($subaccounts ? '?tree=true' : '');
 56             $jdata = $this->query($url);
 57 
 58             if ($data = json_decode($jdata->body, true))
 59             {
 60                 return $data;
 61             }
 62             else
 63             {
 64                 throw new UnexpectedValueException("Unexpected data received from Google: `{$jdata->body}`.");
 65             }
 66         }
 67         else
 68         {
 69             return false;
 70         }
 71     }
 72 
 73     /**
 74      * Method to retrieve a list of AdSense accounts from Google
 75      *
 76      * @param   array  $options   Search settings
 77      * @param   int    $maxpages  Maximum number of pages of accounts to return
 78      *
 79      * @return  mixed  Data from Google
 80      *
 81      * @since   12.3
 82      * @throws  UnexpectedValueException
 83      */
 84     public function listAccounts($options = array(), $maxpages = 1)
 85     {
 86         if ($this->isAuthenticated())
 87         {
 88             $next = array_key_exists('nextPageToken', $options) ? $options['nextPage'] : null;
 89             unset($options['nextPageToken']);
 90             $url = 'https://www.googleapis.com/adsense/v1.1/accounts?' . http_build_query($options);
 91 
 92             return $this->listGetData($url, $maxpages, $next);
 93         }
 94         else
 95         {
 96             return false;
 97         }
 98     }
 99 
100     /**
101      * Method to retrieve a list of AdSense clients from Google
102      *
103      * @param   string  $accountID  ID of account to list the clients from
104      * @param   array   $options    Search settings
105      * @param   int     $maxpages   Maximum number of pages of accounts to return
106      *
107      * @return  mixed  Data from Google
108      *
109      * @since   12.3
110      * @throws  UnexpectedValueException
111      */
112     public function listClients($accountID, $options = array(), $maxpages = 1)
113     {
114         if ($this->isAuthenticated())
115         {
116             $next = array_key_exists('nextPageToken', $options) ? $options['nextPage'] : null;
117             unset($options['nextPageToken']);
118             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID) . '/adclients?' . http_build_query($options);
119 
120             return $this->listGetData($url, $maxpages, $next);
121         }
122         else
123         {
124             return false;
125         }
126     }
127 
128     /**
129      * Method to get an AdSense AdUnit
130      *
131      * @param   string  $accountID   ID of account to get
132      * @param   string  $adclientID  ID of client to get
133      * @param   string  $adunitID    ID of adunit to get
134      *
135      * @return  mixed  Data from Google
136      *
137      * @since   12.3
138      * @throws  UnexpectedValueException
139      */
140     public function getUnit($accountID, $adclientID, $adunitID)
141     {
142         if ($this->isAuthenticated())
143         {
144             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID);
145             $url .= '/adclients/' . urlencode($adclientID) . '/adunits/' . urlencode($adunitID);
146             $jdata = $this->query($url);
147 
148             if ($data = json_decode($jdata->body, true))
149             {
150                 return $data;
151             }
152             else
153             {
154                 throw new UnexpectedValueException("Unexpected data received from Google: `{$jdata->body}`.");
155             }
156         }
157         else
158         {
159             return false;
160         }
161     }
162 
163     /**
164      * Method to retrieve a list of AdSense Custom Channels for a specific Adunit
165      *
166      * @param   string  $accountID   ID of account
167      * @param   string  $adclientID  ID of client
168      * @param   string  $adunitID    ID of adunit to list channels from
169      * @param   array   $options     Search settings
170      * @param   int     $maxpages    Maximum number of pages of accounts to return
171      *
172      * @return  mixed  Data from Google
173      *
174      * @since   12.3
175      * @throws  UnexpectedValueException
176      */
177     public function listUnitChannels($accountID, $adclientID, $adunitID, $options = array(), $maxpages = 1)
178     {
179         if ($this->isAuthenticated())
180         {
181             $next = array_key_exists('nextPageToken', $options) ? $options['nextPage'] : null;
182             unset($options['nextPageToken']);
183             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID);
184             $url .= '/adclients/' . urlencode($adclientID) . '/adunits/' . urlencode($adunitID) . '/customchannels?' . http_build_query($options);
185 
186             return $this->listGetData($url, $maxpages, $next);
187         }
188         else
189         {
190             return false;
191         }
192     }
193 
194     /**
195      * Method to get an Adsense Channel
196      *
197      * @param   string  $accountID   ID of account to get
198      * @param   string  $adclientID  ID of client to get
199      * @param   string  $channelID   ID of channel to get
200      *
201      * @return  mixed  Data from Google
202      *
203      * @since   12.3
204      * @throws  UnexpectedValueException
205      */
206     public function getChannel($accountID, $adclientID, $channelID)
207     {
208         if ($this->isAuthenticated())
209         {
210             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID) . '/adclients/';
211             $url .= urlencode($adclientID) . '/customchannels/' . urlencode($channelID);
212             $jdata = $this->query($url);
213 
214             if ($data = json_decode($jdata->body, true))
215             {
216                 return $data;
217             }
218             else
219             {
220                 throw new UnexpectedValueException("Unexpected data received from Google: `{$jdata->body}`.");
221             }
222         }
223         else
224         {
225             return false;
226         }
227     }
228 
229     /**
230      * Method to retrieve a list of AdSense Custom Channels
231      *
232      * @param   string  $accountID   ID of account
233      * @param   string  $adclientID  ID of client to list channels from
234      * @param   array   $options     Search settings
235      * @param   int     $maxpages    Maximum number of pages of accounts to return
236      *
237      * @return  mixed  Data from Google
238      *
239      * @since   12.3
240      * @throws  UnexpectedValueException
241      */
242     public function listChannels($accountID, $adclientID, $options = array(), $maxpages = 1)
243     {
244         if ($this->isAuthenticated())
245         {
246             $next = array_key_exists('nextPageToken', $options) ? $options['nextPage'] : null;
247             unset($options['nextPageToken']);
248             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID) . '/adclients/' . urlencode($adclientID);
249             $url .= '/customchannels?' . http_build_query($options);
250 
251             return $this->listGetData($url, $maxpages, $next);
252         }
253         else
254         {
255             return false;
256         }
257     }
258 
259     /**
260      * Method to retrieve a list of AdSense Adunits for a specific Custom Channel
261      *
262      * @param   string  $accountID   ID of account
263      * @param   string  $adclientID  ID of client
264      * @param   string  $channelID   ID of channel to list units from
265      * @param   array   $options     Search settings
266      * @param   int     $maxpages    Maximum number of pages of accounts to return
267      *
268      * @return  mixed  Data from Google
269      *
270      * @since   12.3
271      * @throws  UnexpectedValueException
272      */
273     public function listChannelUnits($accountID, $adclientID, $channelID, $options = array(), $maxpages = 1)
274     {
275         if ($this->isAuthenticated())
276         {
277             $next = array_key_exists('nextPageToken', $options) ? $options['nextPage'] : null;
278             unset($options['nextPageToken']);
279             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID) . '/adclients/' . urlencode($adclientID);
280             $url .= '/customchannels/' . urlencode($channelID) . '/adunits?' . http_build_query($options);
281 
282             return $this->listGetData($url, $maxpages, $next);
283         }
284         else
285         {
286             return false;
287         }
288     }
289 
290     /**
291      * Method to generate a report from Google AdSense
292      *
293      * @param   string  $accountID   ID of account
294      * @param   string  $adclientID  ID of client
295      * @param   array   $options     Search settings
296      * @param   int     $maxpages    Maximum number of pages of accounts to return
297      *
298      * @return  mixed  Data from Google
299      *
300      * @since   12.3
301      * @throws  UnexpectedValueException
302      */
303     public function listUrlChannels($accountID, $adclientID, $options = array(), $maxpages = 1)
304     {
305         if ($this->isAuthenticated())
306         {
307             $next = array_key_exists('nextPageToken', $options) ? $options['nextPage'] : null;
308             unset($options['nextPageToken']);
309             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID);
310             $url .= '/adclients/' . urlencode($adclientID) . '/urlchannels?' . http_build_query($options);
311 
312             return $this->listGetData($url, $maxpages, $next);
313         }
314         else
315         {
316             return false;
317         }
318     }
319 
320     /**
321      * Method to retrieve a list of AdSense Channel URLs
322      *
323      * @param   string  $accountID  ID of account
324      * @param   mixed   $start      Start day
325      * @param   mixed   $end        End day
326      * @param   array   $options    Search settings
327      * @param   int     $maxpages   Maximum number of pages of accounts to return
328      *
329      * @return  mixed  Data from Google
330      *
331      * @since   12.3
332      * @throws  InvalidArgumentException
333      * @throws  UnexpectedValueException
334      */
335     public function generateReport($accountID, $start, $end = false, $options = array(), $maxpages = 1)
336     {
337         if ($this->isAuthenticated())
338         {
339             if (is_int($start))
340             {
341                 $startobj = new DateTime;
342                 $startobj->setTimestamp($start);
343             }
344             elseif (is_string($start))
345             {
346                 $startobj = new DateTime($start);
347             }
348             elseif (is_a($start, 'DateTime'))
349             {
350                 $startobj = $start;
351             }
352             else
353             {
354                 throw new InvalidArgumentException('Invalid start time.');
355             }
356 
357             if (!$end)
358             {
359                 $endobj = new DateTime;
360             }
361             elseif (is_int($end))
362             {
363                 $endobj = new DateTime;
364                 $endobj->setTimestamp($end);
365             }
366             elseif (is_string($end))
367             {
368                 $endobj = new DateTime($end);
369             }
370             elseif (is_a($end, 'DateTime'))
371             {
372                 $endobj = $end;
373             }
374             else
375             {
376                 throw new InvalidArgumentException('Invalid end time.');
377             }
378 
379             $options['startDate'] = $startobj->format('Y-m-d');
380             $options['endDate'] = $endobj->format('Y-m-d');
381 
382             unset($options['startIndex']);
383 
384             $url = 'https://www.googleapis.com/adsense/v1.1/accounts/' . urlencode($accountID) . '/reports?' . http_build_query($options);
385 
386             if (strpos($url, '&'))
387             {
388                 $url .= '&';
389             }
390 
391             $i = 0;
392             $data['rows'] = array();
393 
394             do
395             {
396                 $jdata = $this->query($url . 'startIndex=' . count($data['rows']));
397                 $newdata = json_decode($jdata->body, true);
398 
399                 if ($newdata && array_key_exists('rows', $newdata))
400                 {
401                     $newdata['rows'] = array_merge($data['rows'], $newdata['rows']);
402                     $data = $newdata;
403                 }
404                 else
405                 {
406                     throw new UnexpectedValueException("Unexpected data received from Google: `{$jdata->body}`.");
407                 }
408 
409                 $i++;
410             }
411             while (count($data['rows']) < $data['totalMatchedRows'] && $i < $maxpages);
412 
413             return $data;
414         }
415         else
416         {
417             return false;
418         }
419     }
420 }
421 

Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.