Google_Service_AdSenseHost

Service definition for AdSenseHost (v4.1).

Defined (1)

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

/includes/api-libs/Google/Service/AdSenseHost.php  
  1. class Google_Service_AdSenseHost extends Google_Service 
  2. /** View and manage your AdSense host data and associated accounts. */ 
  3. const ADSENSEHOST = 
  4. "https://www.googleapis.com/auth/adsensehost"; 
  5.  
  6. public $accounts; 
  7. public $accounts_adclients; 
  8. public $accounts_adunits; 
  9. public $accounts_reports; 
  10. public $adclients; 
  11. public $associationsessions; 
  12. public $customchannels; 
  13. public $reports; 
  14. public $urlchannels; 
  15.  
  16.  
  17. /** 
  18. * Constructs the internal representation of the AdSenseHost service. 
  19. * @param Google_Client $client 
  20. */ 
  21. public function __construct(Google_Client $client) 
  22. parent::__construct($client); 
  23. $this->servicePath = 'adsensehost/v4.1/'; 
  24. $this->version = 'v4.1'; 
  25. $this->serviceName = 'adsensehost'; 
  26.  
  27. $this->accounts = new Google_Service_AdSenseHost_Accounts_Resource( 
  28. $this,  
  29. $this->serviceName,  
  30. 'accounts',  
  31. array( 
  32. 'methods' => array( 
  33. 'get' => array( 
  34. 'path' => 'accounts/{accountId}',  
  35. 'httpMethod' => 'GET',  
  36. 'parameters' => array( 
  37. 'accountId' => array( 
  38. 'location' => 'path',  
  39. 'type' => 'string',  
  40. 'required' => true,  
  41. ),  
  42. ),  
  43. ), 'list' => array( 
  44. 'path' => 'accounts',  
  45. 'httpMethod' => 'GET',  
  46. 'parameters' => array( 
  47. 'filterAdClientId' => array( 
  48. 'location' => 'query',  
  49. 'type' => 'string',  
  50. 'repeated' => true,  
  51. 'required' => true,  
  52. ),  
  53. ),  
  54. ),  
  55. ); 
  56. $this->accounts_adclients = new Google_Service_AdSenseHost_AccountsAdclients_Resource( 
  57. $this,  
  58. $this->serviceName,  
  59. 'adclients',  
  60. array( 
  61. 'methods' => array( 
  62. 'get' => array( 
  63. 'path' => 'accounts/{accountId}/adclients/{adClientId}',  
  64. 'httpMethod' => 'GET',  
  65. 'parameters' => array( 
  66. 'accountId' => array( 
  67. 'location' => 'path',  
  68. 'type' => 'string',  
  69. 'required' => true,  
  70. ),  
  71. 'adClientId' => array( 
  72. 'location' => 'path',  
  73. 'type' => 'string',  
  74. 'required' => true,  
  75. ),  
  76. ),  
  77. ), 'list' => array( 
  78. 'path' => 'accounts/{accountId}/adclients',  
  79. 'httpMethod' => 'GET',  
  80. 'parameters' => array( 
  81. 'accountId' => array( 
  82. 'location' => 'path',  
  83. 'type' => 'string',  
  84. 'required' => true,  
  85. ),  
  86. 'pageToken' => array( 
  87. 'location' => 'query',  
  88. 'type' => 'string',  
  89. ),  
  90. 'maxResults' => array( 
  91. 'location' => 'query',  
  92. 'type' => 'integer',  
  93. ),  
  94. ),  
  95. ),  
  96. ); 
  97. $this->accounts_adunits = new Google_Service_AdSenseHost_AccountsAdunits_Resource( 
  98. $this,  
  99. $this->serviceName,  
  100. 'adunits',  
  101. array( 
  102. 'methods' => array( 
  103. 'delete' => array( 
  104. 'path' => 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}',  
  105. 'httpMethod' => 'DELETE',  
  106. 'parameters' => array( 
  107. 'accountId' => array( 
  108. 'location' => 'path',  
  109. 'type' => 'string',  
  110. 'required' => true,  
  111. ),  
  112. 'adClientId' => array( 
  113. 'location' => 'path',  
  114. 'type' => 'string',  
  115. 'required' => true,  
  116. ),  
  117. 'adUnitId' => array( 
  118. 'location' => 'path',  
  119. 'type' => 'string',  
  120. 'required' => true,  
  121. ),  
  122. ),  
  123. ), 'get' => array( 
  124. 'path' => 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}',  
  125. 'httpMethod' => 'GET',  
  126. 'parameters' => array( 
  127. 'accountId' => array( 
  128. 'location' => 'path',  
  129. 'type' => 'string',  
  130. 'required' => true,  
  131. ),  
  132. 'adClientId' => array( 
  133. 'location' => 'path',  
  134. 'type' => 'string',  
  135. 'required' => true,  
  136. ),  
  137. 'adUnitId' => array( 
  138. 'location' => 'path',  
  139. 'type' => 'string',  
  140. 'required' => true,  
  141. ),  
  142. ),  
  143. ), 'getAdCode' => array( 
  144. 'path' => 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode',  
  145. 'httpMethod' => 'GET',  
  146. 'parameters' => array( 
  147. 'accountId' => array( 
  148. 'location' => 'path',  
  149. 'type' => 'string',  
  150. 'required' => true,  
  151. ),  
  152. 'adClientId' => array( 
  153. 'location' => 'path',  
  154. 'type' => 'string',  
  155. 'required' => true,  
  156. ),  
  157. 'adUnitId' => array( 
  158. 'location' => 'path',  
  159. 'type' => 'string',  
  160. 'required' => true,  
  161. ),  
  162. 'hostCustomChannelId' => array( 
  163. 'location' => 'query',  
  164. 'type' => 'string',  
  165. 'repeated' => true,  
  166. ),  
  167. ),  
  168. ), 'insert' => array( 
  169. 'path' => 'accounts/{accountId}/adclients/{adClientId}/adunits',  
  170. 'httpMethod' => 'POST',  
  171. 'parameters' => array( 
  172. 'accountId' => array( 
  173. 'location' => 'path',  
  174. 'type' => 'string',  
  175. 'required' => true,  
  176. ),  
  177. 'adClientId' => array( 
  178. 'location' => 'path',  
  179. 'type' => 'string',  
  180. 'required' => true,  
  181. ),  
  182. ),  
  183. ), 'list' => array( 
  184. 'path' => 'accounts/{accountId}/adclients/{adClientId}/adunits',  
  185. 'httpMethod' => 'GET',  
  186. 'parameters' => array( 
  187. 'accountId' => array( 
  188. 'location' => 'path',  
  189. 'type' => 'string',  
  190. 'required' => true,  
  191. ),  
  192. 'adClientId' => array( 
  193. 'location' => 'path',  
  194. 'type' => 'string',  
  195. 'required' => true,  
  196. ),  
  197. 'includeInactive' => array( 
  198. 'location' => 'query',  
  199. 'type' => 'boolean',  
  200. ),  
  201. 'pageToken' => array( 
  202. 'location' => 'query',  
  203. 'type' => 'string',  
  204. ),  
  205. 'maxResults' => array( 
  206. 'location' => 'query',  
  207. 'type' => 'integer',  
  208. ),  
  209. ),  
  210. ), 'patch' => array( 
  211. 'path' => 'accounts/{accountId}/adclients/{adClientId}/adunits',  
  212. 'httpMethod' => 'PATCH',  
  213. 'parameters' => array( 
  214. 'accountId' => array( 
  215. 'location' => 'path',  
  216. 'type' => 'string',  
  217. 'required' => true,  
  218. ),  
  219. 'adClientId' => array( 
  220. 'location' => 'path',  
  221. 'type' => 'string',  
  222. 'required' => true,  
  223. ),  
  224. 'adUnitId' => array( 
  225. 'location' => 'query',  
  226. 'type' => 'string',  
  227. 'required' => true,  
  228. ),  
  229. ),  
  230. ), 'update' => array( 
  231. 'path' => 'accounts/{accountId}/adclients/{adClientId}/adunits',  
  232. 'httpMethod' => 'PUT',  
  233. 'parameters' => array( 
  234. 'accountId' => array( 
  235. 'location' => 'path',  
  236. 'type' => 'string',  
  237. 'required' => true,  
  238. ),  
  239. 'adClientId' => array( 
  240. 'location' => 'path',  
  241. 'type' => 'string',  
  242. 'required' => true,  
  243. ),  
  244. ),  
  245. ),  
  246. ); 
  247. $this->accounts_reports = new Google_Service_AdSenseHost_AccountsReports_Resource( 
  248. $this,  
  249. $this->serviceName,  
  250. 'reports',  
  251. array( 
  252. 'methods' => array( 
  253. 'generate' => array( 
  254. 'path' => 'accounts/{accountId}/reports',  
  255. 'httpMethod' => 'GET',  
  256. 'parameters' => array( 
  257. 'accountId' => array( 
  258. 'location' => 'path',  
  259. 'type' => 'string',  
  260. 'required' => true,  
  261. ),  
  262. 'startDate' => array( 
  263. 'location' => 'query',  
  264. 'type' => 'string',  
  265. 'required' => true,  
  266. ),  
  267. 'endDate' => array( 
  268. 'location' => 'query',  
  269. 'type' => 'string',  
  270. 'required' => true,  
  271. ),  
  272. 'sort' => array( 
  273. 'location' => 'query',  
  274. 'type' => 'string',  
  275. 'repeated' => true,  
  276. ),  
  277. 'locale' => array( 
  278. 'location' => 'query',  
  279. 'type' => 'string',  
  280. ),  
  281. 'metric' => array( 
  282. 'location' => 'query',  
  283. 'type' => 'string',  
  284. 'repeated' => true,  
  285. ),  
  286. 'maxResults' => array( 
  287. 'location' => 'query',  
  288. 'type' => 'integer',  
  289. ),  
  290. 'filter' => array( 
  291. 'location' => 'query',  
  292. 'type' => 'string',  
  293. 'repeated' => true,  
  294. ),  
  295. 'startIndex' => array( 
  296. 'location' => 'query',  
  297. 'type' => 'integer',  
  298. ),  
  299. 'dimension' => array( 
  300. 'location' => 'query',  
  301. 'type' => 'string',  
  302. 'repeated' => true,  
  303. ),  
  304. ),  
  305. ),  
  306. ); 
  307. $this->adclients = new Google_Service_AdSenseHost_Adclients_Resource( 
  308. $this,  
  309. $this->serviceName,  
  310. 'adclients',  
  311. array( 
  312. 'methods' => array( 
  313. 'get' => array( 
  314. 'path' => 'adclients/{adClientId}',  
  315. 'httpMethod' => 'GET',  
  316. 'parameters' => array( 
  317. 'adClientId' => array( 
  318. 'location' => 'path',  
  319. 'type' => 'string',  
  320. 'required' => true,  
  321. ),  
  322. ),  
  323. ), 'list' => array( 
  324. 'path' => 'adclients',  
  325. 'httpMethod' => 'GET',  
  326. 'parameters' => array( 
  327. 'pageToken' => array( 
  328. 'location' => 'query',  
  329. 'type' => 'string',  
  330. ),  
  331. 'maxResults' => array( 
  332. 'location' => 'query',  
  333. 'type' => 'integer',  
  334. ),  
  335. ),  
  336. ),  
  337. ); 
  338. $this->associationsessions = new Google_Service_AdSenseHost_Associationsessions_Resource( 
  339. $this,  
  340. $this->serviceName,  
  341. 'associationsessions',  
  342. array( 
  343. 'methods' => array( 
  344. 'start' => array( 
  345. 'path' => 'associationsessions/start',  
  346. 'httpMethod' => 'GET',  
  347. 'parameters' => array( 
  348. 'productCode' => array( 
  349. 'location' => 'query',  
  350. 'type' => 'string',  
  351. 'repeated' => true,  
  352. 'required' => true,  
  353. ),  
  354. 'websiteUrl' => array( 
  355. 'location' => 'query',  
  356. 'type' => 'string',  
  357. 'required' => true,  
  358. ),  
  359. 'websiteLocale' => array( 
  360. 'location' => 'query',  
  361. 'type' => 'string',  
  362. ),  
  363. 'userLocale' => array( 
  364. 'location' => 'query',  
  365. 'type' => 'string',  
  366. ),  
  367. ),  
  368. ), 'verify' => array( 
  369. 'path' => 'associationsessions/verify',  
  370. 'httpMethod' => 'GET',  
  371. 'parameters' => array( 
  372. 'token' => array( 
  373. 'location' => 'query',  
  374. 'type' => 'string',  
  375. 'required' => true,  
  376. ),  
  377. ),  
  378. ),  
  379. ); 
  380. $this->customchannels = new Google_Service_AdSenseHost_Customchannels_Resource( 
  381. $this,  
  382. $this->serviceName,  
  383. 'customchannels',  
  384. array( 
  385. 'methods' => array( 
  386. 'delete' => array( 
  387. 'path' => 'adclients/{adClientId}/customchannels/{customChannelId}',  
  388. 'httpMethod' => 'DELETE',  
  389. 'parameters' => array( 
  390. 'adClientId' => array( 
  391. 'location' => 'path',  
  392. 'type' => 'string',  
  393. 'required' => true,  
  394. ),  
  395. 'customChannelId' => array( 
  396. 'location' => 'path',  
  397. 'type' => 'string',  
  398. 'required' => true,  
  399. ),  
  400. ),  
  401. ), 'get' => array( 
  402. 'path' => 'adclients/{adClientId}/customchannels/{customChannelId}',  
  403. 'httpMethod' => 'GET',  
  404. 'parameters' => array( 
  405. 'adClientId' => array( 
  406. 'location' => 'path',  
  407. 'type' => 'string',  
  408. 'required' => true,  
  409. ),  
  410. 'customChannelId' => array( 
  411. 'location' => 'path',  
  412. 'type' => 'string',  
  413. 'required' => true,  
  414. ),  
  415. ),  
  416. ), 'insert' => array( 
  417. 'path' => 'adclients/{adClientId}/customchannels',  
  418. 'httpMethod' => 'POST',  
  419. 'parameters' => array( 
  420. 'adClientId' => array( 
  421. 'location' => 'path',  
  422. 'type' => 'string',  
  423. 'required' => true,  
  424. ),  
  425. ),  
  426. ), 'list' => array( 
  427. 'path' => 'adclients/{adClientId}/customchannels',  
  428. 'httpMethod' => 'GET',  
  429. 'parameters' => array( 
  430. 'adClientId' => array( 
  431. 'location' => 'path',  
  432. 'type' => 'string',  
  433. 'required' => true,  
  434. ),  
  435. 'pageToken' => array( 
  436. 'location' => 'query',  
  437. 'type' => 'string',  
  438. ),  
  439. 'maxResults' => array( 
  440. 'location' => 'query',  
  441. 'type' => 'integer',  
  442. ),  
  443. ),  
  444. ), 'patch' => array( 
  445. 'path' => 'adclients/{adClientId}/customchannels',  
  446. 'httpMethod' => 'PATCH',  
  447. 'parameters' => array( 
  448. 'adClientId' => array( 
  449. 'location' => 'path',  
  450. 'type' => 'string',  
  451. 'required' => true,  
  452. ),  
  453. 'customChannelId' => array( 
  454. 'location' => 'query',  
  455. 'type' => 'string',  
  456. 'required' => true,  
  457. ),  
  458. ),  
  459. ), 'update' => array( 
  460. 'path' => 'adclients/{adClientId}/customchannels',  
  461. 'httpMethod' => 'PUT',  
  462. 'parameters' => array( 
  463. 'adClientId' => array( 
  464. 'location' => 'path',  
  465. 'type' => 'string',  
  466. 'required' => true,  
  467. ),  
  468. ),  
  469. ),  
  470. ); 
  471. $this->reports = new Google_Service_AdSenseHost_Reports_Resource( 
  472. $this,  
  473. $this->serviceName,  
  474. 'reports',  
  475. array( 
  476. 'methods' => array( 
  477. 'generate' => array( 
  478. 'path' => 'reports',  
  479. 'httpMethod' => 'GET',  
  480. 'parameters' => array( 
  481. 'startDate' => array( 
  482. 'location' => 'query',  
  483. 'type' => 'string',  
  484. 'required' => true,  
  485. ),  
  486. 'endDate' => array( 
  487. 'location' => 'query',  
  488. 'type' => 'string',  
  489. 'required' => true,  
  490. ),  
  491. 'sort' => array( 
  492. 'location' => 'query',  
  493. 'type' => 'string',  
  494. 'repeated' => true,  
  495. ),  
  496. 'locale' => array( 
  497. 'location' => 'query',  
  498. 'type' => 'string',  
  499. ),  
  500. 'metric' => array( 
  501. 'location' => 'query',  
  502. 'type' => 'string',  
  503. 'repeated' => true,  
  504. ),  
  505. 'maxResults' => array( 
  506. 'location' => 'query',  
  507. 'type' => 'integer',  
  508. ),  
  509. 'filter' => array( 
  510. 'location' => 'query',  
  511. 'type' => 'string',  
  512. 'repeated' => true,  
  513. ),  
  514. 'startIndex' => array( 
  515. 'location' => 'query',  
  516. 'type' => 'integer',  
  517. ),  
  518. 'dimension' => array( 
  519. 'location' => 'query',  
  520. 'type' => 'string',  
  521. 'repeated' => true,  
  522. ),  
  523. ),  
  524. ),  
  525. ); 
  526. $this->urlchannels = new Google_Service_AdSenseHost_Urlchannels_Resource( 
  527. $this,  
  528. $this->serviceName,  
  529. 'urlchannels',  
  530. array( 
  531. 'methods' => array( 
  532. 'delete' => array( 
  533. 'path' => 'adclients/{adClientId}/urlchannels/{urlChannelId}',  
  534. 'httpMethod' => 'DELETE',  
  535. 'parameters' => array( 
  536. 'adClientId' => array( 
  537. 'location' => 'path',  
  538. 'type' => 'string',  
  539. 'required' => true,  
  540. ),  
  541. 'urlChannelId' => array( 
  542. 'location' => 'path',  
  543. 'type' => 'string',  
  544. 'required' => true,  
  545. ),  
  546. ),  
  547. ), 'insert' => array( 
  548. 'path' => 'adclients/{adClientId}/urlchannels',  
  549. 'httpMethod' => 'POST',  
  550. 'parameters' => array( 
  551. 'adClientId' => array( 
  552. 'location' => 'path',  
  553. 'type' => 'string',  
  554. 'required' => true,  
  555. ),  
  556. ),  
  557. ), 'list' => array( 
  558. 'path' => 'adclients/{adClientId}/urlchannels',  
  559. 'httpMethod' => 'GET',  
  560. 'parameters' => array( 
  561. 'adClientId' => array( 
  562. 'location' => 'path',  
  563. 'type' => 'string',  
  564. 'required' => true,  
  565. ),  
  566. 'pageToken' => array( 
  567. 'location' => 'query',  
  568. 'type' => 'string',  
  569. ),  
  570. 'maxResults' => array( 
  571. 'location' => 'query',  
  572. 'type' => 'integer',  
  573. ),  
  574. ),  
  575. ),  
  576. );