The DCM/DFA Reporting and Trafficking API v3.2 is deprecated and will be sunset on August 31st, 2019. All users must migrate to a newer API version by that date.

Ads

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a Campaign Manager ad.

{
  "kind": "dfareporting#ad",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "campaignId": long,
  "campaignIdDimensionValue": dimensionValues Resource,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "subaccountId": long,
  "accountId": long,
  "name": string,
  "active": boolean,
  "archived": boolean,
  "comments": string,
  "startTime": datetime,
  "endTime": datetime,
  "placementAssignments": [
    {
      "placementId": long,
      "placementIdDimensionValue": dimensionValues Resource,
      "active": boolean,
      "sslRequired": boolean
    }
  ],
  "eventTagOverrides": [
    {
      "id": long,
      "enabled": boolean
    }
  ],
  "clickThroughUrlSuffixProperties": {
    "overrideInheritedSuffix": boolean,
    "clickThroughUrlSuffix": string
  },
  "defaultClickThroughEventTagProperties": {
    "overrideInheritedEventTag": boolean,
    "defaultClickThroughEventTagId": long
  },
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "sslRequired": boolean,
  "sslCompliant": boolean,
  "type": string,
  "geoTargeting": {
    "excludeCountries": boolean,
    "countries": [
      countries Resource
    ],
    "regions": [
      regions Resource
    ],
    "cities": [
      cities Resource
    ],
    "metros": [
      metros Resource
    ],
    "postalCodes": [
      postalCodes Resource
    ]
  },
  "technologyTargeting": {
    "operatingSystems": [
      operatingSystems Resource
    ],
    "browsers": [
      browsers Resource
    ],
    "platformTypes": [
      platformTypes Resource
    ],
    "mobileCarriers": [
      mobileCarriers Resource
    ],
    "connectionTypes": [
      connectionTypes Resource
    ],
    "operatingSystemVersions": [
      operatingSystemVersions Resource
    ]
  },
  "dayPartTargeting": {
    "userLocalTime": boolean,
    "daysOfWeek": [
      string
    ],
    "hoursOfDay": [
      integer
    ]
  },
  "deliverySchedule": {
    "hardCutoff": boolean,
    "priority": string,
    "impressionRatio": long,
    "frequencyCap": {
      "impressions": long,
      "duration": long
    }
  },
  "creativeRotation": {
    "type": string,
    "weightCalculationStrategy": string,
    "creativeOptimizationConfigurationId": long,
    "creativeAssignments": [
      {
        "creativeId": long,
        "creativeIdDimensionValue": dimensionValues Resource,
        "active": boolean,
        "weight": integer,
        "startTime": datetime,
        "endTime": datetime,
        "sequence": integer,
        "clickThroughUrl": {
          "defaultLandingPage": boolean,
          "landingPageId": long,
          "customClickThroughUrl": string,
          "computedClickThroughUrl": string
        },
        "creativeGroupAssignments": [
          {
            "creativeGroupId": long,
            "creativeGroupNumber": string
          }
        ],
        "richMediaExitOverrides": [
          {
            "exitId": long,
            "enabled": boolean,
            "clickThroughUrl": {
              "defaultLandingPage": boolean,
              "landingPageId": long,
              "customClickThroughUrl": string,
              "computedClickThroughUrl": string
            }
          }
        ],
        "companionCreativeOverrides": [
          {
            "creativeId": long,
            "clickThroughUrl": {
              "defaultLandingPage": boolean,
              "landingPageId": long,
              "customClickThroughUrl": string,
              "computedClickThroughUrl": string
            }
          }
        ],
        "applyEventTags": boolean,
        "sslCompliant": boolean
      }
    ]
  },
  "remarketingListExpression": {
    "expression": string
  },
  "audienceSegmentId": long,
  "keyValueTargetingExpression": {
    "expression": string
  },
  "clickThroughUrl": {
    "defaultLandingPage": boolean,
    "landingPageId": long,
    "customClickThroughUrl": string,
    "computedClickThroughUrl": string
  },
  "creativeGroupAssignments": [
    {
      "creativeGroupId": long,
      "creativeGroupNumber": string
    }
  ],
  "size": sizes Resource,
  "compatibility": string,
  "dynamicClickTracker": boolean,
  "languageTargeting": {
    "languages": [
      languages Resource
    ]
  },
  "targetingTemplateId": long
}
Property name Value Description Notes
accountId long Account ID of this ad. This is a read-only field that can be left blank.
active boolean Whether this ad is active. When true, archived must be false.
advertiserId long Advertiser ID of this ad. This is a required field on insertion.
advertiserIdDimensionValue nested object Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
archived boolean Whether this ad is archived. When true, active must be false.
audienceSegmentId long Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
campaignId long Campaign ID of this ad. This is a required field on insertion.
campaignIdDimensionValue nested object Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
clickThroughUrl nested object Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
clickThroughUrl.computedClickThroughUrl string Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
  • If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
  • If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
  • If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
