PageRenderTime 110ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/GoogleApiAdsAdWords/v201101/_Ads---AdWords---v201101---InfoService.php.html

http://google-api-adwords-php.googlecode.com/
HTML | 457 lines | 396 code | 58 blank | 3 comment | 0 complexity | 958c93edb9710c1922bbc80eb48fddb6 MD5 | raw file
Possible License(s): Apache-2.0, MIT 
    

  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos -->
    6. 

  6. 			<title>Docs for page InfoService.php</title>
    7. 

  7. 			<link rel="stylesheet" href="../../media/stylesheet.css" />
    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9. 

  9. 		</head>
    10. 

  10. 		<body>
    11. 

  11. 			<div class="page-body">			
    12. 

  12. <h2 class="file-name">/Ads/AdWords/v201101/InfoService.php</h2>
    13. 

  13. 

  14. <a name="sec-description"></a>
    15. 

  15. <div class="info-box">
    16. 

  16. 	<div class="info-box-title">Description</div>
    17. 

  17. 	<div class="nav-bar">
    18. 

  18. 					<span class="disabled">Description</span> |
    19. 

  19. 							<a href="#sec-classes">Classes</a>
    20. 

  20. 			|							<a href="#sec-includes">Includes</a>
    21. 

  21. 												</div>
    22. 

  22. 	<div class="info-box-body">	
    23. 

  23. 		<!-- ========== Info from phpDoc block ========= -->
    24. 

  24. <p class="short-description">Contains all client objects for the InfoService service.</p>
    25. 

  25. <p class="description"><p>PHP version 5</p><p>Copyright 2011, Google Inc. All Rights Reserved.</p><p>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);  you may not use this file except in compliance with the License.  You may obtain a copy of the License at</p><p>http://www.apache.org/licenses/LICENSE-2.0</p><p>Unless required by applicable law or agreed to in writing, software  distributed under the License is distributed on an &quot;AS IS&quot; BASIS,  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and  limitations under the License.</p></p>
    26. 

  26. 	<ul class="tags">
    27. 

  27. 				<li><span class="field">author:</span> Eric Koleda &lt;<a href="mailto:eric.koleda@google.com">eric.koleda@google.com</a>&gt;</li>
    28. 

  28. 				<li><span class="field">copyright:</span> 2011, Google Inc. All Rights Reserved.</li>
    29. 

  29. 				<li><span class="field">license:</span> <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License,
    30. 

  30.              Version 2.0</a></li>
    31. 

  31. 			</ul>
    32. 

  32. 		
    33. 

  33. 			</div>
    34. 

  34. </div>
    35. 

  35. 		
    36. 

  36. 	<a name="sec-classes"></a>	
    37. 

  37. 	<div class="info-box">
    38. 

  38. 		<div class="info-box-title">Classes</div>
    39. 

  39. 		<div class="nav-bar">
    40. 

  40. 			<a href="#sec-description">Description</a> |
    41. 

  41. 			<span class="disabled">Classes</span>
    42. 

  42. 			|							<a href="#sec-includes">Includes</a>
    43. 

  43. 																		</div>
    44. 

  44. 		<div class="info-box-body">	
    45. 

  45. 			<table cellpadding="2" cellspacing="0" class="class-table">
    46. 

  46. 				<tr>
    47. 

  47. 					<th class="class-table-header">Class</th>
    48. 

  48. 					<th class="class-table-header">Description</th>
    49. 

  49. 				</tr>
    50. 

  50. 								<tr>
    51. 

  51. 					<td style="padding-right: 2em; vertical-align: top">
    52. 

  52. 						
    53. 

  53. 					</td>
    54. 

  54. 					<td>
    55. 

  55. 											Represents a range of dates that has either an upper or a lower bound.
    56. 

  56. 										</td>
    57. 

  57. 				</tr>
    58. 

  58. 								<tr>
    59. 

  59. 					<td style="padding-right: 2em; vertical-align: top">
    60. 

  60. 						
    61. 

  61. 					</td>
    62. 

  62. 					<td>
    63. 

  63. 											Defines the required and optional elements within the header of a SOAP request.
    64. 

  64. 										</td>
    65. 

  65. 				</tr>
    66. 

  66. 								<tr>
    67. 

  67. 					<td style="padding-right: 2em; vertical-align: top">
    68. 

  68. 						
    69. 

  69. 					</td>
    70. 

  70. 					<td>
    71. 

  71. 											Defines the elements within the header of a SOAP response.
    72. 

  72. 										</td>
    73. 

  73. 				</tr>
    74. 

  74. 								<tr>
    75. 

  75. 					<td style="padding-right: 2em; vertical-align: top">
    76. 

  76. 						
    77. 

  77. 					</td>
    78. 

  78. 					<td>
    79. 

  79. 											The API error base class that provides details about an error that occurred while processing a service request.
    80. 

  80. 										</td>
    81. 

  81. 				</tr>
    82. 

  82. 								<tr>
    83. 

  83. 					<td style="padding-right: 2em; vertical-align: top">
    84. 

  84. 						
    85. 

  85. 					</td>
    86. 

  86. 					<td>
    87. 

  87. 											Base class for exceptions.
    88. 

  88. 										</td>
    89. 

  89. 				</tr>
    90. 

  90. 								<tr>
    91. 

  91. 					<td style="padding-right: 2em; vertical-align: top">
    92. 

  92. 						
    93. 

  93. 					</td>
    94. 

  94. 					<td>
    95. 

  95. 											The single reason for the authentication failure.
    96. 

  96. 										</td>
    97. 

  97. 				</tr>
    98. 

  98. 								<tr>
    99. 

  99. 					<td style="padding-right: 2em; vertical-align: top">
    100. 

  100. 						
    101. 

  101. 					</td>
    102. 

  102. 					<td>
    103. 

  103. 											The reasons for the database error.
    104. 

  104. 										</td>
    105. 

  105. 				</tr>
    106. 

  106. 								<tr>
    107. 

  107. 					<td style="padding-right: 2em; vertical-align: top">
    108. 

  108. 						
    109. 

  109. 					</td>
    110. 

  110. 					<td>
    111. 

  111. 											Enums for the various reasons an error can be thrown as a result of  ClientTerms violation.
    112. 

  112. 										</td>
    113. 

  113. 				</tr>
    114. 

  114. 								<tr>
    115. 

  115. 					<td style="padding-right: 2em; vertical-align: top">
    116. 

  116. 						
    117. 

  117. 					</td>
    118. 

  118. 					<td>
    119. 

  119. 											The specified id refered to an entity which either doesn't exist or is not accessible to the  customer. e.g. campaign belongs to another customer.
    120. 

  120. 										</td>
    121. 

  121. 				</tr>
    122. 

  122. 								<tr>
    123. 

  123. 					<td style="padding-right: 2em; vertical-align: top">
    124. 

  124. 						
    125. 

  125. 					</td>
    126. 

  126. 					<td>
    127. 

  127. 											The single reason for the internal API error.
    128. 

  128. 										</td>
    129. 

  129. 				</tr>
    130. 

  130. 								<tr>
    131. 

  131. 					<td style="padding-right: 2em; vertical-align: top">
    132. 

  132. 						
    133. 

  133. 					</td>
    134. 

  134. 					<td>
    135. 

  135. 											The reasons for the validation error.
    136. 

  136. 										</td>
    137. 

  137. 				</tr>
    138. 

  138. 								<tr>
    139. 

  139. 					<td style="padding-right: 2em; vertical-align: top">
    140. 

  140. 						
    141. 

  141. 					</td>
    142. 

  142. 					<td>
    143. 

  143. 											The single reason for the whitelist error.
    144. 

  144. 										</td>
    145. 

  145. 				</tr>
    146. 

  146. 								<tr>
    147. 

  147. 					<td style="padding-right: 2em; vertical-align: top">
    148. 

  148. 						
    149. 

  149. 					</td>
    150. 

  150. 					<td>
    151. 

  151. 											The reasons for the validation error.
    152. 

  152. 										</td>
    153. 

  153. 				</tr>
    154. 

  154. 								<tr>
    155. 

  155. 					<td style="padding-right: 2em; vertical-align: top">
    156. 

  156. 						
    157. 

  157. 					</td>
    158. 

  158. 					<td>
    159. 

  159. 											This represents an operator that may be presented to an adsapi service.
    160. 

  160. 										</td>
    161. 

  161. 				</tr>
    162. 

  162. 								<tr>
    163. 

  163. 					<td style="padding-right: 2em; vertical-align: top">
    164. 

  164. 						
    165. 

  165. 					</td>
    166. 

  166. 					<td>
    167. 

  167. 											The reasons for the validation error.
    168. 

  168. 										</td>
    169. 

  169. 				</tr>
    170. 

  170. 								<tr>
    171. 

  171. 					<td style="padding-right: 2em; vertical-align: top">
    172. 

  172. 						
    173. 

  173. 					</td>
    174. 

  174. 					<td>
    175. 

  175. 											Enums for all the reasons an error can be thrown to the user during  billing quota checks.
    176. 

  176. 										</td>
    177. 

  177. 				</tr>
    178. 

  178. 								<tr>
    179. 

  179. 					<td style="padding-right: 2em; vertical-align: top">
    180. 

  180. 						
    181. 

  181. 					</td>
    182. 

  182. 					<td>
    183. 

  183. 											The reason for the rate exceeded error.
    184. 

  184. 										</td>
    185. 

  185. 				</tr>
    186. 

  186. 								<tr>
    187. 

  187. 					<td style="padding-right: 2em; vertical-align: top">
    188. 

  188. 						
    189. 

  189. 					</td>
    190. 

  190. 					<td>
    191. 

  191. 											The reasons for the target error.
    192. 

  192. 										</td>
    193. 

  193. 				</tr>
    194. 

  194. 								<tr>
    195. 

  195. 					<td style="padding-right: 2em; vertical-align: top">
    196. 

  196. 						
    197. 

  197. 					</td>
    198. 

  198. 					<td>
    199. 

  199. 											Error reason is unknown.
    200. 

  200. 										</td>
    201. 

  201. 				</tr>
    202. 

  202. 								<tr>
    203. 

  203. 					<td style="padding-right: 2em; vertical-align: top">
    204. 

  204. 						
    205. 

  205. 					</td>
    206. 

  206. 					<td>
    207. 

  207. 											The reasons for the target error.
    208. 

  208. 										</td>
    209. 

  209. 				</tr>
    210. 

  210. 								<tr>
    211. 

  211. 					<td style="padding-right: 2em; vertical-align: top">
    212. 

  212. 						
    213. 

  213. 					</td>
    214. 

  214. 					<td>
    215. 

  215. 											The reasons for Ad Scheduling errors.
    216. 

  216. 										</td>
    217. 

  217. 				</tr>
    218. 

  218. 								<tr>
    219. 

  219. 					<td style="padding-right: 2em; vertical-align: top">
    220. 

  220. 						
    221. 

  221. 					</td>
    222. 

  222. 					<td>
    223. 

  223. 											Represents possible error codes in InfoService.
    224. 

  224. 										</td>
    225. 

  225. 				</tr>
    226. 

  226. 								<tr>
    227. 

  227. 					<td style="padding-right: 2em; vertical-align: top">
    228. 

  228. 						
    229. 

  229. 					</td>
    230. 

  230. 					<td>
    231. 

  231. 											Data record for per client API units.
    232. 

  232. 										</td>
    233. 

  233. 				</tr>
    234. 

  234. 								<tr>
    235. 

  235. 					<td style="padding-right: 2em; vertical-align: top">
    236. 

  236. 						
    237. 

  237. 					</td>
    238. 

  238. 					<td>
    239. 

  239. 											Specifies the type of API usage information to be returned. API usage information returned is based on the #apiUsageType specified. All returned values are specific to the developer token being used to call <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../GoogleApiAdsAdWords/v201008/InfoService.html">InfoService</a></span>.<span class="src-id">get</span></div></li>
    240. 

  240. </ol></div>.
    241. 

  241. 										</td>
    242. 

  242. 				</tr>
    243. 

  243. 								<tr>
    244. 

  244. 					<td style="padding-right: 2em; vertical-align: top">
    245. 

  245. 						
    246. 

  246. 					</td>
    247. 

  247. 					<td>
    248. 

  248. 											Represents the API usage information.
    249. 

  249. 										</td>
    250. 

  250. 				</tr>
    251. 

  251. 								<tr>
    252. 

  252. 					<td style="padding-right: 2em; vertical-align: top">
    253. 

  253. 						
    254. 

  254. 					</td>
    255. 

  255. 					<td>
    256. 

  256. 											Enum used to represent the errors
    257. 

  257. 										</td>
    258. 

  258. 				</tr>
    259. 

  259. 								<tr>
    260. 

  260. 					<td style="padding-right: 2em; vertical-align: top">
    261. 

  261. 						
    262. 

  262. 					</td>
    263. 

  263. 					<td>
    264. 

  264. 											Enum to represent the type of API usage.
    265. 

  265. 										</td>
    266. 

  266. 				</tr>
    267. 

  267. 								<tr>
    268. 

  268. 					<td style="padding-right: 2em; vertical-align: top">
    269. 

  269. 						
    270. 

  270. 					</td>
    271. 

  271. 					<td>
    272. 

  272. 											&lt;span class=&quot;constraint Required&quot;&gt;This field is required and should not be {@code null}.&lt;/span&gt;
    273. 

  273. 										</td>
    274. 

  274. 				</tr>
    275. 

  275. 								<tr>
    276. 

  276. 					<td style="padding-right: 2em; vertical-align: top">
    277. 

  277. 						
    278. 

  278. 					</td>
    279. 

  279. 					<td>
    280. 

  280. 											
    281. 

  281. 										</td>
    282. 

  282. 				</tr>
    283. 

  283. 								<tr>
    284. 

  284. 					<td style="padding-right: 2em; vertical-align: top">
    285. 

  285. 						
    286. 

  286. 					</td>
    287. 

  287. 					<td>
    288. 

  288. 											Errors returned when Authentication failed.
    289. 

  289. 										</td>
    290. 

  290. 				</tr>
    291. 

  291. 								<tr>
    292. 

  292. 					<td style="padding-right: 2em; vertical-align: top">
    293. 

  293. 						
    294. 

  294. 					</td>
    295. 

  295. 					<td>
    296. 

  296. 											Errors that are thrown due to an authorization problem.
    297. 

  297. 										</td>
    298. 

  298. 				</tr>
    299. 

  299. 								<tr>
    300. 

  300. 					<td style="padding-right: 2em; vertical-align: top">
    301. 

  301. 						
    302. 

  302. 					</td>
    303. 

  303. 					<td>
    304. 

  304. 											Encapsulates the errors thrown during client terms checks for adwords.
    305. 

  305. 										</td>
    306. 

  306. 				</tr>
    307. 

  307. 								<tr>
    308. 

  308. 					<td style="padding-right: 2em; vertical-align: top">
    309. 

  309. 						
    310. 

  310. 					</td>
    311. 

  311. 					<td>
    312. 

  312. 											An id did not correspond to an entity, or it referred to an entity which does not belong to the  customer.
    313. 

  313. 										</td>
    314. 

  314. 				</tr>
    315. 

  315. 								<tr>
    316. 

  316. 					<td style="padding-right: 2em; vertical-align: top">
    317. 

  317. 						
    318. 

  318. 					</td>
    319. 

  319. 					<td>
    320. 

  320. 											Indicates that a server-side error has occured. {@code InternalApiError}s  are generally not the result of an invalid request or message sent by the  client.
    321. 

  321. 										</td>
    322. 

  322. 				</tr>
    323. 

  323. 								<tr>
    324. 

  324. 					<td style="padding-right: 2em; vertical-align: top">
    325. 

  325. 						
    326. 

  326. 					</td>
    327. 

  327. 					<td>
    328. 

  328. 											A list of all errors associated with the @NotEmpty constraints.
    329. 

  329. 										</td>
    330. 

  330. 				</tr>
    331. 

  331. 								<tr>
    332. 

  332. 					<td style="padding-right: 2em; vertical-align: top">
    333. 

  333. 						
    334. 

  334. 					</td>
    335. 

  335. 					<td>
    336. 

  336. 											Indicates that the customer is not whitelisted for accessing the API.
    337. 

  337. 										</td>
    338. 

  338. 				</tr>
    339. 

  339. 								<tr>
    340. 

  340. 					<td style="padding-right: 2em; vertical-align: top">
    341. 

  341. 						
    342. 

  342. 					</td>
    343. 

  343. 					<td>
    344. 

  344. 											Errors associated with contents not null constraint.
    345. 

  345. 										</td>
    346. 

  346. 				</tr>
    347. 

  347. 								<tr>
    348. 

  348. 					<td style="padding-right: 2em; vertical-align: top">
    349. 

  349. 						
    350. 

  350. 					</td>
    351. 

  351. 					<td>
    352. 

  352. 											A list of all errors associated with the @SupportedOperators constraints.
    353. 

  353. 										</td>
    354. 

  354. 				</tr>
    355. 

  355. 								<tr>
    356. 

  356. 					<td style="padding-right: 2em; vertical-align: top">
    357. 

  357. 						
    358. 

  358. 					</td>
    359. 

  359. 					<td>
    360. 

  360. 											Encapsulates the errors thrown during developer quota checks.
    361. 

  361. 										</td>
    362. 

  362. 				</tr>
    363. 

  363. 								<tr>
    364. 

  364. 					<td style="padding-right: 2em; vertical-align: top">
    365. 

  365. 						
    366. 

  366. 					</td>
    367. 

  367. 					<td>
    368. 

  368. 											Signals that a call failed because a measured rate exceeded.
    369. 

  369. 										</td>
    370. 

  370. 				</tr>
    371. 

  371. 								<tr>
    372. 

  372. 					<td style="padding-right: 2em; vertical-align: top">
    373. 

  373. 						
    374. 

  374. 					</td>
    375. 

  375. 					<td>
    376. 

  376. 											A list of all errors associated with the @ReadOnly constraint.
    377. 

  377. 										</td>
    378. 

  378. 				</tr>
    379. 

  379. 								<tr>
    380. 

  380. 					<td style="padding-right: 2em; vertical-align: top">
    381. 

  381. 						
    382. 

  382. 					</td>
    383. 

  383. 					<td>
    384. 

  384. 											Encapsulates the generic errors thrown when there's an error with user  request.
    385. 

  385. 										</td>
    386. 

  386. 				</tr>
    387. 

  387. 								<tr>
    388. 

  388. 					<td style="padding-right: 2em; vertical-align: top">
    389. 

  389. 						
    390. 

  390. 					</td>
    391. 

  391. 					<td>
    392. 

  392. 											Errors due to missing required field.
    393. 

  393. 										</td>
    394. 

  394. 				</tr>
    395. 

  395. 								<tr>
    396. 

  396. 					<td style="padding-right: 2em; vertical-align: top">
    397. 

  397. 						
    398. 

  398. 					</td>
    399. 

  399. 					<td>
    400. 

  400. 											Indicates that the number of entries in the request or response exceeds the system limit.
    401. 

  401. 										</td>
    402. 

  402. 				</tr>
    403. 

  403. 								<tr>
    404. 

  404. 					<td style="padding-right: 2em; vertical-align: top">
    405. 

  405. 						
    406. 

  406. 					</td>
    407. 

  407. 					<td>
    408. 

  408. 											Exception class for holding a list of service errors.
    409. 

  409. 										</td>
    410. 

  410. 				</tr>
    411. 

  411. 								<tr>
    412. 

  412. 					<td style="padding-right: 2em; vertical-align: top">
    413. 

  413. 						
    414. 

  414. 					</td>
    415. 

  415. 					<td>
    416. 

  416. 											InfoService
    417. 

  417. 										</td>
    418. 

  418. 				</tr>
    419. 

  419. 							</table>
    420. 

  420. 		</div>
    421. 

  421. 	</div>
    422. 

  422. 

  423. 	<a name="sec-includes"></a>	
    424. 

  424. 	<div class="info-box">
    425. 

  425. 		<div class="info-box-title">Includes</div>
    426. 

  426. 		<div class="nav-bar">
    427. 

  427. 			<a href="#sec-description">Description</a> |
    428. 

  428. 							<a href="#sec-classes">Classes</a>
    429. 

  429. 				|						<span class="disabled">Includes</span>
    430. 

  430. 														</div>
    431. 

  431. 		<div class="info-box-body">	
    432. 

  432. 			<a name="_dirname(__FILE__)_/__/Lib/AdWordsSoapClient_php"><!-- --></a>
    433. 

  433. <div class="evenrow">
    434. 

  434. 	
    435. 

  435. 	<div>
    436. 

  436. 		<span class="include-title">
    437. 

  437. 			<span class="include-type">require_once</span>
    438. 

  438. 			(<span class="include-name">dirname(__FILE__)."/../Lib/AdWordsSoapClient.php"</span>)
    439. 

  439. 			(line <span class="line-number">31</span>)
    440. 

  440. 		</span>
    441. 

  441. 	</div>
    442. 

  442. 

  443. 	<!-- ========== Info from phpDoc block ========= -->
    444. 

  444. <p class="short-description">Required classes. *</p>
    445. 

  445. 	
    446. 

  446. </div>
    447. 

  447. 		</div>
    448. 

  448. 	</div>
    449. 

  449. 	
    450. 

  450. 	
    451. 

  451. 	
    452. 

  452. 	
    453. 

  453. 	<p class="notes" id="credit">
    454. 

  454. 		Documentation generated by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
    455. 

  455. 	</p>
    456. 

  456. 	</div></body>
    457. 

  457. </html>
    458.