Package google.ads.datamanager.v1

string

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

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

EventType

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

Timestamp

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

string

اختیاری. شناسه‌ای که توسط تماس‌گیرنده ایجاد و مدیریت می‌شود و به طور منحصر به فرد این رویداد را مشخص می‌کند.

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

UserData

اختیاری. چندین قطعه داده ارائه شده توسط کاربر، که نشان دهنده کاربری است که رویداد با آن مرتبط است.

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

DeviceInfo

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

string

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

string

الزامی. شناسه کمپین مرتبط.

string

الزامی. نام کمپین مرتبط.

string

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

string

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

int32

اختیاری. ارتفاع تبلیغ بر حسب پیکسل.

int32

اختیاری. عرض تبلیغ بر حسب پیکسل.

string

اختیاری. کشور به علاوه‌ی تقسیمات کشوری بر اساس استاندارد ISO 3166-2.

string

الزامی. منبع پلتفرم تبلیغ، مشابه منبع گوگل آنالیتیکس.

string

الزامی. رسانه‌ی تبلیغ، مشابه رسانه‌ی گوگل آنالیتیکس.

AttributionHint

اختیاری. وضعیت انتساب فرض‌شده توسط شریک برای این رویداد تبلیغاتی.

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

ViewabilityInfo

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

EventSubtype

مقدار شمارشی برای زیرنوع رویداد.

string

مقدار رشته‌ای برای زیرنوع رویداد.

AdType

مقدار شمارشی برای نوع تبلیغ.

string

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

AdFormat

مقدار شمارشی برای قالب تبلیغ.

string

مقدار رشته‌ای برای قالب تبلیغ.

AdPlacement

مقدار شمارشی برای قرار دادن تبلیغ.

string

مقدار رشته‌ای برای قرار دادن تبلیغ.

TargetingType

مقدار شمارشی برای نوع هدف‌گیری.

string

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

PlatformType

مقدار شمارشی برای نوع پلتفرم.

string

مقدار رشته‌ای برای نوع پلتفرم.

Platform

مقدار شمارشی برای پلتفرم.

string

مقدار رشته‌ای برای پلتفرم.

bool

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

string

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

string

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

string

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

string

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

DeviceInfo

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

string

اختیاری. شناسه موبایل برای تبلیغ‌کنندگان. این شناسه می‌تواند در iOS، IDFA، در اندروید، AdID یا شناسه‌های سایر پلتفرم‌ها برای تبلیغ‌کنندگان باشد.

string

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

string

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

string

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

EncryptedUserId

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

string

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

string

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

string

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

string

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

string

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

قبل از هش کردن، مقدار را نرمال‌سازی کنید:

• حذف کاراکترهای نماد
• تبدیل به حروف کوچک
• حذف فضای خالی ابتدا و انتهای متن

string

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

مقدار باید به این صورت نرمال‌سازی شود:

• حذف کاراکترهای نماد
• تبدیل به حروف کوچک
• حذف فضای خالی ابتدا و انتهای متن

string

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

مقدار باید به این صورت نرمال‌سازی شود:

• حذف کاراکترهای نماد
• تبدیل به حروف کوچک
• حذف فضای خالی ابتدا و انتهای متن

string

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

Consent

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

UserData

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

PairData

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

این ویژگی فقط برای شرکای داده در دسترس است.

MobileData

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

UserIdData

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

PpidData

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

این ویژگی فقط برای شرکای داده در دسترس است.

CompositeData

گروهی از چندین نوع شناسه.

GoogleUserIdData

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

PartnerProvidedIdData

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

KeyType

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

string

الزامی. نام منبع آمازون مربوط به نقش IAM که برای دسترسی به رمزگشایی KMS در نظر گرفته شده است. باید به فرمت arn:{partition}:iam::{account_id}:role/{role_name} باشد.

string

الزامی. آدرس اینترنتی (URI) کلید AWS KMS که برای رمزگشایی DEK استفاده می‌شود. باید به فرمت arn:{partition}:kms:{region}:{account_id}:key/{key_id} یا aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}

string

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

Location

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

bool

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

string

فهرست کدهای منطقه‌ای ISO 3166-1 alpha-2.

string

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

string

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

string

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

double

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

Item

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

string

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

اگر رویداد مربوط به یک مقصد گوگل آنالیتیکس است، فقط یک کد تخفیف ارائه دهید. گوگل آنالیتیکس کدهای تخفیف اضافی را نادیده می‌گیرد.

UserData

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

IpData

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

ConsentStatus

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

ConsentStatus

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

int32

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

DataSourceType

اختیاری. تغییرناپذیر. منبع داده‌های آپلود

