شروع کنید

Campaign Manager 360 API دسترسی برنامه‌ریزی شده به اطلاعات حساب Campaign Manager 360 شما را فراهم می‌کند. برای مدیریت و ایجاد کمپین ها و گزارش ها استفاده می شود، درست همانطور که از طریق خدمات وب Campaign Manager 360 و Report Builder استفاده می کنید.

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

پیش نیازها

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

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

  2. حساب Campaign Manager 360 شما باید برای دسترسی به API فعال باشد. اکثر حساب ها به طور پیش فرض این را فعال کرده اند. اگر مطمئن نیستید، برای راهنمایی با نماینده حساب خود یا تیم پشتیبانی Campaign Manager 360 تماس بگیرید.

  3. شما باید یک نمایه کاربری با دسترسی به این حساب داشته باشید. از سرپرست حساب Campaign Manager 360 خود بخواهید یک نمایه کاربری مرتبط با این حساب ایجاد کند.

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

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

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

اعتبارنامه تولید کنید

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

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

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

  2. صفحه Credentials را در کنسول API باز کنید.

  3. روی ایجاد اعتبار > شناسه مشتری OAuth کلیک کنید.

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

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

    3. فرم اولیه را پر کنید. در صورت نیاز می توانید بعداً این را ویرایش کنید. پس از اتمام روی ذخیره کلیک کنید.

    4. برای ادامه به Credentials > CREATE CREDENTIALS > OAuth Client ID برگردید.

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

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

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

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

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

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

سی شارپ

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

کنسول NuGet Package Manager را باز کنید و دستور زیر را اجرا کنید:

Install-Package Google.Apis.Dfareporting.v3_4

بیشتر بدانید

جاوا

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

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

<dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v4-rev20220611-1.32.1</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 اضافه کنید.

بیشتر بدانید

پایتون

آخرین کتابخانه سرویس گیرنده Campaign Manager 360 API را برای پایتون نصب کنید. استفاده از pip برای مدیریت نصب توصیه می شود.

یک ترمینال را باز کنید و دستور زیر را اجرا کنید:

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

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

بیشتر بدانید

روبی

آخرین کتابخانه سرویس گیرنده 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 هستید. با دنبال کردن راه اندازی سریع زیر، نحوه مجوز، پیکربندی مشتری و اولین درخواست خود را بیاموزید.

سی شارپ

  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.Load(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);

// 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()
    );
}

پایتون

  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', 'v4', 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']))

روبی

  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 ارائه می دهد، به مرجع API مراجعه کنید. هر صفحه جزئیات روش دارای یک API Explorer تعبیه شده است که می توانید از آن برای ایجاد درخواست های آزمایشی مستقیماً از مرورگر خود استفاده کنید.

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

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