Class AdvertiserLandingPagesResource.ListRequest
Retrieves a list of landing pages.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v3_4
Assembly: Google.Apis.Dfareporting.v3_4.dll
Syntax
public class ListRequest : DfareportingBaseServiceRequest<AdvertiserLandingPagesListResponse>, IClientServiceRequest<AdvertiserLandingPagesListResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, Int64)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, long profileId)
Parameters
Type | Name | Description |
---|---|---|
Google.Apis.Services.IClientService | service | |
System.Int64 | profileId |
Properties
AdvertiserIds
Select only landing pages that belong to these advertisers.
Declaration
[RequestParameter("advertiserIds", RequestParameterType.Query)]
public virtual Repeatable<string> AdvertiserIds { get; set; }
Property Value
Type | Description |
---|---|
Google.Apis.Util.Repeatable<System.String> |
Archived
Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
Declaration
[RequestParameter("archived", RequestParameterType.Query)]
public virtual bool? Archived { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
CampaignIds
Select only landing pages that are associated with these campaigns.
Declaration
[RequestParameter("campaignIds", RequestParameterType.Query)]
public virtual Repeatable<string> CampaignIds { get; set; }
Property Value
Type | Description |
---|---|
Google.Apis.Util.Repeatable<System.String> |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Ids
Select only landing pages with these IDs.
Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type | Description |
---|---|
Google.Apis.Util.Repeatable<System.String> |
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
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 |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
SearchString
Allows searching for landing pages by name or ID. Wildcards () are allowed. For example, "landingpage2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".
Declaration
[RequestParameter("searchString", RequestParameterType.Query)]
public virtual string SearchString { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SortField
Field by which to sort the list.
Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual AdvertiserLandingPagesResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<AdvertiserLandingPagesResource.ListRequest.SortFieldEnum> |
SortOrder
Order of sorted results.
Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual AdvertiserLandingPagesResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<AdvertiserLandingPagesResource.ListRequest.SortOrderEnum> |
SubaccountId
Select only landing pages that belong to this subaccount.
Declaration
[RequestParameter("subaccountId", RequestParameterType.Query)]
public virtual long? SubaccountId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()