Queries

للاطّلاع على قائمة طُرق لهذا المورد، يُرجى الاطّلاع على نهاية هذه الصفحة.

تمثيلات الموارد

يمثل طلب بحث.

{
  "kind": "doubleclickbidmanager#query",
  "queryId": long,
  "metadata": {
    "title": string,
    "dataRange": string,
    "format": string,
    "running": boolean,
    "reportCount": integer,
    "googleCloudStoragePathForLatestReport": string,
    "latestReportRunTimeMs": long,
    "googleDrivePathForLatestReport": string,
    "sendNotification": boolean,
    "shareEmailAddress": [
      string
    ],
    "locale": string
  },
  "params": {
    "type": string,
    "groupBys": [
      string
    ],
    "filters": [
      {
        "type": string,
        "value": string
      }
    ],
    "metrics": [
      string
    ],
    "includeInviteData": boolean
  },
  "schedule": {
    "frequency": string,
    "endTimeMs": long,
    "nextRunMinuteOfDay": integer,
    "nextRunTimezoneCode": string
  },
  "reportDataStartTimeMs": long,
  "reportDataEndTimeMs": long,
  "timezoneCode": string
}
اسم الموقع القيمة الوصف ملاحظات
kind string يحدّد نوع هذا المورد. القيمة: السلسلة الثابتة "doubleclickbidmanager#query".
metadata nested object البيانات الوصفية لطلب البحث
metadata.dataRange string نطاق بيانات التقرير.

القيم المقبولة هي:
  • "ALL_TIME"
  • "CURRENT_DAY"
  • "CUSTOM_DATES"
  • "LAST_14_DAYS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_DAY"
  • "PREVIOUS_HALF_MONTH"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TYPE_NOT_SUPPORTED"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
metadata.format string تنسيق التقرير الذي تم إنشاؤه.

القيم المقبولة هي:
  • "CSV"
  • "EXCEL_CSV"
  • "XLSX"
metadata.googleCloudStoragePathForLatestReport string المسار إلى الموقع الجغرافي في Google Cloud Storage حيث يتم تخزين آخر تقرير.
metadata.googleDrivePathForLatestReport string المسار في Google Drive لأحدث تقرير.
metadata.latestReportRunTimeMs long الوقت الذي بدأ فيه تشغيل آخر تقرير.
metadata.locale string

لغة التقارير التي تم إنشاؤها. القيم المقبولة هي:

  • "cs" لأغنية CZECH
  • "de" لألمانيا
  • "en" باللغة الإنجليزية
  • "es" لدالة SPISH
  • "fr" للغة الفرنسية
  • "it" لإيطاليا
  • "ja" باللغة اليابانية
  • "ko" باللغة الكورية
  • "pl" لتطبيق POLISH
  • "pt-BR" عن BRAZILIAN_PORTUGUESE
  • "ru" لروسين
  • "tr" للغة التركية
  • "uk" للمملكة المتحدة
  • "zh-CN" لـ CHINA_CHINESE
  • "zh-TW" لـ TAIWAN_CHINESE

ستُنشئ سلسلة لغة غير مدرَجة في القائمة أعلاه تقارير باللغة الإنجليزية.

metadata.reportCount integer عدد التقارير التي تم إنشاؤها لطلب البحث.
metadata.running boolean ما إذا كان أحدث تقرير قيد التشغيل حاليًا.
metadata.sendNotification boolean يمكنك اختيار إرسال إشعار عبر البريد الإلكتروني عندما يكون التقرير جاهزًا. الخيار التلقائي هو "خطأ".
metadata.shareEmailAddress[] list قائمة بعناوين البريد الإلكتروني التي يتم إرسال إشعارات إليها عبر البريد الإلكتروني عند انتهاء التقرير فصل عن sendNotification.
metadata.title string عنوان طلب البحث يُستخدم هذا الاسم لتسمية التقارير التي تم إنشاؤها من طلب البحث هذا.
params nested object معلِمات طلب البحث.
params.filters[] list الفلاتر المستخدَمة لمطابقة بيانات الزيارات في تقريرك.
params.filters[].type string نوع الفلتر

