Creative (Ad Exchange Buyer API II v2beta1-rev20210613-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.adexchangebuyer2.v2beta1.model.Creative

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Creative
extends GenericJson
```
A creative and its classification data.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Ad Exchange Buyer API II. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Creative()

Constructors
Constructor and Description
`Creative()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Creative`	`clone()`
`String`	`getAccountId()` The account that this creative belongs to.
`String`	`getAdChoicesDestinationUrl()` The link to AdChoices destination page.
`AdTechnologyProviders`	`getAdTechnologyProviders()` Output only.
`String`	`getAdvertiserName()` The name of the company being advertised in the creative.
`Long`	`getAgencyId()` The agency ID for this creative.
`String`	`getApiUpdateTime()` Output only.
`List<String>`	`getAttributes()` All attributes for the ads that may be shown from this creative.
`List<String>`	`getClickThroughUrls()` The set of destination URLs for the creative.
`List<Correction>`	`getCorrections()` Output only.
`String`	`getCreativeId()` The buyer-defined creative ID of this creative.
`String`	`getDealsStatus()` Output only.
`List<String>`	`getDeclaredClickThroughUrls()` The set of declared destination URLs for the creative.
`List<Long>`	`getDetectedAdvertiserIds()` Output only.
`List<String>`	`getDetectedDomains()` Output only.
`List<String>`	`getDetectedLanguages()` Output only.
`List<Integer>`	`getDetectedProductCategories()` Output only.
`List<Integer>`	`getDetectedSensitiveCategories()` Output only.
`HtmlContent`	`getHtml()` An HTML creative.
`List<String>`	`getImpressionTrackingUrls()` The set of URLs to be called to record an impression.
`NativeContent`	`getNative()` A native creative.
`String`	`getOpenAuctionStatus()` Output only.
`List<String>`	`getRestrictedCategories()` All restricted categories for the ads that may be shown from this creative.
`List<ServingRestriction>`	`getServingRestrictions()` Output only.
`List<Integer>`	`getVendorIds()` All vendor IDs for the ads that may be shown from this creative.
`Integer`	`getVersion()` Output only.
`VideoContent`	`getVideo()` A video creative.
`Creative`	`set(String fieldName, Object value)`
`Creative`	`setAccountId(String accountId)` The account that this creative belongs to.
`Creative`	`setAdChoicesDestinationUrl(String adChoicesDestinationUrl)` The link to AdChoices destination page.
`Creative`	`setAdTechnologyProviders(AdTechnologyProviders adTechnologyProviders)` Output only.
`Creative`	`setAdvertiserName(String advertiserName)` The name of the company being advertised in the creative.
`Creative`	`setAgencyId(Long agencyId)` The agency ID for this creative.
`Creative`	`setApiUpdateTime(String apiUpdateTime)` Output only.
`Creative`	`setAttributes(List<String> attributes)` All attributes for the ads that may be shown from this creative.
`Creative`	`setClickThroughUrls(List<String> clickThroughUrls)` The set of destination URLs for the creative.
`Creative`	`setCorrections(List<Correction> corrections)` Output only.
`Creative`	`setCreativeId(String creativeId)` The buyer-defined creative ID of this creative.
`Creative`	`setDealsStatus(String dealsStatus)` Output only.
`Creative`	`setDeclaredClickThroughUrls(List<String> declaredClickThroughUrls)` The set of declared destination URLs for the creative.
`Creative`	`setDetectedAdvertiserIds(List<Long> detectedAdvertiserIds)` Output only.
`Creative`	`setDetectedDomains(List<String> detectedDomains)` Output only.
`Creative`	`setDetectedLanguages(List<String> detectedLanguages)` Output only.
`Creative`	`setDetectedProductCategories(List<Integer> detectedProductCategories)` Output only.
`Creative`	`setDetectedSensitiveCategories(List<Integer> detectedSensitiveCategories)` Output only.
`Creative`	`setHtml(HtmlContent html)` An HTML creative.
`Creative`	`setImpressionTrackingUrls(List<String> impressionTrackingUrls)` The set of URLs to be called to record an impression.
`Creative`	`setNative(NativeContent native__)` A native creative.
`Creative`	`setOpenAuctionStatus(String openAuctionStatus)` Output only.
`Creative`	`setRestrictedCategories(List<String> restrictedCategories)` All restricted categories for the ads that may be shown from this creative.
`Creative`	`setServingRestrictions(List<ServingRestriction> servingRestrictions)` Output only.
`Creative`	`setVendorIds(List<Integer> vendorIds)` All vendor IDs for the ads that may be shown from this creative.
`Creative`	`setVersion(Integer version)` Output only.
`Creative`	`setVideo(VideoContent video)` A video creative.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Creative
```
public Creative()
```
- Method Detail
  - getAccountId
```
public String getAccountId()
```
    The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
    
    Returns:
    
    value or null for none
  - setAccountId
```
public Creative setAccountId(String accountId)
```
    The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
    
    Parameters:
    
    accountId - accountId or null for none
  - getAdChoicesDestinationUrl
```
public String getAdChoicesDestinationUrl()
```
    The link to AdChoices destination page.
    
    Returns:
    
    value or null for none
  - setAdChoicesDestinationUrl
```
public Creative setAdChoicesDestinationUrl(String adChoicesDestinationUrl)
```
    The link to AdChoices destination page.
    
    Parameters:
    
    adChoicesDestinationUrl - adChoicesDestinationUrl or null for none
  - getAdTechnologyProviders
```
public AdTechnologyProviders getAdTechnologyProviders()
```
    Output only. The detected ad technology providers.
    
    Returns:
    
    value or null for none
  - setAdTechnologyProviders
```
public Creative setAdTechnologyProviders(AdTechnologyProviders adTechnologyProviders)
```
    Output only. The detected ad technology providers.
    
    Parameters:
    
    adTechnologyProviders - adTechnologyProviders or null for none
  - getAdvertiserName
```
public String getAdvertiserName()
```
    The name of the company being advertised in the creative.
    
    Returns:
    
    value or null for none
  - setAdvertiserName
```
public Creative setAdvertiserName(String advertiserName)
```
    The name of the company being advertised in the creative.
    
    Parameters:
    
    advertiserName - advertiserName or null for none
  - getAgencyId
```
public Long getAgencyId()
```
    The agency ID for this creative.
    
    Returns:
    
    value or null for none
  - setAgencyId
```
public Creative setAgencyId(Long agencyId)
```
    The agency ID for this creative.
    
    Parameters:
    
    agencyId - agencyId or null for none
  - getApiUpdateTime
```
public String getApiUpdateTime()
```
    Output only. The last update timestamp of the creative via API.
    
    Returns:
    
    value or null for none
  - setApiUpdateTime
```
public Creative setApiUpdateTime(String apiUpdateTime)
```
    Output only. The last update timestamp of the creative via API.
    
    Parameters:
    
    apiUpdateTime - apiUpdateTime or null for none
  - getAttributes
```
public List<String> getAttributes()
```
    All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
    
    Returns:
    
    value or null for none
  - setAttributes
```
public Creative setAttributes(List<String> attributes)
```
    All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
    
    Parameters:
    
    attributes - attributes or null for none
  - getClickThroughUrls
```
public List<String> getClickThroughUrls()
```
    The set of destination URLs for the creative.
    
    Returns:
    
    value or null for none
  - setClickThroughUrls
```
public Creative setClickThroughUrls(List<String> clickThroughUrls)
```
    The set of destination URLs for the creative.
    
    Parameters:
    
    clickThroughUrls - clickThroughUrls or null for none
  - getCorrections
```
public List<Correction> getCorrections()
```
    Output only. Shows any corrections that were applied to this creative.
    
    Returns:
    
    value or null for none
  - setCorrections
```
public Creative setCorrections(List<Correction> corrections)
```
    Output only. Shows any corrections that were applied to this creative.
    
    Parameters:
    
    corrections - corrections or null for none
  - getCreativeId
```
public String getCreativeId()
```
    The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
    
    Returns:
    
    value or null for none
  - setCreativeId
```
public Creative setCreativeId(String creativeId)
```
    The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
    
    Parameters:
    
    creativeId - creativeId or null for none
  - getDealsStatus
```
public String getDealsStatus()
```
    Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
    
    Returns:
    
    value or null for none
  - setDealsStatus
```
public Creative setDealsStatus(String dealsStatus)
```
    Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
    
    Parameters:
    
    dealsStatus - dealsStatus or null for none
  - getDeclaredClickThroughUrls
```
public List<String> getDeclaredClickThroughUrls()
```
    The set of declared destination URLs for the creative.
    
    Returns:
    
    value or null for none
  - setDeclaredClickThroughUrls
```
public Creative setDeclaredClickThroughUrls(List<String> declaredClickThroughUrls)
```
    The set of declared destination URLs for the creative.
    
    Parameters:
    
    declaredClickThroughUrls - declaredClickThroughUrls or null for none
  - getDetectedAdvertiserIds
```
public List<Long> getDetectedAdvertiserIds()
```
    Output only. Detected advertiser IDs, if any.
    
    Returns:
    
    value or null for none
  - setDetectedAdvertiserIds
```
public Creative setDetectedAdvertiserIds(List<Long> detectedAdvertiserIds)
```
    Output only. Detected advertiser IDs, if any.
    
    Parameters:
    
    detectedAdvertiserIds - detectedAdvertiserIds or null for none
  - getDetectedDomains
```
public List<String> getDetectedDomains()
```
    Output only. The detected domains for this creative.
    
    Returns:
    
    value or null for none
  - setDetectedDomains
```
public Creative setDetectedDomains(List<String> detectedDomains)
```
    Output only. The detected domains for this creative.
    
    Parameters:
    
    detectedDomains - detectedDomains or null for none
  - getDetectedLanguages
```
public List<String> getDetectedLanguages()
```
    Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
    
    Returns:
    
    value or null for none
  - setDetectedLanguages
```
public Creative setDetectedLanguages(List<String> detectedLanguages)
```
    Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
    
    Parameters:
    
    detectedLanguages - detectedLanguages or null for none
  - getDetectedProductCategories
```
public List<Integer> getDetectedProductCategories()
```
    Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
    
    Returns:
    
    value or null for none
  - setDetectedProductCategories
```
public Creative setDetectedProductCategories(List<Integer> detectedProductCategories)
```
    Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
    
    Parameters:
    
    detectedProductCategories - detectedProductCategories or null for none
  - getDetectedSensitiveCategories
```
public List<Integer> getDetectedSensitiveCategories()
```
    Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
    
    Returns:
    
    value or null for none
  - setDetectedSensitiveCategories
```
public Creative setDetectedSensitiveCategories(List<Integer> detectedSensitiveCategories)
```
    Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
    
    Parameters:
    
    detectedSensitiveCategories - detectedSensitiveCategories or null for none
  - getHtml
```
public HtmlContent getHtml()
```
    An HTML creative.
    
    Returns:
    
    value or null for none
  - setHtml
```
public Creative setHtml(HtmlContent html)
```
    An HTML creative.
    
    Parameters:
    
    html - html or null for none
  - getImpressionTrackingUrls
```
public List<String> getImpressionTrackingUrls()
```
    The set of URLs to be called to record an impression.
    
    Returns:
    
    value or null for none
  - setImpressionTrackingUrls
```
public Creative setImpressionTrackingUrls(List<String> impressionTrackingUrls)
```
    The set of URLs to be called to record an impression.
    
    Parameters:
    
    impressionTrackingUrls - impressionTrackingUrls or null for none
  - getNative
```
public NativeContent getNative()
```
    A native creative.
    
    Returns:
    
    value or null for none
  - setNative
```
public Creative setNative(NativeContent native__)
```
    A native creative.
    
    Parameters:
    
    native__ - native__ or null for none
  - getOpenAuctionStatus
```
public String getOpenAuctionStatus()
```
    Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
    
    Returns:
    
    value or null for none
  - setOpenAuctionStatus
```
public Creative setOpenAuctionStatus(String openAuctionStatus)
```
    Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
    
    Parameters:
    
    openAuctionStatus - openAuctionStatus or null for none
  - getRestrictedCategories
```
public List<String> getRestrictedCategories()
```
    All restricted categories for the ads that may be shown from this creative.
    
    Returns:
    
    value or null for none
  - setRestrictedCategories
```
public Creative setRestrictedCategories(List<String> restrictedCategories)
```
    All restricted categories for the ads that may be shown from this creative.
    
    Parameters:
    
    restrictedCategories - restrictedCategories or null for none
  - getServingRestrictions
```
public List<ServingRestriction> getServingRestrictions()
```
    Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
    
    Returns:
    
    value or null for none
  - setServingRestrictions
```
public Creative setServingRestrictions(List<ServingRestriction> servingRestrictions)
```
    Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
    
    Parameters:
    
    servingRestrictions - servingRestrictions or null for none
  - getVendorIds
```
public List<Integer> getVendorIds()
```
    All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
    
    Returns:
    
    value or null for none
  - setVendorIds
```
public Creative setVendorIds(List<Integer> vendorIds)
```
    All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
    
    Parameters:
    
    vendorIds - vendorIds or null for none
  - getVersion
```
public Integer getVersion()
```
    Output only. The version of this creative.
    
    Returns:
    
    value or null for none
  - setVersion
```
public Creative setVersion(Integer version)
```
    Output only. The version of this creative.
    
    Parameters:
    
    version - version or null for none
  - getVideo
```
public VideoContent getVideo()
```
    A video creative.
    
    Returns:
    
    value or null for none
  - setVideo
```
public Creative setVideo(VideoContent video)
```
    A video creative.
    
    Parameters:
    
    video - video or null for none
  - set
```
public Creative set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Creative clone()
```
    Overrides:
    
    clone in class GenericJson

Class Creative

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Creative

Method Detail

getAccountId

setAccountId

getAdChoicesDestinationUrl

setAdChoicesDestinationUrl

getAdTechnologyProviders

setAdTechnologyProviders

getAdvertiserName

setAdvertiserName

getAgencyId

setAgencyId

getApiUpdateTime

setApiUpdateTime

getAttributes

setAttributes

getClickThroughUrls

setClickThroughUrls

getCorrections

setCorrections

getCreativeId

setCreativeId

getDealsStatus

setDealsStatus

getDeclaredClickThroughUrls

setDeclaredClickThroughUrls

getDetectedAdvertiserIds

setDetectedAdvertiserIds

getDetectedDomains

setDetectedDomains

getDetectedLanguages

setDetectedLanguages

getDetectedProductCategories

setDetectedProductCategories

getDetectedSensitiveCategories

setDetectedSensitiveCategories

getHtml

setHtml

getImpressionTrackingUrls

setImpressionTrackingUrls

getNative

setNative

getOpenAuctionStatus

setOpenAuctionStatus

getRestrictedCategories

setRestrictedCategories

getServingRestrictions

setServingRestrictions

getVendorIds

setVendorIds

getVersion

setVersion

getVideo

setVideo

set

clone