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