public interface TwitterAdsLineItemApi
| 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) |
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
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.TwitterExceptionBaseAdsResponse<LineItem> getLineItemById(java.lang.String accountId, java.lang.String lineItemId, boolean withDeleted) throws TwitterException
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.TwitterExceptionBaseAdsResponse<LineItem> createLineItem(java.lang.String accountId, LineItem lineItem) throws TwitterException
lineItem - A LineItem object representing the line item to be created.TwitterExceptionBaseAdsResponse<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
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 setincludeSentiment - (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).TwitterExceptionBaseAdsResponse<LineItem> deleteLineItem(java.lang.String accountId, java.lang.String lineItemId) throws TwitterException
accountId - The identifier for the leveraged account.lineItemId - The line item identifier of the line item to delete.TwitterExceptionBaseAdsResponse<PromotedAccount> createPromotedAccounts(java.lang.String accountId, java.lang.String lineItemId, java.lang.String userId) throws TwitterException
accountId - The identifier for the leveraged account.lineItemId - Scope the response to just the desired line itemuserId - Id of the user of the account to be promotedTwitterException@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
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.TwitterExceptionBaseAdsListResponseIterable<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
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.TwitterExceptionBaseAdsResponse<TwitterMediaCallToAction> createCallToActionDetails(java.lang.String accountId, java.lang.String lineItemId, TwitterCallToActionType twitterCallToActionType, java.lang.String callToActionUrl) throws TwitterException
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.TwitterExceptionBaseAdsResponse<AssociateMediaCreativeResponse> associateMediaCreativeWithAccount(java.lang.String accountId, java.lang.String lineItemId, java.lang.String accountMediaId, java.lang.String landingUrl) throws TwitterException
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.TwitterExceptionBaseAdsResponse<TwitterMediaCallToAction> updateCallToAction(java.lang.String accountId, java.lang.String channelId, java.lang.String callToActionUrl, TwitterCallToActionType twitterCallToActionType) throws TwitterException
TwitterExceptionBaseAdsResponse<TwitterMediaCallToAction> deleteCallToAction(java.lang.String accountId, java.lang.String channelId) throws TwitterException
TwitterExceptionBaseAdsResponse<LineItemAppResponse> publishApp(java.lang.String accountId, java.lang.String lineItemId, java.lang.String appStoreIdentifier, TwitterOSType twitterOSType) throws TwitterException
TwitterExceptionBaseAdsResponse<LineItemAppResponse> getForLineItemAppId(java.lang.String accountId, java.lang.String lineItemAppId) throws TwitterException
TwitterException@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
TwitterExceptionBaseAdsListResponseIterable<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
TwitterExceptionBaseAdsResponse<LineItemAppResponse> deleteLineItemApp(java.lang.String accountId, java.lang.String lineItemAppId) throws TwitterException
TwitterException