Skip to content

Latest commit

 

History

History
441 lines (255 loc) · 12.6 KB

aggregateperformancebykeyword.schema.md

File metadata and controls

441 lines (255 loc) · 12.6 KB
Raw

Search Advertising Aggregate Performance Measures By Keyword Schema

https://ns.adobe.com/xdm/adcloud/searchads/aggregateperformancebykeyword

Search Advertising Aggregate Performance Measures By Keyword is a collection of measures pulled from Search Advertising Platforms by Keyword.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/adcloud/searchads/aggregateperformancebykeyword.schema.json

Schema Hierarchy

  • Search Advertising Aggregate Performance Measures By Keyword https://ns.adobe.com/xdm/adcloud/searchads/aggregateperformancebykeyword
    • Time-series Schema https://ns.adobe.com/xdm/data/time-series
    • Measure https://ns.adobe.com/xdm/data/measure
    • Device https://ns.adobe.com/xdm/context/device

Search Advertising Aggregate Performance Measures By Keyword Properties

Property Type Required Defined by
@id string Optional Time-series Schema
searchads:accountId string Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:adgroupId string Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:avgPosition Measure Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:campaignId string Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:clicks Measure Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:device Device Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:impressions Measure Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:matchType enum Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:qualityScore Measure Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:searchEngineId integer Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:term string Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:termId string Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:topPageBid Measure Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
searchads:totalCost Measure Optional Search Advertising Aggregate Performance Measures By Keyword (this schema)
xdm:eventType string Optional Time-series Schema
xdm:timestamp string Optional Time-series Schema
* any Additional this schema allows additional properties

@id

Identifier

A unique identifier for the time-series event.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

searchads:accountId

Account Identifier

Identifier that defines Customer/Client ID setup on the Search Advertising Platform.

searchads:accountId

  • is optional
  • type: string
  • defined in this schema

searchads:accountId Type

string

searchads:adgroupId

Ad Group Identifier

Ad Group ID on the search advertising platform.

searchads:adgroupId

  • is optional
  • type: string
  • defined in this schema

searchads:adgroupId Type

string

searchads:avgPosition

Average Position of the Ad displayed on the network.

searchads:avgPosition

  • is optional
  • type: Measure
  • defined in this schema

searchads:avgPosition Type

  • Measure – https://ns.adobe.com/xdm/data/measure

searchads:campaignId

Campaign Identifier

Campaign ID on the search advertising platform..

searchads:campaignId

  • is optional
  • type: string
  • defined in this schema

searchads:campaignId Type

string

searchads:clicks

Count of Clicks for a given ad displayed on the network.

searchads:clicks

  • is optional
  • type: Measure
  • defined in this schema

searchads:clicks Type

  • Measure – https://ns.adobe.com/xdm/data/measure

searchads:device

Device

The device from where the ad was displayed.

searchads:device

  • is optional
  • type: Device
  • defined in this schema

searchads:device Type

  • Device – https://ns.adobe.com/xdm/context/device

searchads:impressions

Count of impressions for a given ad displayed on the network.

searchads:impressions

  • is optional
  • type: Measure
  • defined in this schema

searchads:impressions Type

  • Measure – https://ns.adobe.com/xdm/data/measure

searchads:matchType

Term Match Type

Match Type associated to the Search Term being targeted for the Ad.

searchads:matchType

  • is optional
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

searchads:matchType Known Values

Value Description
Broad Broad
Phrase Phrase
Exact Exact
Advanced Advanced
Standard Standard
Website Website
Product Target Product Target
Product Group Product Group
Content Content
SiteCpc SiteCpc
Sitecpm SiteCpm
Category Category
Search Search
Adgroup Adgroup
Dynamic Ad Target Dynamic Ad Target
Unknown Unknown
SiteCpm

searchads:qualityScore

Quality Score of the Keyword assigned by the network - range 1 to 10. This is not an additive measure.

searchads:qualityScore

  • is optional
  • type: Measure
  • defined in this schema

searchads:qualityScore Type

  • Measure – https://ns.adobe.com/xdm/data/measure

searchads:searchEngineId

Search Engine Identifier

The application-specified identifier used to identify the Search Advertising Platform Name.

searchads:searchEngineId

  • is optional
  • type: integer
  • defined in this schema

searchads:searchEngineId Type

integer

searchads:term

Search Term

Search Term targeted for the Ad.

searchads:term

  • is optional
  • type: string
  • defined in this schema

searchads:term Type

string

searchads:termId

Search Term Identifier

Search Term ID on the search advertising platform.

searchads:termId

  • is optional
  • type: string
  • defined in this schema

searchads:termId Type

string

searchads:topPageBid

Top of the Page Bid Estimator. The measure is computed by the network and is not an additive measure.

searchads:topPageBid

  • is optional
  • type: Measure
  • defined in this schema

searchads:topPageBid Type

  • Measure – https://ns.adobe.com/xdm/data/measure

searchads:totalCost

Total Advertising Spend for a given ad displayed on the network. The spend is in the account currency configured on the network.

searchads:totalCost

  • is optional
  • type: Measure
  • defined in this schema

searchads:totalCost Type

  • Measure – https://ns.adobe.com/xdm/data/measure

xdm:eventType

Event Type

The primary event type for this time-series record.

xdm:eventType

xdm:eventType Type

string

xdm:eventType Known Values

Value Description
advertising.completes Advertising Completes
advertising.timePlayed Advertising Time Played
advertising.federated Advertising Federated
advertising.clicks Advertising Clicks
advertising.conversions Advertising Conversions
advertising.firstQuartiles Advertising First Quartiles
advertising.impressions Advertising Impressions
advertising.midpoints Advertising Midpoints
advertising.starts Advertising Starts
advertising.thirdQuartiles Advertising Third Quartiles
application.close Application Close
application.launch Application Launch
web.webpagedetails.pageViews Web Webpagedetails Page Views
web.webinteraction.linkClicks Web Webinteraction Link Clicks
web.formFilledOut Web Form Filled Out
commerce.checkouts Commerce Checkouts
commerce.productListAdds Commerce Product List Adds
commerce.productListOpens Commerce Product List Opens
commerce.productListRemovals Commerce Product List Removals
commerce.productListReopens Commerce Product List Reopens
commerce.productListViews Commerce Product List Views
commerce.productViews Commerce Product Views
commerce.purchases Commerce Purchases
commerce.saveForLaters Commerce Save For Laters
decisioning.propositionDisplay Decisioning Proposition Display
decisioning.propositionInteract Decisioning Proposition Interact
delivery.feedback Delivery Feedback
message.feedback Message Feedback
message.tracking Message Tracking
pushTracking.applicationOpened Push Tracking Application Opened
pushTracking.customAction Push Tracking Custom Action
listOperation.removeFromList List Operation Remove From List
listOperation.addToList List Operation Add To List
leadOperation.scoreChanged Lead Operation Score Changed
leadOperation.statusInCampaignProgressionChanged Lead Operation Status In Campaign Progression Changed
leadOperation.interestingMoment Lead Operation Interesting Moment
leadOperation.newLead Lead Operation New Lead
leadOperation.convertLead Lead Operation Convert Lead
directMarketing.emailBounced Direct Marketing Email Bounced
directMarketing.emailBouncedSoft Direct Marketing Email Bounced Soft
directMarketing.emailDelivered Direct Marketing Email Delivered
directMarketing.emailUnsubscribed Direct Marketing Email Unsubscribed
directMarketing.emailOpened Direct Marketing Email Opened
directMarketing.emailClicked Direct Marketing Email Clicked
opportunityEvent.removeFromOpportunity Opportunity Event Remove From Opportunity
opportunityEvent.addToOpportunity Opportunity Event Add To Opportunity
opportunityEvent.opportunityUpdated Opportunity Event Opportunity Updated
inappmessageTracking.dismiss inapp message was dimissed
inappmessageTracking.display inapp message was displayed
inappmessageTracking.interact inapp message was interacted with

xdm:timestamp

Timestamp

The time when an event or observation occurred.

xdm:timestamp

xdm:timestamp Type

string