eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType(3)

NAME
eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType

DESCRIPTION
Retrieves sales lead information for a lead generation listing. GetAdFormatLeadsRequest returns the number of leads for an ad and any contact information that the prospective buyer submitted.

SYNOPSIS

INHERITANCE
eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

  setEndCreationTime()
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.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

  getEndCreationTime()
# Returns: 'xs:dateTime'

  setIncludeMemberMessages()
Boolean which indicates whether to return mail messages for this lead in a MemberMessage node.

  RequiredInput: No
#    Argument: 'xs:boolean'

  isIncludeMemberMessages()
# Returns: 'xs:boolean'

  setItemID()
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.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

  RequiredInput: No
#    Argument: 'ns:ItemIDType'

  getItemID()
# Returns: 'ns:ItemIDType'

  setStartCreationTime()
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.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

  getStartCreationTime()
# Returns: 'xs:dateTime'

  setStatus()
Filters the leads based on their status.

  RequiredInput: No
#    Argument: 'ns:MessageStatusTypeCodeType'

  getStatus()
# Returns: 'ns:MessageStatusTypeCodeType'