Class FloodlightActivityGroupsResource.ListRequest
Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
Inheritance
Inherited Members
Namespace: Google.Apis.Dfareporting.v4
Assembly: Google.Apis.Dfareporting.v4.dll
Syntax
public class FloodlightActivityGroupsResource.ListRequest : DfareportingBaseServiceRequest<FloodlightActivityGroupsListResponse>, IClientServiceRequest<FloodlightActivityGroupsListResponse>, 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
AdvertiserId
Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }
Property Value
Type | Description |
---|---|
long? |
FloodlightConfigurationId
Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
Declaration
[RequestParameter("floodlightConfigurationId", RequestParameterType.Query)]
public virtual long? FloodlightConfigurationId { get; set; }
Property Value
Type | Description |
---|---|
long? |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Ids
Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
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
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
SearchString
Allows searching for objects by name or ID. Wildcards () are allowed. For example, "floodlightactivitygroup2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
Declaration
[RequestParameter("searchString", RequestParameterType.Query)]
public virtual string SearchString { get; set; }
Property Value
Type | Description |
---|---|
string |
SortField
Field by which to sort the list.
Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual FloodlightActivityGroupsResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type | Description |
---|---|
FloodlightActivityGroupsResource.ListRequest.SortFieldEnum? |
SortOrder
Order of sorted results.
Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual FloodlightActivityGroupsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
FloodlightActivityGroupsResource.ListRequest.SortOrderEnum? |
Type
Select only floodlight activity groups with the specified floodlight activity group type.
Declaration
[RequestParameter("type", RequestParameterType.Query)]
public virtual FloodlightActivityGroupsResource.ListRequest.TypeEnum? Type { get; set; }
Property Value
Type | Description |
---|---|
FloodlightActivityGroupsResource.ListRequest.TypeEnum? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()