Вы можете работать с этим кратким руководством, чтобы ознакомиться с API Data Manager. Выберите версию краткого руководства, которую вы хотите увидеть:
В этом кратком руководстве вы выполните следующие шаги:
- Подготовьте
Destination
для получения данных об аудитории. - Подготовьте данные об аудитории для отправки.
- Создайте запрос
IngestionService
для членов аудитории. - Отправьте запрос с помощью Google APIs Explorer.
- Понимание успешных и неудачных реакций.
Подготовьте пункт назначения
Прежде чем отправлять данные, вам необходимо подготовить место назначения для отправки данных. Вот пример Destination
, которое вы можете использовать:
{
"operatingAccount": {
"product": "OPERATING_ACCOUNT_PRODUCT",
"accountId": "OPERATING_ACCOUNT_ID"
},
"productDestinationId": "AUDIENCE_ID"
}
Установите для
operatingAccount
продукт и идентификатор учетной записи, которая будет получать данные об аудитории.
Подготовка данных об аудитории
Рассмотрим следующий пример данных в файле, разделенном запятыми. Каждая строка в файле соответствует одному участнику аудитории, и у каждого участника есть до трех адресов электронной почты.
#,email_1,email_2,email_3
1,dana@example.com,DanaM@example.com,
2,ALEXJ@example.com, AlexJ@cymbalgroup.com,alexj@altostrat.com
3,quinn@CYMBALGROUP.com,baklavainthebalkans@gmail.com ,
4,rosario@example.org,cloudySanFrancisco@GMAIL.com,
Адреса электронной почты имеют следующие требования к форматированию и хешированию:
- Удалите все начальные, конечные и промежуточные пробелы.
- Преобразуйте адрес электронной почты в нижний регистр.
- Хэшируйте адрес электронной почты с помощью алгоритма SHA-256 .
- Закодируйте байты хеша, используя шестнадцатеричное (hex) или кодирование Base64 . В примерах в этом руководстве используется шестнадцатеричное кодирование.
Вот отформатированные данные:
#,email_1,email_2,email_3
1,dana@example.com,danam@example.com,
2,alexj@example.com,alexj@cymbalgroup.com,alexj@altostrat.com
3,quinn@cymbalgroup.com,baklavainthebalkans@gmail.com,
4,rosario@example.org,cloudysanfrancisco@gmail.com,
А вот данные после хеширования и кодирования:
#,email_1,email_2,email_3
1,07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3,1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7
2,2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3,54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51,e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478
3,05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0,f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5
4,83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f,223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4
Вот пример AudienceMember
для отформатированных, хешированных и закодированных адресов электронной почты dana@example.com
и danam@example.com
из первой строки входных данных:
{
"userData": {
"userIdentifiers": [
{
"emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
},
{
"emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
}
]
}
}
Создайте тело запроса
Объедините Destination
и userData
для тела запроса:
{
"destinations": [
{
"operatingAccount": {
"product": "OPERATING_ACCOUNT_PRODUCT",
"accountId": "OPERATING_ACCOUNT_ID"
},
"productDestinationId": "AUDIENCE_ID"
}
],
"audienceMembers": [
{
"userData": {
"userIdentifiers": [
{
"emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
},
{
"emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
}
]
}
},
{
"userData": {
"userIdentifiers": [
{
"emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
},
{
"emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
},
{
"emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
}
]
}
},
{
"userData": {
"userIdentifiers": [
{
"emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
},
{
"emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
}
]
}
},
{
"userData": {
"userIdentifiers": [
{
"emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
},
{
"emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
}
]
}
}
],
"consent": {
"adUserData": "CONSENT_GRANTED",
"adPersonalization": "CONSENT_GRANTED"
},
"encoding": "HEX",
"termsOfService": {
"customerMatchTermsOfServiceStatus": "ACCEPTED"
},
"validateOnly": true
}
- Обновите заполнители в тексте, такие как
OPERATING_ACCOUNT_PRODUCT
,OPERATING_ACCOUNT_ID
иAUDIENCE_ID
, указав значения для вашей учетной записи и назначения. - Установите
validateOnly
наtrue
, чтобы проверить запрос без применения изменений. Когда вы будете готовы применить изменения, установитеvalidateOnly
наfalse
. - Установите
termsOfService
, чтобы указать, что пользователь принял условия обслуживания Customer Match . - Обратите внимание, что этот запрос указывает на то, что
consent
предоставлено, и не использует шифрование.
Отправить запрос
- Скопируйте текст запроса с помощью кнопки «Копировать» в правом верхнем углу образца.
- Перейдите на страницу
audienceMembers.ingest
. - Нажмите кнопку API справа, затем кнопку Попробовать! в развернутом разделе.
- Вставьте скопированное тело запроса в поле «Тело запроса» .
- Нажмите кнопку «Выполнить» , заполните поля авторизации и просмотрите ответ.
Успешные ответы
Успешный запрос возвращает ответ с объектом, содержащим requestId
.
{
"requestId": "126365e1-16d0-4c81-9de9-f362711e250a"
}
Ответы на неудачи
Неудачный запрос приводит к появлению кода состояния ответа об ошибке, например 400 Bad Request
, и ответа с подробностями ошибки.
Например, email_address
, содержащий обычную текстовую строку вместо шестнадцатеричного значения, выдает следующий ответ:
{
"error": {
"code": 400,
"message": "There was a problem with the request.",
"status": "INVALID_ARGUMENT",
"details": [
{
"@type": "type.googleapis.com/google.rpc.ErrorInfo",
"reason": "INVALID_ARGUMENT",
"domain": "datamanager.googleapis.com"
},
{
"@type": "type.googleapis.com/google.rpc.BadRequest",
"fieldViolations": [
{
"field": "audience_members.audience_members[0].user_data.user_identifiers",
"description": "Email is not hex encoded.",
"reason": "INVALID_HEX_ENCODING"
}
]
}
]
}
}
Адрес email_address
, который не хеширован и представлен только в шестнадцатеричном формате, возвращает следующий ответ:
{
"error": {
"code": 400,
"message": "There was a problem with the request.",
"status": "INVALID_ARGUMENT",
"details": [
{
"@type": "type.googleapis.com/google.rpc.ErrorInfo",
"reason": "INVALID_ARGUMENT",
"domain": "datamanager.googleapis.com"
},
{
"@type": "type.googleapis.com/google.rpc.BadRequest",
"fieldViolations": [
{
"field": "audience_members.audience_members[0]",
"reason": "INVALID_SHA256_FORMAT"
}
]
}
]
}
}
Следующие шаги
- Настройте аутентификацию и среду с помощью клиентской библиотеки.
- Узнайте о требованиях к форматированию, хешированию и кодированию для каждого типа данных.
- Узнайте, как шифровать данные пользователя .
- Узнайте о передовом опыте .
- Узнайте об ограничениях и квотах .