Resource Names

  • The Google Ads API uses unique identifiers called resource names to represent entities.

  • Resource names follow a predictable format and can be generated using their components.

  • The ResourceNames class allows you to construct a resource name using relevant IDs, such as customer ID and campaign ID.

  • Using entity names like campaign with appropriate IDs in the ResourceNames class generates the full resource name string.

The unique identifier for an entity in the Google Ads API is called a resource name, and is represented as a string with a predictable format. If you know the constituent components of a resource name, you can use this utility to generate the final resource name.

ResourceNames class

The ResourceNames class is a way to construct the resource name of an entity if you know all of the relevant IDs related to that entity. For example, a campaign resource name is in the format:

customers/{customer_id}/campaigns/{campaign_id}

So if you know the customer ID and the campaign ID, you can use the ResourceNames class construct the full resource name as follows:

String campaignResourceName = ResourceNames.campaign(customerId, campaignId);

You can use other entity names as well, which take different IDs depending on the final form of the resource name.