clickThroughUrl.customClickThroughUrl string Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
clickThroughUrl.defaultLandingPage boolean Whether the campaign default landing page is used.
clickThroughUrl.landingPageId long ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
clickThroughUrlSuffixProperties nested object Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
clickThroughUrlSuffixProperties.clickThroughUrlSuffix string Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
clickThroughUrlSuffixProperties.overrideInheritedSuffix boolean Whether this entity should override the inherited click-through URL suffix with its own defined value.
comments string Comments for this ad.
compatibility string Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.

Acceptable values are:
  • "APP"
  • "APP_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
  • "IN_STREAM_AUDIO"
  • "IN_STREAM_VIDEO"
createInfo nested object Information about the creation of this ad. This is a read-only field.
createInfo.time long Timestamp of the last change in milliseconds since epoch.
creativeGroupAssignments[] list Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
creativeGroupAssignments[].creativeGroupId long ID of the creative group to be assigned.
creativeGroupAssignments[].creativeGroupNumber string Creative group number of the creative group assignment.

Acceptable values are:
  • "CREATIVE_GROUP_ONE"
  • "CREATIVE_GROUP_TWO"
creativeRotation nested object Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
creativeRotation.creativeAssignments[] list Creative assignments in this creative rotation.
creativeRotation.creativeAssignments[].active boolean Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
creativeRotation.creativeAssignments[].applyEventTags boolean Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
creativeRotation.creativeAssignments[].clickThroughUrl nested object Click-through URL of the creative assignment.
creativeRotation.creativeAssignments[].clickThroughUrl.computedClickThroughUrl string Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
  • If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
  • If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
  • If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
creativeRotation.creativeAssignments[].clickThroughUrl.customClickThroughUrl string Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
creativeRotation.creativeAssignments[].clickThroughUrl.defaultLandingPage boolean Whether the campaign default landing page is used.
creativeRotation.creativeAssignments[].clickThroughUrl.landingPageId long ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
creativeRotation.creativeAssignments[].companionCreativeOverrides[] list Companion creative overrides for this creative assignment. Applicable to video ads.
creativeRotation.creativeAssignments[].companionCreativeOverrides[].clickThroughUrl nested object Click-through URL of this companion click-through override.
creativeRotation.creativeAssignments[].companionCreativeOverrides[].clickThroughUrl.computedClickThroughUrl string Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
  • If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
  • If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
  • If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
creativeRotation.creativeAssignments[].companionCreativeOverrides[].clickThroughUrl.customClickThroughUrl string Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
creativeRotation.creativeAssignments[].companionCreativeOverrides[].clickThroughUrl.defaultLandingPage boolean Whether the campaign default landing page is used.
creativeRotation.creativeAssignments[].companionCreativeOverrides[].clickThroughUrl.landingPageId long ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
creativeRotation.creativeAssignments[].companionCreativeOverrides[].creativeId long ID of the creative for this companion click-through override.
creativeRotation.creativeAssignments[].creativeGroupAssignments[] list Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
creativeRotation.creativeAssignments[].creativeGroupAssignments[].creativeGroupId long ID of the creative group to be assigned.
creativeRotation.creativeAssignments[].creativeGroupAssignments[].creativeGroupNumber string Creative group number of the creative group assignment.

