شروع به کار

میانای برنامه‌سازی کاربردی Campaign Manager 360 دسترسی برنامه‌ریزی‌شده‌ای به اطلاعات حساب Campaign Manager 360 شما ارائه می‌دهد. از آن برای مدیریت و ایجاد پویش‌ها و گزارش‌ها استفاده می‌شود، درست همان‌طور که ازطریق سرویس‌های وب «مدیر پویش ۳۶۰» و «گزارش‌ساز» انجام می‌دهید.

این راهنما نحوه شروع به کار با Campaign Manager 360 API را شرح می‌دهد.

پیش‌نیازها

قبل‌از استفاده از Campaign Manager 360 API، چند مرحله پیش‌نیاز وجود دارد که باید آن‌ها را انجام دهید:

  1. باید حساب Campaign Manager 360 داشته باشید. برای اطلاعات ثبت‌نام، به آگهی‌دهندگان/کارگزاری‌ها مراجعه کنید.

  2. حساب Campaign Manager 360 شما باید برای «دسترسی به میانای برنامه‌سازی کاربردی» فعال شده باشد. این ویژگی به‌طور پیش‌فرض برای اکثر حساب‌ها فعال است؛ اگر مطمئن نیستید، با نماینده حسابتان یا تیم پشتیبانی Campaign Manager 360 تماس بگیرید تا به شما کمک کنند.

  3. باید نمایه کاربری با دسترسی به این حساب داشته باشید. از سرپرست حساب «مدیر کمپین ۳۶۰» خود بخواهید نمایه کاربری مرتبط با این حساب ایجاد کند.

  4. اجازه‌های نمایه کاربر را در واسط کاربر Campaign Manager 360 بررسی کنید. این‌ها کنترل می‌کنند نمایه کاربر به چه چیزهایی از میانای برنامه‌سازی کاربردی دسترسی داشته باشد. اجازه‌های API جداگانه‌ای وجود ندارد.

ایجاد کردن پروژه

برای شروع استفاده از Campaign Manager 360 API، ابتدا باید پروژه‌ای را در Google API Console ایجاد یا انتخاب کنید و API را فعال کنید. استفاده از این پیوند شما را درطول فرایند راهنمایی می‌کند و Campaign Manager 360 API را به‌طور خودکار فعال می‌کند.

تولید کردن اطلاعات کاربری

همه درخواست‌هایی که به Campaign Manager 360 API ارسال می‌کنید باید مجاز باشند. برای مروری کوتاه بر صدور مجوز، درباره نحوه صدور مجوز و شناسایی برنامه‌تان برای Google مطالعه کنید.

دستورالعمل‌های زیر شما را در فرایند ایجاد شناسه کارخواه OAuth 2.0 برای استفاده با جریان برنامه نصب‌شده راهنمایی می‌کند. برای دریافت دستورالعمل‌های مربوط به تولید اطلاعات کاربری برای استفاده با جریان حساب خدمات، به راهنمای حساب‌های خدمات مراجعه کنید.

  1. مراحل پیکربندی پروژه «کنسول Google API» را دنبال کنید.

  2. صفحه اطلاعات کاربری را در «کنسول API» باز کنید.
  3. روی ایجاد اعتبارنامه > شناسه کارخواه OAuth کلیک کنید.

    1. اگر قبلاً صفحه رضایت OAuth را برای این پروژه پیکربندی نکرده‌اید، اکنون برای انجام این کار هدایت می‌شوید. روی پیکربندی صفحه رضایت کلیک کنید.

    2. نوع کاربر را انتخاب کنید و روی ایجاد کلیک کنید.

    3. فرم اولیه را تکمیل کنید. درصورت نیاز می‌توانید این مورد را بعداً ویرایش کنید. وقتی انجام شد، روی ذخیره کلیک کنید.

    4. برای ادامه، به اعتبارنامه‌ها > ایجاد اعتبارنامه > شناسه کارخواه OAuth برگردید.

  4. برنامه رایانه‌ای را به‌عنوان نوع برنامه انتخاب کنید، نامی برای آن انتخاب کنید، سپس روی ایجاد کلیک کنید.

