Method: targetingTypes.targetingOptions.search

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

طلب HTTP

POST https://displayvideo.googleapis.com/v1/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.

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" أو "مرسيدس بنز".
regionQuery

string

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

GeoRegionSearchTerms

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

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

string

طلب البحث للمنطقة الجغرافية المطلوبة. يمكن أن يكون الاستعلام بادئة، على سبيل المثال: "New Yor" أو "Seattle" أو "USA" وما إلى ذلك.