twitter4jads.api

Interface TwitterAdsStatApi

All Known Implementing Classes:

TwitterAdsStatApiImpl

public interface TwitterAdsStatApi

User: abhay Date: 4/5/16 Time: 11:31 AM

Method Summary

Modifier and Type	Method and Description
BaseAdsResponse<JobDetails>	createAsyncJob(java.lang.String accountId, TwitterEntityType twitterEntityType, java.util.Collection<java.lang.String> ids, long startTime, long endTime, boolean withDeleted, Granularity granularity, Placement placement, java.util.Optional<TwitterSegmentationType> twitterSegmentationType)
BaseAdsResponse<JobDetails>	deleteJob(java.lang.String accountId, java.lang.String jobId)
BaseAdsListResponseIterable<TwitterAuctionInsights>	fetchAuctionInsights(java.lang.String accountId, java.util.Collection<java.lang.String> lineItemIds, long startTime, long endTime, Granularity granularity, Placement placement)
BaseAdsListResponseIterable<TwitterAdStatistics>	fetchCampaignStats(java.lang.String accountId, java.util.Collection<java.lang.String> campaignIds, long startTime, long endTime)
BaseAdsListResponse<TwitterEntityStatistics>	fetchJobDataAsync(java.lang.String dataUrl)
BaseAdsListResponseIterable<TwitterEntityStatistics>	fetchStatsSync(java.lang.String accountId, TwitterEntityType twitterEntity, java.util.Collection<java.lang.String> ids, long startTime, long endTime, boolean withDeleted, Granularity granularity, Placement placement)
BaseAdsListResponseIterable<JobDetails>	getJobExecutionDetails(java.lang.String accountId, java.util.Collection<java.lang.String> jobIds)

Method Detail

fetchStatsSync

BaseAdsListResponseIterable<TwitterEntityStatistics> fetchStatsSync(java.lang.String accountId,
                                                                    TwitterEntityType twitterEntity,
                                                                    java.util.Collection<java.lang.String> ids,
                                                                    long startTime,
                                                                    long endTime,
                                                                    boolean withDeleted,
                                                                    Granularity granularity,
                                                                    Placement placement)
                                                             throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

twitterEntity - The enum of entity type (e.g. LINE_ITEM, PROMOTED_TWEET).

ids - A collection of ids to retrieve stats for.

startTime - The time to retrieve stats from.

endTime - The time to retrieve stats until.

withDeleted - Whether or not to include deleted items in the results. Defaults to false.

granularity - The granularity as enum such as DAY or HOUR.

placement - The placement of entity to retrieve stats for.

Returns:

analytics data for the given parameters

Throws:

TwitterException

See Also:

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

fetchAuctionInsights

BaseAdsListResponseIterable<TwitterAuctionInsights> fetchAuctionInsights(java.lang.String accountId,
                                                                         java.util.Collection<java.lang.String> lineItemIds,
                                                                         long startTime,
                                                                         long endTime,
                                                                         Granularity granularity,
                                                                         Placement placement)
                                                                  throws TwitterException

Throws:

TwitterException

createAsyncJob

BaseAdsResponse<JobDetails> createAsyncJob(java.lang.String accountId,
                                           TwitterEntityType twitterEntityType,
                                           java.util.Collection<java.lang.String> ids,
                                           long startTime,
                                           long endTime,
                                           boolean withDeleted,
                                           Granularity granularity,
                                           Placement placement,
                                           java.util.Optional<TwitterSegmentationType> twitterSegmentationType)
                                    throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

twitterEntityType - The enum of entity type (e.g. LINE_ITEM, PROMOTED_TWEET).

ids - A collection of ids to retrieve stats for.

startTime - The time to retrieve stats from.

endTime - The time to retrieve stats until.

withDeleted - Whether or not to include deleted items in the results. Defaults to false.

granularity - The granularity as enum such as DAY or HOUR.

placement - The placement of entity to retrieve stats for.

twitterSegmentationType - (optional) Break down analytics data via a supported segmentation type.

Returns:

job details for async job to fetch analytics data for the given paramters

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/1/post/stats/jobs/accounts/%3Aaccount_id

getJobExecutionDetails

BaseAdsListResponseIterable<JobDetails> getJobExecutionDetails(java.lang.String accountId,
                                                               java.util.Collection<java.lang.String> jobIds)
                                                        throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

jobIds - A collection of job IDs to retrieve status of.

Returns:

job execution details for given job IDs

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/1/get/stats/jobs/accounts/%3Aaccount_id

fetchJobDataAsync

BaseAdsListResponse<TwitterEntityStatistics> fetchJobDataAsync(java.lang.String dataUrl)
                                                        throws TwitterException

Parameters:

dataUrl - The path given as output via a completed async job.

Returns:

analytics data extracted from the finished output path of a async job

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/1/get/stats/jobs/accounts/%3Aaccount_id

fetchCampaignStats

BaseAdsListResponseIterable<TwitterAdStatistics> fetchCampaignStats(java.lang.String accountId,
                                                                    java.util.Collection<java.lang.String> campaignIds,
                                                                    long startTime,
                                                                    long endTime)
                                                             throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

campaignIds - Campaign ids to fetch stats for.

startTime - Start time.

endTime - End time.

Returns:

statistics response

Throws:

TwitterException

deleteJob

BaseAdsResponse<JobDetails> deleteJob(java.lang.String accountId,
                                      java.lang.String jobId)
                               throws TwitterException

Throws:

TwitterException