Class CreativeGroupsResource.ListRequest

Retrieves a list of creative groups, possibly filtered. This method supports paging.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<CreativeGroupsListResponse>
DfareportingBaseServiceRequest<CreativeGroupsListResponse>
CreativeGroupsResource.ListRequest
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dfareporting.v3_5
Assembly: Google.Apis.Dfareporting.v3_5.dll
Syntax
public class CreativeGroupsResource.ListRequest : DfareportingBaseServiceRequest<CreativeGroupsListResponse>, IClientServiceRequest<CreativeGroupsListResponse>, 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

AdvertiserIds

Select only creative groups that belong to these advertisers.

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

GroupNumber

Select only creative groups that belong to this subgroup.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.CreativeGroupsListResponse>.HttpMethod

Ids

Select only creative groups 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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.CreativeGroupsListResponse>.MethodName

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.CreativeGroupsListResponse>.RestPath

SearchString

Allows searching for creative groups by name or ID. Wildcards () are allowed. For example, "creativegroup2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".

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 CreativeGroupsResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
CreativeGroupsResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dfareporting.v3_5.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_5.Data.CreativeGroupsListResponse>.InitParameters()

Implements