REST Resource: guaranteedOrders

উৎস: গ্যারান্টিযুক্ত ক্রম

একটি নিশ্চিত অর্ডার।

গ্যারান্টিযুক্ত অর্ডার হলো গ্যারান্টিযুক্ত ইনভেন্টরি সোর্সের মূল সত্তা। একটি গ্যারান্টিযুক্ত ইনভেন্টরি সোর্স তৈরি করার সময়, সেই সোর্সে অবশ্যই একটি গ্যারান্টিযুক্ত অর্ডার আইডি বরাদ্দ করতে হবে।

JSON উপস্থাপনা 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
ক্ষেত্র
name

string

শুধুমাত্র আউটপুট। নিশ্চিত অর্ডারের রিসোর্স নাম।

legacyGuaranteedOrderId

string

শুধুমাত্র আউটপুট। গ্যারান্টিযুক্ত অর্ডারের লিগ্যাসি আইডি। মূল এক্সচেঞ্জ দ্বারা নির্ধারিত। লিগ্যাসি আইডি একটি এক্সচেঞ্জের মধ্যে অনন্য, কিন্তু সমস্ত গ্যারান্টিযুক্ত অর্ডারের ক্ষেত্রে এটি অনন্য হওয়ার নিশ্চয়তা নেই। এই আইডিটি SDF এবং UI-তে ব্যবহৃত হয়।

exchange

enum ( Exchange )

আবশ্যক। অপরিবর্তনীয়। যে এক্সচেঞ্জ থেকে গ্যারান্টিযুক্ত অর্ডারটি উদ্ভূত হয়েছিল।

guaranteedOrderId

string

শুধুমাত্র আউটপুট। গ্যারান্টিযুক্ত অর্ডারের অনন্য শনাক্তকারী। গ্যারান্টিযুক্ত অর্ডার আইডিগুলোর ফরম্যাট হলো {exchange}-{legacyGuaranteedOrderId} ।

displayName

string

আবশ্যক। নিশ্চিত অর্ডারের প্রদর্শিত নাম।

অবশ্যই UTF-8 এনকোড করা হতে হবে এবং এর সর্বোচ্চ আকার হবে ২৪০ বাইট।

status

object ( GuaranteedOrderStatus )

নিশ্চিত অর্ডারের স্ট্যাটাস সেটিংস।

updateTime

string ( Timestamp format)

শুধুমাত্র আউটপুট। নিশ্চিত অর্ডারটি সর্বশেষ আপডেট করার সময়কার টাইমস্ট্যাম্প। সিস্টেম দ্বারা নির্ধারিত।

RFC 3339 ব্যবহার করা হয়, যেখানে তৈরি হওয়া আউটপুট সর্বদা Z-নরম্যালাইজড হবে এবং এতে ০, ৩, ৬ বা ৯টি ভগ্নাংশীয় অঙ্ক ব্যবহৃত হবে। "Z" ছাড়াও অন্যান্য অফসেটও গ্রহণ করা হয়। উদাহরণ: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" অথবা "2014-10-02T15:01:23+05:30" ।

publisherName

string

আবশ্যক। নিশ্চিত অর্ডারের প্রকাশকের নাম।

অবশ্যই UTF-8 এনকোড করা হতে হবে এবং এর সর্বোচ্চ আকার হবে ২৪০ বাইট।

readAccessInherited

boolean

readWritePartnerId এর সকল বিজ্ঞাপনদাতার গ্যারান্টিযুক্ত অর্ডারটি পড়ার অ্যাক্সেস থাকবে কিনা। এটি শুধুমাত্র তখনই প্রযোজ্য যখন readWritePartnerId সেট করা থাকে। যদি True হয়, তবে এটি readAdvertiserIds ওভাররাইড করবে।

readAdvertiserIds[]

string ( int64 format)

নিশ্চিত অর্ডারটি পড়ার অ্যাক্সেস আছে এমন বিজ্ঞাপনদাতাদের আইডি।

যদি readWriteAdvertiserId সেট করা থাকে, তবে এই ফিল্ডে সেই বিজ্ঞাপনদাতাকে অন্তর্ভুক্ত করা যাবে না। এই ফিল্ডের সমস্ত বিজ্ঞাপনদাতাকে অবশ্যই readWritePartnerId এর অন্তর্ভুক্ত হতে হবে অথবা readWriteAdvertiserId মতো একই পার্টনারের হতে হবে।

defaultAdvertiserId

string ( int64 format)

শুধুমাত্র আউটপুট। নিশ্চিত অর্ডারের ডিফল্ট বিজ্ঞাপনদাতার আইডি।

ডিফল্ট বিজ্ঞাপনদাতা হলো readWriteAdvertiserId অথবা, যদি সেটি সেট করা না থাকে, তাহলে readAdvertiserIds এ তালিকাভুক্ত প্রথম বিজ্ঞাপনদাতা। অন্যথায়, কোনো ডিফল্ট বিজ্ঞাপনদাতা নেই।

