eBay::API::XML::Call::GetPopularKeywords - eBay::API::XML::Call::GetPopularKeywords documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetPopularKeywords

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetPopularKeywords inherits from the eBay::API::XML::BaseCall class

Subroutines:

Top

setCategoryID()

A category ID for which you want keywords returned. When IncludeChildCategories is true, one and only one CategoryID is allowed. Otherwise, up to 100 CategoryIds are allowed. To retrieve the keywords for root category, set one of the CategoryIDs to -1 or submit no CategoryIDs at all.

MaxLength: 10

  RequiredInput: No
#    Argument: reference to an array  
                      of 'xs:string'

setIncludeChildCategories()

If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories. If false, keywords are returned only for the categories identified by CategoryID. Default is false.

  RequiredInput: No
#    Argument: 'xs:boolean'

setMaxKeywordsRetrieved()

The maximum number of keywords to be retrieved per category for this call.

Max: 1000 Default: 20 Min: 1

  RequiredInput: No
#    Argument: 'xs:int'

setPagination()

Details about how many categories to return per page and which page to view.

  RequiredInput: No
#    Argument: 'ns:PaginationType'

getCategoryArray()

Organization of keywords by category. For each category, its ID and its parent's ID and keywords are listed.

  Returned: Always
#    Returns: 'ns:CategoryArrayType'

isHasMore()

Indicates whether there are more categories beyond the subset returned in the last call to GetPopularKeywords. Returned only when IncludeChildCategories is true.

  Returned: Conditionally
#    Returns: 'xs:boolean'

getPaginationResult()

Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries.

  Returned: Conditionally
#    Returns: 'ns:PaginationResultType'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::Call::GetPopularKeywords;

use strict;
use warnings;  

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


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

use eBay::API::XML::Call::GetPopularKeywords::GetPopularKeywordsRequestType;
use eBay::API::XML::Call::GetPopularKeywords::GetPopularKeywordsResponseType;



sub getApiCallName {
   return 'GetPopularKeywords';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetPopularKeywords::GetPopularKeywordsRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetPopularKeywords::GetPopularKeywordsResponseType';
}

#
# input properties
#


       
sub setCategoryID {
   my $self   = shift;
   my $sCategoryID = shift;
   $self->getRequestDataType()->setCategoryID($sCategoryID);
}


       
sub setIncludeChildCategories {
   my $self   = shift;
   my $sIncludeChildCategories = shift;
   $self->getRequestDataType()->setIncludeChildCategories($sIncludeChildCategories);
}


       
sub setMaxKeywordsRetrieved {
   my $self   = shift;
   my $sMaxKeywordsRetrieved = shift;
   $self->getRequestDataType()->setMaxKeywordsRetrieved($sMaxKeywordsRetrieved);
}


       
sub setPagination {
   my $self   = shift;
   my $pPagination = shift;
   $self->getRequestDataType()->setPagination($pPagination);
}



#
# output properties
#


       
sub getCategoryArray {
   my $self = shift;
   return $self->getResponseDataType()->getCategoryArray();
}


       
sub isHasMore {
   my $self = shift;
   return $self->getResponseDataType()->isHasMore();
}


       
sub getPaginationResult {
   my $self = shift;
   return $self->getResponseDataType()->getPaginationResult();
}





1;