وقتی تمام شد، شناسه کارخواه OAuth 2.0 و رمز کارخواه به شما ارائه می‌شود که می‌توانید آن را در قالب JSON بارگیری کنید و برای استفاده بعدی ذخیره کنید.

نصب کتابخانه کارخواه

‫Campaign Manager 360 API برپایه HTTP و JSON ساخته شده است، بنابراین هر کارخواه HTTP استانداردی می‌تواند به آن درخواست ارسال کند و پاسخ‌ها را تجزیه کند.

بااین‌حال، کتابخانه‌های کارخواه Google API ادغام زبانی بهتر، امنیت بهبودیافته، و پشتیبانی برای ایجاد درخواست‌های مجاز را ارائه می‌دهند. کتابخانه‌های کارخواه به چند زبان برنامه‌نویسی دردسترس هستند؛ بااستفاده از آن‌ها می‌توانید از نیاز به راه‌اندازی دستی درخواست‌های HTTP و تجزیه پاسخ‌ها اجتناب کنید.

برای شروع، زبان برنامه‌نویسی‌ای را که برای توسعه استفاده می‌کنید انتخاب کنید.

C#‎

جدیدترین کتابخانه کارخواه Campaign Manager 360 API برای NET. را نصب کنید. توصیه می‌شود برای مدیریت نصب از NuGet استفاده کنید.

«کنسول مدیر بسته NuGet» را باز کنید و فرمان زیر را اجرا کنید:

Install-Package Google.Apis.Dfareporting.v5

بیشتر بدانید

جاوا

جدیدترین کتابخانه کارخواه Campaign Manager 360 API برای Java را نصب کنید. توصیه می‌شود از Maven برای مدیریت نصب استفاده کنید.

وابستگی زیر را به فایل pom.xml خود اضافه کنید:

<dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v5-rev20260511-2.0.0</version>
  <exclusions>
    <exclusion>
      <groupId>com.google.guava</groupId>
      <artifactId>guava-jdk5</artifactId>
    </exclusion>
  </exclusions>
</dependency>

بیشتر بدانید

PHP

جدیدترین کتابخانه کارخواه Campaign Manager 360 API برای PHP را نصب کنید. توصیه می‌شود از Composer برای مدیریت نصب استفاده کنید.

پایانه‌ای را باز کنید و فرمان زیر را اجرا کنید:

composer require google/apiclient

اگر قبلاً کتابخانه را نصب کرده‌اید و فقط می‌خواهید آن را به جدیدترین نسخه به‌روز کنید:

composer update google/apiclient

بسته به سیستم شما، ممکن است لازم باشد این فرمان‌ها را با sudo پیش‌افزایی کنید.

بیشتر بدانید

Python

جدیدترین کتابخانه کارخواه Campaign Manager 360 API برای Python را نصب کنید. توصیه می‌شود از pip برای مدیریت نصب استفاده کنید.

پایانه‌ای را باز کنید و فرمان زیر را اجرا کنید:

pip install --upgrade google-api-python-client

بسته به سیستم شما، ممکن است لازم باشد این فرمان‌ها را با sudo پیش‌افزایی کنید.

بیشتر بدانید

Ruby

جدیدترین کتابخانه کارخواه Campaign Manager 360 API برای Ruby را نصب کنید. توصیه می‌شود برای مدیریت نصب از RubyGems استفاده کنید.

پایانه‌ای را باز کنید و فرمان زیر را اجرا کنید:

gem install google-api-client

اگر قبلاً کتابخانه را نصب کرده‌اید و فقط می‌خواهید آن را به جدیدترین نسخه به‌روز کنید:

gem update -y google-api-client

بسته به سیستم شما، ممکن است لازم باشد این فرمان‌ها را با sudo پیش‌افزایی کنید.

بیشتر بدانید

