|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetAdFormatLeadsCall
public class GetAdFormatLeadsCall
Wrapper class of the GetAdFormatLeads call of eBay SOAP API.
Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
ItemID
- The unique identifier of an item listed on the eBay site.
Returned by eBay when the item is created. This ID must correspond
to an ad format item.
Status
- Filters the leads based on their status.
IncludeMemberMessages
- Boolean which indicates whether to return mail messages for this lead in a MemberMessage node.
StartCreationTime
- Used with EndCreationTime to limit the returned leads for a user to only
those with a creation date greater than or equal to the specified date and
time.
EndCreationTime
- Used with StartCreationTime to limit the returned leads for a user to only
those with a creation date less than or equal to the specified date and
time.
ReturnedAdFormatLeads
- Contains contact and other information for one lead. One node is
returned for each lead. Only returned at a detail level of ReturnAll. At
least one lead must be available for the specified item to return
AdFormatLead.
ReturnedAdFormatLeadCount
- The total number of leads returned. Only returned if you do not
specify a detail level.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetAdFormatLeadsCall()
Constructor. |
|
GetAdFormatLeadsCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
void |
getAdFormatLeads()
Retrieves sales lead information for a lead generation listing. |
Calendar |
getEndCreationTime()
Gets the GetAdFormatLeadsRequestType.endCreationTime. |
Boolean |
getIncludeMemberMessages()
Gets the GetAdFormatLeadsRequestType.includeMemberMessages. |
String |
getItemID()
Gets the GetAdFormatLeadsRequestType.itemID. |
Integer |
getReturnedAdFormatLeadCount()
Valid after executing the API. |
AdFormatLeadType[] |
getReturnedAdFormatLeads()
Valid after executing the API. |
Calendar |
getStartCreationTime()
Gets the GetAdFormatLeadsRequestType.startCreationTime. |
MessageStatusTypeCodeType |
getStatus()
Gets the GetAdFormatLeadsRequestType.status. |
void |
setEndCreationTime(Calendar endCreationTime)
Sets the GetAdFormatLeadsRequestType.endCreationTime. |
void |
setIncludeMemberMessages(Boolean includeMemberMessages)
Sets the GetAdFormatLeadsRequestType.includeMemberMessages. |
void |
setItemID(String itemID)
Sets the GetAdFormatLeadsRequestType.itemID. |
void |
setStartCreationTime(Calendar startCreationTime)
Sets the GetAdFormatLeadsRequestType.startCreationTime. |
void |
setStatus(MessageStatusTypeCodeType status)
Sets the GetAdFormatLeadsRequestType.status. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetAdFormatLeadsCall()
public GetAdFormatLeadsCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getAdFormatLeads() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public Calendar getEndCreationTime()
public void setEndCreationTime(Calendar endCreationTime)
endCreationTime
- Calendarpublic Boolean getIncludeMemberMessages()
public void setIncludeMemberMessages(Boolean includeMemberMessages)
includeMemberMessages
- Booleanpublic String getItemID()
public void setItemID(String itemID)
itemID
- Stringpublic Calendar getStartCreationTime()
public void setStartCreationTime(Calendar startCreationTime)
startCreationTime
- Calendarpublic MessageStatusTypeCodeType getStatus()
public void setStatus(MessageStatusTypeCodeType status)
status
- MessageStatusTypeCodeTypepublic Integer getReturnedAdFormatLeadCount()
public AdFormatLeadType[] getReturnedAdFormatLeads()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.