Show / Hide Table of Contents

Class CollectionsResource.ListRequest

Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListCollectionsResponse>
ShoppingContentBaseServiceRequest<ListCollectionsResponse>
CollectionsResource.ListRequest
Implements
IClientServiceRequest<ListCollectionsResponse>
IClientServiceRequest
Inherited Members
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.Xgafv
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.AccessToken
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.Alt
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.Callback
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.Fields
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.Key
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.OauthToken
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.PrettyPrint
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.QuotaUser
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.UploadType
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.UploadProtocol
ClientServiceRequest<ListCollectionsResponse>.Execute()
ClientServiceRequest<ListCollectionsResponse>.ExecuteAsStream()
ClientServiceRequest<ListCollectionsResponse>.ExecuteAsync()
ClientServiceRequest<ListCollectionsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListCollectionsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListCollectionsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListCollectionsResponse>.CreateRequest(bool?)
ClientServiceRequest<ListCollectionsResponse>.GenerateRequestUri()
ClientServiceRequest<ListCollectionsResponse>.GetBody()
ClientServiceRequest<ListCollectionsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListCollectionsResponse>.ETagAction
ClientServiceRequest<ListCollectionsResponse>.ModifyRequest
ClientServiceRequest<ListCollectionsResponse>.ValidateParameters
ClientServiceRequest<ListCollectionsResponse>.ApiVersion
ClientServiceRequest<ListCollectionsResponse>.RequestParameters
ClientServiceRequest<ListCollectionsResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.ShoppingContent.v2_1
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class CollectionsResource.ListRequest : ShoppingContentBaseServiceRequest<ListCollectionsResponse>, IClientServiceRequest<ListCollectionsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, long)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, long merchantId)
Parameters
Type Name Description
IClientService service
long merchantId

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListCollectionsResponse>.HttpMethod

MerchantId

Required. The ID of the account that contains the collection. This account cannot be a multi-client account.

Declaration
[RequestParameter("merchantId", RequestParameterType.Path)]
public virtual long MerchantId { get; }
Property Value
Type Description
long

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListCollectionsResponse>.MethodName

PageSize

The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListCollectionsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
ShoppingContentBaseServiceRequest<ListCollectionsResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX