public interface TwitterAdsTargetingApi
| 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) |
@Deprecated BaseAdsListResponseIterable<TargetingCriteria> getTargetingCriterias(java.lang.String accountId, java.lang.String lineItemId, boolean withDeleted) throws TwitterException
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.TwitterExceptionBaseAdsListResponseIterable<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
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: 200withDeleted - 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: 1000cursor - Specifies a cursor to get the next page of results.sortBy - Sorts by supported attribute in ascending or descending order.TwitterExceptionBaseAdsResponse<TargetingCriteria> getTargetingCriteriaById(java.lang.String accountId, java.lang.String targetingId, boolean withDeleted) throws TwitterException
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.TwitterExceptionBaseAdsResponse<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
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.TwitterExceptionjava.util.List<TargetingCriteria> createTargetingCriterias(java.lang.String accountId, java.lang.String lineItemId, java.util.List<TargetingCriteria> targetingCriteriaValues) throws TwitterException
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.TwitterExceptionBaseAdsResponse<TargetingCriteria> deleteTargetingCriteria(java.lang.String accountId, java.lang.String targetingCriteriaId) throws TwitterException
accountId - The identifier for the leveraged account.targetingCriteriaId - The targeting criteria ID to delete.TwitterExceptionBaseAdsListResponseIterable<TargetingLocation> getAllTargetingLocations(java.util.Optional<LocationType> locationType, java.lang.String q, java.lang.String countryCode, java.util.Optional<java.lang.Integer> count) throws TwitterException
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.TwitterExceptionBaseAdsListResponseIterable<TargetingLocation> getTargetingLocations(java.lang.String query, LocationType locationType) throws TwitterException
locationType - (optional) Scope the results to a specific type of location.query - (optional) Search for a specific location.TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTargetingLocales(java.lang.String q) throws TwitterException
q - (optional) Search results for matching a specific locale.TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTargetingEvents(java.lang.String q) throws TwitterException
q - (optional) Search for a specific event.TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllEvents() throws TwitterException
TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTargetingInterests(java.lang.String q) throws TwitterException
q - (optional) Search for a specific interest.TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTargetingPlatforms(java.lang.String q) throws TwitterException
q - (optional) Search results for matching a specific platform.TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTargetingNetworkOperators(java.lang.String q) throws TwitterException
q - (optional) Search results for matching a specific network operator.TwitterExceptionBaseAdsListResponseIterable<PlatformVersions> getAllTargetingPlatformVersions() throws TwitterException
TwitterExceptionBaseAdsListResponseIterable<Conversations> getAllTargetingConversations() throws TwitterException
TwitterExceptionBaseAdsListResponseIterable<Devices> getAllTargetingDevices(java.lang.String q) throws TwitterException
q - (optional) Search results for matching a specific device.TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTargetingTVChannels(java.lang.String tvMarketLocale, java.util.Optional<java.lang.Integer> count, java.util.Optional<java.lang.String> cursor) throws TwitterException
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).TwitterExceptionBaseAdsListResponseIterable<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
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).TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTVMarkets() throws TwitterException
TwitterExceptionBaseAdsListResponseIterable<TargetingCriteria> getAllTargetingTVGenres() throws TwitterException
TwitterExceptionjava.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
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.TwitterExceptionBaseAdsListResponseIterable<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
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).TwitterExceptionBaseAdsListResponseIterable<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
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).TwitterExceptionjava.util.List<TwitterAppStore> searchAppStoreCategories(java.lang.String q, java.util.Optional<AppStoreSearchType> appStoreSearchType) throws TwitterException
q - (optional) Search results for matching a specific app store category.appStoreSearchType - (optional) Limit the number of results to the given count.TwitterExceptionBaseAdsListResponseIterable<TwitterApplicationList> getAllAppLists(java.lang.String accountId) throws TwitterException
accountId - The identifier for the leveraged account.TwitterExceptionBaseAdsResponse<TwitterApplicationList> getAllAppsListsById(java.lang.String accountId, java.lang.String listId) throws TwitterException
accountId - The identifier for the leveraged account.listId - A specific app list ID.TwitterExceptionBaseAdsResponse<TwitterApplicationList> createNewApplicationList(java.lang.String accountId, TwitterApplicationList twitterApplicationList) throws TwitterException
accountId - The identifier for the leveraged account.twitterApplicationList - A list of applications to add to app list.TwitterExceptionBaseAdsListResponseIterable<IabCategory> getAllIabCategories(java.lang.String q) throws TwitterException
q - (optional) Search results for matching a specific IAB category.TwitterExceptionBaseAdsResponse<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
TwitterExceptionBaseAdsListResponseIterable<IabCategory> fetchIabCategories(java.lang.String q) throws TwitterException
TwitterExceptionTargetingParamResponse createTargetingBatchRequest(java.lang.String accountId, java.util.List<TargetingParamRequest> targetingParamRequests) throws TwitterException
TwitterException