زبان‌های پشتیبانی‌شده بیشتر را می‌توانید در صفحه کتابخانه‌های مشتری پیدا کنید.

درخواست دادن

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

C#‎

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

    اولین‌باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود پیام‌واره صدور مجوز را در مرورگرتان بپذیرید. قبل‌از پذیرفتن، مطمئن شوید با «حساب Google» که به Campaign Manager 360 دسترسی دارد به سیستم وارد شده‌اید. برنامه شما مجاز خواهد بود ازطرف هر حسابی که درحال‌حاضر به سیستم وارد شده است به داده‌ها دسترسی داشته باشد.

    // Load client secrets from the specified JSON file.
    GoogleClientSecrets clientSecrets;
    using(Stream json = new FileStream(pathToJsonFile, FileMode.Open, FileAccess.Read)) {
      clientSecrets = GoogleClientSecrets.FromStream(json);
    }
    
    // Create an asynchronous authorization task.
    //
    // Note: providing a data store allows auth credentials to be cached, so they survive multiple
    // runs of the application. This avoids prompting the user for authorization every time the
    // access token expires, by remembering the refresh token. The "user" value is used to
    // identify a specific set of credentials within the data store. You may provide different
    // values here to persist credentials for multiple users to the same data store.
    Task<UserCredential> authorizationTask = GoogleWebAuthorizationBroker.AuthorizeAsync(
        clientSecrets.Secrets,
        OAuthScopes,
        "user",
        CancellationToken.None,
        dataStore,
        new ManualCodeReceiver());
    
    // Authorize and persist credentials to the data store.
    UserCredential credential = authorizationTask.Result;
  2. یک کارخواه Dfareporting مجاز ایجاد کنید.

    // Create a Dfareporting service object.
    //
    // Note: application name should be replaced with a value that identifies your application.
    service = new DfareportingService(
        new BaseClientService.Initializer {
          HttpClientInitializer = credential,
          ApplicationName = "C# installed app sample"
        }
    );
  3. انجام عملیات.

    // Retrieve and print all user profiles for the current authorized user.
    UserProfileList profiles = service.UserProfiles.List().Execute();
    
    foreach (UserProfile profile in profiles.Items) {
      Console.WriteLine("Found user profile with ID {0} and name \"{1}\".",
          profile.ProfileId, profile.UserName);
    }

جاوا

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

    اولین‌باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود پیام‌واره صدور مجوز را در مرورگرتان بپذیرید. قبل‌از پذیرفتن، مطمئن شوید با «حساب Google» که به Campaign Manager 360 دسترسی دارد به سیستم وارد شده‌اید. برنامه شما مجاز خواهد بود ازطرف هر حسابی که درحال‌حاضر به سیستم وارد شده است به داده‌ها دسترسی داشته باشد.

    // Load the client secrets JSON file.
    GoogleClientSecrets clientSecrets =
        GoogleClientSecrets.load(
            jsonFactory, Files.newBufferedReader(Paths.get(pathToClientSecretsFile), UTF_8));
    
    // Set up the authorization code flow.
    //
    // Note: providing a DataStoreFactory allows auth credentials to be cached, so they survive
    // multiple runs of the program. This avoids prompting the user for authorization every time the
    // access token expires, by remembering the refresh token.
    GoogleAuthorizationCodeFlow flow =
        new GoogleAuthorizationCodeFlow.Builder(
                httpTransport, jsonFactory, clientSecrets, OAUTH_SCOPES)
            .setDataStoreFactory(dataStoreFactory)
            .build();
    
    // Authorize and persist credentials to the data store.
    //
    // Note: the "user" value below is used to identify a specific set of credentials in the data
    // store. You may provide different values here to persist credentials for multiple users to
    // the same data store.
    Credential credential =
        new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
  2. یک کارخواه Dfareporting مجاز ایجاد کنید.

    // Create a Dfareporting client instance.
    //
    // Note: application name below should be replaced with a value that identifies your
    // application. Suggested format is "MyCompany-ProductName/Version.MinorVersion".
    Dfareporting reporting =
        new Dfareporting.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("dfareporting-java-installed-app-sample")
            .build();
  3. انجام عملیات.

    // Retrieve and print all user profiles for the current authorized user.
    UserProfileList profiles = reporting.userProfiles().list().execute();
    for (int i = 0; i < profiles.getItems().size(); i++) {
      System.out.printf("%d) %s%n", i + 1, profiles.getItems().get(i).getUserName());
    }

