Console
    Start free

    Google Ads Data Manager V1 Client - Class UserListLicensePricing (0.4.0)

    Reference documentation and code samples for the Google Ads Data Manager V1 Client class UserListLicensePricing.

    A user list license pricing.

    Generated from protobuf message google.ads.datamanager.v1.UserListLicensePricing

    Namespace

    Google \ Ads \ DataManager \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ pricing_id
    int|string

    Output only. The ID of this pricing.

    ↳ cost_micros
    int|string

    Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD .

    ↳ currency_code
    string

    Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.

    ↳ start_time
    Google\Protobuf\Timestamp

    Output only. Start time of the pricing.

    ↳ end_time
    Google\Protobuf\Timestamp

    Optional. End time of the pricing.

    ↳ pricing_active
    bool

    Output only. Whether this pricing is active.

    ↳ buyer_approval_state
    int

    Output only. The buyer approval state of this pricing. This field is read-only.

    ↳ cost_type
    int

    Immutable. The cost type of this pricing. Can be set only in the create operation. Can't be updated for an existing license.

    ↳ max_cost_micros
    int|string

    Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD . This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to 0 , there is no cap.

    getPricingId

    Output only. The ID of this pricing.

    Returns
    Type
    Description
    int|string

    setPricingId

    Output only. The ID of this pricing.

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getCostMicros

    Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD .

    Returns
    Type
    Description
    int|string

    hasCostMicros

    clearCostMicros

    setCostMicros

    Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD .

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getCurrencyCode

    Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.

    Returns
    Type
    Description
    string

    hasCurrencyCode

    clearCurrencyCode

    setCurrencyCode

    Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getStartTime

    Output only. Start time of the pricing.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasStartTime

    clearStartTime

    setStartTime

    Output only. Start time of the pricing.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getEndTime

    Optional. End time of the pricing.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasEndTime

    clearEndTime

    setEndTime

    Optional. End time of the pricing.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getPricingActive

    Output only. Whether this pricing is active.

    Returns
    Type
    Description
    bool

    setPricingActive

    Output only. Whether this pricing is active.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getBuyerApprovalState

    Output only. The buyer approval state of this pricing.

    This field is read-only.

    Returns
    Type
    Description
    int
    Enum of type UserListPricingBuyerApprovalState .

    setBuyerApprovalState

    Output only. The buyer approval state of this pricing.

    This field is read-only.

    Parameter
    Name
    Description
    var
    int

    Enum of type UserListPricingBuyerApprovalState .

    Returns
    Type
    Description
    $this

    getCostType

    Immutable. The cost type of this pricing.

    Can be set only in the create operation. Can't be updated for an existing license.

    Returns
    Type
    Description
    int

    hasCostType

    clearCostType

    setCostType

    Immutable. The cost type of this pricing.

    Can be set only in the create operation. Can't be updated for an existing license.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getMaxCostMicros

    Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD .

    This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to 0 , there is no cap.

    Returns
    Type
    Description
    int|string

    hasMaxCostMicros

    clearMaxCostMicros

    setMaxCostMicros

    Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD .

    This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to 0 , there is no cap.

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: