Google Shopping Css V1 Client - Class UpdateAccountLabelsRequest (0.2.9)

Reference documentation and code samples for the Google Shopping Css V1 Client class UpdateAccountLabelsRequest.

The request message for the UpdateLabels method.

Generated from protobuf message google.shopping.css.v1.UpdateAccountLabelsRequest

Namespace

Google \ Shopping \ Css \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The label resource name. Format: accounts/{account}

↳ label_ids array

The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.

↳ parent string

Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}

getName

Required. The label resource name.

Format: accounts/{account}

Returns
Type Description
string

setName

Required. The label resource name.

Format: accounts/{account}

Parameter
Name Description
var string
Returns
Type Description
$this

getLabelIds

The list of label IDs to overwrite the existing account label IDs.

If the list is empty, all currently assigned label IDs will be deleted.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLabelIds

The list of label IDs to overwrite the existing account label IDs.

If the list is empty, all currently assigned label IDs will be deleted.

Parameter
Name Description
var int[]|string[]|Google\Protobuf\Internal\RepeatedField
Returns
Type Description
$this

getParent

Optional. Only required when updating MC account labels.

The CSS domain that is the parent resource of the MC account. Format: accounts/{account}

Returns
Type Description
string

hasParent

clearParent

setParent

Optional. Only required when updating MC account labels.

The CSS domain that is the parent resource of the MC account. Format: accounts/{account}

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The label resource name. Format: accounts/{account} Please see Google\Shopping\Css\V1\AccountsServiceClient::accountName() for help formatting this field.

Returns
Type Description
Google\Shopping\Css\V1\UpdateAccountLabelsRequest