com.opsmatters.bitly.api.services.v4

Class CustomBitlinkService

java.lang.Object

com.opsmatters.bitly.api.services.BitlyService

com.opsmatters.bitly.api.services.v4.BitlyV4Service

com.opsmatters.bitly.api.services.v4.CustomBitlinkService

public class CustomBitlinkService
extends BitlyV4Service

The set of operations used for custom bitlinks.

Author:

Gerald Curley (opsmatters)

Field Summary

Fields inherited from class com.opsmatters.bitly.api.services.v4.BitlyV4Service

CREATE_BITLINK, CREATE_CAMPAIGN, CREATE_CHANNEL, CREATE_CUSTOM_BITLINK, CREATE_WEBHOOK, EXPAND_BITLINK, GET_BITLINK, GET_BITLINK_CLICKS, GET_BITLINK_CLICKS_SUMMARY, GET_BITLINK_QR_CODE, GET_BITLINKS_BY_GROUP, GET_CAMPAIGN, GET_CHANNEL, GET_CUSTOM_BITLINK, GET_GROUP, GET_GROUP_PREFERENCES, GET_GROUP_TAGS, GET_METRICS_BY_COUNTRIES, GET_METRICS_BY_DESTINATION, GET_METRICS_BY_REFERRERS, GET_METRICS_BY_REFERRERS_BY_DOMAIN, GET_METRICS_BY_REFERRING_DOMAINS, GET_METRICS_BY_REFERRING_NETWORKS, GET_OAUTH_APP, GET_ORGANIZATION, GET_SHORTEN_COUNTS, GET_SORTED_BITLINKS_BY_GROUP, GET_USER, GET_WEBHOOK, LIST_BSDS, LIST_CAMPAIGNS, LIST_CHANNELS, LIST_GROUPS, LIST_ORGANIZATIONS, LIST_WEBHOOKS, UPDATE_BITLINK, UPDATE_CAMPAIGN, UPDATE_CHANNEL, UPDATE_CUSTOM_BITLINK, UPDATE_GROUP, UPDATE_GROUP_PREFERENCES, UPDATE_USER, UPDATE_WEBHOOK

Fields inherited from class com.opsmatters.bitly.api.services.BitlyService

HTTP

Constructor Summary

Constructors

Constructor and Description
CustomBitlinkService(String accessToken, HttpContext httpContext) Constructor that takes a http context and API client.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<CreateCustomBitlinkResponse>	create(CreateCustomBitlinkRequest request) Add a keyword to a bitlink.
com.google.common.base.Optional<GetCustomBitlinkResponse>	get(String customBitlink) Returns the details and history of a custom bitlink.
com.google.common.base.Optional<GetMetricsByDestinationResponse>	getMetricsByDestination(String customBitlink) Returns the clicks for the given custom bitlink by destination.
com.google.common.base.Optional<UpdateCustomBitlinkResponse>	update(String customBitlink, UpdateCustomBitlinkRequest request) Move a keyword to a different bitlink.

Methods inherited from class com.opsmatters.bitly.api.services.v4.BitlyV4Service

getQueryParameterList, getQueryParameterList

Methods inherited from class com.opsmatters.bitly.api.services.BitlyService

encode, getHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomBitlinkService

public CustomBitlinkService(String accessToken,
                            HttpContext httpContext)

Constructor that takes a http context and API client.

Parameters:

accessToken - The access token used to authenticate the operations

httpContext - The set of HTTP operations

Method Detail

get

public com.google.common.base.Optional<GetCustomBitlinkResponse> get(String customBitlink)
                                                              throws IOException,
                                                                     URISyntaxException

Returns the details and history of a custom bitlink.

Parameters:

customBitlink - The custom bitlink made of the domain and keyword

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

create

public com.google.common.base.Optional<CreateCustomBitlinkResponse> create(CreateCustomBitlinkRequest request)
                                                                    throws IOException

Add a keyword to a bitlink.

Parameters:

request - The request containing the bitlink and keyword to be added

Returns:

The response object

Throws:

IOException - if there is a communication error.

update

public com.google.common.base.Optional<UpdateCustomBitlinkResponse> update(String customBitlink,
                                                                           UpdateCustomBitlinkRequest request)
                                                                    throws IOException,
                                                                           URISyntaxException

Move a keyword to a different bitlink.

Parameters:

customBitlink - The custom bitlink made of the domain and keyword

request - The request containing the attributes of the bitlink to be updated

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getMetricsByDestination

public com.google.common.base.Optional<GetMetricsByDestinationResponse> getMetricsByDestination(String customBitlink)
                                                                                         throws IOException,
                                                                                                URISyntaxException

Returns the clicks for the given custom bitlink by destination.

Parameters:

customBitlink - The custom bitlink made of the domain and keyword

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.