Загрузить аудитории списков электронных адресов

Вы можете создавать аудитории электронных адресов , используя загруженную контактную информацию клиентов или идентификаторы мобильных устройств с помощью API Display & Video 360. На этой странице описано, как создать первоначальную аудиторию электронных адресов и добавить новые данные о клиентах к существующей аудитории с помощью API Display & Video 360.

Предупреждение. Убедитесь, что функции загрузки данных одобрены для родительского партнера предлагаемой аудитории. Для этого сначала попытайтесь создать аудиторию списков электронных адресов для соответствующего рекламодателя в пользовательском интерфейсе. Если загрузка данных не включена, попытки создать или обновить аудитории электронных адресов приведут к ошибке. Пользователи с доступом на уровне партнера могут запросить одобрение, используя эту форму запроса на доступ к партнеру .

Подготовьте пользовательские данные

Пользовательские данные, используемые для заполнения аудиторий электронных адресов, являются конфиденциальными и перед загрузкой должны быть надлежащим образом подготовлены.

Хеширование конфиденциальных данных

Некоторые аудитории электронных адресов создаются с использованием конфиденциальной контактной информации клиентов. Дисплей и Видео 360 требует, чтобы конфиденциальные данные перед загрузкой хешировались с использованием алгоритма SHA256. Перед загрузкой необходимо хешировать следующие поля данных:

• Имя
• Фамилия
• Адрес электронной почты
• Телефонные номера

Почтовые индексы и коды стран не следует хешировать перед загрузкой. Попытка загрузить нехешированные данные о клиентах приводит к ошибке.

Перед хешированием данных убедитесь, что выполнены следующие условия:

• Любые пробелы должны быть удалены из значений имени, фамилии и адреса электронной почты.
• Все значения должны быть записаны строчными буквами.
• Все телефонные номера должны быть отформатированы в формате E.164 и включать телефонный код страны.

Установить согласие пользователя

При загрузке пользовательских данных используйте поля consent в предоставленных объектах ContactInfoList или MobileDeviceIdList для передачи сигналов согласия, предоставленных включенными пользователями.

Установка значения CONSENT_STATUS_DENIED для любого поля объекта Consent приводит к ошибке.

Предупреждение. При загрузке членов аудитории списков электронных адресов из Европейской экономической зоны (ЕЭЗ) необходимо отправлять сигналы согласия, чтобы соблюдать Политику согласия пользователей из ЕС и использовать данные пользователей из ЕЭЗ для заполнения аудиторий электронных адресов.

Сигналы согласия устанавливаются для всех пользователей, добавленных в одном запросе firstAndThirdPartyAudiences.create или firstAndThirdPartyAudiences.editCustomerMatchMembers . Пользователей с разными сигналами согласия необходимо загружать в отдельные запросы.

Создайте аудиторию электронных адресов

Аудиторию электронных адресов можно создать с помощью метода firstAndThirdPartyAudiences.create . Аудитория должна быть объявлена ​​собственной аудиторией и иметь audienceType CUSTOMER_MATCH_CONTACT_INFO или CUSTOMER_MATCH_DEVICE_ID . Данные электронных адресов необходимо предоставлять с использованием соответствующего поля в members полей объединения .

Примечание. membershipDurationDays является обязательным при создании аудиторий электронных адресов. Неограниченный срок членства можно включить, установив значение поля равным 10000.

Вот пример того, как создать новую аудиторию списков электронных адресов с контактной информацией и неограниченным сроком членства, используя предоставленный список хешированных телефонных номеров:

Джава

// Create Customer Match audience object.
FirstAndThirdPartyAudience customerMatchAudience =
    new FirstAndThirdPartyAudience()
        .setDisplayName(display-name)
        .setFirstAndThirdPartyAudienceType(
            "FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY"
        )
        .setAudienceType("CUSTOMER_MATCH_CONTACT_INFO")
        .setMembershipDurationDays(10000L);

// Build list of contact information objects.
ContactInfoList contactInfoList = new ContactInfoList();
ArrayList<ContactInfo> contactInfos = new ArrayList<ContactInfo>();
for (String hashedPhoneNumber : list-of-hashed-phone-numbers) {
  ContactInfo contactInfo = new ContactInfo();
  ArrayList<String> phoneNumberList = new ArrayList<String>();
  phoneNumberList.add(hashedPhoneNumber);
  contactInfo.setHashedPhoneNumbers(phoneNumberList);
  contactInfos.add(contactInfo);
}
contactInfoList.setContactInfos(contactInfos);

