Package google.ads.datamanager.v1

فهرست

خدمات بلع

سرویسی برای ارسال داده‌های مخاطبان به مقاصد پشتیبانی‌شده.

اعضای IngestAudience

rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse )

فهرستی از منابع AudienceMember را در Destination ارائه شده آپلود می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager
رویدادهای Ingest

rpc IngestEvents( IngestEventsRequest ) returns ( IngestEventsResponse )

فهرستی از منابع Event را از Destination ارائه شده بارگذاری می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager
حذف اعضای مخاطب

rpc RemoveAudienceMembers( RemoveAudienceMembersRequest ) returns ( RemoveAudienceMembersResponse )

لیستی از منابع AudienceMember را از Destination ارائه شده حذف می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager
بازیابی وضعیت درخواست

rpc RetrieveRequestStatus( RetrieveRequestStatusRequest ) returns ( RetrieveRequestStatusResponse )

وضعیت یک درخواست را با دادن شناسه درخواست (request id) دریافت می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager

شناسه‌های تبلیغاتی

شناسه‌ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت‌های آنلاین (مانند کلیک‌های تبلیغاتی).

فیلدها
session_attributes

string

اختیاری. ویژگی‌های جلسه برای انتساب و مدل‌سازی رویداد.

gclid

string

اختیاری. شناسه کلیک گوگل (gclid) مرتبط با این رویداد.

gbraid

string

اختیاری. شناسه کلیک برای کلیک‌های مرتبط با رویدادهای برنامه و منشأ گرفته از دستگاه‌های iOS با شروع iOS14.

wbraid

string

اختیاری. شناسه کلیک برای کلیک‌های مرتبط با رویدادهای وب و منشأ گرفته از دستگاه‌های iOS از iOS14 به بعد.

landing_page_device_info

DeviceInfo

اختیاری. اطلاعات جمع‌آوری‌شده در مورد دستگاه مورد استفاده (در صورت وجود) در زمان ورود به سایت تبلیغ‌کننده پس از تعامل با تبلیغ.

اطلاعات آدرس

اطلاعات آدرس برای کاربر.

فیلدها
given_name

string

الزامی. نام (کوچک) کاربر، تماماً با حروف کوچک، بدون نقطه‌گذاری، بدون فاصله‌ی خالی در ابتدا یا انتهای کلمه، و به صورت SHA-256 هش شده.

family_name

string

الزامی. نام خانوادگی (فامیلی) کاربر، تماماً با حروف کوچک، بدون نقطه‌گذاری، بدون فاصله‌ی خالی در ابتدا یا انتهای کلمه، و به صورت SHA-256 هش شده.

region_code

string

الزامی. کد منطقه دو حرفی در استاندارد ISO-3166-1 alpha-2 مربوط به آدرس کاربر.

postal_code

string

الزامی. کد پستی آدرس کاربر.

عضو مخاطب

مخاطبی که قرار است تحت عمل جراحی قرار گیرد.

فیلدها
destination_references[]

string

اختیاری. مشخص می‌کند که مخاطب به کدام Destination ارسال شود.

consent

Consent

اختیاری. تنظیم رضایت برای کاربر.

data فیلد یونیون. نوع داده‌های شناسایی که قرار است روی آنها عملیات انجام شود. data می‌توانند فقط یکی از موارد زیر باشند:
user_data

UserData

داده‌های ارائه شده توسط کاربر که کاربر را شناسایی می‌کند.

pair_data

PairData

شناسه‌های تطبیق هویت ناشر و تبلیغ‌کننده (PAIR) .

mobile_data

MobileData

داده‌هایی که دستگاه‌های تلفن همراه کاربر را شناسایی می‌کنند.

سبد خرید

داده‌های سبد خرید مرتبط با رویداد.

فیلدها
merchant_id

string

اختیاری. شناسه مرکز فروش مرتبط با اقلام.

merchant_feed_label

string

اختیاری. برچسب فید مرکز فروشندگان که با فید اقلام مرتبط است.

merchant_feed_language_code

string

اختیاری. کد زبان در ISO 639-1 مرتبط با فید مرکز فروشندگان اقلام. جایی که اقلام شما آپلود می‌شوند.

transaction_discount

double

اختیاری. مجموع تمام تخفیف‌های مرتبط با تراکنش.

items[]

Item

اختیاری. فهرست موارد مرتبط با رویداد.

تنظیمات رضایت‌نامه‌ی قانون بازارهای دیجیتال (DMA) برای کاربر.

فیلدها
ad_user_data

ConsentStatus

اختیاری. نشان می‌دهد که آیا کاربر با داده‌های کاربر تبلیغاتی موافقت می‌کند یا خیر.

ad_personalization

ConsentStatus

اختیاری. نشان می‌دهد که آیا کاربر با شخصی‌سازی تبلیغ موافقت می‌کند یا خیر.

وضعیت رضایت

نشان می‌دهد که آیا کاربر رضایت خود را داده، رد کرده یا مشخص نکرده است.

انوم‌ها
CONSENT_STATUS_UNSPECIFIED مشخص نشده است.
CONSENT_GRANTED اعطا شد.
CONSENT_DENIED تکذیب شد.

متغیر سفارشی

متغیر سفارشی برای تبدیل تبلیغات.

فیلدها
variable

string

اختیاری. نام متغیر سفارشی که قرار است تنظیم شود. اگر متغیر برای مقصد داده شده پیدا نشود، نادیده گرفته می‌شود.

value

string

اختیاری. مقداری که قرار است برای متغیر سفارشی ذخیره شود.

destination_references[]

string

اختیاری. رشته مرجعی که برای تعیین اینکه متغیر سفارشی باید به کدام یک از Event.destination_references ارسال شود، استفاده می‌شود. در صورت خالی بودن، از Event.destination_references استفاده خواهد شد.

نوع مشتری

نوع مشتری مرتبط با رویداد.

انوم‌ها
CUSTOMER_TYPE_UNSPECIFIED نوع مشتری نامشخص. هرگز نباید استفاده شود.
NEW مشتری برای تبلیغ کننده جدید است.
RETURNING مشتری دوباره به تبلیغ کننده مراجعه می‌کند.
REENGAGED مشتری دوباره با تبلیغ کننده ارتباط برقرار کرده است.

سبد ارزش مشتری

ارزش مشتری که توسط تبلیغ‌کننده ارزیابی شده است.

انوم‌ها
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket نامشخص. هرگز نباید استفاده شود.
LOW مشتری ارزش پایینی دارد.
MEDIUM مشتری ارزش متوسطی دارد.
HIGH مشتری ارزش بالایی دارد.

مقصد

محصول گوگلی که داده‌ها را برای آن ارسال می‌کنید. برای مثال، یک حساب Google Ads.

فیلدها
reference

string

اختیاری. شناسه (ID) برای این منبع Destination ، منحصر به فرد در درخواست. برای ارجاع به این Destination در IngestEventsRequest و IngestAudienceMembersRequest استفاده می‌شود.

login_account

ProductAccount

اختیاری. حسابی که برای فراخوانی این API استفاده می‌شود. برای اضافه کردن یا حذف داده‌ها از operating_account ، این login_account باید دسترسی نوشتن به operating_account داشته باشد. به عنوان مثال، یک حساب کاربری مدیر operating_account یا حسابی با پیوند برقرار شده به operating_account .

linked_account

ProductAccount

اختیاری. حسابی که login_account کاربر فراخوانی‌کننده از طریق یک لینک حساب ایجاد شده به آن دسترسی دارد. برای مثال، login_account یک شریک داده ممکن است به linked_account یک مشتری دسترسی داشته باشد. شریک ممکن است از این فیلد برای ارسال داده از linked_account به operating_account دیگری استفاده کند.

operating_account

ProductAccount

الزامی. حسابی که قرار است داده‌ها به آن ارسال یا از آن حذف شوند.

product_destination_id

string

الزامی. شیء درون حساب محصول که باید در آن وارد شود. برای مثال، شناسه مخاطب گوگل ادز، شناسه مخاطب Display & Video 360 یا شناسه اقدام تبدیل گوگل ادز.

اطلاعات دستگاه

اطلاعات مربوط به دستگاهی که هنگام وقوع رویداد مورد استفاده قرار گرفته است (در صورت وجود).

فیلدها
user_agent

string

اختیاری. رشته‌ی عامل کاربر دستگاه برای زمینه‌ی داده شده.

ip_address

string

اختیاری. آدرس IP دستگاه برای زمینه داده شده.

توجه: گوگل ادز از تطبیق آدرس IP برای کاربران نهایی در منطقه اقتصادی اروپا (EEA)، بریتانیا (UK) یا سوئیس (CH) پشتیبانی نمی‌کند. منطقی اضافه کنید تا به طور مشروط اشتراک‌گذاری آدرس‌های IP را از کاربران این مناطق حذف کنید و اطمینان حاصل کنید که اطلاعات واضح و جامعی در مورد داده‌هایی که در سایت‌ها، برنامه‌ها و سایر دارایی‌های خود جمع‌آوری می‌کنید در اختیار کاربران قرار می‌دهید و در صورت لزوم طبق قانون یا هرگونه سیاست گوگل، رضایت آنها را دریافت می‌کنید. برای جزئیات بیشتر به صفحه «درباره واردات تبدیل آفلاین» مراجعه کنید.

رمزگذاری

نوع کدگذاری اطلاعات شناسایی هش شده.

انوم‌ها
ENCODING_UNSPECIFIED نوع رمزگذاری نامشخص. هرگز نباید استفاده شود.
HEX کدگذاری هگز.
BASE64 کدگذاری پایه ۶۴

اطلاعات رمزگذاری

اطلاعات رمزگذاری برای داده‌های در حال مصرف.

فیلدها
فیلد union به wrapped_key . کلید پیچیده شده‌ای که برای رمزگذاری داده‌ها استفاده می‌شود. wrapped_key می‌تواند فقط یکی از موارد زیر باشد:
gcp_wrapped_key_info

GcpWrappedKeyInfo

پلتفرم ابری گوگل اطلاعات کلیدی را در خود جای داده است.

تعداد خطا

تعداد خطا برای یک دلیل خطای مشخص.

فیلدها
record_count

int64

تعداد رکوردهایی که به دلیل مشخصی آپلود نشده‌اند.

reason

ProcessingErrorReason

دلیل خطای رکوردهای ناموفق.

اطلاعات خطا

برای هر نوع خطا، تعداد خطاها محاسبه می‌شود.

فیلدها
error_counts[]

ErrorCount

فهرستی از خطاها و تعداد آنها به ازای هر دلیل خطا. ممکن است در همه موارد پر نشود.

دلیل خطا

دلایل خطا برای API مدیریت داده.

انوم‌ها
ERROR_REASON_UNSPECIFIED از این مقدار پیش‌فرض استفاده نکنید.
INTERNAL_ERROR یک خطای داخلی رخ داده است.
DEADLINE_EXCEEDED پاسخ به درخواست خیلی طول کشید.
RESOURCE_EXHAUSTED درخواست‌ها خیلی زیاده.
NOT_FOUND منبع یافت نشد.
PERMISSION_DENIED کاربر مجوز ندارد یا منبع مورد نظر یافت نشد.
INVALID_ARGUMENT مشکلی در درخواست وجود داشت.
REQUIRED_FIELD_MISSING فیلد مورد نیاز موجود نیست.
INVALID_FORMAT فرمت نامعتبر است.
INVALID_HEX_ENCODING مقدار کدگذاری شده HEX ناقص است.
INVALID_BASE64_ENCODING مقدار کدگذاری شده با base64 ناقص است.
INVALID_SHA256_FORMAT مقدار رمزگذاری شده SHA256 ناقص است.
INVALID_POSTAL_CODE کد پستی معتبر نیست.
INVALID_COUNTRY_CODE کد کشور معتبر نیست.
INVALID_ENUM_VALUE مقدار Enum قابل استفاده نیست.
INVALID_USER_LIST_TYPE نوع فهرست کاربران برای این درخواست قابل استفاده نیست.
INVALID_AUDIENCE_MEMBER این عضو مخاطب معتبر نیست.
TOO_MANY_AUDIENCE_MEMBERS حداکثر تعداد اعضای مخاطب مجاز برای هر درخواست 10،000 نفر است.
TOO_MANY_USER_IDENTIFIERS حداکثر تعداد شناسه‌های کاربری مجاز برای هر مخاطب، ۱۰ است.
TOO_MANY_DESTINATIONS حداکثر تعداد مقصد مجاز برای هر درخواست 10 است.
INVALID_DESTINATION این مقصد معتبر نیست.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED شریک داده به لیست کاربران متعلق به حساب عملیاتی دسترسی ندارد.
INVALID_MOBILE_ID_FORMAT قالب شناسه موبایل معتبر نیست.
INVALID_USER_LIST_ID لیست کاربران معتبر نیست.
MULTIPLE_DATA_TYPES_NOT_ALLOWED دریافت چندین نوع داده در یک درخواست واحد مجاز نیست.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER پیکربندی‌های مقصد حاوی یک حساب کاربری ورود به سیستم DataPartner باید در تمام پیکربندی‌های مقصد، حساب کاربری یکسانی داشته باشند.
TERMS_AND_CONDITIONS_NOT_SIGNED شرایط و ضوابط الزامی پذیرفته نمی‌شود.
INVALID_NUMBER_FORMAT قالب شماره نامعتبر است.
INVALID_CONVERSION_ACTION_ID شناسه اقدام تبدیل معتبر نیست.
INVALID_CONVERSION_ACTION_TYPE نوع عمل تبدیل معتبر نیست.
INVALID_CURRENCY_CODE کد ارز پشتیبانی نمی‌شود.
INVALID_EVENT این رویداد معتبر نیست.
TOO_MANY_EVENTS حداکثر تعداد رویدادهای مجاز برای هر درخواست 10،000 است.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS حساب مقصد برای تبدیل‌های پیشرفته برای سرنخ‌ها فعال نیست.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS به دلیل سیاست‌های داده‌های مشتری گوگل، نمی‌توان از تبدیل‌های پیشرفته برای حساب مقصد استفاده کرد. با نماینده گوگل خود تماس بگیرید.
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED حساب مقصد با شرایط تبدیل‌های پیشرفته موافقت نکرده است.
DUPLICATE_DESTINATION_REFERENCE دو یا چند مقصد در درخواست، مرجع یکسانی دارند.
NO_IDENTIFIERS_PROVIDED داده‌های رویدادها حاوی هیچ شناسه کاربری یا شناسه تبلیغاتی نیستند.

رویداد

رویدادی که نشان‌دهنده تعامل کاربر با وب‌سایت یا برنامه تبلیغ‌کننده است.

فیلدها
destination_references[]

string

اختیاری. رشته مرجع مورد استفاده برای تعیین مقصد. در صورت خالی بودن، رویداد به تمام destinations در درخواست ارسال خواهد شد.

transaction_id

string

اختیاری. شناسه منحصر به فرد برای این رویداد. برای تبدیل‌هایی که از چندین منبع داده استفاده می‌کنند، الزامی است.

event_timestamp

Timestamp

الزامی. زمان وقوع رویداد.

last_updated_timestamp

Timestamp

اختیاری. آخرین باری که رویداد به‌روزرسانی شده است.

user_data

UserData

اختیاری. بخش‌هایی از داده‌های ارائه شده توسط کاربر، که نشان دهنده کاربری است که رویداد با آن مرتبط است.

consent

Consent

اختیاری. اطلاعاتی در مورد اینکه آیا کاربر مرتبط انواع مختلفی از رضایت را ارائه داده است یا خیر.

ad_identifiers

AdIdentifiers

