مشتری خود را نصب و پیکربندی کنید

توصیه می‌کنیم از کتابخانه‌های کلاینت Google API به همراه Display & Video 360 API استفاده کنید. با استفاده از کتابخانه‌های کلاینت، لازم نیست درخواست‌های HTTP را به صورت دستی ارسال کرده و پاسخ‌ها را تجزیه کنید. کتابخانه‌های کلاینت می‌توانند ادغام زبان بهتر، امنیت بهبود یافته و پشتیبانی از برقراری تماس‌هایی که نیاز به مجوز کاربر دارند را فراهم کنند.

رابط برنامه‌نویسی کاربردی نمایشگر و ویدئو ۳۶۰ درجه (Display & Video 360 API) بر پایه HTTP و JSON ساخته شده است. در صورت تمایل، می‌توانید از هر کلاینت HTTP استانداردی برای ارسال درخواست و تجزیه پاسخ‌ها استفاده کنید.

نصب کتابخانه کلاینت

ما کتابخانه‌های کلاینتی ارائه می‌دهیم که از رابط برنامه‌نویسی کاربردی Display & Video 360 در زبان‌های برنامه‌نویسی مختلف پشتیبانی می‌کنند. برای مشاهده لیست کامل کتابخانه‌های کلاینت، به صفحه نمونه‌ها و کتابخانه‌های ما مراجعه کنید.

راهنماهای توسعه‌دهندگان Display & Video 360 API قطعه کدهایی را برای زبان‌های زیر ارائه می‌دهند:

• جاوا
• پایتون
• پی اچ پی

علاوه بر قطعه کدهای موجود در راهنماهای ما، ما نمونه‌های کاملی از ادغام در این زبان‌ها را ارائه می‌دهیم. برای مشاهده این نمونه‌ها ، به نمونه‌های Display & Video 360 API در مخزن گیت‌هاب ما مراجعه کنید.

کلاینت خود را پیکربندی کنید

با اعتبارنامه‌های OAuth 2.0 و یک کتابخانه کلاینت نصب‌شده ، شما آماده استفاده از Display & Video 360 API هستید. در اینجا نحوه‌ی احراز هویت و پیکربندی کلاینت شما آمده است:

جاوا

1. کتابخانه‌های لازم را وارد کنید.

   import static java.nio.charset.StandardCharsets.UTF_8;
   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.util.Utils;
   import com.google.api.services.displayvideo.v4.DisplayVideo;
   import com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers;
   import com.google.api.services.displayvideo.v4.model.Advertiser;
   import com.google.api.services.displayvideo.v4.model.ListAdvertisersResponse;
   import java.io.Reader;
   import java.nio.file.Files;
   import java.nio.file.Paths;
   

2. فایل اسرار کلاینت را بارگذاری کنید و اعتبارنامه‌های مجوز را ایجاد کنید.

   اولین باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود که درخواست مجوز را در مرورگر خود بپذیرید. قبل از پذیرش، مطمئن شوید که با یک حساب گوگل که به Display & Video 360 دسترسی دارد، وارد سیستم شده‌اید. برنامه شما مجاز خواهد بود از طرف هر حسابی که در حال حاضر وارد سیستم شده است، به داده‌ها دسترسی داشته باشد. برای جزئیات بیشتر به راهنمای مفهوم مجوزهای کاربر ما مراجعه کنید.

   // Read client secrets file.
   GoogleClientSecrets clientSecrets;
   try (Reader reader = Files.newBufferedReader(Paths.get(path-to-client-secrets-file), UTF_8)) {
     clientSecrets = GoogleClientSecrets.load(Utils.getDefaultJsonFactory(), reader);
   }
   
   // Generate authorization credentials.
   // Set up the authorization code flow.
   GoogleAuthorizationCodeFlow flow =
       new GoogleAuthorizationCodeFlow.Builder(
           Utils.getDefaultTransport(),
           Utils.getDefaultJsonFactory(),
           clientSecrets,
           oauth-scopes)
       .build();
   
   Credential credential =
       new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
   

