twitter4jads.api

Interface TwitterAdsTargetingApi

All Known Implementing Classes:

TwitterAdsTargetingApiImpl

public interface TwitterAdsTargetingApi

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

Method Summary

Modifier and Type	Method and Description
BaseAdsResponse<TwitterApplicationList>	createNewApplicationList(java.lang.String accountId, TwitterApplicationList twitterApplicationList)
TargetingParamResponse	createTargetingBatchRequest(java.lang.String accountId, java.util.List<TargetingParamRequest> targetingParamRequests)
BaseAdsResponse<TargetingCriteria>	createTargetingCriteria(java.lang.String accountId, java.lang.String lineItemId, TargetingType targetingType, java.lang.String targetingValue, boolean tailoredAudienceExpansion, java.util.Optional<TailoredAudienceType> tailoredAudienceType)
java.util.List<TargetingCriteria>	createTargetingCriterias(java.lang.String accountId, java.lang.String lineItemId, java.util.List<TargetingCriteria> targetingCriteriaValues)
BaseAdsResponse<TargetingCriteria>	deleteTargetingCriteria(java.lang.String accountId, java.lang.String targetingCriteriaId)
BaseAdsListResponseIterable<IabCategory>	fetchIabCategories(java.lang.String q)
BaseAdsListResponseIterable<TwitterApplicationList>	getAllAppLists(java.lang.String accountId)
BaseAdsResponse<TwitterApplicationList>	getAllAppsListsById(java.lang.String accountId, java.lang.String listId)
BaseAdsListResponseIterable<TargetingCriteria>	getAllEvents()
BaseAdsListResponseIterable<IabCategory>	getAllIabCategories(java.lang.String q)
BaseAdsListResponseIterable<Conversations>	getAllTargetingConversations()
BaseAdsListResponseIterable<Devices>	getAllTargetingDevices(java.lang.String q)
BaseAdsListResponseIterable<TargetingCriteria>	getAllTargetingEvents(java.lang.String q)
BaseAdsListResponseIterable<TargetingCriteria>	getAllTargetingInterests(java.lang.String q)
BaseAdsListResponseIterable<TargetingCriteria>	getAllTargetingLocales(java.lang.String q)
BaseAdsListResponseIterable<TargetingLocation>	getAllTargetingLocations(java.util.Optional<LocationType> locationType, java.lang.String q, java.lang.String countryCode, java.util.Optional<java.lang.Integer> count)
BaseAdsListResponseIterable<TargetingCriteria>	getAllTargetingNetworkOperators(java.lang.String q)
BaseAdsListResponseIterable<TargetingCriteria>	getAllTargetingPlatforms(java.lang.String q)
BaseAdsListResponseIterable<PlatformVersions>	getAllTargetingPlatformVersions()
BaseAdsListResponseIterable<TargetingCriteria>	getAllTargetingTVChannels(java.lang.String tvMarketLocale, java.util.Optional<java.lang.Integer> count, java.util.Optional<java.lang.String> cursor)
BaseAdsListResponseIterable<TargetingCriteria>	getAllTargetingTVGenres()
BaseAdsListResponseIterable<TargetingCriteria>	getAllTVMarkets()
BaseAdsListResponseIterable<TargetingCriteria>	getAllTVShows(java.lang.String tvMarket, java.lang.String q, java.util.Optional<java.lang.Integer> count, java.util.Optional<java.lang.String> cursor)
BaseAdsListResponseIterable<TwitterBehavior>	getBehaviors(java.util.Optional<java.lang.Integer> count, java.util.Optional<java.lang.String> cursor, java.util.List<java.lang.String> behaviorIds, java.util.Optional<java.lang.String> countryCode)
BaseAdsListResponseIterable<TwitterBehaviorTaxonomy>	getBehaviorTaxonomy(java.util.List<java.lang.String> behaviorTaxonomyIds, java.util.List<java.lang.String> parentBehaviorTaxonomyIds, java.util.Optional<java.lang.Integer> count, java.util.Optional<java.lang.String> cursor)
BaseAdsResponse<NewTwitterReachEstimate>	getReachEstimate(java.lang.String accountId, ProductType productType, java.util.List<TargetingCriteria> targetingCriterias, java.lang.String objective, java.lang.Long bidAmountLocalMicro, java.lang.String currency, java.lang.Long campaignDailyBudgetAmountLocalMicro, java.lang.String bidType)
BaseAdsResponse<TargetingCriteria>	getTargetingCriteriaById(java.lang.String accountId, java.lang.String targetingId, boolean withDeleted)
BaseAdsListResponseIterable<TargetingCriteria>	getTargetingCriterias(java.lang.String accountId, java.util.Collection<java.lang.String> lineItemIds, boolean withDeleted, java.lang.Integer count, java.lang.String cursor, java.lang.String sortBy)
BaseAdsListResponseIterable<TargetingCriteria>	getTargetingCriterias(java.lang.String accountId, java.lang.String lineItemId, boolean withDeleted) Deprecated.
BaseAdsListResponseIterable<TargetingLocation>	getTargetingLocations(java.lang.String query, LocationType locationType)
java.util.List<TargetingSuggestion>	getTargetingSuggestion(java.lang.String accountId, SuggestionType suggestionType, java.util.List<java.lang.String> targetingValues, java.util.Optional<java.lang.Integer> count, java.util.List<java.lang.String> ignoredValues)
java.util.List<TwitterAppStore>	searchAppStoreCategories(java.lang.String q, java.util.Optional<AppStoreSearchType> appStoreSearchType)

Method Detail

getTargetingCriterias

@Deprecated
BaseAdsListResponseIterable<TargetingCriteria> getTargetingCriterias(java.lang.String accountId,
                                                                                 java.lang.String lineItemId,
                                                                                 boolean withDeleted)
                                                                          throws TwitterException

Deprecated.

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - Scope targeting criteria to a specific line item by providing its identifier.

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

Returns:

Retrieve details for some or all TargetingCriterias associated with the current account.

Throws:

TwitterException

See Also:

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

getTargetingCriterias

BaseAdsListResponseIterable<TargetingCriteria> getTargetingCriterias(java.lang.String accountId,
                                                                     java.util.Collection<java.lang.String> lineItemIds,
                                                                     boolean withDeleted,
                                                                     java.lang.Integer count,
                                                                     java.lang.String cursor,
                                                                     java.lang.String sortBy)
                                                              throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

accountId - The identifier for the leveraged account.

lineItemIds - Scope targeting criteria to specific line items by providing its identifier. Max size: 200

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

count - Specifies the number of records to try and retrieve per distinct request. Default: 200, Min: 1, Max: 1000

cursor - Specifies a cursor to get the next page of results.

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

Returns:

Retrieve details for some or all TargetingCriterias associated with the current account.

Throws:

TwitterException

getTargetingCriteriaById

BaseAdsResponse<TargetingCriteria> getTargetingCriteriaById(java.lang.String accountId,
                                                            java.lang.String targetingId,
                                                            boolean withDeleted)
                                                     throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

targetingId - A reference to the targeting criteria you are operating with in the request.

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

Returns:

Retrieve detailed information on a targeting criterion associated with a specific line item.

Throws:

TwitterException

See Also:

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

createTargetingCriteria

BaseAdsResponse<TargetingCriteria> createTargetingCriteria(java.lang.String accountId,
                                                           java.lang.String lineItemId,
                                                           TargetingType targetingType,
                                                           java.lang.String targetingValue,
                                                           boolean tailoredAudienceExpansion,
                                                           java.util.Optional<TailoredAudienceType> tailoredAudienceType)
                                                    throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - The line item ID to create targeting criteria upon.

targetingType - The type of targeting to be used with this targeting criteria.

targetingValue - The targeting value being set.

tailoredAudienceExpansion - (optional) Whether or not to expand tailored audiences.

tailoredAudienceType - (optional) The type of tailored audience being set.

Returns:

created targeting criteria

Throws:

TwitterException

See Also:

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

createTargetingCriterias

java.util.List<TargetingCriteria> createTargetingCriterias(java.lang.String accountId,
                                                           java.lang.String lineItemId,
                                                           java.util.List<TargetingCriteria> targetingCriteriaValues)
                                                    throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - The line item ID to create targeting criteria upon.

targetingCriteriaValues - A list of TargetingCriteria object to set multiple targeting criteria.

Returns:

created targeting criterias

Throws:

TwitterException

See Also:

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

deleteTargetingCriteria

BaseAdsResponse<TargetingCriteria> deleteTargetingCriteria(java.lang.String accountId,
                                                           java.lang.String targetingCriteriaId)
                                                    throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

targetingCriteriaId - The targeting criteria ID to delete.

Returns:

deleted targeting criteria with deleted field set to true

Throws:

TwitterException

See Also:

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

getAllTargetingLocations

BaseAdsListResponseIterable<TargetingLocation> getAllTargetingLocations(java.util.Optional<LocationType> locationType,
                                                                        java.lang.String q,
                                                                        java.lang.String countryCode,
                                                                        java.util.Optional<java.lang.Integer> count)
                                                                 throws TwitterException

