Package com.google.ads.googleads.v24.actions

Class ShareablePreview

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v24.actions.ShareablePreview
All Implemented Interfaces:
ShareablePreviewOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ShareablePreview extends com.google.protobuf.GeneratedMessage implements ShareablePreviewOrBuilder
 A shareable preview with its identifier.

 Only Performance Max asset groups and certain YouTube video/audio ad formats
 are supported. Other ad types, such as Responsive Search Ads or Responsive
 Display Ads, are not supported and return an `UNSUPPORTED_AD_TYPE` error.

 The generated preview URLs cannot be embedded in an iframe because the
 response headers include `X-Frame-Options: deny`.
Protobuf type google.ads.googleads.v24.actions.ShareablePreview
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ShareablePreview.Builder
    A shareable preview with its identifier.
    static enum 
    ShareablePreview.IdentifierCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AD_GROUP_AD_FIELD_NUMBER
     
    static final int
    ASSET_GROUP_FIELD_NUMBER
     
    static final int
    PREVIEW_TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAdGroupAd()
    Ad group ad of the shareable preview.
    com.google.protobuf.ByteString
    getAdGroupAdBytes()
    Ad group ad of the shareable preview.
    String
    getAssetGroup()
    Asset group of the shareable preview.
    com.google.protobuf.ByteString
    getAssetGroupBytes()
    Asset group of the shareable preview.
    static ShareablePreview
    getDefaultInstance()
     
    ShareablePreview
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ShareablePreview.IdentifierCase
    getIdentifierCase()
     
    com.google.protobuf.Parser<ShareablePreview>
    getParserForType()
     
    PreviewTypeEnum.PreviewType
    getPreviewType()
    Required.
    int
    getPreviewTypeValue()
    Required.
    int
    getSerializedSize()
     
    boolean
    hasAdGroupAd()
    Ad group ad of the shareable preview.
    boolean
    hasAssetGroup()
    Asset group of the shareable preview.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ShareablePreview.Builder
    newBuilder()
     
    static ShareablePreview.Builder
    newBuilder(ShareablePreview prototype)
     
    ShareablePreview.Builder
    newBuilderForType()
     
    protected ShareablePreview.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ShareablePreview
    parseDelimitedFrom(InputStream input)
     
    static ShareablePreview
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ShareablePreview
    parseFrom(byte[] data)
     
    static ShareablePreview
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ShareablePreview
    parseFrom(com.google.protobuf.ByteString data)
     
    static ShareablePreview
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ShareablePreview
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ShareablePreview
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ShareablePreview
    parseFrom(InputStream input)
     
    static ShareablePreview
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ShareablePreview
    parseFrom(ByteBuffer data)
     
    static ShareablePreview
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ShareablePreview>
    parser()
     
    ShareablePreview.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • PREVIEW_TYPE_FIELD_NUMBER

      public static final int PREVIEW_TYPE_FIELD_NUMBER
      See Also:

    • AD_GROUP_AD_FIELD_NUMBER

      public static final int AD_GROUP_AD_FIELD_NUMBER
      See Also:

    • ASSET_GROUP_FIELD_NUMBER

      public static final int ASSET_GROUP_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getIdentifierCase

      public ShareablePreview.IdentifierCase getIdentifierCase()
      Specified by:
      getIdentifierCase in interface ShareablePreviewOrBuilder

    • getPreviewTypeValue

      public int getPreviewTypeValue()
       Required. The type of preview to generate.
      .google.ads.googleads.v24.enums.PreviewTypeEnum.PreviewType preview_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPreviewTypeValue in interface ShareablePreviewOrBuilder
      Returns:
      The enum numeric value on the wire for previewType.

    • getPreviewType

      public PreviewTypeEnum.PreviewType getPreviewType()
       Required. The type of preview to generate.
      .google.ads.googleads.v24.enums.PreviewTypeEnum.PreviewType preview_type = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPreviewType in interface ShareablePreviewOrBuilder
      Returns:
      The previewType.

    • hasAdGroupAd

      public boolean hasAdGroupAd()
       Ad group ad of the shareable preview. Only supported for preview type
 YOUTUBE_LIVE_PREVIEW.
 Format: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}
      string ad_group_ad = 2;
      Specified by:
      hasAdGroupAd in interface ShareablePreviewOrBuilder
      Returns:
      Whether the adGroupAd field is set.

    • getAdGroupAd

      public String getAdGroupAd()
       Ad group ad of the shareable preview. Only supported for preview type
 YOUTUBE_LIVE_PREVIEW.
 Format: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}
      string ad_group_ad = 2;
      Specified by:
      getAdGroupAd in interface ShareablePreviewOrBuilder
      Returns:
      The adGroupAd.

    • getAdGroupAdBytes

      public com.google.protobuf.ByteString getAdGroupAdBytes()
       Ad group ad of the shareable preview. Only supported for preview type
 YOUTUBE_LIVE_PREVIEW.
 Format: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}
      string ad_group_ad = 2;
      Specified by:
      getAdGroupAdBytes in interface ShareablePreviewOrBuilder
      Returns:
      The bytes for adGroupAd.

    • hasAssetGroup

      public boolean hasAssetGroup()
       Asset group of the shareable preview.
 Format: customers/{customer_id}/assetGroups/{asset_group_id}
      string asset_group = 3;
      Specified by:
      hasAssetGroup in interface ShareablePreviewOrBuilder
      Returns:
      Whether the assetGroup field is set.

    • getAssetGroup

      public String getAssetGroup()
       Asset group of the shareable preview.
 Format: customers/{customer_id}/assetGroups/{asset_group_id}
      string asset_group = 3;
      Specified by:
      getAssetGroup in interface ShareablePreviewOrBuilder
      Returns:
      The assetGroup.

    • getAssetGroupBytes

      public com.google.protobuf.ByteString getAssetGroupBytes()
       Asset group of the shareable preview.
 Format: customers/{customer_id}/assetGroups/{asset_group_id}
      string asset_group = 3;
      Specified by:
      getAssetGroupBytes in interface ShareablePreviewOrBuilder
      Returns:
      The bytes for assetGroup.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 ShareablePreview parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ShareablePreview.Builder newBuilder()

    • newBuilder

      public static ShareablePreview.Builder newBuilder(ShareablePreview prototype)

    • toBuilder

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

    • newBuilderForType

      protected ShareablePreview.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ShareablePreview getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ShareablePreview> 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.GeneratedMessage

    • getDefaultInstanceForType

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