com.google.api.services.analytics

Class AnalyticsRequestInitializer

java.lang.Object

com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer

com.google.api.services.analytics.AnalyticsRequestInitializer

All Implemented Interfaces:

GoogleClientRequestInitializer

public class AnalyticsRequestInitializer
extends CommonGoogleJsonClientRequestInitializer

Analytics request initializer for setting properties like key and userIp.

The simplest usage is to use it to set the key parameter:

  public static final GoogleClientRequestInitializer KEY_INITIALIZER =
      new AnalyticsRequestInitializer(KEY);
 

There is also a constructor to set both the key and userIp parameters:

  public static final GoogleClientRequestInitializer INITIALIZER =
      new AnalyticsRequestInitializer(KEY, USER_IP);
 

If you want to implement custom logic, extend it like this:

  public static class MyRequestInitializer extends AnalyticsRequestInitializer {

    @Override
    public void initializeAnalyticsRequest(AnalyticsRequest<?> request)
        throws IOException {
      // custom logic
    }
  }
 

Finally, to set the key and userIp parameters and insert custom logic, extend it like this:

  public static class MyRequestInitializer2 extends AnalyticsRequestInitializer {

    public MyKeyRequestInitializer() {
      super(KEY, USER_IP);
    }

    @Override
    public void initializeAnalyticsRequest(AnalyticsRequest<?> request)
        throws IOException {
      // custom logic
    }
  }
 

Subclasses should be thread-safe.

Since:

1.12

Constructor Summary

Constructors

Constructor and Description
AnalyticsRequestInitializer()
AnalyticsRequestInitializer(String key)
AnalyticsRequestInitializer(String key, String userIp)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	initializeAnalyticsRequest(AnalyticsRequest<?> request) Initializes Analytics request.
void	initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)

Methods inherited from class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer

initialize

Methods inherited from class com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

getKey, getUserIp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnalyticsRequestInitializer

public AnalyticsRequestInitializer()

AnalyticsRequestInitializer

public AnalyticsRequestInitializer(String key)

Parameters:

key - API key or null to leave it unchanged

AnalyticsRequestInitializer

public AnalyticsRequestInitializer(String key,
                           String userIp)

Parameters:

key - API key or null to leave it unchanged

userIp - user IP or null to leave it unchanged

Method Detail

initializeJsonRequest

public final void initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)
                                 throws IOException

Overrides:

initializeJsonRequest in class CommonGoogleJsonClientRequestInitializer

Throws:

IOException

initializeAnalyticsRequest

protected void initializeAnalyticsRequest(AnalyticsRequest<?> request)
                                   throws IOException

Initializes Analytics request.

Default implementation does nothing. Called from initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest).

Throws:

IOException - I/O exception