Parameters:

locationType - (optional) Scope the results to a specific type of location.

q - (optional) Search for a specific location.

countryCode - (optional) Specify a country code to retrieve results from.

count - (optional) Limit the number of results to the given count.

Returns:

all possible targeting locations to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/locations

getTargetingLocations

BaseAdsListResponseIterable<TargetingLocation> getTargetingLocations(java.lang.String query,
                                                                     LocationType locationType)
                                                              throws TwitterException

Parameters:

locationType - (optional) Scope the results to a specific type of location.

query - (optional) Search for a specific location.

Returns:

all possible targeting locations to choose from for the given location type

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/locations

getAllTargetingLocales

BaseAdsListResponseIterable<TargetingCriteria> getAllTargetingLocales(java.lang.String q)
                                                               throws TwitterException

Parameters:

q - (optional) Search results for matching a specific locale.

Returns:

all possible twitter targeting languages to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/languages

getAllTargetingEvents

BaseAdsListResponseIterable<TargetingCriteria> getAllTargetingEvents(java.lang.String q)
                                                              throws TwitterException

Parameters:

q - (optional) Search for a specific event.

Returns:

all possible events to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/events

getAllEvents

BaseAdsListResponseIterable<TargetingCriteria> getAllEvents()
                                                     throws TwitterException

Returns:

all the events that can be targeted

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/events

getAllTargetingInterests

BaseAdsListResponseIterable<TargetingCriteria> getAllTargetingInterests(java.lang.String q)
                                                                 throws TwitterException

Parameters:

q - (optional) Search for a specific interest.

Returns:

all possible targeting interests to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/interests

getAllTargetingPlatforms

BaseAdsListResponseIterable<TargetingCriteria> getAllTargetingPlatforms(java.lang.String q)
                                                                 throws TwitterException

Parameters:

q - (optional) Search results for matching a specific platform.

Returns:

all possible targeting platforms to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/platforms

getAllTargetingNetworkOperators

BaseAdsListResponseIterable<TargetingCriteria> getAllTargetingNetworkOperators(java.lang.String q)
                                                                        throws TwitterException

Parameters:

q - (optional) Search results for matching a specific network operator.

Returns:

all possible network operators to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/network_operators

getAllTargetingPlatformVersions

BaseAdsListResponseIterable<PlatformVersions> getAllTargetingPlatformVersions()
                                                                       throws TwitterException

Returns:

all possible targeting platform versions to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/platform_versions

getAllTargetingConversations

BaseAdsListResponseIterable<Conversations> getAllTargetingConversations()
                                                                 throws TwitterException

Returns:

all possible targeting conversations to choose from

Throws:

TwitterException

getAllTargetingDevices

BaseAdsListResponseIterable<Devices> getAllTargetingDevices(java.lang.String q)
                                                     throws TwitterException

Parameters:

q - (optional) Search results for matching a specific device.

Returns:

all possible targeting devices to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/devices

getAllTargetingTVChannels

BaseAdsListResponseIterable<TargetingCriteria> getAllTargetingTVChannels(java.lang.String tvMarketLocale,
                                                                         java.util.Optional<java.lang.Integer> count,
                                                                         java.util.Optional<java.lang.String> cursor)
                                                                  throws TwitterException

Parameters:

tvMarketLocale - (optional) Scope the results to a specific tv market locale.

count - (optional) Limit the number of results to the given count.

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:

all possible twitter targeting tv channels to choose from

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/tv_channels

getAllTVShows

BaseAdsListResponseIterable<TargetingCriteria> getAllTVShows(java.lang.String tvMarket,
                                                             java.lang.String q,
                                                             java.util.Optional<java.lang.Integer> count,
                                                             java.util.Optional<java.lang.String> cursor)
                                                      throws TwitterException

Parameters:

tvMarket - (optional) Scope the results to a specific tv market.

q - (optional) Search results for matching a specific tv show.

count - (optional) Limit the number of results to the given count.

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:

all the tv shows (matching q if provided) that can be targeted

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/tv_shows

getAllTVMarkets

BaseAdsListResponseIterable<TargetingCriteria> getAllTVMarkets()
                                                        throws TwitterException

Returns:

All the TV Markets that can be targeted

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/tv_markets

getAllTargetingTVGenres

BaseAdsListResponseIterable<TargetingCriteria> getAllTargetingTVGenres()
                                                                throws TwitterException

Returns:

All the TV Genres that can be targeted

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/tv_genres

getTargetingSuggestion

