GetContextualKeywords

Use this call to retrieve top-ranked contextual eBay keywords and categories for a specified web page.

eBay AdContext was developed using eBay's relevant keyword selection technology, which uses proprietary eBay data to match relevant eBay ads to the content of the Web page. The contextual ads take into account the popularity of certain keywords on eBay, not just the keywords on a given Web site, making them relevant to what people are actually shopping for on eBay.

Results can come in two forms: category/keyword pairs and just categories. There is separate ranking for each of these forms.

The results from this call are ranked according to score. This enables developers to create applications that are different from traditional contextual ad serving. For instance, instead of building a standard ad banner or skyscraper ad like those from eBay AdContext, a developer could create an application that does inline hyperlinking of keywords on any page or create widgets for blog platforms.

There is no limit on the number of ContextSearchAssets that may be returned. It is also possible that none will be returned for a given URL.

You can test this call in the sandbox. Provide your choice of web site URL and the value ISO-8859-1 for Encoding. Parse results for pairing of categories/keywords versus just categories.

At this time, the call is available for all sites except SG and HK.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetContextualKeywordsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <CategoryID> string </CategoryID>
  <!-- ... more CategoryID values allowed here ... -->
  <Encoding> string </Encoding>
  <URL> anyURI </URL>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetContextualKeywordsRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetContextualKeywordsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <ContextSearchAsset> ContextSearchAssetType
    <Category> CategoryType
      <CategoryID> string </CategoryID>
      <CategoryName> string </CategoryName>
    </Category>
    <Keyword> string </Keyword>
    <Ranking> int </Ranking>
  </ContextSearchAsset>
  <!-- ... more ContextSearchAsset nodes allowed here ... -->
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetContextualKeywordsResponse>

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Returns the contextual keywords for a world-famous web site.

Description

Input

XML format.

<?xml version="1.0" encoding="utf-8"?> 
<GetContextualKeywordsRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials> 
  <URL>http://www.phoons.com/formaloutfit.html</URL> 
  <Encoding>ISO-8859-1</Encoding> 
</GetContextualKeywordsRequest>

Output

XML format.
<GetContextualKeywordsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-04T20:29:57.517Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_API6_19105226_R1</Build>
  <ContextSearchAsset>
    <Keyword>laptop</Keyword>
    <Category>
      <CategoryID>58058</CategoryID>
      <CategoryName>Computers &amp; Networking</CategoryName>
    </Category>
    <Ranking>1</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>laptop computer</Keyword>
    <Category>
      <CategoryID>58058</CategoryID>
      <CategoryName>Computers &amp; Networking</CategoryName>
    </Category>
    <Ranking>2</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>shoes</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>3</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>boots</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>4</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>jordan</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>5</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>women shoes</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>6</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>coach handbags</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>7</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>ralph lauren</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>8</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>nike</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>9</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Keyword>dress</Keyword>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>10</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Category>
      <CategoryID>58058</CategoryID>
      <CategoryName>Computers &amp; Networking</CategoryName>
    </Category>
    <Ranking>1</Ranking>
  </ContextSearchAsset>
  <ContextSearchAsset>
    <Category>
      <CategoryID>11450</CategoryID>
      <CategoryName>Clothing, Shoes &amp; Accessories</CategoryName>
    </Category>
    <Ranking>2</Ranking>
  </ContextSearchAsset>
</GetContextualKeywordsResponse>

Change History