Google cung cấp một thư viện ứng dụng Node.js để tương tác với API Ad Manager.
Điều kiện tiên quyết
Để sử dụng thư viện ứng dụng Node.js, bạn phải cài đặt Node.js. Để biết thêm thông tin, hãy xem phần Tải Node.js® xuống.
Cài đặt thư viện ứng dụng
Để bắt đầu, hãy tạo một dự án mới trong IDE mà bạn chọn hoặc thêm phần phụ thuộc vào một dự án hiện có. Google xuất bản các cấu phần phần mềm thư viện ứng dụng lên npm dưới dạng @google-ads/admanager
.
package.json
"dependencies": {
"@google-ads/admanager": "^0.4.0"
}
Dòng lệnh
npm install @google-ads/admanager
Định cấu hình thông tin đăng nhập
Để xác thực, thư viện ứng dụng Node.js sử dụng OAuth2 và Thông tin đăng nhập mặc định của ứng dụng (ADC). Để tạo và định cấu hình thông tin đăng nhập ADC, hãy xem phần Xác thực.
Tạo yêu cầu đầu tiên
Mỗi dịch vụ đều có một đối tượng ServiceClient
với các phương thức cho từng phương thức REST.
Để xem ví dụ về từng phương thức, hãy xem kho lưu trữ googleapis/google-cloud-node
trên GitHub.
Ví dụ sau đây đọc một đối tượng 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();
Ghi nhật ký các yêu cầu và phản hồi HTTP
Thư viện ứng dụng Node.js hỗ trợ ghi nhật ký các yêu cầu và phản hồi HTTP. Theo mặc định, thư viện ứng dụng sẽ tắt tính năng ghi nhật ký.
Để bật tính năng ghi nhật ký mặc định vào đầu ra chuẩn, hãy đặt biến môi trường GOOGLE_SDK_NODE_LOGGING
thành danh sách tên gói API của Google được phân tách bằng dấu phẩy.
Bạn có thể bật tính năng ghi nhật ký cho tất cả các API của Google bằng cách đặt giá trị biến thành all
. Để biết tất cả tên gói thư viện ứng dụng hiện có, hãy xem Thư viện ứng dụng 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 hoặc 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
Ngoài ra, bạn có thể thay đổi phần phụ trợ ghi nhật ký hoặc móc các sự kiện nhật ký. Để biết thêm thông tin, hãy xem bài viết Công cụ ghi nhật ký của Google.
Xử lý lỗi
Trong thư viện ứng dụng Node.js, tất cả lỗi Ad Manager API đều tạo ra một ngoại lệ thuộc loại GaxiosError.
Lỗi Ad Manager API bao gồm một thông báo lỗi và một giá trị requestId
duy nhất mà bạn có thể cung cấp cho nhóm hỗ trợ API. Để được trợ giúp về cách khắc phục sự cố, hãy xem phần Liên hệ với nhóm hỗ trợ API. Ví dụ sau đây trích xuất giá trị requestId
và thông báo lỗi:
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;
}
}