Class AdvertisersResource.AdGroupAdsResource.ListRequest

Lists ad group ads.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListAdGroupAdsResponse>
DisplayVideoBaseServiceRequest<ListAdGroupAdsResponse>
AdvertisersResource.AdGroupAdsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.DisplayVideo.v3
Assembly: Google.Apis.DisplayVideo.v3.dll
Syntax
public class AdvertisersResource.AdGroupAdsResource.ListRequest : DisplayVideoBaseServiceRequest<ListAdGroupAdsResponse>, IClientServiceRequest<ListAdGroupAdsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, long)

Constructs a new List request.

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

Properties

AdvertiserId

Required. The ID of the advertiser the ads belong to.

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

Filter

Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND and OR. A sequence of restrictions implicitly uses AND. * A restriction has the form of {field} {operator} {value}. * All fields must use the EQUALS (=) operator. Supported fields: * adGroupId * displayName * entityStatus * adGroupAdId Examples: * All ad group ads under an ad group: adGroupId="1234" * All ad group ads under an ad group with an entityStatus of ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

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

HttpMethod

Gets the HTTP method.

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

MethodName

Gets the method name.

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

OrderBy

Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

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

PageSize

Optional. Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

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

PageToken

Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListAdGroupAds method. If not specified, the first page of results will be returned.

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

RestPath

Gets the REST path.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements