Ads Data Hub API

用於執行 Ads Data Hub 查詢的 API。

服務:adsdatahub.googleapis.com

如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用自己的程式庫來呼叫此服務,請在發出 API 要求時提供下列資訊。

探索文件

探索文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件:

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:

  • https://adsdatahub.googleapis.com

REST 資源:v1.customers

方法
describeValidDv360AdvertiserIds POST /v1/{customer=customers/*}:describeValidDv360AdvertiserIds
說明有效的 DV360 廣告客戶 ID
describeValidFrequencyLimitingEventMatchers GET /v1/{customer=customers/*}:describeValidFrequencyLimitingEventMatchers
列出有效事件比對器及其展示頻率上限目標對象名單的中繼資料。
exportJobHistory POST /v1/{customer=customers/*}:exportJobHistory
將客戶帳戶的工作記錄匯出至客戶選取的 BigQuery 資料集。
generateDv360IvtVideoViewabilityReport POST /v1/{customer=customers/*}:generateDv360IvtVideoViewabilityReport
開始執行查詢,以擷取 DV360 平台的無效流量可視度指標。
generateIvtReport POST /v1/{name=customers/*}:generateIvtReport
開始執行查詢,以擷取特定平台的無效流量數量每日摘要。
get GET /v1/{name=customers/*}
擷取所要求的廣告資料中心客戶。
getImportCompletionStatus GET /v1/{customer=customers/*}/importCompletionStatus
在指定日期成功擷取到 ADH 的所有 Google 資料所佔百分比。
list GET /v1/customers
列出目前使用者可存取的廣告資料中心客戶。

REST 資源:v1.customers.adsDataCustomers

方法
get GET /v1/{name=customers/*/adsDataCustomers/*}
擷取所要求的廣告資料中心客戶。
getDataAccessBudget GET /v1/{name=customers/*/adsDataCustomers/*/dataAccessBudget}
擷取過去 366 天內所要求廣告資料來源的資料存取預算。
list GET /v1/{parent=customers/*}/adsDataCustomers
列出客戶可以存取的廣告資料。

REST 資源:v1.customers.analysisQuery

方法
create POST /v1/{parent=customers/*}/analysisQueries
建立分析查詢,以供後續執行。
delete DELETE /v1/{name=customers/*/analysisQueries/*}
刪除分析查詢。
get GET /v1/{name=customers/*/analysisQueries/*}
擷取要求的分析查詢。
list GET /v1/{parent=customers/*}/analysisQueries
列出指定客戶擁有的分析查詢。
patch PATCH /v1/{query.name=customers/*/analysisQueries/*}
更新現有的分析查詢。
start POST /v1/{name=customers/*/analysisQueries/*}:start
開始針對已儲存的分析查詢執行。
startTransient POST /v1/{parent=customers/*}/analysisQueries:startTransient
開始執行暫時分析查詢。
validate POST /v1/{parent=customers/*}/analysisQueries:validate
對所提供的分析查詢執行靜態驗證檢查。

REST 資源:v1.customers.customBiddingAlgorithms

方法
addAdvertiser POST /v1/{customBiddingAlgorithm=customers/*/customBiddingAlgorithms/*}:addAdvertiser
將 DV360 廣告客戶新增至自訂出價演算法的廣告客戶。
create POST /v1/{parent=customers/*}/customBiddingAlgorithms
建立由廣告資料中心管理的自訂出價演算法。
delete DELETE /v1/{name=customers/*/customBiddingAlgorithms/*}
刪除這個自訂出價演算法。
execute POST /v1/{name=customers/*/customBiddingAlgorithms/*}:execute
針對自訂出價模式過去 30 天的曝光次數評分。
get GET /v1/{name=customers/*/customBiddingAlgorithms/*}
擷取所要求的廣告資料中心代管自訂出價演算法。
list GET /v1/{parent=customers/*}/customBiddingAlgorithms
列出由指定廣告資料中心客戶管理的自訂出價演算法。
patch PATCH /v1/{customBiddingAlgorithm.name=customers/*/customBiddingAlgorithms/*}
更新要求的 Google Ads Data Hub 代管自訂出價演算法。
removeAdvertiser POST /v1/{customBiddingAlgorithm=customers/*/customBiddingAlgorithms/*}:removeAdvertiser
從自訂出價演算法的廣告客戶中移除 DV360 廣告客戶。

REST 資源:v1.customers.table

方法
get GET /v1/{name=customers/*/tables/*}
擷取要求的廣告資料中心表格。
list GET /v1/{parent=customers/*}/tables
列出指定客戶有權存取的廣告資料中心資料表。

REST 資源:v1.customers.tempTables

方法
get GET /v1/{name=customers/*/tempTables/*}
擷取要求的 Ads Data Hub 臨時資料表。
list GET /v1/{parent=customers/*}/tempTables
列出客戶建立的 Ads Data Hub 臨時資料表。

REST 資源:v1.customers.userListQuery

方法
create POST /v1/{parent=customers/*}/userListQueries
建立使用者清單查詢,以便稍後執行。
delete DELETE /v1/{name=customers/*/userListQueries/*}
刪除使用者清單查詢。
get GET /v1/{name=customers/*/userListQueries/*}
擷取要求的使用者名單查詢。
list GET /v1/{parent=customers/*}/userListQueries
列出指定客戶擁有的使用者名單查詢。
patch PATCH /v1/{query.name=customers/*/userListQueries/*}
更新現有的使用者名單查詢。
start POST /v1/{name=customers/*/userListQueries/*}:start
對已儲存的使用者名單查詢執行。
startTransient
(deprecated)
POST /v1/{parent=customers/*}/userListQueries:startTransient
開始執行臨時使用者名單查詢。
validate POST /v1/{parent=customers/*}/userListQueries:validate
對所提供的使用者名單查詢執行靜態驗證檢查。

REST 資源:v1.customers.userLists

方法
addEventMatchers POST /v1/{userList=customers/*/userLists/*}:addEventMatchers
將事件比對器新增至以頻率為準的使用者名單。
addRecipients POST /v1/{userList=customers/*/userLists/*}:addRecipients
將實體加進廣告資料中心管理的使用者名單收件者。
create POST /v1/{parent=customers/*}/userLists
建立由廣告資料中心管理的使用者名單。
delete DELETE /v1/{name=customers/*/userLists/*}
刪除系統要求的廣告資料中心管理的使用者名單。
generateFrequencyListMemberships POST /v1/{name=customers/*/userLists/*}:generateFrequencyListMemberships
為 UserList 產生會員資格。
get GET /v1/{name=customers/*/userLists/*}
擷取所要求的廣告資料中心代管使用者名單。
list GET /v1/{parent=customers/*}/userLists
列出由指定廣告資料中心客戶管理的使用者名單。
patch PATCH /v1/{userList.name=customers/*/userLists/*}
更新要求的廣告管理系統管理的使用者名單。
removeRecipients POST /v1/{userList=customers/*/userLists/*}:removeRecipients
從廣告資料中心管理的使用者名單收件者中移除實體。

REST 資源:v1.operations

方法
cancel POST /v1/{name=operations/**}:cancel
長時間執行的作業時,系統會開始取消非同步作業。
delete DELETE /v1/{name=operations/**}
刪除長時間執行的作業。
get GET /v1/{name=operations/**}
取得長時間執行的作業的最新狀態。
list GET /v1/{name}
列出符合要求中指定篩選條件的作業。
wait POST /v1/{name=operations/**}:wait
等待指定的長時間執行作業完成,或是最多達到指定逾時時間,並傳回最新狀態。

REST 資源:v1.outages

方法
list GET /v1/outages
列出服務中斷情形的時間戳記以遞減順序列出,回溯期則為 130 天。