您可以使用 Bulk Uploader API 為 Authorized Buyers 新增及移除廣告 ID 以及指定的使用者名單
以下是 HTTPS Bulk Uploader API 網址範例:
https://cm.g.doubleclick.net/upload?nid={GoogleNetworkId}
端點接受 HTTPS POST 要求。
GoogleNetworkId
的值應為 Cookie 比對聯播網 ID (NID)
用於識別「大量上傳程式」的帳戶專屬識別號碼
Cookie 比對。
HTTPS POST 要求的酬載 通訊協定緩衝區,說明要修改的清單。 如要查看大量上傳工具服務的架構,請前往: cookie-bulk-upload-proto.txt.各個 Pod 的酬載 限制為 100 KB。
如要進一步瞭解如何編譯,並使用 cookie-bulk-upload.proto
來
序列化和剖析訊息,請參閱偏好使用的教學課程
語言。
您可以上傳下列 ID 類型:
- Google 使用者 ID
- 合作夥伴提供的 ID
- iOS 廣告識別碼
- Android 廣告 ID
- Roku ID
- Amazon Fire TV ID
- Xbox 或 Microsoft ID
上傳 Google 使用者 ID
Google 使用者 ID 是從 doubleclick.net
網域經過加密的 ID。
上傳 Google 使用者 ID 的方法如下:
- 使用 Google 設定 Cookie 比對,並代管 對照表。
- 使用對照表將 User-ID 轉換為 Google User-ID。
- 將 Google 使用者 ID 上傳到使用者名單。
例如,如果您在 Cookie 比對期間收到下列項目:
https://ad.network.com/pixel?google_gid=CAESEHIV8HXNp0pFdHgi2rElMfk&google_cver=1
google_gid
參數是經過加密的 Google 使用者 ID。
如要將該應用程式加入使用者名單,請複製到 UpdateUsersDataRequest
主體:
ops {
user_id: "CAESEHIV8HXNp0pFdHgi2rElMfk"
user_list_id: 111
delete: false
user_id_type: GOOGLE_USER_ID
}
上傳合作夥伴提供的 ID
合作夥伴提供的 ID 是合作夥伴自有網域的 ID。方法如下 上傳合作夥伴提供的 ID:
透過 Google 設定 Cookie 比對,並允許 由 Google 代管對照表。
將合作夥伴提供的 ID 上傳到使用者名單。
舉例來說,如果網域的使用者 ID 已設為
123456
,您可以 然後在 Google 代管的對照表中填入 Cookie 比對好感度預測 代碼應包含可在網路上安全存取的 base64 編碼的版本 指派給google_hm
參數的 ID,如下所示:https://cm.g.doubleclick.net/pixel?google_nid=cookie-monster&google_hm=MTIzNDU2&google_cm
接著,您就可以將合作夥伴提供的 ID 上傳到含有
UpdateUsersDataRequest
:ops { user_id: "123456" user_list_id: 123 delete: false user_id_type: PARTNER_PROVIDED_ID }
接著,Google 會將合作夥伴提供 ID 的使用者名單翻譯成 Google 然後將 ID 加進使用者名單。
上傳 IDFA 或 Android 廣告 ID
您也可以上傳裝置 ID。
使用
UpdateUsersDataRequest
上傳裝置 ID:ops { user_id: "2024D65F-EBBD-11FF-23AB-823FC255913A" user_list_id: 111 delete: false user_id_type: IDFA }
接著,Google 會將使用者名單從裝置 ID 轉譯為 Google 使用者 ID。 將 ID 加進使用者名單。
工作流程
所有大量上傳者要求與回應範例均以「文字」 格式:您必須傳送 傳送至大量用戶端的通訊協定緩衝區訊息 上傳器 API 端點。
舉例來說,如要將 IDFA 和合作夥伴提供的 ID 上傳到使用者名單 123
,
建立 UpdateUsersDataRequest
:
ops {
user_id: "2024D65F-EBBD-11FF-23AB-823FC255913A"
user_list_id: 123
delete: false
user_id_type: IDFA
}
ops {
user_id: "1234567"
user_list_id: 123
delete: false
user_id_type: PARTNER_PROVIDED_ID
}
# See warning before use. Requires affirmative end-user consent.
process_consent: true
然後,傳送含有序列化 UpdateUsersDataRequest
的 HTTPS POST 要求。
做為酬載
如果所有作業都順利完成,您會看到下列結果:
UpdateUsersDataResponse
:
status: NO_ERROR
如果部分作業成功,回應會包含
UpdateUsersDataResponse
,每項失敗作業皆有錯誤:
status: PARTIAL_SUCCESS
errors {
user_id: "1234567"
error_code: UNKNOWN_ID
user_id_type: PARTNER_PROVIDED_ID
}
如果所有作業皆失敗,回應會包含
status
的 UpdateUsersDataResponse
設為 BAD_COOKIE
:
status: BAD_COOKIE
範例
這是 Python 指令碼範例,示範如何使用程式庫 以便填入 cookie-bulk-upload.proto 產生的 使用大量上傳工具服務,列出特定編號的使用者名單:
#!/usr/bin/python
#
# Copyright 2023 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""A sample demonstrating usage of the Authorized Buyers Bulk Upload service.
Successfully running this example will add the provided ID to the given user
list. To learn more about the bulk uploader service, see:
https://developers.google.com/authorized-buyers/rtb/bulk-uploader
"""
import argparse
import gen.cookie_bulk_upload_pb2
import requests
BULK_UPLOAD_ENDPOINT_TEMPLATE = 'https://cm.g.doubleclick.net/upload?nid=%s'
def main(account_nid, user_list_id, user_id, user_id_type):
# Build the bulk upload request.
update_request = gen.cookie_bulk_upload_pb2.UpdateUsersDataRequest()
update_request.send_notifications = True
ops = update_request.ops
op = ops.add()
op.user_list_id = user_list_id
op.user_id = user_id
op.user_id_type = user_id_type
user_id_type_value = gen.cookie_bulk_upload_pb2.UserIdType.Name(
user_id_type)
print(f'For NID "{account_nid}", adding user ID "{user_id}" of type '
f'"{user_id_type_value}" to user list ID "{user_list_id}"')
# Execute the bulk upload request.
response = requests.post(BULK_UPLOAD_ENDPOINT_TEMPLATE % account_nid,
data=update_request.SerializeToString())
# Parse and display the response.
update_response = gen.cookie_bulk_upload_pb2.UpdateUsersDataResponse()
update_response.ParseFromString(response.content)
print('Operation completed with the following:')
print(f'\tHTTP Status code: {response.status_code}')
status_value = gen.cookie_bulk_upload_pb2.ErrorCode.Name(
update_response.status)
print(f'\tUpdateUsersDataResponse.status: {status_value}')
print(f'\tUpdateUsersDataResponse.errors: {update_response.errors}')
print('\tUpdateUsersDataResponse.notifications: '
f'{update_response.notifications}')
n_status_value = gen.cookie_bulk_upload_pb2.NotificationStatus.Name(
update_response.notification_status)
print(f'\tUpdateUsersDataResponse.notification_status: {n_status_value}')
if __name__ == '__main__':
parser = argparse.ArgumentParser(
description=('A sample demonstrating usage of the Authorized Buyers '
'bulk uploader service.'))
parser.add_argument('-n', '--account_nid',
required=True, help='The Account NID.')
parser.add_argument('-u', '--user_id',
required=True, help='The User ID to be added.')
parser.add_argument('-l', '--user_list_id', type=int, required=True,
help='The user list that the ID is being added to.')
parser.add_argument('-t', '--user_id_type', type=int, required=True,
help=('The type of user ID being added. See '
'"UserIdType" enum for more details.'))
args = parser.parse_args()
main(args.account_nid, args.user_list_id, args.user_id, args.user_id_type)
處理大量上傳要求中的同意聲明
使用 Bulk Upload API 的合作夥伴必須指明, 基於「大量上傳」,與 Google 分享使用者資料的法律依據 process_consent 參數的值。這項規定適用於所有大量上傳 要求。
根據 Google 的歐盟地區規定,需要徵詢使用者同意的使用者資料
使用者同意政策
(請參閱 https://www.google.com/about/company/user-consent-policy/)
根據其他當地法律規定,合作夥伴必須取得
徵得使用者同意聲明,並提供已取得的同意聲明
即可設定 process_consent=True
。
對於不受使用者同意聲明規定的使用者資料,
合作夥伴必須指明
要求設定 process_consent=True
。
系統會篩除缺少「process_consent
」的要求並傳回
下列錯誤:
status: MISSING_CONSENT_WILL_BE_DROPPED
系統會篩除 process_consent
設為 false
的要求,並
會傳回下列錯誤:
status: MISSING_CONSENT