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

با ایجاد اعتبارنامه 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.v3.DisplayVideo;
    import com.google.api.services.displayvideo.v3.DisplayVideo.Advertisers;
    import com.google.api.services.displayvideo.v3.model.Advertiser;
    import com.google.api.services.displayvideo.v3.model.ListAdvertisersResponse;
    import java.io.Reader;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
  2. فایل اسرار مشتری را بارگیری کنید و اعتبارنامه مجوز ایجاد کنید.

    اولین باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود که درخواست مجوز را در مرورگر خود بپذیرید. قبل از پذیرش، مطمئن شوید که با یک حساب Google وارد سیستم شده‌اید که به Display & Video 360 دسترسی دارد. برنامه شما مجاز خواهد بود از طرف هر حسابی که در حال حاضر وارد سیستم شده است به داده‌ها دسترسی داشته باشد. برای جزئیات بیشتر به راهنمای درخواست‌های مجوز ما مراجعه کنید. مجوزهای کاربر 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();
    
  4. یک عملیات انجام دهید.

    // Perform an operation.
    // Retrieve and print the first ten advertisers under a partner.
    ListAdvertisersResponse response =
        service
            .advertisers()
            .list()
            .setPartnerId(partner-id)
            .setPageSize(10)
            .execute();
    if (response.getAdvertisers().size() > 0) {
      for (int i = 0; i < response.getAdvertisers().size(); i++) {
        System.out.printf(
            "ID: %s Display Name: %s%n",
            response.getAdvertisers().get(i).getAdvertiserId(),
            response.getAdvertisers().get(i).getDisplayName());
      }
    } else {
      System.out.print("No advertisers found.");
    }
    

پایتون

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

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. فایل اسرار مشتری را بارگیری کنید و اعتبارنامه مجوز ایجاد کنید.

    اولین باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود که درخواست مجوز را در مرورگر خود بپذیرید. قبل از پذیرش، مطمئن شوید که با یک حساب Google وارد سیستم شده‌اید که به Display & Video 360 دسترسی دارد. برنامه شما مجاز خواهد بود از طرف هر حسابی که در حال حاضر وارد سیستم شده است به داده‌ها دسترسی داشته باشد. برای جزئیات بیشتر به راهنمای درخواست‌های مجوز ما مراجعه کنید. مجوزهای کاربر 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=v3'
    
    # Build the API service.
    service = discovery.build(
        'displayvideo',
        'v3',
        discoveryServiceUrl=discovery_url,
        credentials=credentials)
    
  4. یک عملیات انجام دهید.

    # Build advertisers.list request.
    request = service.advertisers().list(
        partnerId=partner-id, pageSize='10')
    
    # Execute request.
    response = request.execute()
    
    # Print response.
    if len(response['advertisers']) > 0:
      for advertiser in response['advertisers']:
        print(f'ID: {advertiser["advertiserId"]} Display Name: {advertiser["displayName"]}')
    else:
      print('No advertisers found.')
    

PHP

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

php -S localhost:8000 -t ./

  1. Google API PHP Client را دانلود و نصب کنید.

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

    composer require google/apiclient:^2.15.1 google/apiclient-services:=0.332.0
    

    پس از نصب، حتماً Autoloader را در آن قرار دهید:

    require_once '/path/to/your-project/vendor/autoload.php';
    
  2. یک شی Google_Client ایجاد کنید.

    $client = new Google_Client();
    
  3. کلاینت را تنظیم کنید، در صورت نیاز به URL احراز هویت هدایت کنید و یک نشانه دسترسی را بازیابی کنید.

    اولین باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود که درخواست مجوز را در مرورگر خود بپذیرید. قبل از پذیرش، مطمئن شوید که با یک حساب Google وارد سیستم شده‌اید که به Display & Video 360 دسترسی دارد. برنامه شما مجاز خواهد بود از طرف هر حسابی که در حال حاضر وارد سیستم شده است به داده‌ها دسترسی داشته باشد. برای جزئیات بیشتر به راهنمای درخواست‌های مجوز ما مراجعه کنید. مجوزهای کاربر 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);
    
  5. یک عملیات انجام دهید.

    // Configure params for the advertisers.list request.
    $optParams = array('pageSize' => 10, 'partnerId' => partner-id);
    
    // Execute the request.
    $result = $service->advertisers->listAdvertisers($optParams);
    
    // Print the retrieved advertisers.
    if (!empty($result->getAdvertisers())) {
      print('<pre>');
      foreach ($result->getAdvertisers() as $advertiser) {
        printf('<p>ID: %s, Display Name: %s</p>', $advertiser->advertiserId, $advertiser->displayName);
      }
      print('</pre>');
    } else {
      print '<p>No advertisers found.</p>';
    }