REST Resource: advertisers

資源:廣告主

Display & Video 360 (DV360) 中的單一廣告客戶。

JSON 表示法
{
  "name": string,
  "advertiserId": string,
  "partnerId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "generalConfig": {
    object (AdvertiserGeneralConfig)
  },
  "adServerConfig": {
    object (AdvertiserAdServerConfig)
  },
  "creativeConfig": {
    object (AdvertiserCreativeConfig)
  },
  "dataAccessConfig": {
    object (AdvertiserDataAccessConfig)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "servingConfig": {
    object (AdvertiserTargetingConfig)
  },
  "prismaEnabled": boolean,
  "billingConfig": {
    object (AdvertiserBillingConfig)
  }
}
欄位
name

string

僅供輸出。廣告客戶的資源名稱。

advertiserId

string (int64 format)

僅供輸出。廣告客戶的專屬 ID。由系統指派。

partnerId

string (int64 format)

必要欄位。不可變動。廣告客戶所屬合作夥伴的專屬 ID。

displayName

string

必要欄位。廣告客戶的顯示名稱。

必須使用 UTF-8 編碼,且大小上限為 240 個位元組。

entityStatus

enum (EntityStatus)

必要欄位。控管廣告客戶的廣告訂單和委刊項能否支出預算及對廣告空間出價。

  • 可接受的值為 ENTITY_STATUS_ACTIVEENTITY_STATUS_PAUSEDENTITY_STATUS_SCHEDULED_FOR_DELETION
  • 如果設為 ENTITY_STATUS_SCHEDULED_FOR_DELETION,系統會從首次排定刪除的 30 天後刪除廣告主。
updateTime

string (Timestamp format)

僅供輸出。廣告客戶上次更新時的時間戳記。由系統指派。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

generalConfig

object (AdvertiserGeneralConfig)

必要欄位。廣告客戶的一般設定。

adServerConfig

object (AdvertiserAdServerConfig)

必要欄位。不可變動。廣告主的廣告伺服器相關設定。

creativeConfig

object (AdvertiserCreativeConfig)

必要欄位。廣告主的廣告素材相關設定。

dataAccessConfig

object (AdvertiserDataAccessConfig)

控管廣告主資料存取方式的設定。

integrationDetails

object (IntegrationDetails)

廣告客戶的整合詳細資料。目前只有 integrationCode 適用於廣告主。IntegrationDetails 的其他欄位不受支援,如有提供,會遭到忽略。

servingConfig

object (AdvertiserTargetingConfig)

與廣告主廣告放送相關的指定目標設定。

prismaEnabled

boolean

是否已啟用 Mediaocean (Prisma) 整合功能。啟用這項功能即代表您同意下列條款:

本人謹代表本公司授權 Mediaocean (Prisma) 將預算區隔企劃書傳送給 Google,並授權 Google 透過 DV360 將相應的報表和月結單傳送給 Mediaocean,以便這個廣告主規劃預算、計費及對帳。

billingConfig

object (AdvertiserBillingConfig)

廣告主的帳單相關設定。

AdvertiserGeneralConfig

廣告客戶的一般設定。

JSON 表示法
{
  "domainUrl": string,
  "timeZone": string,
  "currencyCode": string
}
欄位
domainUrl

string

必要欄位。廣告客戶主要網站的網域網址。系統會將這項資訊傳送給發布商,表示發布商必須提供網站網址,才能將廣告活動與廣告客戶建立關聯。

請提供不含路徑或查詢字串的網址,開頭須為 http:https:。例如:http://www.example.com

timeZone

string

僅供輸出。廣告客戶時區的標準 TZ 資料庫名稱,例如 America/New_York

詳情請參閱:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

如果是 CM360 混合型廣告客戶,時區會與相關聯的 CM360 帳戶相同;如果是僅限第三方的廣告客戶,時區會與上層合作夥伴的時區相同。

currencyCode

string

必要欄位。不可變動。採用 ISO 4217 格式的廣告主貨幣。

