Method: targetingTypes.targetingOptions.search

البحث عن خيارات استهداف من نوع معيّن استنادًا إلى عبارات البحث المحدّدة

طلب HTTP

POST https://displayvideo.googleapis.com/v4/targetingTypes/{targetingType}/targetingOptions:search

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
targetingType

enum (TargetingType)

مطلوب. نوع خيارات الاستهداف المطلوب استرجاعها.

القيم المقبولة هي:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,

  // Union field search_terms can be only one of the following:
  "poiSearchTerms": {
    object (PoiSearchTerms)
  },
  "businessChainSearchTerms": {
    object (BusinessChainSearchTerms)
  },
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
  // End of list of possible types for union field search_terms.
}
الحقول
advertiserId

string (int64 format)

مطلوب. المعلِن الذي يتم تقديم هذا الطلب في سياقه
pageSize

integer

حجم الصفحة المطلوب يجب أن تتراوح بين 1 و200. إذا لم يتم تحديد قيمة، سيتم ضبطها تلقائيًا على 100. تُعرِض رمز الخطأ INVALID_ARGUMENT في حال تحديد قيمة غير صالحة.
pageToken

string

رمز مميّز يحدّد صفحة النتائج التي يجب أن يعرضها الخادم. وعادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الطلب السابق لاستخدام طريقة targetingOptions.search. إذا لم يتم تحديدها، سيتم عرض الصفحة الأولى من النتائج.
حقل الربط search_terms طلبات البحث التي يتم البحث من خلالها عن خيارات الاستهداف يمكن ملء حقل واحد فقط في search_terms، ويجب أن يكون مطابقًا للحقل targeting_type. يمكن أن يكون search_terms واحدًا فقط مما يلي:
poiSearchTerms

object (PoiSearchTerms)

عبارات البحث عن خيارات استهداف نقاط الاهتمام لا يمكن استخدامها إلا عندما يكون targetingType هو TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

عبارات البحث عن خيارات استهداف سلاسل الأنشطة التجارية لا يمكن استخدامها إلا عندما يكون targetingType هو TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

عبارات البحث عن خيارات الاستهداف حسب المنطقة الجغرافية لا يمكن استخدامها إلا عندما يكون targetingType هو TARGETING_TYPE_GEO_REGION.

نص الاستجابة

رسالة الردّ بشأن targetingOptions.search

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
الحقول
targetingOptions[]

object (TargetingOption)

قائمة خيارات الاستهداف التي تتطابق مع معايير البحث

لن تظهر هذه القائمة إذا كانت فارغة.
nextPageToken

string

رمز مميّز لاسترداد الصفحة التالية من النتائج نقْل هذه القيمة في حقل pageToken في الطلب اللاحق لطريقة targetingOptions.search لاسترداد الصفحة التالية من النتائج.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/display-video

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

PoiSearchTerms

عبارات البحث عن خيارات استهداف نقاط الاهتمام

تمثيل JSON 
{
  "poiQuery": string
}
الحقول
poiQuery

string

طلب البحث عن اسم نقطة الاهتمام أو عنوان الشارع أو الإحداثيات لنقطة الاهتمام المطلوبة يمكن أن يكون الطلب بادئة، مثل "Times squar" أو "40.7505045,-73.99562" أو "315 W 44th St" وما إلى ذلك.

BusinessChainSearchTerms

عبارات البحث عن خيارات استهداف سلاسل الأنشطة التجارية

يجب تعبئة حقل واحد على الأقل.

تمثيل JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
الحقول
businessChainQuery

string

طلب البحث عن سلسلة الأنشطة التجارية المطلوبة. يجب أن يكون الطلب هو الاسم الكامل للنشاط التجاري، مثل "KFC" أو "mercedes-benz".
regionQuery

string

طلب البحث عن المنطقة الجغرافية المطلوبة، مثل "سياتل" أو "الولايات المتحدة"

GeoRegionSearchTerms

عبارات البحث عن خيارات الاستهداف حسب المنطقة الجغرافية

تمثيل JSON 
{
  "geoRegionQuery": string
}
الحقول
geoRegionQuery

string

طلب البحث عن المنطقة الجغرافية المطلوبة يمكن أن يكون الطلب بادئة، مثل "القاهرة" أو "الإسكندرية" أو "مصر" وما إلى ذلك.