Show / Hide Table of Contents

Class PromotionsResource.ListRequest

List all promotions from your Merchant Center account.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListPromotionResponse>
ShoppingContentBaseServiceRequest<ListPromotionResponse>
PromotionsResource.ListRequest
Implements
IClientServiceRequest<ListPromotionResponse>
IClientServiceRequest
Inherited Members
ShoppingContentBaseServiceRequest<ListPromotionResponse>.Xgafv
ShoppingContentBaseServiceRequest<ListPromotionResponse>.AccessToken
ShoppingContentBaseServiceRequest<ListPromotionResponse>.Alt
ShoppingContentBaseServiceRequest<ListPromotionResponse>.Callback
ShoppingContentBaseServiceRequest<ListPromotionResponse>.Fields
ShoppingContentBaseServiceRequest<ListPromotionResponse>.Key
ShoppingContentBaseServiceRequest<ListPromotionResponse>.OauthToken
ShoppingContentBaseServiceRequest<ListPromotionResponse>.PrettyPrint
ShoppingContentBaseServiceRequest<ListPromotionResponse>.QuotaUser
ShoppingContentBaseServiceRequest<ListPromotionResponse>.UploadType
ShoppingContentBaseServiceRequest<ListPromotionResponse>.UploadProtocol
ClientServiceRequest<ListPromotionResponse>.Execute()
ClientServiceRequest<ListPromotionResponse>.ExecuteAsStream()
ClientServiceRequest<ListPromotionResponse>.ExecuteAsync()
ClientServiceRequest<ListPromotionResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListPromotionResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListPromotionResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListPromotionResponse>.CreateRequest(bool?)
ClientServiceRequest<ListPromotionResponse>.GenerateRequestUri()
ClientServiceRequest<ListPromotionResponse>.GetBody()
ClientServiceRequest<ListPromotionResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListPromotionResponse>.ETagAction
ClientServiceRequest<ListPromotionResponse>.ModifyRequest
ClientServiceRequest<ListPromotionResponse>.ValidateParameters
ClientServiceRequest<ListPromotionResponse>.ApiVersion
ClientServiceRequest<ListPromotionResponse>.RequestParameters
ClientServiceRequest<ListPromotionResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.ShoppingContent.v2_1
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class PromotionsResource.ListRequest : ShoppingContentBaseServiceRequest<ListPromotionResponse>, IClientServiceRequest<ListPromotionResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, long)

Constructs a new List request.

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

Properties

CountryCode

CLDR country code (for example, "US"), used as a filter on promotions target country.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListPromotionResponse>.HttpMethod

LanguageCode

The two-letter ISO 639-1 language code associated with the promotions, used as a filter.

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

MerchantId

Required. The ID of the account that contains the collection.

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

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListPromotionResponse>.MethodName

PageSize

The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

PageToken

A page token, received from a previous ListPromotion call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPromotion must match the call that provided the page token.

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
ClientServiceRequest<ListPromotionResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
ShoppingContentBaseServiceRequest<ListPromotionResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX