- درخواست HTTP
- پارامترهای پرس و جو
- درخواست بدنه
- بدنه پاسخ
- دامنههای مجوز
- درخواستوضعیتبه ازای هر مقصد
- وضعیت درخواست
- اطلاعات خطا
- تعداد خطا
- دلیل خطای پردازش
- اطلاعات هشدار
- تعداد هشدارها
- دلیل هشدار در حال پردازش
- وضعیت اعضا
- وضعیت دادههای کاربر را دریافت کنید
- محدوده نرخ تطابق
- وضعیت دادههای موبایل را دریافت کنید
- وضعیت دادههای جفتشده (IngestPairDataStatus)
- وضعیت رویدادها
- وضعیت اعضا را حذف کنید
- حذف وضعیت دادههای کاربر
- حذف وضعیت دادههای موبایل
- وضعیت حذف جفت دادهها
- امتحانش کن!
وضعیت یک درخواست را با دادن شناسه درخواست (request id) دریافت میکند.
درخواست HTTP
GET https://datamanager.googleapis.com/v1/requestStatus:retrieve
این URL از سینتکس Transcoding در gRPC استفاده میکند.
پارامترهای پرس و جو
| پارامترها | |
|---|---|
requestId | الزامی. الزامی. شناسه درخواست مربوط به درخواست API مدیریت داده. |
درخواست بدنه
بدنه درخواست باید خالی باشد.
بدنه پاسخ
پاسخ از RetrieveRequestStatusRequest .
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{
"requestStatusPerDestination": [
{
object ( |
| فیلدها | |
|---|---|
requestStatusPerDestination[] | فهرستی از وضعیتهای درخواست به ازای هر مقصد. ترتیب وضعیتها با ترتیب مقصدها در درخواست اصلی مطابقت دارد. |
دامنههای مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/datamanager
درخواستوضعیتبه ازای هر مقصد
وضعیت درخواست برای هر مقصد.
| نمایش JSON |
|---|
{ "destination": { object ( |
| فیلدها | |
|---|---|
destination | مقصدی درون یک درخواست DM API. |
requestStatus | وضعیت درخواست مقصد. |
errorInfo | یک خطای اطلاعات خطا شامل دلیل خطا و تعداد خطاهای مربوط به آپلود. |
warningInfo | اطلاعات هشدار شامل دلیل هشدار و تعداد هشدارهای مربوط به آپلود. |
فیلد status اتحادیه. وضعیت مقصد. status میتواند فقط یکی از موارد زیر باشد: | |
audienceMembersIngestionStatus | وضعیت درخواست اعضای مخاطب ورودی. |
eventsIngestionStatus | وضعیت درخواست رویدادهای ورودی. |
audienceMembersRemovalStatus | وضعیت درخواست حذف مخاطب. |
وضعیت درخواست
وضعیت درخواست.
| انومها | |
|---|---|
REQUEST_STATUS_UNKNOWN | وضعیت درخواست نامشخص است. |
SUCCESS | درخواست با موفقیت انجام شد. |
PROCESSING | درخواست در حال پردازش است. |
FAILED | درخواست با شکست مواجه شد. |
PARTIAL_SUCCESS | این درخواست تا حدی موفقیتآمیز بود. |
اطلاعات خطا
برای هر نوع خطا، تعداد خطاها محاسبه میشود.
| نمایش JSON |
|---|
{
"errorCounts": [
{
object ( |
| فیلدها | |
|---|---|
errorCounts[] | فهرستی از خطاها و تعداد آنها به ازای هر دلیل خطا. ممکن است در همه موارد پر نشود. |
تعداد خطا
تعداد خطا برای یک دلیل خطای مشخص.
| نمایش JSON |
|---|
{
"recordCount": string,
"reason": enum ( |
| فیلدها | |
|---|---|
recordCount | تعداد رکوردهایی که به دلیل مشخصی آپلود نشدهاند. |
reason | دلیل خطای رکوردهای ناموفق. |
دلیل خطای پردازش
دلیل خطای پردازش
| انومها | |
|---|---|
PROCESSING_ERROR_REASON_UNSPECIFIED | دلیل خطای پردازش ناشناخته است. |
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE | متغیر سفارشی نامعتبر است. |
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED | وضعیت متغیر سفارشی فعال نیست. |
PROCESSING_ERROR_REASON_EVENT_TOO_OLD | تبدیل قدیمیتر از حداکثر سن پشتیبانیشده است. |
PROCESSING_ERROR_REASON_DENIED_CONSENT | دادههای کاربر تبلیغ، چه توسط کاربر و چه در تنظیمات پیشفرض تبلیغکننده، رد میشود. |
PROCESSING_ERROR_REASON_NO_CONSENT | تبلیغکننده رضایتنامهی 3P را برای سرویسهای پلتفرم اصلی تبلیغات ارائه نکرده است. |
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT | رضایت کلی (که از رضایت سطح ردیف، رضایت سطح درخواست و تنظیمات حساب تعیین میشود) برای این کاربر قابل تعیین نیست. |
PROCESSING_ERROR_REASON_DUPLICATE_GCLID | تبدیلی با همان GCLID و زمان تبدیل از قبل در سیستم وجود دارد. |
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID | تبدیلی با همان شناسه سفارش و ترکیب اقدام تبدیل قبلاً آپلود شده است. |
PROCESSING_ERROR_REASON_INVALID_GBRAID | جیبراید قابل رمزگشایی نبود. |
PROCESSING_ERROR_REASON_INVALID_GCLID | شناسه کلیک گوگل قابل رمزگشایی نیست. |
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID | شناسه فروشنده شامل کاراکترهای غیر رقمی است. |
PROCESSING_ERROR_REASON_INVALID_WBRAID | wbraid قابل رمزگشایی نبود. |
PROCESSING_ERROR_REASON_INTERNAL_ERROR | خطای داخلی. |
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED | شرایط تبدیلهای پیشرفته در حساب مقصد امضا نشدهاند. |
PROCESSING_ERROR_REASON_INVALID_EVENT | رویداد نامعتبر است. |
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS | تراکنشهای منطبق کمتر از حداقل آستانه هستند. |
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS | تراکنشها کمتر از حداقل آستانه هستند. |
PROCESSING_ERROR_REASON_INVALID_FORMAT | این رویداد دارای خطای قالببندی است. |
PROCESSING_ERROR_REASON_DECRYPTION_ERROR | این رویداد دارای خطای رمزگشایی است. |
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR | رمزگشایی DEK ناموفق بود. |
PROCESSING_ERROR_REASON_INVALID_WIP | WIP به طور نادرست قالب بندی شده است یا WIP وجود ندارد. |
PROCESSING_ERROR_REASON_INVALID_KEK | KEK نمیتواند دادهها را رمزگشایی کند زیرا KEK اشتباه است یا اصلاً وجود ندارد. |
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED | برنامه در حال اجرا قابل استفاده نبود زیرا طبق شرایط تأیید، رد شده بود. |
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED | این سیستم مجوزهای لازم برای دسترسی به KEK را نداشت. |
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED | سیستم نتوانست با AWS احراز هویت شود. |
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR | رمزگشایی دادههای UserIdentifier با استفاده از DEK ناموفق بود. |
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER | کاربر تلاش کرد رویدادهایی را با شناسه تبلیغاتی که از تبلیغات حساب کاربری نیست، دریافت کند. |
اطلاعات هشدار
برای هر نوع هشدار، یک هشدار حساب میشود.
| نمایش JSON |
|---|
{
"warningCounts": [
{
object ( |
| فیلدها | |
|---|---|
warningCounts[] | فهرستی از هشدارها و تعداد آنها به ازای هر دلیل هشدار. |
تعداد هشدارها
تعداد اخطارها برای یک دلیل اخطار داده شده.
| نمایش JSON |
|---|
{
"recordCount": string,
"reason": enum ( |
| فیلدها | |
|---|---|
recordCount | تعداد رکوردهایی که دارای هشدار هستند. |
reason | دلیل هشدار. |
دلیل هشدار در حال پردازش
دلیل هشدار پردازش.
| انومها | |
|---|---|
PROCESSING_WARNING_REASON_UNSPECIFIED | دلیل هشدار پردازش مشخص نیست. |
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED | این سیستم مجوزهای لازم برای دسترسی به KEK را نداشت. |
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR | رمزگشایی DEK ناموفق بود. |
PROCESSING_WARNING_REASON_DECRYPTION_ERROR | این رویداد دارای خطای رمزگشایی است. |
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED | برنامه در حال اجرا قابل استفاده نبود زیرا طبق شرایط تأیید، رد شده بود. |
PROCESSING_WARNING_REASON_INVALID_WIP | WIP به طور نادرست قالب بندی شده است یا WIP وجود ندارد. |
PROCESSING_WARNING_REASON_INVALID_KEK | KEK نمیتواند دادهها را رمزگشایی کند زیرا KEK اشتباه است یا اصلاً وجود ندارد. |
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR | رمزگشایی دادههای UserIdentifier با استفاده از DEK ناموفق بود. |
PROCESSING_WARNING_REASON_INTERNAL_ERROR | خطای داخلی. |
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED | سیستم نتوانست با AWS احراز هویت شود. |
وضعیت اعضا
وضعیت درخواست اعضای مخاطب ورودی.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
status فیلد Union. وضعیت اعضای مخاطب که به مقصد میرسند. status میتواند فقط یکی از موارد زیر باشد: | |
userDataIngestionStatus | وضعیت دریافت دادههای کاربر به مقصد. |
mobileDataIngestionStatus | وضعیت دریافت داده تلفن همراه به مقصد. |
pairDataIngestionStatus | وضعیت دریافت دادههای جفتی به مقصد. |
وضعیت دادههای کاربر را دریافت کنید
وضعیت دریافت دادههای کاربر به مقصد که شامل آمار مربوط به دریافت است.
| نمایش JSON |
|---|
{
"recordCount": string,
"userIdentifierCount": string,
"uploadMatchRateRange": enum ( |
| فیلدها | |
|---|---|
recordCount | تعداد کل اعضای مخاطب که در درخواست آپلود برای مقصد ارسال شدهاند. شامل تمام اعضای مخاطب در درخواست میشود، صرف نظر از اینکه آیا با موفقیت دریافت شدهاند یا خیر. |
userIdentifierCount | تعداد کل شناسههای کاربری ارسالشده در درخواست آپلود برای مقصد. شامل تمام شناسههای کاربری موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شدهاند یا خیر، میشود. |
uploadMatchRateRange | محدوده نرخ تطابق آپلود. |
محدوده نرخ تطابق
محدوده نرخ تطابق آپلود یا لیست کاربران.
| انومها | |
|---|---|
MATCH_RATE_RANGE_UNKNOWN | محدوده نرخ مسابقه مشخص نیست. |
MATCH_RATE_RANGE_NOT_ELIGIBLE | محدوده نرخ مسابقه واجد شرایط نیست. |
MATCH_RATE_RANGE_LESS_THAN_20 | محدوده نرخ تطابق کمتر از 20٪ است (در بازه [0, 20) ). |
MATCH_RATE_RANGE_20_TO_30 | محدوده نرخ تطابق بین 20% تا 30% است (در بازه [20, 31) ). |
MATCH_RATE_RANGE_31_TO_40 | محدوده نرخ تطابق بین ۳۱٪ و ۴۰٪ است (در بازه [31, 41) ). |
MATCH_RATE_RANGE_41_TO_50 | محدوده نرخ تطابق بین ۴۱٪ و ۵۰٪ است (در بازه [41, 51) ). |
MATCH_RATE_RANGE_51_TO_60 | محدوده نرخ تطابق بین ۵۱٪ و ۶۰٪ است (در بازه [51, 61) . |
MATCH_RATE_RANGE_61_TO_70 | محدوده نرخ تطابق بین ۶۱٪ و ۷۰٪ است (در بازه [61, 71) ). |
MATCH_RATE_RANGE_71_TO_80 | محدوده نرخ تطابق بین ۷۱٪ و ۸۰٪ است (در بازه [71, 81) ). |
MATCH_RATE_RANGE_81_TO_90 | محدوده نرخ تطابق بین ۸۱٪ و ۹۰٪ است (در بازه [81, 91) ). |
MATCH_RATE_RANGE_91_TO_100 | محدوده نرخ تطابق بین ۹۱٪ و ۱۰۰٪ است (در بازه |
وضعیت دادههای موبایل را دریافت کنید
وضعیت دریافت داده تلفن همراه به مقصد که شامل آمار مربوط به دریافت است.
| نمایش JSON |
|---|
{ "recordCount": string, "mobileIdCount": string } |
| فیلدها | |
|---|---|
recordCount | تعداد کل اعضای مخاطب که در درخواست آپلود برای مقصد ارسال شدهاند. شامل تمام اعضای مخاطب در درخواست میشود، صرف نظر از اینکه آیا با موفقیت دریافت شدهاند یا خیر. |
mobileIdCount | تعداد کل شناسههای موبایل ارسالشده در درخواست آپلود برای مقصد. شامل تمام شناسههای موبایل موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شدهاند یا خیر، میشود. |
وضعیت دادههای جفتشده (IngestPairDataStatus)
وضعیت دریافت دادههای جفتی به مقصد که شامل آمار مربوط به دریافت است.
| نمایش JSON |
|---|
{ "recordCount": string, "pairIdCount": string } |
| فیلدها | |
|---|---|
recordCount | تعداد کل اعضای مخاطب که در درخواست آپلود برای مقصد ارسال شدهاند. شامل تمام اعضای مخاطب در درخواست میشود، صرف نظر از اینکه آیا با موفقیت دریافت شدهاند یا خیر. |
pairIdCount | تعداد کل شناسههای جفت ارسالشده در درخواست آپلود برای مقصد. شامل تمام شناسههای جفت موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شدهاند یا خیر، میشود. |
وضعیت رویدادها
وضعیت دریافت رویدادها به مقصد.
| نمایش JSON |
|---|
{ "recordCount": string } |
| فیلدها | |
|---|---|
recordCount | تعداد کل رویدادهای ارسال شده در درخواست آپلود. شامل تمام رویدادهای موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شدهاند یا خیر. |
وضعیت اعضا را حذف کنید
وضعیت درخواست حذف مخاطب.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
status فیلد Union. وضعیت حذف اعضای مخاطب از مقصد. status میتواند فقط یکی از موارد زیر باشد: | |
userDataRemovalStatus | وضعیت حذف دادههای کاربر از مقصد. |
mobileDataRemovalStatus | وضعیت حذف دادههای تلفن همراه از مقصد. |
pairDataRemovalStatus | وضعیت حذف جفت دادهها از مقصد. |
حذف وضعیت دادههای کاربر
وضعیت حذف دادههای کاربر از مقصد.
| نمایش JSON |
|---|
{ "recordCount": string, "userIdentifierCount": string } |
| فیلدها | |
|---|---|
recordCount | تعداد کل مخاطبانی که درخواست حذف ارسال کردهاند. شامل همه مخاطبانی میشود که در درخواست ذکر شدهاند، صرف نظر از اینکه آیا با موفقیت حذف شدهاند یا خیر. |
userIdentifierCount | تعداد کل شناسههای کاربری ارسالشده در درخواست حذف. شامل تمام شناسههای کاربری موجود در درخواست، صرفنظر از اینکه با موفقیت حذف شدهاند یا خیر، میشود. |
حذف وضعیت دادههای موبایل
وضعیت حذف دادههای تلفن همراه از مقصد.
| نمایش JSON |
|---|
{ "recordCount": string, "mobileIdCount": string } |
| فیلدها | |
|---|---|
recordCount | تعداد کل مخاطبانی که درخواست حذف ارسال کردهاند. شامل همه مخاطبانی میشود که در درخواست ذکر شدهاند، صرف نظر از اینکه آیا با موفقیت حذف شدهاند یا خیر. |
mobileIdCount | تعداد کل شناسههای تلفن همراه ارسال شده در درخواست حذف. شامل تمام شناسههای تلفن همراه در درخواست، صرف نظر از اینکه آیا با موفقیت حذف شدهاند یا خیر. |
وضعیت حذف جفت دادهها
وضعیت حذف جفت دادهها از مقصد.
| نمایش JSON |
|---|
{ "recordCount": string, "pairIdCount": string } |
| فیلدها | |
|---|---|
recordCount | تعداد کل مخاطبانی که درخواست حذف ارسال کردهاند. شامل همه مخاطبانی میشود که در درخواست ذکر شدهاند، صرف نظر از اینکه آیا با موفقیت حذف شدهاند یا خیر. |
pairIdCount | تعداد کل شناسههای جفت ارسال شده در درخواست حذف. شامل تمام شناسههای جفت موجود در درخواست، صرف نظر از اینکه آیا با موفقیت حذف شدهاند یا خیر، میشود. |