接受的代碼及其代表的貨幣如下:

貨幣代碼:貨幣名稱

  • ARS:阿根廷披索
  • AUD:澳幣
  • BRL:巴西雷亞爾
  • CAD:加幣
  • CHF:瑞士法郎
  • CLP:智利披索
  • CNY:人民幣
  • COP:哥倫比亞披索
  • CZK:捷克克朗
  • DKK:丹麥克朗
  • EGP:埃及鎊
  • EUR:歐元
  • GBP:英鎊
  • HKD:港幣
  • HUF:匈牙利福林
  • IDR:印尼盧比
  • ILS:以色列謝克爾
  • INR:印度盧比
  • JPY:日圓
  • KRW:韓元
  • MXN:墨西哥披索
  • MYR:馬來西亞林吉特
  • NGN:奈及利亞奈拉
  • NOK:挪威克朗
  • NZD:紐西蘭幣
  • PEN:秘魯新索爾
  • PLN:波蘭茲羅提
  • RON:新羅馬尼亞列伊
  • RUB:俄羅斯盧布
  • SEK:瑞典克朗
  • TRY:土耳其里拉
  • TWD:新臺幣
  • USD:美元
  • ZAR:南非蘭特

AdvertiserAdServerConfig

廣告客戶的廣告伺服器相關設定。

JSON 表示法
{

  // Union field ad_server_config_scheme can be only one of the following:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of list of possible types for union field ad_server_config_scheme.
}
欄位
聯集欄位 ad_server_config_scheme。必要欄位。ad_server_config_scheme 只能是下列其中一項:
thirdPartyOnlyConfig

object (ThirdPartyOnlyConfig)

僅限使用第三方廣告伺服器的廣告主設定。

cmHybridConfig

object (CmHybridConfig)

適用於同時使用 Campaign Manager 360 (CM360) 和第三方廣告伺服器的廣告客戶設定。

ThirdPartyOnlyConfig

僅適用於使用第三方廣告伺服器的廣告客戶設定。

JSON 表示法
{
  "pixelOrderIdReportingEnabled": boolean
}
欄位
pixelOrderIdReportingEnabled

boolean

是否已啟用像素的訂單 ID 報表功能。這個值設為 true 後就無法變更。

CmHybridConfig

適用於同時使用 Campaign Manager 360 (CM360) 和第三方廣告伺服器的廣告客戶設定。

