Skip to content

Latest commit

 

History

History
428 lines (238 loc) · 10.5 KB

account.schema.md

File metadata and controls

428 lines (238 loc) · 10.5 KB
Raw

Search Advertising Account Schema

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

Search Advertising Account defines Customer Configuration on Search Advertising Platform.

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

Schema Hierarchy

  • Search Advertising Account https://ns.adobe.com/xdm/adcloud/searchads/account

Search Advertising Account Example

{
  "@id": "100001061",
  "searchads:accountId": "10001234",
  "searchads:accountName": "My First Account",
  "searchads:currencyCode": "USD",
  "searchads:accountStatus": "Enabled",
  "searchads:budget": 123.45,
  "searchads:budgetType": "Monthly",
  "searchads:searchEngineId": 3,
  "repo:createDate": "2019-04-26T14:00:00+00:00",
  "repo:modifyDate": "2019-04-26T14:00:00+00:00"
}

Search Advertising Account 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 Account (this schema)
searchads:accountName string Optional Search Advertising Account (this schema)
searchads:accountStatus enum Optional Search Advertising Account (this schema)
searchads:budget number Optional Search Advertising Account (this schema)
searchads:budgetType enum Optional Search Advertising Account (this schema)
searchads:createDate string Optional Search Advertising Account (this schema)
searchads:currencyCode string Optional Search Advertising Account (this schema)
searchads:modifyDate string Optional Search Advertising Account (this schema)
searchads:searchEngineId integer Optional Search Advertising Account (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:accountName

Account Name

Name of the Account.

searchads:accountName

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

searchads:accountName Type

string

searchads:accountStatus

Account Status

Managed Flag indicates whether account is enabled or disabled on search networks.

searchads:accountStatus

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

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

searchads:accountStatus Known Values

Value Description
Enabled Enabled
Disabled Disabled

searchads:budget

Budget

Budget Allocated to the Account acts only as a spend cap across all your campaigns.

searchads:budget

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

searchads:budget Type

number

searchads:budgetType

Budget Type

Budget Type

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

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

Currency Code

Currency in which this account operates.

searchads:currencyCode

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

searchads:currencyCode Type

string

All instances must conform to this regular expression

^[A-Z]{3}$
  • test example: USD
  • test example: EUR
  • test example: JPY

searchads:currencyCode Examples

"USD"
"EUR"
"JPY"

searchads:modifyDate

The date and time when the account 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 applicatio-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