اختیاری. شناسه‌ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت‌های آنلاین (مانند کلیک‌های تبلیغاتی).

currency

string

اختیاری. کد ارزی مرتبط با تمام مقادیر پولی در این رویداد.

conversion_value

double

اختیاری. مقدار تبدیل مرتبط با رویداد، برای تبدیل‌های مبتنی بر ارزش.

event_source

EventSource

اختیاری. علامتی برای محل وقوع رویداد (وب، اپلیکیشن، فروشگاه و غیره).

event_device_info

DeviceInfo

اختیاری. اطلاعات جمع‌آوری‌شده در مورد دستگاهی که هنگام وقوع رویداد مورد استفاده قرار گرفته است (در صورت وجود).

cart_data

CartData

اختیاری. اطلاعات مربوط به تراکنش و موارد مرتبط با رویداد.

custom_variables[]

CustomVariable

اختیاری. اطلاعات جفت کلید/مقدار اضافی برای ارسال به کانتینرهای تبدیل (عمل تبدیل یا فعالیت FL).

experimental_fields[]

ExperimentalField

اختیاری. فهرستی از جفت‌های کلید/مقدار برای فیلدهای آزمایشی که ممکن است در نهایت به عنوان بخشی از API ارتقا یابند.

user_properties

UserProperties

اختیاری. اطلاعات ارزیابی‌شده توسط تبلیغ‌کننده درباره کاربر در زمان وقوع رویداد.

منبع رویداد

منبع رویداد.

انوم‌ها
EVENT_SOURCE_UNSPECIFIED منبع رویداد نامشخص. هرگز نباید استفاده شود.
WEB این رویداد از یک مرورگر وب ایجاد شده است.
APP این رویداد از یک برنامه ایجاد شده است.
IN_STORE این رویداد از یک تراکنش درون فروشگاهی ایجاد شده است.
PHONE این رویداد از یک تماس تلفنی ایجاد شد.
OTHER این رویداد از منابع دیگر تولید شده است.

میدان تجربی

میدان تجربی که نمایانگر میدان‌های غیررسمی است.

فیلدها
field

string

اختیاری. نام فیلدی که قرار است استفاده شود.

value

string

اختیاری. مقداری که فیلد باید تنظیم کند.

اطلاعات کلید GcpWrapped

اطلاعات مربوط به کلید پیچیده‌شده در پلتفرم ابری گوگل.

فیلدها
key_type

KeyType

الزامی. نوع الگوریتم مورد استفاده برای رمزگذاری داده‌ها.

wip_provider

string

الزامی. ارائه‌دهنده‌ی استخر هویت بار کاری (Workload Identity Pool) ملزم به استفاده از KEK است.

kek_uri

string

الزامی. شناسه منبع سرویس مدیریت کلید ابری پلتفرم گوگل کلود. باید به فرمت "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}" باشد.

encrypted_dek

string

الزامی. کلید رمزگذاری داده‌های رمزگذاری شده با کد base64.

نوع کلید

نوع الگوریتمی که برای رمزگذاری داده‌ها استفاده می‌شود.

انوم‌ها
KEY_TYPE_UNSPECIFIED نوع کلید نامشخص. هرگز نباید استفاده شود.
XCHACHA20_POLY1305 الگوریتم XChaCha20-Poly1305

درخواست اعضا برای دریافت اطلاعات مخاطبان

درخواست آپلود اعضای مخاطب به مقصدهای ارائه شده. یک IngestAudienceMembersResponse برمی‌گرداند.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:
با REST امتحانش کن
فیلدها
destinations[]

Destination

الزامی. فهرست مقاصدی که مخاطبان باید به آنجا فرستاده شوند.

audience_members[]

AudienceMember

الزامی. فهرست کاربرانی که باید به مقصدهای مشخص‌شده ارسال شوند. حداکثر ۱۰۰۰۰ منبع AudienceMember را می‌توان در یک درخواست واحد ارسال کرد.

consent

Consent

اختیاری. رضایت در سطح درخواست برای همه کاربران در درخواست اعمال می‌شود. رضایت در سطح کاربر، رضایت در سطح درخواست را لغو می‌کند و می‌تواند در هر AudienceMember مشخص شود.

validate_only

bool

اختیاری. برای اهداف آزمایشی. اگر true ، درخواست اعتبارسنجی می‌شود اما اجرا نمی‌شود. فقط خطاها برگردانده می‌شوند، نه نتایج.

encoding

Encoding

اختیاری. برای آپلودهای UserData الزامی است. نوع رمزگذاری شناسه‌های کاربر. برای شناسه‌های کاربر هش‌شده، این نوع رمزگذاری رشته هش‌شده است. برای شناسه‌های کاربر هش‌شده رمزگذاری‌شده، این نوع رمزگذاری رشته رمزگذاری‌شده بیرونی است، اما لزوماً رشته هش‌شده داخلی نیست، به این معنی که رشته هش‌شده داخلی می‌تواند به روشی متفاوت از رشته رمزگذاری‌شده بیرونی رمزگذاری شود. برای آپلودهای غیر UserData ، این فیلد نادیده گرفته می‌شود.

encryption_info

EncryptionInfo

اختیاری. اطلاعات رمزگذاری برای آپلودهای UserData . اگر تنظیم نشود، فرض بر این است که اطلاعات شناسایی آپلود شده هش شده اما رمزگذاری نشده‌اند. برای آپلودهای غیر UserData ، این فیلد نادیده گرفته می‌شود.

terms_of_service

TermsOfService

اختیاری. شرایط خدماتی که کاربر پذیرفته/رد کرده است.

پاسخ اعضا و مخاطبان

پاسخ از درخواست IngestAudienceMembersRequest .

فیلدها
request_id

string

شناسه‌ی خودکارِ ایجاد شده برای درخواست.

درخواست رویدادهای دریافتی

درخواست آپلود اعضای مخاطب به مقصدهای ارائه شده. یک IngestEventsResponse برمی‌گرداند.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:
با REST امتحانش کن
فیلدها
destinations[]

Destination

الزامی. فهرست مقاصدی که رویدادها به آنها ارسال می‌شوند.

events[]

Event

الزامی. فهرست رویدادهایی که باید به مقصدهای مشخص‌شده ارسال شوند. حداکثر ۲۰۰۰ منبع Event را می‌توان در یک درخواست واحد ارسال کرد.

consent

Consent

اختیاری. رضایت در سطح درخواست برای همه کاربران موجود در درخواست اعمال می‌شود. رضایت در سطح کاربر، رضایت در سطح درخواست را لغو می‌کند و می‌تواند در هر Event مشخص شود.

validate_only

bool

اختیاری. برای اهداف آزمایشی. اگر true ، درخواست اعتبارسنجی می‌شود اما اجرا نمی‌شود. فقط خطاها برگردانده می‌شوند، نه نتایج.

encoding

Encoding

اختیاری. برای آپلودهای UserData الزامی است. نوع رمزگذاری شناسه‌های کاربر. برای شناسه‌های کاربر هش‌شده، این نوع رمزگذاری رشته هش‌شده است. برای شناسه‌های کاربر هش‌شده رمزگذاری‌شده، این نوع رمزگذاری رشته رمزگذاری‌شده بیرونی است، اما لزوماً رشته هش‌شده داخلی نیست، به این معنی که رشته هش‌شده داخلی می‌تواند به روشی متفاوت از رشته رمزگذاری‌شده بیرونی رمزگذاری شود. برای آپلودهای غیر UserData ، این فیلد نادیده گرفته می‌شود.

encryption_info

EncryptionInfo

اختیاری. اطلاعات رمزگذاری برای آپلودهای UserData . اگر تنظیم نشود، فرض بر این است که اطلاعات شناسایی آپلود شده هش شده اما رمزگذاری نشده‌اند. برای آپلودهای غیر UserData ، این فیلد نادیده گرفته می‌شود.

پاسخ IngestEvents

