Trading_UploadSiteHostedPicturesRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_UploadSiteHostedPicturesRequestType.h Trading_UploadSiteHostedPicturesRequestType.m |
Overview
Uploads a picture for a listing and returns a URL for the picture.
@ingroup EBayAPIInterface
Tasks
-
pictureName
A name you provide for the picture.
property
Returned as SiteHostedPictureDetails.PictureName in the call response. -
pictureSystemVersion
Specifies the picture system version. Only version 2 is valid.
property
Available to support future changes in the picture system version. -
pictureSet
The image sizes that will be generated.
property -
pictureData
An optional reference ID to the binary attachment.
property
The PictureData field does not contain the binary attachment.
The binary attachment is image data,
including headers, from a JPG, GIF, PNG, BMP, or TIF format image file.
The binary attachment must be sent as a MIME attachment,
in your POST request, after the XML input.
Note: Not applicable for eBay Large Merchant Services. Use the
ExternalPictureURL field instead. -
pictureUploadPolicy
When the My Picture Uploads feature is available (see the Trading API Release Notes), applications
property
(including non-listing apps, such as photo-editors and digital-camera software) will be able to use
the PictureUploadPolicy field to specify that an uploaded picture is available to a seller on the eBay site. When you use PictureUploadPolicy, you are specifying that the picture you uploaded (and its URL) is stored for 48 hours on the eBay site. (If, within 48 hours, the picture is associated with an item,
then it persists on the eBay site for the same time length as other pictures uploaded using
the UploadSiteHostedPictures call).
As a result of the storage on the eBay site, the picture is available to the seller on
the My Picture Uploads tab within the Sell Your Item (SYI) pages.
A maximum of 25 URLs can be stored. -
externalPictureURL
Include the URL for a picture that you want to include in your listing.
property
You can only include one ExternalPictureURL field per call.
Note:
If a URI contains spaces, replace them with%20
.
For example,http://example.com/my image.jpg
must be submitted ashttp://example.com/my%20image.jpg
to replace the space in the image file name.
This field allows the eBay server to retrieve a picture from a URL on an
external web server. Once retrieved, the picture will be copied to
eBay Picture Services (EPS), and retained for 90 days, plus the length of
your listing duration.
Note: The ExternalPictureURL field is required
when using eBay Large Merchant Services. -
pictureWatermark
This is the type of watermark that should be applied to the pictures hosted
property
by the eBay Picture Services. Please note that watermarks are applied only
to pictures that are greater than an EPS configured size. The possible
values are: None, Both, Icon, or SellerId. -
extensionInDays
The number of days to extend the expiration date for the
property
specified image, after a listing has ended. This call is restricted to
applications that have been granted permission to use it by eBay
Developer Technical Support.
This call is not needed for active listings - it is meant to be used only
when a photo needs to be hosted longer than the normal listing
duration.
The maximum number of days allowed for this field is 30.
Properties
extensionInDays
The number of days to extend the expiration date for the
specified image, after a listing has ended. This call is restricted to
applications that have been granted permission to use it by eBay
Developer Technical Support.
This call is not needed for active listings - it is meant to be used only
when a photo needs to be hosted longer than the normal listing
duration.
The maximum number of days allowed for this field is 30.
@property (nonatomic, retain) NSNumber *extensionInDays
Discussion
The number of days to extend the expiration date for the
specified image, after a listing has ended. This call is restricted to
applications that have been granted permission to use it by eBay
Developer Technical Support.
This call is not needed for active listings - it is meant to be used only
when a photo needs to be hosted longer than the normal listing
duration.
The maximum number of days allowed for this field is 30.
type : NSNumber, wrapper for primitive int
Declared In
Trading_UploadSiteHostedPicturesRequestType.h
externalPictureURL
Include the URL for a picture that you want to include in your listing.
You can only include one ExternalPictureURL field per call.
Note:
If a URI contains spaces, replace them with %20
.
For example, http://example.com/my image.jpg
must be submitted as http://example.com/my%20image.jpg
to replace the space in the image file name.
This field allows the eBay server to retrieve a picture from a URL on an
external web server. Once retrieved, the picture will be copied to
eBay Picture Services (EPS), and retained for 90 days, plus the length of
your listing duration.
Note: The ExternalPictureURL field is required
when using eBay Large Merchant Services.
@property (nonatomic, retain) NSMutableArray *externalPictureURL
Discussion
Include the URL for a picture that you want to include in your listing.
You can only include one ExternalPictureURL field per call.
Note:
If a URI contains spaces, replace them with %20
.
For example, http://example.com/my image.jpg
must be submitted as http://example.com/my%20image.jpg
to replace the space in the image file name.
This field allows the eBay server to retrieve a picture from a URL on an
external web server. Once retrieved, the picture will be copied to
eBay Picture Services (EPS), and retained for 90 days, plus the length of
your listing duration.
Note: The ExternalPictureURL field is required
when using eBay Large Merchant Services.
entry type : NSString, wrapper for primitive string
Declared In
Trading_UploadSiteHostedPicturesRequestType.h
pictureData
An optional reference ID to the binary attachment.
The PictureData field does not contain the binary attachment.
The binary attachment is image data,
including headers, from a JPG, GIF, PNG, BMP, or TIF format image file.
The binary attachment must be sent as a MIME attachment,
in your POST request, after the XML input.
Note: Not applicable for eBay Large Merchant Services. Use the
ExternalPictureURL field instead.
@property (nonatomic, retain) Trading_Base64BinaryType *pictureData
Discussion
An optional reference ID to the binary attachment.
The PictureData field does not contain the binary attachment.
The binary attachment is image data,
including headers, from a JPG, GIF, PNG, BMP, or TIF format image file.
The binary attachment must be sent as a MIME attachment,
in your POST request, after the XML input.
Note: Not applicable for eBay Large Merchant Services. Use the
ExternalPictureURL field instead.
type : class Trading_Base64BinaryType
Declared In
Trading_UploadSiteHostedPicturesRequestType.h
pictureName
A name you provide for the picture.
Returned as SiteHostedPictureDetails.PictureName in the call response.
@property (nonatomic, retain) NSString *pictureName
Discussion
A name you provide for the picture.
Returned as SiteHostedPictureDetails.PictureName in the call response.
type : NSString, wrapper for primitive string
Declared In
Trading_UploadSiteHostedPicturesRequestType.h
pictureSet
The image sizes that will be generated.
@property (nonatomic, retain) NSString *pictureSet
Discussion
The image sizes that will be generated.
type: string constant in Trading_PictureSetCodeType.h
Declared In
Trading_UploadSiteHostedPicturesRequestType.h
pictureSystemVersion
Specifies the picture system version. Only version 2 is valid.
Available to support future changes in the picture system version.
@property (nonatomic, retain) NSNumber *pictureSystemVersion
Discussion
Specifies the picture system version. Only version 2 is valid.
Available to support future changes in the picture system version.
type : NSNumber, wrapper for primitive int
Declared In
Trading_UploadSiteHostedPicturesRequestType.h
pictureUploadPolicy
When the My Picture Uploads feature is available (see the Trading API Release Notes), applications
(including non-listing apps, such as photo-editors and digital-camera software) will be able to use
the PictureUploadPolicy field to specify that an uploaded picture is available to a seller on the eBay site. When you use PictureUploadPolicy, you are specifying that the picture you uploaded (and its URL) is stored for 48 hours on the eBay site. (If, within 48 hours, the picture is associated with an item,
then it persists on the eBay site for the same time length as other pictures uploaded using
the UploadSiteHostedPictures call).
As a result of the storage on the eBay site, the picture is available to the seller on
the My Picture Uploads tab within the Sell Your Item (SYI) pages.
A maximum of 25 URLs can be stored.
@property (nonatomic, retain) NSString *pictureUploadPolicy
Discussion
When the My Picture Uploads feature is available (see the Trading API Release Notes), applications
(including non-listing apps, such as photo-editors and digital-camera software) will be able to use
the PictureUploadPolicy field to specify that an uploaded picture is available to a seller on the eBay site. When you use PictureUploadPolicy, you are specifying that the picture you uploaded (and its URL) is stored for 48 hours on the eBay site. (If, within 48 hours, the picture is associated with an item,
then it persists on the eBay site for the same time length as other pictures uploaded using
the UploadSiteHostedPictures call).
As a result of the storage on the eBay site, the picture is available to the seller on
the My Picture Uploads tab within the Sell Your Item (SYI) pages.
A maximum of 25 URLs can be stored.
type: string constant in Trading_PictureUploadPolicyCodeType.h
Declared In
Trading_UploadSiteHostedPicturesRequestType.h
pictureWatermark
This is the type of watermark that should be applied to the pictures hosted
by the eBay Picture Services. Please note that watermarks are applied only
to pictures that are greater than an EPS configured size. The possible
values are: None, Both, Icon, or SellerId.
@property (nonatomic, retain) NSMutableArray *pictureWatermark
Discussion
This is the type of watermark that should be applied to the pictures hosted
by the eBay Picture Services. Please note that watermarks are applied only
to pictures that are greater than an EPS configured size. The possible
values are: None, Both, Icon, or SellerId.
entry type : string constant in Trading_PictureWatermarkCodeType.h
Declared In
Trading_UploadSiteHostedPicturesRequestType.h