string

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

string

الزامی. والد، که مالک این مجموعه از لینک‌های همکار است. قالب: accountTypes/{account_type}/accounts/{account}

PartnerLink

الزامی. لینک همکاری که باید ایجاد شود.

string

الزامی. حسابی که مالک فهرست کاربران دارای مجوز است. باید به فرمت accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} باشد.

UserListDirectLicense

الزامی. فهرست کاربران، مجوز مستقیم برای ایجاد.

string

الزامی. حسابی که مالک فهرست کاربران دارای مجوز است. باید به فرمت accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} باشد.

UserListGlobalLicense

الزامی. فهرست کاربران، مجوز سراسری برای ایجاد.

string

الزامی. حساب والد که این فهرست کاربران در آن ایجاد خواهد شد. قالب: accountTypes/{account_type}/accounts/{account}

UserList

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

bool

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

string

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

string

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

string

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

string

الزامی. نام منبع لینک همکار برای حذف. قالب: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

string

الزامی. نام فهرست کاربرانی که قرار است حذف شوند. قالب: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

bool

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

string

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

ProductAccount

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

ProductAccount

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

ProductAccount

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

string

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

string

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

string

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

string

اختیاری. دسته دستگاه. به عنوان مثال، "دسکتاپ"، "تبلت"، "موبایل"، "تلویزیون هوشمند".

string

اختیاری. زبانی که دستگاه با فرمت ISO 639-1 استفاده می‌کند.

int32

اختیاری. ارتفاع صفحه نمایش بر حسب پیکسل.

int32

اختیاری. عرض صفحه نمایش بر حسب پیکسل.

string

اختیاری. سیستم عامل یا پلتفرم دستگاه.

string

اختیاری. نسخه سیستم عامل یا پلتفرم.

string

اختیاری. مدل دستگاه.

string

اختیاری. نام تجاری دستگاه.

string

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

string

اختیاری. نسخه مرورگر.

string

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

EncryptionEntityType

الزامی. نوع موجودیت رمزگذاری. این باید با پیکربندی رمزگذاری برای نمایش آگهی یا انتقال داده مطابقت داشته باشد.

int64

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

EncryptionSource

الزامی. توضیح می‌دهد که آیا کوکی رمزگذاری‌شده از سرویس پخش آگهی (ماکرو %m) یا از انتقال داده دریافت شده است.

GcpWrappedKeyInfo

Google Cloud Platform wrapped key information.

AwsWrappedKeyInfo

Amazon Web Services wrapped key information.

CoordinatorKeyInfo

Key information for the chosen coordinator key.

This is not supported for the IngestEvents , IngestAudienceMembers , and RemoveAudienceMembers methods.

int64

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

ProcessingErrorReason

The error reason of the failed records.

ErrorCount

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

string

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

string

Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions.

Timestamp

Required. The time the event occurred.

Timestamp

Optional. The last time the event was updated.

UserData

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

Consent

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

AdIdentifiers

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

string

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

EventSource

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

DeviceInfo

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

CartData

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

CustomVariable

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

ExperimentalField

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

UserProperties

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

string

Optional. The name of the event. Required for GA4 events.

string

Optional. A unique identifier for the user instance of a web client for this GA4 web stream.

string

Optional. A unique identifier for a user, as defined by the advertiser.

EventParameter

Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.

UserData

Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data.

EventLocation

Optional. Information gathered about the location of the user when this event occurred.

string

Optional. A unique identifier for the user instance of an app client for this GA4 app stream.

double

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

double

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

string

Optional. Required for Store Sales. The identifier to represent a physical store where the event happened.

string

Optional. The name of the city where the event occurred.

string

Optional. The ISO 3166-2 subdivision code where the event occurred.

string

Optional. The 2-letter CLDR region code of the user's address.

string

Optional. The subcontinent code in UN M49 format where the event occurred.

string

Optional. The continent code in UN M49 format where the event occurred.

string

Required. The name of the parameter to use.

string

Required. The string representation of the value of the parameter to set.

string

Optional. The name of the field to use.

string

Optional. The value the field to set.

WarningReason

The warning reason.

string

The detailed warning message describing the issue.

string

The field path that triggered the warning. Uses the same format as google.rpc.BadRequest.FieldViolation.field .

KeyType

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

string

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

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} or gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}

string

Required. The base64 encoded encrypted data encryption key.

string

Required. The resource name of the user list direct license.

string

Required. The resource name of the user list global license.

string

Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

string

Required. The list of encrypted google user IDs.

AdEvent

Required. Required (at least 1). A list of ad events.

EncryptionInfo

