Reklam kimliklerini kullanıcı listelerine yükleme

Hedefleme için Authorized Buyers kullanıcı listelerine reklam kimlikleri eklemek ve bu listelerden reklam kimliklerini kaldırmak üzere toplu yükleyici API'sini kullanabilirsiniz.

Örnek bir HTTPS Toplu Yükleyici API URL'si:

https://cm.g.doubleclick.net/upload?nid={GoogleNetworkId}

Uç nokta, HTTPS POST isteklerini kabul eder.

GoogleNetworkId değeri, Toplu Yükleyici ve çerez eşleştirme için hesabınızı benzersiz şekilde tanımlayan çerez eşleştirme ağ kimliğiniz (NID) olmalıdır.

HTTPS POST isteğinin yükü, değiştirilecek listeleri açıklayan kodlanmış bir protokol arabelleğidir. Toplu Yükleyici hizmetinin şemasını cookie-bulk-upload-proto.txt dosyasında bulabilirsiniz. Her isteğin yükü 100 KB ile sınırlıdır.

Mesajları serileştirmek ve ayrıştırmak için cookie-bulk-upload.proto'ı derleme ve kullanma hakkında daha fazla bilgi edinmek için tercih ettiğiniz dildeki eğiticileri inceleyin.

Aşağıdaki tanımlayıcı türlerini yükleyebilirsiniz:

  • Google kullanıcı kimliği
  • İş ortağı tarafından sağlanan kimlik
  • iOS IDFA
  • Android reklam kimliği
  • Roku kimliği
  • Amazon Fire TV kimliği
  • Xbox veya Microsoft Kimliği

Google kullanıcı kimliklerini yükleme

Google kullanıcı kimlikleri, doubleclick.net alanından alınan şifrelenmiş kimliklerdir.

Google kullanıcı kimliği yüklemek için:

  1. Google ile çerez eşlemeyi ayarlayın ve eşleşme tablosunu barındırın.
  2. Kullanıcı kimliklerinizi Google kullanıcı kimliklerine dönüştürmek için eşleşme tablonuzu kullanın.
  3. Google kullanıcı kimliklerini kullanıcı listesine yükleyin.

Örneğin, çerez eşleştirme sırasında aşağıdakileri alırsanız:

https://ad.network.com/pixel?google_gid=CAESEHIV8HXNp0pFdHgi2rElMfk&google_cver=1

google_gid parametresi, şifrelenmiş Google kullanıcı kimliğidir.

Bir kullanıcı listesine eklemek için UpdateUsersDataRequest gövdesine kopyalayın:

ops {
  user_id: "CAESEHIV8HXNp0pFdHgi2rElMfk"
  user_list_id: 111
  delete: false
  user_id_type: GOOGLE_USER_ID
}

İş ortağı tarafından sağlanan kimlikleri yükleme

İş ortağı tarafından sağlanan kimlikler, iş ortağının kendi alanındaki kimliklerdir. İş ortağı tarafından sağlanan kimliği yüklemek için aşağıdaki adımları uygulayın:

  1. Google ile çerez eşlemeyi ayarlayın ve Google'ın eşleşme tablonuzu barındırmasına izin verin.

  2. İş ortağı tarafından sağlanan kimliklerinizi kullanıcı listesine yükleyin.

    Örneğin, alanınız için 123456 olarak ayarlanmış bir kullanıcı kimliğiniz varsa bunu, Google'ın barındırılan eşleşme tablosunda çerez eşleme ile doldurabilirsiniz. Eşleşme etiketiniz, google_hm parametresine atanan kimliğin web güvenli base64 kodlu bir sürümünü içermelidir. Örneğin:

    https://cm.g.doubleclick.net/pixel?google_nid=cookie-monster&google_hm=MTIzNDU2&google_cm
    
  3. Ardından, iş ortağı tarafından sağlanan kimliği UpdateUsersDataRequest ile bir kullanıcı listesine yükleyebilirsiniz:

    ops {
     user_id: "123456"
     user_list_id: 123
     delete: false
     user_id_type: PARTNER_PROVIDED_ID
    }
    
  4. Ardından Google, kullanıcı listesini iş ortağı tarafından sağlanan kimliklerden Google kullanıcı kimliklerine çevirir ve kimlikleri kullanıcı listenize ekler.

IDFA veya Android reklam kimliklerini yükleme

Cihaz kimliklerini de yükleyebilirsiniz.

  1. Cihaz kimliğini UpdateUsersDataRequest ile yükleyin:

    ops {
     user_id: "2024D65F-EBBD-11FF-23AB-823FC255913A"
     user_list_id: 111
     delete: false
     user_id_type: IDFA
    }
    
  2. Ardından Google, kullanıcı listesini cihaz kimliklerinden Google kullanıcı kimliklerine çevirir ve kimlikleri kullanıcı listenize ekler.

İş akışı

Tüm Toplu Yükleyici istek ve yanıt örnekleri Metin Biçimi'nde yazılır. Bunları, seri hale getirilmiş Protocol Buffer iletileri olarak Bulk Uploader API uç noktasına göndermeniz gerekir.

Örneğin, 123 kullanıcı listesine bir IDFA ve iş ortağı tarafından sağlanan kimlik yüklemek için UpdateUsersDataRequest oluşturun:

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

Ardından, yük olarak serileştirilmiş UpdateUsersDataRequest mesajı içeren bir HTTPS POST isteği gönderin.

Tüm işlemler başarılı olursa aşağıdakileri alırsınız UpdateUsersDataResponse:

status: NO_ERROR

İşlemlerden bazıları başarılı olduysa yanıtta, başarısız olan her işlem için bir hata içeren UpdateUsersDataResponse bulunur:

status: PARTIAL_SUCCESS
errors {
  user_id: "1234567"
  error_code: UNKNOWN_ID
  user_id_type: PARTNER_PROVIDED_ID
}

İşlemlerden hiçbiri başarılı olmazsa yanıtta UpdateUsersDataResponse değeri BAD_COOKIE olarak ayarlanmış bir status bulunur:

status: BAD_COOKIE

Örnek

Bu, cookie-bulk-upload.proto tarafından oluşturulan kitaplığı kullanarak bir kullanıcı listesini toplu yükleyici hizmetiyle belirli bir kimlikle nasıl doldurabileceğinizi gösteren bir örnek Python komut dosyasıdır:

  #!/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)

Toplu Yükleme API'sini kullanan iş ortakları, process_consent parametresini kullanarak kullanıcı verilerini Toplu Yükleme amacıyla Google ile paylaşmak için uygun yasal dayanağa sahip olduklarını belirtmelidir. Bu koşul, tüm toplu yükleme istekleri için geçerlidir.

Google'ın AB kullanıcı rızası politikası (https://www.google.com/about/company/user-consent-policy/) veya diğer yerel yasalar uyarınca son kullanıcı izni gerektiren kullanıcı verileri için iş ortaklarının son kullanıcı izni alması ve process_consent=True ayarını yaparak toplanan izni belirtmesi gerekir.

Son kullanıcı izni şartlarına tabi olmayan kullanıcı verileri için iş ortaklarının, process_consent=True ayarını yaparak izin gerekmediğini belirtmesi gerekir.

process_consent parametresinin eksik olduğu istekler filtrelenir ve aşağıdaki hata döndürülür:

status: MISSING_CONSENT_WILL_BE_DROPPED

process_consent değerinin false olarak ayarlandığı istekler filtrelenir ve aşağıdaki hata döndürülür:

status: MISSING_CONSENT