JSON 表示法
{
  "cmAccountId": string,
  "cmFloodlightConfigId": string,
  "cmAdvertiserIds": [
    string
  ],
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
欄位
cmAccountId

string (int64 format)

必要欄位。不可變動。與 DV360 廣告主連結的 CM360 Floodlight 設定帳戶 ID。

cmFloodlightConfigId

string (int64 format)

必要欄位。不可變動。與 DV360 廣告主連結的 CM360 Floodlight 設定 ID。

cmAdvertiserIds[]

string (int64 format)

僅供輸出。共用 CM360 Floodlight 設定的 CM360 廣告主 ID 組合。

cmSyncableSiteIds[]

string (int64 format)

CM360 網站清單,這些網站的刊登位置將同步處理至 DV360 做為廣告素材。

如果 advertisers.create 方法中缺少或空白,系統會自動建立 CM360 網站。

從這份清單中移除網站,可能會導致從 CM360 同步的 DV360 廣告素材遭到刪除。請至少指定一個網站。

dv360ToCmDataSharingEnabled

boolean

是否在 CM360 資料移轉報表中納入 DV360 資料。

dv360ToCmCostReportingEnabled

boolean

是否向 CM360 回報 DV360 費用。

cmFloodlightLinkingAuthorized

boolean

必要欄位。不可變動。將這個欄位設為「true」,即表示您代表貴公司授權將指定 Floodlight 設定的資訊分享給這個 Display & Video 360 廣告主。

AdvertiserCreativeConfig

廣告主的廣告素材相關設定。

JSON 表示法
{
  "iasClientId": string,
  "obaComplianceDisabled": boolean,
  "dynamicCreativeEnabled": boolean,
  "videoCreativeDataSharingAuthorized": boolean
}
欄位
iasClientId

string (int64 format)

用於設定 Integral Ad Service (IAS) 廣告活動監控功能的 ID。DV360 系統會將內含這個 ID 的 IAS「Campaign Monitor」代碼附加到廣告素材代碼中。

obaComplianceDisabled

boolean

是否停用 Google 的「關於這則廣告」功能,會在廣告加入「線上行為廣告」(OBA) 和法規要求時加入徽章 (以識別廣告內容) 和透明度資訊 (與「關於這則廣告」互動)。關於這則廣告,使用者能進一步掌控自己看到的廣告,並解釋他們看見廣告的原因。瞭解詳情

請注意,如果選擇將這個欄位設為 true,請注意,透過 Display & Video 360 放送的廣告必須遵守下列規定:

  • 根據您與 Google Marketing Platform 之間的合約,遵守「線上行為廣告」(OBA)。
  • 在歐洲經濟區 (EEA),納入資訊公開資訊,以及讓使用者檢舉廣告中非法內容的機制。如果採用替代的廣告徽章、資訊公開和報表解決方案,請務必確認其中包含必要的透明度資訊和非法內容檢舉機制,並透過適當表單通知 Google 發現違法內容。
dynamicCreativeEnabled

boolean

是否為廣告客戶啟用動態廣告素材。

videoCreativeDataSharingAuthorized

boolean

將這個欄位設為「true」,即表示您 (代表貴公司) 授權 Google 使用與這個 Display & Video 360 廣告主相關的影片廣告素材,以提供該廣告主電視廣告活動相關的報表和功能。

只有在廣告主進行 CM360 hybrid 廣告伺服器設定時,才能使用這項屬性。

AdvertiserDataAccessConfig

控管廣告主相關資料存取方式的設定。

JSON 表示法
{
  "sdfConfig": {
    object (AdvertiserSdfConfig)
  }
}
欄位
sdfConfig

object (AdvertiserSdfConfig)

廣告客戶的結構化資料檔案 (SDF) 設定。

如未指定,則會使用上層夥伴的 SDF 設定。

AdvertiserSdfConfig

廣告客戶的結構化資料檔案 (SDF) 設定。

JSON 表示法
{
  "overridePartnerSdfConfig": boolean,
  "sdfConfig": {
    object (SdfConfig)
  }
}
欄位
overridePartnerSdfConfig

boolean

這個廣告主是否會覆寫上層夥伴的 SDF 設定。

根據預設,廣告客戶會沿用上層夥伴的 SDF 設定。如要覆寫合作夥伴設定,請將這個欄位設為 true,並在 sdfConfig 中提供新設定。

sdfConfig

object (SdfConfig)

廣告客戶的 SDF 設定。

AdvertiserTargetingConfig

與廣告主廣告放送相關的指定目標設定。

JSON 表示法
{
  "exemptTvFromViewabilityTargeting": boolean
}
欄位
exemptTvFromViewabilityTargeting

boolean

連網電視裝置是否不必針對廣告主的所有影片委刊項指定可視度。

AdvertiserBillingConfig

廣告客戶的帳單相關設定。

JSON 表示法
{
  "billingProfileId": string
}
欄位
billingProfileId

string (int64 format)

指派給廣告客戶的帳單資料 ID。

如果未提供值,這個欄位將預設為廣告主上層夥伴的預設帳單資料 ID。

方法

audit

稽核廣告客戶。

create

建立新的廣告客戶。

delete

刪除廣告客戶。

editAssignedTargetingOptions

編輯單一廣告主的指定目標選項。

get

取得廣告主。

list

列出目前使用者可存取的廣告主。

listAssignedTargetingOptions

列出廣告客戶在不同指定類型中的指派的指定目標選項。

patch

更新現有的廣告客戶。