// Build consent object for passing consent if granted by the end user.
Consent consent =
    new Consent()
        .setAdUserData(ad-user-data-consent)
        .setAdPersonalization(ad-personalization-consent);
ContactInfoList.setConsent(consent);

// Assign contact info list to Customer Match audience.
customerMatchAudience.setContactInfoList(contactInfoList);

// Create Customer Match audience.
FirstAndThirdPartyAudience response =
    service
        .firstAndThirdPartyAudiences()
        .create(customerMatchAudience)
        .setAdvertiserId(advertiser-id)
        .execute();

// Display name of new audience.
System.out.printf(
    "Customer Match audience %s was created.",
    response.getName()
);

Питон

# Build list of Contact Info objects
contact_infos = []
for hashed_phone_number in list-of-hashed-phone-numbers:
  contact_infos.append({'hashedPhoneNumbers': [hashed_phone_number]})

# Create a Customer Match first- and third-party audience object.
audience_obj = {
    'displayName': display-name,
    'firstAndThirdPartyAudienceType':
        'FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY',
    'audienceType': 'CUSTOMER_MATCH_CONTACT_INFO',
    'membershipDurationDays': 10000,
    'contactInfoList': {
        'contactInfos': [
            contact_infos
        ],
        'consent': {
            'adUserData': ad-user-data-consent,
            'adPersonalization': ad-personalization-consent
        }
    }
}

# Build and execute request.
audience = service.firstAndThirdPartyAudiences().create(
    advertiserId=advertiser-id,
    body=audience_obj
).execute()

# Display name of new audience.
print('Customer Match audience %s was created.' % audience["name"])

PHP

// Create a Customer Match first- and third-party audience object.
$audience = new Google_Service_DisplayVideo_FirstAndThirdPartyAudience();
$audience->setDisplayName(display-name);
$audience->setFirstAndThirdPartyAudienceType(
    'FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY'
);
$audience->setAudienceType('CUSTOMER_MATCH_CONTACT_INFO');
$audience->setMembershipDurationDays(10000);

// Build list of contact information objects.
$contactInfoList = new Google_Service_DisplayVideo_ContactInfoList();
$contactInfos = array();
foreach (list-of-hashed-phone-numbers as $hashedPhoneNumber) {
    $contactInfo = new Google_Service_DisplayVideo_ContactInfo();
    $contactInfo->setHashedPhoneNumbers(array($hashedPhoneNumber));
    $contactInfos[] = $contactInfo;
}
$contactInfoList->setContactInfos($contactInfos);

// Build consent object for passing consent if granted by the end user.
$consent = new Google_Service_DisplayVideo_Consent();
$consent->setAdUserData(ad-user-data-consent);
$consent->setAdPersonalization(ad-personalization-consent);
$contactInfoList->setConsent($consent);

// Assign contactInfoList to audience object.
$audience->setContactInfoList($contactInfoList);

// Call the API, creating the audience.
$result = $this->service->firstAndThirdPartyAudiences->create(
    $audience,
    array('advertiserId' => advertiser-id)
);

// Display name of new audience.
printf('Customer Match audience %s was created.', $result['name']);

Обновление состава аудитории списков электронных адресов

Если вы определили дополнительных клиентов, на которых хотите настроить таргетинг, вам необходимо продлить членство клиентов в существующей аудитории или вы хотите удалить клиентов из аудитории, вы можете обновить данные о клиентах существующей аудитории списков электронных адресов с помощью firstAndThirdPartyAudiences.editCustomerMatchMembers . метод. Вы можете добавлять клиентов в список, используя поле объединения added_members , и удалять клиентов из списка с помощью поля объединения removed_members .

Один запрос firstAndThirdPartyAudiences.editCustomerMatchMembers может только добавлять или удалять участников из списка. Один запрос, пытающийся выполнить оба действия, приводит к ошибке INVALID_ARGUMENT .

