Node.js

Google یک کتابخانه کارخواه Node.js برای تعامل با Ad Manager API ارائه می‌دهد.

پیش‌نیاز

برای استفاده از کتابخانه کارخواه Node.js، باید Node.js را نصب کرده باشید. برای اطلاعات بیشتر، بارگیری Node.js® را ببینید.

نصب کتابخانه مشتری

برای شروع، پروژه جدیدی در IDE انتخابی‌تان ایجاد کنید یا وابستگی را به پروژه موجودی اضافه کنید. Google مصنوعات کتابخانه کارخواه را در npm به‌عنوان @google-ads/admanager منتشر می‌کند.

package.json 

"dependencies": {
  "@google-ads/admanager": "^0.15.0"
}

خط فرمان 

npm install @google-ads/admanager

پیکربندی اعتبارنامه‌ها

برای اصالت‌سنجی، کتابخانه کارخواه Node.js از OAuth2 و «اعتبارنامه‌های پیش‌فرض برنامه» (ADC) استفاده می‌کند. برای ایجاد و پیکربندی اطلاعات اعتباری ADC، به اصالت‌سنجی مراجعه کنید.

اولین درخواستتان را ارسال کنید

هر سرویس دارای یک شیء ServiceClient با روش‌هایی برای هر روش REST است. برای مشاهده نمونه‌های هر روش، به مخزن GitHub googleapis/google-cloud-node مراجعه کنید. مثال زیر شیء Network را می‌خواند:

// Resource name of the Network
const name = 'networks/NETWORK_CODE'

// Imports the Admanager library
const {NetworkServiceClient} = require('@google-ads/admanager').v1;

// Instantiates a client
const admanagerClient = new NetworkServiceClient();

async function callGetNetwork() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const response = await admanagerClient.getNetwork(request);
  console.log(response);
}

callGetNetwork();

ثبت درخواست‌ها و پاسخ‌های اچ‌تی‌تی‌پی

کتابخانه کارخواه Node.js از ثبت درخواست‌ها و پاسخ‌های HTTP پشتیبانی می‌کند. به‌طور پیش‌فرض، کتابخانه کارخواه گزارش‌گیری را غیرفعال می‌کند.

برای فعال کردن ثبت پیش‌فرض در برونداد استاندارد، متغیر محیطی GOOGLE_SDK_NODE_LOGGING را روی فهرست جداشده با کاما از نام بسته‌های Google API تنظیم کنید. می‌توانید با تنظیم مقدار متغیر روی all، ثبت گزارش را برای همه میاناهای برنامه‌سازی کاربردی Google فعال کنید. برای اطلاع از همه نام‌های بسته کتابخانه مشتری دردسترس، به کتابخانه‌های مشتری Google Cloud Node.js مراجعه کنید.

Node.js 

// Enable logging for the Google Ad Manager API
process.env.GOOGLE_SDK_NODE_LOGGING = 'admanager';

// Enable logging for the Google Ad Manager and pubsub APIs.
process.env.GOOGLE_SDK_NODE_LOGGING = 'admanager,pubsub';

// Enable logging for all Google APIs
process.env.GOOGLE_SDK_NODE_LOGGING = 'all';

Linux یا macOS 

# Enable logging for the Google Ad Manager API.
export GOOGLE_SDK_NODE_LOGGING=admanager

# Enable logging for the Google Ad Manager and pubsub APIs.
export GOOGLE_SDK_NODE_LOGGING=admanager,pubsub

# Enable logging for all Google APIs
export GOOGLE_SDK_NODE_LOGGING=all

Windows 

# Enable logging for the Google Ad Manager API.
set GOOGLE_SDK_NODE_LOGGING=admanager

# Enable logging for the Google Ad Manager and pubsub APIs.
set GOOGLE_SDK_NODE_LOGGING=admanager,pubsub

# Enable logging for all Google APIs
set GOOGLE_SDK_NODE_LOGGING=all

یا می‌توانید باطن ثبت گزارش را تغییر دهید یا رویدادهای گزارش را قلاب کنید. برای اطلاعات بیشتر، به ابزارهای ثبت Google مراجعه کنید.

مدیریت کردن خطاها

در کتابخانه کارخواه Node.js، همه خطاهای Ad Manager API استثنایی از نوع GaxiosError ایجاد می‌کنند.

خطاهای Ad Manager API شامل پیام خطا و مقدار requestId منحصربه‌فردی است که می‌توانید به تیم پشتیبانی API ارائه دهید. برای دریافت کمک درخصوص عیب‌یابی، به تماس با پشتیبانی API مراجعه کنید. مثال زیر مقدار requestId و پیام خطا را استخراج می‌کند:

const admanagerClient = new NetworkServiceClient();
try {
  const network = admanagerClient.getNetwork(
    { name: 'networks/NETWORK_CODE' }
  );
  console.log(network);
} catch(e) {
  if (e instanceof GaxiosError) {
    // Load the error
    const apiError = JSON.parse(e.message).error;
    const requestInfoType = 'type.googleapis.com/google.rpc.RequestInfo';
    const requestInfo = apiError.details.find(detail => detail['@type'] === requestInfoType);
    console.error(apiError.status + ' - ' + apiError.message);
    console.error('RequestId: ' + requestInfo.requestId);
  } else {
    throw e;
  }
}