پاسخ از IngestEventsRequest .

فیلدها
request_id

string

شناسه‌ی خودکارِ ایجاد شده برای درخواست.

مورد

نشان دهنده یک آیتم در سبد خرید مرتبط با رویداد است.

فیلدها
merchant_product_id

string

اختیاری. شناسه محصول در حساب مرکز فروشندگان.

quantity

int64

اختیاری. شماره این آیتم مرتبط با رویداد.

unit_price

double

اختیاری. قیمت واحد بدون احتساب مالیات، هزینه ارسال و هرگونه تخفیف در سطح تراکنش.

محدوده نرخ تطابق

محدوده نرخ تطابق آپلود یا لیست کاربران.

انوم‌ها
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

محدوده نرخ تطابق بین ۹۱٪ و ۱۰۰٪ است (در بازه [91, 100] ).

موبایل دیتا

ارائه کارت شناسایی موبایل برای حضار. ارائه حداقل یک کارت شناسایی موبایل الزامی است.

فیلدها
mobile_ids[]

string

الزامی. فهرست شناسه‌های دستگاه‌های تلفن همراه (شناسه تبلیغات/IDFA). حداکثر ۱۰ mobileIds می‌تواند در یک AudienceMember ارائه شود.

جفت داده

شناسه‌های PAIR برای حضار. حداقل یک شناسه PAIR لازم است.

فیلدها
pair_ids[]

string

الزامی. داده‌های PII ارائه شده توسط Cleanroom، هش شده با SHA256 و رمزگذاری شده با یک رمز جابجایی EC با استفاده از کلید ناشر برای لیست کاربران PAIR . حداکثر 10 pairIds می‌تواند در یک AudienceMember ارائه شود.

دلیل خطای پردازش

دلیل خطای پردازش

انوم‌ها
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_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_USER_IDENTIFIER_DECRYPTION_ERROR رمزگشایی داده‌های UserIdentifier با استفاده از DEK ناموفق بود.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER کاربر تلاش کرد رویدادهایی را با شناسه تبلیغاتی که از تبلیغات حساب کاربری نیست، دریافت کند.

دلیل هشدار در حال پردازش

دلیل هشدار پردازش.

انوم‌ها
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 خطای داخلی.

محصول

منسوخ شده. به جای آن از AccountType استفاده کنید. نشان دهنده یک محصول خاص گوگل است.

انوم‌ها
PRODUCT_UNSPECIFIED محصول نامشخص. هرگز نباید استفاده شود.
GOOGLE_ADS تبلیغات گوگل.
DISPLAY_VIDEO_PARTNER شریک نمایش و ویدئو ۳۶۰
DISPLAY_VIDEO_ADVERTISER تبلیغ‌کننده‌ی نمایش و ویدیوی ۳۶۰ درجه.
DATA_PARTNER شریک داده.

حساب کاربری محصول

نشان دهنده یک حساب کاربری خاص است.

فیلدها
product
(deprecated)

Product

منسوخ شده. به جای آن از account_type استفاده کنید.

account_id

string

الزامی. شناسه حساب. به عنوان مثال، شناسه حساب Google Ads شما.

account_type

AccountType

اختیاری. نوع حساب. برای مثال، GOOGLE_ADS . یا account_type یا product منسوخ شده مورد نیاز است. اگر هر دو تنظیم شده باشند، مقادیر باید مطابقت داشته باشند.

نوع حساب

انواع حساب‌های گوگل را نشان می‌دهد. برای یافتن حساب‌ها و مقصدها استفاده می‌شود.

انوم‌ها
ACCOUNT_TYPE_UNSPECIFIED محصول نامشخص. هرگز نباید استفاده شود.
GOOGLE_ADS تبلیغات گوگل.
DISPLAY_VIDEO_PARTNER شریک نمایش و ویدئو ۳۶۰
DISPLAY_VIDEO_ADVERTISER تبلیغ‌کننده‌ی نمایش و ویدیوی ۳۶۰ درجه.
DATA_PARTNER شریک داده.

درخواست حذف مخاطبان

درخواست حذف کاربران از مخاطبان در مقصدهای ارائه شده. پاسخ RemoveAudienceMembersResponse را برمی‌گرداند.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:
با REST امتحانش کن
فیلدها
destinations[]

Destination

الزامی. فهرست مقاصدی که کاربران باید از آنها حذف شوند.

audience_members[]

AudienceMember

الزامی. فهرست کاربرانی که باید حذف شوند.

validate_only

bool

اختیاری. برای اهداف آزمایشی. اگر true ، درخواست اعتبارسنجی می‌شود اما اجرا نمی‌شود. فقط خطاها برگردانده می‌شوند، نه نتایج.

encoding

Encoding

اختیاری. برای آپلودهای UserData الزامی است. نوع کدگذاری شناسه‌های کاربر. فقط برای کدگذاری بیرونی شناسه‌های کاربر رمزگذاری شده اعمال می‌شود. برای آپلودهای غیر UserData ، این فیلد نادیده گرفته می‌شود.

encryption_info

EncryptionInfo

اختیاری. اطلاعات رمزگذاری برای آپلودهای UserData . اگر تنظیم نشود، فرض بر این است که اطلاعات شناسایی آپلود شده هش شده اما رمزگذاری نشده‌اند. برای آپلودهای غیر UserData ، این فیلد نادیده گرفته می‌شود.

پاسخ اعضای مخاطب را حذف کنید

پاسخ از RemoveAudienceMembersRequest .

فیلدها
request_id

string

شناسه‌ی خودکارِ ایجاد شده برای درخواست.

درخواستوضعیتبه ازای هر مقصد

وضعیت درخواست برای هر مقصد.

فیلدها
destination

Destination

مقصدی درون یک درخواست DM API.

request_status

RequestStatus

وضعیت درخواست مقصد.

error_info

ErrorInfo

یک خطای اطلاعات خطا شامل دلیل خطا و تعداد خطاهای مربوط به آپلود.

warning_info

WarningInfo

اطلاعات هشدار شامل دلیل هشدار و تعداد هشدارهای مربوط به آپلود.

فیلد status اتحادیه. وضعیت مقصد. status می‌تواند فقط یکی از موارد زیر باشد:
audience_members_ingestion_status

IngestAudienceMembersStatus

وضعیت درخواست اعضای مخاطب ورودی.

events_ingestion_status

IngestEventsStatus

وضعیت درخواست رویدادهای ورودی.

audience_members_removal_status

RemoveAudienceMembersStatus

وضعیت درخواست حذف مخاطب.

وضعیت اعضا

وضعیت درخواست اعضای مخاطب ورودی.

فیلدها
status فیلد Union. وضعیت اعضای مخاطب که به مقصد می‌رسند. status می‌تواند فقط یکی از موارد زیر باشد:
user_data_ingestion_status

IngestUserDataStatus

وضعیت دریافت داده‌های کاربر به مقصد.

mobile_data_ingestion_status

IngestMobileDataStatus

وضعیت دریافت داده تلفن همراه به مقصد.

pair_data_ingestion_status

IngestPairDataStatus

وضعیت دریافت داده‌های جفتی به مقصد.

وضعیت رویدادها

وضعیت دریافت رویدادها به مقصد.

فیلدها
record_count

int64

تعداد کل رویدادهای ارسال شده در درخواست آپلود. شامل تمام رویدادهای موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شده‌اند یا خیر.

وضعیت داده‌های موبایل را دریافت کنید

وضعیت دریافت داده تلفن همراه به مقصد که شامل آمار مربوط به دریافت است.

فیلدها
record_count

int64

تعداد کل اعضای مخاطب که در درخواست آپلود برای مقصد ارسال شده‌اند. شامل تمام اعضای مخاطب در درخواست می‌شود، صرف نظر از اینکه آیا با موفقیت دریافت شده‌اند یا خیر.

mobile_id_count

int64