Примечание. Поля метаданных контактной информации и идентификатора устройства для аудиторий со списками электронных адресов, например displayName membershipDurationDays , можно обновить с помощью метода firstAndThirdPartyAudiences.patch .

Вот пример того, как добавить одного клиента в качестве участника к существующей контактной информации аудитории списка электронных адресов, используя предоставленные данные почтового адреса:

Джава

// Create an edit members request object.
EditCustomerMatchMembersRequest editCustomerMatchMembersRequest =
    new EditCustomerMatchMembersRequest()
        .setAdvertiserId(advertiser-id);

// Build contact information object to add to audience.
ContactInfoList contactInfoList = new ContactInfoList();
ArrayList<ContactInfo> contactInfos = new ArrayList<ContactInfo>();
ContactInfo contactInfo =
    new ContactInfo()
        .setHashedFirstName(hashed-customer-first-name)
        .setHashedLastName(hashed-customer-last-name)
        .setZipCodes(customer-zip-codes-list)
        .setCountryCode(customer-country-code);
contactInfos.add(contactInfo);
contactInfoList.setContactInfos(contactInfos);

// Build consent object for passing consent if granted by the end user.
Consent consent =
    new Consent()
        .setAdUserData(ad-user-data-consent)
        .setAdPersonalization(ad-personalization-consent);
ContactInfoList.setConsent(consent);

// Assign contact info list to request body.
editCustomerMatchMembersRequest.setAddedContactInfoList(contactInfoList);

// Edit Customer Match audience membership.
EditCustomerMatchMembersResponse response =
    service
        .firstAndThirdPartyAudiences()
        .editCustomerMatchMembers(
            audience-id,
            editCustomerMatchMembersRequest
        )
        .execute();

// Display ID of updated audience.
System.out.printf(
    "The membership of Customer Match audience ID %s was edited.",
    response.getFirstAndThirdPartyAudienceId()
);

Питон

# Create an edit members request object.
edit_member_request_obj = {
    'advertiserId': advertiser-id,
    'addedContactInfoList': {
        'contactInfos': [
            {
                'hashedFirstName': hashed-customer-first-name,
                'hashedLastName': hashed-customer-last-name,
                'countryCode': customer-country-code,
                'zipCodes': customer-zip-codes-list
            }
        ],
        'consent': {
          'adUserData': ad-user-data-consent,
          'adPersonalization': ad-personalization-consent
        }
    }
}

# Build and execute request.
response = service.firstAndThirdPartyAudiences().editCustomerMatchMembers(
    firstAndThirdPartyAudienceId=audience-id,
    body=edit_member_request_obj
).execute()

# Display ID of updated audience.
print('The membership of the Customer Match audience ID %s was updated.'
      % response["firstAndThirdPartyAudienceId"])

PHP

// Create an edit members request object.
$editMemberRequest =
    new Google_Service_DisplayVideo_EditCustomerMatchMembersRequest();
$editMemberRequest->setAdvertiserId(advertiser-id);

// Build contact information object to add to audience.
$contactInfoList = new Google_Service_DisplayVideo_ContactInfoList();
$contactInfos = array();
$contactInfo = new Google_Service_DisplayVideo_ContactInfo();
$contactInfo->setHashedFirstName(hashed-customer-first-name);
$contactInfo->setHashedLastName(hashed-customer-last-name);
$contactInfo->setCountryCode(customer-country-code);
$contactInfo->setZipCodes(array(customer-zip-codes-list));
$contactInfos[] = $contactInfo;
$contactInfoList->setContactInfos($contactInfos);

// Build consent object for passing consent if granted by the end user.
$consent = new Google_Service_DisplayVideo_Consent();
$consent->setAdUserData(ad-user-data-consent);
$consent->setAdPersonalization(ad-personalization-consent);
$contactInfoList->setConsent($consent);

// Assign contactInfoList to edit members request body.
$editMemberRequest->setAddedContactInfoList($contactInfoList);

// Call the API, editing the audience membership.
$response = $this
    ->service
    ->firstAndThirdPartyAudiences
    ->editCustomerMatchMembers(
        audience-id,
        $editMemberRequest
    );

// Display ID of updated audience.
printf(
    'The membership of Customer Match audience ID %s was edited',
    $result['firstAndThirdPartyAudienceId']
);