twitter4jads.api

Interface TwitterAdsLineItemApi

All Known Implementing Classes:

TwitterAdsLineItemApiImpl

public interface TwitterAdsLineItemApi

User: abhay Date: 4/4/16 Time: 8:00 PM

Method Summary

Modifier and Type	Method and Description
BaseAdsResponse<AssociateMediaCreativeResponse>	associateMediaCreativeWithAccount(java.lang.String accountId, java.lang.String lineItemId, java.lang.String accountMediaId, java.lang.String landingUrl)
BaseAdsResponse<TwitterMediaCallToAction>	createCallToActionDetails(java.lang.String accountId, java.lang.String lineItemId, TwitterCallToActionType twitterCallToActionType, java.lang.String callToActionUrl)
BaseAdsResponse<LineItem>	createLineItem(java.lang.String accountId, LineItem lineItem)
BaseAdsResponse<PromotedAccount>	createPromotedAccounts(java.lang.String accountId, java.lang.String lineItemId, java.lang.String userId)
BaseAdsResponse<TwitterMediaCallToAction>	deleteCallToAction(java.lang.String accountId, java.lang.String channelId)
BaseAdsResponse<LineItem>	deleteLineItem(java.lang.String accountId, java.lang.String lineItemId)
BaseAdsResponse<LineItemAppResponse>	deleteLineItemApp(java.lang.String accountId, java.lang.String lineItemAppId)
BaseAdsListResponseIterable<LineItem>	getAllLineItems(java.lang.String accountId, java.util.Optional<java.util.Collection<java.lang.String>> campaignIds, java.util.Optional<java.util.Collection<java.lang.String>> lineItemIds, java.util.Optional<java.util.Collection<java.lang.String>> fundingInstrumentIds, java.util.Optional<java.lang.Integer> count, boolean withDeleted, java.lang.String cursor, java.util.Optional<LineItemsSortByField> sortByField)
BaseAdsResponse<LineItemAppResponse>	getForLineItemAppId(java.lang.String accountId, java.lang.String lineItemAppId)
BaseAdsListResponseIterable<LineItemAppResponse>	getForLineItemAppIds(java.lang.String accountId, java.util.Collection<java.lang.String> lineItemIds, java.util.List<java.lang.String> lineItemAppIds, java.lang.Integer count, java.lang.String cursor, boolean withDeleted)
BaseAdsListResponseIterable<LineItemAppResponse>	getForLineItemAppIds(java.lang.String accountId, java.lang.String lineItemId, java.util.List<java.lang.String> lineItemAppIds, java.lang.Integer count, java.lang.String cursor, boolean withDeleted) Deprecated.
BaseAdsResponse<LineItem>	getLineItemById(java.lang.String accountId, java.lang.String lineItemId, boolean withDeleted)
BaseAdsListResponseIterable<PromotedAccount>	getPromotedAccounts(java.lang.String accountId, java.util.Optional<java.util.Collection<java.lang.String>> promotedAccountIds, java.util.Optional<java.util.Collection<java.lang.String>> lineItemIds, boolean withDeleted, PromotedAccountsSortByField sortByField)
BaseAdsListResponseIterable<PromotedAccount>	getPromotedAccounts(java.lang.String accountId, java.util.Optional<java.util.Collection<java.lang.String>> promotedAccountIds, java.lang.String lineItemId, boolean withDeleted, PromotedAccountsSortByField sortByField) Deprecated.
BaseAdsResponse<LineItemAppResponse>	publishApp(java.lang.String accountId, java.lang.String lineItemId, java.lang.String appStoreIdentifier, TwitterOSType twitterOSType)
BaseAdsResponse<TwitterMediaCallToAction>	updateCallToAction(java.lang.String accountId, java.lang.String channelId, java.lang.String callToActionUrl, TwitterCallToActionType twitterCallToActionType)
BaseAdsResponse<LineItem>	updateLineItem(java.lang.String accountId, java.lang.String lineItemId, BidType bidType, boolean automaticallySelectBid, java.util.Optional<java.lang.Long> bidAmountLocalMicro, EntityStatus status, java.util.Optional<Sentiments> includeSentiment, java.util.Optional<java.lang.Boolean> matchRelevantPopularQueries, java.util.Optional<java.lang.String> chargeBy, java.util.Optional<java.lang.String> bidUnit, java.util.Optional<java.lang.String> advertiserDomain, java.lang.String optimization, java.lang.String[] iabCategories, java.lang.String startTime, java.lang.String endTime, java.lang.String name, java.lang.Long targetCPA, java.lang.Long budget, java.lang.String trackingTags)

Method Detail

getAllLineItems