تعداد کل شناسه‌های موبایل ارسال‌شده در درخواست آپلود برای مقصد. شامل تمام شناسه‌های موبایل موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شده‌اند یا خیر، می‌شود.

وضعیت داده‌های جفت‌شده (IngestPairDataStatus)

وضعیت دریافت داده‌های جفتی به مقصد که شامل آمار مربوط به دریافت است.

فیلدها
record_count

int64

تعداد کل اعضای مخاطب که در درخواست آپلود برای مقصد ارسال شده‌اند. شامل تمام اعضای مخاطب در درخواست می‌شود، صرف نظر از اینکه آیا با موفقیت دریافت شده‌اند یا خیر.

pair_id_count

int64

تعداد کل شناسه‌های جفت ارسال‌شده در درخواست آپلود برای مقصد. شامل تمام شناسه‌های جفت موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شده‌اند یا خیر، می‌شود.

وضعیت داده‌های کاربر را دریافت کنید

وضعیت دریافت داده‌های کاربر به مقصد که شامل آمار مربوط به دریافت است.

فیلدها
record_count

int64

تعداد کل اعضای مخاطب که در درخواست آپلود برای مقصد ارسال شده‌اند. شامل تمام اعضای مخاطب در درخواست می‌شود، صرف نظر از اینکه آیا با موفقیت دریافت شده‌اند یا خیر.

user_identifier_count

int64

تعداد کل شناسه‌های کاربری ارسال‌شده در درخواست آپلود برای مقصد. شامل تمام شناسه‌های کاربری موجود در درخواست، صرف نظر از اینکه با موفقیت دریافت شده‌اند یا خیر، می‌شود.

upload_match_rate_range

MatchRateRange

محدوده نرخ تطابق آپلود.

وضعیت اعضا را حذف کنید

وضعیت درخواست حذف مخاطب.

فیلدها
status فیلد Union. وضعیت حذف اعضای مخاطب از مقصد. status می‌تواند فقط یکی از موارد زیر باشد:
user_data_removal_status

RemoveUserDataStatus

وضعیت حذف داده‌های کاربر از مقصد.

mobile_data_removal_status

RemoveMobileDataStatus

وضعیت حذف داده‌های تلفن همراه از مقصد.

pair_data_removal_status

RemovePairDataStatus

وضعیت حذف جفت داده‌ها از مقصد.

حذف وضعیت داده‌های موبایل

وضعیت حذف داده‌های تلفن همراه از مقصد.

فیلدها
record_count

int64

تعداد کل مخاطبانی که درخواست حذف ارسال کرده‌اند. شامل همه مخاطبانی می‌شود که در درخواست ذکر شده‌اند، صرف نظر از اینکه آیا با موفقیت حذف شده‌اند یا خیر.

mobile_id_count

int64

تعداد کل شناسه‌های تلفن همراه ارسال شده در درخواست حذف. شامل تمام شناسه‌های تلفن همراه در درخواست، صرف نظر از اینکه آیا با موفقیت حذف شده‌اند یا خیر.

وضعیت حذف جفت داده‌ها

وضعیت حذف جفت داده‌ها از مقصد.

فیلدها
record_count

int64

تعداد کل مخاطبانی که درخواست حذف ارسال کرده‌اند. شامل همه مخاطبانی می‌شود که در درخواست ذکر شده‌اند، صرف نظر از اینکه آیا با موفقیت حذف شده‌اند یا خیر.

pair_id_count

int64

تعداد کل شناسه‌های جفت ارسال شده در درخواست حذف. شامل تمام شناسه‌های جفت موجود در درخواست، صرف نظر از اینکه آیا با موفقیت حذف شده‌اند یا خیر، می‌شود.

حذف وضعیت داده‌های کاربر

وضعیت حذف داده‌های کاربر از مقصد.

فیلدها
record_count

int64

تعداد کل مخاطبانی که درخواست حذف ارسال کرده‌اند. شامل همه مخاطبانی می‌شود که در درخواست ذکر شده‌اند، صرف نظر از اینکه آیا با موفقیت حذف شده‌اند یا خیر.

user_identifier_count

int64

تعداد کل شناسه‌های کاربری ارسال‌شده در درخواست حذف. شامل تمام شناسه‌های کاربری موجود در درخواست، صرف‌نظر از اینکه با موفقیت حذف شده‌اند یا خیر، می‌شود.

وضعیت درخواست

وضعیت درخواست.

انوم‌ها
REQUEST_STATUS_UNKNOWN وضعیت درخواست نامشخص است.
SUCCESS درخواست با موفقیت انجام شد.
PROCESSING درخواست در حال پردازش است.
FAILED درخواست با شکست مواجه شد.
PARTIAL_SUCCESS این درخواست تا حدی موفقیت‌آمیز بود.

بازیابی درخواستوضعیتدرخواست

درخواستی برای دریافت وضعیت درخواست ارسال شده به DM API برای یک شناسه درخواست داده شده. یک RetrieveRequestStatusResponse برمی‌گرداند.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:
با REST امتحانش کن
فیلدها
request_id

string

الزامی. الزامی. شناسه درخواست مربوط به درخواست API مدیریت داده.

بازیابیدرخواستوضعیتپاسخ

پاسخ از RetrieveRequestStatusRequest .

فیلدها
request_status_per_destination[]

RequestStatusPerDestination

فهرستی از وضعیت‌های درخواست به ازای هر مقصد. ترتیب وضعیت‌ها با ترتیب مقصدها در درخواست اصلی مطابقت دارد.

شرایط خدمات

شرایط خدماتی که کاربر پذیرفته/رد کرده است.

فیلدها
customer_match_terms_of_service_status

TermsOfServiceStatus

اختیاری. شرایط خدمات «مطابقت با مشتری»: https://support.google.com/adspolicy/answer/6299717 . این شرایط باید هنگام دریافت UserData یا MobileData پذیرفته شود. این فیلد برای فهرست کاربران «مطابقت با شریک» الزامی نیست.

وضعیت شرایط خدمات

نشان دهنده تصمیم تماس گیرنده برای پذیرش یا رد شرایط خدمات است.

انوم‌ها
TERMS_OF_SERVICE_STATUS_UNSPECIFIED مشخص نشده است.
ACCEPTED وضعیتی که نشان می‌دهد تماس‌گیرنده شرایط خدمات را پذیرفته است.
REJECTED وضعیتی که نشان می‌دهد تماس‌گیرنده تصمیم به رد شرایط خدمات گرفته است.

داده‌های کاربر

داده‌هایی که کاربر را شناسایی می‌کنند. حداقل یک شناسه لازم است.

فیلدها
user_identifiers[]

UserIdentifier

الزامی. شناسه‌های کاربر. می‌توان چندین نمونه از یک نوع داده (مثلاً چندین آدرس ایمیل) ارائه داد. برای افزایش احتمال تطابق، تا حد امکان شناسه‌های بیشتری ارائه دهید. حداکثر 10 userIdentifiers می‌توان در یک AudienceMember یا Event ارائه داد.

شناسه کاربری

یک شناسه واحد برای کاربر.

فیلدها
identifier فیلد Union. دقیقاً یکی باید مشخص شود. identifier فقط می‌تواند یکی از موارد زیر باشد:
email_address

string

آدرس ایمیل هش شده با استفاده از تابع هش SHA-256 پس از نرمال‌سازی.

phone_number

string

شماره تلفن هش شده با استفاده از تابع هش SHA-256 پس از نرمال‌سازی (استاندارد E164).

address

AddressInfo

اجزای شناخته‌شده‌ی آدرس کاربر. گروهی از شناسه‌ها را که همگی به طور همزمان تطبیق داده شده‌اند، در خود نگه می‌دارد.

ویژگی‌های کاربر

اطلاعات ارزیابی‌شده توسط تبلیغ‌کننده درباره کاربر در زمان وقوع رویداد. برای جزئیات بیشتر به https://support.google.com/google-ads/answer/14007601 مراجعه کنید.

فیلدها
customer_type

