شاخص
-
IngestionService
(رابط) -
AdIdentifiers
(پیام) -
AddressInfo
(پیام) -
AudienceMember
(پیام) -
CartData
(پیام) -
Consent
(پیام) -
ConsentStatus
(تعدادی) -
CustomVariable
(پیام) -
CustomerType
(تعدادی) -
CustomerValueBucket
(تعدادی) -
Destination
(پیام) -
DeviceInfo
(پیام) -
Encoding
(enum) -
EncryptionInfo
(پیام) -
Event
(پیام) -
EventSource
(enum) -
ExperimentalField
(پیام) -
GcpWrappedKeyInfo
(پیام) -
GcpWrappedKeyInfo.KeyType
(enum) -
IngestAudienceMembersRequest
(پیام) -
IngestAudienceMembersResponse
(پیام) -
IngestEventsRequest
(پیام) -
IngestEventsResponse
(پیام) -
Item
(پیام) -
MobileData
(پیام) -
PairData
(پیام) -
Product
(تعدادی) -
ProductAccount
(پیام) -
RemoveAudienceMembersRequest
(پیام) -
RemoveAudienceMembersResponse
(پیام) -
TermsOfService
(پیام) -
TermsOfServiceStatus
(enum) -
UserData
(پیام) -
UserIdentifier
(پیام) -
UserProperties
(پیام)
IngestionService
سرویس ارسال اطلاعات مخاطبان به مقاصد پشتیبانی شده.
IngestAudienceMembers |
---|
فهرستی از منابع
|
IngestEvents |
---|
فهرستی از منابع
|
RemoveAudienceMembers |
---|
فهرستی از منابع
|
شناسه های تبلیغاتی
شناسه ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت های آنلاین (مانند کلیک های تبلیغاتی).
فیلدها | |
---|---|
session_attributes | اختیاری. ویژگیهای جلسه برای اسناد و مدلسازی رویداد. |
gclid | اختیاری. شناسه کلیک Google (gclid) مرتبط با این رویداد. |
gbraid | اختیاری. شناسه کلیک برای کلیکهای مرتبط با رویدادهای برنامه و از دستگاههای iOS که با iOS14 شروع میشوند. |
wbraid | اختیاری. شناسه کلیک برای کلیکهای مرتبط با رویدادهای وب و از دستگاههای iOS که با iOS14 شروع میشوند. |
landing_page_device_info | اختیاری. اطلاعات جمعآوریشده درباره دستگاه مورد استفاده (در صورت وجود) در زمان ورود به سایت آگهیدهنده پس از تعامل با آگهی. |
آدرس اطلاعات
اطلاعات آدرس برای کاربر
فیلدها | |
---|---|
given_name | مورد نیاز. نام کاربر (اول) داده شده، تماماً با حروف کوچک، بدون علامت نقطه گذاری، بدون فضای خالی اصلی یا انتهایی، و به عنوان SHA-256 هش شده است. |
family_name | مورد نیاز. نام خانوادگی (فامیل) کاربر، تماماً با حروف کوچک، بدون علامت نقطه گذاری، بدون فضای خالی اصلی یا انتهایی و هش شده به عنوان SHA-256. |
region_code | مورد نیاز. کد منطقه 2 حرفی در ISO-3166-1 آلفا-2 آدرس کاربر. |
postal_code | مورد نیاز. کد پستی آدرس کاربر. |
عضو مخاطب
مخاطبی که باید عمل شود.
فیلدها | |
---|---|
consent | اختیاری. تنظیم رضایت برای کاربر |
data میدان اتحادیه نوع داده های شناسایی که باید روی آنها عمل شود. data فقط می توانند یکی از موارد زیر باشند: | |
user_data | داده های ارائه شده توسط کاربر که کاربر را شناسایی می کند. |
pair_data | |
mobile_data | داده هایی که دستگاه های تلفن همراه کاربر را شناسایی می کند. |
CartData
دادههای سبد خرید مرتبط با رویداد.
فیلدها | |
---|---|
merchant_id | اختیاری. شناسه Merchant Center مرتبط با موارد. |
merchant_feed_label | اختیاری. برچسب فید Merchant Center مرتبط با فید موارد. |
merchant_feed_language_code | اختیاری. کد زبان در ISO 639-1 مرتبط با فید Merchant Center اقلام. جایی که موارد شما آپلود می شوند. |
transaction_discount | اختیاری. مجموع کلیه تخفیف های مرتبط با معامله. |
items[] | اختیاری. لیست موارد مرتبط با رویداد. |
رضایت
تنظیمات رضایت کاربر قانون بازارهای دیجیتال (DMA) .
فیلدها | |
---|---|
ad_user_data | اختیاری. در صورتی که کاربر با داده های کاربر آگهی موافقت کند نشان می دهد. |
ad_personalization | اختیاری. در صورتی که کاربر به شخصی سازی آگهی رضایت دهد نشان می دهد. |
وضعیت رضایت
در صورتی که کاربر رضایت خود را اعطا کرده، رد کرده یا مشخص نکرده باشد، نشان می دهد.
Enums | |
---|---|
CONSENT_STATUS_UNSPECIFIED | مشخص نشده است. |
CONSENT_GRANTED | داده شده است. |
CONSENT_DENIED | تکذیب شد. |
CustomVariable
متغیر سفارشی برای تبدیل تبلیغات.
فیلدها | |
---|---|
variable | اختیاری. نام متغیر سفارشی برای تنظیم. اگر متغیر برای مقصد مورد نظر پیدا نشود، نادیده گرفته می شود. |
value | اختیاری. مقدار ذخیره شده برای متغیر سفارشی. |
destination_references[] | اختیاری. رشته مرجع برای تعیین اینکه متغیر سفارشی باید به کدام یک از |
نوع مشتری
نوع مشتری مرتبط با رویداد.
Enums | |
---|---|
CUSTOMER_TYPE_UNSPECIFIED | نوع مشتری نامشخص هرگز نباید استفاده شود. |
NEW | مشتری تازه وارد تبلیغ کننده است. |
RETURNING | مشتری به سمت تبلیغ کننده باز می گردد. |
REENGAGED | مشتری دوباره با تبلیغ کننده ارتباط برقرار کرده است. |
CustomerValueBucket
ارزش مشتری توسط تبلیغ کننده.
Enums | |
---|---|
CUSTOMER_VALUE_BUCKET_UNSPECIFIED | CustomerValueBucket نامشخص. هرگز نباید استفاده شود. |
LOW | مشتری کم ارزش است. |
MEDIUM | مشتری ارزش متوسطی دارد. |
HIGH | مشتری ارزش بالایی دارد. |
مقصد
محصول Google که دادهها را به آن ارسال میکنید. به عنوان مثال، یک حساب Google Ads.
فیلدها | |
---|---|
reference | اختیاری. شناسه این منبع |
login_account | اختیاری. حساب مورد استفاده برای برقراری این تماس API. برای افزودن یا حذف دادهها از |
linked_account | اختیاری. حسابی که |
operating_account | مورد نیاز. حسابی برای ارسال داده ها یا حذف داده ها از آن. |
product_destination_id | مورد نیاز. شیء موجود در حساب محصول برای ورود به آن. به عنوان مثال، شناسه مخاطب Google Ads یا شناسه مخاطب Display & Video 360. |
اطلاعات دستگاه
اطلاعات مربوط به دستگاه مورد استفاده (در صورت وجود) هنگام وقوع رویداد.
فیلدها | |
---|---|
user_agent | اختیاری. رشته عامل کاربر دستگاه برای زمینه داده شده. |
ip_address | اختیاری. آدرس IP دستگاه برای زمینه داده شده. توجه: Google Ads از تطبیق آدرس IP برای کاربران نهایی در منطقه اقتصادی اروپا (EEA)، بریتانیا (بریتانیا)، یا سوئیس (CH) پشتیبانی نمیکند. منطقی را برای حذف مشروط نشانیهای IP از کاربران این مناطق اضافه کنید و اطمینان حاصل کنید که اطلاعات واضح و جامعی را درباره دادههایی که در سایتها، برنامهها و سایر داراییهای خود جمعآوری میکنید در اختیار کاربران قرار میدهید و در مواردی که طبق قانون یا هر خطمشیهای قابلاجرای Google لازم است رضایت دریافت کنید. برای جزئیات بیشتر به صفحه درباره واردات تبدیل آفلاین مراجعه کنید. |
رمزگذاری
نوع رمزگذاری اطلاعات شناسایی هش شده.
Enums | |
---|---|
ENCODING_UNSPECIFIED | نوع رمزگذاری نامشخص هرگز نباید استفاده شود. |
HEX | رمزگذاری هگز. |
BASE64 | کدگذاری پایه 64 |
EncryptionInfo
اطلاعات رمزگذاری برای داده های در حال مصرف.
فیلدها | |
---|---|
فیلد اتحادیه wrapped_key . کلید پیچیده ای که برای رمزگذاری داده ها استفاده می شود. wrapped_key فقط می تواند یکی از موارد زیر باشد: | |
gcp_wrapped_key_info | Google Cloud Platform اطلاعات کلیدی را جمع آوری کرده است. |
رویداد
رویدادی که نشاندهنده تعامل کاربر با وبسایت یا برنامه تبلیغکننده است.
فیلدها | |
---|---|
destination_references[] | اختیاری. رشته مرجع برای تعیین مقصد استفاده می شود. در صورت خالی بودن، رویداد به تمام |
transaction_id | مورد نیاز. شناسه منحصر به فرد این رویداد. |
event_timestamp | مورد نیاز. زمانی که واقعه رخ داد. |
last_updated_timestamp | اختیاری. آخرین باری که رویداد به روز شد. |
user_data | اختیاری. قطعاتی از داده های ارائه شده توسط کاربر، نشان دهنده کاربری است که رویداد با آن مرتبط است. |
consent | اختیاری. اطلاعاتی در مورد اینکه آیا کاربر مرتبط انواع مختلفی از رضایت را ارائه کرده است یا خیر. |
ad_identifiers | اختیاری. شناسه ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت های آنلاین (مانند کلیک های تبلیغاتی). |
currency | اختیاری. کد ارز مرتبط با تمام مقادیر پولی در این رویداد. |
conversion_value | اختیاری. ارزش تبدیل مرتبط با رویداد، برای تبدیلهای مبتنی بر ارزش. |
event_source | اختیاری. سیگنال محل وقوع رویداد (وب، برنامه، فروشگاه و غیره). |
event_device_info | اختیاری. اطلاعات جمع آوری شده در مورد دستگاه مورد استفاده (در صورت وجود) هنگام وقوع رویداد. |
cart_data | اختیاری. اطلاعات مربوط به تراکنش و موارد مرتبط با رویداد. |
custom_variables[] | اختیاری. اطلاعات اضافی جفت کلید/مقدار برای ارسال به کانتینرهای تبدیل (عمل تبدیل یا فعالیت FL). |
experimental_fields[] | اختیاری. فهرستی از جفتهای کلید/مقدار برای فیلدهای آزمایشی که ممکن است در نهایت به عنوان بخشی از API تبلیغ شوند. |
user_properties | اختیاری. اطلاعات ارزیابی شده توسط تبلیغ کننده در مورد کاربر در زمان وقوع رویداد. |
منبع رویداد
منبع رویداد.
Enums | |
---|---|
EVENT_SOURCE_UNSPECIFIED | منبع رویداد نامشخص هرگز نباید استفاده شود. |
WEB | این رویداد از یک مرورگر وب ایجاد شد. |
APP | این رویداد از یک برنامه ایجاد شده است. |
IN_STORE | این رویداد از یک معامله در فروشگاه ایجاد شد. |
PHONE | این رویداد از یک تماس تلفنی ایجاد شد. |
OTHER | این رویداد از منابع دیگر تولید شده است. |
میدان تجربی
میدان تجربی نشان دهنده زمینه های غیر رسمی.
فیلدها | |
---|---|
field | اختیاری. نام فیلد مورد استفاده |
value | اختیاری. مقدار فیلدی که باید تنظیم شود. |
GcpWrappedKeyInfo
اطلاعاتی درباره کلید پیچیده Google Cloud Platform.
فیلدها | |
---|---|
key_type | مورد نیاز. نوع الگوریتم مورد استفاده برای رمزگذاری داده ها. |
wip_provider | مورد نیاز. ارائهدهنده مجموعه شناسایی حجم کار برای استفاده از KEK الزامی است. |
kek_uri | مورد نیاز. شناسه منبع سرویس مدیریت کلید ابری پلتفرم Google Cloud . |
encrypted_dek | مورد نیاز. کلید رمزگذاری داده های رمزگذاری شده base64. |
نوع کلید
نوع الگوریتم مورد استفاده برای رمزگذاری داده ها.
Enums | |
---|---|
KEY_TYPE_UNSPECIFIED | نوع کلید نامشخص هرگز نباید استفاده شود. |
XCHACHA20_POLY1305 | الگوریتم XChaCha20-Poly1305 |
IngestAudienceMembersRequest
درخواست آپلود اعضای مخاطب در مقاصد ارائه شده. یک IngestAudienceMembersResponse
را برمیگرداند.
فیلدها | |
---|---|
destinations[] | مورد نیاز. لیست مقاصدی که باید مخاطبان را به آنها بفرستید. |
audience_members[] | مورد نیاز. لیست کاربران برای ارسال به مقاصد مشخص شده. حداکثر 10000 منبع |
consent | اختیاری. درخواست رضایت در سطح درخواست برای اعمال همه کاربران در درخواست. رضایت در سطح کاربر بر رضایت سطح درخواست لغو می شود و می تواند در هر |
validate_only | اختیاری. برای اهداف آزمایشی اگر |
encoding | اختیاری. برای آپلود |
encryption_info | اختیاری. اطلاعات رمزگذاری برای آپلود |
terms_of_service | اختیاری. شرایط خدماتی که کاربر پذیرفته/رد کرده است. |
IngestAudienceMembersResponse
پاسخ از IngestAudienceMembersRequest
.
فیلدها | |
---|---|
request_id | شناسه درخواستی که به صورت خودکار ایجاد شده است. |
IngestEventsRequest
درخواست آپلود اعضای مخاطب در مقاصد ارائه شده. یک IngestEventsResponse
را برمیگرداند.
فیلدها | |
---|---|
destinations[] | مورد نیاز. لیست مقصدهایی که رویدادها را به آنها ارسال کنید. |
events[] | مورد نیاز. لیست رویدادها برای ارسال به مقصدهای مشخص شده. حداکثر 2000 منبع |
consent | اختیاری. درخواست رضایت در سطح درخواست برای اعمال همه کاربران در درخواست. رضایت در سطح کاربر بر رضایت سطح درخواست لغو می شود و می توان آن را در هر |
validate_only | اختیاری. برای اهداف آزمایشی اگر |
encoding | اختیاری. برای آپلود |
encryption_info | اختیاری. اطلاعات رمزگذاری برای آپلود |
IngestEventsResponse
پاسخ از IngestEventsRequest
.
فیلدها | |
---|---|
request_id | شناسه درخواستی که به صورت خودکار ایجاد شده است. |
مورد
نشان دهنده یک مورد در سبد خرید مرتبط با رویداد است.
فیلدها | |
---|---|
merchant_product_id | اختیاری. شناسه محصول در حساب Merchant Center. |
quantity | اختیاری. تعداد این مورد مرتبط با رویداد. |
unit_price | اختیاری. قیمت واحد بدون احتساب مالیات، حمل و نقل و هر گونه تخفیف در سطح تراکنش. |
MobileData
شناسه موبایل برای مخاطبان حداقل یک شناسه موبایل مورد نیاز است.
فیلدها | |
---|---|
mobile_ids[] | مورد نیاز. لیست شناسه های دستگاه تلفن همراه (شناسه تبلیغاتی/IDFA). حداکثر 10 |
PairData
جفت شناسه برای مخاطب. حداقل یک شناسه جفت مورد نیاز است.
فیلدها | |
---|---|
pair_ids[] | مورد نیاز. دادههای PII ارائهشده توسط اتاق تمیز، هششده با SHA256، و رمزگذاری شده با رمز جابجایی EC با استفاده از کلید ناشر برای فهرست کاربران PAIR . حداکثر 10 |
محصول
نشان دهنده یک محصول خاص گوگل است. برای مکان یابی حساب ها و مقاصد استفاده می شود.
Enums | |
---|---|
PRODUCT_UNSPECIFIED | محصول نامشخص هرگز نباید استفاده شود. |
GOOGLE_ADS | تبلیغات گوگل |
DISPLAY_VIDEO_PARTNER | شریک Display & Video 360. |
DISPLAY_VIDEO_ADVERTISER | تبلیغ کننده Display & Video 360. |
DATA_PARTNER | شریک داده. |
حساب محصول
یک حساب کاربری خاص را نشان می دهد.
فیلدها | |
---|---|
product | مورد نیاز. محصولی که حساب کاربری به آن تعلق دارد. به عنوان مثال، |
account_id | مورد نیاز. شناسه حساب به عنوان مثال، شناسه حساب Google Ads شما. |
RemoveAudienceMembersRequest
درخواست حذف کاربران از مخاطبان در مقاصد ارائه شده. RemoveAudienceMembersResponse
را برمی گرداند.
فیلدها | |
---|---|
destinations[] | مورد نیاز. لیست مقاصدی که کاربران را از آنها حذف کنید. |
audience_members[] | مورد نیاز. لیست کاربرانی که باید حذف شوند. |
validate_only | اختیاری. برای اهداف آزمایشی اگر |
encoding | اختیاری. برای آپلود |
encryption_info | اختیاری. اطلاعات رمزگذاری برای آپلود |
RemoveAudienceMembersResponse
پاسخ از RemoveAudienceMembersRequest
.
فیلدها | |
---|---|
request_id | شناسه درخواستی که به صورت خودکار ایجاد شده است. |
TermsOfService
شرایط خدماتی که کاربر پذیرفته/رد کرده است.
فیلدها | |
---|---|
customer_match_terms_of_service_status | اختیاری. شرایط خدمات مطابقت مشتری: https://support.google.com/adspolicy/answer/6299717 . این باید برای همه بارگذاریها در فهرستهای کاربری مطابقت مشتری پذیرفته شود. |
وضعیت شرایط خدمات
نشان دهنده تصمیم تماس گیرنده برای پذیرش یا رد شرایط خدمات است.
Enums | |
---|---|
TERMS_OF_SERVICE_STATUS_UNSPECIFIED | مشخص نشده است. |
ACCEPTED | وضعیتی که نشان میدهد تماسگیرنده شرایط خدمات را قبول کرده است. |
REJECTED | وضعیتی که نشان میدهد تماسگیرنده شرایط خدمات را رد کرده است. |
UserData
داده هایی که کاربر را شناسایی می کند. حداقل یک شناسه مورد نیاز است.
فیلدها | |
---|---|
user_identifiers[] | مورد نیاز. شناسه های کاربر امکان ارائه چندین نمونه از یک نوع داده (مثلاً چندین آدرس ایمیل) وجود دارد. برای افزایش احتمال تطابق، تا حد امکان شناسه های بیشتری ارائه دهید. حداکثر 10 |
UserIdentifier
یک شناسه واحد برای کاربر.
فیلدها | |
---|---|
identifier فیلد اتحادیه دقیقا یکی باید مشخص شود. identifier می تواند تنها یکی از موارد زیر باشد: | |
email_address | آدرس ایمیل هش شده با استفاده از تابع هش SHA-256 پس از عادی سازی. |
phone_number | شماره تلفن هش شده با استفاده از عملکرد هش SHA-256 پس از عادی سازی (استاندارد E164). |
address | اجزای شناخته شده آدرس کاربر. گروهی از شناسهها را نگه میدارد که به یکباره مطابقت دارند. |
ویژگی های کاربر
اطلاعات ارزیابی شده توسط تبلیغ کننده در مورد کاربر در زمان وقوع رویداد. برای جزئیات بیشتر به https://support.google.com/google-ads/answer/14007601 مراجعه کنید.
فیلدها | |
---|---|
customer_type | اختیاری. نوع مشتری مرتبط با رویداد. |
customer_value_bucket | اختیاری. ارزش مشتری توسط تبلیغ کننده. |