Package com.google.ads.googleads.v13.resources

Class FeedMapping

  • All Implemented Interfaces:
    FeedMappingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class FeedMapping
extends com.google.protobuf.GeneratedMessageV3
implements FeedMappingOrBuilder
     A feed mapping.
    Protobuf type google.ads.googleads.v13.resources.FeedMapping
    See Also:
    Serialized Form

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ATTRIBUTE_FIELD_MAPPINGS_FIELD_NUMBER

        public static final int ATTRIBUTE_FIELD_MAPPINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PLACEHOLDER_TYPE_FIELD_NUMBER

        public static final int PLACEHOLDER_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CRITERION_TYPE_FIELD_NUMBER

        public static final int CRITERION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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 java.lang.String getResourceName()
         Immutable. The resource name of the feed mapping.
 Feed mapping resource names have the form:

 `customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface FeedMappingOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the feed mapping.
 Feed mapping resource names have the form:

 `customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface FeedMappingOrBuilder
        Returns:
        The bytes for resourceName.

      • hasFeed

        public boolean hasFeed()
         Immutable. The feed of this feed mapping.
        optional string feed = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        hasFeed in interface FeedMappingOrBuilder
        Returns:
        Whether the feed field is set.

      • getFeed

        public java.lang.String getFeed()
         Immutable. The feed of this feed mapping.
        optional string feed = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getFeed in interface FeedMappingOrBuilder
        Returns:
        The feed.

      • getFeedBytes

        public com.google.protobuf.ByteString getFeedBytes()
         Immutable. The feed of this feed mapping.
        optional string feed = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getFeedBytes in interface FeedMappingOrBuilder
        Returns:
        The bytes for feed.

      • getAttributeFieldMappingsList

        public java.util.List<AttributeFieldMapping> getAttributeFieldMappingsList()
         Immutable. Feed attributes to field mappings. These mappings are a
 one-to-many relationship meaning that 1 feed attribute can be used to
 populate multiple placeholder fields, but 1 placeholder field can only draw
 data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
 field can be mapped to multiple feed attributes. Required.
        repeated .google.ads.googleads.v13.resources.AttributeFieldMapping attribute_field_mappings = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAttributeFieldMappingsList in interface FeedMappingOrBuilder

      • getAttributeFieldMappingsOrBuilderList

        public java.util.List<? extends AttributeFieldMappingOrBuilder> getAttributeFieldMappingsOrBuilderList()
         Immutable. Feed attributes to field mappings. These mappings are a
 one-to-many relationship meaning that 1 feed attribute can be used to
 populate multiple placeholder fields, but 1 placeholder field can only draw
 data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
 field can be mapped to multiple feed attributes. Required.
        repeated .google.ads.googleads.v13.resources.AttributeFieldMapping attribute_field_mappings = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAttributeFieldMappingsOrBuilderList in interface FeedMappingOrBuilder

      • getAttributeFieldMappingsCount

        public int getAttributeFieldMappingsCount()
         Immutable. Feed attributes to field mappings. These mappings are a
 one-to-many relationship meaning that 1 feed attribute can be used to
 populate multiple placeholder fields, but 1 placeholder field can only draw
 data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
 field can be mapped to multiple feed attributes. Required.
        repeated .google.ads.googleads.v13.resources.AttributeFieldMapping attribute_field_mappings = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAttributeFieldMappingsCount in interface FeedMappingOrBuilder

      • getAttributeFieldMappings

        public AttributeFieldMapping getAttributeFieldMappings​(int index)
         Immutable. Feed attributes to field mappings. These mappings are a
 one-to-many relationship meaning that 1 feed attribute can be used to
 populate multiple placeholder fields, but 1 placeholder field can only draw
 data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
 field can be mapped to multiple feed attributes. Required.
        repeated .google.ads.googleads.v13.resources.AttributeFieldMapping attribute_field_mappings = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAttributeFieldMappings in interface FeedMappingOrBuilder

      • getAttributeFieldMappingsOrBuilder

        public AttributeFieldMappingOrBuilder getAttributeFieldMappingsOrBuilder​(int index)
         Immutable. Feed attributes to field mappings. These mappings are a
 one-to-many relationship meaning that 1 feed attribute can be used to
 populate multiple placeholder fields, but 1 placeholder field can only draw
 data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
 field can be mapped to multiple feed attributes. Required.
        repeated .google.ads.googleads.v13.resources.AttributeFieldMapping attribute_field_mappings = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAttributeFieldMappingsOrBuilder in interface FeedMappingOrBuilder

      • getStatusValue

        public int getStatusValue()
         Output only. Status of the feed mapping.
 This field is read-only.
        .google.ads.googleads.v13.enums.FeedMappingStatusEnum.FeedMappingStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface FeedMappingOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        public FeedMappingStatusEnum.FeedMappingStatus getStatus()
         Output only. Status of the feed mapping.
 This field is read-only.
        .google.ads.googleads.v13.enums.FeedMappingStatusEnum.FeedMappingStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatus in interface FeedMappingOrBuilder
        Returns:
        The status.

      • hasPlaceholderType

        public boolean hasPlaceholderType()
         Immutable. The placeholder type of this mapping (for example, if the
 mapping maps feed attributes to placeholder fields).
        .google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasPlaceholderType in interface FeedMappingOrBuilder
        Returns:
        Whether the placeholderType field is set.

      • getPlaceholderTypeValue

        public int getPlaceholderTypeValue()
         Immutable. The placeholder type of this mapping (for example, if the
 mapping maps feed attributes to placeholder fields).
        .google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPlaceholderTypeValue in interface FeedMappingOrBuilder
        Returns:
        The enum numeric value on the wire for placeholderType.

      • getPlaceholderType

        public PlaceholderTypeEnum.PlaceholderType getPlaceholderType()
         Immutable. The placeholder type of this mapping (for example, if the
 mapping maps feed attributes to placeholder fields).
        .google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPlaceholderType in interface FeedMappingOrBuilder
        Returns:
        The placeholderType.

      • hasCriterionType

        public boolean hasCriterionType()
         Immutable. The criterion type of this mapping (for example, if the
 mapping maps feed attributes to criterion fields).
        .google.ads.googleads.v13.enums.FeedMappingCriterionTypeEnum.FeedMappingCriterionType criterion_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasCriterionType in interface FeedMappingOrBuilder
        Returns:
        Whether the criterionType field is set.

      • getCriterionTypeValue

        public int getCriterionTypeValue()
         Immutable. The criterion type of this mapping (for example, if the
 mapping maps feed attributes to criterion fields).
        .google.ads.googleads.v13.enums.FeedMappingCriterionTypeEnum.FeedMappingCriterionType criterion_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getCriterionTypeValue in interface FeedMappingOrBuilder
        Returns:
        The enum numeric value on the wire for criterionType.

      • getCriterionType

        public FeedMappingCriterionTypeEnum.FeedMappingCriterionType getCriterionType()
         Immutable. The criterion type of this mapping (for example, if the
 mapping maps feed attributes to criterion fields).
        .google.ads.googleads.v13.enums.FeedMappingCriterionTypeEnum.FeedMappingCriterionType criterion_type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getCriterionType in interface FeedMappingOrBuilder
        Returns:
        The criterionType.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 FeedMapping parseFrom​(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FeedMapping parseFrom​(java.nio.ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static FeedMapping parseFrom​(java.io.InputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FeedMapping parseFrom​(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static FeedMapping parseDelimitedFrom​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static FeedMapping parseDelimitedFrom​(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FeedMapping parseFrom​(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FeedMapping parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static FeedMapping getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<FeedMapping> 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 FeedMapping getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder