Skip to content

Latest commit

 

History

History
556 lines (303 loc) · 13.3 KB

campaign.schema.md

File metadata and controls

556 lines (303 loc) · 13.3 KB
Raw

Search Advertising Campaign Schema

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

Search Advertising Campaigns is a set of ad groups (ads, keywords, and bids) that share a budget, location targeting, and other settings.

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

Schema Hierarchy

  • Search Advertising Campaign https://ns.adobe.com/xdm/adcloud/searchads/campaign

Search Advertising Campaign Properties

Property Type Required Defined by
@id string Optional Record Schema
repo:createDate string Optional Audit trail
repo:modifyDate string Optional Audit trail
searchads:accountId string Optional Search Advertising Campaign (this schema)
searchads:adDeliveryType enum Optional Search Advertising Campaign (this schema)
searchads:budget number Optional Search Advertising Campaign (this schema)
searchads:budgetType enum Optional Search Advertising Campaign (this schema)
searchads:campaignDescription string Optional Search Advertising Campaign (this schema)
searchads:campaignEndDate string Optional Search Advertising Campaign (this schema)
searchads:campaignId string Optional Search Advertising Campaign (this schema)
searchads:campaignName string Optional Search Advertising Campaign (this schema)
searchads:campaignStartDate string Optional Search Advertising Campaign (this schema)
searchads:campaignStatus enum Optional Search Advertising Campaign (this schema)
searchads:channelType string Optional Search Advertising Campaign (this schema)
searchads:createDate string Optional Search Advertising Campaign (this schema)
searchads:modifyDate string Optional Search Advertising Campaign (this schema)
searchads:objective enum Optional Search Advertising Campaign (this schema)
searchads:portfolioId string Optional Search Advertising Campaign (this schema)
searchads:searchEngineId integer Optional Search Advertising Campaign (this schema)
xdm:createdByBatchID string Optional Audit trail
xdm:modifiedByBatchID string Optional Audit trail
xdm:repositoryCreatedBy string Optional Audit trail
xdm:repositoryLastModifiedBy string Optional Audit trail
* any Additional this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

@id Type

string

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

repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:createDate

repo:createDate Type

string

repo:createDate Example

"2004-10-23T12:00:00-06:00"

repo:modifyDate

The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:modifyDate

repo:modifyDate Type

string

repo:modifyDate Example

"2004-10-23T12:00:00-06:00"

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:adDeliveryType

Ad Delivery Method

Ad Delivery method can determine how long your budget lasts

searchads:adDeliveryType

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

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

searchads:adDeliveryType Known Values

Value Description
Standard Standard
Accelerated Accelerated

searchads:budget

Budget

Budget Allocated for the Campaign

searchads:budget

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

searchads:budget Type

number

searchads:budgetType

Budget Type

Budget Type indicates how the allocated budget will be spent

searchads:budgetType

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

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

searchads:budgetType Known Values

Value Description
Daily Daily
Monthly Monthly
Lifetime Lifetime
Daily Spend Until Depleted Daily Spend Until Depleted
Day of Week Day of Week

searchads:campaignDescription

Description

Description of the Campaign.

searchads:campaignDescription

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

searchads:campaignDescription Type

string

searchads:campaignEndDate

Campaign End Date

Campaign End Date

searchads:campaignEndDate

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

searchads:campaignEndDate Type

string

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:campaignName

Campaign Name

Name of the Campaign.

searchads:campaignName

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

searchads:campaignName Type

string

searchads:campaignStartDate

Campaign Start Date

Campaign Start Date

searchads:campaignStartDate

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

searchads:campaignStartDate Type

string

searchads:campaignStatus

Campaign Status

Campaign Status indicates if underlying ads are eligible to serve.

searchads:campaignStatus

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

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

searchads:campaignStatus Known Values

Value Description
Active Active
Paused Paused
Deleted Deleted
Ended Ended
Pending Pending
Inactive Inactive
Disapproved Disapproved
Incomplete Incomplete
Offline Offline
On Hold (Editing) On Hold (Editing)
On Hold (Other) On Hold (Other)
Duplicate Duplicate
Orphan Orphan
Optimize Optimize
Disabled Disabled
Unknown Unknown
Dummy Dummy

searchads:channelType

Channel Type

Channel Type for the Campaign

searchads:channelType

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

searchads:channelType Type

string

searchads:createDate

The date and time when the campaign was created. An example form is "2004-10-23T12:00:00-06:00".

searchads:createDate

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

searchads:createDate Type

string

searchads:createDate Example

"2004-10-23T12:00:00-06:00"

searchads:modifyDate

The date and time when the campaign was last modified. An example form is "2004-10-23T12:00:00-06:00".

searchads:modifyDate

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

searchads:modifyDate Type

string

searchads:modifyDate Example

"2004-10-23T12:00:00-06:00"

searchads:objective

Campaign Objective

Campaign Objective indicates the primary objective of the campaign - e.g. Promotions, Brands, App Installs.

searchads:objective

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

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

searchads:objective Known Values

Value Description
visit_web visit_web
promote_brand promote_brand
install_app install_app
visit_offer visit_offer

searchads:portfolioId

Portfolio Identifier

Identifier indicates if campaign has been assigned and managed via portfolio.

searchads:portfolioId

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

searchads:portfolioId Type

string

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

xdm:createdByBatchID

Created by batch identifier

The dataset files in Catalog which has been originating the creation of the record.

xdm:createdByBatchID

xdm:createdByBatchID Type

string

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

xdm:modifiedByBatchID

Modified by batch identifier

The last dataset files in Catalog which has modified the record. At creation time, modifiedByBatchID is set as createdByBatchID.

xdm:modifiedByBatchID

xdm:modifiedByBatchID Type

string

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

xdm:repositoryCreatedBy

Created by user identifier

User ID of who created the record.

xdm:repositoryCreatedBy

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

Modified by user identifier

User ID of who last modified the record. At creation time, modifiedByUser is set as createdByUser.

xdm:repositoryLastModifiedBy

xdm:repositoryLastModifiedBy Type

string