리소스 이름

Google Ads API에서 항목의 고유 식별자를 리소스 이름이라고 하며, 예측 가능한 형식의 문자열로 표현됩니다. 리소스 이름의 구성요소를 알고 있으면 여러 서비스 객체에 있는 도우미 메서드를 사용하여 리소스 이름을 생성할 수 있습니다.

서비스 경로 메서드

API에서 특정 유형의 객체 읽기 또는 변형을 처리하도록 설계된 모든 서비스에는 resource_name을 쉽게 구성할 수 있는 도우미 메서드가 있습니다. 예를 들어 Campaign 객체의 리소스 이름을 만드는 방법은 다음과 같습니다.

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage()
customer_id = "7892134783"
campaign_id = "1234567890"
campaign_service = client.get_service("CampaignService")
resource_name = campaign_service.campaign_path(customer_id, campaign_id)

클라이언트 라이브러리 버전 10.0.0부터 각 서비스에는 resource_name을 개별 세그먼트로 해체하는 parse_*_path 메서드도 함께 제공됩니다. 예를 들면 다음과 같습니다.

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage()
resource_name = "customers/7892134783/campaigns/1234567890"
campaign_service = client.get_service('CampaignService')
segments = campaign_service.parse_campaign_path(resource_name)
customer_id = segments["customer_id"]
campaign_id = segments["campaign_id"]

복합 리소스 이름

클라이언트 라이브러리 버전 9.0.0부터 서비스의 경로 도우미가 리소스 이름의 복합 세그먼트를 구성합니다. 복합 ID의 여러 세그먼트는 메서드에서 개별 매개변수로 허용됩니다.

from google.ads.google_ads.client import GoogleAdsClient

customer_id = "0987654321"
ad_group_id = "1234567890"
criterion_id = "74932"

client = GoogleAdsClient.load_from_storage()
ad_group_criterion_service = client.get_service("AdGroupCriterionService")

# An AdGroupCriterion resource name that uses the above IDs looks like this:
# "customers/0987654321/adGroupCriteria/1234567890~74932"
resource_name = ad_group_criterion_service.ad_group_criterion_path(
    customer_id, ad_group_id, criterion_id
)

9.0.0 이전 버전

9.0.0 이전 버전에서는 서비스의 경로 도우미가 리소스 이름의 복합 세그먼트를 구성하지 않습니다. 이러한 세그먼트는 호출자가 제공해야 합니다. 클라이언트 라이브러리에는 이 작업을 지원하는 작은 유틸리티가 있습니다.

from google.ads.google_ads.client import GoogleAdsClient
from google.ads.google_ads.util import ResourceName

customer_id = "0987654321"
ad_group_id = "1234567890"
criterion_id = "74932"

client = GoogleAdsClient.load_from_storage()
ad_group_criterion_service = client.get_service("AdGroupCriterionService")

# An AdGroupCriterion resource name that uses the above IDs looks like this:
# "customers/0987654321/adGroupCriteria/1234567890~74932"
composite_id = ResourceName.format_composite(ad_group_id, criterion_id)
resource_name = ad_group_criterion_service.ad_group_criterion_path(
    customer_id, composite_id
)