Changes since
the last release

com.ebay.sdk.call
Class GetContextualKeywordsCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetContextualKeywordsCall

public class GetContextualKeywordsCall
extends ApiCall

Wrapper class of the GetContextualKeywords call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: URL - The URL of the web page from which eBay is to extract keywords.
Input property: Encoding - Web page encoding by which the URL is to be handled, such as ISO-8859-1.
Input property: CategoryID - The ID of the category to which keywords are to be limited. Zero or more category IDs can be specified.
Output property: ReturnedContextSearchAsset - An array of either keyword/category pairs or categories, with ranking and score.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetContextualKeywordsCall()
          Constructor.
GetContextualKeywordsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String[] getCategoryID()
          Gets the GetContextualKeywordsRequestType.categoryID.
 ContextSearchAssetType[] getContextualKeywords()
          Retrieves top-ranked contextual eBay keywords and categories for a specified web page.
 java.lang.String getEncoding()
          Gets the GetContextualKeywordsRequestType.encoding.
 ContextSearchAssetType[] getReturnedContextSearchAsset()
          Valid after executing the API.
 java.lang.String getURL()
          Gets the GetContextualKeywordsRequestType.uRL.
 void setCategoryID(java.lang.String[] categoryID)
          Sets the GetContextualKeywordsRequestType.categoryID.
 void setEncoding(java.lang.String encoding)
          Sets the GetContextualKeywordsRequestType.encoding.
 void setURL(java.lang.String uRL)
          Sets the GetContextualKeywordsRequestType.uRL.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetContextualKeywordsCall

public GetContextualKeywordsCall()
Constructor.


GetContextualKeywordsCall

public GetContextualKeywordsCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getContextualKeywords

public ContextSearchAssetType[] getContextualKeywords()
                                               throws ApiException,
                                                      SdkException,
                                                      java.lang.Exception
Retrieves top-ranked contextual eBay keywords and categories for a specified web page.

Returns:
The ContextSearchAssetType[] object.
Throws:
ApiException
SdkException
java.lang.Exception

getCategoryID

public java.lang.String[] getCategoryID()
Gets the GetContextualKeywordsRequestType.categoryID.

Returns:
String[]

setCategoryID

public void setCategoryID(java.lang.String[] categoryID)
Sets the GetContextualKeywordsRequestType.categoryID.

Parameters:
categoryID - String[]

getEncoding

public java.lang.String getEncoding()
Gets the GetContextualKeywordsRequestType.encoding.

Returns:
String

setEncoding

public void setEncoding(java.lang.String encoding)
Sets the GetContextualKeywordsRequestType.encoding.

Parameters:
encoding - String

getURL

public java.lang.String getURL()
Gets the GetContextualKeywordsRequestType.uRL.

Returns:
String

setURL

public void setURL(java.lang.String uRL)
Sets the GetContextualKeywordsRequestType.uRL.

Parameters:
uRL - String

getReturnedContextSearchAsset

public ContextSearchAssetType[] getReturnedContextSearchAsset()
Valid after executing the API. Gets the returned GetContextualKeywordsResponseType.returnedContextSearchAsset.

Returns:
ContextSearchAssetType[]

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.