CustomerType

اختیاری. نوع مشتری مرتبط با رویداد.

customer_value_bucket

CustomerValueBucket

اختیاری. ارزش ارزیابی‌شده توسط تبلیغ‌کننده برای مشتری.

تعداد هشدارها

تعداد اخطارها برای یک دلیل اخطار داده شده.

فیلدها
record_count

int64

تعداد رکوردهایی که دارای هشدار هستند.

reason

ProcessingWarningReason

دلیل هشدار.

اطلاعات هشدار

برای هر نوع هشدار، یک هشدار حساب می‌شود.

فیلدها
warning_counts[]

WarningCount

فهرستی از هشدارها و تعداد آنها به ازای هر دلیل هشدار.

،

فهرست

خدمات بلع

سرویسی برای ارسال داده‌های مخاطبان به مقاصد پشتیبانی‌شده.

اعضای IngestAudience

rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse )

فهرستی از منابع AudienceMember را در Destination ارائه شده آپلود می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager
رویدادهای Ingest

rpc IngestEvents( IngestEventsRequest ) returns ( IngestEventsResponse )

فهرستی از منابع Event را از Destination ارائه شده بارگذاری می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager
حذف اعضای مخاطب

rpc RemoveAudienceMembers( RemoveAudienceMembersRequest ) returns ( RemoveAudienceMembersResponse )

لیستی از منابع AudienceMember را از Destination ارائه شده حذف می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager
بازیابی وضعیت درخواست

rpc RetrieveRequestStatus( RetrieveRequestStatusRequest ) returns ( RetrieveRequestStatusResponse )

وضعیت یک درخواست را با دادن شناسه درخواست (request id) دریافت می‌کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/datamanager

شناسه‌های تبلیغاتی

شناسه‌ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت‌های آنلاین (مانند کلیک‌های تبلیغاتی).

فیلدها
session_attributes

string

اختیاری. ویژگی‌های جلسه برای انتساب و مدل‌سازی رویداد.

gclid

string

اختیاری. شناسه کلیک گوگل (gclid) مرتبط با این رویداد.

gbraid

string

اختیاری. شناسه کلیک برای کلیک‌های مرتبط با رویدادهای برنامه و منشأ گرفته از دستگاه‌های iOS با شروع iOS14.

wbraid

string

اختیاری. شناسه کلیک برای کلیک‌های مرتبط با رویدادهای وب و منشأ گرفته از دستگاه‌های iOS از iOS14 به بعد.

landing_page_device_info

DeviceInfo

اختیاری. اطلاعات جمع‌آوری‌شده در مورد دستگاه مورد استفاده (در صورت وجود) در زمان ورود به سایت تبلیغ‌کننده پس از تعامل با تبلیغ.

اطلاعات آدرس

اطلاعات آدرس برای کاربر.

فیلدها
given_name

string

الزامی. نام (کوچک) کاربر، تماماً با حروف کوچک، بدون نقطه‌گذاری، بدون فاصله‌ی خالی در ابتدا یا انتهای کلمه، و به صورت SHA-256 هش شده.

family_name

string

الزامی. نام خانوادگی (فامیلی) کاربر، تماماً با حروف کوچک، بدون نقطه‌گذاری، بدون فاصله‌ی خالی در ابتدا یا انتهای کلمه، و به صورت SHA-256 هش شده.

region_code

string

الزامی. کد منطقه دو حرفی در استاندارد ISO-3166-1 alpha-2 مربوط به آدرس کاربر.

postal_code

string

الزامی. کد پستی آدرس کاربر.

عضو مخاطب

مخاطبی که قرار است تحت عمل جراحی قرار گیرد.

فیلدها
destination_references[]

string

اختیاری. مشخص می‌کند که مخاطب به کدام Destination ارسال شود.

consent

Consent

اختیاری. تنظیم رضایت برای کاربر.

Union field data . The type of identifying data to be operated on. data can be only one of the following:
user_data

UserData

User-provided data that identifies the user.

pair_data

PairData

Publisher Advertiser Identity Reconciliation (PAIR) IDs .

mobile_data

MobileData

Data identifying the user's mobile devices.

CartData

The cart data associated with the event.

فیلدها
merchant_id

string

Optional. The Merchant Center ID associated with the items.

merchant_feed_label

string

Optional. The Merchant Center feed label associated with the feed of the items.

merchant_feed_language_code

string

Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.

transaction_discount

double

Optional. The sum of all discounts associated with the transaction.

items[]

Item

Optional. The list of items associated with the event.

Digital Markets Act (DMA) consent settings for the user.

فیلدها
ad_user_data

ConsentStatus

Optional. Represents if the user consents to ad user data.

ad_personalization

ConsentStatus

Optional. Represents if the user consents to ad personalization.

ConsentStatus

Represents if the user granted, denied, or hasn't specified consent.

انوم‌ها
CONSENT_STATUS_UNSPECIFIED مشخص نشده است.
CONSENT_GRANTED اعطا شد.
CONSENT_DENIED تکذیب شد.

متغیر سفارشی

Custom variable for ads conversions.

فیلدها
variable

string

Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.

value

string

Optional. The value to store for the custom variable.

destination_references[]

string

Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.

نوع مشتری

Type of the customer associated with the event.

انوم‌ها
CUSTOMER_TYPE_UNSPECIFIED Unspecified CustomerType. Should never be used.
NEW The customer is new to the advertiser.
RETURNING The customer is returning to the advertiser.
REENGAGED The customer has re-engaged with the advertiser.

CustomerValueBucket

The advertiser-assessed value of the customer.

انوم‌ها
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket. Should never be used.
LOW The customer is low value.
MEDIUM The customer is medium value.
HIGH The customer is high value.

مقصد

The Google product you're sending data to. For example, a Google Ads account.

فیلدها
reference

string

Optional. ID for this Destination resource, unique within the request. Use to reference this Destination in the IngestEventsRequest and IngestAudienceMembersRequest .

login_account

ProductAccount

Optional. The account used to make this API call. To add or remove data from the operating_account , this login_account must have write access to the operating_account . For example, a manager account of the operating_account , or an account with an established link to the operating_account .

linked_account

ProductAccount

Optional. An account that the calling user's login_account has access to, through an established account link. For example, a data partner's login_account might have access to a client's linked_account . The partner might use this field to send data from the linked_account to another operating_account .

operating_account

ProductAccount

Required. The account to send the data to or remove the data from.

product_destination_id

string

Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.

اطلاعات دستگاه

Information about the device being used (if any) when the event happened.

فیلدها
user_agent

string

Optional. The user-agent string of the device for the given context.

ip_address

string

Optional. The IP address of the device for the given context.

Note: Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the About offline conversion imports page for more details.

رمزگذاری

The encoding type of the hashed identifying information.

انوم‌ها
ENCODING_UNSPECIFIED Unspecified Encoding type. Should never be used.
HEX Hex encoding.
BASE64 Base 64 encoding.

EncryptionInfo

Encryption information for the data being ingested.

فیلدها
Union field wrapped_key . The wrapped key used to encrypt the data. wrapped_key can be only one of the following:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Google Cloud Platform wrapped key information.

ErrorCount

The error count for a given error reason.

فیلدها
record_count

int64

The count of records that failed to upload for a given reason.

reason

ProcessingErrorReason

The error reason of the failed records.

ErrorInfo

Error counts for each type of error.

فیلدها
error_counts[]

ErrorCount

A list of errors and counts per error reason. May not be populated in all cases.

ErrorReason

Error reasons for Data Manager API.

