Package com.google.ads.googleads.v18.resources

Class CampaignAsset

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.CampaignAsset
All Implemented Interfaces:
CampaignAssetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class CampaignAsset extends com.google.protobuf.GeneratedMessageV3 implements CampaignAssetOrBuilder
 A link between a Campaign and an Asset.
Protobuf type google.ads.googleads.v18.resources.CampaignAsset
See Also:

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • CAMPAIGN_FIELD_NUMBER

      public static final int CAMPAIGN_FIELD_NUMBER
      See Also:

    • ASSET_FIELD_NUMBER

      public static final int ASSET_FIELD_NUMBER
      See Also:

    • FIELD_TYPE_FIELD_NUMBER

      public static final int FIELD_TYPE_FIELD_NUMBER
      See Also:

    • SOURCE_FIELD_NUMBER

      public static final int SOURCE_FIELD_NUMBER
      See Also:

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • PRIMARY_STATUS_FIELD_NUMBER

      public static final int PRIMARY_STATUS_FIELD_NUMBER
      See Also:

    • PRIMARY_STATUS_DETAILS_FIELD_NUMBER

      public static final int PRIMARY_STATUS_DETAILS_FIELD_NUMBER
      See Also:

    • PRIMARY_STATUS_REASONS_FIELD_NUMBER

      public static final int PRIMARY_STATUS_REASONS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the campaign asset.
 CampaignAsset resource names have the form:

 `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface CampaignAssetOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the campaign asset.
 CampaignAsset resource names have the form:

 `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface CampaignAssetOrBuilder
      Returns:
      The bytes for resourceName.

    • hasCampaign

      public boolean hasCampaign()
       Immutable. The campaign to which the asset is linked.
      optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      hasCampaign in interface CampaignAssetOrBuilder
      Returns:
      Whether the campaign field is set.

    • getCampaign

      public String getCampaign()
       Immutable. The campaign to which the asset is linked.
      optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaign in interface CampaignAssetOrBuilder
      Returns:
      The campaign.

    • getCampaignBytes

      public com.google.protobuf.ByteString getCampaignBytes()
       Immutable. The campaign to which the asset is linked.
      optional string campaign = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaignBytes in interface CampaignAssetOrBuilder
      Returns:
      The bytes for campaign.

    • hasAsset

      public boolean hasAsset()
       Immutable. The asset which is linked to the campaign.
      optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      hasAsset in interface CampaignAssetOrBuilder
      Returns:
      Whether the asset field is set.

    • getAsset

      public String getAsset()
       Immutable. The asset which is linked to the campaign.
      optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getAsset in interface CampaignAssetOrBuilder
      Returns:
      The asset.

    • getAssetBytes

      public com.google.protobuf.ByteString getAssetBytes()
       Immutable. The asset which is linked to the campaign.
      optional string asset = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getAssetBytes in interface CampaignAssetOrBuilder
      Returns:
      The bytes for asset.

    • getFieldTypeValue

      public int getFieldTypeValue()
       Immutable. Role that the asset takes under the linked campaign.
 Required.
      .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getFieldTypeValue in interface CampaignAssetOrBuilder
      Returns:
      The enum numeric value on the wire for fieldType.

    • getFieldType

      public AssetFieldTypeEnum.AssetFieldType getFieldType()
       Immutable. Role that the asset takes under the linked campaign.
 Required.
      .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getFieldType in interface CampaignAssetOrBuilder
      Returns:
      The fieldType.

    • getSourceValue

      public int getSourceValue()
       Output only. Source of the campaign asset link.
      .google.ads.googleads.v18.enums.AssetSourceEnum.AssetSource source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSourceValue in interface CampaignAssetOrBuilder
      Returns:
      The enum numeric value on the wire for source.

    • getSource

      public AssetSourceEnum.AssetSource getSource()
       Output only. Source of the campaign asset link.
      .google.ads.googleads.v18.enums.AssetSourceEnum.AssetSource source = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSource in interface CampaignAssetOrBuilder
      Returns:
      The source.

    • getStatusValue

      public int getStatusValue()
       Status of the campaign asset.
      .google.ads.googleads.v18.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
      Specified by:
      getStatusValue in interface CampaignAssetOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      public AssetLinkStatusEnum.AssetLinkStatus getStatus()
       Status of the campaign asset.
      .google.ads.googleads.v18.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
      Specified by:
      getStatus in interface CampaignAssetOrBuilder
      Returns:
      The status.

    • getPrimaryStatusValue

      public int getPrimaryStatusValue()
       Output only. Provides the PrimaryStatus of this asset link.
 Primary status is meant essentially to differentiate between the plain
 "status" field, which has advertiser set values of enabled, paused, or
 removed.  The primary status takes into account other signals (for assets
 its mainly policy and quality approvals) to come up with a more
 comprehensive status to indicate its serving state.
      .google.ads.googleads.v18.enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusValue in interface CampaignAssetOrBuilder
      Returns:
      The enum numeric value on the wire for primaryStatus.

    • getPrimaryStatus

      public AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus getPrimaryStatus()
       Output only. Provides the PrimaryStatus of this asset link.
 Primary status is meant essentially to differentiate between the plain
 "status" field, which has advertiser set values of enabled, paused, or
 removed.  The primary status takes into account other signals (for assets
 its mainly policy and quality approvals) to come up with a more
 comprehensive status to indicate its serving state.
      .google.ads.googleads.v18.enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatus in interface CampaignAssetOrBuilder
      Returns:
      The primaryStatus.

    • getPrimaryStatusDetailsList

      public List<AssetLinkPrimaryStatusDetails> getPrimaryStatusDetailsList()
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusDetailsList in interface CampaignAssetOrBuilder

    • getPrimaryStatusDetailsOrBuilderList

      public List<? extends AssetLinkPrimaryStatusDetailsOrBuilder> getPrimaryStatusDetailsOrBuilderList()
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusDetailsOrBuilderList in interface CampaignAssetOrBuilder

    • getPrimaryStatusDetailsCount

      public int getPrimaryStatusDetailsCount()
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusDetailsCount in interface CampaignAssetOrBuilder

    • getPrimaryStatusDetails

      public AssetLinkPrimaryStatusDetails getPrimaryStatusDetails(int index)
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusDetails in interface CampaignAssetOrBuilder

    • getPrimaryStatusDetailsOrBuilder

      public AssetLinkPrimaryStatusDetailsOrBuilder getPrimaryStatusDetailsOrBuilder(int index)
       Output only. Provides the details of the primary status and its associated
 reasons.
      repeated .google.ads.googleads.v18.common.AssetLinkPrimaryStatusDetails primary_status_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusDetailsOrBuilder in interface CampaignAssetOrBuilder

    • getPrimaryStatusReasonsList

      public List<AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason> getPrimaryStatusReasonsList()
       Output only. Provides a list of reasons for why an asset is not serving or
 not serving at full capacity.
      repeated .google.ads.googleads.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsList in interface CampaignAssetOrBuilder
      Returns:
      A list containing the primaryStatusReasons.

    • getPrimaryStatusReasonsCount

      public int getPrimaryStatusReasonsCount()
       Output only. Provides a list of reasons for why an asset is not serving or
 not serving at full capacity.
      repeated .google.ads.googleads.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsCount in interface CampaignAssetOrBuilder
      Returns:
      The count of primaryStatusReasons.

    • getPrimaryStatusReasons

      public AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason getPrimaryStatusReasons(int index)
       Output only. Provides a list of reasons for why an asset is not serving or
 not serving at full capacity.
      repeated .google.ads.googleads.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasons in interface CampaignAssetOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The primaryStatusReasons at the given index.

    • getPrimaryStatusReasonsValueList

      public List<Integer> getPrimaryStatusReasonsValueList()
       Output only. Provides a list of reasons for why an asset is not serving or
 not serving at full capacity.
      repeated .google.ads.googleads.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsValueList in interface CampaignAssetOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for primaryStatusReasons.

    • getPrimaryStatusReasonsValue

      public int getPrimaryStatusReasonsValue(int index)
       Output only. Provides a list of reasons for why an asset is not serving or
 not serving at full capacity.
      repeated .google.ads.googleads.v18.enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPrimaryStatusReasonsValue in interface CampaignAssetOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of primaryStatusReasons at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CampaignAsset parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CampaignAsset parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CampaignAsset parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CampaignAsset parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CampaignAsset parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CampaignAsset parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CampaignAsset parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CampaignAsset parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CampaignAsset parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CampaignAsset parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CampaignAsset parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CampaignAsset parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CampaignAsset.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CampaignAsset.Builder newBuilder()

    • newBuilder

      public static CampaignAsset.Builder newBuilder(CampaignAsset prototype)

    • toBuilder

      public CampaignAsset.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CampaignAsset.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static CampaignAsset getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CampaignAsset> parser()

    • getParserForType

      public com.google.protobuf.Parser<CampaignAsset> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public CampaignAsset getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder