com.brsanthu.googleanalytics.ExceptionHit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-analytics-java Show documentation

This is Java API for Google Analytics (Measurement Protocol). More information about the protocol is available at https://developers.google.com/analytics/devguides/collection/protocol/v1/.

There is a newer version: 2.0.0

Show newest version

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" 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.
 */
package com.brsanthu.googleanalytics;

import static com.brsanthu.googleanalytics.GoogleAnalyticsParameter.EXCEPTION_DESCRIPTION;
import static com.brsanthu.googleanalytics.GoogleAnalyticsParameter.EXCEPTION_FATAL;

/**
 * GA request to track exceptions.
 *
 * For more information, see GA Parameters Reference
 *
 * @author Santhosh Kumar
 */
public class ExceptionHit extends GoogleAnalyticsRequest {

	public ExceptionHit() {
		this(null);
	}

	public ExceptionHit(String exceptionDescription) {
		this(exceptionDescription, false);
	}

	public ExceptionHit(String exceptionDescription, Boolean fatal) {
		super("exception");
		exceptionDescription(exceptionDescription);
		exceptionFatal(fatal);
	}

	/**
	 * 
	 * 	
	 * 		Optional.
	 * 	
	 * 	Specifies the description of an exception.
	 * 	
	 * 		
	 * 			
	 * 				
	 * 				
	 * 				
	 * 				
	 * 				
	 * 			
	 * 			
	 * 				
	 * 				
	 * 				
	 * 				
	 * 				
	 * 			
	 * 		
	 * 	Parameter Value Type Default Value Max Length Supported Hit Types
exd text None
	 * 				 150 Bytes
	 * 				 exception
	 * 	
	 * 		Example value: DatabaseError

	 * 		Example usage: exd=DatabaseError
	 * 	
	 * 
	 */
	public ExceptionHit exceptionDescription(String value) {
		setString(EXCEPTION_DESCRIPTION, value);
	   	return this;
	}
	public String exceptionDescription() {
		return getString(EXCEPTION_DESCRIPTION);
	}

	/**
	 * 
	 * 	
	 * 		Optional.
	 * 	
	 * 	Specifies whether the exception was fatal.
	 * 	
	 * 		
	 * 			
	 * 				
	 * 				
	 * 				
	 * 				
	 * 				
	 * 			
	 * 			
	 * 				
	 * 				
	 * 				
	 * 				
	 * 				
	 * 			
	 * 		
	 * 	Parameter Value Type Default Value Max Length Supported Hit Types
exf boolean 1
	 * 				 None
	 * 				 exception
	 * 	
	 * 		Example value: 0

	 * 		Example usage: exf=0
	 * 	
	 * 
	 */
	public ExceptionHit exceptionFatal(Boolean value) {
		setBoolean(EXCEPTION_FATAL, value);
	   	return this;
	}
	public Boolean exceptionFatal() {
		return getBoolean(EXCEPTION_FATAL);
	}
}