twitter4jads.api

Interface TwitterAdsFundingInstrumentApi

All Known Implementing Classes:

TwitterAdsFundingInstrumentApiImpl

public interface TwitterAdsFundingInstrumentApi

User: abhay Date: 4/5/16 Time: 10:36 AM

Method Summary

Modifier and Type	Method and Description
BaseAdsListResponseIterable<FundingInstrument>	getAllFundingInstruments(java.lang.String accountId, boolean withDeleted, java.util.Optional<java.util.Collection<java.lang.String>> fundingInstrumentIds, java.util.Optional<FundingInstrumentSortByField> sortByField)
BaseAdsResponse<FundingInstrument>	getFundingInstrumentById(java.lang.String accountId, java.lang.String fundingInstrumentId, boolean withDeleted)

Method Detail

getAllFundingInstruments

BaseAdsListResponseIterable<FundingInstrument> getAllFundingInstruments(java.lang.String accountId,
                                                                        boolean withDeleted,
                                                                        java.util.Optional<java.util.Collection<java.lang.String>> fundingInstrumentIds,
                                                                        java.util.Optional<FundingInstrumentSortByField> sortByField)
                                                                 throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

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

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

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

Returns:

Retrieve some or all funding instruments associated with the account.

Throws:

TwitterException

See Also:

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

getFundingInstrumentById

BaseAdsResponse<FundingInstrument> getFundingInstrumentById(java.lang.String accountId,
                                                            java.lang.String fundingInstrumentId,
                                                            boolean withDeleted)
                                                     throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

fundingInstrumentId - The identifier for a funding instrument associated with the current account.

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

Returns:

Retrieve a specific funding instrument associated with the account.

Throws:

TwitterException

See Also:

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