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
System.Object
ClientServiceRequest
ClientServiceRequest<ListCollectionsResponse>
ShoppingContentBaseServiceRequest<ListCollectionsResponse>
CollectionsResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.ShoppingContent.v2_1
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class ListRequest : ShoppingContentBaseServiceRequest<ListCollectionsResponse>, IClientServiceRequest<ListCollectionsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, Int64)

Constructs a new List request.

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

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.ShoppingContent.v2_1.Data.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
System.Int64

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.ShoppingContent.v2_1.Data.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
System.Nullable<System.Int32>

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
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.ShoppingContent.v2_1.Data.ListCollectionsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.ShoppingContent.v2_1.ShoppingContentBaseServiceRequest<Google.Apis.ShoppingContent.v2_1.Data.ListCollectionsResponse>.InitParameters()

Implements