Acceptable values are:
  • "CREATIVE_GROUP_ONE"
  • "CREATIVE_GROUP_TWO"
creativeRotation.creativeAssignments[].creativeId long ID of the creative to be assigned. This is a required field.
creativeRotation.creativeAssignments[].creativeIdDimensionValue nested object Dimension value for the ID of the creative. This is a read-only, auto-generated field.
creativeRotation.creativeAssignments[].endTime datetime Date and time that the assigned creative should stop serving. Must be later than the start time.
creativeRotation.creativeAssignments[].richMediaExitOverrides[] list Rich media exit overrides for this creative assignment.

Applicable when the creative type is any of the following:

  • DISPLAY
  • RICH_MEDIA_INPAGE
  • RICH_MEDIA_INPAGE_FLOATING
  • RICH_MEDIA_IM_EXPAND
  • RICH_MEDIA_EXPANDING
  • RICH_MEDIA_INTERSTITIAL_FLOAT
  • RICH_MEDIA_MOBILE_IN_APP
  • RICH_MEDIA_MULTI_FLOATING
  • RICH_MEDIA_PEEL_DOWN
  • VPAID_LINEAR
  • VPAID_NON_LINEAR

creativeRotation.creativeAssignments[].richMediaExitOverrides[].clickThroughUrl nested object Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
creativeRotation.creativeAssignments[].richMediaExitOverrides[].clickThroughUrl.computedClickThroughUrl string Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
  • If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
  • If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
  • If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
creativeRotation.creativeAssignments[].richMediaExitOverrides[].clickThroughUrl.customClickThroughUrl string Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
creativeRotation.creativeAssignments[].richMediaExitOverrides[].clickThroughUrl.defaultLandingPage boolean Whether the campaign default landing page is used.
creativeRotation.creativeAssignments[].richMediaExitOverrides[].clickThroughUrl.landingPageId long ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
creativeRotation.creativeAssignments[].richMediaExitOverrides[].enabled boolean Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
creativeRotation.creativeAssignments[].richMediaExitOverrides[].exitId long ID for the override to refer to a specific exit in the creative.
creativeRotation.creativeAssignments[].sequence integer Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
creativeRotation.creativeAssignments[].sslCompliant boolean Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
creativeRotation.creativeAssignments[].startTime datetime Date and time that the assigned creative should start serving.
creativeRotation.creativeAssignments[].weight integer Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
creativeRotation.creativeOptimizationConfigurationId long Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
creativeRotation.type string Type of creative rotation. Can be used to specify whether to use sequential or random rotation.

Acceptable values are:
  • "CREATIVE_ROTATION_TYPE_RANDOM"
  • "CREATIVE_ROTATION_TYPE_SEQUENTIAL"
creativeRotation.weightCalculationStrategy string Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.

Acceptable values are:
  • "WEIGHT_STRATEGY_CUSTOM"
  • "WEIGHT_STRATEGY_EQUAL"
  • "WEIGHT_STRATEGY_HIGHEST_CTR"
  • "WEIGHT_STRATEGY_OPTIMIZED"
dayPartTargeting nested object Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
dayPartTargeting.daysOfWeek[] list Days of the week when the ad will serve.

Acceptable values are:
  • "SUNDAY"
  • "MONDAY"
  • "TUESDAY"
  • "WEDNESDAY"
  • "THURSDAY"
  • "FRIDAY"
  • "SATURDAY"
dayPartTargeting.hoursOfDay[] list Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
dayPartTargeting.userLocalTime boolean Whether or not to use the user's local time. If false, the America/New York time zone applies.
defaultClickThroughEventTagProperties nested object Default click-through event tag properties for this ad.
defaultClickThroughEventTagProperties.defaultClickThroughEventTagId long ID of the click-through event tag to apply to all ads in this entity's scope.
defaultClickThroughEventTagProperties.overrideInheritedEventTag boolean Whether this entity should override the inherited default click-through event tag with its own defined value.
deliverySchedule nested object Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
deliverySchedule.frequencyCap nested object Limit on the number of times an individual user can be served the ad within a specified period of time.
deliverySchedule.frequencyCap.duration long Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
deliverySchedule.frequencyCap.impressions long Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
deliverySchedule.hardCutoff boolean Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
deliverySchedule.impressionRatio long Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
deliverySchedule.priority string Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.

Acceptable values are:
  • "AD_PRIORITY_01"
  • "AD_PRIORITY_02"
  • "AD_PRIORITY_03"
  • "AD_PRIORITY_04"
  • "AD_PRIORITY_05"
  • "AD_PRIORITY_06"
  • "AD_PRIORITY_07"
  • "AD_PRIORITY_08"
  • "AD_PRIORITY_09"
  • "AD_PRIORITY_10"
  • "AD_PRIORITY_11"
  • "AD_PRIORITY_12"
  • "AD_PRIORITY_13"
  • "AD_PRIORITY_14"
  • "AD_PRIORITY_15"
  • "AD_PRIORITY_16"
dynamicClickTracker boolean Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
endTime datetime Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
eventTagOverrides[] list Event tag overrides for this ad.
eventTagOverrides[].enabled boolean Whether this override is enabled.
eventTagOverrides[].id long ID of this event tag override. This is a read-only, auto-generated field.
geoTargeting nested object Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
geoTargeting.cities[] list Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
geoTargeting.countries[] list Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
geoTargeting.excludeCountries boolean Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
geoTargeting.metros[] list Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
geoTargeting.postalCodes[] list Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
geoTargeting.regions[] list Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
id long ID of this ad. This is a read-only, auto-generated field.
idDimensionValue nested object Dimension value for the ID of this ad. This is a read-only, auto-generated field.
keyValueTargetingExpression nested object Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
keyValueTargetingExpression.expression string Keyword expression being targeted by the ad.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
languageTargeting nested object Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
languageTargeting.languages[] list Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
lastModifiedInfo nested object Information about the most recent modification of this ad. This is a read-only field.
lastModifiedInfo.time long Timestamp of the last change in milliseconds since epoch.
name string Name of this ad. This is a required field and must be less than 256 characters long.
placementAssignments[] list Placement assignments for this ad.
placementAssignments[].active boolean Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
placementAssignments[].placementId long ID of the placement to be assigned. This is a required field.
placementAssignments[].placementIdDimensionValue nested object Dimension value for the ID of the placement. This is a read-only, auto-generated field.
placementAssignments[].sslRequired boolean Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
remarketingListExpression nested object Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
remarketingListExpression.expression string Expression describing which lists are being targeted by the ad.
size nested object Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
sslCompliant boolean Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
sslRequired boolean Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
startTime datetime Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
subaccountId long Subaccount ID of this ad. This is a read-only field that can be left blank.
targetingTemplateId long Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
technologyTargeting nested object Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
technologyTargeting.browsers[] list Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
technologyTargeting.connectionTypes[] list Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
technologyTargeting.mobileCarriers[] list Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
technologyTargeting.operatingSystemVersions[] list Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
technologyTargeting.operatingSystems[] list Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
technologyTargeting.platformTypes[] list Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
type string Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).

Acceptable values are:
  • "AD_SERVING_CLICK_TRACKER"
  • "AD_SERVING_DEFAULT_AD"
  • "AD_SERVING_STANDARD_AD"
  • "AD_SERVING_TRACKING"

Methods

get
Gets one ad by ID.
insert
Inserts a new ad.
list
Retrieves a list of ads, possibly filtered. This method supports paging.
patch
Updates an existing ad. This method supports patch semantics.
update
Updates an existing ad.

Send feedback about...

Campaign Manager
Campaign Manager