انوم‌ها
ERROR_REASON_UNSPECIFIED Do not use this default value.
INTERNAL_ERROR یک خطای داخلی رخ داده است.
DEADLINE_EXCEEDED The request took too long to respond.
RESOURCE_EXHAUSTED درخواست‌ها خیلی زیاده.
NOT_FOUND Resource not found.
PERMISSION_DENIED The user does not have permission or the resource is not found.
INVALID_ARGUMENT There was a problem with the request.
REQUIRED_FIELD_MISSING Required field is missing.
INVALID_FORMAT Format is invalid.
INVALID_HEX_ENCODING The HEX encoded value is malformed.
INVALID_BASE64_ENCODING The base64 encoded value is malformed.
INVALID_SHA256_FORMAT The SHA256 encoded value is malformed.
INVALID_POSTAL_CODE کد پستی معتبر نیست.
INVALID_COUNTRY_CODE Country code is not valid.
INVALID_ENUM_VALUE Enum value cannot be used.
INVALID_USER_LIST_TYPE Type of the user list is not applicable for this request.
INVALID_AUDIENCE_MEMBER This audience member is not valid.
TOO_MANY_AUDIENCE_MEMBERS Maximum number of audience members allowed per request is 10,000.
TOO_MANY_USER_IDENTIFIERS Maximum number of user identifiers allowed per audience member is 10.
TOO_MANY_DESTINATIONS Maximum number of destinations allowed per request is 10.
INVALID_DESTINATION This Destination is not valid.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED Data Partner does not have access to the operating account owned userlist.
INVALID_MOBILE_ID_FORMAT Mobile ID format is not valid.
INVALID_USER_LIST_ID User list is not valid.
MULTIPLE_DATA_TYPES_NOT_ALLOWED Multiple data types are not allowed to be ingested in a single request.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER Destination configs containing a DataPartner login account must have the same login account across all destination configs.
TERMS_AND_CONDITIONS_NOT_SIGNED Required terms and conditions are not accepted.
INVALID_NUMBER_FORMAT Invalid number format.
INVALID_CONVERSION_ACTION_ID Conversion action ID is not valid.
INVALID_CONVERSION_ACTION_TYPE The conversion action type is not valid.
INVALID_CURRENCY_CODE The currency code is not supported.
INVALID_EVENT This event is not valid.
TOO_MANY_EVENTS Maximum number of events allowed per request is 10,000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS The destination account is not enabled for enhanced conversions for leads.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Enhanced conversions can't be used for the destination account because of Google customer data policies. Contact your Google representative..
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED The destination account hasn't agreed to the terms for enhanced conversions.
DUPLICATE_DESTINATION_REFERENCE Two or more destinations in the request have the same reference.
NO_IDENTIFIERS_PROVIDED Events data contains no user identifiers or ad identifiers.

رویداد

An event representing a user interaction with an advertiser's website or app.

فیلدها
destination_references[]

string

Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.

transaction_id

string

Optional. The unique identifier for this event. Required for conversions using multiple data sources.

event_timestamp

Timestamp

Required. The time the event occurred.

last_updated_timestamp

Timestamp

Optional. The last time the event was updated.

user_data

UserData

Optional. Pieces of user provided data, representing the user the event is associated with.

consent

Consent

Optional. Information about whether the associated user has provided different types of consent.

ad_identifiers

AdIdentifiers

Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).

currency

string

Optional. The currency code associated with all monetary values within this event.

conversion_value

double

Optional. The conversion value associated with the event, for value-based conversions.

event_source

EventSource

Optional. Signal for where the event happened (web, app, in-store, etc.).

event_device_info

DeviceInfo

Optional. Information gathered about the device being used (if any) when the event happened.

cart_data

CartData

Optional. Information about the transaction and items associated with the event.

custom_variables[]

CustomVariable

Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).

experimental_fields[]

ExperimentalField

Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.

user_properties

UserProperties

Optional. Advertiser-assessed information about the user at the time that the event happened.

منبع رویداد

The source of the event.

انوم‌ها
EVENT_SOURCE_UNSPECIFIED Unspecified EventSource. Should never be used.
WEB The event was generated from a web browser.
APP The event was generated from an app.
IN_STORE The event was generated from an in-store transaction.
PHONE The event was generated from a phone call.
OTHER The event was generated from other sources.

ExperimentalField

Experimental field representing unofficial fields.

فیلدها
field

string

Optional. The name of the field to use.

value

string

Optional. The value the field to set.

GcpWrappedKeyInfo

Information about the Google Cloud Platform wrapped key.

فیلدها
key_type

KeyType

Required. The type of algorithm used to encrypt the data.

wip_provider

string

Required. The Workload Identity pool provider required to use KEK.

kek_uri

string

Required. Google Cloud Platform Cloud Key Management Service resource ID . Should be in the format of "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}".

encrypted_dek

string

Required. The base64 encoded encrypted data encryption key.

KeyType

The type of algorithm used to encrypt the data.

انوم‌ها
KEY_TYPE_UNSPECIFIED Unspecified key type. Should never be used.
XCHACHA20_POLY1305 Algorithm XChaCha20-Poly1305

IngestAudienceMembersRequest

Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse .

You can try this method in the REST APIs explorer:
Try it with REST
فیلدها
destinations[]

Destination

Required. The list of destinations to send the audience members to.

audience_members[]

AudienceMember

Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.

consent

Consent

Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember .

validate_only

bool

Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.

encoding

Encoding

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.

encryption_info

EncryptionInfo

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

terms_of_service

TermsOfService

Optional. The terms of service that the user has accepted/rejected.

IngestAudienceMembersResponse

Response from the IngestAudienceMembersRequest .

فیلدها
request_id

string

The auto-generated ID of the request.

IngestEventsRequest

Request to upload audience members to the provided destinations. Returns an IngestEventsResponse .

You can try this method in the REST APIs explorer:
Try it with REST
فیلدها
destinations[]

Destination

Required. The list of destinations to send the events to.

events[]

Event

Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.

consent

Consent

Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event .

validate_only

bool

Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.

encoding

Encoding

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.

encryption_info

EncryptionInfo

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

IngestEventsResponse

Response from the IngestEventsRequest .

فیلدها
request_id

string

The auto-generated ID of the request.

مورد

Represents an item in the cart associated with the event.

فیلدها
merchant_product_id

string

Optional. The product ID within the Merchant Center account.

quantity

int64

Optional. The number of this item associated with the event.

unit_price

double

Optional. The unit price excluding tax, shipping, and any transaction level discounts.

MatchRateRange

The match rate range of the upload or userlist.