3. یک کلاینت API مجاز ایجاد کنید.

   // Create authorized API client.
   DisplayVideo service =
       new DisplayVideo.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
           .setApplicationName("displayvideo-java-installed-app-sample")
           .build();
   

پایتون

1. کتابخانه‌های لازم را وارد کنید.

   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient import discovery
   

2. فایل اسرار کلاینت را بارگذاری کنید و اعتبارنامه‌های مجوز را ایجاد کنید.

   اولین باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود که درخواست مجوز را در مرورگر خود بپذیرید. قبل از پذیرش، مطمئن شوید که با یک حساب گوگل که به Display & Video 360 دسترسی دارد، وارد سیستم شده‌اید. برنامه شما مجاز خواهد بود از طرف هر حسابی که در حال حاضر وارد سیستم شده است، به داده‌ها دسترسی داشته باشد. برای جزئیات بیشتر به راهنمای مفهوم مجوزهای کاربر ما مراجعه کنید.

   # Set up a flow object to create the credentials using the
   # client secrets file and OAuth scopes.
   credentials = InstalledAppFlow.from_client_secrets_file(
       path-to-client-secrets-file, oauth-scopes).run_local_server()
   

3. یک کلاینت API مجاز ایجاد کنید.

   # Build the discovery document URL.
   discovery_url = f'https://displayvideo.googleapis.com/$discovery/rest?version=v4'
   
   # Build the API service.
   service = discovery.build(
       'displayvideo',
       'v4',
       discoveryServiceUrl=discovery_url,
       credentials=credentials)
   

پی اچ پی

این نمونه فرض می‌کند که شما PHP را با یک وب سرور داخلی اجرا می‌کنید و اعتبارنامه‌های خود را برای هدایت به صفحه وب مربوطه پیکربندی کرده‌اید. برای مثال، این کد، در یک فایل index.php ، می‌تواند با استفاده از دستور زیر و اعتبارنامه‌های پیکربندی شده برای هدایت به http://localhost:8000 پس از احراز هویت، اجرا شود:

php -S localhost:8000 -t ./

1. کلاینت PHP API گوگل را دانلود و نصب کنید.

   روش ترجیحی استفاده از Composer است:

   composer require google/apiclient:^2.18.2 google/apiclient-services:=0.396.0

   پس از نصب، حتماً autoloader را فعال کنید:

   require_once '/path/to/your-project/vendor/autoload.php';
   

2. یک شیء Google_Client ایجاد کنید.

   $client = new Google_Client();
   

3. کلاینت را تنظیم کنید، در صورت نیاز به URL احراز هویت هدایت شوید و یک توکن دسترسی دریافت کنید.

   اولین باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود که درخواست مجوز را در مرورگر خود بپذیرید. قبل از پذیرش، مطمئن شوید که با یک حساب گوگل که به Display & Video 360 دسترسی دارد، وارد سیستم شده‌اید. برنامه شما مجاز خواهد بود از طرف هر حسابی که در حال حاضر وارد سیستم شده است، به داده‌ها دسترسی داشته باشد. برای جزئیات بیشتر به راهنمای مفهوم مجوزهای کاربر ما مراجعه کنید.

   // Set up the client.
   $client->setApplicationName('DV360 API PHP Samples');
   $client->addScope(oauth-scope);
   $client->setAccessType('offline');
   $client->setAuthConfigFile(path-to-client-secrets-file);
   
   // If the code is passed, authenticate. If not, redirect to authentication page.
   if (isset($_GET['code'])) {
     $client->authenticate($_GET['code']);
   } else {
     $authUrl = $client->createAuthUrl();
     header('Location: ' . $authUrl);
   }
   
   // Exchange authorization code for an access token.
   $accessToken = $client->getAccessToken();
   $client->setAccessToken($accessToken);
   

4. یک کلاینت برای سرویس Display & Video 360 API بسازید.

   $service = new Google_Service_DisplayVideo($client);