Class AdWordError

Description
Description | Methods (details)

AdWords Lib Error Class

  • copyright: Mirchev Ideas Ltd. © 2003, 2004, 2005

Located in /util/AdWordError.inc 


	
			






	
	

		
Method Summary

		

			Description |
									Methods (details)
		

		
			
			

								
				

					 
											mixed
										get
											(string $errorPart)
									

								
				

					 
											AdWordApiException
										getApiException
										()
									

								
				

					 
											array
										getError
										()
									

								
				

					 
											string
										toString
										()
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
													Methods (details)
						
		

		

			



	
	

		
			
 
	
	

Returns a specific part of the error


If you don't need all error fields, you can take just the part you want.  All errors have 3 fields:  
  • 'code' - the code of the error. All errors that were handled by
 PHP AdWords API Lib have negative codes. Errors with positive
 codes are errors returned by Google AdWords Service.
  • 'string' - a short text that explains error
  • 'detail' - an array which holds more information about the error
Example:  
  1.  <?php
    2. 

  2.  $creativeService = new AdWordCreativeService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $creativeService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //activateCreativeList() function expect arrays as input parameters
    5. 

  5.  //but we pass to it two strings, so responce will be false
    6. 

  6.  $response = $creativeService->activateCreativeList('', '');
    7. 

  7.  if ($response === false) {
    8. 

  8.          $error = $classKW->getLastError(); //get error object
    9. 

  9.          $errorCode = $error->get('code');
    10. 

  10.          echo $errorCode;
    11. 

  11.          exit();
    12. 

  12.  }
    13. 

  13.  //output is :
    14. 

  14.  //-2
    15. 

  15.  ?>
    16. 


	
	
	

		mixed
		
			get
		
					(string $errorPart)
			

	
			
    
					
  • 
				string
				$errorPart: the part of the error to be returned - 'code', 'string' or 'detail'			
    • 
				

		
		
	




	
	

		
			
 
	
	

Returns an AdWordApiException object

	
	
	

		AdWordApiException
		
			getApiException
		
				()
			

	
		
		
	




	
	

		
			
 
	
	

Returns an array that holds the error.


All errors have 3 fields:  
  • 'code' - the code of the error. All errors that were handled by
 PHP AdWords API Lib have negative codes. Errors with positive
 codes are errors returned by Google AdWords Service.
  • 'string' - a short text that explains error
  • 'detail' - an array which holds more information about the error
Example:  
  1.  <?php
    2. 

  2.  $creativeService = new AdWordCreativeService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $creativeService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //activateCreativeList() function expect arrays as input parameters
    5. 

  5.  //but we pass to it two strings, so responce will be false
    6. 

  6.  $response = $creativeService->activateCreativeList('', '');
    7. 

  7.  if ($response === false) {
    8. 

  8.          $error = $classKW->getLastError(); //get error object
    9. 

  9.          $errorArray = $error->getError();
    10. 

  10.          echo $errorArray['code'];
    11. 

  11.          echo '<br>';
    12. 

  12.          echo $errorArray['string'];
    13. 

  13.          exit();
    14. 

  14.  }
    15. 

  15.  //output is :
    16. 

  16.  //-2
    17. 

  17.  //Invalid input parameter. Array expected
    18. 

  18.  ?>
    19. 


	
	
	

		array
		
			getError
		
				()
			

	
		
		
	




	
	

		
			
 
	
	

Returns all parts of the error as a string


Example:  
  1.  <?php
    2. 

  2.  $creativeService = new AdWordCreativeService(ADWORD_SOAP_TOOLKIT_NUSOAP);
    3. 

  3.  $creativeService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
    4. 

  4.  //activateCreativeList() function expect arrays as input parameters
    5. 

  5.  //but we pass to it two strings, so responce will be false
    6. 

  6.  $response = $creativeService->activateCreativeList('', '');
    7. 

  7.  if ($response === false) {
    8. 

  8.          $error = $classKW->getLastError(); //get error object
    9. 

  9.          echo $error->toString();
    10. 

  10.          exit();
    11. 

  11.  }
    12. 

  12.  ?>
    13. 


	
	
	

		string
		
			toString
		
				()
			

	
		
		
	

						
		

	

	
	

		Documentation generated on Mon, 10 Sep 2007 15:07:20 +0300 by phpDocumentor 1.3.2