Class BillingProfilesResource.ListRequest

Retrieves a list of billing profiles, possibly filtered. This method supports paging.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<BillingProfilesListResponse>
DfareportingBaseServiceRequest<BillingProfilesListResponse>
BillingProfilesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v4
Assembly: Google.Apis.Dfareporting.v4.dll
Syntax
public class BillingProfilesResource.ListRequest : DfareportingBaseServiceRequest<BillingProfilesListResponse>, IClientServiceRequest<BillingProfilesListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, long)

Constructs a new List request.

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

Properties

CurrencyCode

Select only billing profile with currency.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

Ids

Select only billing profile with these IDs.

Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type Description
Repeatable<string>

MaxResults

Maximum number of results to return.

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

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

Allows searching for billing profiles by name. Wildcards () are allowed. For example, "profile2020" will return objects with names like "profile June 2020", "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile", "profile 2021", or simply "profile".

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

OnlySuggestion

Select only billing profile which is suggested for the currency_code &amp; subaccount_id using the Billing Suggestion API.

Declaration
[RequestParameter("onlySuggestion", RequestParameterType.Query)]
public virtual bool? OnlySuggestion { get; set; }
Property Value
Type Description
bool?

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
string

ProfileId

User profile ID associated with this request.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SortField

Field by which to sort the list.

Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual BillingProfilesResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
BillingProfilesResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual BillingProfilesResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
BillingProfilesResource.ListRequest.SortOrderEnum?

Status

Select only billing profile with the specified status.

Declaration
[RequestParameter("status", RequestParameterType.Query)]
public virtual BillingProfilesResource.ListRequest.StatusEnum? Status { get; set; }
Property Value
Type Description
BillingProfilesResource.ListRequest.StatusEnum?
Remarks

Use this property to set a single value for the parameter, or StatusList to set multiple values. Do not set both properties.

StatusList

Select only billing profile with the specified status.

Declaration
[RequestParameter("status", RequestParameterType.Query)]
public virtual Repeatable<BillingProfilesResource.ListRequest.StatusEnum> StatusList { get; set; }
Property Value
Type Description
Repeatable<BillingProfilesResource.ListRequest.StatusEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Status.

SubaccountIds

Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported.

Declaration
[RequestParameter("subaccountIds", RequestParameterType.Query)]
public virtual Repeatable<string> SubaccountIds { get; set; }
Property Value
Type Description
Repeatable<string>

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements