Method: firstPartyAndPartnerAudiences.list

列出第一方和夥伴目標對象。

順序由 orderBy 參數定義。

HTTP 要求

GET https://displayvideo.googleapis.com/v5/firstPartyAndPartnerAudiences

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
pageSize

integer

(選用步驟) 要求的頁面大小。必須介於 1 至 5000 之間。如未指定,這個值會預設為 5000。如果指定的值無效,則會傳回錯誤代碼 INVALID_ARGUMENT。

pageToken

string

(選用步驟) 用來識別伺服器應傳回哪一頁結果的權杖。通常,這是先前呼叫 firstPartyAndPartnerAudiences.list 方法時傳回的 nextPageToken 值。如未指定,系統會傳回第一頁的結果。

orderBy

string

(選用步驟) 用於排序清單的欄位。可接受的值如下:

  • FirstPartyAndPartnerAudienceId (預設)
  • displayName

預設排列順序為遞增。如要指定欄位的遞減排序,請在欄位名稱後方加上「desc」。範例:displayName desc。

filter

string

(選用步驟) 可依第一方和夥伴目標對象欄位篩選。

支援的語法:

  • 第一方和夥伴目標對象的篩選運算式最多只能包含一項限制。
  • 限制的格式為 {field} {operator} {value}。
  • 所有欄位都必須使用 HAS (:) 運算子。

支援的欄位:

  • displayName

範例:

  • 顯示名稱包含「Google」的所有第一方和夥伴目標對象:displayName:"Google"。

這個欄位的長度不得超過 500 個字元。

詳情請參閱篩選 LIST 要求指南。

必填。指出提出要求的 DV360 實體。LIST 要求只會傳回第一方和合作夥伴目標對象實體,且這些實體必須可供 accessor 中識別的 DV360 實體存取。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
partnerId

string (int64 format)

有權存取所擷取第一方和夥伴目標對象的夥伴 ID。

advertiserId

string (int64 format)

有權存取所擷取第一方和合作夥伴目標對象的廣告主 ID。

互斥欄位結束。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "firstPartyAndPartnerAudiences": [
    {
      object (FirstPartyAndPartnerAudience)
    }
  ],
  "nextPageToken": string
}
欄位
firstPartyAndPartnerAudiences[]

object (FirstPartyAndPartnerAudience)

第一方和夥伴目標對象名單。不含目標對象規模屬性。

如果清單空白,就不會顯示。

nextPageToken

string

用來擷取下一頁結果的權杖。在後續呼叫 firstPartyAndPartnerAudiences.list 方法時,將這個值傳遞至 pageToken 欄位,即可擷取下一頁結果。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/display-video

詳情請參閱OAuth 2.0 Overview。