defaultCampaignId

string ( int64 format)

নিশ্চিত অর্ডারের জন্য নির্ধারিত ডিফল্ট ক্যাম্পেইনের আইডি।

ডিফল্ট ক্যাম্পেইনটি অবশ্যই ডিফল্ট বিজ্ঞাপনদাতার মালিকানাধীন হতে হবে।

প্রয়োজনীয়।

সেই অংশীদার বা বিজ্ঞাপনদাতা যার নিশ্চিত অর্ডারে পঠন/লিখন অ্যাক্সেস রয়েছে। নিম্নলিখিতটি হলো পারস্পরিকভাবে স্বতন্ত্র ক্ষেত্রগুলির একটি তালিকা। একটি প্রতিক্রিয়ায় ক্ষেত্রগুলির মধ্যে সর্বাধিক একটি সেট করা হবে:

readWritePartnerId

string ( int64 format)

নিশ্চিত অর্ডারটিতে পঠন/লিখন অ্যাক্সেস থাকা অংশীদার।

readWriteAdvertiserId

string ( int64 format)

যে বিজ্ঞাপনদাতার গ্যারান্টিযুক্ত অর্ডারে পঠন/লিখন অ্যাক্সেস রয়েছে। ইনিই গ্যারান্টিযুক্ত অর্ডারের ডিফল্ট বিজ্ঞাপনদাতা।

পারস্পরিকভাবে বর্জনশীল ক্ষেত্রসমূহের সমাপ্তি।

গ্যারান্টিযুক্ত অর্ডারের অবস্থা

নিশ্চিত অর্ডারের স্ট্যাটাস সেটিংস।

JSON উপস্থাপনা 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
ক্ষেত্র
entityStatus

enum ( EntityStatus )

নিশ্চিতকৃত অর্ডারটি পরিবেশনযোগ্য কি না।

গ্রহণযোগ্য মানগুলো হলো ENTITY_STATUS_ACTIVE , ENTITY_STATUS_ARCHIVED , এবং ENTITY_STATUS_PAUSED । ডিফল্ট মান হলো ENTITY_STATUS_ACTIVE ।

entityPauseReason

string

এই নিশ্চিত অর্ডারটি স্থগিত করার জন্য ব্যবহারকারীর দেওয়া কারণ।

অবশ্যই UTF-8 এনকোড করা হতে হবে এবং এর সর্বোচ্চ দৈর্ঘ্য হবে ১০০ বাইট।

শুধুমাত্র তখনই প্রযোজ্য যখন entityStatus ENTITY_STATUS_PAUSED এ সেট করা থাকে।

configStatus

enum ( GuaranteedOrderConfigStatus )

শুধুমাত্র আউটপুট। নিশ্চিত অর্ডারের কনফিগারেশন অবস্থা।

গ্রহণযোগ্য মানগুলো হলো PENDING এবং COMPLETED ।

একটি নিশ্চিত অর্ডার পরিবেশন করার আগে তা কনফিগার করতে হবে (প্রয়োজনীয় ফিল্ডগুলো পূরণ করুন, ক্রিয়েটিভ বেছে নিন এবং একটি ডিফল্ট ক্যাম্পেইন নির্বাচন করুন)। বর্তমানে এই কনফিগারেশনের কাজটি শুধুমাত্র UI-এর মাধ্যমেই করা যায়।

গ্যারান্টিযুক্ত অর্ডার কনফিগারেশন স্ট্যাটাস

একটি নিশ্চিত ক্রমের জন্য সম্ভাব্য কনফিগারেশন অবস্থা।

এনাম
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED এই সংস্করণে অনুমোদনের অবস্থা নির্দিষ্ট করা নেই বা অজানা।
PENDING একটি নিশ্চিত অর্ডারের প্রারম্ভিক অবস্থা। এই অবস্থায় থাকা নিশ্চিত অর্ডারটি পরিবেশন করার আগে কনফিগার করতে হবে।
COMPLETED ক্রেতা একটি নিশ্চিত অর্ডার কনফিগার করার পরের অবস্থা।

পদ্ধতি

create

 একটি নতুন নিশ্চিত অর্ডার তৈরি করে।

editGuaranteedOrderReadAccessors

 সম্পাদনাগুলো বিজ্ঞাপনদাতাদের একটি নিশ্চিত অর্ডারের বার্তা দেয়।

get

 নিশ্চিত অর্ডার পাওয়া যায়।

list

 নিশ্চিত অর্ডারগুলোর তালিকা দেয় যা বর্তমান ব্যবহারকারীর জন্য অ্যাক্সেসযোগ্য।

patch

 বিদ্যমান একটি গ্যারান্টিযুক্ত অর্ডার আপডেট করে।