এই নির্দেশিকাটি সকল API কলের সাধারণ কাঠামো বর্ণনা করে।
যদি আপনি API এর সাথে ইন্টারঅ্যাক্ট করার জন্য একটি ক্লায়েন্ট লাইব্রেরি ব্যবহার করেন, তাহলে আপনাকে অন্তর্নিহিত অনুরোধের বিবরণ জানার প্রয়োজন হবে না। তবে, API কল কাঠামো সম্পর্কে কিছু জ্ঞান পরীক্ষা এবং ডিবাগিংয়ের সময় কাজে আসতে পারে।
Google Ads API হল একটি gRPC API , যার REST বাইন্ডিং রয়েছে। এর মানে হল API তে কল করার দুটি উপায় রয়েছে।
পছন্দের :
অনুরোধের মূল অংশটি একটি প্রোটোকল বাফার হিসেবে তৈরি করুন।
HTTP/2 ব্যবহার করে সার্ভারে পাঠান।
একটি প্রোটোকল বাফারের প্রতিক্রিয়া ডিসিরিয়ালাইজ করুন।
ফলাফল ব্যাখ্যা করুন।
আমাদের বেশিরভাগ ডকুমেন্টেশন gRPC ব্যবহার বর্ণনা করে।
ঐচ্ছিক :
অনুরোধের মূল অংশটি একটি JSON অবজেক্ট হিসেবে তৈরি করুন।
HTTP 1.1 ব্যবহার করে সার্ভারে পাঠান।
প্রতিক্রিয়াটিকে JSON অবজেক্ট হিসেবে ডিসিরিয়ালাইজ করুন।
ফলাফল ব্যাখ্যা করুন।
REST ব্যবহার সম্পর্কে আরও তথ্যের জন্য REST ইন্টারফেস নির্দেশিকাটি দেখুন।
রিসোর্সের নাম
API-এর বেশিরভাগ অবজেক্ট তাদের রিসোর্স নেম স্ট্রিং দ্বারা চিহ্নিত করা হয়। REST ইন্টারফেস ব্যবহার করার সময় এই স্ট্রিংগুলি URL হিসেবেও কাজ করে। তাদের কাঠামোর জন্য REST ইন্টারফেসের রিসোর্স নেম দেখুন।
কম্পোজিট আইডি
যদি কোনও বস্তুর আইডি বিশ্বব্যাপী অনন্য না হয়, তাহলে সেই বস্তুর জন্য একটি যৌগিক আইডি তৈরি করা হয় তার প্যারেন্ট আইডি এবং একটি টিল্ড (~) এর আগে যুক্ত করে।
উদাহরণস্বরূপ, যেহেতু একটি বিজ্ঞাপন গোষ্ঠীর বিজ্ঞাপন আইডি বিশ্বব্যাপী অনন্য নয়, তাই আমরা একটি অনন্য কম্পোজিট আইডি তৈরি করতে এর প্যারেন্ট অবজেক্ট (বিজ্ঞাপন গোষ্ঠী) আইডিটি এর সাথে যুক্ত করি:
-
123এরAdGroupId+~+45678এরAdGroupAdId=123~45678এর যৌগিক বিজ্ঞাপন গ্রুপ বিজ্ঞাপন আইডি।
হেডারের অনুরোধ করুন
অনুরোধের বডির সাথে থাকা HTTP হেডারগুলি (অথবা grpc মেটাডেটা ) হল:
অনুমোদন
আপনাকে অবশ্যই Authorization: Bearer YOUR_ACCESS_TOKEN আকারে একটি OAuth2 অ্যাক্সেস টোকেন অন্তর্ভুক্ত করতে হবে যা ক্লায়েন্টের পক্ষে কাজ করা একজন ম্যানেজার অ্যাকাউন্টকে, অথবা সরাসরি তাদের নিজস্ব অ্যাকাউন্ট পরিচালনাকারী একজন বিজ্ঞাপনদাতাকে চিহ্নিত করে। অ্যাক্সেস টোকেন পুনরুদ্ধারের নির্দেশাবলী OAuth2 নির্দেশিকাতে পাওয়া যাবে। একটি অ্যাক্সেস টোকেন অর্জনের এক ঘন্টার জন্য বৈধ থাকে; যখন এটির মেয়াদ শেষ হয়ে যায়, তখন একটি নতুন পুনরুদ্ধার করতে অ্যাক্সেস টোকেনটি রিফ্রেশ করুন। মনে রাখবেন যে আমাদের ক্লায়েন্ট লাইব্রেরিগুলি স্বয়ংক্রিয়ভাবে মেয়াদোত্তীর্ণ টোকেনগুলি রিফ্রেশ করে।
ডেভেলপার-টোকেন
একটি ডেভেলপার টোকেন হল একটি ২২-অক্ষরের স্ট্রিং যা একজন Google Ads API ডেভেলপারকে অনন্যভাবে শনাক্ত করে। একটি উদাহরণ ডেভেলপার টোকেন স্ট্রিং হল ABcdeFGH93KL-NOPQ_STUv । ডেভেলপার টোকেনটি developer-token : ABcdeFGH93KL-NOPQ_STUv ।
লগইন-গ্রাহক-আইডি
এটি অনুরোধে ব্যবহার করার জন্য অনুমোদিত গ্রাহকের গ্রাহক আইডি, হাইফেন ( - ) ছাড়াই। যদি গ্রাহক অ্যাকাউন্টে আপনার অ্যাক্সেস একটি ম্যানেজার অ্যাকাউন্টের মাধ্যমে হয়, তাহলে এই হেডারটি প্রয়োজনীয় এবং ম্যানেজার অ্যাকাউন্টের গ্রাহক আইডিতে সেট করা আবশ্যক।
https://googleads.googleapis.com/v22/customers/1234567890/campaignBudgets:mutate
login-customer-id সেট করা মানে সাইন ইন করার পরে অথবা উপরের ডানদিকে আপনার প্রোফাইল ছবিতে ক্লিক করার পরে Google বিজ্ঞাপন UI তে একটি অ্যাকাউন্ট বেছে নেওয়ার সমতুল্য। যদি আপনি এই হেডারটি অন্তর্ভুক্ত না করেন, তাহলে এটি ডিফল্টভাবে অপারেটিং গ্রাহকের কাছে থাকবে।
লিঙ্কড-গ্রাহক-আইডি
এই হেডারটি শুধুমাত্র [তৃতীয় পক্ষের অ্যাপ বিশ্লেষণ প্রদানকারীরা একটি লিঙ্ক করা Google বিজ্ঞাপন অ্যাকাউন্টে রূপান্তর আপলোড করার সময় ব্যবহার করে।
অ্যাকাউন্ট A এর ব্যবহারকারীরা ThirdPartyAppAnalyticsLink এর মাধ্যমে অ্যাকাউন্ট B এর সত্তাগুলিতে পঠন এবং সম্পাদনা অ্যাক্সেস প্রদান করে এমন পরিস্থিতি বিবেচনা করুন। লিঙ্ক হয়ে গেলে, অ্যাকাউন্ট B এর একজন ব্যবহারকারী অ্যাকাউন্ট A বিরুদ্ধে API কল করতে পারেন, লিঙ্ক দ্বারা প্রদত্ত অনুমতি সাপেক্ষে। এই ক্ষেত্রে, অ্যাকাউন্ট A এর API-কলিং অনুমতিগুলি অ্যাকাউন্ট B তৃতীয়-পক্ষের লিঙ্ক দ্বারা নির্ধারিত হয়, অন্যান্য API কলগুলিতে ব্যবহৃত ম্যানেজার-অ্যাকাউন্ট সম্পর্কের পরিবর্তে।
তৃতীয় পক্ষের অ্যাপ বিশ্লেষণ প্রদানকারী নিম্নরূপ একটি API কল করে:
-
linked-customer-id: তৃতীয় পক্ষের অ্যাপ অ্যানালিটিক্স অ্যাকাউন্ট যা ডেটা আপলোড করে (অ্যাকাউন্টB)। -
customer-id: যে Google বিজ্ঞাপন অ্যাকাউন্টে ডেটা আপলোড করা হয় (অ্যাকাউন্টA)। -
login-customer-idএবংAuthorizationহেডার: অ্যাকাউন্টBতে অ্যাক্সেস আছে এমন ব্যবহারকারীকে শনাক্ত করার জন্য মানগুলির সংমিশ্রণ।
প্রতিক্রিয়া শিরোনাম
নিম্নলিখিত হেডারগুলি (অথবা grpc trailing-metadata ) রেসপন্স বডির সাথে ফেরত পাঠানো হয়। আমরা আপনাকে ডিবাগিংয়ের উদ্দেশ্যে এই মানগুলি লগ করার পরামর্শ দিচ্ছি।
অনুরোধ-আইডি
request-id হলো একটি স্ট্রিং যা এই রিকোয়েস্টটিকে অনন্যভাবে শনাক্ত করে।