BaseAdsListResponseIterable<LineItem> getAllLineItems(java.lang.String accountId,
                                                      java.util.Optional<java.util.Collection<java.lang.String>> campaignIds,
                                                      java.util.Optional<java.util.Collection<java.lang.String>> lineItemIds,
                                                      java.util.Optional<java.util.Collection<java.lang.String>> fundingInstrumentIds,
                                                      java.util.Optional<java.lang.Integer> count,
                                                      boolean withDeleted,
                                                      java.lang.String cursor,
                                                      java.util.Optional<LineItemsSortByField> sortByField)
                                               throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

campaignIds - (optional) Scope the response to just the desired campaigns by specifying a Collection of identifiers. Up to 50 ids may be provided.

lineItemIds - (optional) Scope the response to just the desired line items by specifying a Collection of identifiers. Up to 50 ids may be provided.

fundingInstrumentIds - (optional) Scope the response to just the desired funding instruments by specifying a Collection of identifiers. Up to 50 ids may be provided.

count - (optional) Specifies the number of campaigns to try and 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).

sortByField - (optional) Specify to return the line items according to the sorted parameter given.

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

Returns:

Retrieve the line items associated with a specific campaign belonging to the current account.

Throws:

TwitterException

See Also:

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

getLineItemById

BaseAdsResponse<LineItem> getLineItemById(java.lang.String accountId,
                                          java.lang.String lineItemId,
                                          boolean withDeleted)
                                   throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - A reference to the line item you are operating with in the request.

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

Returns:

Retrieve a specific line item associated with a campaign belonging to the current account.

Throws:

TwitterException

See Also:

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

createLineItem

BaseAdsResponse<LineItem> createLineItem(java.lang.String accountId,
                                         LineItem lineItem)
                                  throws TwitterException

Parameters:

lineItem - A LineItem object representing the line item to be created.

Returns:

created line item

Throws:

TwitterException

See Also:

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

updateLineItem

BaseAdsResponse<LineItem> updateLineItem(java.lang.String accountId,
                                         java.lang.String lineItemId,
                                         BidType bidType,
                                         boolean automaticallySelectBid,
                                         java.util.Optional<java.lang.Long> bidAmountLocalMicro,
                                         EntityStatus status,
                                         java.util.Optional<Sentiments> includeSentiment,
                                         java.util.Optional<java.lang.Boolean> matchRelevantPopularQueries,
                                         java.util.Optional<java.lang.String> chargeBy,
                                         java.util.Optional<java.lang.String> bidUnit,
                                         java.util.Optional<java.lang.String> advertiserDomain,
                                         java.lang.String optimization,
                                         java.lang.String[] iabCategories,
                                         java.lang.String startTime,
                                         java.lang.String endTime,
                                         java.lang.String name,
                                         java.lang.Long targetCPA,
                                         java.lang.Long budget,
                                         java.lang.String trackingTags)
                                  throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - The line item identifier of the line item to update.

bidType - The BidType to use on this line item.

automaticallySelectBid - Whether to use auto bidding on this line item.

bidAmountLocalMicro - (optional) Specify a new bid to set on this line item.

status - Status to set

includeSentiment - (optional) Update the include sentiment parameter of line item.

chargeBy - (optional) Update the charge by parameter of line item.

bidUnit - (optional) Update the bid unit parameter of line item.

advertiserDomain - (optional) Update the advertiser domain of line item (for TAP campaigns).

iabCategories - (optional) Update the IAB categories associated with the line item (for TAP campaigns).

Returns:

updated line item

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/put/accounts/%3Aaccount_id/line_items/%3Aline_item_id

deleteLineItem

BaseAdsResponse<LineItem> deleteLineItem(java.lang.String accountId,
                                         java.lang.String lineItemId)
                                  throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - The line item identifier of the line item to delete.

Returns:

line item to be deleted with deleted field set to true

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/delete/accounts/%3Aaccount_id/line_items/%3Aline_item_id

createPromotedAccounts

BaseAdsResponse<PromotedAccount> createPromotedAccounts(java.lang.String accountId,
                                                        java.lang.String lineItemId,
                                                        java.lang.String userId)
                                                 throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - Scope the response to just the desired line item

userId - Id of the user of the account to be promoted

Returns:

created promoted account

Throws:

TwitterException

See Also:

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

getPromotedAccounts

@Deprecated
BaseAdsListResponseIterable<PromotedAccount> getPromotedAccounts(java.lang.String accountId,
                                                                             java.util.Optional<java.util.Collection<java.lang.String>> promotedAccountIds,
                                                                             java.lang.String lineItemId,
                                                                             boolean withDeleted,
                                                                             PromotedAccountsSortByField sortByField)
                                                                      throws TwitterException

Deprecated.

Parameters:

accountId - The identifier for the leveraged account.