القيم المقبولة هي:
  • "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY"
  • "FILTER_ACTIVITY_ID"
  • "FILTER_ADVERTISER"
  • "FILTER_ADVERTISER_CURRENCY"
  • "FILTER_ADVERTISER_TIMEZONE"
  • "FILTER_AD_POSITION"
  • "FILTER_AGE"
  • "FILTER_AUTHORIZED_SELLER_STATE_ID"
  • "FILTER_BRANDSAFE_CHANNEL_ID"
  • "FILTER_BROWSER"
  • "FILTER_BUDGET_SEGMENT_DESCRIPTION"
  • "FILTER_CAMPAIGN_DAILY_FREQUENCY"
  • "FILTER_CARRIER"
  • "FILTER_CHANNEL_ID"
  • "FILTER_CITY"
  • "FILTER_COMPANION_CREATIVE_ID"
  • "FILTER_CONVERSION_DELAY"
  • "FILTER_COUNTRY"
  • "FILTER_CREATIVE_ATTRIBUTE"
  • "FILTER_CREATIVE_HEIGHT"
  • "FILTER_CREATIVE_ID"
  • "FILTER_CREATIVE_SIZE"
  • "FILTER_CREATIVE_TYPE"
  • "FILTER_CREATIVE_WIDTH"
  • "FILTER_DATA_PROVIDER"
  • "FILTER_DATE"
  • "FILTER_DAY_OF_WEEK"
  • "FILTER_DEVICE_MAKE"
  • "FILTER_DEVICE_MODEL"
  • "FILTER_DEVICE_TYPE"
  • "FILTER_DFP_ORDER_ID"
  • "FILTER_DMA"
  • "FILTER_DV360_ACTIVITY_ID"
  • "FILTER_EXCHANGE_ID"
  • "FILTER_FLOODLIGHT_ACTIVITY_ID"
  • "FILTER_FLOODLIGHT_PIXEL_ID"
  • "FILTER_GENDER"
  • "FILTER_INSERTION_ORDER"
  • "FILTER_INVENTORY_COMMITMENT_TYPE"
  • "FILTER_INVENTORY_DELIVERY_METHOD"
  • "FILTER_INVENTORY_FORMAT"
  • "FILTER_INVENTORY_RATE_TYPE"
  • "FILTER_INVENTORY_SOURCE"
  • "FILTER_INVENTORY_SOURCE_TYPE"
  • "FILTER_KEYWORD"
  • "FILTER_LINE_ITEM"
  • "FILTER_LINE_ITEM_DAILY_FREQUENCY"
  • "FILTER_LINE_ITEM_LIFETIME_FREQUENCY"
  • "FILTER_LINE_ITEM_TYPE"
  • "FILTER_MEDIA_PLAN"
  • "FILTER_MOBILE_DEVICE_MAKE"
  • "FILTER_MOBILE_DEVICE_MAKE_MODEL"
  • "FILTER_MOBILE_DEVICE_TYPE"
  • "FILTER_MOBILE_GEO"
  • "FILTER_MONTH"
  • "FILTER_MRAID_SUPPORT"
  • "FILTER_NIELSEN_AGE"
  • "FILTER_NIELSEN_COUNTRY_CODE"
  • "FILTER_NIELSEN_DEVICE_ID"
  • "FILTER_NIELSEN_GENDER"
  • "FILTER_NOT_SUPPORTED"
  • "FILTER_ORDER_ID"
  • "FILTER_OS"
  • "FILTER_PAGE_CATEGORY"
  • "FILTER_PAGE_LAYOUT"
  • "FILTER_PARTNER"
  • "FILTER_PARTNER_CURRENCY"
  • "FILTER_PUBLIC_INVENTORY"
  • "FILTER_QUARTER"
  • "FILTER_REGION"
  • "FILTER_REGULAR_CHANNEL_ID"
  • "FILTER_SITE_ID"
  • "FILTER_SITE_LANGUAGE"
  • "FILTER_SKIPPABLE_SUPPORT"
  • "FILTER_TARGETED_USER_LIST"
  • "FILTER_TIME_OF_DAY"
  • "FILTER_TRUEVIEW_AD_GROUP_AD_ID"
  • "FILTER_TRUEVIEW_AD_GROUP_ID"
  • "FILTER_TRUEVIEW_AGE"
  • "FILTER_TRUEVIEW_CATEGORY"
  • "FILTER_TRUEVIEW_CITY"
  • "FILTER_TRUEVIEW_CONVERSION_TYPE"
  • "FILTER_TRUEVIEW_COUNTRY"
  • "FILTER_TRUEVIEW_CUSTOM_AFFINITY"
  • "FILTER_TRUEVIEW_DMA"
  • "FILTER_TRUEVIEW_GENDER"
  • "FILTER_TRUEVIEW_IAR_AGE"
  • "FILTER_TRUEVIEW_IAR_CATEGORY"
  • "FILTER_TRUEVIEW_IAR_CITY"
  • "FILTER_TRUEVIEW_IAR_COUNTRY"
  • "FILTER_TRUEVIEW_IAR_GENDER"
  • "FILTER_TRUEVIEW_IAR_INTEREST"
  • "FILTER_TRUEVIEW_IAR_LANGUAGE"
  • "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS"
  • "FILTER_TRUEVIEW_IAR_REGION"
  • "FILTER_TRUEVIEW_IAR_REMARKETING_LIST"
  • "FILTER_TRUEVIEW_IAR_TIME_OF_DAY"
  • "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL"
  • "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO"
  • "FILTER_TRUEVIEW_IAR_ZIPCODE"
  • "FILTER_TRUEVIEW_INTEREST"
  • "FILTER_TRUEVIEW_KEYWORD"
  • "FILTER_TRUEVIEW_PARENTAL_STATUS"
  • "FILTER_TRUEVIEW_PLACEMENT"
  • "FILTER_TRUEVIEW_REGION"
  • "FILTER_TRUEVIEW_REMARKETING_LIST"
  • "FILTER_TRUEVIEW_URL"
  • "FILTER_TRUEVIEW_ZIPCODE"
  • "FILTER_UNKNOWN"
  • "FILTER_USER_LIST"
  • "FILTER_USER_LIST_FIRST_PARTY"
  • "FILTER_USER_LIST_THIRD_PARTY"
  • "FILTER_VIDEO_AD_POSITION_IN_STREAM"
  • "FILTER_VIDEO_COMPANION_SIZE"
  • "FILTER_VIDEO_COMPANION_TYPE"
  • "FILTER_VIDEO_CREATIVE_DURATION"
  • "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE"
  • "FILTER_VIDEO_DURATION_SECONDS"
  • "FILTER_VIDEO_FORMAT_SUPPORT"
  • "FILTER_VIDEO_INVENTORY_TYPE"
  • "FILTER_VIDEO_PLAYER_SIZE"
  • "FILTER_VIDEO_RATING_TIER"
  • "FILTER_VIDEO_SKIPPABLE_SUPPORT"
  • "FILTER_VIDEO_VPAID_SUPPORT"
  • "FILTER_WEEK"
  • "FILTER_YEAR"
  • "FILTER_YOUTUBE_VERTICAL"
  • "FILTER_ZIP_CODE"
