public final class LineItem extends GeneratedMessage implements LineItemOrBuilderA LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.
Protobuf type google.ads.admanager.v1.LineItem
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > LineItemImplements
LineItemOrBuilderStatic Fields
ALLOWED_FORMATS_FIELD_NUMBER
public static final int ALLOWED_FORMATS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ALLOW_OVERBOOK_FIELD_NUMBER
public static final int ALLOW_OVERBOOK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
APPLIED_LABELS_FIELD_NUMBER
public static final int APPLIED_LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ARCHIVED_FIELD_NUMBER
public static final int ARCHIVED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
AUTO_EXTENSION_DAYS_FIELD_NUMBER
public static final int AUTO_EXTENSION_DAYS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BUDGET_FIELD_NUMBER
public static final int BUDGET_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CHILD_CONTENT_ELIGIBILITY_FIELD_NUMBER
public static final int CHILD_CONTENT_ELIGIBILITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
COMPANION_DELIVERY_OPTION_FIELD_NUMBER
public static final int COMPANION_DELIVERY_OPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
COMPETITIVE_CONSTRAINT_SCOPE_FIELD_NUMBER
public static final int COMPETITIVE_CONSTRAINT_SCOPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONTRACTED_UNITS_BOUGHT_FIELD_NUMBER
public static final int CONTRACTED_UNITS_BOUGHT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
COST_TYPE_FIELD_NUMBER
public static final int COST_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATIVE_PLACEHOLDERS_FIELD_NUMBER
public static final int CREATIVE_PLACEHOLDERS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATIVE_ROTATION_TYPE_FIELD_NUMBER
public static final int CREATIVE_ROTATION_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATIVE_TARGETINGS_FIELD_NUMBER
public static final int CREATIVE_TARGETINGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_FIELD_VALUES_FIELD_NUMBER
public static final int CUSTOM_FIELD_VALUES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_PACING_CURVE_FIELD_NUMBER
public static final int CUSTOM_PACING_CURVE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_VAST_EXTENSION_FIELD_NUMBER
public static final int CUSTOM_VAST_EXTENSION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DEAL_INFO_FIELD_NUMBER
public static final int DEAL_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELIVERY_FORECAST_SOURCE_FIELD_NUMBER
public static final int DELIVERY_FORECAST_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELIVERY_INDICATOR_FIELD_NUMBER
public static final int DELIVERY_INDICATOR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELIVERY_RATE_TYPE_FIELD_NUMBER
public static final int DELIVERY_RATE_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISCOUNT_FIELD_NUMBER
public static final int DISCOUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EFFECTIVE_APPLIED_LABELS_FIELD_NUMBER
public static final int EFFECTIVE_APPLIED_LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
END_TIME_UNLIMITED_FIELD_NUMBER
public static final int END_TIME_UNLIMITED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENVIRONMENT_TYPE_FIELD_NUMBER
public static final int ENVIRONMENT_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXTERNAL_LINE_ITEM_ID_FIELD_NUMBER
public static final int EXTERNAL_LINE_ITEM_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FREQUENCY_CAPS_FIELD_NUMBER
public static final int FREQUENCY_CAPS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GOAL_FIELD_NUMBER
public static final int GOAL_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GRP_SETTINGS_FIELD_NUMBER
public static final int GRP_SETTINGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LINE_ITEM_TYPE_FIELD_NUMBER
public static final int LINE_ITEM_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MAX_VIDEO_CREATIVE_DURATION_FIELD_NUMBER
public static final int MAX_VIDEO_CREATIVE_DURATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MISSING_CREATIVES_FIELD_NUMBER
public static final int MISSING_CREATIVES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NOTES_FIELD_NUMBER
public static final int NOTES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ORDER_DISPLAY_NAME_FIELD_NUMBER
public static final int ORDER_DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RATE_FIELD_NUMBER
public static final int RATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REPEATED_CREATIVE_SERVING_ENABLED_FIELD_NUMBER
public static final int REPEATED_CREATIVE_SERVING_ENABLED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RESERVATION_STATUS_FIELD_NUMBER
public static final int RESERVATION_STATUS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RESERVE_ON_CREATION_FIELD_NUMBER
public static final int RESERVE_ON_CREATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ROADBLOCKING_TYPE_FIELD_NUMBER
public static final int ROADBLOCKING_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SAME_ADVERTISER_EXCEPTION_ENABLED_FIELD_NUMBER
public static final int SAME_ADVERTISER_EXCEPTION_ENABLED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SECONDARY_GOALS_FIELD_NUMBER
public static final int SECONDARY_GOALS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SKIPPABLE_AD_TYPE_FIELD_NUMBER
public static final int SKIPPABLE_AD_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SKIP_CROSS_SELLING_RULE_WARNING_CHECKS_FIELD_NUMBER
public static final int SKIP_CROSS_SELLING_RULE_WARNING_CHECKS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SKIP_INVENTORY_CHECK_FIELD_NUMBER
public static final int SKIP_INVENTORY_CHECK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SPONSORSHIP_EXCLUSIVITY_ENABLED_FIELD_NUMBER
public static final int SPONSORSHIP_EXCLUSIVITY_ENABLED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATS_FIELD_NUMBER
public static final int STATS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TARGETING_FIELD_NUMBER
public static final int TARGETING_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TARGET_END_TIME_FIELD_NUMBER
public static final int TARGET_END_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
THIRD_PARTY_MEASUREMENT_SETTINGS_FIELD_NUMBER
public static final int THIRD_PARTY_MEASUREMENT_SETTINGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_SOURCE_FIELD_NUMBER
public static final int UPDATE_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VALUE_CPM_FIELD_NUMBER
public static final int VALUE_CPM_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VIEWABILITY_PROVIDER_COMPANIES_FIELD_NUMBER
public static final int VIEWABILITY_PROVIDER_COMPANIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WEB_PROPERTY_CODE_FIELD_NUMBER
public static final int WEB_PROPERTY_CODE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
YOUTUBE_KIDS_RESTRICTED_FIELD_NUMBER
public static final int YOUTUBE_KIDS_RESTRICTED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static LineItem getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
LineItem |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static LineItem.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
LineItem.Builder |
|
newBuilder(LineItem prototype)
public static LineItem.Builder newBuilder(LineItem prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
LineItem |
| Returns | |
|---|---|
| Type | Description |
LineItem.Builder |
|
parseDelimitedFrom(InputStream input)
public static LineItem parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LineItem parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static LineItem parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LineItem parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static LineItem parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LineItem parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static LineItem parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LineItem parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static LineItem parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LineItem parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static LineItem parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LineItem parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LineItem |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<LineItem> parser()| Returns | |
|---|---|
| Type | Description |
Parser<LineItem> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAllowOverbook()
public boolean getAllowOverbook()Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
optional bool allow_overbook = 28 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The allowOverbook. |
getAllowedFormats(int index)
public LineItemAllowedFormatEnum.LineItemAllowedFormat getAllowedFormats(int index)Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.
repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
LineItemAllowedFormatEnum.LineItemAllowedFormat |
The allowedFormats at the given index. |
getAllowedFormatsCount()
public int getAllowedFormatsCount()Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.
repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of allowedFormats. |
getAllowedFormatsList()
public List<LineItemAllowedFormatEnum.LineItemAllowedFormat> getAllowedFormatsList()Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.
repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<LineItemAllowedFormat> |
A list containing the allowedFormats. |
getAllowedFormatsValue(int index)
public int getAllowedFormatsValue(int index)Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.
repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of allowedFormats at the given index. |
getAllowedFormatsValueList()
public List<Integer> getAllowedFormatsValueList()Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.
repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for allowedFormats. |
getAppliedLabels(int index)
public AppliedLabel getAppliedLabels(int index)Optional. The set of labels applied directly to this line item.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AppliedLabel |
|
getAppliedLabelsCount()
public int getAppliedLabelsCount()Optional. The set of labels applied directly to this line item.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAppliedLabelsList()
public List<AppliedLabel> getAppliedLabelsList()Optional. The set of labels applied directly to this line item.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<AppliedLabel> |
|
getAppliedLabelsOrBuilder(int index)
public AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)Optional. The set of labels applied directly to this line item.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AppliedLabelOrBuilder |
|
getAppliedLabelsOrBuilderList()
public List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()Optional. The set of labels applied directly to this line item.
repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder> |
|
getArchived()
public boolean getArchived()Output only. The archival status of the LineItem.
optional bool archived = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The archived. |
getAutoExtensionDays()
public int getAutoExtensionDays()Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.
optional int32 auto_extension_days = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The autoExtensionDays. |
getBudget()
public Money getBudget()Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
optional .google.type.Money budget = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.type.Money |
The budget. |
getBudgetOrBuilder()
public MoneyOrBuilder getBudgetOrBuilder()Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
optional .google.type.Money budget = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.type.MoneyOrBuilder |
|
getChildContentEligibility()
public ChildContentEligibilityEnum.ChildContentEligibility getChildContentEligibility()Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.
optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
ChildContentEligibilityEnum.ChildContentEligibility |
The childContentEligibility. |
getChildContentEligibilityValue()
public int getChildContentEligibilityValue()Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.
optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for childContentEligibility. |
getCompanionDeliveryOption()
public CompanionDeliveryOptionEnum.CompanionDeliveryOption getCompanionDeliveryOption()Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:
- The "Guaranteed roadblocks" feature is enabled on your network.
- One of the following is true (both cannot be true, these are mutually exclusive).
- The environmentType is VIDEO_PLAYER.
- The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CompanionDeliveryOptionEnum.CompanionDeliveryOption |
The companionDeliveryOption. |
getCompanionDeliveryOptionValue()
public int getCompanionDeliveryOptionValue()Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:
- The "Guaranteed roadblocks" feature is enabled on your network.
- One of the following is true (both cannot be true, these are mutually exclusive).
- The environmentType is VIDEO_PLAYER.
- The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for companionDeliveryOption. |
getCompetitiveConstraintScope()
public ExclusionScopeEnum.ExclusionScope getCompetitiveConstraintScope()Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.
optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
ExclusionScopeEnum.ExclusionScope |
The competitiveConstraintScope. |
getCompetitiveConstraintScopeValue()
public int getCompetitiveConstraintScopeValue()Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.
optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for competitiveConstraintScope. |
getContractedUnitsBought()
public long getContractedUnitsBought()Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.
optional int64 contracted_units_bought = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The contractedUnitsBought. |
getCostType()
public LineItemCostTypeEnum.LineItemCostType getCostType()Required. The method used for billing this LineItem.
optional .google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType cost_type = 22 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
LineItemCostTypeEnum.LineItemCostType |
The costType. |
getCostTypeValue()
public int getCostTypeValue()Required. The method used for billing this LineItem.
optional .google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType cost_type = 22 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for costType. |
getCreateTime()
public Timestamp getCreateTime()Output only. The time this line item was created.
optional .google.protobuf.Timestamp create_time = 58 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time this line item was created.
optional .google.protobuf.Timestamp create_time = 58 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCreativePlaceholders(int index)
public CreativePlaceholder getCreativePlaceholders(int index)Required. Details about the creatives that are expected to serve through this LineItem.
repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 25 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholder |
|
getCreativePlaceholdersCount()
public int getCreativePlaceholdersCount()Required. Details about the creatives that are expected to serve through this LineItem.
repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 25 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
|
getCreativePlaceholdersList()
public List<CreativePlaceholder> getCreativePlaceholdersList()Required. Details about the creatives that are expected to serve through this LineItem.
repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 25 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<CreativePlaceholder> |
|
getCreativePlaceholdersOrBuilder(int index)
public CreativePlaceholderOrBuilder getCreativePlaceholdersOrBuilder(int index)Required. Details about the creatives that are expected to serve through this LineItem.
repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 25 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholderOrBuilder |
|
getCreativePlaceholdersOrBuilderList()
public List<? extends CreativePlaceholderOrBuilder> getCreativePlaceholdersOrBuilderList()Required. Details about the creatives that are expected to serve through this LineItem.
repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 25 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.CreativePlaceholderOrBuilder> |
|
getCreativeRotationType()
public CreativeRotationTypeEnum.CreativeRotationType getCreativeRotationType()Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.
optional .google.ads.admanager.v1.CreativeRotationTypeEnum.CreativeRotationType creative_rotation_type = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreativeRotationTypeEnum.CreativeRotationType |
The creativeRotationType. |
getCreativeRotationTypeValue()
public int getCreativeRotationTypeValue()Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.
optional .google.ads.admanager.v1.CreativeRotationTypeEnum.CreativeRotationType creative_rotation_type = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for creativeRotationType. |
getCreativeTargetings(int index)
public CreativeTargeting getCreativeTargetings(int index)Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.
repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativeTargeting |
|
getCreativeTargetingsCount()
public int getCreativeTargetingsCount()Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.
repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getCreativeTargetingsList()
public List<CreativeTargeting> getCreativeTargetingsList()Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.
repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<CreativeTargeting> |
|
getCreativeTargetingsOrBuilder(int index)
public CreativeTargetingOrBuilder getCreativeTargetingsOrBuilder(int index)Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.
repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativeTargetingOrBuilder |
|
getCreativeTargetingsOrBuilderList()
public List<? extends CreativeTargetingOrBuilder> getCreativeTargetingsOrBuilderList()Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.
repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.CreativeTargetingOrBuilder> |
|
getCustomFieldValues(int index)
public CustomFieldValue getCustomFieldValues(int index)Optional. The values of the custom fields associated with this line item.
repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CustomFieldValue |
|
getCustomFieldValuesCount()
public int getCustomFieldValuesCount()Optional. The values of the custom fields associated with this line item.
repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getCustomFieldValuesList()
public List<CustomFieldValue> getCustomFieldValuesList()Optional. The values of the custom fields associated with this line item.
repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<CustomFieldValue> |
|
getCustomFieldValuesOrBuilder(int index)
public CustomFieldValueOrBuilder getCustomFieldValuesOrBuilder(int index)Optional. The values of the custom fields associated with this line item.
repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CustomFieldValueOrBuilder |
|
getCustomFieldValuesOrBuilderList()
public List<? extends CustomFieldValueOrBuilder> getCustomFieldValuesOrBuilderList()Optional. The values of the custom fields associated with this line item.
repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.CustomFieldValueOrBuilder> |
|
getCustomPacingCurve()
public CustomPacingCurve getCustomPacingCurve()Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.
optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CustomPacingCurve |
The customPacingCurve. |
getCustomPacingCurveOrBuilder()
public CustomPacingCurveOrBuilder getCustomPacingCurveOrBuilder()Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.
optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CustomPacingCurveOrBuilder |
|
getCustomVastExtension()
public String getCustomVastExtension()Optional. Custom XML to be rendered in a custom VAST response at serving time.
optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The customVastExtension. |
getCustomVastExtensionBytes()
public ByteString getCustomVastExtensionBytes()Optional. Custom XML to be rendered in a custom VAST response at serving time.
optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customVastExtension. |
getDealInfo()
public LineItemDealInfo getDealInfo()Optional. The deal information associated with this line item, if it is programmatic.
optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LineItemDealInfo |
The dealInfo. |
getDealInfoOrBuilder()
public LineItemDealInfoOrBuilder getDealInfoOrBuilder()Optional. The deal information associated with this line item, if it is programmatic.
optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LineItemDealInfoOrBuilder |
|
getDefaultInstanceForType()
public LineItem getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LineItem |
|
getDeliveryForecastSource()
public LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource getDeliveryForecastSource()Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.
optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource |
The deliveryForecastSource. |
getDeliveryForecastSourceValue()
public int getDeliveryForecastSourceValue()Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.
optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for deliveryForecastSource. |
getDeliveryIndicator()
public DeliveryIndicator getDeliveryIndicator()Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:
- The line item is not delivering.
- The line item has an unlimited goal or cap.
- The line item has a percentage based goal or cap.
optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DeliveryIndicator |
The deliveryIndicator. |
getDeliveryIndicatorOrBuilder()
public DeliveryIndicatorOrBuilder getDeliveryIndicatorOrBuilder()Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:
- The line item is not delivering.
- The line item has an unlimited goal or cap.
- The line item has a percentage based goal or cap.
optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DeliveryIndicatorOrBuilder |
|
getDeliveryRateType()
public LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType getDeliveryRateType()Optional. Non-empty default. The strategy for delivering ads over the course of the line item's duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network's configuration.
optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType |
The deliveryRateType. |
getDeliveryRateTypeValue()
public int getDeliveryRateTypeValue()Optional. Non-empty default. The strategy for delivering ads over the course of the line item's duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network's configuration.
optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for deliveryRateType. |
getDiscount()
public LineItemDiscount getDiscount()Optional. Discount information for the line item.
optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LineItemDiscount |
The discount. |
getDiscountOrBuilder()
public LineItemDiscountOrBuilder getDiscountOrBuilder()Optional. Discount information for the line item.
optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LineItemDiscountOrBuilder |
|
getDisplayName()
public String getDisplayName()Required. The name of the line item. This attribute has a maximum length of 255 characters.
optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. The name of the line item. This attribute has a maximum length of 255 characters.
optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEffectiveAppliedLabels(int index)
public AppliedLabel getEffectiveAppliedLabels(int index)Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.
repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AppliedLabel |
|
getEffectiveAppliedLabelsCount()
public int getEffectiveAppliedLabelsCount()Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.
repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getEffectiveAppliedLabelsList()
public List<AppliedLabel> getEffectiveAppliedLabelsList()Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.
repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<AppliedLabel> |
|
getEffectiveAppliedLabelsOrBuilder(int index)
public AppliedLabelOrBuilder getEffectiveAppliedLabelsOrBuilder(int index)Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.
repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AppliedLabelOrBuilder |
|
getEffectiveAppliedLabelsOrBuilderList()
public List<? extends AppliedLabelOrBuilder> getEffectiveAppliedLabelsOrBuilderList()Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.
repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder> |
|
getEndTime()
public Timestamp getEndTime()Output only. The timestamp when the LineItem will stop serving. This attribute includes auto extension days.
optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()Output only. The timestamp when the LineItem will stop serving. This attribute includes auto extension days.
optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getEndTimeUnlimited()
public boolean getEndTimeUnlimited()Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.
optional bool end_time_unlimited = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
The endTimeUnlimited. |
getEnvironmentType()
public EnvironmentTypeEnum.EnvironmentType getEnvironmentType()Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
EnvironmentTypeEnum.EnvironmentType |
The environmentType. |
getEnvironmentTypeValue()
public int getEnvironmentTypeValue()Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for environmentType. |
getExternalLineItemId()
public String getExternalLineItemId()Optional. An identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The externalLineItemId. |
getExternalLineItemIdBytes()
public ByteString getExternalLineItemIdBytes()Optional. An identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for externalLineItemId. |
getFrequencyCaps(int index)
public FrequencyCap getFrequencyCaps(int index)Optional. The set of frequency capping units for this LineItem.
repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FrequencyCap |
|
getFrequencyCapsCount()
public int getFrequencyCapsCount()Optional. The set of frequency capping units for this LineItem.
repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getFrequencyCapsList()
public List<FrequencyCap> getFrequencyCapsList()Optional. The set of frequency capping units for this LineItem.
repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<FrequencyCap> |
|
getFrequencyCapsOrBuilder(int index)
public FrequencyCapOrBuilder getFrequencyCapsOrBuilder(int index)Optional. The set of frequency capping units for this LineItem.
repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FrequencyCapOrBuilder |
|
getFrequencyCapsOrBuilderList()
public List<? extends FrequencyCapOrBuilder> getFrequencyCapsOrBuilderList()Optional. The set of frequency capping units for this LineItem.
repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.FrequencyCapOrBuilder> |
|
getGoal()
public Goal getGoal()Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.
optional .google.ads.admanager.v1.Goal goal = 76 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Goal |
The goal. |
getGoalOrBuilder()
public GoalOrBuilder getGoalOrBuilder()Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.
optional .google.ads.admanager.v1.Goal goal = 76 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GoalOrBuilder |
|
getGrpSettings()
public GrpSettings getGrpSettings()Optional. Contains the information for a line item which has a target GRP demographic.
optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GrpSettings |
The grpSettings. |
getGrpSettingsOrBuilder()
public GrpSettingsOrBuilder getGrpSettingsOrBuilder()Optional. Contains the information for a line item which has a target GRP demographic.
optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GrpSettingsOrBuilder |
|
getLineItemType()
public LineItemTypeEnum.LineItemType getLineItemType()Required. Indicates the line item type of a LineItem. The line item type determines the default priority of the line item. More information can be found at https://support.google.com/admanager/answer/177279.
optional .google.ads.admanager.v1.LineItemTypeEnum.LineItemType line_item_type = 17 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
LineItemTypeEnum.LineItemType |
The lineItemType. |
getLineItemTypeValue()
public int getLineItemTypeValue()Required. Indicates the line item type of a LineItem. The line item type determines the default priority of the line item. More information can be found at https://support.google.com/admanager/answer/177279.
optional .google.ads.admanager.v1.LineItemTypeEnum.LineItemType line_item_type = 17 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for lineItemType. |
getMaxVideoCreativeDuration()
public Duration getMaxVideoCreativeDuration()Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.
optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The maxVideoCreativeDuration. |
getMaxVideoCreativeDurationOrBuilder()
public DurationOrBuilder getMaxVideoCreativeDurationOrBuilder()Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.
optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMissingCreatives()
public boolean getMissingCreatives()Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:
- Not enough Creative creatives of a certain size have been uploaded, as determined by expected_creative_count. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.
- The [Creative.applied_labels][] of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
optional bool missing_creatives = 61 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The missingCreatives. |
getName()
public String getName() Identifier. The resource name of the LineItem.
Format: networks/{network_code}/lineItems/{line_item_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Identifier. The resource name of the LineItem.
Format: networks/{network_code}/lineItems/{line_item_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNotes()
public String getNotes()Optional. Provides any additional notes that may annotate the LineItem. This attribute has a maximum length of 65,535 characters.
optional string notes = 54 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The notes. |
getNotesBytes()
public ByteString getNotesBytes()Optional. Provides any additional notes that may annotate the LineItem. This attribute has a maximum length of 65,535 characters.
optional string notes = 54 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for notes. |
getOrder()
public String getOrder() Required. Immutable. The ID of the Order to which the LineItem belongs.
Format: networks/{network_code}/orders/{order}
optional string order = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The order. |
getOrderBytes()
public ByteString getOrderBytes() Required. Immutable. The ID of the Order to which the LineItem belongs.
Format: networks/{network_code}/orders/{order}
optional string order = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for order. |
getOrderDisplayName()
public String getOrderDisplayName()Output only. The name of the Order.
optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The orderDisplayName. |
getOrderDisplayNameBytes()
public ByteString getOrderDisplayNameBytes()Output only. The name of the Order.
optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderDisplayName. |
getParserForType()
public Parser<LineItem> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<LineItem> |
|
getPriority()
public int getPriority()Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:
- LineItemType: default priority (minimum priority, maximum priority)
- SPONSORSHIP: 4 (2, 5)
- STANDARD: 8 (6, 10)
- NETWORK: 12 (11, 14)
- BULK: 12 (11, 14)
- PRICE_PRIORITY: 12 (11, 14)
- HOUSE: 16 (15, 16)
- CLICK_TRACKING: 16 (1, 16)
- AD_EXCHANGE: 12 (1, 16)
- ADSENSE: 12 (1, 16)
- BUMPER: 16 (15, 16)
- ADMOB: 21 (1, 16)
- PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.
optional int32 priority = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The priority. |
getRate()
public Money getRate()Required. The amount of money to spend per impression or click.
optional .google.type.Money rate = 20 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
com.google.type.Money |
The rate. |
getRateOrBuilder()
public MoneyOrBuilder getRateOrBuilder()Required. The amount of money to spend per impression or click.
optional .google.type.Money rate = 20 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
com.google.type.MoneyOrBuilder |
|
getRepeatedCreativeServingEnabled()
public boolean getRepeatedCreativeServingEnabled()Optional. Indicates whether repeated creative serving is enabled for this line item.
optional bool repeated_creative_serving_enabled = 90 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The repeatedCreativeServingEnabled. |
getReservationStatus()
public LineItemReservationStatusEnum.LineItemReservationStatus getReservationStatus()Output only. Describes whether or not inventory has been reserved for the LineItem.
optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LineItemReservationStatusEnum.LineItemReservationStatus |
The reservationStatus. |
getReservationStatusValue()
public int getReservationStatusValue()Output only. Describes whether or not inventory has been reserved for the LineItem.
optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for reservationStatus. |
getReserveOnCreation()
public boolean getReserveOnCreation()Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.
optional bool reserve_on_creation = 31 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The reserveOnCreation. |
getRoadblockingType()
public RoadblockingTypeEnum.RoadblockingType getRoadblockingType()Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.
optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
RoadblockingTypeEnum.RoadblockingType |
The roadblockingType. |
getRoadblockingTypeValue()
public int getRoadblockingTypeValue()Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.
optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for roadblockingType. |
getSameAdvertiserExceptionEnabled()
public boolean getSameAdvertiserExceptionEnabled()Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
optional bool same_advertiser_exception_enabled = 52 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The sameAdvertiserExceptionEnabled. |
getSecondaryGoals(int index)
public Goal getSecondaryGoals(int index)Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.
repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Goal |
|
getSecondaryGoalsCount()
public int getSecondaryGoalsCount()Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.
repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getSecondaryGoalsList()
public List<Goal> getSecondaryGoalsList()Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.
repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Goal> |
|
getSecondaryGoalsOrBuilder(int index)
public GoalOrBuilder getSecondaryGoalsOrBuilder(int index)Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.
repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GoalOrBuilder |
|
getSecondaryGoalsOrBuilderList()
public List<? extends GoalOrBuilder> getSecondaryGoalsOrBuilderList()Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.
repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.GoalOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getSkipCrossSellingRuleWarningChecks()
public boolean getSkipCrossSellingRuleWarningChecks()Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
optional bool skip_cross_selling_rule_warning_checks = 30 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The skipCrossSellingRuleWarningChecks. |
getSkipInventoryCheck()
public boolean getSkipInventoryCheck()Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
optional bool skip_inventory_check = 29 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The skipInventoryCheck. |
getSkippableAdType()
public SkippableAdTypeEnum.SkippableAdType getSkippableAdType()Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
SkippableAdTypeEnum.SkippableAdType |
The skippableAdType. |
getSkippableAdTypeValue()
public int getSkippableAdTypeValue()Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for skippableAdType. |
getSponsorshipExclusivityEnabled()
public boolean getSponsorshipExclusivityEnabled()Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.
optional bool sponsorship_exclusivity_enabled = 89 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The sponsorshipExclusivityEnabled. |
getStartTime()
public Timestamp getStartTime()Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.
optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.
optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getStats()
public LineItemStats getStats()Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.
optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LineItemStats |
The stats. |
getStatsOrBuilder()
public LineItemStatsOrBuilder getStatsOrBuilder()Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.
optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LineItemStatsOrBuilder |
|
getStatus()
public LineItemComputedStatusEnum.LineItemComputedStatus getStatus()Output only. The status of the LineItem.
optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LineItemComputedStatusEnum.LineItemComputedStatus |
The status. |
getStatusValue()
public int getStatusValue()Output only. The status of the LineItem.
optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for status. |
getTargetEndTime()
public Timestamp getTargetEndTime()Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.
optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The targetEndTime. |
getTargetEndTimeOrBuilder()
public TimestampOrBuilder getTargetEndTimeOrBuilder()Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.
optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getTargeting()
public Targeting getTargeting()Required. Contains the targeting criteria for the ad campaign.
optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Targeting |
The targeting. |
getTargetingOrBuilder()
public TargetingOrBuilder getTargetingOrBuilder()Required. Contains the targeting criteria for the ad campaign.
optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TargetingOrBuilder |
|
getThirdPartyMeasurementSettings()
public ThirdPartyMeasurementSettings getThirdPartyMeasurementSettings()Optional. Third party auto-pixeling settings for cross-sell Partners.
optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ThirdPartyMeasurementSettings |
The thirdPartyMeasurementSettings. |
getThirdPartyMeasurementSettingsOrBuilder()
public ThirdPartyMeasurementSettingsOrBuilder getThirdPartyMeasurementSettingsOrBuilder()Optional. Third party auto-pixeling settings for cross-sell Partners.
optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ThirdPartyMeasurementSettingsOrBuilder |
|
getUpdateSource()
public String getUpdateSource()Output only. The application that last modified this line item.
optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The updateSource. |
getUpdateSourceBytes()
public ByteString getUpdateSourceBytes()Output only. The application that last modified this line item.
optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for updateSource. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. The time this line item was last modified.
optional .google.protobuf.Timestamp update_time = 57 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time this line item was last modified.
optional .google.protobuf.Timestamp update_time = 57 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getValueCpm()
public Money getValueCpm()Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.
optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
com.google.type.Money |
The valueCpm. |
getValueCpmOrBuilder()
public MoneyOrBuilder getValueCpmOrBuilder()Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.
optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
com.google.type.MoneyOrBuilder |
|
getViewabilityProviderCompanies(int index)
public String getViewabilityProviderCompanies(int index)Optional. Optional IDs of the Company that provide ad verification for this line item.
repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The viewabilityProviderCompanies at the given index. |
getViewabilityProviderCompaniesBytes(int index)
public ByteString getViewabilityProviderCompaniesBytes(int index)Optional. Optional IDs of the Company that provide ad verification for this line item.
repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the viewabilityProviderCompanies at the given index. |
getViewabilityProviderCompaniesCount()
public int getViewabilityProviderCompaniesCount()Optional. Optional IDs of the Company that provide ad verification for this line item.
repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of viewabilityProviderCompanies. |
getViewabilityProviderCompaniesList()
public ProtocolStringList getViewabilityProviderCompaniesList()Optional. Optional IDs of the Company that provide ad verification for this line item.
repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the viewabilityProviderCompanies. |
getWebPropertyCode()
public String getWebPropertyCode()Optional. The web property code used for dynamic allocation line items. This web property is only required with line item types AD_EXCHANGE and ADSENSE.
optional string web_property_code = 49 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The webPropertyCode. |
getWebPropertyCodeBytes()
public ByteString getWebPropertyCodeBytes()Optional. The web property code used for dynamic allocation line items. This web property is only required with line item types AD_EXCHANGE and ADSENSE.
optional string web_property_code = 49 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for webPropertyCode. |
getYoutubeKidsRestricted()
public boolean getYoutubeKidsRestricted()Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.
optional bool youtube_kids_restricted = 74 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The youtubeKidsRestricted. |
hasAllowOverbook()
public boolean hasAllowOverbook()Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
optional bool allow_overbook = 28 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the allowOverbook field is set. |
hasArchived()
public boolean hasArchived()Output only. The archival status of the LineItem.
optional bool archived = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the archived field is set. |
hasAutoExtensionDays()
public boolean hasAutoExtensionDays()Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.
optional int32 auto_extension_days = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the autoExtensionDays field is set. |
hasBudget()
public boolean hasBudget()Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
optional .google.type.Money budget = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the budget field is set. |
hasChildContentEligibility()
public boolean hasChildContentEligibility()Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.
optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the childContentEligibility field is set. |
hasCompanionDeliveryOption()
public boolean hasCompanionDeliveryOption()Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:
- The "Guaranteed roadblocks" feature is enabled on your network.
- One of the following is true (both cannot be true, these are mutually exclusive).
- The environmentType is VIDEO_PLAYER.
- The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the companionDeliveryOption field is set. |
hasCompetitiveConstraintScope()
public boolean hasCompetitiveConstraintScope()Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.
optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the competitiveConstraintScope field is set. |
hasContractedUnitsBought()
public boolean hasContractedUnitsBought()Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.
optional int64 contracted_units_bought = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the contractedUnitsBought field is set. |
hasCostType()
public boolean hasCostType()Required. The method used for billing this LineItem.
optional .google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType cost_type = 22 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the costType field is set. |
hasCreateTime()
public boolean hasCreateTime()Output only. The time this line item was created.
optional .google.protobuf.Timestamp create_time = 58 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasCreativeRotationType()
public boolean hasCreativeRotationType()Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.
optional .google.ads.admanager.v1.CreativeRotationTypeEnum.CreativeRotationType creative_rotation_type = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the creativeRotationType field is set. |
hasCustomPacingCurve()
public boolean hasCustomPacingCurve()Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.
optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customPacingCurve field is set. |
hasCustomVastExtension()
public boolean hasCustomVastExtension()Optional. Custom XML to be rendered in a custom VAST response at serving time.
optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customVastExtension field is set. |
hasDealInfo()
public boolean hasDealInfo()Optional. The deal information associated with this line item, if it is programmatic.
optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dealInfo field is set. |
hasDeliveryForecastSource()
public boolean hasDeliveryForecastSource()Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.
optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deliveryForecastSource field is set. |
hasDeliveryIndicator()
public boolean hasDeliveryIndicator()Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:
- The line item is not delivering.
- The line item has an unlimited goal or cap.
- The line item has a percentage based goal or cap.
optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deliveryIndicator field is set. |
hasDeliveryRateType()
public boolean hasDeliveryRateType()Optional. Non-empty default. The strategy for delivering ads over the course of the line item's duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network's configuration.
optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deliveryRateType field is set. |
hasDiscount()
public boolean hasDiscount()Optional. Discount information for the line item.
optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the discount field is set. |
hasDisplayName()
public boolean hasDisplayName()Required. The name of the line item. This attribute has a maximum length of 255 characters.
optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the displayName field is set. |
hasEndTime()
public boolean hasEndTime()Output only. The timestamp when the LineItem will stop serving. This attribute includes auto extension days.
optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasEndTimeUnlimited()
public boolean hasEndTimeUnlimited()Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.
optional bool end_time_unlimited = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endTimeUnlimited field is set. |
hasEnvironmentType()
public boolean hasEnvironmentType()Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the environmentType field is set. |
hasExternalLineItemId()
public boolean hasExternalLineItemId()Optional. An identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the externalLineItemId field is set. |
hasGoal()
public boolean hasGoal()Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.
optional .google.ads.admanager.v1.Goal goal = 76 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the goal field is set. |
hasGrpSettings()
public boolean hasGrpSettings()Optional. Contains the information for a line item which has a target GRP demographic.
optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the grpSettings field is set. |
hasLineItemType()
public boolean hasLineItemType()Required. Indicates the line item type of a LineItem. The line item type determines the default priority of the line item. More information can be found at https://support.google.com/admanager/answer/177279.
optional .google.ads.admanager.v1.LineItemTypeEnum.LineItemType line_item_type = 17 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lineItemType field is set. |
hasMaxVideoCreativeDuration()
public boolean hasMaxVideoCreativeDuration()Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.
optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxVideoCreativeDuration field is set. |
hasMissingCreatives()
public boolean hasMissingCreatives()Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:
- Not enough Creative creatives of a certain size have been uploaded, as determined by expected_creative_count. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.
- The [Creative.applied_labels][] of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
optional bool missing_creatives = 61 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the missingCreatives field is set. |
hasNotes()
public boolean hasNotes()Optional. Provides any additional notes that may annotate the LineItem. This attribute has a maximum length of 65,535 characters.
optional string notes = 54 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the notes field is set. |
hasOrder()
public boolean hasOrder() Required. Immutable. The ID of the Order to which the LineItem belongs.
Format: networks/{network_code}/orders/{order}
optional string order = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the order field is set. |
hasOrderDisplayName()
public boolean hasOrderDisplayName()Output only. The name of the Order.
optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the orderDisplayName field is set. |
hasPriority()
public boolean hasPriority()Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:
- LineItemType: default priority (minimum priority, maximum priority)
- SPONSORSHIP: 4 (2, 5)
- STANDARD: 8 (6, 10)
- NETWORK: 12 (11, 14)
- BULK: 12 (11, 14)
- PRICE_PRIORITY: 12 (11, 14)
- HOUSE: 16 (15, 16)
- CLICK_TRACKING: 16 (1, 16)
- AD_EXCHANGE: 12 (1, 16)
- ADSENSE: 12 (1, 16)
- BUMPER: 16 (15, 16)
- ADMOB: 21 (1, 16)
- PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.
optional int32 priority = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the priority field is set. |
hasRate()
public boolean hasRate()Required. The amount of money to spend per impression or click.
optional .google.type.Money rate = 20 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rate field is set. |
hasRepeatedCreativeServingEnabled()
public boolean hasRepeatedCreativeServingEnabled()Optional. Indicates whether repeated creative serving is enabled for this line item.
optional bool repeated_creative_serving_enabled = 90 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the repeatedCreativeServingEnabled field is set. |
hasReservationStatus()
public boolean hasReservationStatus()Output only. Describes whether or not inventory has been reserved for the LineItem.
optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reservationStatus field is set. |
hasReserveOnCreation()
public boolean hasReserveOnCreation()Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.
optional bool reserve_on_creation = 31 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reserveOnCreation field is set. |
hasRoadblockingType()
public boolean hasRoadblockingType()Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.
optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the roadblockingType field is set. |
hasSameAdvertiserExceptionEnabled()
public boolean hasSameAdvertiserExceptionEnabled()Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
optional bool same_advertiser_exception_enabled = 52 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sameAdvertiserExceptionEnabled field is set. |
hasSkipCrossSellingRuleWarningChecks()
public boolean hasSkipCrossSellingRuleWarningChecks()Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
optional bool skip_cross_selling_rule_warning_checks = 30 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the skipCrossSellingRuleWarningChecks field is set. |
hasSkipInventoryCheck()
public boolean hasSkipInventoryCheck()Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
optional bool skip_inventory_check = 29 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the skipInventoryCheck field is set. |
hasSkippableAdType()
public boolean hasSkippableAdType()Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the skippableAdType field is set. |
hasSponsorshipExclusivityEnabled()
public boolean hasSponsorshipExclusivityEnabled()Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.
optional bool sponsorship_exclusivity_enabled = 89 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sponsorshipExclusivityEnabled field is set. |
hasStartTime()
public boolean hasStartTime()Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.
optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |
hasStats()
public boolean hasStats()Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.
optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the stats field is set. |
hasStatus()
public boolean hasStatus()Output only. The status of the LineItem.
optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the status field is set. |
hasTargetEndTime()
public boolean hasTargetEndTime()Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.
optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the targetEndTime field is set. |
hasTargeting()
public boolean hasTargeting()Required. Contains the targeting criteria for the ad campaign.
optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the targeting field is set. |
hasThirdPartyMeasurementSettings()
public boolean hasThirdPartyMeasurementSettings()Optional. Third party auto-pixeling settings for cross-sell Partners.
optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the thirdPartyMeasurementSettings field is set. |
hasUpdateSource()
public boolean hasUpdateSource()Output only. The application that last modified this line item.
optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateSource field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. The time this line item was last modified.
optional .google.protobuf.Timestamp update_time = 57 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
hasValueCpm()
public boolean hasValueCpm()Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.
optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the valueCpm field is set. |
hasWebPropertyCode()
public boolean hasWebPropertyCode()Optional. The web property code used for dynamic allocation line items. This web property is only required with line item types AD_EXCHANGE and ADSENSE.
optional string web_property_code = 49 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the webPropertyCode field is set. |
hasYoutubeKidsRestricted()
public boolean hasYoutubeKidsRestricted()Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.
optional bool youtube_kids_restricted = 74 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the youtubeKidsRestricted field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public LineItem.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
LineItem.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected LineItem.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
LineItem.Builder |
|
toBuilder()
public LineItem.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
LineItem.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|