PHP

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

    اولین‌باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود پیام‌واره صدور مجوز را در مرورگرتان بپذیرید. قبل‌از پذیرفتن، مطمئن شوید با «حساب Google» که به Campaign Manager 360 دسترسی دارد به سیستم وارد شده‌اید. برنامه شما مجاز خواهد بود ازطرف هر حسابی که درحال‌حاضر به سیستم وارد شده است به داده‌ها دسترسی داشته باشد.

    // Create a Google_Client instance.
    //
    // Note: application name should be replaced with a value that identifies
    // your application. Suggested format is "MyCompany-ProductName".
    $client = new Google_Client();
    $client->setAccessType('offline');
    $client->setApplicationName('PHP installed app sample');
    $client->setRedirectUri(self::OAUTH_REDIRECT_URI);
    $client->setScopes(self::$OAUTH_SCOPES);
    
    // Load the client secrets file.
    $client->setAuthConfig($pathToJsonFile);
    
    // Try to load cached credentials from the token store. Using a token store
    // allows auth credentials to be cached, so they survive multiple runs of
    // the application. This avoids prompting the user for authorization every
    // time the access token expires, by remembering the refresh token.
    if (file_exists($tokenStore) && filesize($tokenStore) > 0) {
        $client->setAccessToken(file_get_contents($tokenStore));
    } else {
        // If no cached credentials were found, authorize and persist
        // credentials to the token store.
        print 'Open this URL in your browser and authorize the application.';
        printf("\n\n%s\n\n", $client->createAuthUrl());
        print 'Enter the authorization code: ';
        $code = trim(fgets(STDIN));
        $client->authenticate($code);
    
        file_put_contents($tokenStore, json_encode($client->getAccessToken()));
    }
  2. یک کارخواه Dfareporting مجاز ایجاد کنید.

    // Create a Dfareporting service object.
    $service = new Google_Service_Dfareporting($client);
  3. انجام عملیات.

    // Retrieve and print all user profiles for the current authorized user.
    $result = $service->userProfiles->listUserProfiles();
    foreach ($result['items'] as $userProfile) {
        printf(
            "User profile \"%s\" (ID: %d) found for account %d.\n",
            $userProfile->getUserName(),
            $userProfile->getProfileId(),
            $userProfile->getAccountId()
        );
    }

Python

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

    اولین‌باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود پیام‌واره صدور مجوز را در مرورگرتان بپذیرید. قبل‌از پذیرفتن، مطمئن شوید با «حساب Google» که به Campaign Manager 360 دسترسی دارد به سیستم وارد شده‌اید. برنامه شما مجاز خواهد بود ازطرف هر حسابی که درحال‌حاضر به سیستم وارد شده است به داده‌ها دسترسی داشته باشد.

    # Set up a Flow object to be used if we need to authenticate.
    flow = client.flow_from_clientsecrets(
        path_to_client_secrets_file, scope=OAUTH_SCOPES)
    
    # Check whether credentials exist in the credential store. Using a credential
    # store allows auth credentials to be cached, so they survive multiple runs
    # of the application. This avoids prompting the user for authorization every
    # time the access token expires, by remembering the refresh token.
    storage = Storage(CREDENTIAL_STORE_FILE)
    credentials = storage.get()
    
    # If no credentials were found, go through the authorization process and
    # persist credentials to the credential store.
    if credentials is None or credentials.invalid:
      credentials = tools.run_flow(flow, storage,
                                   tools.argparser.parse_known_args()[0])
    
    # Use the credentials to authorize an httplib2.Http instance.
    http = credentials.authorize(httplib2.Http())
  2. یک کارخواه Dfareporting مجاز ایجاد کنید.

    # Construct a service object via the discovery service.
    service = discovery.build('dfareporting', 'v5', http=http)
  3. انجام عملیات.

    # Construct the request.
    request = service.userProfiles().list()
    
    # Execute request and print response.
    response = request.execute()
    
    for profile in response['items']:
      print('Found user profile with ID %s and user name "%s".' %
            (profile['profileId'], profile['userName']))