Required. Information about encryption keys which are used to encrypt the data.

bool

Optional. If true, the request is validated, but not executed.

Destination

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

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

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 .

bool

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

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.

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.

TermsOfService

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

string

The auto-generated ID of the request.

FieldWarning

Detailed row-level warnings with field paths.

Destination

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

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

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 .

bool

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

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.

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.

string

The auto-generated ID of the request.

FieldWarning

Detailed row-level warnings with field paths.

UploadKeyType

Required. Immutable. Upload key types of this user list.

ContactIdInfo

Optional. Additional information when CONTACT_ID is one of the upload_key_types .

MobileIdInfo

Optional. Additional information when MOBILE_ID is one of the upload_key_types .

UserIdInfo

Optional. Additional information when USER_ID is one of the upload_key_types .

PairIdInfo

Optional. Additional information when PAIR_ID is one of the upload_key_types .

This feature is only available to data partners.

PseudonymousIdInfo

Optional. Additional information for PSEUDONYMOUS_ID is one of the upload_key_types .

PartnerAudienceInfo

Optional. Additional information for partner audiences.

This feature is only available to data partners.

string

Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.

Timestamp

Optional. First recorded interaction time from this IP address in a session.

Timestamp

Optional. Last recorded interaction time from this IP address in a session.

string

Optional. The product ID within the Merchant Center account.

int64

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

double

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

string

Optional. A unique identifier to reference the item.

ItemParameter

Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

string

Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.

string

Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.

string

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

ItemCustomVariable

Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.

double

Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.

string

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

string

Optional. The value to store for the custom variable.

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.

string

Required. The name of the parameter to use.

string

Required. The string representation of the value of the parameter to set.

string

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case.

Supported Operations:

• AND
• =
• !=
• >
• >=
• <
• <=

Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456)

Unsupported Fields:

• name (use get method instead)
• historical_pricings and all its subfields
• pricing.start_time
• pricing.end_time

int32

Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

string

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

UserListDirectLicense

The licenses for the given user list in the request.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID} . To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/- )

string

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case.

Supported Operations:

• AND
• =
• !=
• >
• >=
• <
• <=

Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456)

Unsupported Fields:

• name (use get method instead)
• historical_pricings and all its subfields
• pricing.start_time
• pricing.end_time

int32

Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

string

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

UserListGlobalLicenseCustomerInfo

The customer information for the given license in the request.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case.

Supported Operations:

• AND
• =
• !=
• >
• >=
• <
• <=

Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(user_list_id, 123, 456)

Unsupported Fields:

• name (use get method instead)
• historical_pricings and all its subfields
• pricing.start_time
• pricing.end_time

int32

Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

string

Optional. A page token, received from a previous ListUserListGlobalLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

UserListGlobalLicense

The licenses for the given user list in the request.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}

int32

Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

string

Optional. A page token, received from a previous ListUserLists call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserLists must match the call that provided the page token.

string