promotedAccountIds - (optional) Scope the response to the Collection of promoted account IDs. These identifiers refer to a associated Promoted Account with a line item.

lineItemId - (optional) A reference to the line item you are operating with in the request. Omitting the lineItemIds will return all promoted tweets across all campaigns.

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

sortByField - Sorts by supported attribute in ascending or descending order.

Returns:

references to the Promoted Accounts associated with one or more line items

Throws:

TwitterException

See Also:

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

getPromotedAccounts

BaseAdsListResponseIterable<PromotedAccount> getPromotedAccounts(java.lang.String accountId,
                                                                 java.util.Optional<java.util.Collection<java.lang.String>> promotedAccountIds,
                                                                 java.util.Optional<java.util.Collection<java.lang.String>> lineItemIds,
                                                                 boolean withDeleted,
                                                                 PromotedAccountsSortByField sortByField)
                                                          throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

promotedAccountIds - (optional) Scope the response to the Collection of promoted account IDs. These identifiers refer to a associated Promoted Account with a line item.

lineItemIds - (optional) A reference to line items you are operating with in the request. Omitting the lineItemIds will return all promoted tweets across all campaigns.

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

sortByField - Sorts by supported attribute in ascending or descending order.

Returns:

references to the Promoted Accounts associated with one or more line items

Throws:

TwitterException

See Also:

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

createCallToActionDetails

BaseAdsResponse<TwitterMediaCallToAction> createCallToActionDetails(java.lang.String accountId,
                                                                    java.lang.String lineItemId,
                                                                    TwitterCallToActionType twitterCallToActionType,
                                                                    java.lang.String callToActionUrl)
                                                             throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - The line item identifier of the line item to create call to action details for.

twitterCallToActionType - The call to action type to be used with this pre-roll.

callToActionUrl - The call to action URL to be used with this pre-roll.

Returns:

the response of creating call to action details for pre roll views

Throws:

TwitterException

See Also:

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

associateMediaCreativeWithAccount

BaseAdsResponse<AssociateMediaCreativeResponse> associateMediaCreativeWithAccount(java.lang.String accountId,
                                                                                  java.lang.String lineItemId,
                                                                                  java.lang.String accountMediaId,
                                                                                  java.lang.String landingUrl)
                                                                           throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - The line item identifier of the line item to associate media with.

accountMediaId - The account media ID to associate.

landingUrl - The url of the media creative.

Returns:

response of associating media creative with account

Throws:

TwitterException

See Also:

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

updateCallToAction

BaseAdsResponse<TwitterMediaCallToAction> updateCallToAction(java.lang.String accountId,
                                                             java.lang.String channelId,
                                                             java.lang.String callToActionUrl,
                                                             TwitterCallToActionType twitterCallToActionType)
                                                      throws TwitterException

Throws:

TwitterException

deleteCallToAction

BaseAdsResponse<TwitterMediaCallToAction> deleteCallToAction(java.lang.String accountId,
                                                             java.lang.String channelId)
                                                      throws TwitterException

Throws:

TwitterException

publishApp

BaseAdsResponse<LineItemAppResponse> publishApp(java.lang.String accountId,
                                                java.lang.String lineItemId,
                                                java.lang.String appStoreIdentifier,
                                                TwitterOSType twitterOSType)
                                         throws TwitterException

Throws:

TwitterException

getForLineItemAppId

BaseAdsResponse<LineItemAppResponse> getForLineItemAppId(java.lang.String accountId,
                                                         java.lang.String lineItemAppId)
                                                  throws TwitterException

Throws:

TwitterException

getForLineItemAppIds

@Deprecated
BaseAdsListResponseIterable<LineItemAppResponse> getForLineItemAppIds(java.lang.String accountId,
                                                                                  java.lang.String lineItemId,
                                                                                  java.util.List<java.lang.String> lineItemAppIds,
                                                                                  java.lang.Integer count,
                                                                                  java.lang.String cursor,
                                                                                  boolean withDeleted)
                                                                           throws TwitterException

Deprecated.

Throws:

TwitterException

getForLineItemAppIds

BaseAdsListResponseIterable<LineItemAppResponse> getForLineItemAppIds(java.lang.String accountId,
                                                                      java.util.Collection<java.lang.String> lineItemIds,
                                                                      java.util.List<java.lang.String> lineItemAppIds,
                                                                      java.lang.Integer count,
                                                                      java.lang.String cursor,
                                                                      boolean withDeleted)
                                                               throws TwitterException

Throws:

TwitterException

deleteLineItemApp

BaseAdsResponse<LineItemAppResponse> deleteLineItemApp(java.lang.String accountId,
                                                       java.lang.String lineItemAppId)
                                                throws TwitterException

Throws:

TwitterException