リソース名

Google Ads API におけるエンティティの固有識別子は、リソースと呼ばれます。 予測可能な形式の文字列として表されます。ご存じの場合 各要素を表す場合は、リソース名を 多くの Service オブジェクトに存在するヘルパー メソッドを使用します。

サービスパス メソッド

特定の種類の読み取りまたは変更を処理するように設計されたすべてのサービス API のオブジェクトには、簡単に作成できるようにするヘルパー メソッドが備わっています。 resource_names です。たとえば、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 以降のクライアント ライブラリでは、各サービスに 付属の parse_*_path メソッドを使用すると、resource_name を名前に分解できます。 追加することもできます。たとえば、

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
)