com.opsmatters.bitly.api.services.v4

Class CampaignChannelService

java.lang.Object

com.opsmatters.bitly.api.services.BitlyService

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

com.opsmatters.bitly.api.services.v4.CampaignChannelService

public class CampaignChannelService
extends BitlyV4Service

The set of operations used for bitly campaign channels.

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
CampaignChannelService(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<CreateChannelResponse>	create(CreateChannelRequest request) Creates a campaign channel.
com.google.common.base.Optional<GetChannelResponse>	get(String channelGuid) Returns the attributes of the given campaign channel.
com.google.common.base.Optional<ListChannelsResponse>	list(String groupGuid, String campaignGuid) Returns the list of campaign channels for the given group and campaign.
com.google.common.base.Optional<UpdateChannelResponse>	update(String channelGuid, UpdateChannelRequest request) Updates the attributes of the given campaign channel.

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

CampaignChannelService

public CampaignChannelService(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<GetChannelResponse> get(String channelGuid)
                                                        throws IOException,
                                                               URISyntaxException

Returns the attributes of the given campaign channel.

Parameters:

channelGuid - The GUID of the channel to be retrieved

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<CreateChannelResponse> create(CreateChannelRequest request)
                                                              throws IOException

Creates a campaign channel.

Parameters:

request - The request containing the attributes of the campaign channel to be created

Returns:

The response object

Throws:

IOException - if there is a communication error.

update

public com.google.common.base.Optional<UpdateChannelResponse> update(String channelGuid,
                                                                     UpdateChannelRequest request)
                                                              throws IOException,
                                                                     URISyntaxException

Updates the attributes of the given campaign channel.

Parameters:

channelGuid - The GUID of the campaign channel to be updated

request - The request containing the attributes of the campaign channel 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.

list

public com.google.common.base.Optional<ListChannelsResponse> list(String groupGuid,
                                                                  String campaignGuid)
                                                           throws IOException,
                                                                  URISyntaxException

Returns the list of campaign channels for the given group and campaign.

Parameters:

groupGuid - The GUID of the group for the campaign channels

campaignGuid - The GUID of the campaign for the campaign channels

Returns:

The response object

Throws:

IOException - if there is a communication error.

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