Reference documentation and code samples for the Google Ads Ad Manager V1 Client class LineItemCreativeAssociation.
A LineItemCreativeAssociation associates a Creative or CreativeSet with a LineItem so that the creative can be served in ad units targeted by the line item.
Generated from protobuf message google.ads.admanager.v1.LineItemCreativeAssociation
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the |
↳ line_item |
string
Required. Immutable. The LineItem to which the LineItemCreativeAssociation belongs. |
↳ creative |
string
Optional. Immutable. The Creative to which the LineItemCreativeAssociation associated. Optional if creativeSet is set. |
↳ creative_set |
string
Optional. Immutable. The CreativeSet to which the LineItemCreativeAssociation associated. Optional if creative is set. |
↳ status |
int
Output only. The status of the association. |
↳ start_time |
Google\Protobuf\Timestamp
Optional. Overrides the value set for startTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the startTime of the lineItem will be used. |
↳ end_time |
Google\Protobuf\Timestamp
Optional. Overrides endTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the endTime of the lineItem will be used. |
↳ sizes |
array<Size>
Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. |
↳ destination_url |
string
Optional. Overrides the value set for destinationUrl of the creative. This value is only valid for Ad Manager 360 networks. |
↳ manual_creative_rotation_weight |
float
Optional. Non-empty default. The weight of the creative. This value is only used if the creativeRotationType of the lineItem is set to WEIGHTED. Defaults to 10. |
↳ sequential_creative_rotation_index |
int
Optional. Non-empty default. The sequential rotation index of the Creative. This value is used only if the lineItem's creativeRotationType is set to SEQUENTIAL. Defaults to 1. |
↳ targeting_display_name |
string
Optional. Specifies creative targeting for this line item creative association. It should match the targetingName specified on the corresponding creativePlaceholder on the lineItem. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The date and time this association was last modified. |
↳ stats |
LineItemCreativeAssociationStats
Output only. Contains trafficking statistics for the association. |
getName
Identifier. The resource name of the LineItemCreativeAssociation.
Format:
networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the LineItemCreativeAssociation.
Format:
networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLineItem
Required. Immutable. The LineItem to which the LineItemCreativeAssociation belongs.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasLineItem
clearLineItem
setLineItem
Required. Immutable. The LineItem to which the LineItemCreativeAssociation belongs.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreative
Optional. Immutable. The Creative to which the LineItemCreativeAssociation associated. Optional if creativeSet is set.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreative
clearCreative
setCreative
Optional. Immutable. The Creative to which the LineItemCreativeAssociation associated. Optional if creativeSet is set.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreativeSet
Optional. Immutable. The CreativeSet to which the LineItemCreativeAssociation associated. Optional if creative is set.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreativeSet
clearCreativeSet
setCreativeSet
Optional. Immutable. The CreativeSet to which the LineItemCreativeAssociation associated. Optional if creative is set.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of the association.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasStatus
clearStatus
setStatus
Output only. The status of the association.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Optional. Overrides the value set for startTime of the lineItem.
This value is only valid for Ad Manager 360 networks. If unset, the startTime of the lineItem will be used.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Optional. Overrides the value set for startTime of the lineItem.
This value is only valid for Ad Manager 360 networks. If unset, the startTime of the lineItem will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Optional. Overrides endTime of the lineItem.
This value is only valid for Ad Manager 360 networks. If unset, the endTime of the lineItem will be used.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Optional. Overrides endTime of the lineItem.
This value is only valid for Ad Manager 360 networks. If unset, the endTime of the lineItem will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSizes
Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Size> |
|
setSizes
Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Size>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestinationUrl
Optional. Overrides the value set for destinationUrl of the creative.
This value is only valid for Ad Manager 360 networks.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDestinationUrl
clearDestinationUrl
setDestinationUrl
Optional. Overrides the value set for destinationUrl of the creative.
This value is only valid for Ad Manager 360 networks.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getManualCreativeRotationWeight
Optional. Non-empty default. The weight of the creative.
This value is only used if the creativeRotationType of the lineItem is set to WEIGHTED. Defaults to 10.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasManualCreativeRotationWeight
clearManualCreativeRotationWeight
setManualCreativeRotationWeight
Optional. Non-empty default. The weight of the creative.
This value is only used if the creativeRotationType of the lineItem is set to WEIGHTED. Defaults to 10.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSequentialCreativeRotationIndex
Optional. Non-empty default. The sequential rotation index of the Creative.
This value is used only if the lineItem's creativeRotationType is set to SEQUENTIAL. Defaults to 1.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasSequentialCreativeRotationIndex
clearSequentialCreativeRotationIndex
setSequentialCreativeRotationIndex
Optional. Non-empty default. The sequential rotation index of the Creative.
This value is used only if the lineItem's creativeRotationType is set to SEQUENTIAL. Defaults to 1.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetingDisplayName
Optional. Specifies creative targeting for this line item creative association. It should match the targetingName specified on the corresponding creativePlaceholder on the lineItem.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTargetingDisplayName
Optional. Specifies creative targeting for this line item creative association. It should match the targetingName specified on the corresponding creativePlaceholder on the lineItem.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The date and time this association was last modified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The date and time this association was last modified.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStats
Output only. Contains trafficking statistics for the association.
| Returns | |
|---|---|
| Type | Description |
LineItemCreativeAssociationStats|null |
|
hasStats
clearStats
setStats
Output only. Contains trafficking statistics for the association.
| Parameter | |
|---|---|
| Name | Description |
var |
LineItemCreativeAssociationStats
|
| Returns | |
|---|---|
| Type | Description |
$this |
|