Class InventoryItemsResource.ListRequest
Retrieves a list of inventory items, possibly filtered. This method supports paging.
Inheritance
System.Object
InventoryItemsResource.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.Dfareporting.v3_3
Assembly: Google.Apis.Dfareporting.v3_3.dll
Syntax
public class ListRequest : DfareportingBaseServiceRequest<InventoryItemsListResponse>, IClientServiceRequest<InventoryItemsListResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, Int64, Int64)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, long profileId, long projectId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
System.Int64 | profileId | |
System.Int64 | projectId |
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.Dfareporting.v3_3.Data.InventoryItemsListResponse>.HttpMethod
Ids
Select only inventory items with these IDs.
Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<System.String> |
InPlan
Select only inventory items that are in plan.
Declaration
[RequestParameter("inPlan", RequestParameterType.Query)]
public virtual bool? InPlan { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
MaxResults
Maximum number of results to return.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_3.Data.InventoryItemsListResponse>.MethodName
OrderId
Select only inventory items that belong to specified orders.
Declaration
[RequestParameter("orderId", RequestParameterType.Query)]
public virtual Repeatable<string> OrderId { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<System.String> |
PageToken
Value of the nextPageToken from the previous result page.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ProfileId
User profile ID associated with this request.
Declaration
[RequestParameter("profileId", RequestParameterType.Path)]
public virtual long ProfileId { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
ProjectId
Project ID for order documents.
Declaration
[RequestParameter("projectId", RequestParameterType.Path)]
public virtual long ProjectId { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_3.Data.InventoryItemsListResponse>.RestPath
SiteId
Select only inventory items that are associated with these sites.
Declaration
[RequestParameter("siteId", RequestParameterType.Query)]
public virtual Repeatable<string> SiteId { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<System.String> |
SortField
Field by which to sort the list.
Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual InventoryItemsResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<InventoryItemsResource.ListRequest.SortFieldEnum> |
SortOrder
Order of sorted results.
Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual InventoryItemsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<InventoryItemsResource.ListRequest.SortOrderEnum> |
Type
Select only inventory items with this type.
Declaration
[RequestParameter("type", RequestParameterType.Query)]
public virtual InventoryItemsResource.ListRequest.TypeEnum? Type { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<InventoryItemsResource.ListRequest.TypeEnum> |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dfareporting.v3_3.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_3.Data.InventoryItemsListResponse>.InitParameters()