role property

String? role
getter/setter pair

The role of this asset for the creative.

Optional. Possible string values are:

  • "ASSET_ROLE_UNSPECIFIED" : Asset role is not specified or is unknown in this version.
  • "ASSET_ROLE_MAIN" : The asset is the main asset of the creative.
  • "ASSET_ROLE_BACKUP" : The asset is a backup asset of the creative.
  • "ASSET_ROLE_POLITE_LOAD" : The asset is a polite load asset of the creative.
  • "ASSET_ROLE_HEADLINE" : Headline of a native creative. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • "ASSET_ROLE_LONG_HEADLINE" : Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • "ASSET_ROLE_BODY" : Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • "ASSET_ROLE_LONG_BODY" : Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • "ASSET_ROLE_CAPTION_URL" : A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • "ASSET_ROLE_CALL_TO_ACTION" : The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • "ASSET_ROLE_ADVERTISER_NAME" : The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • "ASSET_ROLE_PRICE" : The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.
  • "ASSET_ROLE_ANDROID_APP_ID" : The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in https://play.google.com/store/apps/details?id=com.company.appname the identifier is com.company.appname. Assets of this role are read-only.
  • "ASSET_ROLE_IOS_APP_ID" : The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after "id". For example, in https://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is 422689480. Assets of this role are read-only.
  • "ASSET_ROLE_RATING" : The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.
  • "ASSET_ROLE_ICON" : The icon of a creative. This role is only supported and required in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • "ASSET_ROLE_COVER_IMAGE" : The cover image of a native video creative. This role is only supported and required in the following creative_type: * CREATIVE_TYPE_VIDEO
  • "ASSET_ROLE_BACKGROUND_COLOR" : The main color to use in a creative. This role is only supported and required in the following creative_type: * CREATIVE_TYPE_ASSET_BASED_CREATIVE
  • "ASSET_ROLE_ACCENT_COLOR" : The accent color to use in a creative. This role is only supported and required in the following creative_type: * CREATIVE_TYPE_ASSET_BASED_CREATIVE
  • "ASSET_ROLE_REQUIRE_LOGO" : Whether the creative must use a logo asset. This role is only supported and required in the following creative_type: * CREATIVE_TYPE_ASSET_BASED_CREATIVE
  • "ASSET_ROLE_REQUIRE_IMAGE" : Whether the creative must use an image asset. This role is only supported and required in the following creative_type: * CREATIVE_TYPE_ASSET_BASED_CREATIVE
  • "ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS" : Whether asset enhancements can be applied to the creative. This role is only supported and required in the following creative_type: * CREATIVE_TYPE_ASSET_BASED_CREATIVE

Implementation

core.String? role;