twitter4jads.impl

Class TwitterAdsWebEventApiImpl

java.lang.Object

twitter4jads.impl.TwitterAdsWebEventApiImpl

All Implemented Interfaces:

TwitterAdsWebEventApi

public class TwitterAdsWebEventApiImpl
extends java.lang.Object
implements TwitterAdsWebEventApi

User: abhay Date: 4/7/16 Time: 12:16 PM

Constructor Summary

Constructors

Constructor and Description
TwitterAdsWebEventApiImpl(TwitterAdsClient twitterAdsClient)

Method Summary

Modifier and Type	Method and Description
BaseAdsResponse<WebEventTag>	createWebEventTag(java.lang.String accountId, java.lang.String name, java.lang.Integer clickWindow, java.lang.Integer viewThroughWindow, WebEventTagType type, boolean retargetingEnabled)
BaseAdsResponse<TwitterWebsiteTag>	createWebsiteTag(java.lang.String accountId, TwitterWebsiteTag.WebsiteTagType websiteTagType)
BaseAdsResponse<WebEventTag>	deleteWebEventTag(java.lang.String accountId, java.lang.String webEventTagId) Delete a specific web event tag associated to the current account.
BaseAdsListResponseIterable<WebEventTag>	getAllWebEventTags(java.lang.String accountId, boolean withDeleted, java.lang.Integer count, java.lang.String cursor)
BaseAdsListResponseIterable<TwitterWebsiteTag>	getAllWebsiteTags(java.lang.String accountId, boolean withDeleted, java.lang.Integer count, java.lang.String cursor)
BaseAdsResponse<WebEventTag>	getWebEventTag(java.lang.String accountId, boolean withDeleted, java.lang.String webEventTagId)
BaseAdsResponse<TwitterWebsiteTag>	getWebsiteTag(java.lang.String accountId, boolean withDeleted, java.lang.String websiteTagId)
BaseAdsResponse<WebEventTag>	updateWebEventTag(java.lang.String accountId, java.lang.String webEventTagId, java.lang.String name, java.lang.Integer clickWindow, java.lang.Integer viewThroughWindow, WebEventTagType type, boolean retargetingEnabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

TwitterAdsWebEventApiImpl

public TwitterAdsWebEventApiImpl(TwitterAdsClient twitterAdsClient)

Method Detail

getAllWebEventTags

public BaseAdsListResponseIterable<WebEventTag> getAllWebEventTags(java.lang.String accountId,
                                                                   boolean withDeleted,
                                                                   java.lang.Integer count,
                                                                   java.lang.String cursor)
                                                            throws TwitterException

Specified by:

getAllWebEventTags in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

withDeleted - Include deleted results in your request. Defaults to false.

count - (optional) Specifies the number of web event tags to retrieve, up to a maximum of 1000 per distinct request.

cursor - (optional) Specify a cursor to retrieve data from a specific page (function automatically handles paging upon iteration when you do not specify cursor value).

Returns:

Web Event Tags for the account

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/web_event_tags

getWebEventTag

public BaseAdsResponse<WebEventTag> getWebEventTag(java.lang.String accountId,
                                                   boolean withDeleted,
                                                   java.lang.String webEventTagId)
                                            throws TwitterException

Specified by:

getWebEventTag in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

withDeleted - Include deleted results in your request. Defaults to false.

webEventTagId - The identifier for the web event tag to retrieve

Returns:

Queried web event tag

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/web_event_tags/%3Aid

createWebEventTag

public BaseAdsResponse<WebEventTag> createWebEventTag(java.lang.String accountId,
                                                      java.lang.String name,
                                                      java.lang.Integer clickWindow,
                                                      java.lang.Integer viewThroughWindow,
                                                      WebEventTagType type,
                                                      boolean retargetingEnabled)
                                               throws TwitterException

Specified by:

createWebEventTag in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

name - The name of the web tag

clickWindow - The click window for this web tag. Possible values are 1, 7, 14, 30, 60 or 90.

viewThroughWindow - The view through window for this web tag. This value must always be less than or equal to the click_window value. Possible values are 0, 1, 7, 14, 30, 60 or 90.

type - The type of web tag.

retargetingEnabled - Boolean indicating if retargeting should be enabled for this web tag. Possible values are true, 1, false, 0

Returns:

created Event Tag

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/post/accounts/%3Aaccount_id/web_event_tags

updateWebEventTag

public BaseAdsResponse<WebEventTag> updateWebEventTag(java.lang.String accountId,
                                                      java.lang.String webEventTagId,
                                                      java.lang.String name,
                                                      java.lang.Integer clickWindow,
                                                      java.lang.Integer viewThroughWindow,
                                                      WebEventTagType type,
                                                      boolean retargetingEnabled)
                                               throws TwitterException

Specified by:

updateWebEventTag in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

webEventTagId - The identifier for a web tag on the current account

name - The name of the web tag

clickWindow - The click window for this web tag. Possible values are 1, 7, 14, 30, 60 or 90

viewThroughWindow - The view through window for this web tag. This value must always be less than or equal to the click_window value. Possible values are 0, 1, 7, 14, 30, 60 or 90.

type - The type of web tag

retargetingEnabled - Boolean indicating if retargeting should be enabled for this web tag. Possible values are true, 1, false, 0

Returns:

Updated Event Tag

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/put/accounts/%3Aaccount_id/web_event_tags/%3Aid

deleteWebEventTag

public BaseAdsResponse<WebEventTag> deleteWebEventTag(java.lang.String accountId,
                                                      java.lang.String webEventTagId)
                                               throws TwitterException

Description copied from interface: TwitterAdsWebEventApi

Delete a specific web event tag associated to the current account.

Specified by:

deleteWebEventTag in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

webEventTagId - The identifier for the web event tag

Returns:

Deleted Tag

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/delete/accounts/%3Aaccount_id/web_event_tags/%3Aid

getAllWebsiteTags

public BaseAdsListResponseIterable<TwitterWebsiteTag> getAllWebsiteTags(java.lang.String accountId,
                                                                        boolean withDeleted,
                                                                        java.lang.Integer count,
                                                                        java.lang.String cursor)
                                                                 throws TwitterException

Specified by:

getAllWebsiteTags in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

withDeleted - Include deleted results in your request. Defaults to false.

count - Specifies the number of web event tags to retrieve, up to a maximum of 200 per distinct request.

Returns:

Website Tags for the account

Throws:

TwitterException

getWebsiteTag

public BaseAdsResponse<TwitterWebsiteTag> getWebsiteTag(java.lang.String accountId,
                                                        boolean withDeleted,
                                                        java.lang.String websiteTagId)
                                                 throws TwitterException

Specified by:

getWebsiteTag in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

withDeleted - Include deleted results in your request. Defaults to false.

websiteTagId - The identifier for the website tag to retrieve

Returns:

Queried web event tag

Throws:

TwitterException

createWebsiteTag

public BaseAdsResponse<TwitterWebsiteTag> createWebsiteTag(java.lang.String accountId,
                                                           TwitterWebsiteTag.WebsiteTagType websiteTagType)
                                                    throws TwitterException

Specified by:

createWebsiteTag in interface TwitterAdsWebEventApi

Parameters:

accountId - The identifier for the leveraged account. (required)

websiteTagType - The type of website tag.

Returns:

created Website Tag

Throws:

TwitterException