params.filters[].value string قيمة الفلتر
params.groupBys[] list يتم تجميع البيانات حسب الفلاتر المُدرجة في هذا الحقل.
params.includeInviteData boolean تمّ الإيقاف. لم يعد هذا الحقل قيد الاستخدام.
params.metrics[] list المقاييس المطلوب تضمينها كأعمدة في تقريرك.
params.type string نوع التقرير

القيود الخاصة بالنوع:
  • يتوافق TYPE_ORDER_ID مع النطاقات الزمنية السابقة في آخر 60 يومًا على الأكثر.
  • لا يتجاوز النطاق الزمني TYPE_AUDIENCE_COMPOSITION وTYPE_INVENTORY_AVAILABILITY وTYPE_TRUEVIEW_IAR النطاق الزمني للدعم في آخر 30 يومًا.


القيم المقبولة هي:
  • "TYPE_ACTIVE_GRP"
  • "TYPE_AUDIENCE_COMPOSITION"
  • "TYPE_AUDIENCE_PERFORMANCE"
  • "TYPE_CLIENT_SAFE"
  • "TYPE_COMSCORE_VCE"
  • "TYPE_CROSS_FEE"
  • "TYPE_CROSS_PARTNER"
  • "TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER"
  • "TYPE_ESTIMATED_CONVERSION"
  • "TYPE_FEE"
  • "TYPE_GENERAL"
  • "TYPE_INVENTORY_AVAILABILITY"
  • "TYPE_KEYWORD"
  • "TYPE_LINEAR_TV_SEARCH_LIFT"
  • "TYPE_NIELSEN_AUDIENCE_PROFILE"
  • "TYPE_NIELSEN_DAILY_REACH_BUILD"
  • "TYPE_NIELSEN_ONLINE_GLOBAL_MARKET"
  • "TYPE_NIELSEN_SITE"
  • "TYPE_NOT_SUPPORTED"
  • "TYPE_ORDER_ID"
  • "TYPE_PAGE_CATEGORY"
  • "TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE"
  • "TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD"
  • "TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET"
  • "TYPE_PIXEL_LOAD"
  • "TYPE_REACH_AND_FREQUENCY"
  • "TYPE_REACH_AUDIENCE"
  • "TYPE_THIRD_PARTY_DATA_PROVIDER"
  • "TYPE_TRUEVIEW"
  • "TYPE_TRUEVIEW_IAR"
  • "TYPE_VERIFICATION"
  • "TYPE_YOUTUBE_VERTICAL"