Ruby

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

    اولین‌باری که این مرحله را انجام می‌دهید، از شما خواسته می‌شود پیام‌واره صدور مجوز را در مرورگرتان بپذیرید. قبل‌از پذیرفتن، مطمئن شوید با «حساب Google» که به Campaign Manager 360 دسترسی دارد به سیستم وارد شده‌اید. برنامه شما مجاز خواهد بود ازطرف هر حسابی که درحال‌حاضر به سیستم وارد شده است به داده‌ها دسترسی داشته باشد.

    # Load client ID from the specified file.
    client_id = Google::Auth::ClientId.from_file(path_to_json_file)
    
    # Set up the user authorizer.
    #
    # Note: providing a token store allows auth credentials to be cached, so they
    # survive multiple runs of the application. This avoids prompting the user for
    # authorization every time the access token expires, by remembering the
    # refresh token.
    authorizer = Google::Auth::UserAuthorizer.new(
      client_id, [API_NAMESPACE::AUTH_DFAREPORTING], token_store
    )
    
    # Authorize and persist credentials to the data store.
    #
    # Note: the 'user' value below is used to identify a specific set of
    # credentials in the token store. You may provide different values here to
    # persist credentials for multiple users to the same token store.
    authorization = authorizer.get_credentials('user')
    if authorization.nil?
      puts format(
        "Open this URL in your browser and authorize the application.\n\n%s" \
        "\n\nEnter the authorization code:",
        authorizer.get_authorization_url(base_url: OAUTH_REDIRECT_URI)
      )
      code = STDIN.gets.chomp
      authorization = authorizer.get_and_store_credentials_from_code(
        base_url: OAUTH_REDIRECT_URI, code: code, user_id: 'user'
      )
    end
  2. یک کارخواه Dfareporting مجاز ایجاد کنید.

    # Create a Dfareporting service object.
    #
    # Note: application name should be replaced with a value that identifies
    # your application. Suggested format is "MyCompany-ProductName".
    service = API_NAMESPACE::DfareportingService.new
    service.authorization = authorization
    service.client_options.application_name = 'Ruby installed app sample'
    service.client_options.application_version = '1.0.0'
  3. انجام عملیات.

    // Retrieve and print all user profiles for the current authorized user.
    UserProfileList profiles = service.UserProfiles.List().Execute();
    
    foreach (UserProfile profile in profiles.Items) {
      Console.WriteLine("Found user profile with ID {0} and name \"{1}\".",
          profile.ProfileId, profile.UserName);
    }

بیشتر بدانید

برای آشنایی با همه سرویس‌هایی که میانای برنامه‌سازی کاربردی ارائه می‌دهد، به مرجع میانای برنامه‌سازی کاربردی مراجعه کنید. هر صفحه جزئیات روش دارای یک API Explorer جاسازی‌شده است که می‌توانید از آن برای ارسال درخواست‌های آزمایشی مستقیماً از مرورگر خود استفاده کنید.

راهنماهای دیگر ما را که موضوعات پیشرفته را پوشش می‌دهند و نمونه‌های سرتاسری برای کارهای رایج ارائه می‌دهند مرور کنید.

وقتی آماده شروع نوشتن کد بودید، می‌توانید مجموعه گسترده نمونه کدهای ما را کاوش کنید که ممکن است برای مطابقت با نیازهایتان اصلاح و گسترش داده شوند.