Optional. A filter string . All fields need to be on the left hand side of each condition (for example: display_name = "list 1" ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case.

Supported operations:

• AND
• =
• !=
• >
• >=
• <
• <=
• : (has)

Supported Functions: - IN(field, value1, value2, ...) : returns true if the field matches any of the values. Example: IN(display_name, "name1", "name2")

Supported fields:

• id
• display_name
• description
• membership_status
• integration_code
• access_reason
• ingested_user_list_info.upload_key_types

UserList

The user lists from the specified account.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The list of mobile device IDs (Android advertising ID, iOS IDFA for Customer Match user lists and Android advertising ID, iOS IDFA, Xbox or Microsoft ID, Amazon Fire TV ID, Roku ID, Generic Device ID for basic user lists). At most 10 mobileIds can be provided in a single AudienceMember .

DataSourceType

Optional. Immutable. Source of the upload data.

KeySpace

Required. Immutable. The key space of mobile IDs.

string

Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.

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 .

int64

Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.

string

Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.

int32

Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.

int64

Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.

string

Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.

PartnerAudienceSource

Required. Immutable. The source of the partner audience.

string

Optional. The commerce partner name. Only allowed if partner_audience_source is COMMERCE_AUDIENCE .

string

Required. The identifier of the customer account in the partner's ID space.

string

Optional. The name of the account.

string

Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example.

string

Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

string

Output only. The partner link ID.

ProductAccount

Required. The owning account granting access to the partner account.

ProductAccount

Required. The partner account granted access by the owning account.

FeatureSet

Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT .

PartnerCustomerAccount

Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.

PartnerLinkMetadata

Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT .

PartnerCustomerAccount

Optional. The list of implicit accounts.

string

Required. The list of partner-provided identifiers.

string

Required. The list of publisher provided identifiers for a user.

Product

Deprecated. Use account_type instead.

string

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

AccountType

Required. 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.

SyncStatus

Output only. Sync status of the user list.

int64

Optional. Immutable. The number of billable records (eg uploaded or matched).

Destination

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

Timestamp

Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future.

bool

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

string

The auto-generated ID of the request.

Destination

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

AudienceMember

Required. The list of users to remove.

bool

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

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.

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.

string

The auto-generated ID of the request.

Destination

A destination within a DM API request.

RequestStatus

The request status of the destination.

ErrorInfo

An error info error containing the error reason and error counts related to the upload. Only populated if the request_status is FAILED or PARTIAL_SUCCESS . This field isn't populated while the request has request_status of PROCESSING .

WarningInfo

A warning info containing the warning reason and warning counts related to the upload. This field isn't populated while the request has request_status of PROCESSING .

IngestAudienceMembersStatus

The status of the ingest audience members request.

IngestEventsStatus

The status of the ingest events request.

RemoveAudienceMembersStatus

The status of the remove audience members request.

RemoveAllAudienceMembersStatus

The status of the remove all audience members request.

DataType

The type of data.

int64

The count for this data type.

IngestUserDataStatus

The status of the user data ingestion to the destination.

IngestMobileDataStatus

The status of the mobile data ingestion to the destination.

IngestPairDataStatus

The status of the pair data ingestion to the destination.

IngestUserIdDataStatus

The status of the user id data ingestion to the destination.

IngestPpidDataStatus

The status of the ppid data ingestion to the destination.

IngestCompositeDataStatus

The status of the composite data ingestion to the destination.

IngestGoogleUserIdDataStatus

The status of the google user id data ingestion to the destination.

IngestPartnerProvidedIdDataStatus

The status of the partner provided id data ingestion to the destination.

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.

DataTypeCount

The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not.

MatchRateRange

The match rate range of the upload.

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.

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.

int64

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

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.

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.

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.

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.

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.

int64

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

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.

int64

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

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.

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.

MatchRateRange

The match rate range of the upload.

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.

int64

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

RemoveUserDataStatus

The status of the user data removal from the destination.

RemoveMobileDataStatus

The status of the mobile data removal from the destination.

RemovePairDataStatus

The status of the pair data removal from the destination.

RemoveUserIdDataStatus

The status of the user id data removal from the destination.

RemovePpidDataStatus

The status of the ppid data removal from the destination.

RemoveCompositeDataStatus

The status of the composite data removal from the destination.

RemoveGoogleUserIdDataStatus

The status of the google user id data removal from the destination.

RemovePartnerProvidedIdDataStatus

The status of the partner provided id data removal from the destination.

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.

DataTypeCount

The total count of data types sent in the removal request, broken down by data type. Includes all data types in the request, regardless of whether they were successfully removed or not.

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.

int64

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

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.

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.

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.

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.

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.

int64

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

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.

int64

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

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.

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.

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.

int64

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

string

Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}

Baseline

Required. Baseline for the insights requested.

string

Required. The user list ID for which insights are requested.

MarketingDataInsight

Contains the insights for the marketing data.

AudienceInsightsDimension

The dimension to which the insight belongs.

MarketingDataInsightsAttribute

Insights for values of a given dimension.

int64

The user interest ID.

float

Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].

AgeRange

Age range of the audience for which the lift is provided.

Gender

Gender of the audience for which the lift is provided.

string

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

RequestStatusPerDestination

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

string

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned.

Format: accountTypes/{account_type}/accounts/{account}

int32

The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 50 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.

string

A page token, received from a previous SearchPartnerLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.

string

Optional. A filter string . All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case.

Supported operations:

• AND
• =
• !=

Supported fields:

• partner_link_id
• owning_account.account_type
• owning_account.account_id
• partner_account.account_type
• partner_account.account_id
• feature_set

For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported:

• partner_customer_account.account_id

Example: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

PartnerLink

The partner links for the given account.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

int64

Output only. Estimated number of members in this user list, on the Google Display Network.

int64

Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.

int64

Output only. Estimated number of members in this user list on YouTube.

int64

Output only. Estimated number of members in this user list on Gmail.

bool

Output only. Indicates this user list is eligible for Google Display Network.

bool

Optional. Indicates if this user list is eligible for Google Search Network.

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.

UserListDirectLicense

Required. The licenses' name field is used to identify the license to update.

FieldMask

Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

UserListGlobalLicense

Required. The licenses' name field is used to identify the license to update.

FieldMask

Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

UserList

Required. The user list to update.

The user list's name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

FieldMask

Optional. The list of fields to update.