Google_Service_AdSenseHost

Service definition for AdSenseHost (v4.1).

Defined (1)

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

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