queryId long معرّف طلب البحث.
reportDataEndTimeMs long وقت انتهاء البيانات التي يتم عرضها في التقرير. ملاحظة: السمة reportDataEndTimeMs مطلوبة إذا كانت السمة metadata.dataRange CUSTOM_DATES وتم تجاهلها.
reportDataStartTimeMs long وقت البدء للبيانات التي يتم عرضها في التقرير. ملاحظة: السمة reportDataStartTimeMs مطلوبة إذا كانت السمة metadata.dataRange CUSTOM_DATES وتم تجاهلها.
schedule nested object معلومات حول عدد مرات إجراء طلب البحث ووقته.
schedule.endTimeMs long تاريخ إجراء طلب البحث بشكل دوري حتى.
schedule.frequency string عدد مرات تنفيذ طلب البحث

القيم المقبولة هي:
  • "DAILY"
  • "MONTHLY"
  • "ONE_TIME"
  • "QUARTERLY"
  • "SEMI_MONTHLY"
  • "WEEKLY"
schedule.nextRunMinuteOfDay integer تمّ الإيقاف. هذا الحقل ليس له أي تأثير.
schedule.nextRunTimezoneCode string رمز المنطقة الزمنية الأساسية لوقت إنشاء التقرير يكون الإعداد التلقائي بالقيمة America/New_York.
timezoneCode string رمز المنطقة الزمنية الأساسي لوقت بيانات التقرير يكون الإعداد التلقائي بالقيمة America/New_York.

الطُرق

إنشاء طلب بحث
لإنشاء طلب بحث.
حذف طلب البحث
يحذف طلب بحث مخزَّن، بالإضافة إلى التقارير المرتبطة به.
getquery
استرداد طلب البحث المخزَّن
قوائم الطلبات
استرداد طلبات البحث المخزّنة
runquery
يتم تنفيذ طلب بحث مُخزَّن لإنشاء تقرير.