Skip to content

adgroup.schema.md

Latest commit

 

History

History
405 lines (223 loc) · 10.2 KB

adgroup.schema.md

File metadata and controls

405 lines (223 loc) · 10.2 KB

Search Advertising AdGroup Schema

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

Search Advertising Ad Group is a logical collection or grouping of ads.

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

Schema Hierarchy

  • Search Advertising AdGroup https://ns.adobe.com/xdm/adcloud/searchads/adgroup

Search Advertising AdGroup Properties

Property Type Required Defined by
@id string Optional Record Schema
repo:createDate string Optional Audit trail
repo:modifyDate string Optional Audit trail
searchads:adGroupStatus enum Optional Search Advertising AdGroup (this schema)
searchads:adgroupId string Optional Search Advertising AdGroup (this schema)
searchads:adgroupName string Optional Search Advertising AdGroup (this schema)
searchads:bidLevel enum Optional Search Advertising AdGroup (this schema)
searchads:campaignId string Optional Search Advertising AdGroup (this schema)
searchads:createDate string Optional Search Advertising AdGroup (this schema)
searchads:internalCampaignId string Optional Search Advertising AdGroup (this schema)
searchads:modifyDate string Optional Search Advertising AdGroup (this schema)
searchads:searchEngineId integer Optional Search Advertising AdGroup (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:adGroupStatus

Ad Group Status

Ad Group Status indicates if underlying ads are eligible to serve.

searchads:adGroupStatus

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

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

searchads:adGroupStatus 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: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:adgroupName

Ad Group Name

Name of the Ad Group.

searchads:adgroupName

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

searchads:adgroupName Type

string

searchads:bidLevel

Bid Level

What determines the bid for all ads belonging to this adgroup.

searchads:bidLevel

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

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

searchads:bidLevel Known Values

Value Description
Gender Gender
Placement Placement
Vertical Vertical
Age Range Age Range
Keyword Keyword
Adgroup Adgroup
User Interest and List User Interest and List

searchads:campaignId

Campaign Identifier

Campaign ID for the Ad Group on the search advertising platform.

searchads:campaignId

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

searchads:campaignId Type

string

searchads:createDate

The date and time when the adgroup 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:internalCampaignId

Internal Campaign Identifier

Internal Campaign ID for the Ad Group. This identifier determines uniqueness of campaign and ad group record.

searchads:internalCampaignId

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

searchads:internalCampaignId Type

string

searchads:modifyDate

The date and time when the adgroup 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: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