eBay::API::XML::DataType::PromotedItemType - eBay::API::XML::DataType::PromotedItemType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::PromotedItemType

DESCRIPTION

Top

Contains the data describing one cross-promoted item.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::PromotedItemType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setItemID()

The unique ID of the item for which there is a promotion.

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

# Argument: 'ns:ItemIDType'

getItemID()

  Calls: GetPromotionRules
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetCrossPromotions
  Returned: Always

# Returns: 'ns:ItemIDType'

setListingType()

The listing type under which the cross-promoted item is being offered.<br> <br> <span class="tablenote"><b>Note:</b> Lead generated items are only cross-promoted if they are in the classified ad format (ListingSubtype=ClassifiedAd).</span>

# Argument: 'ns:ListingTypeCodeType'

getListingType()

  Calls: GetItem
  Returned: Conditionally
  AllValuesExcept: Unknown, Live, Auction, PersonalOffer,
							Half, Express
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetCrossPromotions
  Returned: Always
  AllValuesExcept: Unknown, Live, Auction, PersonalOffer,
							Half, Express

# Returns: 'ns:ListingTypeCodeType'

setPictureURL()

URL for an image hosted by eBay Picture Services (EPS) or self-hosted for the promoted item, if any.

# Argument: 'xs:string'

getPictureURL()

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

# Returns: 'xs:string'

setPosition()

The ordinal position of the cross-promoted item in the display. If the display is from top to bottom, 1 is at top. If the display is from left to right, 1 is at left.

# Argument: 'xs:int'

getPosition()

  Calls: GetPromotionRules
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetCrossPromotions
  Returned: Always

# Returns: 'xs:int'

setPromotionDetails()

Contains the details about the promoted item for a given PromotionPriceType. Output only. Returned with request versions 485 or higher.

# Argument: reference to an array of 'ns:PromotionDetailsType'

getPromotionDetails()

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetCrossPromotions
  Returned: Always

# Returns: reference to an array of 'ns:PromotionDetailsType'

setSelectionType()

The manner in which the cross-promoted item was chosen to be associated with the referring item. Output only.

# Argument: 'ns:PromotionItemSelectionCodeType'

getSelectionType()

  Calls: GetPromotionRules
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetCrossPromotions
  Returned: Always

# Returns: 'ns:PromotionItemSelectionCodeType'

setTimeLeft()

Time left before the listing for the cross-promoted item ends. Output only. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds).

# Argument: 'xs:duration'

getTimeLeft()

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetCrossPromotions
  Returned: Always

# Returns: 'xs:duration'

setTitle()

The title of the promoted item for display in the referring item's page. Output only.

# Argument: 'xs:string'

getTitle()

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

  Calls: GetCrossPromotions
  Returned: Always

# Returns: 'xs:string'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::PromotedItemType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. PromotedItemType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");

use eBay::API::XML::DataType::ItemIDType;
use eBay::API::XML::DataType::PromotionDetailsType;
use eBay::API::XML::DataType::Enum::ListingTypeCodeType;
use eBay::API::XML::DataType::Enum::PromotionItemSelectionCodeType;


my @gaProperties = ( [ 'ItemID', 'ns:ItemIDType', ''
	     ,'eBay::API::XML::DataType::ItemIDType', '1' ]
	, [ 'ListingType', 'ns:ListingTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ListingTypeCodeType', '' ]
	, [ 'PictureURL', 'xs:string', '', '', '' ]
	, [ 'Position', 'xs:int', '', '', '' ]
	, [ 'PromotionDetails', 'ns:PromotionDetailsType', '1'
	     ,'eBay::API::XML::DataType::PromotionDetailsType', '1' ]
	, [ 'SelectionType', 'ns:PromotionItemSelectionCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::PromotionItemSelectionCodeType', '' ]
	, [ 'TimeLeft', 'xs:duration', '', '', '' ]
	, [ 'Title', 'xs:string', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setItemID {
  my $self = shift;
  $self->{'ItemID'} = shift
}


sub getItemID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ItemID'
		,'eBay::API::XML::DataType::ItemIDType');
}



sub setListingType {
  my $self = shift;
  $self->{'ListingType'} = shift
}


sub getListingType {
  my $self = shift;
  return $self->{'ListingType'};
}



sub setPictureURL {
  my $self = shift;
  $self->{'PictureURL'} = shift
}


sub getPictureURL {
  my $self = shift;
  return $self->{'PictureURL'};
}



sub setPosition {
  my $self = shift;
  $self->{'Position'} = shift
}


sub getPosition {
  my $self = shift;
  return $self->{'Position'};
}



sub setPromotionDetails {
  my $self = shift;
  $self->{'PromotionDetails'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getPromotionDetails {
  my $self = shift;
  return $self->_getDataTypeArray('PromotionDetails');
}



sub setSelectionType {
  my $self = shift;
  $self->{'SelectionType'} = shift
}


sub getSelectionType {
  my $self = shift;
  return $self->{'SelectionType'};
}



sub setTimeLeft {
  my $self = shift;
  $self->{'TimeLeft'} = shift
}


sub getTimeLeft {
  my $self = shift;
  return $self->{'TimeLeft'};
}



sub setTitle {
  my $self = shift;
  $self->{'Title'} = shift
}


sub getTitle {
  my $self = shift;
  return $self->{'Title'};
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;