Package google.ads.datamanager.v1

شاخص

IngestionService

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

IngestAudienceMembers

rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse )

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

محدوده مجوز

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

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

rpc IngestEvents( IngestEventsRequest ) returns ( IngestEventsResponse )

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

محدوده مجوز

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

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

rpc RemoveAudienceMembers( RemoveAudienceMembersRequest ) returns ( RemoveAudienceMembersResponse )

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

محدوده مجوز

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

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

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

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

فیلدها
session_attributes

string

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

gclid

string

اختیاری. شناسه کلیک Google (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

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

postal_code

string

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

عضو مخاطب

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

فیلدها
consent

Consent

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

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

UserData

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

pair_data

PairData

شناسه‌های تطبیق هویت آگهی‌دهنده ناشر (PAIR) .

mobile_data

MobileData

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

CartData

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

فیلدها
merchant_id

string

اختیاری. شناسه Merchant Center مرتبط با موارد.

merchant_feed_label

string

اختیاری. برچسب فید Merchant Center مرتبط با فید موارد.

merchant_feed_language_code

string

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

transaction_discount

double

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

items[]

Item

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

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

فیلدها
ad_user_data

ConsentStatus

اختیاری. در صورتی که کاربر با داده های کاربر آگهی موافقت کند نشان می دهد.

ad_personalization

ConsentStatus

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

وضعیت رضایت

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

Enums
CONSENT_STATUS_UNSPECIFIED مشخص نشده است.
CONSENT_GRANTED داده شده است.
CONSENT_DENIED تکذیب شد.

CustomVariable

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

فیلدها
variable

string

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

value

string

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

destination_references[]

string

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

نوع مشتری

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

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

CustomerValueBucket

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

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

مقصد

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

فیلدها
reference

string

اختیاری. شناسه این منبع Destination ، منحصر به فرد در درخواست. برای ارجاع به این Destination در IngestEventsRequest استفاده کنید.

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

مورد نیاز. شیء موجود در حساب محصول برای ورود به آن. به عنوان مثال، شناسه مخاطب Google Ads یا شناسه مخاطب Display & Video 360.

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

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

فیلدها
user_agent

string

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

ip_address

string

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

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

رمزگذاری

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

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

EncryptionInfo

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

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

GcpWrappedKeyInfo

Google Cloud Platform اطلاعات کلیدی را جمع آوری کرده است.

رویداد

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

فیلدها
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

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

منبع رویداد

منبع رویداد.

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

میدان تجربی

میدان تجربی نشان دهنده زمینه های غیر رسمی.

فیلدها
field

string

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

value

string

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

GcpWrappedKeyInfo

اطلاعاتی درباره کلید پیچیده Google Cloud Platform.

فیلدها
key_type

KeyType

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

wip_provider

string

مورد نیاز. ارائه‌دهنده مجموعه شناسایی حجم کار برای استفاده از KEK الزامی است.

kek_uri

string

مورد نیاز. شناسه منبع سرویس مدیریت کلید ابری پلتفرم Google Cloud .

encrypted_dek

string

مورد نیاز. کلید رمزگذاری داده های رمزگذاری شده base64.

نوع کلید

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

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

IngestAudienceMembersRequest

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

فیلدها
destinations[]

Destination

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

audience_members[]

AudienceMember

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

consent

Consent

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

validate_only

bool

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

encoding

Encoding

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

encryption_info

EncryptionInfo

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

terms_of_service

TermsOfService

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

IngestAudienceMembersResponse

پاسخ از IngestAudienceMembersRequest .

فیلدها
request_id

string

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

IngestEventsRequest

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

فیلدها
destinations[]

Destination

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

events[]

Event

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

consent

Consent

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

validate_only

bool

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

encoding

Encoding

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

encryption_info

EncryptionInfo

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

IngestEventsResponse

پاسخ از IngestEventsRequest .

فیلدها
request_id

string

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

مورد

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

فیلدها
merchant_product_id

string

اختیاری. شناسه محصول در حساب Merchant Center.

quantity

int64

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

unit_price

double

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

MobileData

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

فیلدها
mobile_ids[]

string

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

PairData

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

فیلدها
pair_ids[]

string

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

محصول

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

Enums
PRODUCT_UNSPECIFIED محصول نامشخص هرگز نباید استفاده شود.
GOOGLE_ADS تبلیغات گوگل
DISPLAY_VIDEO_PARTNER شریک Display & Video 360.
DISPLAY_VIDEO_ADVERTISER تبلیغ کننده Display & Video 360.
DATA_PARTNER شریک داده.

حساب محصول

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

فیلدها
product

Product

مورد نیاز. محصولی که حساب کاربری به آن تعلق دارد. به عنوان مثال، GOOGLE_ADS .

account_id

string

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

RemoveAudienceMembersRequest

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

فیلدها
destinations[]

Destination

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

audience_members[]

AudienceMember

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

validate_only

bool

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

encoding

Encoding

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

encryption_info

EncryptionInfo

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

RemoveAudienceMembersResponse

پاسخ از RemoveAudienceMembersRequest .

فیلدها
request_id

string

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

TermsOfService

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

فیلدها
customer_match_terms_of_service_status

TermsOfServiceStatus

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

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

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

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

UserData

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

فیلدها
user_identifiers[]

UserIdentifier

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

UserIdentifier

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

فیلدها
identifier فیلد اتحادیه دقیقا یکی باید مشخص شود. 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

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