انوم‌ها
MATCH_RATE_RANGE_UNKNOWN The match rate range is unknown.
MATCH_RATE_RANGE_NOT_ELIGIBLE The match rate range is not eligible.
MATCH_RATE_RANGE_LESS_THAN_20 The match rate range is less than 20% (in the interval [0, 20) ).
MATCH_RATE_RANGE_20_TO_30 The match rate range is between 20% and 30% (in the interval [20, 31) ).
MATCH_RATE_RANGE_31_TO_40 The match rate range is between 31% and 40% (in the interval [31, 41) ).
MATCH_RATE_RANGE_41_TO_50 The match rate range is between 41% and 50% (in the interval [41, 51) ).
MATCH_RATE_RANGE_51_TO_60 The match rate range is between 51% and 60% (in the interval [51, 61) .
MATCH_RATE_RANGE_61_TO_70 The match rate range is between 61% and 70% (in the interval [61, 71) ).
MATCH_RATE_RANGE_71_TO_80 The match rate range is between 71% and 80% (in the interval [71, 81) ).
MATCH_RATE_RANGE_81_TO_90 The match rate range is between 81% and 90% (in the interval [81, 91) ).
MATCH_RATE_RANGE_91_TO_100

The match rate range is between 91% and 100% (in the interval [91, 100] ).

MobileData

Mobile IDs for the audience. At least one mobile ID is required.

فیلدها
mobile_ids[]

string

Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 mobileIds can be provided in a single AudienceMember .

PairData

PAIR IDs for the audience. At least one PAIR ID is required.

فیلدها
pair_ids[]

string

Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the PAIR user list. At most 10 pairIds can be provided in a single AudienceMember .

ProcessingErrorReason

The processing error reason.

انوم‌ها
PROCESSING_ERROR_REASON_UNSPECIFIED The processing error reason is unknown.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE The custom variable is invalid.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED The status of the custom variable is not enabled.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD The conversion is older than max supported age.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID A conversion with the same GCLID and conversion time already exists in the system.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID A conversion with the same order id and conversion action combination was already uploaded.
PROCESSING_ERROR_REASON_INVALID_GBRAID The gbraid could not be decoded.
PROCESSING_ERROR_REASON_INVALID_GCLID The google click ID could not be decoded.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID Merchant id contains non-digit characters.
PROCESSING_ERROR_REASON_INVALID_WBRAID The wbraid could not be decoded.
PROCESSING_ERROR_REASON_INTERNAL_ERROR خطای داخلی.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Enhanced conversions terms are not signed in the destination account.
PROCESSING_ERROR_REASON_INVALID_EVENT The event is invalid.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS The matched transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS The transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INVALID_FORMAT The event has format error.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR The event has a decryption error.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR The DEK failed to be decrypted.
PROCESSING_ERROR_REASON_INVALID_WIP The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_ERROR_REASON_INVALID_KEK The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED The system did not have the permissions needed to access the KEK.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Failed to decrypt the UserIdentifier data using the DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.

ProcessingWarningReason

The processing warning reason.

انوم‌ها
PROCESSING_WARNING_REASON_UNSPECIFIED The processing warning reason is unknown.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED The system did not have the permissions needed to access the KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR The DEK failed to be decrypted.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR The event has a decryption error.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_WARNING_REASON_INVALID_WIP The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_WARNING_REASON_INVALID_KEK The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Failed to decrypt th UserIdentifier data using the DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR خطای داخلی.

محصول

Deprecated. Use AccountType instead. Represents a specific Google product.

انوم‌ها
PRODUCT_UNSPECIFIED Unspecified product. Should never be used.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER Display & Video 360 advertiser.
DATA_PARTNER Data Partner.

ProductAccount

Represents a specific account.

فیلدها
product
(deprecated)

Product

Deprecated. Use account_type instead.

account_id

string

Required. The ID of the account. For example, your Google Ads account ID.

account_type

AccountType

Optional. The type of the account. For example, GOOGLE_ADS . Either account_type or the deprecated product is required. If both are set, the values must match.

نوع حساب

Represents Google account types. Used to locate accounts and destinations.

انوم‌ها
ACCOUNT_TYPE_UNSPECIFIED Unspecified product. Should never be used.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER Display & Video 360 advertiser.
DATA_PARTNER Data Partner.

RemoveAudienceMembersRequest

Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse .

You can try this method in the REST APIs explorer:
Try it with REST
فیلدها
destinations[]

Destination

Required. The list of destinations to remove the users from.

audience_members[]

AudienceMember

Required. The list of users to remove.

validate_only

bool

Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.

encoding

Encoding

Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non UserData uploads, this field is ignored.

encryption_info

EncryptionInfo

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

RemoveAudienceMembersResponse

Response from the RemoveAudienceMembersRequest .

فیلدها
request_id

string

The auto-generated ID of the request.

RequestStatusPerDestination

A request status per destination.

فیلدها
destination

Destination

A destination within a DM API request.

request_status

RequestStatus

The request status of the destination.

error_info

ErrorInfo

An error info error containing the error reason and error counts related to the upload.

warning_info

WarningInfo

A warning info containing the warning reason and warning counts related to the upload.

Union field status . The status of the destination. status can be only one of the following:
audience_members_ingestion_status

IngestAudienceMembersStatus

The status of the ingest audience members request.

events_ingestion_status

IngestEventsStatus

The status of the ingest events request.

audience_members_removal_status

RemoveAudienceMembersStatus

The status of the remove audience members request.

IngestAudienceMembersStatus

The status of the ingest audience members request.

فیلدها
Union field status . The status of the audience members ingestion to the destination. status can be only one of the following:
user_data_ingestion_status

IngestUserDataStatus

The status of the user data ingestion to the destination.

mobile_data_ingestion_status

IngestMobileDataStatus

The status of the mobile data ingestion to the destination.

pair_data_ingestion_status

IngestPairDataStatus

The status of the pair data ingestion to the destination.

IngestEventsStatus

The status of the events ingestion to the destination.

فیلدها
record_count

int64

The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not.

IngestMobileDataStatus

The status of the mobile data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count

int64

The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.

mobile_id_count

int64

The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not.

IngestPairDataStatus

The status of the pair data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count

int64

The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.

pair_id_count

int64

The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not.

IngestUserDataStatus

The status of the user data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count

int64

The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.

user_identifier_count

int64

The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not.

upload_match_rate_range

MatchRateRange

The match rate range of the upload.

RemoveAudienceMembersStatus

The status of the remove audience members request.

فیلدها
Union field status . The status of the audience members removal from the destination. status can be only one of the following:
user_data_removal_status

RemoveUserDataStatus

The status of the user data removal from the destination.

mobile_data_removal_status

RemoveMobileDataStatus

The status of the mobile data removal from the destination.

pair_data_removal_status

RemovePairDataStatus

The status of the pair data removal from the destination.

RemoveMobileDataStatus

The status of the mobile data removal from the destination.

فیلدها
record_count

int64

The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.

mobile_id_count

int64

The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not.

RemovePairDataStatus

The status of the pair data removal from the destination.

فیلدها
record_count

int64

The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.

pair_id_count

int64

The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not.

RemoveUserDataStatus

The status of the user data removal from the destination.

فیلدها
record_count

int64

The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.

user_identifier_count

int64

The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not.

RequestStatus

The request status.

انوم‌ها
REQUEST_STATUS_UNKNOWN The request status is unknown.
SUCCESS The request succeeded.
PROCESSING The request is processing.
FAILED درخواست با شکست مواجه شد.
PARTIAL_SUCCESS The request partially succeeded.

RetrieveRequestStatusRequest

Request to get the status of request made to the DM API for a given request ID. Returns a RetrieveRequestStatusResponse .

You can try this method in the REST APIs explorer:
Try it with REST
فیلدها
request_id

string

Required. Required. The request ID of the Data Manager API request.

RetrieveRequestStatusResponse

Response from the RetrieveRequestStatusRequest .

فیلدها
request_status_per_destination[]

RequestStatusPerDestination

A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.

شرایط خدمات

The terms of service that the user has accepted/rejected.

فیلدها
customer_match_terms_of_service_status

TermsOfServiceStatus

Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717 . This must be accepted when ingesting UserData or MobileData . This field is not required for Partner Match User list.

TermsOfServiceStatus

Represents the caller's decision to accept or reject the terms of service.

انوم‌ها
TERMS_OF_SERVICE_STATUS_UNSPECIFIED مشخص نشده است.
ACCEPTED Status indicating the caller has chosen to accept the terms of service.
REJECTED Status indicating the caller has chosen to reject the terms of service.

UserData

Data that identifies the user. At least one identifier is required.

فیلدها
user_identifiers[]

UserIdentifier

Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 userIdentifiers can be provided in a single AudienceMember or Event .

UserIdentifier

A single identifier for the user.

فیلدها
Union field identifier . Exactly one must be specified. identifier can be only one of the following:
email_address

string

Hashed email address using SHA-256 hash function after normalization.

phone_number

string

Hashed phone number using SHA-256 hash function after normalization (E164 standard).

address

AddressInfo

The known components of a user's address. Holds a grouping of identifiers that are matched all at once.

UserProperties

Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.

فیلدها
customer_type

CustomerType

Optional. Type of the customer associated with the event.

customer_value_bucket

CustomerValueBucket

Optional. The advertiser-assessed value of the customer.

WarningCount

The warning count for a given warning reason.

فیلدها
record_count

int64

The count of records that have a warning.

reason

ProcessingWarningReason

The warning reason.

WarningInfo

Warning counts for each type of warning.

فیلدها
warning_counts[]

WarningCount

A list of warnings and counts per warning reason.