با Ads Data Hub API شروع کنید

این راهنما نحوه شروع نوشتن برنامه‌هایی را توضیح می‌دهد که از Ads Data Hub REST API برای تعامل با Ads Data Hub استفاده می‌کنند. Ads Data Hub REST API به شما این امکان را می دهد که مشتریان Ads Data Hub مرتبط با حساب Google خود را مشاهده کنید، پرس و جو ایجاد کنید، و پرس و جوهایی را اجرا کنید.

راه اندازی

چند مرحله وجود دارد که باید قبل از استفاده از Ads Data Hub API انجام دهید:

  1. اطمینان حاصل کنید که به کاربری که API را فعال می کند، مجوز serviceusage.services.enable در پروژه Google Cloud داده شده است. کاربر دارای مجوز serviceusage.services.enable نیز باید برای دسترسی به API در لیست مجاز باشد.
  2. Ads Data Hub API را در پروژه Google Cloud که در آن اعتبار مشتری یا حساب سرویس ایجاد شده است، فعال کنید. برای فعال کردن Ads Data Hub API برای یک پروژه با استفاده از کنسول:
    1. به کتابخانه Cloud Console API بروید.
    2. پروژه ای را که می خواهید استفاده کنید از لیست پروژه ها انتخاب کنید.
    3. «Ads Data Hub API» را جستجو کنید.
    4. در صفحه API، روی ENABLE کلیک کنید.
  3. مدیریت مجوزها:
    1. آدرس ایمیل یا حساب سرویس مورد استفاده برای ایجاد اعتبارنامه باید با مجوزهای مناسب به Ads Data Hub اضافه شود. برای حساب سرویس، این آدرس ایمیل حساب سرویس است. برای OAuth، این آدرس ایمیل کاربر است. این تضمین می‌کند که حساب سرویس یا حساب کاربر نهایی مجوز اجرای درخواست‌ها در Ads Data Hub را دارد.
  4. (توصیه می شود) یک کتابخانه سرویس گیرنده Google API نصب کنید:
    1. کتابخانه های سرویس گیرنده Google API به چندین زبان محبوب در دسترس هستند و به شما امکان می دهند با بسیاری از API های Google کار کنید. در حالی که این مورد نیاز نیست، کتابخانه های سرویس گیرنده مقدار کدی را که باید بنویسید کاهش می دهند و احراز هویت را برای تنظیم ساده تر می کنند.
کتابخانه مشتری نمونه های Ads Data Hub
Google API Client Library برای جاوا جاوا
Google API Client Library برای پایتون

احراز هویت و مجوز

Ads Data Hub API می‌تواند به داده‌های حساب مشتری Ads Data Hub شما دسترسی داشته باشد و آن‌ها را تغییر دهد، بنابراین باید تأیید کند که شما یک کاربر مجاز هستید. به همین دلیل، قبل از شروع تعامل با Ads Data Hub API، باید یک جریان مجوز را طی کنید. یک جریان مجوز مجوزهای لازم برای تعامل با API را در اختیار شما قرار می دهد. می توانید با استفاده از OAuth 2.0 یا یک حساب سرویس احراز هویت کنید.

راه اندازی حساب سرویس

  1. به کنسول API Google بروید و به پروژه مدیریت خود بروید.
  2. بررسی کنید که Ads Data Hub API برای پروژه شما تحت APIs & Services فعال باشد.
    1. اگر اینطور نیست، روی + Enable APIs and services کلیک کنید و Ads Data Hub API را فعال کنید.
  3. در منوی پیمایش سمت چپ، روی IAM & Admin > حساب‌های سرویس کلیک کنید.
    1. اگر هنوز یک حساب سرویس ایجاد نکرده اید، یک حساب کاربری ایجاد کنید .
  4. روی منوی 3 نقطه ای ( ) در زیر «اقدامات» کلیک کنید، سپس روی Manage keys کلیک کنید.
    1. روی افزودن کلید > ایجاد کلید جدید کلیک کنید
    2. پس از اطمینان از انتخاب "JSON"، روی ایجاد کلیک کنید.
  5. آدرس ایمیل حساب سرویس را به عنوان کاربر در حساب Ads Data Hub خود اضافه کنید.

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

#!/usr/bin/env python3

"""This sample shows how to retrieve all accounts associated with the user.
"""
import json
from google.oauth2.service_account import Credentials
from googleapiclient.discovery import build

SCOPES = ['https://www.googleapis.com/auth/adsdatahub']
DISCOVERY_URL = 'https://adsdatahub.googleapis.com/$discovery/rest?version=v1'
creds = Credentials.from_service_account_file(
    'service-account.json').with_scopes(SCOPES)
developer_key = 'YOUR_DEVELOPER_KEY'  # Replace with your developer key.
service = build('AdsDataHub', 'v1', credentials=creds,
                developerKey=developer_key, discoveryServiceUrl=DISCOVERY_URL)

# Replace with your ADH account ID.
adh_account_id = input('ADH account ID (e.g. "customers/123456789"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=adh_account_id).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

مراحل بعدی

  • برای نمونه پرس و جوهایی که می توانید با Ads Data Hub REST API ایجاد و اجرا کنید، به نمونه پرس و جوها در Ads Data Hub مراجعه کنید.
  • نمونه ها را گسترش دهید تا با API آشنا شوید و آن را برای مورد استفاده خود سفارشی کنید. سپس سعی کنید:
  • اگر سؤال یا بازخوردی در مورد API دارید با پشتیبانی ADH تماس بگیرید.
قبلی
حساب خود را راه اندازی کنید، حساب خود را راه اندازی کنید
بعدی
از رابط کاربری وب استفاده کنید