- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class InventoryEntry(gdata.data.BatchEntry) |
| |
Product entry containing local product information.
The elements of this entry that are used are made up of five different
namespaces. They are:
atom: - Atom
app: - Atom Publishing Protocol
gd: - Google Data API
sc: - Content API for Shopping, general attributes
scp: - Content API for Shopping, product attributes
Only the sc and scp namespace elements are defined here, but additional useful
elements are defined in superclasses.
To remove the value of an attribute of a local product, set the value of the
attribute to the empty string. For example:
entry.availability = Availability('')
The following attributes are encoded as XML elements in the Atom (atom:)
namespace: title, link, entry, id, category, content, author, created
updated. Among these, the title, content and link tags are part of the
required Content for Shopping API so we document them here.
.. attribute:: availability
The avilability of a local product.
This should be an :class:`Availability` instance, for example::
entry = InventoryEntry()
entry.availability = Availability('in stock')
.. attribute:: price
The price for this local product.
This should be a :class:`Price` element, including a unit argument to
indicate the currency, for example::
entry = InventoryEntry()
entry.price = Price('20.00', unit='USD')
.. attribute:: quantity
The quantity of local product available in stock.
This should be a :class:`Quantity` element, for example::
entry = InventoryEntry()
entry.quantity = Quantity('100')
.. attribute:: sale_price
The sale price for this local product.
This should be a :class:`SalePrice` element, including a unit argument to
indicate the currency, for example::
entry = InventoryEntry()
entry.sale_price = SalePrice('20.00', unit='USD')
.. attribute:: sale_price_effective_date
The effective data of the sale price for this local product.
This should be a :class:`SalePriceEffectiveDate` element, for example::
entry = InventoryEntry()
entry.sale_price_effective_date = SalePriceEffectiveDate(
'2012-01-09 2012-01-13') |
| |
- Method resolution order:
- InventoryEntry
- gdata.data.BatchEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Data and other attributes defined here:
- availability = <class 'gdata.contentforshopping.data.Availability'>
- scp:availability element
The retailer's suggested label for product availability. Supported values
include: 'in stock', 'out of stock', 'limited availability',
'available for order', and 'preorder'.
- price = <class 'gdata.contentforshopping.data.Price'>
- scp:price element
The price of the product. The unit attribute must be set, and should represent
the currency.
Note: Required Element
- quantity = <class 'gdata.contentforshopping.data.Quantity'>
- scp:quantity element
The number of items available. A value of 0 indicates items that are
currently out of stock.
- sale_price = <class 'gdata.contentforshopping.data.SalePrice'>
- scp:sale_price element
The sale price of the product. The unit attribute must be set, and should
represent the currency.
- sale_price_effective_date = <class 'gdata.contentforshopping.data.SalePriceEffectiveDate'>
- scp:sale_price_effective_date element
The effective date of the sale price of the product.
Data and other attributes inherited from gdata.data.BatchEntry:
- batch_id = <class 'gdata.data.BatchId'>
- Identifies a single operation in a batch request.
- batch_operation = <class 'gdata.data.BatchOperation'>
- The CRUD operation which this batch entry represents.
- batch_status = <class 'gdata.data.BatchStatus'>
- The batch:status element present in a batch response entry.
A status element contains the code (HTTP response code) and
reason as elements. In a single request these fields would
be part of the HTTP response, but in a batch request each
Entry operation has a corresponding Entry in the response
feed which includes status information.
See http://code.google.com/apis/gdata/batch.html#Handling_Errors
Methods inherited from gdata.data.GDEntry:
- FindMediaLink = find_media_link(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- GetId = get_id(self)
- IsMedia = is_media(self)
- find_media_link(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- get_id(self)
- is_media(self)
Data and other attributes inherited from gdata.data.GDEntry:
- etag = '{http://schemas.google.com/g/2005}etag'
Data and other attributes inherited from atom.data.Entry:
- content = <class 'atom.data.Content'>
- The atom:content element.
- control = <class 'atom.data.Control'>
- The app:control element indicating restrictions on publication.
The APP control element may contain a draft element indicating whether or
not this entry should be publicly available.
- published = <class 'atom.data.Published'>
- The atom:published element.
- source = <class 'atom.data.Source'>
- The atom:source element.
- summary = <class 'atom.data.Summary'>
- The atom:summary element.
Methods inherited from atom.data.FeedEntryParent:
- __init__(self, atom_id=None, text=None, *args, **kwargs)
Data and other attributes inherited from atom.data.FeedEntryParent:
- author = [<class 'atom.data.Author'>]
- category = [<class 'atom.data.Category'>]
- contributor = [<class 'atom.data.Contributor'>]
- id = <class 'atom.data.Id'>
- The atom:id element.
- link = [<class 'atom.data.Link'>]
- rights = <class 'atom.data.Rights'>
- The atom:rights element.
- title = <class 'atom.data.Title'>
- The atom:title element.
- updated = <class 'atom.data.Updated'>
- The atom:updated element.
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
Methods inherited from gdata.data.LinkFinder:
- FindAclLink = find_acl_link(self)
- FindFeedLink = find_feed_link(self)
- FindHtmlLink = find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- FindPostLink = find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- FindPreviousLink = find_previous_link(self)
- GetAclLink = get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- GetFeedLink = get_feed_link(self)
- GetHtmlLink = get_html_link(self)
- GetPostLink = get_post_link(self)
- GetPreviousLink = get_previous_link(self)
- find_acl_link(self)
- find_feed_link(self)
- find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- find_previous_link(self)
- get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- get_feed_link(self)
- get_html_link(self)
- get_post_link(self)
- get_previous_link(self)
Methods inherited from atom.data.LinkFinder:
- FindAlternateLink = find_alternate_link(self)
- FindEditLink = find_edit_link(self)
- FindEditMediaLink = find_edit_media_link(self)
- FindLicenseLink = find_license_link(self)
- FindNextLink = find_next_link(self)
- FindSelfLink = find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- FindUrl = find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- GetAlternateLink = get_alternate_link(self)
- GetEditLink = get_edit_link(self)
- GetEditMediaLink = get_edit_media_link(self)
- GetLicenseLink = get_license_link(self)
- GetLink = get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- GetNextLink = get_next_link(self)
- GetSelfLink = get_self_link(self)
- find_alternate_link(self)
- find_edit_link(self)
- find_edit_media_link(self)
- find_license_link(self)
- find_next_link(self)
- find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- get_alternate_link(self)
- get_edit_link(self)
- get_edit_media_link(self)
- get_license_link(self)
- get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- get_next_link(self)
- get_self_link(self)
|
class InventoryFeed(gdata.data.BatchFeed) |
| |
Represents a feed of a merchant's local products. |
| |
- Method resolution order:
- InventoryFeed
- gdata.data.BatchFeed
- gdata.data.GDFeed
- atom.data.Feed
- atom.data.Source
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Data and other attributes defined here:
- entry = [<class 'gdata.contentforshopping.data.InventoryEntry'>]
- items_per_page = <class 'gdata.contentforshopping.data.ItemsPerPage'>
- start_index = <class 'gdata.contentforshopping.data.StartIndex'>
- total_results = <class 'gdata.contentforshopping.data.TotalResults'>
Methods inherited from gdata.data.BatchFeed:
- AddBatchEntry = add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None)
- Logic for populating members of a BatchEntry and adding to the feed.
If the entry is not a BatchEntry, it is converted to a BatchEntry so
that the batch specific members will be present.
The id_url_string can be used in place of an entry if the batch operation
applies to a URL. For example query and delete operations require just
the URL of an entry, no body is sent in the HTTP request. If an
id_url_string is sent instead of an entry, a BatchEntry is created and
added to the feed.
This method also assigns the desired batch id to the entry so that it
can be referenced in the server's response. If the batch_id_string is
None, this method will assign a batch_id to be the index at which this
entry will be in the feed's entry list.
Args:
entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional)
The entry which will be sent to the server as part of the batch
request. The item must have a valid atom id so that the server
knows which entry this request references.
id_url_string: str (optional) The URL of the entry to be acted on. You
can find this URL in the text member of the atom id for an entry.
If an entry is not sent, this id will be used to construct a new
BatchEntry which will be added to the request feed.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. Note that batch_ids should either always be specified or
never, mixing could potentially result in duplicate batch ids.
operation_string: str (optional) The desired batch operation which will
set the batch_operation.type member of the entry. Options are
'insert', 'update', 'delete', and 'query'
Raises:
MissingRequiredParameters: Raised if neither an id_ url_string nor an
entry are provided in the request.
Returns:
The added entry.
- AddDelete = add_delete(self, url_string=None, entry=None, batch_id_string=None)
- Adds a delete request to the batch request feed.
This method takes either the url_string which is the atom id of the item
to be deleted, or the entry itself. The atom id of the entry must be
present so that the server knows which entry should be deleted.
Args:
url_string: str (optional) The URL of the entry to be deleted. You can
find this URL in the text member of the atom id for an entry.
entry: BatchEntry (optional) The entry to be deleted.
batch_id_string: str (optional)
Raises:
MissingRequiredParameters: Raised if neither a url_string nor an entry
are provided in the request.
- AddInsert = add_insert(self, entry, batch_id_string=None)
- Add an insert request to the operations in this batch request feed.
If the entry doesn't yet have an operation or a batch id, these will
be set to the insert operation and a batch_id specified as a parameter.
Args:
entry: BatchEntry The entry which will be sent in the batch feed as an
insert request.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. Note that batch_ids should either always be specified or
never, mixing could potentially result in duplicate batch ids.
- AddQuery = add_query(self, url_string=None, entry=None, batch_id_string=None)
- Adds a query request to the batch request feed.
This method takes either the url_string which is the query URL
whose results will be added to the result feed. The query URL will
be encapsulated in a BatchEntry, and you may pass in the BatchEntry
with a query URL instead of sending a url_string.
Args:
url_string: str (optional)
entry: BatchEntry (optional)
batch_id_string: str (optional)
Raises:
MissingRequiredParameters
- AddUpdate = add_update(self, entry, batch_id_string=None)
- Add an update request to the list of batch operations in this feed.
Sets the operation type of the entry to insert if it is not already set
and assigns the desired batch id to the entry so that it can be
referenced in the server's response.
Args:
entry: BatchEntry The entry which will be sent to the server as an
update (HTTP PUT) request. The item must have a valid atom id
so that the server knows which entry to replace.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. See also comments for AddInsert.
- FindBatchLink = find_batch_link(self)
- add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None)
- Logic for populating members of a BatchEntry and adding to the feed.
If the entry is not a BatchEntry, it is converted to a BatchEntry so
that the batch specific members will be present.
The id_url_string can be used in place of an entry if the batch operation
applies to a URL. For example query and delete operations require just
the URL of an entry, no body is sent in the HTTP request. If an
id_url_string is sent instead of an entry, a BatchEntry is created and
added to the feed.
This method also assigns the desired batch id to the entry so that it
can be referenced in the server's response. If the batch_id_string is
None, this method will assign a batch_id to be the index at which this
entry will be in the feed's entry list.
Args:
entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional)
The entry which will be sent to the server as part of the batch
request. The item must have a valid atom id so that the server
knows which entry this request references.
id_url_string: str (optional) The URL of the entry to be acted on. You
can find this URL in the text member of the atom id for an entry.
If an entry is not sent, this id will be used to construct a new
BatchEntry which will be added to the request feed.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. Note that batch_ids should either always be specified or
never, mixing could potentially result in duplicate batch ids.
operation_string: str (optional) The desired batch operation which will
set the batch_operation.type member of the entry. Options are
'insert', 'update', 'delete', and 'query'
Raises:
MissingRequiredParameters: Raised if neither an id_ url_string nor an
entry are provided in the request.
Returns:
The added entry.
- add_delete(self, url_string=None, entry=None, batch_id_string=None)
- Adds a delete request to the batch request feed.
This method takes either the url_string which is the atom id of the item
to be deleted, or the entry itself. The atom id of the entry must be
present so that the server knows which entry should be deleted.
Args:
url_string: str (optional) The URL of the entry to be deleted. You can
find this URL in the text member of the atom id for an entry.
entry: BatchEntry (optional) The entry to be deleted.
batch_id_string: str (optional)
Raises:
MissingRequiredParameters: Raised if neither a url_string nor an entry
are provided in the request.
- add_insert(self, entry, batch_id_string=None)
- Add an insert request to the operations in this batch request feed.
If the entry doesn't yet have an operation or a batch id, these will
be set to the insert operation and a batch_id specified as a parameter.
Args:
entry: BatchEntry The entry which will be sent in the batch feed as an
insert request.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. Note that batch_ids should either always be specified or
never, mixing could potentially result in duplicate batch ids.
- add_query(self, url_string=None, entry=None, batch_id_string=None)
- Adds a query request to the batch request feed.
This method takes either the url_string which is the query URL
whose results will be added to the result feed. The query URL will
be encapsulated in a BatchEntry, and you may pass in the BatchEntry
with a query URL instead of sending a url_string.
Args:
url_string: str (optional)
entry: BatchEntry (optional)
batch_id_string: str (optional)
Raises:
MissingRequiredParameters
- add_update(self, entry, batch_id_string=None)
- Add an update request to the list of batch operations in this feed.
Sets the operation type of the entry to insert if it is not already set
and assigns the desired batch id to the entry so that it can be
referenced in the server's response.
Args:
entry: BatchEntry The entry which will be sent to the server as an
update (HTTP PUT) request. The item must have a valid atom id
so that the server knows which entry to replace.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. See also comments for AddInsert.
- find_batch_link(self)
Data and other attributes inherited from gdata.data.BatchFeed:
- interrupted = <class 'gdata.data.BatchInterrupted'>
- The batch:interrupted element sent if batch request was interrupted.
Only appears in a feed if some of the batch entries could not be processed.
See: http://code.google.com/apis/gdata/batch.html#Handling_Errors
Methods inherited from gdata.data.GDFeed:
- GetId = get_id(self)
- get_generator(self)
- get_id(self)
Data and other attributes inherited from gdata.data.GDFeed:
- etag = '{http://schemas.google.com/g/2005}etag'
Data and other attributes inherited from atom.data.Source:
- generator = <class 'atom.data.Generator'>
- The atom:generator element.
- icon = <class 'atom.data.Icon'>
- The atom:icon element.
- logo = <class 'atom.data.Logo'>
- The atom:logo element.
- subtitle = <class 'atom.data.Subtitle'>
- The atom:subtitle element.
Methods inherited from atom.data.FeedEntryParent:
- __init__(self, atom_id=None, text=None, *args, **kwargs)
Data and other attributes inherited from atom.data.FeedEntryParent:
- author = [<class 'atom.data.Author'>]
- category = [<class 'atom.data.Category'>]
- contributor = [<class 'atom.data.Contributor'>]
- id = <class 'atom.data.Id'>
- The atom:id element.
- link = [<class 'atom.data.Link'>]
- rights = <class 'atom.data.Rights'>
- The atom:rights element.
- title = <class 'atom.data.Title'>
- The atom:title element.
- updated = <class 'atom.data.Updated'>
- The atom:updated element.
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
Methods inherited from gdata.data.LinkFinder:
- FindAclLink = find_acl_link(self)
- FindFeedLink = find_feed_link(self)
- FindHtmlLink = find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- FindPostLink = find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- FindPreviousLink = find_previous_link(self)
- GetAclLink = get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- GetFeedLink = get_feed_link(self)
- GetHtmlLink = get_html_link(self)
- GetPostLink = get_post_link(self)
- GetPreviousLink = get_previous_link(self)
- find_acl_link(self)
- find_feed_link(self)
- find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- find_previous_link(self)
- get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- get_feed_link(self)
- get_html_link(self)
- get_post_link(self)
- get_previous_link(self)
Methods inherited from atom.data.LinkFinder:
- FindAlternateLink = find_alternate_link(self)
- FindEditLink = find_edit_link(self)
- FindEditMediaLink = find_edit_media_link(self)
- FindLicenseLink = find_license_link(self)
- FindNextLink = find_next_link(self)
- FindSelfLink = find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- FindUrl = find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- GetAlternateLink = get_alternate_link(self)
- GetEditLink = get_edit_link(self)
- GetEditMediaLink = get_edit_media_link(self)
- GetLicenseLink = get_license_link(self)
- GetLink = get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- GetNextLink = get_next_link(self)
- GetSelfLink = get_self_link(self)
- find_alternate_link(self)
- find_edit_link(self)
- find_edit_media_link(self)
- find_license_link(self)
- find_next_link(self)
- find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- get_alternate_link(self)
- get_edit_link(self)
- get_edit_media_link(self)
- get_license_link(self)
- get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- get_next_link(self)
- get_self_link(self)
|
class Issue(atom.core.XmlElement) |
| |
sc:issue element |
| |
- Method resolution order:
- Issue
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- example_item = [<class 'gdata.contentforshopping.data.ExampleItem'>]
- id = 'id'
- last_checked = 'last_checked'
- num_items = 'num_items'
- offending_term = 'offending_term'
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class IssueGroup(atom.core.XmlElement) |
| |
sc:issue_group element |
| |
- Method resolution order:
- IssueGroup
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- country = 'country'
- id = 'id'
- issue = [<class 'gdata.contentforshopping.data.Issue'>]
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class IssueGroups(atom.core.XmlElement) |
| |
sc:issue_groups element |
| |
- Method resolution order:
- IssueGroups
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- issue_group = [<class 'gdata.contentforshopping.data.IssueGroup'>]
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class ItemGroupID(atom.core.XmlElement) |
| |
scp:item_group_id element
The identifier for products with variants. This id is used to link items which
have different values for the fields:
'color', 'material', 'pattern', 'size'
but are the same item, for example a shirt with different sizes.
Note: This tag is required for all product variants. |
| |
- Method resolution order:
- ItemGroupID
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class ItemId(atom.core.XmlElement) |
| |
sc:item_id element |
| |
- Method resolution order:
- ItemId
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class ItemsPerPage(gdata.data.ItemsPerPage) |
| | |
- Method resolution order:
- ItemsPerPage
- gdata.data.ItemsPerPage
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Location(atom.core.XmlElement) |
| |
sc:location element
The name of the product element that has raised the warning. This may be
any valid product element. |
| |
- Method resolution order:
- Location
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Manufacturer(atom.core.XmlElement) |
| |
scp:manufacturer element
Manufacturer of the product. |
| |
- Method resolution order:
- Manufacturer
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Material(atom.core.XmlElement) |
| |
scp:material element
The material the product is made of. |
| |
- Method resolution order:
- Material
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Message(atom.core.XmlElement) |
| |
sc:message element
A plain text description of the warning. |
| |
- Method resolution order:
- Message
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Mpn(atom.core.XmlElement) |
| |
scp:mpn element
Manufacturer's Part Number. A unique code determined by the manufacturer for
the product. |
| |
- Method resolution order:
- Mpn
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Multipack(atom.core.XmlElement) |
| |
scp:ultipack element
The number of products in a merchant-defined custom multipack |
| |
- Method resolution order:
- Multipack
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Pattern(atom.core.XmlElement) |
| |
scp:pattern element
The pattern of the product. (e.g. polka dots) |
| |
- Method resolution order:
- Pattern
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Performance(atom.core.XmlElement) |
| |
sc:performance element
Container element for daily click data. |
| |
- Method resolution order:
- Performance
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- datapoint = [<class 'gdata.contentforshopping.data.Datapoint'>]
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Permission(atom.core.XmlElement) |
| |
sc:permission element |
| |
- Method resolution order:
- Permission
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- scope = 'scope'
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Price(atom.core.XmlElement) |
| |
scp:price element
The price of the product. The unit attribute must be set, and should represent
the currency.
Note: Required Element |
| |
- Method resolution order:
- Price
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- unit = 'unit'
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class ProcessingStatus(atom.core.XmlElement) |
| |
sc:processing_status element |
| |
- Method resolution order:
- ProcessingStatus
- atom.core.XmlElement
- __builtin__.object
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class ProductControl(atom.data.Control) |
| |
app:control element
overridden to provide additional elements in the sc namespace. |
| |
- Method resolution order:
- ProductControl
- atom.data.Control
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- excluded_destination = [<class 'gdata.contentforshopping.data.ExcludedDestination'>]
- required_destination = [<class 'gdata.contentforshopping.data.RequiredDestination'>]
- status = [<class 'gdata.contentforshopping.data.Status'>]
- validate_destination = [<class 'gdata.contentforshopping.data.ValidateDestination'>]
- warnings = <class 'gdata.contentforshopping.data.Warnings'>
- sc:warnings element
Container element for the list of warnings.
Data and other attributes inherited from atom.data.Control:
- draft = <class 'atom.data.Draft'>
- The app:draft element which indicates if this entry should be public.
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class ProductEntry(gdata.data.BatchEntry) |
| |
Product entry containing product information
The elements of this entry that are used are made up of five different
namespaces. They are:
atom: - Atom
app: - Atom Publishing Protocol
gd: - Google Data API
sc: - Content API for Shopping, general attributes
scp: - Content API for Shopping, product attributes
Only the sc and scp namespace elements are defined here, but additional useful
elements are defined in superclasses.
The following attributes are encoded as XML elements in the Atomn (atom:)
namespace: title, link, entry, id, category, content, author, created
updated. Among these, the title, content and link tags are part of the
required Content for Shopping API so we document them here.
.. attribute:: title
The title of the product.
This should be a :class:`atom.data.Title` element, for example::
entry = ProductEntry()
entry.title = atom.data.Title(u'32GB MP3 Player')
.. attribute:: content
The description of the item.
This should be a :class:`atom.data.Content` element, for example::
entry = ProductEntry()
entry.content = atom.data.Content('My item description')
.. attribute:: link
A link to a page where the item can be purchased.
This should be a :class:`atom.data.Link` element, for example::
link = atom.data.Link(rel='alternate', type='text/html',
href='http://www.somehost.com/123456jsh9')
entry = ProductEntry()
entry.link.append(link)
.. attribute:: additional_image_link
A list of additional links to images of the product. Each link should be an
:class:`AdditionalImageLink` element, for example::
entry = ProductEntry()
entry.additional_image_link.append(
AdditionalImageLink('http://myshop/cdplayer.jpg'))
.. attribute:: author
The author of the product.
This should be a :class:`Author` element, for example::
entry = ProductEntry()
entry.author = atom.data.Author(u'Isaac Asimov')
.. attribute:: attribute
List of generic attributes.
This should be a list of :class:`Attribute` elements, for example::
attribute = Attribute('foo')
attribute.name = 'bar'
attribute.type = 'baz'
attribute.unit = 'kg'
entry = ProductEntry()
entry.attributes.append(attribute)
.. attribute:: availability
The avilability of a product.
This should be an :class:`Availability` instance, for example::
entry = ProductEntry()
entry.availability = Availability('in stock')
.. attribute:: brand
The brand of a product.
This should be a :class:`Brand` element, for example::
entry = ProductEntry()
entry.brand = Brand(u'Sony')
.. attribute:: channel
The channel for the product. Supported values are: 'online', 'local'
This should be a :class:`Channel` element, for example::
entry = ProductEntry()
entry.channel = Channel('online')
.. attribute:: color
The color of a product.
This should be a :class:`Color` element, for example::
entry = ProductEntry()
entry.color = Color(u'purple')
.. attribute:: condition
The condition of a product.
This should be a :class:`Condition` element, for example::
entry = ProductEntry()
entry.condition = Condition(u'new')
.. attribute:: content_language
The language for the product.
This should be a :class:`ContentLanguage` element, for example::
entry = ProductEntry()
entry.content_language = ContentLanguage('EN')
.. attribute:: control
Overrides :class:`atom.data.Control` to provide additional elements
required_destination and excluded_destination in the sc namespace
This should be a :class:`ProductControl` element.
.. attribute:: edition
The edition of the product.
This should be a :class:`Edition` element, for example::
entry = ProductEntry()
entry.edition = Edition('1')
.. attribute:: expiration_date
The expiration date of this product listing.
This should be a :class:`ExpirationDate` element, for example::
entry = ProductEntry()
entry.expiration_date = ExpirationDate('2011-22-03')
.. attribute:: feature
A list of features for this product.
Each feature should be a :class:`Feature` element, for example::
entry = ProductEntry()
entry.feature.append(Feature(u'wifi'))
entry.feature.append(Feature(u'gps'))
.. attribute:: featured_product
Whether the product is featured.
This should be a :class:`FeaturedProduct` element, for example::
entry = ProductEntry()
entry.featured_product = FeaturedProduct('true')
.. attribute:: gender
The gender for the item. Supported values are: 'unisex', 'female', 'male'
This should be a :class:`Gender` element, for example::
entry = ProductEntry()
entry.gender = Gender('female')
.. attribute:: genre
The genre of the product.
This should be a :class:`Genre` element, for example::
entry = ProductEntry()
entry.genre = Genre(u'comedy')
.. attribute:: google_product_category
The product's google category. Value must come from taxonomy listed at
http://www.google.com/support/merchants/bin/answer.py?answer=160081
This should be a :class:`GoogleProductCategory` element, for example::
entry = ProductEntry()
entry.google_product_category = GoogleProductCategory(
'Animals > Live Animals')
.. attribute:: gtin
The gtin for this product.
This should be a :class:`Gtin` element, for example::
entry = ProductEntry()
entry.gtin = Gtin('A888998877997')
.. attribute:: image_link
A link to the product image. This link should be an
:class:`ImageLink` element, for example::
entry = ProductEntry()
entry.image_link = ImageLink('http://myshop/cdplayer.jpg')
.. attribute:: item_group_id
The identifier for products with variants. This id is used to link items
which have different values for the fields:
'color', 'material', 'pattern', 'size'
but are the same item, for example a shirt with different sizes.
This should be a :class:`ItemGroupID` element, for example::
entry = ProductEntry()
entry.item_group_id = ItemGroupID('R1726122')
.. attribute:: manufacturer
The manufacturer of the product.
This should be a :class:`Manufacturer` element, for example::
entry = ProductEntry()
entry.manufacturer = Manufacturer('Sony')
.. attribute:: material
The material the product is made of.
This should be a :class:`Material` element, for example::
entry = ProductEntry()
entry.material = Material('cotton')
.. attribute:: mpn
The manufacturer's part number for this product.
This should be a :class:`Mpn` element, for example::
entry = ProductEntry()
entry.mpn = Mpn('cd700199US')
.. attribute:: pattern
The pattern of the product.
This should be a :class:`Pattern` element, for example::
entry = ProductEntry()
entry.pattern = Pattern('polka dots')
.. attribute:: performance
The performance of the product.
This should be a :class:`Performance` element.
.. attribute:: price
The price for this product.
This should be a :class:`Price` element, including a unit argument to
indicate the currency, for example::
entry = ProductEntry()
entry.price = Price('20.00', unit='USD')
.. attribute:: product_id
A link to the product image. This link should be an
:class:`ProductId` element, for example::
entry = ProductEntry()
entry.product_id = ProductId('ABC1234')
.. attribute:: product_type
The type of product.
This should be a :class:`ProductType` element, for example::
entry = ProductEntry()
entry.product_type = ProductType("Electronics > Video > Projectors")
.. attribute:: quantity
The quantity of product available in stock.
This should be a :class:`Quantity` element, for example::
entry = ProductEntry()
entry.quantity = Quantity('100')
.. attribute:: shipping
The shipping rules for the product.
This should be a :class:`Shipping` with the necessary rules embedded as
elements, for example::
shipping = Shipping()
shipping.shipping_price = ShippingPrice('10.00', unit='USD')
entry = ProductEntry()
entry.shipping.append(shipping)
.. attribute:: shipping_weight
The shipping weight for this product.
This should be a :class:`ShippingWeight` element, including a unit parameter
for the unit of weight, for example::
entry = ProductEntry()
entry.shipping_weight = ShippingWeight('10.45', unit='kg')
.. attribute:: size
A list of the available sizes for this product.
Each item in this list should be a :class:`Size` element, for example::
entry = ProductEntry()
entry.size.append(Size('Small'))
entry.size.append(Size('Medium'))
entry.size.append(Size('Large'))
.. attribute:: target_country
The target country for the product.
This should be a :class:`TargetCountry` element, for example::
entry = ProductEntry()
entry.target_country = TargetCountry('US')
.. attribute:: tax
The tax rules for this product.
This should be a :class:`Tax` element, with the tax rule elements embedded
within, for example::
tax = Tax()
tax.tax_rate = TaxRate('17.5')
entry = ProductEntry()
entry.tax.append(tax)
.. attribute:: year
The year the product was created.
This should be a :class:`Year` element, for example::
entry = ProductEntry()
entry.year = Year('2001') |
| |
- Method resolution order:
- ProductEntry
- gdata.data.BatchEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- GetBatchErrors = get_batch_errors(self)
- get_batch_errors(self)
- Attempts to parse errors from atom:content element.
If the atom:content element is type application/vnd.google.gdata.error+xml,
then it will contain a gd:errors block.
Returns:
If the type of the content element is not
'application/vnd.google.gdata.error+xml', or 0 or more than 1
gd:errors elements are found within the <content type='app...'> block,
then None is returned. Other wise, the gd:errors element parsed
as a ContentForShoppingErrors object is returned.
Data and other attributes defined here:
- additional_image_link = [<class 'gdata.contentforshopping.data.AdditionalImageLink'>]
- attribute = [<class 'gdata.contentforshopping.data.Attribute'>]
- author = <class 'gdata.contentforshopping.data.Author'>
- scp:author element
Defines the author of the information, recommended for books.
- availability = <class 'gdata.contentforshopping.data.Availability'>
- scp:availability element
The retailer's suggested label for product availability. Supported values
include: 'in stock', 'out of stock', 'limited availability',
'available for order', and 'preorder'.
- brand = <class 'gdata.contentforshopping.data.Brand'>
- scp:brand element
The brand of the product
- channel = <class 'gdata.contentforshopping.data.Channel'>
- sc:channel element
The channel for the product. Supported values are: 'online', 'local'
- color = <class 'gdata.contentforshopping.data.Color'>
- scp:color element
The color of the product.
- condition = <class 'gdata.contentforshopping.data.Condition'>
- scp:condition element
The condition of the product, one of "new", "used", "refurbished"
- content_language = <class 'gdata.contentforshopping.data.ContentLanguage'>
- sc:content_language element
Language used in the item content for the product
- control = <class 'gdata.contentforshopping.data.ProductControl'>
- app:control element
overridden to provide additional elements in the sc namespace.
- edition = <class 'gdata.contentforshopping.data.Edition'>
- scp:edition element
The edition of the product. Recommended for products with multiple editions
such as collectors' editions etc, such as books.
- energy_efficiency_class = <class 'gdata.contentforshopping.data.EnergyEfficiencyClass'>
- scp:energy_efficiency_class element
The item's energy efficiency class.
- expiration_date = <class 'gdata.contentforshopping.data.ExpirationDate'>
- sc:expiration_date
This is the date when the product listing will expire. If omitted, this will
default to 30 days after the product was created.
- feature = [<class 'gdata.contentforshopping.data.Feature'>]
- featured_product = <class 'gdata.contentforshopping.data.FeaturedProduct'>
- scp:featured_product element
Used to indicate that this item is a special, featured product; Supported
values are: "true", "false".
- gender = <class 'gdata.contentforshopping.data.Gender'>
- scp:gender element
The gender for the item. Supported values are: 'unisex', 'female', 'male'
Note: This tag is required if the google product type is part of
Apparel & Accessories.
- genre = <class 'gdata.contentforshopping.data.Genre'>
- scp:genre element
Describes the genre of a product, eg "comedy". Strongly recommended for media.
- google_product_category = <class 'gdata.contentforshopping.data.GoogleProductCategory'>
- scp:google_product_category element
The product's google category. The value must be one of the categories listed
in the Product type taxonomy, which can be found at
http://www.google.com/support/merchants/bin/answer.py?answer=160081.
Note that & and > characters must be encoded as & and >
- group = [<class 'gdata.contentforshopping.data.Group'>]
- gtin = <class 'gdata.contentforshopping.data.Gtin'>
- scp:gtin element
GTIN of the product (isbn/upc/ean)
- identifier_exists = <class 'gdata.contentforshopping.data.IdentifierExists'>
- scp:identifier_exists element
Specify as true if the item has no manufacturer part number or
any other industry standard product identifier.
- image_link = <class 'gdata.contentforshopping.data.ImageLink'>
- sc:image_link element
This is the URL of an associated image for a product. Please use full size
images (400x400 pixels or larger), not thumbnails.
- item_group_id = <class 'gdata.contentforshopping.data.ItemGroupID'>
- scp:item_group_id element
The identifier for products with variants. This id is used to link items which
have different values for the fields:
'color', 'material', 'pattern', 'size'
but are the same item, for example a shirt with different sizes.
Note: This tag is required for all product variants.
- manufacturer = <class 'gdata.contentforshopping.data.Manufacturer'>
- scp:manufacturer element
Manufacturer of the product.
- material = <class 'gdata.contentforshopping.data.Material'>
- scp:material element
The material the product is made of.
- mpn = <class 'gdata.contentforshopping.data.Mpn'>
- scp:mpn element
Manufacturer's Part Number. A unique code determined by the manufacturer for
the product.
- multipack = <class 'gdata.contentforshopping.data.Multipack'>
- scp:ultipack element
The number of products in a merchant-defined custom multipack
- pattern = <class 'gdata.contentforshopping.data.Pattern'>
- scp:pattern element
The pattern of the product. (e.g. polka dots)
- performance = <class 'gdata.contentforshopping.data.Performance'>
- sc:performance element
Container element for daily click data.
- price = <class 'gdata.contentforshopping.data.Price'>
- scp:price element
The price of the product. The unit attribute must be set, and should represent
the currency.
Note: Required Element
- product_id = <class 'gdata.contentforshopping.data.ProductId'>
- sc:id element
It is required that all inserted products are provided with a unique
alphanumeric ID, in this element.
- product_type = <class 'gdata.contentforshopping.data.ProductType'>
- scp:product_type element
Describes the type of product. A taxonomy of available product types is