java.util.List<TargetingSuggestion> getTargetingSuggestion(java.lang.String accountId,
                                                           SuggestionType suggestionType,
                                                           java.util.List<java.lang.String> targetingValues,
                                                           java.util.Optional<java.lang.Integer> count,
                                                           java.util.List<java.lang.String> ignoredValues)
                                                    throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

suggestionType - Specify the enum of suggestions being received.

targetingValues - Targeting values being used to seed the suggestion.

count - (optional) Limit the number of results to the given count.

ignoredValues - (optional) A list of values to ignore from suggested output.

Returns:

list of targeting suggestions for keywords and user IDs

Throws:

TwitterException

See Also:

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

getBehaviors

BaseAdsListResponseIterable<TwitterBehavior> getBehaviors(java.util.Optional<java.lang.Integer> count,
                                                          java.util.Optional<java.lang.String> cursor,
                                                          java.util.List<java.lang.String> behaviorIds,
                                                          java.util.Optional<java.lang.String> countryCode)
                                                   throws TwitterException

Parameters:

behaviorIds - (optional) Scope the results to a set of behavior IDs.

count - (optional) Limit the number of results to the given count.

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:

all the behaviors that can be targeted

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/behaviors

getBehaviorTaxonomy

BaseAdsListResponseIterable<TwitterBehaviorTaxonomy> getBehaviorTaxonomy(java.util.List<java.lang.String> behaviorTaxonomyIds,
                                                                         java.util.List<java.lang.String> parentBehaviorTaxonomyIds,
                                                                         java.util.Optional<java.lang.Integer> count,
                                                                         java.util.Optional<java.lang.String> cursor)
                                                                  throws TwitterException

Parameters:

behaviorTaxonomyIds - (optional) List of behavior taxonomy identifiers by which to filter the response.

parentBehaviorTaxonomyIds - (optional) List of behavior taxonomy identifiers of parent nodes in the tree structures. Specifying parents will only return children nodes of the taxonomy.

count - (optional) Limit the number of results to the given count.

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:

the full or partial behavior taxonomy tree

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/behavior_taxonomies

searchAppStoreCategories

java.util.List<TwitterAppStore> searchAppStoreCategories(java.lang.String q,
                                                         java.util.Optional<AppStoreSearchType> appStoreSearchType)
                                                  throws TwitterException

Parameters:

q - (optional) Search results for matching a specific app store category.

appStoreSearchType - (optional) Limit the number of results to the given count.

Returns:

Some or all of the targetable app store categories

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/targeting_criteria/app_store_categories

getAllAppLists

BaseAdsListResponseIterable<TwitterApplicationList> getAllAppLists(java.lang.String accountId)
                                                            throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

Returns:

all app lists associated with the specified account ID

Throws:

TwitterException

See Also:

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

getAllAppsListsById

BaseAdsResponse<TwitterApplicationList> getAllAppsListsById(java.lang.String accountId,
                                                            java.lang.String listId)
                                                     throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

listId - A specific app list ID.

Returns:

an application list given a specific list ID

Throws:

TwitterException

See Also:

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

createNewApplicationList

BaseAdsResponse<TwitterApplicationList> createNewApplicationList(java.lang.String accountId,
                                                                 TwitterApplicationList twitterApplicationList)
                                                          throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

twitterApplicationList - A list of applications to add to app list.

Returns:

response of creating a new application list

Throws:

TwitterException

See Also:

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

getAllIabCategories

BaseAdsListResponseIterable<IabCategory> getAllIabCategories(java.lang.String q)
                                                      throws TwitterException

Parameters:

q - (optional) Search results for matching a specific IAB category.

Returns:

all the Twitter IAB categories that can be targeted

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/iab_categories

getReachEstimate

BaseAdsResponse<NewTwitterReachEstimate> getReachEstimate(java.lang.String accountId,
                                                          ProductType productType,
                                                          java.util.List<TargetingCriteria> targetingCriterias,
                                                          java.lang.String objective,
                                                          java.lang.Long bidAmountLocalMicro,
                                                          java.lang.String currency,
                                                          java.lang.Long campaignDailyBudgetAmountLocalMicro,
                                                          java.lang.String bidType)
                                                   throws TwitterException

Returns:

reach_estimate of the ad

Throws:

TwitterException

fetchIabCategories

BaseAdsListResponseIterable<IabCategory> fetchIabCategories(java.lang.String q)
                                                     throws TwitterException

Throws:

TwitterException

createTargetingBatchRequest

TargetingParamResponse createTargetingBatchRequest(java.lang.String accountId,
                                                   java.util.List<TargetingParamRequest> targetingParamRequests)
                                            throws TwitterException

Throws:

TwitterException