$ yarn add google-ads-apiThe official Google Ads client libraries are robust, but they don't always offer the most user-friendly developer interfaces, and their documentation can be confusing.
\nThis library aims to offer a better way to use the Google Ads API.
\ngoogle-ads-node to provide a better developer experience.We aim to release new versions of this library within a few weeks of new API versions becoming available. These are the releases so far:
\n4.0.0 and above of this library3.6.0 to 3.7.4 of this library3.0.0 to 3.5.2 of this library2.3.0 to 2.3.0 of this library2.1.0 to 2.2.0 of this library1.2.0 to 2.0.0 of this library1.0.0 to 1.0.2 of this library Before you can use the Google Ads API, you'll need to gather some authentication. You'll need:
\nThen, for every Google Ads account you want to access, you'll need:
\nxxx-xxx-xxxx.xxx-xxx-xxxx.import { GoogleAdsApi } from 'google-ads-api'\n\nconst client = new GoogleAdsApi({\n client_id: '<YOUR_CLIENT_ID>',\n client_secret: '<YOUR_CLIENT_SECRET>',\n developer_token: '<YOUR_DEVELOPER_TOKEN>',\n})\n\nconst customer = client.Customer({\n customer_account_id: '123-123-123',\n login_customer_id: '456-456-456', // Optionally provide a login-customer-id\n linked_customer_id: '789-789-789', // Optionally provide a linked-customer-id\n refresh_token: '<YOUR_REFRESH_TOKEN>',\n})\n\n// If done correctly, you should now be able to list the campaigns in the account 123-123-123\ncustomer.campaigns.list()\"Reporting\" just means fetching data about an account.
\nAll data in Google Ads is queriable via SQL-like tables. There is one table per resource (such as campaign or ad_group_ad).\nThese tables and their associated fields can be found in the core resources section of this page, or in the \"API Fields\"\nsection of the official docs.
There are four types of resources available for querying.
\ncampaign, ad_group_criterion.keyword_view is a subset of ad_group_criterion, while age_range_view is a subset of campaign_criterion.click_view, search_term_view.geo_target_constant, mobile_device_constant.Resources contain three types of fields:
\nmetrics.clicks or metrics.historical_quality_score. segments.device or segments.conversion_action. campaign.name or ad_group_criterion.keyword.text.The customer.query() method allows you to query customer data using GAQL (Google Ads Query Language) query strings. This is great for prototyping and getting results out quickly.
GAQL looks like SQL, but it is not SQL. Key differences include:
\nOR in constraints).selectableWith fields. These aren't always intuitive. This file holds a complete list of which fields are usable for each resource.// Basic query\nconst campaigns = await customer.query(`\n SELECT \n campaign.name, campaign.status\n FROM \n campaign\n`)\n\n// More complex query\nconst keyword_texts = await customer.query(`\n SELECT \n keyword_view.resource_name,\n ad_group_criterion.keyword.text <-- This is an implicit join on ad_group_criterion\n FROM \n keyword_view <-- Main resource\n WHERE \n campaign.status = 'PAUSED' <-- This is another implicit join on campaign\n AND metrics.impressions > 5\n ORDER BY campaign.impressions\n LIMIT 20\n`)For a definition of the arguments and return types for customer.query(), see the customer core resource.
The customer.report() method is a safer and more structured way to use GAQL. It's also more practical to use when your queries need to be built dynamically. If you are using typescript, it will give you handy autocomplete, too!
const response = await customer.report({\n entity: 'ad_group', \n attributes: ['ad_group.id', 'ad_group.name', 'ad_group.status'], \n metrics: ['metrics.clicks'],\n segments: ['segments.date'], \n constraints: { 'ad_group.status': enums.AdGroupStatus.ENABLED }, \n from_date: '2019-01-01', \n order_by: 'metrics.clicks', \n sort_order: 'desc',\n limit: 5, \n})For full infomation on the arguments of customer.report(), see the customer core resource.
Every core resource also has get() and list() methods, which offer a convenient way to select every attribute of a resource. This can be quite valuable since GAQL does not support SELECT *. See the campaign core resource for an example.
The customer.reportStream() method is equivalent to customer.report(), except that it returns an async generator that you can use to access rows of data as they come back from the API.
Unlike report(), reportStream() does not support the page_size argument.
The main advantage of reportStream is performance. Not only are you able to get rows before the entire set has finished downloading, but the total time to finish the request will be shorter, especially for large requests (10,000+ rows).
Unfortunately, Google has hardwired the stream's chunk size to 10,000 rows, so there is no benefit to streaming for smaller requests. We're working with them to find a solution.
\ninterface SearchTermView {\n search_term_view: {\n resource_name: string\n search_term: string\n }\n metrics: {\n clicks: number\n }\n}\n\nconst generator = customer.reportStream<SearchTermView>({\n entity: 'search_term_view',\n metrics: ['metrics.clicks'],\n attributes: ['search_term_view.search_term'],\n order_by: 'metrics.clicks',\n sort_order: 'desc',\n})\n\nfor await (let item of generator) {\n // process each SearchTermView\n}For full infomation on the arguments of customer.report(), see the customer core resource.
Every core resource also has get() and list() methods, which offer a convenient way to select every attribute of a resource. This can be quite valuable since GAQL does not support SELECT *. See the campaign core resource for an example.
A \"mutation\" is a change to a Google Ads account, such as a new campaign or an adjusted bid.
\nMost resources in the Google Ads API will have mutation methods for creating, updating, and deleting.
\nThe create method can take a single entity or array of entities. The results property of the response object will contain the newly created entity resource names.
const campaign = {\n name: 'new-campaign',\n campaign_budget: 'customers/123/campaignBudgets/123',\n advertising_channel_type: enums.AdvertisingChannelType.SEARCH,\n status: enums.CampaignStatus.PAUSED,\n}\n\nconst { results } = await customer.campaigns.create(campaign)\nconsole.log(results) // ['customers/123/campaigns/456'] <-- new resource_nameFor more details on this method, check the create() section for the core resource you want to create, such as creating a campaign.
The update method works the same way as create and takes a single entity or array of entities to update. All properties passed (that can be updated) will be updated, so if you don't want to update an attribute, don't include it.
The results property of the response object will contain the updated entity resource names.
const campaign = {\n resource_name: `customers/123/campaigns/456`,\n name: 'updated-campaign-name',\n}\nconst { results } = await customer.campaigns.update(campaign)For more details on this method, check the update() section for the core resource you want to modify, such as updating a campaign.
The delete method should be provided with the resource name of the entity to remove. Note: When deleting an entity in the Google Ads API, it will continue to exist, but it will be immutable and its status will be changed to REMOVED.
await customer.campaigns.delete('customers/123/campaigns/456')For more details on this method, check the delete() section for the core resource you want to delete, such as deleting a campaign.
customer.mutateResources()Sometimes you may want to create multiple resources of different types at once, such as creating a new campaign and its required budget. The customer.mutateResources method is designed for this use case, and supports:
A basic example of creating a budget, and a campaign that uses this budget, is shown below:
\nconst { results } = await customer.mutateResources([\n {\n // For each resource, you must specify its type with the \"_resource\" key\n _resource: 'CampaignBudget',\n resource_name: `customers/123/campaignBudgets/-1`, // We define the new ID as -1\n name: 'My new budget',\n amount_micros: 3000000,\n explicitly_shared: true,\n },\n {\n _resource: 'Campaign',\n campaign_budget: `customers/123/campaignBudgets/-1`, // Reference to the budget above\n name: 'My new campaign',\n advertising_channel_type: enums.AdvertisingChannelType.SEARCH,\n status: enums.CampaignStatus.PAUSED,\n manual_cpc: {\n enhanced_cpc_enabled: true,\n },\n // We don't need to set a temporary resource name here because\n // nothing else in this operations array depends on this campaign\n },\n])\n\n// The real resource ids will now be defined after performing the operation\nconsole.log(results) // ['customers/123/campaignBudgets/123123', 'customers/123/campaigns/321321']By default, mutateResources is atomic and will rollback if one operation fails -- no new resources will be added to the client account if one operation fails. This mode can be disabled by setting the partial_failure option to true. The validate_only option is also supported in this method. See the Google Ads API documentation for more details on these settings.
await customer.mutateResources(operations, { partial_failure: true })As well as creating resources, mutateResources also supports updating and deleting multiple resources (which also works with temporary resource ids). Use the _operation field in an operation to specify the mode, being either create, update or delete. This field isn't required and defaults to create. In the example below, these operations are executed:
-1 is created.456) is updated to use the new budget (-1).const response = await customer.mutateResources([\n // Create new budget\n {\n _resource: 'CampaignBudget',\n _operation: 'create',\n resource_name: 'customers/123/campaignBudgets/-1',\n name: 'My new budget',\n amount_micros: 3000000,\n explicitly_shared: true,\n },\n // Update campaign to use new budget\n {\n _resource: 'Campaign',\n _operation: 'update',\n resource_name: 'customers/123/campaigns/456',\n campaign_budget: 'customers/123/campaignBudgets/-1', // Reference to budget above\n },\n // Delete old budget\n {\n _resource: 'CampaignBudget',\n _operation: 'delete',\n resource_name: 'customers/123/campaignBudgets/123123',\n },\n])Note: Using customer.mutateResources() with a single operation is equivalent to using any of the standard customer.someResource.create|update|delete() methods, but your ts definitions won't be as good.
For more information about this method, see the customer resource's mutateResources section.
","frontmatter":{"title":"Using global mutate","order":4.2,"type":"manual","entity":"mutations"},"fields":{"group":"concepts","mega_order":4,"directory":"concepts/mutations","is_entity_index":false}}},{"node":{"id":"d5e673a9-0c3b-5ebf-a93e-b23355d9ac2f","html":"All enums are represented as numbers in the Google Ads API. This means:
\nFor example:
\n/*\n campaign.status can have a few states:\n\n \"UNSPECIFIED\" = 0\n \"UNKNOWN\" = 1\n \"ENABLED\" = 2\n \"PAUSED\" = 3\n \"REMOVED\" = 4\n*/\n\nconst campaigns = await customer.query(`SELECT campaign.status FROM campaign`)\n\nif (campaigns[0].campaign.status === 2) {\n // the campaign is enabled\n}\n\nconst campaign_to_update = {\n resource_name: `customers/123/campaigns/123`,\n status: 3,\n}\n\nawait customer.campaigns.update(campaign) // This will set the status to \"PAUSED\"Of course, using numbers directly isn't convenient. Instead, use the enums import:
import { enums } from 'google-ads-api'\n\nconst campaigns = await customer.query(`SELECT campaign.status FROM campaign`)\n\nif (campaigns[0].campaign.status === enums.CampaignStatus.ENABLED) {\n // the campaign is enabled\n}\n\nconst campaign_to_update = {\n resource_name: `customers/123/campaigns/123`,\n status: enums.CampaignStatus.PAUSED,\n}\n\nawait customer.campaigns.update(campaign) // This will set the status to \"PAUSED\"The enums.ts file (found in our companion library) lists out all enums available in the Google Ads API. For example:
// Note that this will be compiled to an object by typescript.\nexport enum AdvertisingChannelType {\n 'UNSPECIFIED' = 0,\n 'UNKNOWN' = 1,\n 'SEARCH' = 2,\n 'DISPLAY' = 3,\n 'SHOPPING' = 4,\n 'HOTEL' = 5,\n 'VIDEO' = 6,\n 'MULTI_CHANNEL' = 7,\n}GAQL, on the other hand, expects strings for enums in constraints:
\ncustomer.query(`\n SELECT \n ad_group_ad.id\n FROM \n ad_group_ad \n WHERE \n campaign.status = \"ENABLED\" <-- works!\n campaign.status = ENABLED <-- also works (for enums)\n campaign.status = 2 <-- will not work\n`)customer.query(), you must use strings.customer.report(), both strings and numbers are supported.To handle errors from the Google Ads API, the best approach is to use the provided error enums, available with the enums import. A full list of error types can be found in the Google Ads API reference.
import { enums } from 'google-ads-api'\n\ntry {\n const campaigns = await customer.report({\n entity: 'campaign',\n attributes: ['ad_group_criterion.keyword.text'],\n })\n} catch (err) {\n if (err.code.queryError === enums.QueryError.PROHIBITED_RESOURCE_TYPE_IN_SELECT_CLAUSE) {\n // Handle error case..\n }\n\n // Besides `code`, errors have other useful metadata:\n console.log(err.message) // \"Cannot select fields from the following resource..\"\n console.log(err.location) // \"ad_group_criterion.keyword.text\"\n console.log(err.request_id) // \"5Tzsyp_M_9F7oHl_EZh8Ow\", useful when discussing issues with Google support\n console.log(err.request) // Request protocol buffer body in readable format, useful for debugging\n console.log(err.failure) // gRPC GoogleAdsFailure instance\n}This library exports a set of helper methods that can assist you during development.
\nfromMicros : Converts micro value to a normal number. toMicros: Converts a normal number to a micro value.getEnumString: Get the value of an enum as a string (instead of the default number value).import { fromMicros, toMicros, getEnumString /* , enums, types, GoogleAdsApi */ } from 'google-ads-api'\n\nfromMicros(123300000) // 123.3\ntoMicros(123.3) // 123300000\n\n// You must pass the enum name and the value\ngetEnumString('AdvertisingChannelType', enums.AdvertisingChannelType.DISPLAY) // \"DISPLAY\"\ngetEnumString('AdvertisingChannelType', 3) // \"DISPLAY\"This library has first-class support for Typescript. We also expose every single type in the Google Ads API via the types export, should you choose to use them in your own code:
import { types } from 'google-ads-api'\n\nconst campaign: types.Campaign = {\n id: 123123,\n some_wrong_field: false, // The type checker won't allow this.\n name: [1, 2, 3], // `name` should be a string, so this will also throw an error.\n}The resources.ts file (found in our companion library) is a good reference for all exported types. For example, you'll find:
// Example interface for the v2 common \"TextAdInfo\" entity in the Google Ads API\n\n/* .google.ads.googleads.v2.common.TextAdInfo */\nexport interface TextAdInfo {\n headline?: string\n description_1?: string\n description_2?: string\n}This library's changelog: https://github.com/Opteo/google-ads-api/blob/master/CHANGELOG.md
\nOfficial API changelog: Google Ads API release notes
\nWe do not yet support every feature of the Google Ads API. Currently, these parts are missing:
\nIf any of these features are important to you, help us prioritise by opening an issue on GitHub!
","frontmatter":{"title":"Changelog & future plans","order":8.1,"type":"manual","entity":"misc"},"fields":{"group":"concepts","mega_order":8,"directory":"concepts/misc","is_entity_index":false}}},{"node":{"id":"d02f4dfa-9535-53f4-8c3c-47f8c63795d5","html":"I'm getting errors that my bids or budgets are too small. Why?\nAll monetary values are set and fetched in micros. These are 1,000,000x bigger than the actual amount. Use our utility functions toMicros and fromMicros to convert.
Where are my keywords?\nKeywords are hidden away in AdGroupCriterion -> keyword. Keywords are just one of many types of targeting \"Criteria\", meaning they modify the targeting of ads.
\nCan I run this in a browser?\nNo. There's no way to hide your tokens without using a proxy, which would need to be on your server anyway.
\nCan I run this in a serverless environment (Lambda, etc.)?\nYes. Note that this library uses several NodeJS native methods (fs, crypto), so webworker-like environments such as CloudFlare workers won't function.
\nWhen Google releases their own Node client for Google Ads, will this library still be relevant?\nYes. We've already auto-generated a client with Google's protocol buffers, called google-ads-node. It's very feature complete, and this library is built on top of it. When Google releases their own node client, we may deprecate google-ads-node and refractor this library to use it instead.
\nDo you have any examples on how to use this library?\nWe're working on a robust set of examples. You can find the ones we've already completed in this branch.
","frontmatter":{"title":"FAQ","order":8.2,"type":"manual","entity":"misc"},"fields":{"group":"concepts","mega_order":8,"directory":"concepts/misc","is_entity_index":false}}},{"node":{"id":"0aede071-9cbf-5069-808a-1de0574b15fb","html":"// Example AccountBudget\nconst account_budget = {\n adjusted_spending_limit_type: 2,\n amount_served_micros: 227337890000,\n approved_end_time_type: 3,\n approved_spending_limit_type: 2,\n approved_start_date_time: '2017-01-01 12:22:14',\n billing_setup: 'customers/3827277046/billingSetups/295854200',\n id: 295854560,\n name: '',\n proposed_end_time_type: 3,\n proposed_spending_limit_type: 2,\n proposed_start_date_time: '2017-01-01 12:22:14',\n resource_name: 'customers/3827277046/accountBudgets/295854560',\n status: 3,\n total_adjustments_micros: 1176390000,\n}The customer.accountBudgets.get(resource_name) method returns the AccountBudget identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AccountBudget
\nReturns that AccountBudget as an object.
","frontmatter":{"title":"Get AccountBudget","order":2,"type":"get","entity":"AccountBudget"},"fields":{"group":"entities","mega_order":0,"directory":"entities/account_budget","is_entity_index":false}}},{"node":{"id":"cb10db18-dc20-5037-a568-697c2d361e6a","html":"// Getting the entity\nlet result = await customer.accountBudgets.get('customers/3827277046/accountBudgets/295854560')// Example result\n;({\n adjusted_spending_limit_type: 2,\n amount_served_micros: 227337890000,\n approved_end_time_type: 3,\n approved_spending_limit_type: 2,\n approved_start_date_time: '2017-01-01 12:22:14',\n billing_setup: 'customers/3827277046/billingSetups/295854200',\n id: 295854560,\n name: '',\n proposed_end_time_type: 3,\n proposed_spending_limit_type: 2,\n proposed_start_date_time: '2017-01-01 12:22:14',\n resource_name: 'customers/3827277046/accountBudgets/295854560',\n status: 3,\n total_adjustments_micros: 1176390000,\n})The customer.accountBudgets.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AccountBudget.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a account_budget property. Any other resources that can be selected with account_budget will also be added as properities.
// Listing all the accountBudgets in the account\nlet result = await customer.accountBudgets.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.accountBudgets.list({\n constraints: [\n {\n key: 'account_budget.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'account_budget.some_field.sub_field',\n})// Example result\n;[\n {\n account_budget: {\n adjusted_spending_limit_type: 2,\n amount_served_micros: 227337890000,\n approved_end_time_type: 3,\n approved_spending_limit_type: 2,\n approved_start_date_time: '2017-01-01 12:22:14',\n billing_setup: 'customers/3827277046/billingSetups/295854200',\n id: 295854560,\n name: '',\n proposed_end_time_type: 3,\n proposed_spending_limit_type: 2,\n proposed_start_date_time: '2017-01-01 12:22:14',\n resource_name: 'customers/3827277046/accountBudgets/295854560',\n status: 3,\n total_adjustments_micros: 1176390000,\n },\n billing_setup: {\n end_time_type: 3,\n id: 295854200,\n payments_account: 'customers/3827277046/paymentsAccounts/2445-9502-2490-5474',\n payments_account_info: {\n payments_account_id: '2445-9502-2490-5474',\n payments_account_name: 'AdWords 382-727-7046',\n payments_profile_id: '4466-6664-9412',\n payments_profile_name: 'Opteo LTD',\n },\n resource_name: 'customers/3827277046/billingSetups/295854200',\n start_date_time: '2017-01-01 12:22:14',\n status: 4,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]// Example AccountBudgetProposal\nconst account_budget_proposal = {\n account_budget: 'customers/3827277046/accountBudgets/295854560',\n approval_date_time: '2017-01-01 12:25:18',\n approved_end_time_type: 3,\n approved_spending_limit_type: 2,\n approved_start_date_time: '2017-01-01 12:22:14',\n billing_setup: 'customers/3827277046/billingSetups/295854200',\n creation_date_time: '2017-01-01 12:25:18',\n id: 265265547,\n proposal_type: 0,\n proposed_end_time_type: 3,\n proposed_name: '',\n proposed_spending_limit_type: 2,\n proposed_start_date_time: '2017-01-01 12:22:14',\n resource_name: 'customers/3827277046/accountBudgetProposals/265265547',\n status: 4,\n}The customer.accountBudgetProposals.get(resource_name) method returns the AccountBudgetProposal identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AccountBudgetProposal
\nReturns that AccountBudgetProposal as an object.
","frontmatter":{"title":"Get AccountBudgetProposal","order":2,"type":"get","entity":"AccountBudgetProposal"},"fields":{"group":"entities","mega_order":0,"directory":"entities/account_budget_proposal","is_entity_index":false}}},{"node":{"id":"34b0ae53-d76a-52b2-a79a-b04fd753868c","html":"// Getting the entity\nlet result = await customer.accountBudgetProposals.get('customers/3827277046/accountBudgetProposals/265265547')// Example result\n;({\n account_budget: 'customers/3827277046/accountBudgets/295854560',\n approval_date_time: '2017-01-01 12:25:18',\n approved_end_time_type: 3,\n approved_spending_limit_type: 2,\n approved_start_date_time: '2017-01-01 12:22:14',\n billing_setup: 'customers/3827277046/billingSetups/295854200',\n creation_date_time: '2017-01-01 12:25:18',\n id: 265265547,\n proposal_type: 0,\n proposed_end_time_type: 3,\n proposed_name: '',\n proposed_spending_limit_type: 2,\n proposed_start_date_time: '2017-01-01 12:22:14',\n resource_name: 'customers/3827277046/accountBudgetProposals/265265547',\n status: 4,\n})The customer.accountBudgetProposals.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AccountBudgetProposal.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a account_budget_proposal property. Any other resources that can be selected with account_budget_proposal will also be added as properities.
// Listing all the accountBudgetProposals in the account\nlet result = await customer.accountBudgetProposals.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.accountBudgetProposals.list({\n constraints: [\n {\n key: 'account_budget_proposal.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'account_budget_proposal.some_field.sub_field',\n})// Example result\n;[\n {\n account_budget_proposal: {\n account_budget: 'customers/3827277046/accountBudgets/295854560',\n approval_date_time: '2017-01-01 12:25:18',\n approved_end_time_type: 3,\n approved_spending_limit_type: 2,\n approved_start_date_time: '2017-01-01 12:22:14',\n billing_setup: 'customers/3827277046/billingSetups/295854200',\n creation_date_time: '2017-01-01 12:25:18',\n id: 265265547,\n proposal_type: 0,\n proposed_end_time_type: 3,\n proposed_name: '',\n proposed_spending_limit_type: 2,\n proposed_start_date_time: '2017-01-01 12:22:14',\n resource_name: 'customers/3827277046/accountBudgetProposals/265265547',\n status: 4,\n },\n billing_setup: {\n end_time_type: 3,\n id: 295854200,\n payments_account: 'customers/3827277046/paymentsAccounts/2445-9502-2490-5474',\n payments_account_info: {\n payments_account_id: '2445-9502-2490-5474',\n payments_account_name: 'AdWords 382-727-7046',\n payments_profile_id: '4466-6664-9412',\n payments_profile_name: 'Opteo LTD',\n },\n resource_name: 'customers/3827277046/billingSetups/295854200',\n start_date_time: '2017-01-01 12:22:14',\n status: 4,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.accountBudgetProposals.create(account_budget_proposal) method makes a new AccountBudgetProposal in an account. It also supports an array as its first agument for batch operations.
The AccountBudgetProposal object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst account_budget_proposal = {\n // Your AccountBudgetProposal here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.accountBudgetProposals.create(account_budget_proposal)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.accountBudgetProposals.create([account_budget_proposal, other_account_budget_proposal], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/accountBudgetProposals/265265547'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.accountBudgetProposals.update(account_budget_proposal) method changes the attributes of an existing accountBudgetProposals in an account. It also supports an array as its first agument for batch operations.
The AccountBudgetProposal object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst account_budget_proposal = {\n resource_name: 'customers/3827277046/accountBudgetProposals/265265547', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.accountBudgetProposals.update(account_budget_proposal)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.accountBudgetProposals.update([account_budget_proposal, other_account_budget_proposal], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/accountBudgetProposals/265265547'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.accountBudgetProposals.delete(resource_name) sets the status field of an AccountBudgetProposal to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AccountBudgetProposal
\nNothing
","frontmatter":{"title":"Delete AccountBudgetProposal","order":6,"type":"delete","entity":"AccountBudgetProposal"},"fields":{"group":"entities","mega_order":0,"directory":"entities/account_budget_proposal","is_entity_index":false}}},{"node":{"id":"e8c7c702-06cb-5de7-b339-cdb5c63727a0","html":"// Deleting the entity\n\nawait customer.accountBudgetProposals.delete('customers/3827277046/accountBudgetProposals/265265547')Not to be confused with AdGroupAd, this entity only has two methods: get and update. It allows you to edit the creative part of an ad, such as the headline, description, or image. Editing an ad this way will not reset the metrics of the ad.
// Example Ad\nconst ad = {\n added_by_google_ads: false,\n display_url: '',\n expanded_text_ad: {\n description: 'my description here',\n headline_part1: 'headline part 1 here',\n headline_part2: 'headline part 2 here',\n path1: 'path one here',\n path2: 'path two here',\n },\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['http://hello.com'],\n id: 284706472002,\n resource_name: 'customers/9262111890/ads/284706472002',\n type: 3,\n url_collections: [],\n url_custom_parameters: [],\n}The customer.ads.get(resource_name) method returns the Ad identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that Ad
\nReturns that Ad as an object.
","frontmatter":{"title":"Get Ad","order":2,"type":"get","entity":"Ad"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad","is_entity_index":false}}},{"node":{"id":"2b09a0d4-bb6e-5d33-b425-a9f6c4edbebe","html":"// Getting the entity\nlet result = await customer.ads.get('customers/9262111890/ads/284706472002')// Example result\n;({\n added_by_google_ads: false,\n display_url: '',\n expanded_text_ad: {\n description: 'my description here',\n headline_part1: 'headline part 1 here',\n headline_part2: 'headline part 2 here',\n path1: 'path one here',\n path2: 'path two here',\n },\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['http://hello.com'],\n id: 284706472002,\n resource_name: 'customers/9262111890/ads/284706472002',\n type: 3,\n url_collections: [],\n url_custom_parameters: [],\n})The customer.ads.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of Ad.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad property. Any other resources that can be selected with ad will also be added as properities.
// Listing all the ads in the account\nlet result = await customer.ads.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.ads.list({\n constraints: [\n {\n key: 'ad.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad.some_field.sub_field',\n})// Example result\n;[\n /* Todo: add example list() return here */\n]The customer.ads.create(ad) method makes a new Ad in an account. It also supports an array as its first agument for batch operations.
The Ad object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad = {\n // Your Ad here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.ads.create(ad)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.ads.create([ad, other_ad], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/ads/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.ads.update(ad) method changes the attributes of an existing ad in an account. It also supports an array as its first agument for batch operations. Updating an ad using this method will not reset its metrics.
The Ad object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad = {\n resource_name: 'customers/1234567890/ads/123123123', // The resource_name is required\n final_urls : ['https://updated-url.com']\n expanded_text_ad: {\n headline_part1: 'updated headline here',\n },\n}\n\n// Passing in a single entity to update\nconst result = await customer.ads.update(ad)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.ads.update([ad, other_ad], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/ads/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.ads.delete(resource_name) sets the status field of an Ad to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that Ad
\nNothing
","frontmatter":{"title":"Delete Ad","order":6,"type":"delete","entity":"Ad"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad","is_entity_index":false}}},{"node":{"id":"983250fe-b81a-549d-87c0-c58813b789ce","html":"// Deleting the entity\n\nawait customer.ads.delete('customers/1234567890/ads/123123123')// Example AdGroup\nconst ad_group = {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/56761341338',\n campaign: 'customers/3827277046/campaigns/1398201241',\n cpc_bid_micros: 6000000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas: 4,\n effective_target_roas_source: 5,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 56761341338,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/56761341338',\n status: 3,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n { targeting_dimension: 9, bid_only: false },\n ],\n },\n type: 13,\n url_custom_parameters: [],\n}The customer.adGroups.get(resource_name) method returns the AdGroup identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroup
\nReturns that AdGroup as an object.
","frontmatter":{"title":"Get AdGroup","order":2,"type":"get","entity":"AdGroup"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group","is_entity_index":false}}},{"node":{"id":"281a705e-c3da-5411-85bb-da55bc6fe439","html":"// Getting the entity\nlet result = await customer.adGroups.get('customers/3827277046/adGroups/56761341338')// Example result\n;({\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/56761341338',\n campaign: 'customers/3827277046/campaigns/1398201241',\n cpc_bid_micros: 6000000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas: 4,\n effective_target_roas_source: 5,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 56761341338,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/56761341338',\n status: 3,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n { targeting_dimension: 9, bid_only: false },\n ],\n },\n type: 13,\n url_custom_parameters: [],\n})The customer.adGroups.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroup.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group property. Any other resources that can be selected with ad_group will also be added as properities.
// Listing all the adGroups in the account\nlet result = await customer.adGroups.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroups.list({\n constraints: [\n {\n key: 'ad_group.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/56761341338',\n campaign: 'customers/3827277046/campaigns/1398201241',\n cpc_bid_micros: 6000000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas: 4,\n effective_target_roas_source: 5,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 56761341338,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/56761341338',\n status: 3,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n { targeting_dimension: 9, bid_only: false },\n ],\n },\n type: 13,\n url_custom_parameters: [],\n },\n bidding_strategy: {\n campaign_count: 3,\n id: 2053936084,\n name: 'My bidding strategy',\n non_removed_campaign_count: 3,\n resource_name: 'customers/3827277046/biddingStrategies/2053936084',\n status: 2,\n target_roas: { cpc_bid_ceiling_micros: 8000000, target_roas: 4 },\n type: 8,\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/1398201241',\n bidding_strategy: 'customers/3827277046/biddingStrategies/2053936084',\n bidding_strategy_type: 8,\n campaign_budget: 'customers/3827277046/campaignBudgets/1453179506',\n dynamic_search_ads_setting: {\n domain_name: 'opteo.com',\n feeds: [],\n language_code: 'en',\n use_supplied_urls_only: false,\n },\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1398201241,\n labels: [\n 'customers/3827277046/labels/3889728216',\n 'customers/3827277046/labels/3889728468',\n 'customers/3827277046/labels/3889728474',\n ],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/1398201241',\n serving_status: 2,\n start_date: '2018-05-10',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.adGroups.create(ad_group) method makes a new AdGroup in an account. It also supports an array as its first agument for batch operations.
The AdGroup object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group = {\n // Your AdGroup here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroups.create(ad_group)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroups.create([ad_group, other_ad_group], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroups/56761341338'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroups.update(ad_group) method changes the attributes of an existing adGroups in an account. It also supports an array as its first agument for batch operations.
The AdGroup object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group = {\n resource_name: 'customers/3827277046/adGroups/56761341338', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroups.update(ad_group)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroups.update([ad_group, other_ad_group], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroups/56761341338'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroups.delete(resource_name) sets the status field of an AdGroup to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroup
\nNothing
","frontmatter":{"title":"Delete AdGroup","order":6,"type":"delete","entity":"AdGroup"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group","is_entity_index":false}}},{"node":{"id":"61008e91-5d92-5aca-9c3d-072a9d5c9dab","html":"// Deleting the entity\n\nawait customer.adGroups.delete('customers/3827277046/adGroups/56761341338')// Example AdGroupAd\nconst ad_group_ad = {\n ad: {\n added_by_google_ads: false,\n device_preference: 0,\n expanded_text_ad: {\n description: 'my description here2',\n headline_part1: 'headline part 1 here2',\n headline_part2: 'headline part 2 here2',\n path1: 'path one here2',\n path2: 'path two here2',\n },\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['http://hello.com'],\n id: 284706472002,\n resource_name: 'customers/9262111890/ads/284706472002',\n system_managed_resource_source: 0,\n type: 3,\n url_collections: [],\n url_custom_parameters: [],\n },\n ad_group: 'customers/9262111890/adGroups/56328868446',\n ad_strength: 0,\n policy_summary: { approval_status: 0, policy_topic_entries: [], review_status: 2 },\n resource_name: 'customers/9262111890/adGroupAds/56328868446~284706472002',\n status: 2,\n}The customer.adGroupAds.get(resource_name) method returns the AdGroupAd identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupAd
\nReturns that AdGroupAd as an object.
","frontmatter":{"title":"Get AdGroupAd","order":2,"type":"get","entity":"AdGroupAd"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_ad","is_entity_index":false}}},{"node":{"id":"c7283596-9dcf-5ed3-b721-fe53f4dc0ca8","html":"// Getting the entity\nlet result = await customer.adGroupAds.get('customers/9262111890/adGroupAds/56328868446~284706472002')// Example result\n;({\n ad: {\n added_by_google_ads: false,\n device_preference: 0,\n expanded_text_ad: {\n description: 'my description here2',\n headline_part1: 'headline part 1 here2',\n headline_part2: 'headline part 2 here2',\n path1: 'path one here2',\n path2: 'path two here2',\n },\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['http://hello.com'],\n id: 284706472002,\n resource_name: 'customers/9262111890/ads/284706472002',\n system_managed_resource_source: 0,\n type: 3,\n url_collections: [],\n url_custom_parameters: [],\n },\n ad_group: 'customers/9262111890/adGroups/56328868446',\n ad_strength: 0,\n policy_summary: { approval_status: 0, policy_topic_entries: [], review_status: 2 },\n resource_name: 'customers/9262111890/adGroupAds/56328868446~284706472002',\n status: 2,\n})The customer.adGroupAds.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupAd.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_ad property. Any other resources that can be selected with ad_group_ad will also be added as properities.
// Listing all the adGroupAds in the account\nlet result = await customer.adGroupAds.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupAds.list({\n constraints: [\n {\n key: 'ad_group_ad.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_ad.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_ad: {\n ad: {\n added_by_google_ads: false,\n device_preference: 0,\n expanded_text_ad: {\n description: 'my description here2',\n headline_part1: 'headline part 1 here2',\n headline_part2: 'headline part 2 here2',\n path1: 'path one here2',\n path2: 'path two here2',\n },\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['http://hello.com'],\n id: 284706472002,\n resource_name: 'customers/9262111890/ads/284706472002',\n system_managed_resource_source: 0,\n type: 3,\n url_collections: [],\n url_custom_parameters: [],\n },\n ad_group: 'customers/9262111890/adGroups/56328868446',\n ad_strength: 0,\n policy_summary: { approval_status: 0, policy_topic_entries: [], review_status: 2 },\n resource_name: 'customers/9262111890/adGroupAds/56328868446~284706472002',\n status: 2,\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/9262111890/adGroups/56328868446',\n campaign: 'customers/9262111890/campaigns/1485014801',\n cpc_bid_micros: 1000000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n id: 56328868446,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/9262111890/adGroups/56328868446',\n status: 2,\n target_cpa_micros: 0,\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1485014801',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1548344372',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1485014801,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1485014801',\n serving_status: 2,\n start_date: '2018-07-24',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.adGroupAds.create(ad_group_ad) method makes a new AdGroupAd in an account. It also supports an array as its first agument for batch operations.
The AdGroupAd object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_ad = {\n // Your AdGroupAd here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupAds.create(ad_group_ad)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupAds.create([ad_group_ad, other_ad_group_ad], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/adGroupAds/56328868446~284706472002'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupAds.update(ad_group_ad) method changes the attributes of an existing adGroupAds in an account. It also supports an array as its first agument for batch operations.
The AdGroupAd object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_ad = {\n resource_name: 'customers/9262111890/adGroupAds/56328868446~284706472002', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupAds.update(ad_group_ad)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupAds.update([ad_group_ad, other_ad_group_ad], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/adGroupAds/56328868446~284706472002'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupAds.delete(resource_name) sets the status field of an AdGroupAd to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupAd
\nNothing
","frontmatter":{"title":"Delete AdGroupAd","order":6,"type":"delete","entity":"AdGroupAd"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_ad","is_entity_index":false}}},{"node":{"id":"10730580-53b7-507a-ab65-78c345a7b173","html":"// Deleting the entity\n\nawait customer.adGroupAds.delete('customers/9262111890/adGroupAds/56328868446~284706472002')// Example AdGroupAdLabel\nconst ad_group_ad_label = {\n ad_group_ad: 'customers/3827277046/adGroupAds/37706041345~206217423725',\n label: 'customers/3827277046/labels/1285360183',\n resource_name: 'customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183',\n}The customer.adGroupAdLabels.get(resource_name) method returns the AdGroupAdLabel identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupAdLabel
\nReturns that AdGroupAdLabel as an object.
","frontmatter":{"title":"Get AdGroupAdLabel","order":2,"type":"get","entity":"AdGroupAdLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_ad_label","is_entity_index":false}}},{"node":{"id":"b4e57164-a28e-5aeb-9561-d0a089f0151f","html":"// Getting the entity\nlet result = await customer.adGroupAdLabels.get(\n 'customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183'\n)// Example result\n;({\n ad_group_ad: 'customers/3827277046/adGroupAds/37706041345~206217423725',\n label: 'customers/3827277046/labels/1285360183',\n resource_name: 'customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183',\n})The customer.adGroupAdLabels.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupAdLabel.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_ad_label property. Any other resources that can be selected with ad_group_ad_label will also be added as properities.
// Listing all the adGroupAdLabels in the account\nlet result = await customer.adGroupAdLabels.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupAdLabels.list({\n constraints: [\n {\n key: 'ad_group_ad_label.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_ad_label.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_ad_label: {\n ad_group_ad: 'customers/3827277046/adGroupAds/37706041345~206217423725',\n label: 'customers/3827277046/labels/1285360183',\n resource_name: 'customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183',\n },\n ad_group_ad: {\n ad: {\n added_by_google_ads: false,\n device_preference: 0,\n expanded_text_ad: {\n description: 'State Of The Art AdWords PPC Tool. Designed For Agencies. Try It Free!',\n headline_part1: 'Top Ad Words Tool',\n headline_part2: 'Modern Way To Manage Accounts',\n path1: 'ppc',\n path2: 'tool',\n },\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['https://opteo.com'],\n id: 206217423725,\n resource_name: 'customers/3827277046/ads/206217423725',\n system_managed_resource_source: 0,\n type: 3,\n url_collections: [],\n url_custom_parameters: [],\n },\n ad_group: 'customers/3827277046/adGroups/37706041345',\n ad_strength: 0,\n policy_summary: {\n approval_status: 2,\n policy_topic_entries: [\n { topic: 'ONE_WEBSITE_PER_AD_GROUP', type: 2, evidences_list: [], constraints_list: [] },\n ],\n review_status: 3,\n },\n resource_name: 'customers/3827277046/adGroupAds/37706041345~206217423725',\n status: 4,\n },\n label: {\n id: 1285360183,\n name: 'My label',\n resource_name: 'customers/3827277046/labels/1285360183',\n status: 2,\n text_label: { background_color: '#336666', description: '' },\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/37706041345',\n campaign: 'customers/3827277046/campaigns/729684361',\n cpc_bid_micros: 4770000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 37706041345,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/37706041345',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: true },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 4,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/729684361',\n bidding_strategy_type: 3,\n campaign_budget: 'customers/3827277046/campaignBudgets/1005523652',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 729684361,\n labels: [],\n manual_cpc: { enhanced_cpc_enabled: false },\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/729684361',\n serving_status: 2,\n start_date: '2017-01-04',\n status: 4,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.adGroupAdLabels.create(ad_group_ad_label) method makes a new AdGroupAdLabel in an account. It also supports an array as its first agument for batch operations.
The AdGroupAdLabel object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_ad_label = {\n // Your AdGroupAdLabel here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupAdLabels.create(ad_group_ad_label)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupAdLabels.create([ad_group_ad_label, other_ad_group_ad_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupAdLabels.update(ad_group_ad_label) method changes the attributes of an existing adGroupAdLabels in an account. It also supports an array as its first agument for batch operations.
The AdGroupAdLabel object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_ad_label = {\n resource_name: 'customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupAdLabels.update(ad_group_ad_label)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupAdLabels.update([ad_group_ad_label, other_ad_group_ad_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupAdLabels.delete(resource_name) sets the status field of an AdGroupAdLabel to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupAdLabel
\nNothing
","frontmatter":{"title":"Delete AdGroupAdLabel","order":6,"type":"delete","entity":"AdGroupAdLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_ad_label","is_entity_index":false}}},{"node":{"id":"59c866b0-c547-58cf-93c2-580492ae0353","html":"// Deleting the entity\n\nawait customer.adGroupAdLabels.delete('customers/3827277046/adGroupAdLabels/37706041345~206217423725~1285360183')// Example AdGroupBidModifier\nconst ad_group_bid_modifier = {\n ad_group: 'customers/9262111890/adGroups/57176985017',\n base_ad_group: 'customers/9262111890/adGroups/57176985017',\n bid_modifier_source: 0,\n criterion_id: 30000,\n device: { type: 4 },\n resource_name: 'customers/9262111890/adGroupBidModifiers/57176985017~30000',\n}The customer.adGroupBidModifiers.get(resource_name) method returns the AdGroupBidModifier identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupBidModifier
\nReturns that AdGroupBidModifier as an object.
","frontmatter":{"title":"Get AdGroupBidModifier","order":2,"type":"get","entity":"AdGroupBidModifier"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_bid_modifier","is_entity_index":false}}},{"node":{"id":"ec263512-e396-5ba3-acfa-666d87b77d93","html":"// Getting the entity\nlet result = await customer.adGroupBidModifiers.get('customers/9262111890/adGroupBidModifiers/57176985017~30000')// Example result\n;({\n ad_group: 'customers/9262111890/adGroups/57176985017',\n base_ad_group: 'customers/9262111890/adGroups/57176985017',\n bid_modifier_source: 0,\n criterion_id: 30000,\n device: { type: 4 },\n resource_name: 'customers/9262111890/adGroupBidModifiers/57176985017~30000',\n})The customer.adGroupBidModifiers.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupBidModifier.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_bid_modifier property. Any other resources that can be selected with ad_group_bid_modifier will also be added as properities.
// Listing all the adGroupBidModifiers in the account\nlet result = await customer.adGroupBidModifiers.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupBidModifiers.list({\n constraints: [\n {\n key: 'ad_group_bid_modifier.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_bid_modifier.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_bid_modifier: {\n ad_group: 'customers/9262111890/adGroups/57176985017',\n base_ad_group: 'customers/9262111890/adGroups/57176985017',\n bid_modifier_source: 0,\n criterion_id: 30000,\n device: { type: 4 },\n resource_name: 'customers/9262111890/adGroupBidModifiers/57176985017~30000',\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/9262111890/adGroups/57176985017',\n campaign: 'customers/9262111890/campaigns/1485014801',\n cpc_bid_micros: 10000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n id: 57176985017,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/9262111890/adGroups/57176985017',\n status: 4,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 5, bid_only: true },\n { targeting_dimension: 6, bid_only: true },\n { targeting_dimension: 8, bid_only: true },\n { targeting_dimension: 9, bid_only: true },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1485014801',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1548344372',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1485014801,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1485014801',\n serving_status: 2,\n start_date: '2018-07-24',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.adGroupBidModifiers.create(ad_group_bid_modifier) method makes a new AdGroupBidModifier in an account. It also supports an array as its first agument for batch operations.
The AdGroupBidModifier object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_bid_modifier = {\n // Your AdGroupBidModifier here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupBidModifiers.create(ad_group_bid_modifier)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupBidModifiers.create([ad_group_bid_modifier, other_ad_group_bid_modifier], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/adGroupBidModifiers/57176985017~30000'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupBidModifiers.update(ad_group_bid_modifier) method changes the attributes of an existing adGroupBidModifiers in an account. It also supports an array as its first agument for batch operations.
The AdGroupBidModifier object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_bid_modifier = {\n resource_name: 'customers/9262111890/adGroupBidModifiers/57176985017~30000', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupBidModifiers.update(ad_group_bid_modifier)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupBidModifiers.update([ad_group_bid_modifier, other_ad_group_bid_modifier], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/adGroupBidModifiers/57176985017~30000'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupBidModifiers.delete(resource_name) sets the status field of an AdGroupBidModifier to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupBidModifier
\nNothing
","frontmatter":{"title":"Delete AdGroupBidModifier","order":6,"type":"delete","entity":"AdGroupBidModifier"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_bid_modifier","is_entity_index":false}}},{"node":{"id":"89195873-8cc6-5596-96be-67c34e183ac5","html":"// Deleting the entity\n\nawait customer.adGroupBidModifiers.delete('customers/9262111890/adGroupBidModifiers/57176985017~30000')// Example AdGroupCriterion\nconst ad_group_criterion = {\n ad_group: 'customers/9262111890/adGroups/60170225920',\n approval_status: 4,\n criterion_id: 521456008776,\n disapproval_reasons: [],\n effective_cpc_bid_micros: 1000000,\n effective_cpc_bid_source: 6,\n effective_cpm_bid_micros: 10000,\n effective_cpm_bid_source: 6,\n effective_cpv_bid_source: 0,\n effective_percent_cpc_bid_source: 0,\n final_mobile_urls: [],\n final_urls: [],\n keyword: { match_type: 4, text: 'test-keyword-478619' },\n negative: false,\n resource_name: 'customers/9262111890/adGroupCriteria/60170225920~521456008776',\n status: 3,\n system_serving_status: 3,\n type: 2,\n url_custom_parameters: [],\n}The customer.adGroupCriteria.get(resource_name) method returns the AdGroupCriterion identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupCriterion
\nReturns that AdGroupCriterion as an object.
","frontmatter":{"title":"Get AdGroupCriterion","order":2,"type":"get","entity":"AdGroupCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_criterion","is_entity_index":false}}},{"node":{"id":"9720375f-897a-5b54-8c55-0825c319911d","html":"// Getting the entity\nlet result = await customer.adGroupCriteria.get('customers/9262111890/adGroupCriteria/60170225920~521456008776')// Example result\n;({\n ad_group: 'customers/9262111890/adGroups/60170225920',\n approval_status: 4,\n criterion_id: 521456008776,\n disapproval_reasons: [],\n effective_cpc_bid_micros: 1000000,\n effective_cpc_bid_source: 6,\n effective_cpm_bid_micros: 10000,\n effective_cpm_bid_source: 6,\n effective_cpv_bid_source: 0,\n effective_percent_cpc_bid_source: 0,\n final_mobile_urls: [],\n final_urls: [],\n keyword: { match_type: 4, text: 'test-keyword-478619' },\n negative: false,\n resource_name: 'customers/9262111890/adGroupCriteria/60170225920~521456008776',\n status: 3,\n system_serving_status: 3,\n type: 2,\n url_custom_parameters: [],\n})The customer.adGroupCriteria.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupCriterion.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_criterion property. Any other resources that can be selected with ad_group_criterion will also be added as properities.
// Listing all the adGroupCriteria in the account\nlet result = await customer.adGroupCriteria.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupCriteria.list({\n constraints: [\n {\n key: 'ad_group_criterion.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_criterion.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_criterion: {\n ad_group: 'customers/9262111890/adGroups/60170225920',\n approval_status: 4,\n criterion_id: 521456008776,\n disapproval_reasons: [],\n effective_cpc_bid_micros: 1000000,\n effective_cpc_bid_source: 6,\n effective_cpm_bid_micros: 10000,\n effective_cpm_bid_source: 6,\n effective_cpv_bid_source: 0,\n effective_percent_cpc_bid_source: 0,\n final_mobile_urls: [],\n final_urls: [],\n keyword: { match_type: 4, text: 'test-keyword-478619' },\n negative: false,\n resource_name: 'customers/9262111890/adGroupCriteria/60170225920~521456008776',\n status: 3,\n system_serving_status: 3,\n type: 2,\n url_custom_parameters: [],\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/9262111890/adGroups/60170225920',\n campaign: 'customers/9262111890/campaigns/1485014801',\n cpc_bid_micros: 1000000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n id: 60170225920,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/9262111890/adGroups/60170225920',\n status: 2,\n target_cpa_micros: 0,\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1485014801',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1548344372',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1485014801,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1485014801',\n serving_status: 2,\n start_date: '2018-07-24',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.adGroupCriteria.create(ad_group_criterion) method makes a new AdGroupCriterion in an account. It also supports an array as its first agument for batch operations.
The AdGroupCriterion object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_criterion = {\n // Your AdGroupCriterion here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupCriteria.create(ad_group_criterion)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupCriteria.create([ad_group_criterion, other_ad_group_criterion], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/adGroupCriteria/60170225920~521456008776'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupCriteria.update(ad_group_criterion) method changes the attributes of an existing adGroupCriteria in an account. It also supports an array as its first agument for batch operations.
The AdGroupCriterion object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_criterion = {\n resource_name: 'customers/9262111890/adGroupCriteria/60170225920~521456008776', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupCriteria.update(ad_group_criterion)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupCriteria.update([ad_group_criterion, other_ad_group_criterion], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/adGroupCriteria/60170225920~521456008776'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupCriteria.delete(resource_name) sets the status field of an AdGroupCriterion to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupCriterion
\nNothing
","frontmatter":{"title":"Delete AdGroupCriterion","order":6,"type":"delete","entity":"AdGroupCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_criterion","is_entity_index":false}}},{"node":{"id":"faa4d7cb-a3b9-5813-9b9d-a66a060dcfbd","html":"// Deleting the entity\n\nawait customer.adGroupCriteria.delete('customers/9262111890/adGroupCriteria/60170225920~521456008776')// Example AdGroupCriterionLabel\nconst ad_group_criterion_label = {\n ad_group_criterion: 'customers/3827277046/adGroupCriteria/45808681353~331634074542',\n label: 'customers/3827277046/labels/3866969030',\n resource_name: 'customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030',\n}The customer.adGroupCriterionLabels.get(resource_name) method returns the AdGroupCriterionLabel identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupCriterionLabel
\nReturns that AdGroupCriterionLabel as an object.
","frontmatter":{"title":"Get AdGroupCriterionLabel","order":2,"type":"get","entity":"AdGroupCriterionLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_criterion_label","is_entity_index":false}}},{"node":{"id":"f1041f36-2818-515d-ad34-ec399dceeeec","html":"// Getting the entity\nlet result = await customer.adGroupCriterionLabels.get(\n 'customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030'\n)// Example result\n;({\n ad_group_criterion: 'customers/3827277046/adGroupCriteria/45808681353~331634074542',\n label: 'customers/3827277046/labels/3866969030',\n resource_name: 'customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030',\n})The customer.adGroupCriterionLabels.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupCriterionLabel.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_criterion_label property. Any other resources that can be selected with ad_group_criterion_label will also be added as properities.
// Listing all the adGroupCriterionLabels in the account\nlet result = await customer.adGroupCriterionLabels.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupCriterionLabels.list({\n constraints: [\n {\n key: 'ad_group_criterion_label.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_criterion_label.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_criterion_label: {\n ad_group_criterion: 'customers/3827277046/adGroupCriteria/45808681353~331634074542',\n label: 'customers/3827277046/labels/3866969030',\n resource_name: 'customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030',\n },\n ad_group_criterion: {\n ad_group: 'customers/3827277046/adGroups/45808681353',\n approval_status: 2,\n cpc_bid_micros: 2880000,\n criterion_id: 331634074542,\n disapproval_reasons: [],\n effective_cpc_bid_micros: 2880000,\n effective_cpc_bid_source: 7,\n effective_cpm_bid_micros: 10000,\n effective_cpm_bid_source: 6,\n effective_cpv_bid_source: 0,\n effective_percent_cpc_bid_source: 0,\n final_mobile_urls: [],\n final_urls: [],\n keyword: { match_type: 2, text: 'opteo adwords' },\n negative: false,\n resource_name: 'customers/3827277046/adGroupCriteria/45808681353~331634074542',\n status: 3,\n system_serving_status: 2,\n type: 2,\n url_custom_parameters: [],\n },\n label: {\n id: 3866969030,\n name: 'My label',\n resource_name: 'customers/3827277046/labels/3866969030',\n status: 2,\n text_label: { background_color: '#1be779', description: '' },\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/45808681353',\n campaign: 'customers/3827277046/campaigns/881817006',\n cpc_bid_micros: 2720000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 45808681353,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/45808681353',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: true },\n { targeting_dimension: 6, bid_only: true },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n ],\n },\n type: 2,\n url_custom_parameters: [{ key: 'yy', value: '1' }],\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/881817006',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/3827277046/campaignBudgets/1159840470',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 881817006,\n labels: ['customers/3827277046/labels/898377018'],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/881817006',\n serving_status: 2,\n start_date: '2017-07-12',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n tracking_url_template:\n 'https://ad.atdmt.com/s/go;adv=11202207688256;ec=11202207688723;c.a={campaignid};s.a=google;p.a={campaignid};as.a={adgroupid};qpb=1;?bidkw={keyword:defaultkeyword}&dvc={device}&h={lpurl}?utm_source=adwords&utm_medium=PPC&utm_campaign={campaignid}&utm_term={ifsearch:{keyword}}{ifcontent:{placement}}&utm_content={creative}&network={network}&adgroupid={adgroupid}&matchtype={matchtype}&adposition={adposition}&targetid={targetid}&target={target}&device={device}&devicemodel={devicemodel}',\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.adGroupCriterionLabels.create(ad_group_criterion_label) method makes a new AdGroupCriterionLabel in an account. It also supports an array as its first agument for batch operations.
The AdGroupCriterionLabel object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_criterion_label = {\n // Your AdGroupCriterionLabel here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupCriterionLabels.create(ad_group_criterion_label)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupCriterionLabels.create(\n [ad_group_criterion_label, other_ad_group_criterion_label],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupCriterionLabels.update(ad_group_criterion_label) method changes the attributes of an existing adGroupCriterionLabels in an account. It also supports an array as its first agument for batch operations.
The AdGroupCriterionLabel object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_criterion_label = {\n resource_name: 'customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupCriterionLabels.update(ad_group_criterion_label)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupCriterionLabels.update(\n [ad_group_criterion_label, other_ad_group_criterion_label],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupCriterionLabels.delete(resource_name) sets the status field of an AdGroupCriterionLabel to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupCriterionLabel
\nNothing
","frontmatter":{"title":"Delete AdGroupCriterionLabel","order":6,"type":"delete","entity":"AdGroupCriterionLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_criterion_label","is_entity_index":false}}},{"node":{"id":"c0ac7693-18a3-57ce-afbe-d5e405cc4563","html":"// Deleting the entity\n\nawait customer.adGroupCriterionLabels.delete(\n 'customers/3827277046/adGroupCriterionLabels/45808681353~331634074542~3866969030'\n)// Example AdGroupCriterionSimulation\nconst ad_group_criterion_simulation = {\n ad_group_id: 77057369032,\n cpc_bid_point_list: {\n points: [\n {\n cpc_bid_micros: 2750000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 2,\n cost_micros: 1680000,\n impressions: 116,\n top_slot_impressions: 94,\n },\n {\n cpc_bid_micros: 3000000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 2,\n cost_micros: 5740000,\n impressions: 144,\n top_slot_impressions: 113,\n },\n {\n cpc_bid_micros: 3110000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 10800000,\n impressions: 168,\n top_slot_impressions: 131,\n },\n {\n cpc_bid_micros: 4070000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 15350000,\n impressions: 192,\n top_slot_impressions: 154,\n },\n {\n cpc_bid_micros: 5030000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 4,\n cost_micros: 22940000,\n impressions: 212,\n top_slot_impressions: 182,\n },\n {\n cpc_bid_micros: 6310000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 38520000,\n impressions: 232,\n top_slot_impressions: 208,\n },\n {\n cpc_bid_micros: 9060000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 50360000,\n impressions: 237,\n top_slot_impressions: 220,\n },\n ],\n },\n criterion_id: 391658604416,\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name:\n 'customers/3827277046/adGroupCriterionSimulations/77057369032~391658604416~CPC_BID~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 2,\n}The customer.adGroupCriterionSimulations.get(resource_name) method returns the AdGroupCriterionSimulation identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupCriterionSimulation
\nReturns that AdGroupCriterionSimulation as an object.
","frontmatter":{"title":"Get AdGroupCriterionSimulation","order":2,"type":"get","entity":"AdGroupCriterionSimulation"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_criterion_simulation","is_entity_index":false}}},{"node":{"id":"3c1415b6-699f-5c4c-b19e-8c4c23075a1d","html":"// Getting the entity\nlet result = await customer.adGroupCriterionSimulations.get(\n 'customers/3827277046/adGroupCriterionSimulations/77057369032~391658604416~CPC_BID~UNIFORM~20200711~20200717'\n)// Example result\n;({\n ad_group_id: 77057369032,\n cpc_bid_point_list: {\n points: [\n {\n cpc_bid_micros: 2750000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 2,\n cost_micros: 1680000,\n impressions: 116,\n top_slot_impressions: 94,\n },\n {\n cpc_bid_micros: 3000000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 2,\n cost_micros: 5740000,\n impressions: 144,\n top_slot_impressions: 113,\n },\n {\n cpc_bid_micros: 3110000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 10800000,\n impressions: 168,\n top_slot_impressions: 131,\n },\n {\n cpc_bid_micros: 4070000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 15350000,\n impressions: 192,\n top_slot_impressions: 154,\n },\n {\n cpc_bid_micros: 5030000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 4,\n cost_micros: 22940000,\n impressions: 212,\n top_slot_impressions: 182,\n },\n {\n cpc_bid_micros: 6310000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 38520000,\n impressions: 232,\n top_slot_impressions: 208,\n },\n {\n cpc_bid_micros: 9060000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 50360000,\n impressions: 237,\n top_slot_impressions: 220,\n },\n ],\n },\n criterion_id: 391658604416,\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name:\n 'customers/3827277046/adGroupCriterionSimulations/77057369032~391658604416~CPC_BID~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 2,\n})The customer.adGroupCriterionSimulations.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupCriterionSimulation.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_criterion_simulation property. Any other resources that can be selected with ad_group_criterion_simulation will also be added as properities.
// Listing all the adGroupCriterionSimulations in the account\nlet result = await customer.adGroupCriterionSimulations.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupCriterionSimulations.list({\n constraints: [\n {\n key: 'ad_group_criterion_simulation.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_criterion_simulation.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_criterion_simulation: {\n ad_group_id: 77057369032,\n cpc_bid_point_list: {\n points: [\n {\n cpc_bid_micros: 2750000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 2,\n cost_micros: 1680000,\n impressions: 116,\n top_slot_impressions: 94,\n },\n {\n cpc_bid_micros: 3000000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 2,\n cost_micros: 5740000,\n impressions: 144,\n top_slot_impressions: 113,\n },\n {\n cpc_bid_micros: 3110000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 10800000,\n impressions: 168,\n top_slot_impressions: 131,\n },\n {\n cpc_bid_micros: 4070000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 15350000,\n impressions: 192,\n top_slot_impressions: 154,\n },\n {\n cpc_bid_micros: 5030000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 4,\n cost_micros: 22940000,\n impressions: 212,\n top_slot_impressions: 182,\n },\n {\n cpc_bid_micros: 6310000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 38520000,\n impressions: 232,\n top_slot_impressions: 208,\n },\n {\n cpc_bid_micros: 9060000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 50360000,\n impressions: 237,\n top_slot_impressions: 220,\n },\n ],\n },\n criterion_id: 391658604416,\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name:\n 'customers/3827277046/adGroupCriterionSimulations/77057369032~391658604416~CPC_BID~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 2,\n },\n ad_group_criterion: {\n ad_group: 'customers/3827277046/adGroups/77057369032',\n approval_status: 2,\n criterion_id: 391658604416,\n disapproval_reasons: [],\n effective_cpc_bid_micros: 6310000,\n effective_cpc_bid_source: 6,\n effective_cpm_bid_micros: 10000000,\n effective_cpm_bid_source: 6,\n effective_cpv_bid_source: 0,\n effective_percent_cpc_bid_source: 0,\n final_mobile_urls: [],\n final_urls: [],\n keyword: { match_type: 4, text: '+google +ads +optimization' },\n negative: false,\n position_estimates: {\n estimated_add_clicks_at_first_position_cpc: -3,\n estimated_add_cost_at_first_position_cpc: -34860000,\n first_page_cpc_micros: 1470000,\n first_position_cpc_micros: 1470000,\n top_of_page_cpc_micros: 1470000,\n },\n quality_info: {\n creative_quality_score: 4,\n post_click_quality_score: 3,\n quality_score: 5,\n search_predicted_ctr: 2,\n },\n resource_name: 'customers/3827277046/adGroupCriteria/77057369032~391658604416',\n status: 2,\n system_serving_status: 2,\n type: 2,\n url_custom_parameters: [],\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/77057369032',\n campaign: 'customers/3827277046/campaigns/2081620945',\n cpc_bid_micros: 6310000,\n cpm_bid_micros: 10000000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 12000000,\n effective_target_cpa_source: 6,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 77057369032,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/77057369032',\n status: 2,\n target_cpa_micros: 12000000,\n target_cpm_micros: 10000,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: true },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: true },\n { targeting_dimension: 6, bid_only: true },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: true },\n { targeting_dimension: 9, bid_only: true },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/2081620945',\n bidding_strategy_type: 3,\n campaign_budget: 'customers/3827277046/campaignBudgets/6449346159',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 5, positive_geo_target_type: 7 },\n id: 2081620945,\n labels: [\n 'customers/3827277046/labels/3889728216',\n 'customers/3827277046/labels/3889728468',\n 'customers/3827277046/labels/3889728480',\n ],\n manual_cpc: { enhanced_cpc_enabled: true },\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n optimization_score: 0.7376711477461586,\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/2081620945',\n serving_status: 2,\n start_date: '2019-07-30',\n status: 2,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: true }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]// Example AdGroupExtensionSetting\nconst ad_group_extension_setting = {\n ad_group: 'customers/3827277046/adGroups/69639056828',\n device: 0,\n extension_feed_items: [\n 'customers/3827277046/extensionFeedItems/48199744867',\n 'customers/3827277046/extensionFeedItems/48199839565',\n 'customers/3827277046/extensionFeedItems/48200356726',\n 'customers/3827277046/extensionFeedItems/48200575108',\n 'customers/3827277046/extensionFeedItems/48200618792',\n ],\n extension_type: 10,\n resource_name: 'customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK',\n}The customer.adGroupExtensionSettings.get(resource_name) method returns the AdGroupExtensionSetting identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupExtensionSetting
\nReturns that AdGroupExtensionSetting as an object.
","frontmatter":{"title":"Get AdGroupExtensionSetting","order":2,"type":"get","entity":"AdGroupExtensionSetting"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_extension_setting","is_entity_index":false}}},{"node":{"id":"38a3e497-40fb-5036-bd5e-1d3bab585132","html":"// Getting the entity\nlet result = await customer.adGroupExtensionSettings.get(\n 'customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK'\n)// Example result\n;({\n ad_group: 'customers/3827277046/adGroups/69639056828',\n device: 0,\n extension_feed_items: [\n 'customers/3827277046/extensionFeedItems/48199744867',\n 'customers/3827277046/extensionFeedItems/48199839565',\n 'customers/3827277046/extensionFeedItems/48200356726',\n 'customers/3827277046/extensionFeedItems/48200575108',\n 'customers/3827277046/extensionFeedItems/48200618792',\n ],\n extension_type: 10,\n resource_name: 'customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK',\n})The customer.adGroupExtensionSettings.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupExtensionSetting.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_extension_setting property. Any other resources that can be selected with ad_group_extension_setting will also be added as properities.
// Listing all the adGroupExtensionSettings in the account\nlet result = await customer.adGroupExtensionSettings.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupExtensionSettings.list({\n constraints: [\n {\n key: 'ad_group_extension_setting.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_extension_setting.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_extension_setting: {\n ad_group: 'customers/3827277046/adGroups/69639056828',\n device: 0,\n extension_feed_items: [\n 'customers/3827277046/extensionFeedItems/48199744867',\n 'customers/3827277046/extensionFeedItems/48199839565',\n 'customers/3827277046/extensionFeedItems/48200356726',\n 'customers/3827277046/extensionFeedItems/48200575108',\n 'customers/3827277046/extensionFeedItems/48200618792',\n ],\n extension_type: 10,\n resource_name: 'customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK',\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/69639056828',\n campaign: 'customers/3827277046/campaigns/954460701',\n cpc_bid_micros: 4500000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 69639056828,\n labels: ['customers/3827277046/labels/3345231412'],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/69639056828',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n { targeting_dimension: 9, bid_only: false },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/954460701',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/3827277046/campaignBudgets/1234926420',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 954460701,\n labels: ['customers/3827277046/labels/3889728471'],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/954460701',\n serving_status: 2,\n start_date: '2017-10-13',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.adGroupExtensionSettings.create(ad_group_extension_setting) method makes a new AdGroupExtensionSetting in an account. It also supports an array as its first agument for batch operations.
The AdGroupExtensionSetting object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_extension_setting = {\n // Your AdGroupExtensionSetting here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupExtensionSettings.create(ad_group_extension_setting)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupExtensionSettings.create(\n [ad_group_extension_setting, other_ad_group_extension_setting],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupExtensionSettings.update(ad_group_extension_setting) method changes the attributes of an existing adGroupExtensionSettings in an account. It also supports an array as its first agument for batch operations.
The AdGroupExtensionSetting object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_extension_setting = {\n resource_name: 'customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupExtensionSettings.update(ad_group_extension_setting)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupExtensionSettings.update(\n [ad_group_extension_setting, other_ad_group_extension_setting],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupExtensionSettings.delete(resource_name) sets the status field of an AdGroupExtensionSetting to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupExtensionSetting
\nNothing
","frontmatter":{"title":"Delete AdGroupExtensionSetting","order":6,"type":"delete","entity":"AdGroupExtensionSetting"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_extension_setting","is_entity_index":false}}},{"node":{"id":"897de521-57a4-515e-8916-6b9a9ee06e22","html":"// Deleting the entity\n\nawait customer.adGroupExtensionSettings.delete('customers/3827277046/adGroupExtensionSettings/69639056828~SITELINK')// Example AdGroupFeed\nconst ad_group_feed = {\n ad_group: 'customers/3827277046/adGroups/69639056828',\n feed: 'customers/3827277046/feeds/43009393',\n matching_function: {\n function_string: 'IN(FEED_ITEM_ID,{48200575108,48199744867,48200356726,48199839565,48200618792})',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 2,\n right_operands: [\n { constant_operand: { long_value: 48200575108 } },\n { constant_operand: { long_value: 48199744867 } },\n { constant_operand: { long_value: 48200356726 } },\n { constant_operand: { long_value: 48199839565 } },\n { constant_operand: { long_value: 48200618792 } },\n ],\n },\n placeholder_types: [],\n resource_name: 'customers/3827277046/adGroupFeeds/69639056828~43009393',\n status: 2,\n}The customer.adGroupFeeds.get(resource_name) method returns the AdGroupFeed identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupFeed
\nReturns that AdGroupFeed as an object.
","frontmatter":{"title":"Get AdGroupFeed","order":2,"type":"get","entity":"AdGroupFeed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_feed","is_entity_index":false}}},{"node":{"id":"c49b7493-05c4-51ca-8bc5-372303fdc06e","html":"// Getting the entity\nlet result = await customer.adGroupFeeds.get('customers/3827277046/adGroupFeeds/69639056828~43009393')// Example result\n;({\n ad_group: 'customers/3827277046/adGroups/69639056828',\n feed: 'customers/3827277046/feeds/43009393',\n matching_function: {\n function_string: 'IN(FEED_ITEM_ID,{48200575108,48199744867,48200356726,48199839565,48200618792})',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 2,\n right_operands: [\n { constant_operand: { long_value: 48200575108 } },\n { constant_operand: { long_value: 48199744867 } },\n { constant_operand: { long_value: 48200356726 } },\n { constant_operand: { long_value: 48199839565 } },\n { constant_operand: { long_value: 48200618792 } },\n ],\n },\n placeholder_types: [],\n resource_name: 'customers/3827277046/adGroupFeeds/69639056828~43009393',\n status: 2,\n})The customer.adGroupFeeds.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupFeed.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_feed property. Any other resources that can be selected with ad_group_feed will also be added as properities.
// Listing all the adGroupFeeds in the account\nlet result = await customer.adGroupFeeds.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupFeeds.list({\n constraints: [\n {\n key: 'ad_group_feed.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_feed.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_feed: {\n ad_group: 'customers/3827277046/adGroups/69639056828',\n feed: 'customers/3827277046/feeds/43009393',\n matching_function: {\n function_string: 'IN(FEED_ITEM_ID,{48200575108,48199744867,48200356726,48199839565,48200618792})',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 2,\n right_operands: [\n { constant_operand: { long_value: 48200575108 } },\n { constant_operand: { long_value: 48199744867 } },\n { constant_operand: { long_value: 48200356726 } },\n { constant_operand: { long_value: 48199839565 } },\n { constant_operand: { long_value: 48200618792 } },\n ],\n },\n placeholder_types: [],\n resource_name: 'customers/3827277046/adGroupFeeds/69639056828~43009393',\n status: 2,\n },\n feed: {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 43009393,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/3827277046/feeds/43009393',\n status: 2,\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/69639056828',\n campaign: 'customers/3827277046/campaigns/954460701',\n cpc_bid_micros: 4500000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 69639056828,\n labels: ['customers/3827277046/labels/3345231412'],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/69639056828',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n { targeting_dimension: 9, bid_only: false },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/954460701',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/3827277046/campaignBudgets/1234926420',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 954460701,\n labels: ['customers/3827277046/labels/3889728471'],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/954460701',\n serving_status: 2,\n start_date: '2017-10-13',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.adGroupFeeds.create(ad_group_feed) method makes a new AdGroupFeed in an account. It also supports an array as its first agument for batch operations.
The AdGroupFeed object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_feed = {\n // Your AdGroupFeed here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupFeeds.create(ad_group_feed)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupFeeds.create([ad_group_feed, other_ad_group_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroupFeeds/69639056828~43009393'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupFeeds.update(ad_group_feed) method changes the attributes of an existing adGroupFeeds in an account. It also supports an array as its first agument for batch operations.
The AdGroupFeed object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_feed = {\n resource_name: 'customers/3827277046/adGroupFeeds/69639056828~43009393', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupFeeds.update(ad_group_feed)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupFeeds.update([ad_group_feed, other_ad_group_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroupFeeds/69639056828~43009393'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupFeeds.delete(resource_name) sets the status field of an AdGroupFeed to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupFeed
\nNothing
","frontmatter":{"title":"Delete AdGroupFeed","order":6,"type":"delete","entity":"AdGroupFeed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_feed","is_entity_index":false}}},{"node":{"id":"e0f09a89-59b5-5315-9a4c-3da5e00ecd8e","html":"// Deleting the entity\n\nawait customer.adGroupFeeds.delete('customers/3827277046/adGroupFeeds/69639056828~43009393')// Example AdGroupLabel\nconst ad_group_label = {\n ad_group: 'customers/3827277046/adGroups/69639056828',\n label: 'customers/3827277046/labels/3345231412',\n resource_name: 'customers/3827277046/adGroupLabels/69639056828~3345231412',\n}The customer.adGroupLabels.get(resource_name) method returns the AdGroupLabel identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupLabel
\nReturns that AdGroupLabel as an object.
","frontmatter":{"title":"Get AdGroupLabel","order":2,"type":"get","entity":"AdGroupLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_label","is_entity_index":false}}},{"node":{"id":"f4bca833-a45d-57bd-a8b1-03d691b0ecf0","html":"// Getting the entity\nlet result = await customer.adGroupLabels.get('customers/3827277046/adGroupLabels/69639056828~3345231412')// Example result\n;({\n ad_group: 'customers/3827277046/adGroups/69639056828',\n label: 'customers/3827277046/labels/3345231412',\n resource_name: 'customers/3827277046/adGroupLabels/69639056828~3345231412',\n})The customer.adGroupLabels.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupLabel.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_label property. Any other resources that can be selected with ad_group_label will also be added as properities.
// Listing all the adGroupLabels in the account\nlet result = await customer.adGroupLabels.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupLabels.list({\n constraints: [\n {\n key: 'ad_group_label.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_label.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_label: {\n ad_group: 'customers/3827277046/adGroups/69639056828',\n label: 'customers/3827277046/labels/3345231412',\n resource_name: 'customers/3827277046/adGroupLabels/69639056828~3345231412',\n },\n label: {\n id: 3345231412,\n name: 'My label',\n resource_name: 'customers/3827277046/labels/3345231412',\n status: 2,\n text_label: {\n background_color: '#e993eb',\n description: 'Adgroups where Chloe will write new ads that kick butt.',\n },\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/69639056828',\n campaign: 'customers/3827277046/campaigns/954460701',\n cpc_bid_micros: 4500000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 69639056828,\n labels: ['customers/3827277046/labels/3345231412'],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/69639056828',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n { targeting_dimension: 9, bid_only: false },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/954460701',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/3827277046/campaignBudgets/1234926420',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 954460701,\n labels: ['customers/3827277046/labels/3889728471'],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/954460701',\n serving_status: 2,\n start_date: '2017-10-13',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.adGroupLabels.create(ad_group_label) method makes a new AdGroupLabel in an account. It also supports an array as its first agument for batch operations.
The AdGroupLabel object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst ad_group_label = {\n // Your AdGroupLabel here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.adGroupLabels.create(ad_group_label)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.adGroupLabels.create([ad_group_label, other_ad_group_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroupLabels/69639056828~3345231412'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupLabels.update(ad_group_label) method changes the attributes of an existing adGroupLabels in an account. It also supports an array as its first agument for batch operations.
The AdGroupLabel object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst ad_group_label = {\n resource_name: 'customers/3827277046/adGroupLabels/69639056828~3345231412', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.adGroupLabels.update(ad_group_label)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.adGroupLabels.update([ad_group_label, other_ad_group_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/adGroupLabels/69639056828~3345231412'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.adGroupLabels.delete(resource_name) sets the status field of an AdGroupLabel to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that AdGroupLabel
\nNothing
","frontmatter":{"title":"Delete AdGroupLabel","order":6,"type":"delete","entity":"AdGroupLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_label","is_entity_index":false}}},{"node":{"id":"5cbb0792-b1d2-5718-a195-721635152dff","html":"// Deleting the entity\n\nawait customer.adGroupLabels.delete('customers/3827277046/adGroupLabels/69639056828~3345231412')// Example AdGroupSimulation\nconst ad_group_simulation = {\n ad_group_id: 77057363752,\n cpc_bid_point_list: {\n points: [\n {\n cpc_bid_micros: 1820000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 7,\n cost_micros: 10540000,\n impressions: 151,\n top_slot_impressions: 103,\n },\n {\n cpc_bid_micros: 1910000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 16740000,\n impressions: 187,\n top_slot_impressions: 138,\n },\n {\n cpc_bid_micros: 3830000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 13,\n cost_micros: 32520000,\n impressions: 218,\n top_slot_impressions: 170,\n },\n {\n cpc_bid_micros: 4610000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 16,\n cost_micros: 53450000,\n impressions: 250,\n top_slot_impressions: 200,\n },\n {\n cpc_bid_micros: 5500000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 17,\n cost_micros: 66370000,\n impressions: 280,\n top_slot_impressions: 233,\n },\n {\n cpc_bid_micros: 9600000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 19,\n cost_micros: 127600000,\n impressions: 299,\n top_slot_impressions: 276,\n },\n {\n cpc_bid_micros: 11750000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 20,\n cost_micros: 153720000,\n impressions: 304,\n top_slot_impressions: 281,\n },\n ],\n },\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name: 'customers/3827277046/adGroupSimulations/77057363752~CPC_BID~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 2,\n}The customer.adGroupSimulations.get(resource_name) method returns the AdGroupSimulation identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that AdGroupSimulation
\nReturns that AdGroupSimulation as an object.
","frontmatter":{"title":"Get AdGroupSimulation","order":2,"type":"get","entity":"AdGroupSimulation"},"fields":{"group":"entities","mega_order":0,"directory":"entities/ad_group_simulation","is_entity_index":false}}},{"node":{"id":"29d2b1f8-a717-5189-b075-8ee0a91044c9","html":"// Getting the entity\nlet result = await customer.adGroupSimulations.get(\n 'customers/3827277046/adGroupSimulations/77057363752~CPC_BID~UNIFORM~20200711~20200717'\n)// Example result\n;({\n ad_group_id: 77057363752,\n cpc_bid_point_list: {\n points: [\n {\n cpc_bid_micros: 1820000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 7,\n cost_micros: 10540000,\n impressions: 151,\n top_slot_impressions: 103,\n },\n {\n cpc_bid_micros: 1910000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 16740000,\n impressions: 187,\n top_slot_impressions: 138,\n },\n {\n cpc_bid_micros: 3830000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 13,\n cost_micros: 32520000,\n impressions: 218,\n top_slot_impressions: 170,\n },\n {\n cpc_bid_micros: 4610000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 16,\n cost_micros: 53450000,\n impressions: 250,\n top_slot_impressions: 200,\n },\n {\n cpc_bid_micros: 5500000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 17,\n cost_micros: 66370000,\n impressions: 280,\n top_slot_impressions: 233,\n },\n {\n cpc_bid_micros: 9600000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 19,\n cost_micros: 127600000,\n impressions: 299,\n top_slot_impressions: 276,\n },\n {\n cpc_bid_micros: 11750000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 20,\n cost_micros: 153720000,\n impressions: 304,\n top_slot_impressions: 281,\n },\n ],\n },\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name: 'customers/3827277046/adGroupSimulations/77057363752~CPC_BID~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 2,\n})The customer.adGroupSimulations.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of AdGroupSimulation.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a ad_group_simulation property. Any other resources that can be selected with ad_group_simulation will also be added as properities.
// Listing all the adGroupSimulations in the account\nlet result = await customer.adGroupSimulations.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.adGroupSimulations.list({\n constraints: [\n {\n key: 'ad_group_simulation.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'ad_group_simulation.some_field.sub_field',\n})// Example result\n;[\n {\n ad_group_simulation: {\n ad_group_id: 77057363752,\n cpc_bid_point_list: {\n points: [\n {\n cpc_bid_micros: 1820000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 7,\n cost_micros: 10540000,\n impressions: 151,\n top_slot_impressions: 103,\n },\n {\n cpc_bid_micros: 1910000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 16740000,\n impressions: 187,\n top_slot_impressions: 138,\n },\n {\n cpc_bid_micros: 3830000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 13,\n cost_micros: 32520000,\n impressions: 218,\n top_slot_impressions: 170,\n },\n {\n cpc_bid_micros: 4610000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 16,\n cost_micros: 53450000,\n impressions: 250,\n top_slot_impressions: 200,\n },\n {\n cpc_bid_micros: 5500000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 17,\n cost_micros: 66370000,\n impressions: 280,\n top_slot_impressions: 233,\n },\n {\n cpc_bid_micros: 9600000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 19,\n cost_micros: 127600000,\n impressions: 299,\n top_slot_impressions: 276,\n },\n {\n cpc_bid_micros: 11750000,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 20,\n cost_micros: 153720000,\n impressions: 304,\n top_slot_impressions: 281,\n },\n ],\n },\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name: 'customers/3827277046/adGroupSimulations/77057363752~CPC_BID~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 2,\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/77057363752',\n campaign: 'customers/3827277046/campaigns/2081620948',\n cpc_bid_micros: 9600000,\n cpm_bid_micros: 10000000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 12000000,\n effective_target_cpa_source: 6,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 77057363752,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/77057363752',\n status: 2,\n target_cpa_micros: 12000000,\n target_cpm_micros: 10000000,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: true },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: true },\n { targeting_dimension: 6, bid_only: true },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: true },\n { targeting_dimension: 9, bid_only: true },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/2081620948',\n bidding_strategy_type: 3,\n campaign_budget: 'customers/3827277046/campaignBudgets/6449346162',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 5, positive_geo_target_type: 7 },\n id: 2081620948,\n labels: [\n 'customers/3827277046/labels/3889728216',\n 'customers/3827277046/labels/3889728468',\n 'customers/3827277046/labels/3889728480',\n ],\n manual_cpc: { enhanced_cpc_enabled: true },\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n optimization_score: 0.8309262174345264,\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/2081620948',\n serving_status: 2,\n start_date: '2019-07-30',\n status: 2,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: true }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]// Example Asset\nconst asset = {\n id: 225386305,\n image_asset: {\n file_size: 472254,\n full_size: {\n height_pixels: 628,\n url: 'https://tpc.googlesyndication.com/simgad/11290736009894828590',\n width_pixels: 1200,\n },\n mime_type: 4,\n },\n name: '',\n resource_name: 'customers/3827277046/assets/225386305',\n type: 4,\n}The customer.assets.get(resource_name) method returns the Asset identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that Asset
\nReturns that Asset as an object.
","frontmatter":{"title":"Get Asset","order":2,"type":"get","entity":"Asset"},"fields":{"group":"entities","mega_order":0,"directory":"entities/asset","is_entity_index":false}}},{"node":{"id":"ee37b796-112f-5c1a-b5cc-448a5bfef96c","html":"// Getting the entity\nlet result = await customer.assets.get('customers/3827277046/assets/225386305')// Example result\n;({\n id: 225386305,\n image_asset: {\n file_size: 472254,\n full_size: {\n height_pixels: 628,\n url: 'https://tpc.googlesyndication.com/simgad/11290736009894828590',\n width_pixels: 1200,\n },\n mime_type: 4,\n },\n name: '',\n resource_name: 'customers/3827277046/assets/225386305',\n type: 4,\n})The customer.assets.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of Asset.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a asset property. Any other resources that can be selected with asset will also be added as properities.
// Listing all the assets in the account\nlet result = await customer.assets.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.assets.list({\n constraints: [\n {\n key: 'asset.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'asset.some_field.sub_field',\n})// Example result\n;[\n {\n asset: {\n id: 225386305,\n image_asset: {\n file_size: 472254,\n full_size: {\n height_pixels: 628,\n url: 'https://tpc.googlesyndication.com/simgad/11290736009894828590',\n width_pixels: 1200,\n },\n mime_type: 4,\n },\n name: '',\n resource_name: 'customers/3827277046/assets/225386305',\n type: 4,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.assets.create(asset) method makes a new Asset in an account. It also supports an array as its first agument for batch operations.
The Asset object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst asset = {\n // Your Asset here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.assets.create(asset)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.assets.create([asset, other_asset], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/assets/225386305'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.assets.update(asset) method changes the attributes of an existing assets in an account. It also supports an array as its first agument for batch operations.
The Asset object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst asset = {\n resource_name: 'customers/3827277046/assets/225386305', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.assets.update(asset)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.assets.update([asset, other_asset], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/assets/225386305'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.assets.delete(resource_name) sets the status field of an Asset to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that Asset
\nNothing
","frontmatter":{"title":"Delete Asset","order":6,"type":"delete","entity":"Asset"},"fields":{"group":"entities","mega_order":0,"directory":"entities/asset","is_entity_index":false}}},{"node":{"id":"308e0730-670c-5093-b006-1c3b1e5a004a","html":"// Deleting the entity\n\nawait customer.assets.delete('customers/3827277046/assets/225386305')// Example BiddingStrategy\nconst bidding_strategy = {\n campaign_count: 7,\n id: 2039955526,\n name: 'My bidding strategy',\n non_removed_campaign_count: 7,\n resource_name: 'customers/3827277046/biddingStrategies/2039955526',\n status: 2,\n target_impression_share: { cpc_bid_ceiling_micros: 10000000, location: 4, location_fraction_micros: 900000 },\n type: 15,\n}The customer.biddingStrategies.get(resource_name) method returns the BiddingStrategy identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that BiddingStrategy
\nReturns that BiddingStrategy as an object.
","frontmatter":{"title":"Get BiddingStrategy","order":2,"type":"get","entity":"BiddingStrategy"},"fields":{"group":"entities","mega_order":0,"directory":"entities/bidding_strategy","is_entity_index":false}}},{"node":{"id":"f761d2ff-a3af-5270-a1e0-59451885e4cb","html":"// Getting the entity\nlet result = await customer.biddingStrategies.get('customers/3827277046/biddingStrategies/2039955526')// Example result\n;({\n campaign_count: 7,\n id: 2039955526,\n name: 'My bidding strategy',\n non_removed_campaign_count: 7,\n resource_name: 'customers/3827277046/biddingStrategies/2039955526',\n status: 2,\n target_impression_share: { cpc_bid_ceiling_micros: 10000000, location: 4, location_fraction_micros: 900000 },\n type: 15,\n})The customer.biddingStrategies.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of BiddingStrategy.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a bidding_strategy property. Any other resources that can be selected with bidding_strategy will also be added as properities.
// Listing all the biddingStrategies in the account\nlet result = await customer.biddingStrategies.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.biddingStrategies.list({\n constraints: [\n {\n key: 'bidding_strategy.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'bidding_strategy.some_field.sub_field',\n})// Example result\n;[\n {\n bidding_strategy: {\n campaign_count: 7,\n id: 2039955526,\n name: 'My bidding strategy',\n non_removed_campaign_count: 7,\n resource_name: 'customers/3827277046/biddingStrategies/2039955526',\n status: 2,\n target_impression_share: { cpc_bid_ceiling_micros: 10000000, location: 4, location_fraction_micros: 900000 },\n type: 15,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.biddingStrategies.create(bidding_strategy) method makes a new BiddingStrategy in an account. It also supports an array as its first agument for batch operations.
The BiddingStrategy object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst bidding_strategy = {\n // Your BiddingStrategy here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.biddingStrategies.create(bidding_strategy)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.biddingStrategies.create([bidding_strategy, other_bidding_strategy], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/biddingStrategies/2039955526'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.biddingStrategies.update(bidding_strategy) method changes the attributes of an existing biddingStrategies in an account. It also supports an array as its first agument for batch operations.
The BiddingStrategy object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst bidding_strategy = {\n resource_name: 'customers/3827277046/biddingStrategies/2039955526', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.biddingStrategies.update(bidding_strategy)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.biddingStrategies.update([bidding_strategy, other_bidding_strategy], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/biddingStrategies/2039955526'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.biddingStrategies.delete(resource_name) sets the status field of a BiddingStrategy to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that BiddingStrategy
\nNothing
","frontmatter":{"title":"Delete BiddingStrategy","order":6,"type":"delete","entity":"BiddingStrategy"},"fields":{"group":"entities","mega_order":0,"directory":"entities/bidding_strategy","is_entity_index":false}}},{"node":{"id":"85f4f71f-85d7-53d2-a9a7-a38fd06d00e3","html":"// Deleting the entity\n\nawait customer.biddingStrategies.delete('customers/3827277046/biddingStrategies/2039955526')// Example BillingSetup\nconst billing_setup = {\n end_time_type: 3,\n id: 465508048,\n resource_name: 'customers/9262111890/billingSetups/465508048',\n start_date_time: '2018-07-23 15:51:33',\n status: 2,\n}The customer.billingSetups.get(resource_name) method returns the BillingSetup identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that BillingSetup
\nReturns that BillingSetup as an object.
","frontmatter":{"title":"Get BillingSetup","order":2,"type":"get","entity":"BillingSetup"},"fields":{"group":"entities","mega_order":0,"directory":"entities/billing_setup","is_entity_index":false}}},{"node":{"id":"3accb50d-e7b7-5c1d-bf47-e281dffb375e","html":"// Getting the entity\nlet result = await customer.billingSetups.get('customers/9262111890/billingSetups/465508048')// Example result\n;({\n end_time_type: 3,\n id: 465508048,\n resource_name: 'customers/9262111890/billingSetups/465508048',\n start_date_time: '2018-07-23 15:51:33',\n status: 2,\n})The customer.billingSetups.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of BillingSetup.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a billing_setup property. Any other resources that can be selected with billing_setup will also be added as properities.
// Listing all the billingSetups in the account\nlet result = await customer.billingSetups.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.billingSetups.list({\n constraints: [\n {\n key: 'billing_setup.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'billing_setup.some_field.sub_field',\n})// Example result\n;[\n {\n billing_setup: {\n end_time_type: 3,\n id: 465508048,\n resource_name: 'customers/9262111890/billingSetups/465508048',\n start_date_time: '2018-07-23 15:51:33',\n status: 2,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.billingSetups.create(billing_setup) method makes a new BillingSetup in an account. It also supports an array as its first agument for batch operations.
The BillingSetup object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst billing_setup = {\n // Your BillingSetup here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.billingSetups.create(billing_setup)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.billingSetups.create([billing_setup, other_billing_setup], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/billingSetups/465508048'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.billingSetups.update(billing_setup) method changes the attributes of an existing billingSetups in an account. It also supports an array as its first agument for batch operations.
The BillingSetup object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst billing_setup = {\n resource_name: 'customers/9262111890/billingSetups/465508048', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.billingSetups.update(billing_setup)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.billingSetups.update([billing_setup, other_billing_setup], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/billingSetups/465508048'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.billingSetups.delete(resource_name) sets the status field of a BillingSetup to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that BillingSetup
\nNothing
","frontmatter":{"title":"Delete BillingSetup","order":6,"type":"delete","entity":"BillingSetup"},"fields":{"group":"entities","mega_order":0,"directory":"entities/billing_setup","is_entity_index":false}}},{"node":{"id":"640f8f90-96a2-5484-bbe5-a9ffe3753009","html":"// Deleting the entity\n\nawait customer.billingSetups.delete('customers/9262111890/billingSetups/465508048')// Example Campaign\nconst campaign = {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 3,\n base_campaign: 'customers/9262111890/campaigns/1568629385',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1624493702',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1568629385,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: false,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1568629385',\n serving_status: 2,\n start_date: '2018-09-19',\n status: 4,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n}The customer.campaigns.get(resource_name) method returns the Campaign identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that Campaign
\nReturns that Campaign as an object.
","frontmatter":{"title":"Get Campaign","order":2,"type":"get","entity":"Campaign"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign","is_entity_index":false}}},{"node":{"id":"69d5ce34-8103-5be3-9a3d-ee00f82baad5","html":"// Getting the entity\nlet result = await customer.campaigns.get('customers/9262111890/campaigns/1568629385')// Example result\n;({\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 3,\n base_campaign: 'customers/9262111890/campaigns/1568629385',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1624493702',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1568629385,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: false,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1568629385',\n serving_status: 2,\n start_date: '2018-09-19',\n status: 4,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n})The customer.campaigns.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of Campaign.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign property. Any other resources that can be selected with campaign will also be added as properities.
// Listing all the campaigns in the account\nlet result = await customer.campaigns.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaigns.list({\n constraints: [\n {\n key: 'campaign.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign.some_field.sub_field',\n})// Example result\n;[\n {\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 3,\n base_campaign: 'customers/9262111890/campaigns/1568629385',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1624493702',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1568629385,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: false,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1568629385',\n serving_status: 2,\n start_date: '2018-09-19',\n status: 4,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n campaign_budget: {\n amount_micros: 12000000,\n delivery_method: 2,\n explicitly_shared: false,\n has_recommended_budget: false,\n id: 1624493702,\n name: 'My campaign budget',\n period: 2,\n reference_count: 0,\n resource_name: 'customers/9262111890/campaignBudgets/1624493702',\n status: 3,\n type: 2,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.campaigns.create(campaign) method makes a new Campaign in an account. It also supports an array as its first agument for batch operations.
The Campaign object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign = {\n // Your Campaign here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaigns.create(campaign)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaigns.create([campaign, other_campaign], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaigns/1568629385'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaigns.update(campaign) method changes the attributes of an existing campaigns in an account. It also supports an array as its first agument for batch operations.
The Campaign object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign = {\n resource_name: 'customers/9262111890/campaigns/1568629385', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaigns.update(campaign)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaigns.update([campaign, other_campaign], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaigns/1568629385'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaigns.delete(resource_name) sets the status field of a Campaign to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that Campaign
\nNothing
","frontmatter":{"title":"Delete Campaign","order":6,"type":"delete","entity":"Campaign"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign","is_entity_index":false}}},{"node":{"id":"346f504a-b481-57b7-99cc-4fe404a24737","html":"// Deleting the entity\n\nawait customer.campaigns.delete('customers/9262111890/campaigns/1568629385')// Example CampaignBidModifier\nconst campaign_bid_modifier = {\n campaign: 'customers/3827277046/campaigns/881817006',\n criterion_id: 8000,\n resource_name: 'customers/3827277046/campaignBidModifiers/881817006~8000',\n}The customer.campaignBidModifiers.get(resource_name) method returns the CampaignBidModifier identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignBidModifier
\nReturns that CampaignBidModifier as an object.
","frontmatter":{"title":"Get CampaignBidModifier","order":2,"type":"get","entity":"CampaignBidModifier"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_bid_modifier","is_entity_index":false}}},{"node":{"id":"8a8cf634-e91c-5e18-a554-ee093066341f","html":"// Getting the entity\nlet result = await customer.campaignBidModifiers.get('customers/3827277046/campaignBidModifiers/881817006~8000')// Example result\n;({\n campaign: 'customers/3827277046/campaigns/881817006',\n criterion_id: 8000,\n resource_name: 'customers/3827277046/campaignBidModifiers/881817006~8000',\n})The customer.campaignBidModifiers.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignBidModifier.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_bid_modifier property. Any other resources that can be selected with campaign_bid_modifier will also be added as properities.
// Listing all the campaignBidModifiers in the account\nlet result = await customer.campaignBidModifiers.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignBidModifiers.list({\n constraints: [\n {\n key: 'campaign_bid_modifier.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_bid_modifier.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_bid_modifier: {\n campaign: 'customers/3827277046/campaigns/881817006',\n criterion_id: 8000,\n resource_name: 'customers/3827277046/campaignBidModifiers/881817006~8000',\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/881817006',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/3827277046/campaignBudgets/1159840470',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 881817006,\n labels: ['customers/3827277046/labels/898377018'],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/881817006',\n serving_status: 2,\n start_date: '2017-07-12',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n tracking_url_template:\n 'https://ad.atdmt.com/s/go;adv=11202207688256;ec=11202207688723;c.a={campaignid};s.a=google;p.a={campaignid};as.a={adgroupid};qpb=1;?bidkw={keyword:defaultkeyword}&dvc={device}&h={lpurl}?utm_source=adwords&utm_medium=PPC&utm_campaign={campaignid}&utm_term={ifsearch:{keyword}}{ifcontent:{placement}}&utm_content={creative}&network={network}&adgroupid={adgroupid}&matchtype={matchtype}&adposition={adposition}&targetid={targetid}&target={target}&device={device}&devicemodel={devicemodel}',\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.campaignBidModifiers.create(campaign_bid_modifier) method makes a new CampaignBidModifier in an account. It also supports an array as its first agument for batch operations.
The CampaignBidModifier object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign_bid_modifier = {\n // Your CampaignBidModifier here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaignBidModifiers.create(campaign_bid_modifier)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaignBidModifiers.create([campaign_bid_modifier, other_campaign_bid_modifier], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/campaignBidModifiers/881817006~8000'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignBidModifiers.update(campaign_bid_modifier) method changes the attributes of an existing campaignBidModifiers in an account. It also supports an array as its first agument for batch operations.
The CampaignBidModifier object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign_bid_modifier = {\n resource_name: 'customers/3827277046/campaignBidModifiers/881817006~8000', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaignBidModifiers.update(campaign_bid_modifier)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaignBidModifiers.update([campaign_bid_modifier, other_campaign_bid_modifier], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/campaignBidModifiers/881817006~8000'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignBidModifiers.delete(resource_name) sets the status field of a CampaignBidModifier to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CampaignBidModifier
\nNothing
","frontmatter":{"title":"Delete CampaignBidModifier","order":6,"type":"delete","entity":"CampaignBidModifier"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_bid_modifier","is_entity_index":false}}},{"node":{"id":"c4e980a0-bf15-5be2-9dc1-ef697d372ffa","html":"// Deleting the entity\n\nawait customer.campaignBidModifiers.delete('customers/3827277046/campaignBidModifiers/881817006~8000')// Example CampaignBudget\nconst campaign_budget = {\n amount_micros: 12000000,\n delivery_method: 2,\n explicitly_shared: false,\n has_recommended_budget: false,\n id: 1624493702,\n name: 'My campaign budget',\n period: 2,\n reference_count: 0,\n resource_name: 'customers/9262111890/campaignBudgets/1624493702',\n status: 3,\n type: 2,\n}The customer.campaignBudgets.get(resource_name) method returns the CampaignBudget identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignBudget
\nReturns that CampaignBudget as an object.
","frontmatter":{"title":"Get CampaignBudget","order":2,"type":"get","entity":"CampaignBudget"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_budget","is_entity_index":false}}},{"node":{"id":"3b872652-f86e-5b19-bcbd-7ee0f44ccbdd","html":"// Getting the entity\nlet result = await customer.campaignBudgets.get('customers/9262111890/campaignBudgets/1624493702')// Example result\n;({\n amount_micros: 12000000,\n delivery_method: 2,\n explicitly_shared: false,\n has_recommended_budget: false,\n id: 1624493702,\n name: 'My campaign budget',\n period: 2,\n reference_count: 0,\n resource_name: 'customers/9262111890/campaignBudgets/1624493702',\n status: 3,\n type: 2,\n})The customer.campaignBudgets.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignBudget.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_budget property. Any other resources that can be selected with campaign_budget will also be added as properities.
// Listing all the campaignBudgets in the account\nlet result = await customer.campaignBudgets.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignBudgets.list({\n constraints: [\n {\n key: 'campaign_budget.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_budget.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_budget: {\n amount_micros: 12000000,\n delivery_method: 2,\n explicitly_shared: false,\n has_recommended_budget: false,\n id: 1624493702,\n name: 'My campaign budget',\n period: 2,\n reference_count: 0,\n resource_name: 'customers/9262111890/campaignBudgets/1624493702',\n status: 3,\n type: 2,\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 3,\n base_campaign: 'customers/9262111890/campaigns/1568629385',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1624493702',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1568629385,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: false,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1568629385',\n serving_status: 2,\n start_date: '2018-09-19',\n status: 4,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.campaignBudgets.create(campaign_budget) method makes a new CampaignBudget in an account. It also supports an array as its first agument for batch operations.
The CampaignBudget object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign_budget = {\n // Your CampaignBudget here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaignBudgets.create(campaign_budget)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaignBudgets.create([campaign_budget, other_campaign_budget], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignBudgets/1624493702'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignBudgets.update(campaign_budget) method changes the attributes of an existing campaignBudgets in an account. It also supports an array as its first agument for batch operations.
The CampaignBudget object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign_budget = {\n resource_name: 'customers/9262111890/campaignBudgets/1624493702', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaignBudgets.update(campaign_budget)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaignBudgets.update([campaign_budget, other_campaign_budget], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignBudgets/1624493702'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignBudgets.delete(resource_name) sets the status field of a CampaignBudget to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CampaignBudget
\nNothing
","frontmatter":{"title":"Delete CampaignBudget","order":6,"type":"delete","entity":"CampaignBudget"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_budget","is_entity_index":false}}},{"node":{"id":"5b1a379e-9d6e-5b52-b83e-a8fd073b835b","html":"// Deleting the entity\n\nawait customer.campaignBudgets.delete('customers/9262111890/campaignBudgets/1624493702')// Example CampaignCriterion\nconst campaign_criterion = {\n campaign: 'customers/9262111890/campaigns/1483704368',\n criterion_id: 1000,\n language: { language_constant: 'languageConstants/1000' },\n negative: false,\n resource_name: 'customers/9262111890/campaignCriteria/1483704368~1000',\n status: 2,\n type: 20,\n}The customer.campaignCriteria.get(resource_name) method returns the CampaignCriterion identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignCriterion
\nReturns that CampaignCriterion as an object.
","frontmatter":{"title":"Get CampaignCriterion","order":2,"type":"get","entity":"CampaignCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_criterion","is_entity_index":false}}},{"node":{"id":"75657448-3fe2-59cb-9671-2cf5ce4cc4df","html":"// Getting the entity\nlet result = await customer.campaignCriteria.get('customers/9262111890/campaignCriteria/1483704368~1000')// Example result\n;({\n campaign: 'customers/9262111890/campaigns/1483704368',\n criterion_id: 1000,\n language: { language_constant: 'languageConstants/1000' },\n negative: false,\n resource_name: 'customers/9262111890/campaignCriteria/1483704368~1000',\n status: 2,\n type: 20,\n})The customer.campaignCriteria.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignCriterion.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_criterion property. Any other resources that can be selected with campaign_criterion will also be added as properities.
// Listing all the campaignCriteria in the account\nlet result = await customer.campaignCriteria.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignCriteria.list({\n constraints: [\n {\n key: 'campaign_criterion.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_criterion.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_criterion: {\n campaign: 'customers/9262111890/campaigns/1483704368',\n criterion_id: 1000,\n language: { language_constant: 'languageConstants/1000' },\n negative: false,\n resource_name: 'customers/9262111890/campaignCriteria/1483704368~1000',\n status: 2,\n type: 20,\n },\n language_constant: {\n code: 'en',\n id: 1000,\n name: 'My language constant',\n resource_name: 'languageConstants/1000',\n targetable: true,\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1483704368',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1547508174',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1483704368,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1483704368',\n serving_status: 2,\n start_date: '2018-07-23',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 12000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.campaignCriteria.create(campaign_criterion) method makes a new CampaignCriterion in an account. It also supports an array as its first agument for batch operations.
The CampaignCriterion object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign_criterion = {\n // Your CampaignCriterion here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaignCriteria.create(campaign_criterion)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaignCriteria.create([campaign_criterion, other_campaign_criterion], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignCriteria/1483704368~1000'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignCriteria.update(campaign_criterion) method changes the attributes of an existing campaignCriteria in an account. It also supports an array as its first agument for batch operations.
The CampaignCriterion object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign_criterion = {\n resource_name: 'customers/9262111890/campaignCriteria/1483704368~1000', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaignCriteria.update(campaign_criterion)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaignCriteria.update([campaign_criterion, other_campaign_criterion], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignCriteria/1483704368~1000'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignCriteria.delete(resource_name) sets the status field of a CampaignCriterion to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CampaignCriterion
\nNothing
","frontmatter":{"title":"Delete CampaignCriterion","order":6,"type":"delete","entity":"CampaignCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_criterion","is_entity_index":false}}},{"node":{"id":"ed32382a-5949-5e13-b40e-27fa1ca7f4ad","html":"// Deleting the entity\n\nawait customer.campaignCriteria.delete('customers/9262111890/campaignCriteria/1483704368~1000')// Example CampaignCriterionSimulation\nconst campaign_criterion_simulation = {\n bid_modifier_point_list: {\n points: [\n {\n bid_modifier: 0.2,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 3630000,\n impressions: 141,\n top_slot_impressions: 94,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 70,\n parent_cost_micros: 451520000,\n parent_impressions: 1605,\n parent_top_slot_impressions: 1349,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.34,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 3630000,\n impressions: 157,\n top_slot_impressions: 114,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 70,\n parent_cost_micros: 451520000,\n parent_impressions: 1621,\n parent_top_slot_impressions: 1369,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.45,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 13060000,\n impressions: 176,\n top_slot_impressions: 131,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 72,\n parent_cost_micros: 460950000,\n parent_impressions: 1640,\n parent_top_slot_impressions: 1386,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.48,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 6,\n cost_micros: 16090000,\n impressions: 190,\n top_slot_impressions: 149,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 73,\n parent_cost_micros: 463980000,\n parent_impressions: 1654,\n parent_top_slot_impressions: 1404,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.49,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 7,\n cost_micros: 19470000,\n impressions: 204,\n top_slot_impressions: 163,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 74,\n parent_cost_micros: 467360000,\n parent_impressions: 1668,\n parent_top_slot_impressions: 1418,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.59,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 8,\n cost_micros: 25000000,\n impressions: 220,\n top_slot_impressions: 181,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 75,\n parent_cost_micros: 472890000,\n parent_impressions: 1684,\n parent_top_slot_impressions: 1436,\n parent_required_budget_micros: 90410000,\n },\n {\n bid_modifier: 0.77,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 37330000,\n impressions: 236,\n top_slot_impressions: 201,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 76,\n parent_cost_micros: 485220000,\n parent_impressions: 1700,\n parent_top_slot_impressions: 1456,\n parent_required_budget_micros: 91090000,\n },\n {\n bid_modifier: 1,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 48160000,\n impressions: 252,\n top_slot_impressions: 220,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 76,\n parent_cost_micros: 496050000,\n parent_impressions: 1716,\n parent_top_slot_impressions: 1475,\n parent_required_budget_micros: 92690000,\n },\n {\n bid_modifier: 1.82,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 10,\n cost_micros: 84630000,\n impressions: 272,\n top_slot_impressions: 234,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 77,\n parent_cost_micros: 532520000,\n parent_impressions: 1736,\n parent_top_slot_impressions: 1489,\n parent_required_budget_micros: 94830000,\n },\n {\n bid_modifier: 4.51,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 10,\n cost_micros: 89710000,\n impressions: 296,\n top_slot_impressions: 244,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 77,\n parent_cost_micros: 537600000,\n parent_impressions: 1760,\n parent_top_slot_impressions: 1499,\n parent_required_budget_micros: 99910000,\n },\n ],\n },\n campaign_id: 2081620945,\n criterion_id: 30001,\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name:\n 'customers/3827277046/campaignCriterionSimulations/2081620945~30001~BID_MODIFIER~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 5,\n}The customer.campaignCriterionSimulations.get(resource_name) method returns the CampaignCriterionSimulation identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignCriterionSimulation
\nReturns that CampaignCriterionSimulation as an object.
","frontmatter":{"title":"Get CampaignCriterionSimulation","order":2,"type":"get","entity":"CampaignCriterionSimulation"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_criterion_simulation","is_entity_index":false}}},{"node":{"id":"4da313bc-9f28-50fd-8bd5-6b5eb77c68dd","html":"// Getting the entity\nlet result = await customer.campaignCriterionSimulations.get(\n 'customers/3827277046/campaignCriterionSimulations/2081620945~30001~BID_MODIFIER~UNIFORM~20200711~20200717'\n)// Example result\n;({\n bid_modifier_point_list: {\n points: [\n {\n bid_modifier: 0.2,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 3630000,\n impressions: 141,\n top_slot_impressions: 94,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 70,\n parent_cost_micros: 451520000,\n parent_impressions: 1605,\n parent_top_slot_impressions: 1349,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.34,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 3630000,\n impressions: 157,\n top_slot_impressions: 114,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 70,\n parent_cost_micros: 451520000,\n parent_impressions: 1621,\n parent_top_slot_impressions: 1369,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.45,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 13060000,\n impressions: 176,\n top_slot_impressions: 131,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 72,\n parent_cost_micros: 460950000,\n parent_impressions: 1640,\n parent_top_slot_impressions: 1386,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.48,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 6,\n cost_micros: 16090000,\n impressions: 190,\n top_slot_impressions: 149,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 73,\n parent_cost_micros: 463980000,\n parent_impressions: 1654,\n parent_top_slot_impressions: 1404,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.49,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 7,\n cost_micros: 19470000,\n impressions: 204,\n top_slot_impressions: 163,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 74,\n parent_cost_micros: 467360000,\n parent_impressions: 1668,\n parent_top_slot_impressions: 1418,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.59,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 8,\n cost_micros: 25000000,\n impressions: 220,\n top_slot_impressions: 181,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 75,\n parent_cost_micros: 472890000,\n parent_impressions: 1684,\n parent_top_slot_impressions: 1436,\n parent_required_budget_micros: 90410000,\n },\n {\n bid_modifier: 0.77,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 37330000,\n impressions: 236,\n top_slot_impressions: 201,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 76,\n parent_cost_micros: 485220000,\n parent_impressions: 1700,\n parent_top_slot_impressions: 1456,\n parent_required_budget_micros: 91090000,\n },\n {\n bid_modifier: 1,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 48160000,\n impressions: 252,\n top_slot_impressions: 220,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 76,\n parent_cost_micros: 496050000,\n parent_impressions: 1716,\n parent_top_slot_impressions: 1475,\n parent_required_budget_micros: 92690000,\n },\n {\n bid_modifier: 1.82,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 10,\n cost_micros: 84630000,\n impressions: 272,\n top_slot_impressions: 234,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 77,\n parent_cost_micros: 532520000,\n parent_impressions: 1736,\n parent_top_slot_impressions: 1489,\n parent_required_budget_micros: 94830000,\n },\n {\n bid_modifier: 4.51,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 10,\n cost_micros: 89710000,\n impressions: 296,\n top_slot_impressions: 244,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 77,\n parent_cost_micros: 537600000,\n parent_impressions: 1760,\n parent_top_slot_impressions: 1499,\n parent_required_budget_micros: 99910000,\n },\n ],\n },\n campaign_id: 2081620945,\n criterion_id: 30001,\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name:\n 'customers/3827277046/campaignCriterionSimulations/2081620945~30001~BID_MODIFIER~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 5,\n})The customer.campaignCriterionSimulations.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignCriterionSimulation.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_criterion_simulation property. Any other resources that can be selected with campaign_criterion_simulation will also be added as properities.
// Listing all the campaignCriterionSimulations in the account\nlet result = await customer.campaignCriterionSimulations.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignCriterionSimulations.list({\n constraints: [\n {\n key: 'campaign_criterion_simulation.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_criterion_simulation.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_criterion_simulation: {\n bid_modifier_point_list: {\n points: [\n {\n bid_modifier: 0.2,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 3630000,\n impressions: 141,\n top_slot_impressions: 94,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 70,\n parent_cost_micros: 451520000,\n parent_impressions: 1605,\n parent_top_slot_impressions: 1349,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.34,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 3,\n cost_micros: 3630000,\n impressions: 157,\n top_slot_impressions: 114,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 70,\n parent_cost_micros: 451520000,\n parent_impressions: 1621,\n parent_top_slot_impressions: 1369,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.45,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 5,\n cost_micros: 13060000,\n impressions: 176,\n top_slot_impressions: 131,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 72,\n parent_cost_micros: 460950000,\n parent_impressions: 1640,\n parent_top_slot_impressions: 1386,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.48,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 6,\n cost_micros: 16090000,\n impressions: 190,\n top_slot_impressions: 149,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 73,\n parent_cost_micros: 463980000,\n parent_impressions: 1654,\n parent_top_slot_impressions: 1404,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.49,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 7,\n cost_micros: 19470000,\n impressions: 204,\n top_slot_impressions: 163,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 74,\n parent_cost_micros: 467360000,\n parent_impressions: 1668,\n parent_top_slot_impressions: 1418,\n parent_required_budget_micros: 88250000,\n },\n {\n bid_modifier: 0.59,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 8,\n cost_micros: 25000000,\n impressions: 220,\n top_slot_impressions: 181,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 75,\n parent_cost_micros: 472890000,\n parent_impressions: 1684,\n parent_top_slot_impressions: 1436,\n parent_required_budget_micros: 90410000,\n },\n {\n bid_modifier: 0.77,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 37330000,\n impressions: 236,\n top_slot_impressions: 201,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 76,\n parent_cost_micros: 485220000,\n parent_impressions: 1700,\n parent_top_slot_impressions: 1456,\n parent_required_budget_micros: 91090000,\n },\n {\n bid_modifier: 1,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 9,\n cost_micros: 48160000,\n impressions: 252,\n top_slot_impressions: 220,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 76,\n parent_cost_micros: 496050000,\n parent_impressions: 1716,\n parent_top_slot_impressions: 1475,\n parent_required_budget_micros: 92690000,\n },\n {\n bid_modifier: 1.82,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 10,\n cost_micros: 84630000,\n impressions: 272,\n top_slot_impressions: 234,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 77,\n parent_cost_micros: 532520000,\n parent_impressions: 1736,\n parent_top_slot_impressions: 1489,\n parent_required_budget_micros: 94830000,\n },\n {\n bid_modifier: 4.51,\n biddable_conversions: 0,\n biddable_conversions_value: 0,\n clicks: 10,\n cost_micros: 89710000,\n impressions: 296,\n top_slot_impressions: 244,\n parent_biddable_conversions: 0,\n parent_biddable_conversions_value: 0,\n parent_clicks: 77,\n parent_cost_micros: 537600000,\n parent_impressions: 1760,\n parent_top_slot_impressions: 1499,\n parent_required_budget_micros: 99910000,\n },\n ],\n },\n campaign_id: 2081620945,\n criterion_id: 30001,\n end_date: '2020-07-17',\n modification_method: 2,\n resource_name:\n 'customers/3827277046/campaignCriterionSimulations/2081620945~30001~BID_MODIFIER~UNIFORM~20200711~20200717',\n start_date: '2020-07-11',\n type: 5,\n },\n campaign_criterion: {\n campaign: 'customers/3827277046/campaigns/2081620945',\n criterion_id: 30001,\n device: { type: 2 },\n negative: false,\n resource_name: 'customers/3827277046/campaignCriteria/2081620945~30001',\n status: 2,\n type: 6,\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/2081620945',\n bidding_strategy_type: 3,\n campaign_budget: 'customers/3827277046/campaignBudgets/6449346159',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 5, positive_geo_target_type: 7 },\n id: 2081620945,\n labels: [\n 'customers/3827277046/labels/3889728216',\n 'customers/3827277046/labels/3889728468',\n 'customers/3827277046/labels/3889728480',\n ],\n manual_cpc: { enhanced_cpc_enabled: true },\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n optimization_score: 0.7376711477461586,\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/2081620945',\n serving_status: 2,\n start_date: '2019-07-30',\n status: 2,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: true }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]// Example CampaignExtensionSetting\nconst campaign_extension_setting = {\n campaign: 'customers/9262111890/campaigns/1483704368',\n device: 0,\n extension_feed_items: [\n 'customers/9262111890/extensionFeedItems/51842193961',\n 'customers/9262111890/extensionFeedItems/51842200495',\n 'customers/9262111890/extensionFeedItems/51844020102',\n 'customers/9262111890/extensionFeedItems/51844028388',\n ],\n extension_type: 10,\n resource_name: 'customers/9262111890/campaignExtensionSettings/1483704368~SITELINK',\n}The customer.campaignExtensionSettings.get(resource_name) method returns the CampaignExtensionSetting identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignExtensionSetting
\nReturns that CampaignExtensionSetting as an object.
","frontmatter":{"title":"Get CampaignExtensionSetting","order":2,"type":"get","entity":"CampaignExtensionSetting"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_extension_setting","is_entity_index":false}}},{"node":{"id":"7b4c855b-048d-52fa-83db-6abf8341df9c","html":"// Getting the entity\nlet result = await customer.campaignExtensionSettings.get(\n 'customers/9262111890/campaignExtensionSettings/1483704368~SITELINK'\n)// Example result\n;({\n campaign: 'customers/9262111890/campaigns/1483704368',\n device: 0,\n extension_feed_items: [\n 'customers/9262111890/extensionFeedItems/51842193961',\n 'customers/9262111890/extensionFeedItems/51842200495',\n 'customers/9262111890/extensionFeedItems/51844020102',\n 'customers/9262111890/extensionFeedItems/51844028388',\n ],\n extension_type: 10,\n resource_name: 'customers/9262111890/campaignExtensionSettings/1483704368~SITELINK',\n})The customer.campaignExtensionSettings.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignExtensionSetting.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_extension_setting property. Any other resources that can be selected with campaign_extension_setting will also be added as properities.
// Listing all the campaignExtensionSettings in the account\nlet result = await customer.campaignExtensionSettings.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignExtensionSettings.list({\n constraints: [\n {\n key: 'campaign_extension_setting.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_extension_setting.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_extension_setting: {\n campaign: 'customers/9262111890/campaigns/1483704368',\n device: 0,\n extension_feed_items: [\n 'customers/9262111890/extensionFeedItems/51842193961',\n 'customers/9262111890/extensionFeedItems/51842200495',\n 'customers/9262111890/extensionFeedItems/51844020102',\n 'customers/9262111890/extensionFeedItems/51844028388',\n ],\n extension_type: 10,\n resource_name: 'customers/9262111890/campaignExtensionSettings/1483704368~SITELINK',\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1483704368',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1547508174',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1483704368,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1483704368',\n serving_status: 2,\n start_date: '2018-07-23',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 12000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.campaignExtensionSettings.create(campaign_extension_setting) method makes a new CampaignExtensionSetting in an account. It also supports an array as its first agument for batch operations.
The CampaignExtensionSetting object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign_extension_setting = {\n // Your CampaignExtensionSetting here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaignExtensionSettings.create(campaign_extension_setting)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaignExtensionSettings.create(\n [campaign_extension_setting, other_campaign_extension_setting],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/9262111890/campaignExtensionSettings/1483704368~SITELINK'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignExtensionSettings.update(campaign_extension_setting) method changes the attributes of an existing campaignExtensionSettings in an account. It also supports an array as its first agument for batch operations.
The CampaignExtensionSetting object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign_extension_setting = {\n resource_name: 'customers/9262111890/campaignExtensionSettings/1483704368~SITELINK', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaignExtensionSettings.update(campaign_extension_setting)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaignExtensionSettings.update(\n [campaign_extension_setting, other_campaign_extension_setting],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/9262111890/campaignExtensionSettings/1483704368~SITELINK'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignExtensionSettings.delete(resource_name) sets the status field of a CampaignExtensionSetting to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CampaignExtensionSetting
\nNothing
","frontmatter":{"title":"Delete CampaignExtensionSetting","order":6,"type":"delete","entity":"CampaignExtensionSetting"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_extension_setting","is_entity_index":false}}},{"node":{"id":"14da5897-05dd-569b-b793-47617c9d5129","html":"// Deleting the entity\n\nawait customer.campaignExtensionSettings.delete('customers/9262111890/campaignExtensionSettings/1483704368~SITELINK')// Example CampaignFeed\nconst campaign_feed = {\n campaign: 'customers/9262111890/campaigns/1483704368',\n feed: 'customers/9262111890/feeds/82896692',\n matching_function: {\n function_string: 'IN(FEED_ITEM_ID,{51842193961,51842200495,51844020102,51844028388})',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 2,\n right_operands: [\n { constant_operand: { long_value: 51842193961 } },\n { constant_operand: { long_value: 51842200495 } },\n { constant_operand: { long_value: 51844020102 } },\n { constant_operand: { long_value: 51844028388 } },\n ],\n },\n placeholder_types: [],\n resource_name: 'customers/9262111890/campaignFeeds/1483704368~82896692',\n status: 2,\n}The customer.campaignFeeds.get(resource_name) method returns the CampaignFeed identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignFeed
\nReturns that CampaignFeed as an object.
","frontmatter":{"title":"Get CampaignFeed","order":2,"type":"get","entity":"CampaignFeed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_feed","is_entity_index":false}}},{"node":{"id":"ed0bd8bd-476d-5f1d-a9ee-7552d2ab528a","html":"// Getting the entity\nlet result = await customer.campaignFeeds.get('customers/9262111890/campaignFeeds/1483704368~82896692')// Example result\n;({\n campaign: 'customers/9262111890/campaigns/1483704368',\n feed: 'customers/9262111890/feeds/82896692',\n matching_function: {\n function_string: 'IN(FEED_ITEM_ID,{51842193961,51842200495,51844020102,51844028388})',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 2,\n right_operands: [\n { constant_operand: { long_value: 51842193961 } },\n { constant_operand: { long_value: 51842200495 } },\n { constant_operand: { long_value: 51844020102 } },\n { constant_operand: { long_value: 51844028388 } },\n ],\n },\n placeholder_types: [],\n resource_name: 'customers/9262111890/campaignFeeds/1483704368~82896692',\n status: 2,\n})The customer.campaignFeeds.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignFeed.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_feed property. Any other resources that can be selected with campaign_feed will also be added as properities.
// Listing all the campaignFeeds in the account\nlet result = await customer.campaignFeeds.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignFeeds.list({\n constraints: [\n {\n key: 'campaign_feed.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_feed.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_feed: {\n campaign: 'customers/9262111890/campaigns/1483704368',\n feed: 'customers/9262111890/feeds/82896692',\n matching_function: {\n function_string: 'IN(FEED_ITEM_ID,{51842193961,51842200495,51844020102,51844028388})',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 2,\n right_operands: [\n { constant_operand: { long_value: 51842193961 } },\n { constant_operand: { long_value: 51842200495 } },\n { constant_operand: { long_value: 51844020102 } },\n { constant_operand: { long_value: 51844028388 } },\n ],\n },\n placeholder_types: [],\n resource_name: 'customers/9262111890/campaignFeeds/1483704368~82896692',\n status: 2,\n },\n feed: {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 82896692,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/9262111890/feeds/82896692',\n status: 2,\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1483704368',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1547508174',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1483704368,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1483704368',\n serving_status: 2,\n start_date: '2018-07-23',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 12000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.campaignFeeds.create(campaign_feed) method makes a new CampaignFeed in an account. It also supports an array as its first agument for batch operations.
The CampaignFeed object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign_feed = {\n // Your CampaignFeed here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaignFeeds.create(campaign_feed)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaignFeeds.create([campaign_feed, other_campaign_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignFeeds/1483704368~82896692'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignFeeds.update(campaign_feed) method changes the attributes of an existing campaignFeeds in an account. It also supports an array as its first agument for batch operations.
The CampaignFeed object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign_feed = {\n resource_name: 'customers/9262111890/campaignFeeds/1483704368~82896692', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaignFeeds.update(campaign_feed)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaignFeeds.update([campaign_feed, other_campaign_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignFeeds/1483704368~82896692'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignFeeds.delete(resource_name) sets the status field of a CampaignFeed to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CampaignFeed
\nNothing
","frontmatter":{"title":"Delete CampaignFeed","order":6,"type":"delete","entity":"CampaignFeed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_feed","is_entity_index":false}}},{"node":{"id":"521cc80f-930e-54d1-8d94-3a7541040364","html":"// Deleting the entity\n\nawait customer.campaignFeeds.delete('customers/9262111890/campaignFeeds/1483704368~82896692')// Example CampaignLabel\nconst campaign_label = {\n campaign: 'customers/3827277046/campaigns/881817006',\n label: 'customers/3827277046/labels/898377018',\n resource_name: 'customers/3827277046/campaignLabels/881817006~898377018',\n}The customer.campaignLabels.get(resource_name) method returns the CampaignLabel identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignLabel
\nReturns that CampaignLabel as an object.
","frontmatter":{"title":"Get CampaignLabel","order":2,"type":"get","entity":"CampaignLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_label","is_entity_index":false}}},{"node":{"id":"8eeb048e-a298-5599-9d4a-9aefd0aa62f1","html":"// Getting the entity\nlet result = await customer.campaignLabels.get('customers/3827277046/campaignLabels/881817006~898377018')// Example result\n;({\n campaign: 'customers/3827277046/campaigns/881817006',\n label: 'customers/3827277046/labels/898377018',\n resource_name: 'customers/3827277046/campaignLabels/881817006~898377018',\n})The customer.campaignLabels.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignLabel.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_label property. Any other resources that can be selected with campaign_label will also be added as properities.
// Listing all the campaignLabels in the account\nlet result = await customer.campaignLabels.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignLabels.list({\n constraints: [\n {\n key: 'campaign_label.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_label.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_label: {\n campaign: 'customers/3827277046/campaigns/881817006',\n label: 'customers/3827277046/labels/898377018',\n resource_name: 'customers/3827277046/campaignLabels/881817006~898377018',\n },\n label: {\n id: 898377018,\n name: 'My label',\n resource_name: 'customers/3827277046/labels/898377018',\n status: 2,\n text_label: { background_color: '#ccccff', description: '' },\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/881817006',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/3827277046/campaignBudgets/1159840470',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 881817006,\n labels: ['customers/3827277046/labels/898377018'],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/881817006',\n serving_status: 2,\n start_date: '2017-07-12',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n tracking_url_template:\n 'https://ad.atdmt.com/s/go;adv=11202207688256;ec=11202207688723;c.a={campaignid};s.a=google;p.a={campaignid};as.a={adgroupid};qpb=1;?bidkw={keyword:defaultkeyword}&dvc={device}&h={lpurl}?utm_source=adwords&utm_medium=PPC&utm_campaign={campaignid}&utm_term={ifsearch:{keyword}}{ifcontent:{placement}}&utm_content={creative}&network={network}&adgroupid={adgroupid}&matchtype={matchtype}&adposition={adposition}&targetid={targetid}&target={target}&device={device}&devicemodel={devicemodel}',\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.campaignLabels.create(campaign_label) method makes a new CampaignLabel in an account. It also supports an array as its first agument for batch operations.
The CampaignLabel object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign_label = {\n // Your CampaignLabel here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaignLabels.create(campaign_label)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaignLabels.create([campaign_label, other_campaign_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/campaignLabels/881817006~898377018'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignLabels.update(campaign_label) method changes the attributes of an existing campaignLabels in an account. It also supports an array as its first agument for batch operations.
The CampaignLabel object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign_label = {\n resource_name: 'customers/3827277046/campaignLabels/881817006~898377018', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaignLabels.update(campaign_label)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaignLabels.update([campaign_label, other_campaign_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/campaignLabels/881817006~898377018'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignLabels.delete(resource_name) sets the status field of a CampaignLabel to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CampaignLabel
\nNothing
","frontmatter":{"title":"Delete CampaignLabel","order":6,"type":"delete","entity":"CampaignLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_label","is_entity_index":false}}},{"node":{"id":"e41aacbf-01dc-5258-826f-5650f737fe04","html":"// Deleting the entity\n\nawait customer.campaignLabels.delete('customers/3827277046/campaignLabels/881817006~898377018')// Example CampaignSharedSet\nconst campaign_shared_set = {\n campaign: 'customers/9262111890/campaigns/1485014801',\n resource_name: 'customers/9262111890/campaignSharedSets/1485014801~1788591305',\n shared_set: 'customers/9262111890/sharedSets/1788591305',\n status: 3,\n}The customer.campaignSharedSets.get(resource_name) method returns the CampaignSharedSet identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CampaignSharedSet
\nReturns that CampaignSharedSet as an object.
","frontmatter":{"title":"Get CampaignSharedSet","order":2,"type":"get","entity":"CampaignSharedSet"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_shared_set","is_entity_index":false}}},{"node":{"id":"136d86dd-d7ec-526f-ae52-a568334d0d50","html":"// Getting the entity\nlet result = await customer.campaignSharedSets.get('customers/9262111890/campaignSharedSets/1485014801~1788591305')// Example result\n;({\n campaign: 'customers/9262111890/campaigns/1485014801',\n resource_name: 'customers/9262111890/campaignSharedSets/1485014801~1788591305',\n shared_set: 'customers/9262111890/sharedSets/1788591305',\n status: 3,\n})The customer.campaignSharedSets.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CampaignSharedSet.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a campaign_shared_set property. Any other resources that can be selected with campaign_shared_set will also be added as properities.
// Listing all the campaignSharedSets in the account\nlet result = await customer.campaignSharedSets.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.campaignSharedSets.list({\n constraints: [\n {\n key: 'campaign_shared_set.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'campaign_shared_set.some_field.sub_field',\n})// Example result\n;[\n {\n campaign_shared_set: {\n campaign: 'customers/9262111890/campaigns/1485014801',\n resource_name: 'customers/9262111890/campaignSharedSets/1485014801~1788591305',\n shared_set: 'customers/9262111890/sharedSets/1788591305',\n status: 3,\n },\n shared_set: {\n id: 1788591305,\n member_count: 6,\n name: 'My shared set',\n reference_count: 0,\n resource_name: 'customers/9262111890/sharedSets/1788591305',\n status: 2,\n type: 2,\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1485014801',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1548344372',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1485014801,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1485014801',\n serving_status: 2,\n start_date: '2018-07-24',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.campaignSharedSets.create(campaign_shared_set) method makes a new CampaignSharedSet in an account. It also supports an array as its first agument for batch operations.
The CampaignSharedSet object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst campaign_shared_set = {\n // Your CampaignSharedSet here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.campaignSharedSets.create(campaign_shared_set)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.campaignSharedSets.create([campaign_shared_set, other_campaign_shared_set], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignSharedSets/1485014801~1788591305'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignSharedSets.update(campaign_shared_set) method changes the attributes of an existing campaignSharedSets in an account. It also supports an array as its first agument for batch operations.
The CampaignSharedSet object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst campaign_shared_set = {\n resource_name: 'customers/9262111890/campaignSharedSets/1485014801~1788591305', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.campaignSharedSets.update(campaign_shared_set)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.campaignSharedSets.update([campaign_shared_set, other_campaign_shared_set], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/campaignSharedSets/1485014801~1788591305'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.campaignSharedSets.delete(resource_name) sets the status field of a CampaignSharedSet to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CampaignSharedSet
\nNothing
","frontmatter":{"title":"Delete CampaignSharedSet","order":6,"type":"delete","entity":"CampaignSharedSet"},"fields":{"group":"entities","mega_order":0,"directory":"entities/campaign_shared_set","is_entity_index":false}}},{"node":{"id":"bb64a7cd-6971-51a2-a63e-fd925bfe49b0","html":"// Deleting the entity\n\nawait customer.campaignSharedSets.delete('customers/9262111890/campaignSharedSets/1485014801~1788591305')// Example CarrierConstant\nconst carrier_constant = {\n country_code: 'TW',\n id: 70720,\n name: 'Long Distance & Mobile Business Group',\n resource_name: 'carrierConstants/70720',\n}The customer.carrierConstants.get(resource_name) method returns the CarrierConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CarrierConstant
\nReturns that CarrierConstant as an object.
","frontmatter":{"title":"Get CarrierConstant","order":2,"type":"get","entity":"CarrierConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/carrier_constant","is_entity_index":false}}},{"node":{"id":"fbb1d966-24f2-5f8c-9623-ee6de59a72c9","html":"// Getting the entity\nlet result = await customer.carrierConstants.get('carrierConstants/70720')// Example result\n;({\n country_code: 'TW',\n id: 70720,\n name: 'Long Distance & Mobile Business Group',\n resource_name: 'carrierConstants/70720',\n})The customer.carrierConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CarrierConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a carrier_constant property. Any other resources that can be selected with carrier_constant will also be added as properities.
// Listing all the carrierConstants in the account\nlet result = await customer.carrierConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.carrierConstants.list({\n constraints: [\n {\n key: 'carrier_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'carrier_constant.some_field.sub_field',\n})// Example result\n;[\n {\n carrier_constant: {\n country_code: 'TW',\n id: 70720,\n name: 'Long Distance & Mobile Business Group',\n resource_name: 'carrierConstants/70720',\n },\n },\n]// Example ChangeStatus\nconst change_status = {\n feed: 'customers/9262111890/feeds/82896692',\n feed_item: 'customers/9262111890/feedItems/82896692~51844020102',\n last_change_date_time: '2020-07-13 09:01:10.844783',\n resource_name: 'customers/9262111890/changeStatus/1594627270844783-10-82896692-51844020102',\n resource_status: 3,\n resource_type: 10,\n}The customer.changeStatus.get(resource_name) method returns the ChangeStatus identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that ChangeStatus
\nReturns that ChangeStatus as an object.
","frontmatter":{"title":"Get ChangeStatus","order":2,"type":"get","entity":"ChangeStatus"},"fields":{"group":"entities","mega_order":0,"directory":"entities/change_status","is_entity_index":false}}},{"node":{"id":"bd676195-7d43-54c8-b35f-7a4dd1ef2aac","html":"// Getting the entity\nlet result = await customer.changeStatus.get(\n 'customers/9262111890/changeStatus/1594627270844783-10-82896692-51844020102'\n)// Example result\n;({\n feed: 'customers/9262111890/feeds/82896692',\n feed_item: 'customers/9262111890/feedItems/82896692~51844020102',\n last_change_date_time: '2020-07-13 09:01:10.844783',\n resource_name: 'customers/9262111890/changeStatus/1594627270844783-10-82896692-51844020102',\n resource_status: 3,\n resource_type: 10,\n})The customer.changeStatus.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of ChangeStatus.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a change_status property. Any other resources that can be selected with change_status will also be added as properities.
// Listing all the changeStatus in the account\nlet result = await customer.changeStatus.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.changeStatus.list({\n constraints: [\n {\n key: 'change_status.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'change_status.some_field.sub_field',\n})// Example result\n;[\n {\n change_status: {\n feed: 'customers/9262111890/feeds/82896692',\n feed_item: 'customers/9262111890/feedItems/82896692~51844020102',\n last_change_date_time: '2020-07-13 09:01:10.844783',\n resource_name: 'customers/9262111890/changeStatus/1594627270844783-10-82896692-51844020102',\n resource_status: 3,\n resource_type: 10,\n },\n feed: {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 82896692,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/9262111890/feeds/82896692',\n status: 2,\n },\n feed_item: {\n attribute_values: [\n {\n feed_attribute_id: 1,\n string_value: 'my sitelink text',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 3,\n string_value: 'description here',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 4,\n string_value: 'description here line 2',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 5,\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: ['https://myurl.com'],\n double_values_list: [],\n },\n ],\n feed: 'customers/9262111890/feeds/82896692',\n geo_targeting_restriction: 0,\n id: 51844020102,\n policy_infos: [\n {\n placeholder_type_enum: 2,\n feed_mapping_resource_name: 'customers/9262111890/feedMappings/82896692~91300060',\n review_status: 0,\n approval_status: 0,\n policy_topic_entries_list: [],\n validation_status: 4,\n validation_errors_list: [],\n quality_approval_status: 0,\n quality_disapproval_reasons_list: [],\n },\n ],\n resource_name: 'customers/9262111890/feedItems/82896692~51844020102',\n status: 2,\n url_custom_parameters: [],\n },\n ad_group: {\n ad_rotation_mode: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n id: 0,\n labels: [],\n resource_name: '',\n status: 0,\n type: 0,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 0,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 0,\n bidding_strategy_type: 0,\n experiment_type: 0,\n frequency_caps: [],\n id: 0,\n labels: [],\n payment_mode: 0,\n resource_name: '',\n serving_status: 0,\n status: 0,\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]// Example ConversionAction\nconst conversion_action = {\n attribution_model_settings: { attribution_model: 105, data_driven_model_status: 5 },\n category: 5,\n click_through_lookback_window_days: 7,\n counting_type: 3,\n id: 314732636,\n include_in_conversions_metric: true,\n mobile_app_vendor: 1,\n name: 'My conversion action',\n owner_customer: 'customers/9262111890',\n phone_call_duration_seconds: 60,\n resource_name: 'customers/9262111890/conversionActions/314732636',\n status: 3,\n tag_snippets: [\n {\n type: 3,\n page_format: 2,\n global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n event_snippet:\n \"<!-- Event snippet for test-conversion-action-6661770 (created during library test) conversion page\\nIn your html page, add the snippet and call gtag_report_conversion when someone clicks on the chosen link or button. -->\\n<script>\\nfunction gtag_report_conversion(url) {\\n var callback = function () {\\n if (typeof(url) != 'undefined') {\\n window.location = url;\\n }\\n };\\n gtag('event', 'conversion', {\\n 'send_to': 'AW-797556569/5CprCNzgiZYBENn-pvwC',\\n 'value': 5.0,\\n 'currency': 'USD',\\n 'event_callback': callback\\n });\\n return false;\\n}\\n</script>\\n\",\n },\n {\n type: 3,\n page_format: 3,\n global_site_tag:\n '<!-- Global site tag (gtag) - Google Ads: 797556569 -->\\n<amp-analytics type=\"gtag\" data-credentials=\"include\">\\n<script type=\"application/json\">\\n{\\n \"vars\": {\\n \"gtag_id\": \"AW-797556569\",\\n \"config\": {\\n \"AW-797556569\": {\\n \"groups\": \"default\"\\n }\\n }\\n },\\n \"triggers\": {\\n }\\n}\\n</script>\\n</amp-analytics>\\n',\n event_snippet:\n '\"C_yfcHXCUzChg\": {\\n \"on\": \"click\",\\n \"selector\": \"CSS_SELECTOR\",\\n \"vars\": {\\n \"event_name\": \"conversion\",\\n \"value\": 5.0,\\n \"currency\": \"USD\",\\n \"send_to\": [\"AW-797556569/5CprCNzgiZYBENn-pvwC\"]\\n }\\n}\\n',\n },\n {\n type: 2,\n page_format: 2,\n global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n event_snippet:\n \"<!-- Event snippet for test-conversion-action-6661770 (created during library test) conversion page -->\\n<script>\\n gtag('event', 'conversion', {\\n 'send_to': 'AW-797556569/5CprCNzgiZYBENn-pvwC',\\n 'value': 5.0,\\n 'currency': 'USD'\\n });\\n</script>\\n\",\n },\n {\n type: 2,\n page_format: 3,\n global_site_tag:\n '<!-- Global site tag (gtag) - Google Ads: 797556569 -->\\n<amp-analytics type=\"gtag\" data-credentials=\"include\">\\n<script type=\"application/json\">\\n{\\n \"vars\": {\\n \"gtag_id\": \"AW-797556569\",\\n \"config\": {\\n \"AW-797556569\": {\\n \"groups\": \"default\"\\n }\\n }\\n },\\n \"triggers\": {\\n }\\n}\\n</script>\\n</amp-analytics>\\n',\n event_snippet:\n '\"C_yfcHXCUzChg\": {\\n \"on\": \"visible\",\\n \"vars\": {\\n \"event_name\": \"conversion\",\\n \"value\": 5.0,\\n \"currency\": \"USD\",\\n \"send_to\": [\"AW-797556569/5CprCNzgiZYBENn-pvwC\"]\\n }\\n}\\n',\n },\n ],\n type: 8,\n value_settings: { always_use_default_value: false, default_currency_code: 'USD', default_value: 5 },\n view_through_lookback_window_days: 1,\n}The customer.conversionActions.get(resource_name) method returns the ConversionAction identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that ConversionAction
\nReturns that ConversionAction as an object.
","frontmatter":{"title":"Get ConversionAction","order":2,"type":"get","entity":"ConversionAction"},"fields":{"group":"entities","mega_order":0,"directory":"entities/conversion_action","is_entity_index":false}}},{"node":{"id":"71f60a2c-5866-5f92-a08d-343678086f4d","html":"// Getting the entity\nlet result = await customer.conversionActions.get('customers/9262111890/conversionActions/314732636')// Example result\n;({\n attribution_model_settings: { attribution_model: 105, data_driven_model_status: 5 },\n category: 5,\n click_through_lookback_window_days: 7,\n counting_type: 3,\n id: 314732636,\n include_in_conversions_metric: true,\n mobile_app_vendor: 1,\n name: 'My conversion action',\n owner_customer: 'customers/9262111890',\n phone_call_duration_seconds: 60,\n resource_name: 'customers/9262111890/conversionActions/314732636',\n status: 3,\n tag_snippets: [\n {\n type: 3,\n page_format: 2,\n global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n event_snippet:\n \"<!-- Event snippet for test-conversion-action-6661770 (created during library test) conversion page\\nIn your html page, add the snippet and call gtag_report_conversion when someone clicks on the chosen link or button. -->\\n<script>\\nfunction gtag_report_conversion(url) {\\n var callback = function () {\\n if (typeof(url) != 'undefined') {\\n window.location = url;\\n }\\n };\\n gtag('event', 'conversion', {\\n 'send_to': 'AW-797556569/5CprCNzgiZYBENn-pvwC',\\n 'value': 5.0,\\n 'currency': 'USD',\\n 'event_callback': callback\\n });\\n return false;\\n}\\n</script>\\n\",\n },\n {\n type: 3,\n page_format: 3,\n global_site_tag:\n '<!-- Global site tag (gtag) - Google Ads: 797556569 -->\\n<amp-analytics type=\"gtag\" data-credentials=\"include\">\\n<script type=\"application/json\">\\n{\\n \"vars\": {\\n \"gtag_id\": \"AW-797556569\",\\n \"config\": {\\n \"AW-797556569\": {\\n \"groups\": \"default\"\\n }\\n }\\n },\\n \"triggers\": {\\n }\\n}\\n</script>\\n</amp-analytics>\\n',\n event_snippet:\n '\"C_yfcHXCUzChg\": {\\n \"on\": \"click\",\\n \"selector\": \"CSS_SELECTOR\",\\n \"vars\": {\\n \"event_name\": \"conversion\",\\n \"value\": 5.0,\\n \"currency\": \"USD\",\\n \"send_to\": [\"AW-797556569/5CprCNzgiZYBENn-pvwC\"]\\n }\\n}\\n',\n },\n {\n type: 2,\n page_format: 2,\n global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n event_snippet:\n \"<!-- Event snippet for test-conversion-action-6661770 (created during library test) conversion page -->\\n<script>\\n gtag('event', 'conversion', {\\n 'send_to': 'AW-797556569/5CprCNzgiZYBENn-pvwC',\\n 'value': 5.0,\\n 'currency': 'USD'\\n });\\n</script>\\n\",\n },\n {\n type: 2,\n page_format: 3,\n global_site_tag:\n '<!-- Global site tag (gtag) - Google Ads: 797556569 -->\\n<amp-analytics type=\"gtag\" data-credentials=\"include\">\\n<script type=\"application/json\">\\n{\\n \"vars\": {\\n \"gtag_id\": \"AW-797556569\",\\n \"config\": {\\n \"AW-797556569\": {\\n \"groups\": \"default\"\\n }\\n }\\n },\\n \"triggers\": {\\n }\\n}\\n</script>\\n</amp-analytics>\\n',\n event_snippet:\n '\"C_yfcHXCUzChg\": {\\n \"on\": \"visible\",\\n \"vars\": {\\n \"event_name\": \"conversion\",\\n \"value\": 5.0,\\n \"currency\": \"USD\",\\n \"send_to\": [\"AW-797556569/5CprCNzgiZYBENn-pvwC\"]\\n }\\n}\\n',\n },\n ],\n type: 8,\n value_settings: { always_use_default_value: false, default_currency_code: 'USD', default_value: 5 },\n view_through_lookback_window_days: 1,\n})The customer.conversionActions.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of ConversionAction.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a conversion_action property. Any other resources that can be selected with conversion_action will also be added as properities.
// Listing all the conversionActions in the account\nlet result = await customer.conversionActions.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.conversionActions.list({\n constraints: [\n {\n key: 'conversion_action.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'conversion_action.some_field.sub_field',\n})// Example result\n;[\n {\n conversion_action: {\n attribution_model_settings: { attribution_model: 105, data_driven_model_status: 5 },\n category: 5,\n click_through_lookback_window_days: 7,\n counting_type: 3,\n id: 314732636,\n include_in_conversions_metric: true,\n mobile_app_vendor: 1,\n name: 'My conversion action',\n owner_customer: 'customers/9262111890',\n phone_call_duration_seconds: 60,\n resource_name: 'customers/9262111890/conversionActions/314732636',\n status: 3,\n tag_snippets: [\n {\n type: 3,\n page_format: 2,\n global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n event_snippet:\n \"<!-- Event snippet for test-conversion-action-6661770 (created during library test) conversion page\\nIn your html page, add the snippet and call gtag_report_conversion when someone clicks on the chosen link or button. -->\\n<script>\\nfunction gtag_report_conversion(url) {\\n var callback = function () {\\n if (typeof(url) != 'undefined') {\\n window.location = url;\\n }\\n };\\n gtag('event', 'conversion', {\\n 'send_to': 'AW-797556569/5CprCNzgiZYBENn-pvwC',\\n 'value': 5.0,\\n 'currency': 'USD',\\n 'event_callback': callback\\n });\\n return false;\\n}\\n</script>\\n\",\n },\n {\n type: 3,\n page_format: 3,\n global_site_tag:\n '<!-- Global site tag (gtag) - Google Ads: 797556569 -->\\n<amp-analytics type=\"gtag\" data-credentials=\"include\">\\n<script type=\"application/json\">\\n{\\n \"vars\": {\\n \"gtag_id\": \"AW-797556569\",\\n \"config\": {\\n \"AW-797556569\": {\\n \"groups\": \"default\"\\n }\\n }\\n },\\n \"triggers\": {\\n }\\n}\\n</script>\\n</amp-analytics>\\n',\n event_snippet:\n '\"C_yfcHXCUzChg\": {\\n \"on\": \"click\",\\n \"selector\": \"CSS_SELECTOR\",\\n \"vars\": {\\n \"event_name\": \"conversion\",\\n \"value\": 5.0,\\n \"currency\": \"USD\",\\n \"send_to\": [\"AW-797556569/5CprCNzgiZYBENn-pvwC\"]\\n }\\n}\\n',\n },\n {\n type: 2,\n page_format: 2,\n global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n event_snippet:\n \"<!-- Event snippet for test-conversion-action-6661770 (created during library test) conversion page -->\\n<script>\\n gtag('event', 'conversion', {\\n 'send_to': 'AW-797556569/5CprCNzgiZYBENn-pvwC',\\n 'value': 5.0,\\n 'currency': 'USD'\\n });\\n</script>\\n\",\n },\n {\n type: 2,\n page_format: 3,\n global_site_tag:\n '<!-- Global site tag (gtag) - Google Ads: 797556569 -->\\n<amp-analytics type=\"gtag\" data-credentials=\"include\">\\n<script type=\"application/json\">\\n{\\n \"vars\": {\\n \"gtag_id\": \"AW-797556569\",\\n \"config\": {\\n \"AW-797556569\": {\\n \"groups\": \"default\"\\n }\\n }\\n },\\n \"triggers\": {\\n }\\n}\\n</script>\\n</amp-analytics>\\n',\n event_snippet:\n '\"C_yfcHXCUzChg\": {\\n \"on\": \"visible\",\\n \"vars\": {\\n \"event_name\": \"conversion\",\\n \"value\": 5.0,\\n \"currency\": \"USD\",\\n \"send_to\": [\"AW-797556569/5CprCNzgiZYBENn-pvwC\"]\\n }\\n}\\n',\n },\n ],\n type: 8,\n value_settings: { always_use_default_value: false, default_currency_code: 'USD', default_value: 5 },\n view_through_lookback_window_days: 1,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.conversionActions.create(conversion_action) method makes a new ConversionAction in an account. It also supports an array as its first agument for batch operations.
The ConversionAction object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst conversion_action = {\n // Your ConversionAction here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.conversionActions.create(conversion_action)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.conversionActions.create([conversion_action, other_conversion_action], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/conversionActions/314732636'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.conversionActions.update(conversion_action) method changes the attributes of an existing conversionActions in an account. It also supports an array as its first agument for batch operations.
The ConversionAction object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst conversion_action = {\n resource_name: 'customers/9262111890/conversionActions/314732636', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.conversionActions.update(conversion_action)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.conversionActions.update([conversion_action, other_conversion_action], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/conversionActions/314732636'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.conversionActions.delete(resource_name) sets the status field of a ConversionAction to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that ConversionAction
\nNothing
","frontmatter":{"title":"Delete ConversionAction","order":6,"type":"delete","entity":"ConversionAction"},"fields":{"group":"entities","mega_order":0,"directory":"entities/conversion_action","is_entity_index":false}}},{"node":{"id":"ae97dcc7-069c-5909-88c0-68da53f50f9d","html":"// Deleting the entity\n\nawait customer.conversionActions.delete('customers/9262111890/conversionActions/314732636')The customer.conversionUploads.uploadCallConversions(call_conversions) method uploads call conversions to an account. It requires an array of call conversions.
An array of call conversions.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
Boolean adding true will return an array of all uploaded conversions, defaults to false
an array of information for successfully processed CallConversionUpload.
\n If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// uploading CallConversions\n\nconst call_conversions: CallConversion[] = [\n {\n // Your CallConversion here\n },\n {\n // Your CallConversion here\n },\n]\n\n// Getting identifying information for all uploads\nconst result = await customer.conversionUploads.uploadCallConversions(call_conversions, {}, true)\n\n// Getting identifying information for all uploads with options\nconst result = await customer.conversionUploads.uploadCallConversions(\n call_conversions,\n {\n validate_only: true,\n },\n true\n)\n\n// Getting identifying information for the first uploaded item\nconst result = await customer.conversionUploads.uploadCallConversions(call_conversions)// Example result\n\n{\n\tresults: [\n\t\t{\n\t\t\tcaller_id: '+442087599036',\n\t\t\tcall_start_date_time: '2019-01-01 12:32:45-08:00',\n\t\t\tconversion_action: `customer/${CID}/conversionAction/123123123`,\n\t\t\tconversion_date_time: '2019-01-01 12:32:45-08:00',\n\t\t}\n\t],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.conversionUploads.uploadClickConversions(click_conversions) method uploads click conversions to an account. It requires an array of click conversions.
An array of click conversions.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
Boolean adding true will return an array of all uploaded conversions, defaults to false
an array of information for successfully processed ClickConversionUpload.
\n If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// uploading ClickConversions\n\nconst click_conversions: ClickConversion[] = [\n {\n // Your ClickConversion here\n },\n {\n // Your ClickConversion here\n },\n]\n\n// Getting identifying information for all uploads\nconst result = await customer.conversionUploads.uploadClickConversions(click_conversions, {}, true)\n\n// Getting identifying information for all uploads with options\nconst result = await customer.conversionUploads.uploadClickConversions(\n click_conversions,\n {\n validate_only: true,\n },\n true\n)\n\n// Getting identifying information for the first uploaded item\nconst result = await customer.conversionUploads.uploadClickConversions(click_conversions)// Example result\n\n{\n\tresults: [\n\t\t{\n gclid: '42812402112',\n conversion_action: 'beans',\n conversion_date_time: '2019-01-01 12:32:45-08:00',\n conversion_value: 320,\n currency_code: 'GBP',\n order_id: '32894129342',\n external_attribution_data: {\n external_attribution_credit: 925592,\n external_attribution_model: 'heinz',\n }\n\n\t\t}\n\t],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}// Example CustomInterest\nconst custom_interest = {\n description: '',\n id: 13338354,\n members: [\n { member_type: 2, parameter: 'ppc' },\n { member_type: 2, parameter: 'google adwords ppc campaign' },\n { member_type: 2, parameter: 'google adwords ppc advertising' },\n { member_type: 2, parameter: 'ppc and google adwords' },\n { member_type: 2, parameter: 'is google adwords ppc' },\n { member_type: 2, parameter: 'google adwords ppc cost' },\n { member_type: 2, parameter: 'ppc google advertising' },\n { member_type: 2, parameter: 'google ads ppc' },\n { member_type: 2, parameter: 'google ad word campaign' },\n { member_type: 2, parameter: 'google ppc marketing' },\n { member_type: 2, parameter: 'google advertising adwords' },\n { member_type: 2, parameter: 'google ppc campaign' },\n { member_type: 2, parameter: 'what is google ppc advertising' },\n { member_type: 2, parameter: 'adwords ppc campaign' },\n { member_type: 2, parameter: 'google ppc agency' },\n { member_type: 2, parameter: 'google adwords agency' },\n { member_type: 2, parameter: 'google ppc' },\n { member_type: 2, parameter: 'google ppc services' },\n { member_type: 2, parameter: 'google ppc cost' },\n { member_type: 2, parameter: 'what is google ppc' },\n { member_type: 2, parameter: 'google ppc courses' },\n { member_type: 2, parameter: 'google ads' },\n { member_type: 2, parameter: 'adwords' },\n ],\n name: 'My custom interest',\n resource_name: 'customers/3827277046/customInterests/13338354',\n status: 2,\n type: 3,\n}The customer.customInterests.get(resource_name) method returns the CustomInterest identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomInterest
\nReturns that CustomInterest as an object.
","frontmatter":{"title":"Get CustomInterest","order":2,"type":"get","entity":"CustomInterest"},"fields":{"group":"entities","mega_order":0,"directory":"entities/custom_interest","is_entity_index":false}}},{"node":{"id":"36740975-1958-5dd9-afe5-103b9c4e6bad","html":"// Getting the entity\nlet result = await customer.customInterests.get('customers/3827277046/customInterests/13338354')// Example result\n;({\n description: '',\n id: 13338354,\n members: [\n { member_type: 2, parameter: 'ppc' },\n { member_type: 2, parameter: 'google adwords ppc campaign' },\n { member_type: 2, parameter: 'google adwords ppc advertising' },\n { member_type: 2, parameter: 'ppc and google adwords' },\n { member_type: 2, parameter: 'is google adwords ppc' },\n { member_type: 2, parameter: 'google adwords ppc cost' },\n { member_type: 2, parameter: 'ppc google advertising' },\n { member_type: 2, parameter: 'google ads ppc' },\n { member_type: 2, parameter: 'google ad word campaign' },\n { member_type: 2, parameter: 'google ppc marketing' },\n { member_type: 2, parameter: 'google advertising adwords' },\n { member_type: 2, parameter: 'google ppc campaign' },\n { member_type: 2, parameter: 'what is google ppc advertising' },\n { member_type: 2, parameter: 'adwords ppc campaign' },\n { member_type: 2, parameter: 'google ppc agency' },\n { member_type: 2, parameter: 'google adwords agency' },\n { member_type: 2, parameter: 'google ppc' },\n { member_type: 2, parameter: 'google ppc services' },\n { member_type: 2, parameter: 'google ppc cost' },\n { member_type: 2, parameter: 'what is google ppc' },\n { member_type: 2, parameter: 'google ppc courses' },\n { member_type: 2, parameter: 'google ads' },\n { member_type: 2, parameter: 'adwords' },\n ],\n name: 'My custom interest',\n resource_name: 'customers/3827277046/customInterests/13338354',\n status: 2,\n type: 3,\n})The customer.customInterests.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomInterest.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a custom_interest property. Any other resources that can be selected with custom_interest will also be added as properities.
// Listing all the customInterests in the account\nlet result = await customer.customInterests.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customInterests.list({\n constraints: [\n {\n key: 'custom_interest.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'custom_interest.some_field.sub_field',\n})// Example result\n;[\n {\n custom_interest: {\n description: '',\n id: 13338354,\n members: [\n { member_type: 2, parameter: 'ppc' },\n { member_type: 2, parameter: 'google adwords ppc campaign' },\n { member_type: 2, parameter: 'google adwords ppc advertising' },\n { member_type: 2, parameter: 'ppc and google adwords' },\n { member_type: 2, parameter: 'is google adwords ppc' },\n { member_type: 2, parameter: 'google adwords ppc cost' },\n { member_type: 2, parameter: 'ppc google advertising' },\n { member_type: 2, parameter: 'google ads ppc' },\n { member_type: 2, parameter: 'google ad word campaign' },\n { member_type: 2, parameter: 'google ppc marketing' },\n { member_type: 2, parameter: 'google advertising adwords' },\n { member_type: 2, parameter: 'google ppc campaign' },\n { member_type: 2, parameter: 'what is google ppc advertising' },\n { member_type: 2, parameter: 'adwords ppc campaign' },\n { member_type: 2, parameter: 'google ppc agency' },\n { member_type: 2, parameter: 'google adwords agency' },\n { member_type: 2, parameter: 'google ppc' },\n { member_type: 2, parameter: 'google ppc services' },\n { member_type: 2, parameter: 'google ppc cost' },\n { member_type: 2, parameter: 'what is google ppc' },\n { member_type: 2, parameter: 'google ppc courses' },\n { member_type: 2, parameter: 'google ads' },\n { member_type: 2, parameter: 'adwords' },\n ],\n name: 'My custom interest',\n resource_name: 'customers/3827277046/customInterests/13338354',\n status: 2,\n type: 3,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.customInterests.create(custom_interest) method makes a new CustomInterest in an account. It also supports an array as its first agument for batch operations.
The CustomInterest object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst custom_interest = {\n // Your CustomInterest here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.customInterests.create(custom_interest)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.customInterests.create([custom_interest, other_custom_interest], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/customInterests/13338354'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customInterests.update(custom_interest) method changes the attributes of an existing customInterests in an account. It also supports an array as its first agument for batch operations.
The CustomInterest object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst custom_interest = {\n resource_name: 'customers/3827277046/customInterests/13338354', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.customInterests.update(custom_interest)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.customInterests.update([custom_interest, other_custom_interest], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/customInterests/13338354'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customInterests.delete(resource_name) sets the status field of a CustomInterest to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CustomInterest
\nNothing
","frontmatter":{"title":"Delete CustomInterest","order":6,"type":"delete","entity":"CustomInterest"},"fields":{"group":"entities","mega_order":0,"directory":"entities/custom_interest","is_entity_index":false}}},{"node":{"id":"7bdfb37f-43c4-5d06-9031-de89a6109466","html":"// Deleting the entity\n\nawait customer.customInterests.delete('customers/3827277046/customInterests/13338354')The customer resource is the root of all other resources in this library. On top of the usual self-get and self-mutate methods, it also features methods useful for reporting and mutations across several resource types.
\n// Example Customer\nconst customer = {\n resource_name: 'customers/9262111890',\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n test_account: true,\n time_zone: 'Europe/London',\n}The customer.get(resource_name) method returns the Customer identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The ID (aka CID) of that customer, without dashes, such as 1231231234.
Returns that Customer as an object.
","frontmatter":{"title":"Get Customer","order":2,"type":"get","entity":"Customer"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer","is_entity_index":false}}},{"node":{"id":"4c8c3c69-f362-5417-a956-329e5cf4a740","html":"// Getting the entity\nlet result = await customer.get('9262111890')// Example result\n;({\n resource_name: 'customers/9262111890',\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n test_account: true,\n time_zone: 'Europe/London',\n})The customer.query(gaql_string) method takes an SQL-like string and returns the queried rows. For more information about how and when to use this method, see the reporting section.
The SQL-like string.\n
\nAn array of objects, each object containing the keys requested in the query.
","frontmatter":{"title":"Query","order":3,"type":"query","entity":"Customer"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer","is_entity_index":false}}},{"node":{"id":"6cb7b602-55a7-51c6-bdac-33fe0cd84f5e","html":"const ads_with_urls = await customer.query(`\n SELECT \n ad_group.id,\n ad_group_ad.ad.id,\n ad_group_ad.ad.expanded_text_ad.headline_part1,\n ad_group_ad.ad.text_ad.headline,\n metrics.impressions\n FROM \n ad_group_ad \n WHERE \n campaign.status = ENABLED \n AND ad_group_ad.ad.type IN ('TEXT_AD', 'EXPANDED_TEXT_AD')\n AND metrics.impressions > 0 \n AND segments.date >= '2018-02-25'\n AND segments.date <= '2019-03-01'\n ORDER BY metrics.impressions DESC\n LIMIT 3\n`)// result rows\n;[\n {\n ad_group: { resource_name: 'customers/3827277046/adGroups/45808681353', id: 45808681353 },\n ad_group_ad: {\n resource_name: 'customers/3827277046/adGroupAds/45808681353~266534257097',\n ad: { expanded_text_ad: { headline_part_1: 'best ad ever' }, id: 266534257097 },\n },\n metrics: { impressions: 1473 },\n },\n {\n ad_group: { resource_name: 'customers/3827277046/adGroups/45808681353', id: 45808681353 },\n ad_group_ad: {\n resource_name: 'customers/3827277046/adGroupAds/45808681353~304364243717',\n ad: { expanded_text_ad: { headline_part_1: 'next best ad' }, id: 304364243717 },\n },\n metrics: { impressions: 959 },\n },\n {\n ad_group: { resource_name: 'customers/3827277046/adGroups/69639056868', id: 69639056868 },\n ad_group_ad: {\n resource_name: 'customers/3827277046/adGroupAds/69639056868~307847364192',\n ad: { text_ad: { headline: 'pretty okay ad i guess' }, id: 307847364192 },\n },\n metrics: { impressions: 533 },\n },\n]The customer.report() method is very similar to customer.query, except that it takes a query-building object as an argument. For more information about why this is a good idea, see the reporting section
An object of the form:
\n The resource to query. All core resources can be queried, as well as the views defined in the official docs. Note that this field expects resources in snake_case.
The attributes to query. Check the core resource on this page to see which attributes are available.
\nThe metrics to query.
\nThe segments to split your metrics by. Note that segments will increase your number of result rows, and that attributes will simply be repeated.
\nConstraints should be provided as an array. Each constraint is of the form:
\nThe field that you are applying a constraint on.
\n The operator, such as = or NOT IN.
The value to check. This can either be a string or an enum.
\nSince this is quite verbose, we have a few of shorthands explained in the example code to the right.
\n One of the date constants defined in the query grammar, such as LAST_30_DAYS
The start date for any metrics in your query. Only valid if date_constant is not defined.
The end date for any metrics in your query. Defaults to today. Only valid if date_constant is not defined.
The number of rows to return. Useful when used with order_by.
The field to order your results by.
\n The order direction. Either DESC or ASC
This library handles paging automatically. If the number of returned rows is larger than the page size, it will paginate through result sets and return all of the results when done. Defaults to 10,000.
An array of objects, each object containing the keys requested in the query.
","frontmatter":{"title":"Report","order":4,"type":"report","entity":"Customer"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer","is_entity_index":false}}},{"node":{"id":"fdba01af-0174-5450-8abc-d40e2bd749db","html":"// This example will generate the same results as the query() call above\nlet ads_with_urls = await customer.report({\n entity: 'ad_group_ad',\n attributes: [\n 'ad_group_ad.ad.id',\n 'ad_group.id',\n 'ad_group_ad.ad.expanded_text_ad.headline_part1',\n 'ad_group_ad.ad.text_ad.headline',\n ],\n metrics: ['metrics.impressions'],\n constraints: [\n { key: 'metrics.impressions', op: '>', val: 0 },\n {\n 'ad_group_ad.ad.type': [enums.AdType.TEXT_AD, enums.AdType.EXPANDED_TEXT_AD],\n },\n ],\n from_date: '2018-02-25',\n to_date: '2019-03-01',\n order_by: 'metrics.impressions',\n sort_order: 'DESC',\n limit: 3,\n})// result rows\n;[\n {\n ad_group: { resource_name: 'customers/3827277046/adGroups/45808681353', id: 45808681353 },\n ad_group_ad: {\n resource_name: 'customers/3827277046/adGroupAds/45808681353~266534257097',\n ad: { expanded_text_ad: { headline_part_1: 'best ad ever' }, id: 266534257097 },\n },\n metrics: { impressions: 1473 },\n },\n {\n ad_group: { resource_name: 'customers/3827277046/adGroups/45808681353', id: 45808681353 },\n ad_group_ad: {\n resource_name: 'customers/3827277046/adGroupAds/45808681353~304364243717',\n ad: { expanded_text_ad: { headline_part_1: 'next best ad' }, id: 304364243717 },\n },\n metrics: { impressions: 959 },\n },\n {\n ad_group: { resource_name: 'customers/3827277046/adGroups/69639056868', id: 69639056868 },\n ad_group_ad: {\n resource_name: 'customers/3827277046/adGroupAds/69639056868~307847364192',\n ad: { text_ad: { headline: 'pretty okay ad i guess' }, id: 307847364192 },\n },\n metrics: { impressions: 533 },\n },\n]// Constraint shorthands\nconstraints = [\n // clicks > 0, with no shorthand\n { key: 'metrics.clicks', op: '>', val: 0 },\n // campaign.name = \"my campaign\", with object shorthand for \"=\"\n { 'campaign.name': '\"my campaign\"' },\n // campaign.status = \"PAUSED\", with object shorthand for \"=\" on enum\n { 'campaign.status': enums.CampaignStatus.PAUSED },\n // campaign.status IN (\"PAUSED\", \"ENABLED\"), with array shorthand for \"IN\"\n { 'campaign.status': [enums.CampaignStatus.PAUSED, enums.CampaignStatus.ENABLED] },\n]\n\n// If all constraints are using \"=\" or \"IN\", the whole contraints key can be an object instead of an array.\nconstraints = {\n 'campaign.name': '\"my campaign\"',\n 'campaign.status': [enums.CampaignStatus.PAUSED, enums.CampaignStatus.ENABLED],\n}The customer.mutateResources(resources_array) method takes an array of operations, where each operation is mutation to a resource, performs all of these mutations in sequence. By default, a call to customer.mutateResources() is atomic -- either all operations succeed or everything is rolled back.
An array of operations. Each operation looks just like a resource with a few extra keys. They are of the form:
\n The resource type of this operation, such as Campaign or AdGroupAd. All mutable core resources are valid. This string is in TitleCase format.
The mutation type of this operation. Can be create, update, or delete. Defaults to create.
The resource_name of the resource you are operating on. Required for update and deleteoperations, optional for create operations. When creating a resource, if you need to reference this resource in a future operation, use a negative integer as an ID, such as -1.
Any other fields valid for this resource, such as name.
Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
When false, a single failure in the array of operations will cause the whole sequence to be rolled back. When true, the system will attempt to perform the next operations. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\nconst response = await customer.mutateResources([\n\t// Create new budget\n\t{\n\t\t_resource: 'CampaignBudget',\n\t\t_operation: 'create',\n\t\tresource_name: 'customers/3827277046/campaignBudgets/-1',\n\t\tname: 'My new budget',\n\t\tamount_micros: 3000000,\n\t\texplicitly_shared: true,\n\t},\n\t// Update campaign to use the new budget and have a new name\n\t{\n\t\t_resource: 'Campaign',\n\t\t_operation: 'update',\n\t\tname: 'New name for my campaign with a new budget'\n\t\tresource_name: 'customers/3827277046/campaigns/456456456',\n\t\tcampaign_budget: 'customers/3827277046/campaignBudgets/-1',\n\t},\n\t// Delete old budget\n\t{\n\t\t_resource: 'CampaignBudget',\n\t\t_operation: 'delete',\n\t\tresource_name: 'customers/3827277046/campaignBudgets/123123',\n\t},\n]){\n\tresults : [\n\t\t'customers/3827277046/campaignBudgets/265265547' // created\n\t\t'customers/3827277046/campaigns/456456456' // updated\n\t\t'customers/3827277046/campaignBugets/123123' // deleted\n\t],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}// Example CustomerClient\nconst customer_client = {\n client_customer: 'customers/9262111890',\n currency_code: 'EUR',\n descriptive_name: 'My customer client',\n hidden: false,\n id: 9262111890,\n level: 0,\n manager: false,\n resource_name: 'customers/9262111890/customerClients/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n}The customer.customerClients.get(resource_name) method returns the CustomerClient identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomerClient
\nReturns that CustomerClient as an object.
","frontmatter":{"title":"Get CustomerClient","order":2,"type":"get","entity":"CustomerClient"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_client","is_entity_index":false}}},{"node":{"id":"a685fa89-2e93-5541-a314-5a7bcd76cf70","html":"// Getting the entity\nlet result = await customer.customerClients.get('customers/9262111890/customerClients/9262111890')// Example result\n;({\n client_customer: 'customers/9262111890',\n currency_code: 'EUR',\n descriptive_name: 'My customer client',\n hidden: false,\n id: 9262111890,\n level: 0,\n manager: false,\n resource_name: 'customers/9262111890/customerClients/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n})The customer.customerClients.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomerClient.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a customer_client property. Any other resources that can be selected with customer_client will also be added as properities.
// Listing all the customerClients in the account\nlet result = await customer.customerClients.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customerClients.list({\n constraints: [\n {\n key: 'customer_client.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'customer_client.some_field.sub_field',\n})// Example result\n;[\n {\n customer_client: {\n client_customer: 'customers/9262111890',\n currency_code: 'EUR',\n descriptive_name: 'My customer client',\n hidden: false,\n id: 9262111890,\n level: 0,\n manager: false,\n resource_name: 'customers/9262111890/customerClients/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]// Example CustomerClientLink\nconst customer_client_link = /* Todo: add example get() return here */The customer.customerClientLinks.get(resource_name) method returns the CustomerClientLink identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomerClientLink
\nReturns that CustomerClientLink as an object.
","frontmatter":{"title":"Get CustomerClientLink","order":2,"type":"get","entity":"CustomerClientLink"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_client_link","is_entity_index":false}}},{"node":{"id":"cbc3b4fa-31e1-5d8c-b315-2bfe8539096f","html":"// Getting the entity\nlet result = await customer.customerClientLinks.get('customers/1234567890/customerClientLinks/123123123')// Example result\n(/* Todo: add example get() return here */)The customer.customerClientLinks.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomerClientLink.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a customer_client_link property. Any other resources that can be selected with customer_client_link will also be added as properities.
// Listing all the customerClientLinks in the account\nlet result = await customer.customerClientLinks.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customerClientLinks.list({\n constraints: [\n {\n key: 'customer_client_link.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'customer_client_link.some_field.sub_field',\n})// Example result\n;[\n /* Todo: add example list() return here */\n]The customer.customerClientLinks.create(customer_client_link) method makes a new CustomerClientLink in an account. It also supports an array as its first agument for batch operations.
The CustomerClientLink object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst customer_client_link = {\n // Your CustomerClientLink here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.customerClientLinks.create(customer_client_link)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.customerClientLinks.create([customer_client_link, other_customer_client_link], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/customerClientLinks/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerClientLinks.update(customer_client_link) method changes the attributes of an existing customerClientLinks in an account. It also supports an array as its first agument for batch operations.
The CustomerClientLink object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst customer_client_link = {\n resource_name: 'customers/1234567890/customerClientLinks/123123123', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.customerClientLinks.update(customer_client_link)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.customerClientLinks.update([customer_client_link, other_customer_client_link], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/customerClientLinks/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerClientLinks.delete(resource_name) sets the status field of a CustomerClientLink to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CustomerClientLink
\nNothing
","frontmatter":{"title":"Delete CustomerClientLink","order":6,"type":"delete","entity":"CustomerClientLink"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_client_link","is_entity_index":false}}},{"node":{"id":"02c8f35e-4768-5706-8492-8a570b6e80b1","html":"// Deleting the entity\n\nawait customer.customerClientLinks.delete('customers/1234567890/customerClientLinks/123123123')// Example CustomerExtensionSetting\nconst customer_extension_setting = {\n device: 0,\n extension_feed_items: ['customers/9262111890/extensionFeedItems/51842375274'],\n extension_type: 11,\n resource_name: 'customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET',\n}The customer.customerExtensionSettings.get(resource_name) method returns the CustomerExtensionSetting identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomerExtensionSetting
\nReturns that CustomerExtensionSetting as an object.
","frontmatter":{"title":"Get CustomerExtensionSetting","order":2,"type":"get","entity":"CustomerExtensionSetting"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_extension_setting","is_entity_index":false}}},{"node":{"id":"027ed566-0113-5539-8601-d84d156b47e6","html":"// Getting the entity\nlet result = await customer.customerExtensionSettings.get(\n 'customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET'\n)// Example result\n;({\n device: 0,\n extension_feed_items: ['customers/9262111890/extensionFeedItems/51842375274'],\n extension_type: 11,\n resource_name: 'customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET',\n})The customer.customerExtensionSettings.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomerExtensionSetting.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a customer_extension_setting property. Any other resources that can be selected with customer_extension_setting will also be added as properities.
// Listing all the customerExtensionSettings in the account\nlet result = await customer.customerExtensionSettings.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customerExtensionSettings.list({\n constraints: [\n {\n key: 'customer_extension_setting.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'customer_extension_setting.some_field.sub_field',\n})// Example result\n;[\n {\n customer_extension_setting: {\n device: 0,\n extension_feed_items: ['customers/9262111890/extensionFeedItems/51842375274'],\n extension_type: 11,\n resource_name: 'customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET',\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.customerExtensionSettings.create(customer_extension_setting) method makes a new CustomerExtensionSetting in an account. It also supports an array as its first agument for batch operations.
The CustomerExtensionSetting object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst customer_extension_setting = {\n // Your CustomerExtensionSetting here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.customerExtensionSettings.create(customer_extension_setting)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.customerExtensionSettings.create(\n [customer_extension_setting, other_customer_extension_setting],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerExtensionSettings.update(customer_extension_setting) method changes the attributes of an existing customerExtensionSettings in an account. It also supports an array as its first agument for batch operations.
The CustomerExtensionSetting object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst customer_extension_setting = {\n resource_name: 'customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.customerExtensionSettings.update(customer_extension_setting)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.customerExtensionSettings.update(\n [customer_extension_setting, other_customer_extension_setting],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerExtensionSettings.delete(resource_name) sets the status field of a CustomerExtensionSetting to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CustomerExtensionSetting
\nNothing
","frontmatter":{"title":"Delete CustomerExtensionSetting","order":6,"type":"delete","entity":"CustomerExtensionSetting"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_extension_setting","is_entity_index":false}}},{"node":{"id":"187bcdce-aa85-59f7-b9c1-c38a7c7a7f6f","html":"// Deleting the entity\n\nawait customer.customerExtensionSettings.delete('customers/9262111890/customerExtensionSettings/STRUCTURED_SNIPPET')// Example CustomerFeed\nconst customer_feed = {\n feed: 'customers/9262111890/feeds/82896692',\n matching_function: {\n function_string: 'EQUALS(FEED_ITEM_ID,51840594005)',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 4,\n right_operands: [{ constant_operand: { long_value: 51840594005 } }],\n },\n placeholder_types: [],\n resource_name: 'customers/9262111890/customerFeeds/82896692',\n status: 2,\n}The customer.customerFeeds.get(resource_name) method returns the CustomerFeed identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomerFeed
\nReturns that CustomerFeed as an object.
","frontmatter":{"title":"Get CustomerFeed","order":2,"type":"get","entity":"CustomerFeed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_feed","is_entity_index":false}}},{"node":{"id":"09979864-efd5-5c61-b2c9-318737003ce1","html":"// Getting the entity\nlet result = await customer.customerFeeds.get('customers/9262111890/customerFeeds/82896692')// Example result\n;({\n feed: 'customers/9262111890/feeds/82896692',\n matching_function: {\n function_string: 'EQUALS(FEED_ITEM_ID,51840594005)',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 4,\n right_operands: [{ constant_operand: { long_value: 51840594005 } }],\n },\n placeholder_types: [],\n resource_name: 'customers/9262111890/customerFeeds/82896692',\n status: 2,\n})The customer.customerFeeds.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomerFeed.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a customer_feed property. Any other resources that can be selected with customer_feed will also be added as properities.
// Listing all the customerFeeds in the account\nlet result = await customer.customerFeeds.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customerFeeds.list({\n constraints: [\n {\n key: 'customer_feed.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'customer_feed.some_field.sub_field',\n})// Example result\n;[\n {\n customer_feed: {\n feed: 'customers/9262111890/feeds/82896692',\n matching_function: {\n function_string: 'EQUALS(FEED_ITEM_ID,51840594005)',\n left_operands: [{ request_context_operand: { context_type: 2 } }],\n operator: 4,\n right_operands: [{ constant_operand: { long_value: 51840594005 } }],\n },\n placeholder_types: [],\n resource_name: 'customers/9262111890/customerFeeds/82896692',\n status: 2,\n },\n feed: {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 82896692,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/9262111890/feeds/82896692',\n status: 2,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.customerFeeds.create(customer_feed) method makes a new CustomerFeed in an account. It also supports an array as its first agument for batch operations.
The CustomerFeed object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst customer_feed = {\n // Your CustomerFeed here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.customerFeeds.create(customer_feed)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.customerFeeds.create([customer_feed, other_customer_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/customerFeeds/82896692'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerFeeds.update(customer_feed) method changes the attributes of an existing customerFeeds in an account. It also supports an array as its first agument for batch operations.
The CustomerFeed object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst customer_feed = {\n resource_name: 'customers/9262111890/customerFeeds/82896692', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.customerFeeds.update(customer_feed)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.customerFeeds.update([customer_feed, other_customer_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/customerFeeds/82896692'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerFeeds.delete(resource_name) sets the status field of a CustomerFeed to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CustomerFeed
\nNothing
","frontmatter":{"title":"Delete CustomerFeed","order":6,"type":"delete","entity":"CustomerFeed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_feed","is_entity_index":false}}},{"node":{"id":"cd8b3830-b245-5556-a137-33cf3c7cd30a","html":"// Deleting the entity\n\nawait customer.customerFeeds.delete('customers/9262111890/customerFeeds/82896692')// Example CustomerLabel\nconst customer_label = /* Todo: add example get() return here */The customer.customerLabels.get(resource_name) method returns the CustomerLabel identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomerLabel
\nReturns that CustomerLabel as an object.
","frontmatter":{"title":"Get CustomerLabel","order":2,"type":"get","entity":"CustomerLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_label","is_entity_index":false}}},{"node":{"id":"3ab7376a-d17c-55ae-8a3f-bda2c3a6cf3e","html":"// Getting the entity\nlet result = await customer.customerLabels.get('customers/1234567890/customerLabels/123123123')// Example result\n(/* Todo: add example get() return here */)The customer.customerLabels.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomerLabel.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a customer_label property. Any other resources that can be selected with customer_label will also be added as properities.
// Listing all the customerLabels in the account\nlet result = await customer.customerLabels.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customerLabels.list({\n constraints: [\n {\n key: 'customer_label.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'customer_label.some_field.sub_field',\n})// Example result\n;[\n /* Todo: add example list() return here */\n]The customer.customerLabels.create(customer_label) method makes a new CustomerLabel in an account. It also supports an array as its first agument for batch operations.
The CustomerLabel object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst customer_label = {\n // Your CustomerLabel here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.customerLabels.create(customer_label)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.customerLabels.create([customer_label, other_customer_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/customerLabels/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerLabels.update(customer_label) method changes the attributes of an existing customerLabels in an account. It also supports an array as its first agument for batch operations.
The CustomerLabel object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst customer_label = {\n resource_name: 'customers/1234567890/customerLabels/123123123', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.customerLabels.update(customer_label)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.customerLabels.update([customer_label, other_customer_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/customerLabels/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerLabels.delete(resource_name) sets the status field of a CustomerLabel to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CustomerLabel
\nNothing
","frontmatter":{"title":"Delete CustomerLabel","order":6,"type":"delete","entity":"CustomerLabel"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_label","is_entity_index":false}}},{"node":{"id":"e6b4c544-fce0-5463-8b12-9bf7c9db7e4b","html":"// Deleting the entity\n\nawait customer.customerLabels.delete('customers/1234567890/customerLabels/123123123')// Example CustomerManagerLink\nconst customer_manager_link = {\n manager_customer: 'customers/6141549892',\n manager_link_id: 121665495,\n resource_name: 'customers/9262111890/customerManagerLinks/6141549892~121665495',\n status: 2,\n}The customer.customerManagerLinks.get(resource_name) method returns the CustomerManagerLink identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomerManagerLink
\nReturns that CustomerManagerLink as an object.
","frontmatter":{"title":"Get CustomerManagerLink","order":2,"type":"get","entity":"CustomerManagerLink"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_manager_link","is_entity_index":false}}},{"node":{"id":"6f55de33-b5a4-5b6a-894f-ab99105b67c6","html":"// Getting the entity\nlet result = await customer.customerManagerLinks.get('customers/9262111890/customerManagerLinks/6141549892~121665495')// Example result\n;({\n manager_customer: 'customers/6141549892',\n manager_link_id: 121665495,\n resource_name: 'customers/9262111890/customerManagerLinks/6141549892~121665495',\n status: 2,\n})The customer.customerManagerLinks.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomerManagerLink.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a customer_manager_link property. Any other resources that can be selected with customer_manager_link will also be added as properities.
// Listing all the customerManagerLinks in the account\nlet result = await customer.customerManagerLinks.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customerManagerLinks.list({\n constraints: [\n {\n key: 'customer_manager_link.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'customer_manager_link.some_field.sub_field',\n})// Example result\n;[\n {\n customer_manager_link: {\n manager_customer: 'customers/6141549892',\n manager_link_id: 121665495,\n resource_name: 'customers/9262111890/customerManagerLinks/6141549892~121665495',\n status: 2,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.customerManagerLinks.create(customer_manager_link) method makes a new CustomerManagerLink in an account. It also supports an array as its first agument for batch operations.
The CustomerManagerLink object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst customer_manager_link = {\n // Your CustomerManagerLink here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.customerManagerLinks.create(customer_manager_link)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.customerManagerLinks.create([customer_manager_link, other_customer_manager_link], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/customerManagerLinks/6141549892~121665495'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerManagerLinks.update(customer_manager_link) method changes the attributes of an existing customerManagerLinks in an account. It also supports an array as its first agument for batch operations.
The CustomerManagerLink object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst customer_manager_link = {\n resource_name: 'customers/9262111890/customerManagerLinks/6141549892~121665495', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.customerManagerLinks.update(customer_manager_link)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.customerManagerLinks.update([customer_manager_link, other_customer_manager_link], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/customerManagerLinks/6141549892~121665495'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerManagerLinks.delete(resource_name) sets the status field of a CustomerManagerLink to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CustomerManagerLink
\nNothing
","frontmatter":{"title":"Delete CustomerManagerLink","order":6,"type":"delete","entity":"CustomerManagerLink"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_manager_link","is_entity_index":false}}},{"node":{"id":"eb673e47-75bd-5535-8dea-8fecf0f3af11","html":"// Deleting the entity\n\nawait customer.customerManagerLinks.delete('customers/9262111890/customerManagerLinks/6141549892~121665495')// Example CustomerNegativeCriterion\nconst customer_negative_criterion = {\n id: 61276056204,\n mobile_application: {\n app_id: '2-com.duolingo',\n name: 'Mobile App: Duolingo: Learn Languages Free (Google Play), by Duolingo',\n },\n resource_name: 'customers/3827277046/customerNegativeCriteria/61276056204',\n type: 5,\n}The customer.customerNegativeCriteria.get(resource_name) method returns the CustomerNegativeCriterion identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that CustomerNegativeCriterion
\nReturns that CustomerNegativeCriterion as an object.
","frontmatter":{"title":"Get CustomerNegativeCriterion","order":2,"type":"get","entity":"CustomerNegativeCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_negative_criterion","is_entity_index":false}}},{"node":{"id":"837c68de-c047-5b6e-b027-96a979e44ff2","html":"// Getting the entity\nlet result = await customer.customerNegativeCriteria.get('customers/3827277046/customerNegativeCriteria/61276056204')// Example result\n;({\n id: 61276056204,\n mobile_application: {\n app_id: '2-com.duolingo',\n name: 'Mobile App: Duolingo: Learn Languages Free (Google Play), by Duolingo',\n },\n resource_name: 'customers/3827277046/customerNegativeCriteria/61276056204',\n type: 5,\n})The customer.customerNegativeCriteria.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of CustomerNegativeCriterion.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a customer_negative_criterion property. Any other resources that can be selected with customer_negative_criterion will also be added as properities.
// Listing all the customerNegativeCriteria in the account\nlet result = await customer.customerNegativeCriteria.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.customerNegativeCriteria.list({\n constraints: [\n {\n key: 'customer_negative_criterion.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'customer_negative_criterion.some_field.sub_field',\n})// Example result\n;[\n {\n customer_negative_criterion: {\n id: 61276056204,\n mobile_application: {\n app_id: '2-com.duolingo',\n name: 'Mobile App: Duolingo: Learn Languages Free (Google Play), by Duolingo',\n },\n resource_name: 'customers/3827277046/customerNegativeCriteria/61276056204',\n type: 5,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.customerNegativeCriteria.create(customer_negative_criterion) method makes a new CustomerNegativeCriterion in an account. It also supports an array as its first agument for batch operations.
The CustomerNegativeCriterion object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst customer_negative_criterion = {\n // Your CustomerNegativeCriterion here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.customerNegativeCriteria.create(customer_negative_criterion)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.customerNegativeCriteria.create(\n [customer_negative_criterion, other_customer_negative_criterion],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/3827277046/customerNegativeCriteria/61276056204'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerNegativeCriteria.update(customer_negative_criterion) method changes the attributes of an existing customerNegativeCriteria in an account. It also supports an array as its first agument for batch operations.
The CustomerNegativeCriterion object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst customer_negative_criterion = {\n resource_name: 'customers/3827277046/customerNegativeCriteria/61276056204', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.customerNegativeCriteria.update(customer_negative_criterion)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.customerNegativeCriteria.update(\n [customer_negative_criterion, other_customer_negative_criterion],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/3827277046/customerNegativeCriteria/61276056204'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.customerNegativeCriteria.delete(resource_name) sets the status field of a CustomerNegativeCriterion to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that CustomerNegativeCriterion
\nNothing
","frontmatter":{"title":"Delete CustomerNegativeCriterion","order":6,"type":"delete","entity":"CustomerNegativeCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/customer_negative_criterion","is_entity_index":false}}},{"node":{"id":"39e8049b-c39b-5cd6-85ae-08e577120655","html":"// Deleting the entity\n\nawait customer.customerNegativeCriteria.delete('customers/3827277046/customerNegativeCriteria/61276056204')// Example DomainCategory\nconst domain_category = {\n campaign: 'customers/3827277046/campaigns/1398201241',\n category: 'landing pages from your standard ad groups',\n category_rank: 0,\n coverage_fraction: 2.7777777777777777,\n domain: 'opteo.com',\n has_children: false,\n language_code: 'en',\n recommended_cpc_bid_micros: 6626250,\n resource_name:\n 'customers/3827277046/domainCategories/1398201241~bGFuZGluZyBwYWdlcyBmcm9tIHlvdXIgc3RhbmRhcmQgYWQgZ3JvdXBz~en',\n}The customer.domainCategories.get(resource_name) method returns the DomainCategory identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that DomainCategory
\nReturns that DomainCategory as an object.
","frontmatter":{"title":"Get DomainCategory","order":2,"type":"get","entity":"DomainCategory"},"fields":{"group":"entities","mega_order":0,"directory":"entities/domain_category","is_entity_index":false}}},{"node":{"id":"f0ed5fc4-3c37-5711-bfaf-c57d65548359","html":"// Getting the entity\nlet result = await customer.domainCategories.get(\n 'customers/3827277046/domainCategories/1398201241~bGFuZGluZyBwYWdlcyBmcm9tIHlvdXIgc3RhbmRhcmQgYWQgZ3JvdXBz~en'\n)// Example result\n;({\n campaign: 'customers/3827277046/campaigns/1398201241',\n category: 'landing pages from your standard ad groups',\n category_rank: 0,\n coverage_fraction: 2.7777777777777777,\n domain: 'opteo.com',\n has_children: false,\n language_code: 'en',\n recommended_cpc_bid_micros: 6626250,\n resource_name:\n 'customers/3827277046/domainCategories/1398201241~bGFuZGluZyBwYWdlcyBmcm9tIHlvdXIgc3RhbmRhcmQgYWQgZ3JvdXBz~en',\n})The customer.domainCategories.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of DomainCategory.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a domain_category property. Any other resources that can be selected with domain_category will also be added as properities.
// Listing all the domainCategories in the account\nlet result = await customer.domainCategories.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.domainCategories.list({\n constraints: [\n {\n key: 'domain_category.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'domain_category.some_field.sub_field',\n})// Example result\n;[\n {\n domain_category: {\n campaign: 'customers/3827277046/campaigns/1398201241',\n category: 'landing pages from your standard ad groups',\n category_rank: 0,\n coverage_fraction: 2.7777777777777777,\n domain: 'opteo.com',\n has_children: false,\n language_code: 'en',\n recommended_cpc_bid_micros: 6626250,\n resource_name:\n 'customers/3827277046/domainCategories/1398201241~bGFuZGluZyBwYWdlcyBmcm9tIHlvdXIgc3RhbmRhcmQgYWQgZ3JvdXBz~en',\n },\n campaign: {\n ad_serving_optimization_status: 5,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/1398201241',\n bidding_strategy: 'customers/3827277046/biddingStrategies/2053936084',\n bidding_strategy_type: 8,\n campaign_budget: 'customers/3827277046/campaignBudgets/1453179506',\n dynamic_search_ads_setting: {\n domain_name: 'opteo.com',\n feeds: [],\n language_code: 'en',\n use_supplied_urls_only: false,\n },\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1398201241,\n labels: [\n 'customers/3827277046/labels/3889728216',\n 'customers/3827277046/labels/3889728468',\n 'customers/3827277046/labels/3889728474',\n ],\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/1398201241',\n serving_status: 2,\n start_date: '2018-05-10',\n status: 3,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]// Example ExtensionFeedItem\nconst extension_feed_item = {\n ad_schedules: [],\n call_feed_item: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_state: 4,\n call_conversion_tracking_disabled: false,\n call_tracking_enabled: true,\n country_code: 'GB',\n phone_number: '02035751125',\n },\n device: 0,\n extension_type: 4,\n id: 13882206517,\n resource_name: 'customers/3827277046/extensionFeedItems/13882206517',\n status: 2,\n}The customer.extensionFeedItems.get(resource_name) method returns the ExtensionFeedItem identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that ExtensionFeedItem
\nReturns that ExtensionFeedItem as an object.
","frontmatter":{"title":"Get ExtensionFeedItem","order":2,"type":"get","entity":"ExtensionFeedItem"},"fields":{"group":"entities","mega_order":0,"directory":"entities/extension_feed_item","is_entity_index":false}}},{"node":{"id":"bc9864e5-f6f4-5e19-8b1f-c573f021a170","html":"// Getting the entity\nlet result = await customer.extensionFeedItems.get('customers/3827277046/extensionFeedItems/13882206517')// Example result\n;({\n ad_schedules: [],\n call_feed_item: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_state: 4,\n call_conversion_tracking_disabled: false,\n call_tracking_enabled: true,\n country_code: 'GB',\n phone_number: '02035751125',\n },\n device: 0,\n extension_type: 4,\n id: 13882206517,\n resource_name: 'customers/3827277046/extensionFeedItems/13882206517',\n status: 2,\n})The customer.extensionFeedItems.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of ExtensionFeedItem.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a extension_feed_item property. Any other resources that can be selected with extension_feed_item will also be added as properities.
// Listing all the extensionFeedItems in the account\nlet result = await customer.extensionFeedItems.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.extensionFeedItems.list({\n constraints: [\n {\n key: 'extension_feed_item.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'extension_feed_item.some_field.sub_field',\n})// Example result\n;[\n {\n extension_feed_item: {\n ad_schedules: [],\n call_feed_item: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_state: 4,\n call_conversion_tracking_disabled: false,\n call_tracking_enabled: true,\n country_code: 'GB',\n phone_number: '02035751125',\n },\n device: 0,\n extension_type: 4,\n id: 13882206517,\n resource_name: 'customers/3827277046/extensionFeedItems/13882206517',\n status: 2,\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/37706041345',\n campaign: 'customers/3827277046/campaigns/729684361',\n cpc_bid_micros: 4770000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 37706041345,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/37706041345',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: true },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 4,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/729684361',\n bidding_strategy_type: 3,\n campaign_budget: 'customers/3827277046/campaignBudgets/1005523652',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 729684361,\n labels: [],\n manual_cpc: { enhanced_cpc_enabled: false },\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/729684361',\n serving_status: 2,\n start_date: '2017-01-04',\n status: 4,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: false }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.extensionFeedItems.create(extension_feed_item) method makes a new ExtensionFeedItem in an account. It also supports an array as its first agument for batch operations.
The ExtensionFeedItem object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst extension_feed_item = {\n // Your ExtensionFeedItem here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.extensionFeedItems.create(extension_feed_item)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.extensionFeedItems.create([extension_feed_item, other_extension_feed_item], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/extensionFeedItems/13882206517'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.extensionFeedItems.update(extension_feed_item) method changes the attributes of an existing extensionFeedItems in an account. It also supports an array as its first agument for batch operations.
The ExtensionFeedItem object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst extension_feed_item = {\n resource_name: 'customers/3827277046/extensionFeedItems/13882206517', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.extensionFeedItems.update(extension_feed_item)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.extensionFeedItems.update([extension_feed_item, other_extension_feed_item], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/extensionFeedItems/13882206517'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.extensionFeedItems.delete(resource_name) sets the status field of a ExtensionFeedItem to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that ExtensionFeedItem
\nNothing
","frontmatter":{"title":"Delete ExtensionFeedItem","order":6,"type":"delete","entity":"ExtensionFeedItem"},"fields":{"group":"entities","mega_order":0,"directory":"entities/extension_feed_item","is_entity_index":false}}},{"node":{"id":"c26ff679-4236-504c-93f3-a88c287572f7","html":"// Deleting the entity\n\nawait customer.extensionFeedItems.delete('customers/3827277046/extensionFeedItems/13882206517')// Example Feed\nconst feed = {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 82896692,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/9262111890/feeds/82896692',\n status: 2,\n}The customer.feeds.get(resource_name) method returns the Feed identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that Feed
\nReturns that Feed as an object.
","frontmatter":{"title":"Get Feed","order":2,"type":"get","entity":"Feed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed","is_entity_index":false}}},{"node":{"id":"d1be10c1-e606-56c3-b0f2-90733331360d","html":"// Getting the entity\nlet result = await customer.feeds.get('customers/9262111890/feeds/82896692')// Example result\n;({\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 82896692,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/9262111890/feeds/82896692',\n status: 2,\n})The customer.feeds.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of Feed.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a feed property. Any other resources that can be selected with feed will also be added as properities.
// Listing all the feeds in the account\nlet result = await customer.feeds.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.feeds.list({\n constraints: [\n {\n key: 'feed.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'feed.some_field.sub_field',\n})// Example result\n;[\n {\n feed: {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 82896692,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/9262111890/feeds/82896692',\n status: 2,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.feeds.create(feed) method makes a new Feed in an account. It also supports an array as its first agument for batch operations.
The Feed object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst feed = {\n // Your Feed here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.feeds.create(feed)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.feeds.create([feed, other_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/feeds/82896692'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feeds.update(feed) method changes the attributes of an existing feeds in an account. It also supports an array as its first agument for batch operations.
The Feed object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst feed = {\n resource_name: 'customers/9262111890/feeds/82896692', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.feeds.update(feed)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.feeds.update([feed, other_feed], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/feeds/82896692'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feeds.delete(resource_name) sets the status field of a Feed to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that Feed
\nNothing
","frontmatter":{"title":"Delete Feed","order":6,"type":"delete","entity":"Feed"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed","is_entity_index":false}}},{"node":{"id":"6d2c4367-eeb5-5570-9aba-88aad62b5f37","html":"// Deleting the entity\n\nawait customer.feeds.delete('customers/9262111890/feeds/82896692')// Example FeedItem\nconst feed_item = {\n attribute_values: [\n {\n feed_attribute_id: 1,\n string_value: 'AdWords Knowledge Base',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 3,\n string_value: 'Adwords Guides, Case Studies',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 4,\n string_value: 'Chrome Extensions and more!',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 5,\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: ['https://opteo.com/docs'],\n double_values_list: [],\n },\n ],\n feed: 'customers/3827277046/feeds/43009393',\n geo_targeting_restriction: 0,\n id: 9779152283,\n policy_infos: [\n {\n placeholder_type_enum: 2,\n feed_mapping_resource_name: 'customers/3827277046/feedMappings/43009393~46066123',\n review_status: 3,\n approval_status: 2,\n policy_topic_entries_list: [{ topic: 'DESTINATION_MISMATCH', type: 2, evidences_list: [], constraints_list: [] }],\n validation_status: 4,\n validation_errors_list: [],\n quality_approval_status: 0,\n quality_disapproval_reasons_list: [],\n },\n ],\n resource_name: 'customers/3827277046/feedItems/43009393~9779152283',\n status: 3,\n url_custom_parameters: [],\n}The customer.feedItems.get(resource_name) method returns the FeedItem identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that FeedItem
\nReturns that FeedItem as an object.
","frontmatter":{"title":"Get FeedItem","order":2,"type":"get","entity":"FeedItem"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed_item","is_entity_index":false}}},{"node":{"id":"de64c161-fdae-5a85-a97b-9e2730564a2f","html":"// Getting the entity\nlet result = await customer.feedItems.get('customers/3827277046/feedItems/43009393~9779152283')// Example result\n;({\n attribute_values: [\n {\n feed_attribute_id: 1,\n string_value: 'AdWords Knowledge Base',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 3,\n string_value: 'Adwords Guides, Case Studies',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 4,\n string_value: 'Chrome Extensions and more!',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 5,\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: ['https://opteo.com/docs'],\n double_values_list: [],\n },\n ],\n feed: 'customers/3827277046/feeds/43009393',\n geo_targeting_restriction: 0,\n id: 9779152283,\n policy_infos: [\n {\n placeholder_type_enum: 2,\n feed_mapping_resource_name: 'customers/3827277046/feedMappings/43009393~46066123',\n review_status: 3,\n approval_status: 2,\n policy_topic_entries_list: [{ topic: 'DESTINATION_MISMATCH', type: 2, evidences_list: [], constraints_list: [] }],\n validation_status: 4,\n validation_errors_list: [],\n quality_approval_status: 0,\n quality_disapproval_reasons_list: [],\n },\n ],\n resource_name: 'customers/3827277046/feedItems/43009393~9779152283',\n status: 3,\n url_custom_parameters: [],\n})The customer.feedItems.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of FeedItem.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a feed_item property. Any other resources that can be selected with feed_item will also be added as properities.
// Listing all the feedItems in the account\nlet result = await customer.feedItems.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.feedItems.list({\n constraints: [\n {\n key: 'feed_item.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'feed_item.some_field.sub_field',\n})// Example result\n;[\n {\n feed_item: {\n attribute_values: [\n {\n feed_attribute_id: 1,\n string_value: 'AdWords Knowledge Base',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 3,\n string_value: 'Adwords Guides, Case Studies',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 4,\n string_value: 'Chrome Extensions and more!',\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: [],\n double_values_list: [],\n },\n {\n feed_attribute_id: 5,\n integer_values_list: [],\n boolean_values_list: [],\n string_values_list: ['https://opteo.com/docs'],\n double_values_list: [],\n },\n ],\n feed: 'customers/3827277046/feeds/43009393',\n geo_targeting_restriction: 0,\n id: 9779152283,\n policy_infos: [\n {\n placeholder_type_enum: 2,\n feed_mapping_resource_name: 'customers/3827277046/feedMappings/43009393~46066123',\n review_status: 3,\n approval_status: 2,\n policy_topic_entries_list: [\n { topic: 'DESTINATION_MISMATCH', type: 2, evidences_list: [], constraints_list: [] },\n ],\n validation_status: 4,\n validation_errors_list: [],\n quality_approval_status: 0,\n quality_disapproval_reasons_list: [],\n },\n ],\n resource_name: 'customers/3827277046/feedItems/43009393~9779152283',\n status: 3,\n url_custom_parameters: [],\n },\n ad_group_ad: {\n ad: {\n added_by_google_ads: false,\n device_preference: 0,\n expanded_text_ad: {\n description: 'Top Rated AdWords PPC Tool. Designed For Agencies. Try It Free!',\n headline_part1: 'Top Rated Google Ad Tool',\n headline_part2: 'Lift PPC Results In 30 Seconds',\n path1: 'google-ad',\n path2: 'tool',\n },\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['http://lp3.opteo.com/lp/google-ad-tool'],\n id: 170067910717,\n resource_name: 'customers/3827277046/ads/170067910717',\n system_managed_resource_source: 0,\n type: 3,\n url_collections: [],\n url_custom_parameters: [],\n },\n ad_group: 'customers/3827277046/adGroups/36337682617',\n ad_strength: 0,\n policy_summary: {\n approval_status: 3,\n policy_topic_entries: [\n {\n topic: 'TRADEMARKS_IN_AD_TEXT',\n type: 4,\n evidences_list: [{ text_list: { texts: ['Google'] } }],\n constraints_list: [\n {\n country_constraint_list: {\n total_targeted_countries: 23,\n countries: [\n { country_criterion: 'geoTargetConstants/2528' },\n { country_criterion: 'geoTargetConstants/2040' },\n { country_criterion: 'geoTargetConstants/2710' },\n { country_criterion: 'geoTargetConstants/2702' },\n { country_criterion: 'geoTargetConstants/2246' },\n { country_criterion: 'geoTargetConstants/2380' },\n { country_criterion: 'geoTargetConstants/2056' },\n { country_criterion: 'geoTargetConstants/2344' },\n { country_criterion: 'geoTargetConstants/2250' },\n { country_criterion: 'geoTargetConstants/2442' },\n { country_criterion: 'geoTargetConstants/2752' },\n { country_criterion: 'geoTargetConstants/2724' },\n { country_criterion: 'geoTargetConstants/2756' },\n { country_criterion: 'geoTargetConstants/2276' },\n { country_criterion: 'geoTargetConstants/2348' },\n { country_criterion: 'geoTargetConstants/2578' },\n { country_criterion: 'geoTargetConstants/2203' },\n ],\n },\n },\n ],\n },\n ],\n review_status: 3,\n },\n resource_name: 'customers/3827277046/adGroupAds/36337682617~170067910717',\n status: 2,\n },\n feed: {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 43009393,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/3827277046/feeds/43009393',\n status: 2,\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/36337682617',\n campaign: 'customers/3827277046/campaigns/729468367',\n cpc_bid_micros: 5000000,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 36337682617,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/36337682617',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 4,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/729468367',\n bidding_strategy_type: 3,\n campaign_budget: 'customers/3827277046/campaignBudgets/1005586771',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 7 },\n id: 729468367,\n labels: [],\n manual_cpc: { enhanced_cpc_enabled: true },\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/729468367',\n serving_status: 2,\n start_date: '2017-01-04',\n status: 4,\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.feedItems.create(feed_item) method makes a new FeedItem in an account. It also supports an array as its first agument for batch operations.
The FeedItem object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst feed_item = {\n // Your FeedItem here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.feedItems.create(feed_item)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.feedItems.create([feed_item, other_feed_item], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/feedItems/43009393~9779152283'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feedItems.update(feed_item) method changes the attributes of an existing feedItems in an account. It also supports an array as its first agument for batch operations.
The FeedItem object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst feed_item = {\n resource_name: 'customers/3827277046/feedItems/43009393~9779152283', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.feedItems.update(feed_item)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.feedItems.update([feed_item, other_feed_item], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/feedItems/43009393~9779152283'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feedItems.delete(resource_name) sets the status field of a FeedItem to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that FeedItem
\nNothing
","frontmatter":{"title":"Delete FeedItem","order":6,"type":"delete","entity":"FeedItem"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed_item","is_entity_index":false}}},{"node":{"id":"6580642b-439a-5ee9-b10b-00bc57dc17d7","html":"// Deleting the entity\n\nawait customer.feedItems.delete('customers/3827277046/feedItems/43009393~9779152283')// Example FeedItemTarget\nconst feed_item_target = /* Todo: add example get() return here */The customer.feedItemTargets.get(resource_name) method returns the FeedItemTarget identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that FeedItemTarget
\nReturns that FeedItemTarget as an object.
","frontmatter":{"title":"Get FeedItemTarget","order":2,"type":"get","entity":"FeedItemTarget"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed_item_target","is_entity_index":false}}},{"node":{"id":"65f553d6-f320-5644-b9b0-460e9c26134a","html":"// Getting the entity\nlet result = await customer.feedItemTargets.get('customers/1234567890/feedItemTargets/123123123')// Example result\n(/* Todo: add example get() return here */)The customer.feedItemTargets.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of FeedItemTarget.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a feed_item_target property. Any other resources that can be selected with feed_item_target will also be added as properities.
// Listing all the feedItemTargets in the account\nlet result = await customer.feedItemTargets.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.feedItemTargets.list({\n constraints: [\n {\n key: 'feed_item_target.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'feed_item_target.some_field.sub_field',\n})// Example result\n;[\n /* Todo: add example list() return here */\n]The customer.feedItemTargets.create(feed_item_target) method makes a new FeedItemTarget in an account. It also supports an array as its first agument for batch operations.
The FeedItemTarget object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst feed_item_target = {\n // Your FeedItemTarget here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.feedItemTargets.create(feed_item_target)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.feedItemTargets.create([feed_item_target, other_feed_item_target], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/feedItemTargets/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feedItemTargets.update(feed_item_target) method changes the attributes of an existing feedItemTargets in an account. It also supports an array as its first agument for batch operations.
The FeedItemTarget object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst feed_item_target = {\n resource_name: 'customers/1234567890/feedItemTargets/123123123', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.feedItemTargets.update(feed_item_target)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.feedItemTargets.update([feed_item_target, other_feed_item_target], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/feedItemTargets/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feedItemTargets.delete(resource_name) sets the status field of a FeedItemTarget to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that FeedItemTarget
\nNothing
","frontmatter":{"title":"Delete FeedItemTarget","order":6,"type":"delete","entity":"FeedItemTarget"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed_item_target","is_entity_index":false}}},{"node":{"id":"426da85a-9676-51cc-aa81-ba080ed981de","html":"// Deleting the entity\n\nawait customer.feedItemTargets.delete('customers/1234567890/feedItemTargets/123123123')// Example FeedMapping\nconst feed_mapping = {\n attribute_field_mappings: [\n {\n feed_attribute_id: 1,\n field_id: 1,\n sitelink_field: 2,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 2,\n field_id: 2,\n sitelink_field: 1,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 3,\n field_id: 3,\n sitelink_field: 3,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 4,\n field_id: 4,\n sitelink_field: 4,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 5,\n field_id: 5,\n sitelink_field: 5,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 6,\n field_id: 6,\n sitelink_field: 6,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 7,\n field_id: 7,\n sitelink_field: 7,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 8,\n field_id: 8,\n sitelink_field: 8,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n ],\n criterion_type: 0,\n feed: 'customers/9262111890/feeds/82896692',\n placeholder_type: 2,\n resource_name: 'customers/9262111890/feedMappings/82896692~91300060',\n status: 2,\n}The customer.feedMappings.get(resource_name) method returns the FeedMapping identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that FeedMapping
\nReturns that FeedMapping as an object.
","frontmatter":{"title":"Get FeedMapping","order":2,"type":"get","entity":"FeedMapping"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed_mapping","is_entity_index":false}}},{"node":{"id":"da7e590c-aca8-5381-aebb-72443e75f368","html":"// Getting the entity\nlet result = await customer.feedMappings.get('customers/9262111890/feedMappings/82896692~91300060')// Example result\n;({\n attribute_field_mappings: [\n {\n feed_attribute_id: 1,\n field_id: 1,\n sitelink_field: 2,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 2,\n field_id: 2,\n sitelink_field: 1,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 3,\n field_id: 3,\n sitelink_field: 3,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 4,\n field_id: 4,\n sitelink_field: 4,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 5,\n field_id: 5,\n sitelink_field: 5,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 6,\n field_id: 6,\n sitelink_field: 6,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 7,\n field_id: 7,\n sitelink_field: 7,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 8,\n field_id: 8,\n sitelink_field: 8,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n ],\n criterion_type: 0,\n feed: 'customers/9262111890/feeds/82896692',\n placeholder_type: 2,\n resource_name: 'customers/9262111890/feedMappings/82896692~91300060',\n status: 2,\n})The customer.feedMappings.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of FeedMapping.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a feed_mapping property. Any other resources that can be selected with feed_mapping will also be added as properities.
// Listing all the feedMappings in the account\nlet result = await customer.feedMappings.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.feedMappings.list({\n constraints: [\n {\n key: 'feed_mapping.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'feed_mapping.some_field.sub_field',\n})// Example result\n;[\n {\n feed_mapping: {\n attribute_field_mappings: [\n {\n feed_attribute_id: 1,\n field_id: 1,\n sitelink_field: 2,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 2,\n field_id: 2,\n sitelink_field: 1,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 3,\n field_id: 3,\n sitelink_field: 3,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 4,\n field_id: 4,\n sitelink_field: 4,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 5,\n field_id: 5,\n sitelink_field: 5,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 6,\n field_id: 6,\n sitelink_field: 6,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 7,\n field_id: 7,\n sitelink_field: 7,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n {\n feed_attribute_id: 8,\n field_id: 8,\n sitelink_field: 8,\n call_field: 0,\n app_field: 0,\n location_field: 0,\n affiliate_location_field: 0,\n callout_field: 0,\n structured_snippet_field: 0,\n message_field: 0,\n price_field: 0,\n promotion_field: 0,\n ad_customizer_field: 0,\n dsa_page_feed_field: 0,\n location_extension_targeting_field: 0,\n education_field: 0,\n flight_field: 0,\n custom_field: 0,\n hotel_field: 0,\n real_estate_field: 0,\n travel_field: 0,\n local_field: 0,\n job_field: 0,\n },\n ],\n criterion_type: 0,\n feed: 'customers/9262111890/feeds/82896692',\n placeholder_type: 2,\n resource_name: 'customers/9262111890/feedMappings/82896692~91300060',\n status: 2,\n },\n feed: {\n attributes: [\n { id: 1, name: 'SitelinkName', type: 4, is_part_of_key: false },\n { id: 2, name: 'SitelinkUrl', type: 6, is_part_of_key: false },\n { id: 3, name: 'SitelinkDescription1', type: 4, is_part_of_key: false },\n { id: 4, name: 'SitelinkDescription2', type: 4, is_part_of_key: false },\n { id: 5, name: 'SitelinkFinalUrls', type: 12, is_part_of_key: false },\n { id: 6, name: 'SitelinkFinalMobileUrls', type: 12, is_part_of_key: false },\n { id: 7, name: 'SitelinkTrackingUrl', type: 6, is_part_of_key: false },\n { id: 8, name: 'SitelinkFinalUrlSuffix', type: 4, is_part_of_key: false },\n ],\n id: 82896692,\n name: 'My feed',\n origin: 3,\n resource_name: 'customers/9262111890/feeds/82896692',\n status: 2,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.feedMappings.create(feed_mapping) method makes a new FeedMapping in an account. It also supports an array as its first agument for batch operations.
The FeedMapping object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst feed_mapping = {\n // Your FeedMapping here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.feedMappings.create(feed_mapping)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.feedMappings.create([feed_mapping, other_feed_mapping], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/feedMappings/82896692~91300060'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feedMappings.update(feed_mapping) method changes the attributes of an existing feedMappings in an account. It also supports an array as its first agument for batch operations.
The FeedMapping object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst feed_mapping = {\n resource_name: 'customers/9262111890/feedMappings/82896692~91300060', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.feedMappings.update(feed_mapping)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.feedMappings.update([feed_mapping, other_feed_mapping], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/feedMappings/82896692~91300060'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.feedMappings.delete(resource_name) sets the status field of a FeedMapping to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that FeedMapping
\nNothing
","frontmatter":{"title":"Delete FeedMapping","order":6,"type":"delete","entity":"FeedMapping"},"fields":{"group":"entities","mega_order":0,"directory":"entities/feed_mapping","is_entity_index":false}}},{"node":{"id":"07ff6d52-781d-5dc2-9cb6-0c7f467a1c55","html":"// Deleting the entity\n\nawait customer.feedMappings.delete('customers/9262111890/feedMappings/82896692~91300060')// Example GeoTargetConstant\nconst geo_target_constant = {\n canonical_name: 'South Georgia and the South Sandwich Islands',\n country_code: 'GS',\n id: 2239,\n name: 'South Georgia and the South Sandwich Islands',\n resource_name: 'geoTargetConstants/2239',\n status: 2,\n target_type: 'Country',\n}The customer.geoTargetConstants.get(resource_name) method returns the GeoTargetConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that GeoTargetConstant
\nReturns that GeoTargetConstant as an object.
","frontmatter":{"title":"Get GeoTargetConstant","order":2,"type":"get","entity":"GeoTargetConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/geo_target_constant","is_entity_index":false}}},{"node":{"id":"f5078f81-2b81-5922-ada8-35dd2dec0b7e","html":"// Getting the entity\nlet result = await customer.geoTargetConstants.get('geoTargetConstants/2239')// Example result\n;({\n canonical_name: 'South Georgia and the South Sandwich Islands',\n country_code: 'GS',\n id: 2239,\n name: 'South Georgia and the South Sandwich Islands',\n resource_name: 'geoTargetConstants/2239',\n status: 2,\n target_type: 'Country',\n})The customer.geoTargetConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of GeoTargetConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a geo_target_constant property. Any other resources that can be selected with geo_target_constant will also be added as properities.
// Listing all the geoTargetConstants in the account\nlet result = await customer.geoTargetConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.geoTargetConstants.list({\n constraints: [\n {\n key: 'geo_target_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'geo_target_constant.some_field.sub_field',\n})// Example result\n;[\n {\n geo_target_constant: {\n canonical_name: 'South Georgia and the South Sandwich Islands',\n country_code: 'GS',\n id: 2239,\n name: 'South Georgia and the South Sandwich Islands',\n resource_name: 'geoTargetConstants/2239',\n status: 2,\n target_type: 'Country',\n },\n },\n]The customer.geoTargetConstants.suggest() method returns geo target constant suggestion.
If possible, returned geo targets are translated using this locale. If not, en is used by default. This is also used as a hint for returned geo targets.
\nReturned geo targets are restricted to this country code.
\nThe location names to search by. At most 25 names can be set.
\nThe geo target constant resource names to filter by.
\nReturns an array of objects.\nEach object has locale, reach, search_term, geo_target_constant and geo_target_constant_parents[] properties.
// Get geo target constant suggestions\nlet result = await customer.geoTargetConstants.suggest({\n locale: 'en',\n country_code: 'GB',\n location_names: { names: ['London'] },\n})// Example result\n;[\n {\n locale: 'en',\n reach: 32000000,\n search_term: 'London',\n geo_target_constant: {\n resource_name: 'geoTargetConstants/1006886',\n id: 1006886,\n name: 'London',\n country_code: 'GB',\n target_type: 'City',\n status: 2,\n canonical_name: 'London,England,United Kingdom',\n },\n geo_target_constant_parents_list: [\n {\n resource_name: 'geoTargetConstants/20339',\n id: 20339,\n name: 'England',\n country_code: 'GB',\n target_type: 'Province',\n status: 2,\n },\n {\n resource_name: 'geoTargetConstants/2826',\n id: 2826,\n name: 'United Kingdom',\n country_code: 'GB',\n target_type: 'Country',\n status: 2,\n },\n ],\n },\n]// Example KeywordPlan\nconst keyword_plan = {\n forecast_period: { date_interval: 4 },\n id: 115113466,\n name: 'My keyword plan',\n resource_name: 'customers/9262111890/keywordPlans/115113466',\n}The customer.keywordPlans.get(resource_name) method returns the KeywordPlan identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that KeywordPlan
\nReturns that KeywordPlan as an object.
","frontmatter":{"title":"Get KeywordPlan","order":2,"type":"get","entity":"KeywordPlan"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan","is_entity_index":false}}},{"node":{"id":"02d009f4-b723-513c-ad52-526cd632431a","html":"// Getting the entity\nlet result = await customer.keywordPlans.get('customers/9262111890/keywordPlans/115113466')// Example result\n;({\n forecast_period: { date_interval: 4 },\n id: 115113466,\n name: 'My keyword plan',\n resource_name: 'customers/9262111890/keywordPlans/115113466',\n})The customer.keywordPlans.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of KeywordPlan.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a keyword_plan property. Any other resources that can be selected with keyword_plan will also be added as properities.
// Listing all the keywordPlans in the account\nlet result = await customer.keywordPlans.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.keywordPlans.list({\n constraints: [\n {\n key: 'keyword_plan.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'keyword_plan.some_field.sub_field',\n})// Example result\n;[\n {\n keyword_plan: {\n forecast_period: { date_interval: 4 },\n id: 115113466,\n name: 'My keyword plan',\n resource_name: 'customers/9262111890/keywordPlans/115113466',\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.keywordPlans.create(keyword_plan) method makes a new KeywordPlan in an account. It also supports an array as its first agument for batch operations.
The KeywordPlan object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst keyword_plan = {\n // Your KeywordPlan here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.keywordPlans.create(keyword_plan)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.keywordPlans.create([keyword_plan, other_keyword_plan], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/keywordPlans/115113466'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlans.update(keyword_plan) method changes the attributes of an existing keywordPlans in an account. It also supports an array as its first agument for batch operations.
The KeywordPlan object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst keyword_plan = {\n resource_name: 'customers/9262111890/keywordPlans/115113466', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.keywordPlans.update(keyword_plan)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.keywordPlans.update([keyword_plan, other_keyword_plan], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/keywordPlans/115113466'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlans.delete(resource_name) sets the status field of a KeywordPlan to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that KeywordPlan
\nNothing
","frontmatter":{"title":"Delete KeywordPlan","order":6,"type":"delete","entity":"KeywordPlan"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan","is_entity_index":false}}},{"node":{"id":"b870cc6c-9d0e-592e-9c68-abad80f7670e","html":"// Deleting the entity\n\nawait customer.keywordPlans.delete('customers/9262111890/keywordPlans/115113466')// Example KeywordPlanAdGroup\nconst keyword_plan_ad_group = {\n cpc_bid_micros: 2500000,\n id: 104819196,\n keyword_plan_campaign: 'customers/9262111890/keywordPlanCampaigns/115088623',\n name: 'My keyword plan ad group',\n resource_name: 'customers/9262111890/keywordPlanAdGroups/104819196',\n}The customer.keywordPlanAdGroups.get(resource_name) method returns the KeywordPlanAdGroup identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that KeywordPlanAdGroup
\nReturns that KeywordPlanAdGroup as an object.
","frontmatter":{"title":"Get KeywordPlanAdGroup","order":2,"type":"get","entity":"KeywordPlanAdGroup"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_ad_group","is_entity_index":false}}},{"node":{"id":"09692b11-ea7d-5d3c-9687-4d8be88b0e25","html":"// Getting the entity\nlet result = await customer.keywordPlanAdGroups.get('customers/9262111890/keywordPlanAdGroups/104819196')// Example result\n;({\n cpc_bid_micros: 2500000,\n id: 104819196,\n keyword_plan_campaign: 'customers/9262111890/keywordPlanCampaigns/115088623',\n name: 'My keyword plan ad group',\n resource_name: 'customers/9262111890/keywordPlanAdGroups/104819196',\n})The customer.keywordPlanAdGroups.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of KeywordPlanAdGroup.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a keyword_plan_ad_group property. Any other resources that can be selected with keyword_plan_ad_group will also be added as properities.
// Listing all the keywordPlanAdGroups in the account\nlet result = await customer.keywordPlanAdGroups.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.keywordPlanAdGroups.list({\n constraints: [\n {\n key: 'keyword_plan_ad_group.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'keyword_plan_ad_group.some_field.sub_field',\n})// Example result\n;[\n {\n keyword_plan_ad_group: {\n cpc_bid_micros: 2500000,\n id: 104819196,\n keyword_plan_campaign: 'customers/9262111890/keywordPlanCampaigns/115088623',\n name: 'My keyword plan ad group',\n resource_name: 'customers/9262111890/keywordPlanAdGroups/104819196',\n },\n keyword_plan: {\n forecast_period: { date_interval: 4 },\n id: 115133472,\n name: 'My keyword plan',\n resource_name: 'customers/9262111890/keywordPlans/115133472',\n },\n keyword_plan_campaign: {\n cpc_bid_micros: 1000000,\n geo_targets: [{ geo_target_constant: 'geoTargetConstants/1021278' }],\n id: 115088623,\n keyword_plan: 'customers/9262111890/keywordPlans/115133472',\n keyword_plan_network: 2,\n language_constants: ['languageConstants/1000'],\n name: 'My keyword plan campaign',\n resource_name: 'customers/9262111890/keywordPlanCampaigns/115088623',\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.keywordPlanAdGroups.create(keyword_plan_ad_group) method makes a new KeywordPlanAdGroup in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanAdGroup object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst keyword_plan_ad_group = {\n // Your KeywordPlanAdGroup here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.keywordPlanAdGroups.create(keyword_plan_ad_group)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.keywordPlanAdGroups.create([keyword_plan_ad_group, other_keyword_plan_ad_group], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/keywordPlanAdGroups/104819196'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanAdGroups.update(keyword_plan_ad_group) method changes the attributes of an existing keywordPlanAdGroups in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanAdGroup object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst keyword_plan_ad_group = {\n resource_name: 'customers/9262111890/keywordPlanAdGroups/104819196', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.keywordPlanAdGroups.update(keyword_plan_ad_group)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.keywordPlanAdGroups.update([keyword_plan_ad_group, other_keyword_plan_ad_group], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/keywordPlanAdGroups/104819196'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanAdGroups.delete(resource_name) sets the status field of a KeywordPlanAdGroup to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that KeywordPlanAdGroup
\nNothing
","frontmatter":{"title":"Delete KeywordPlanAdGroup","order":6,"type":"delete","entity":"KeywordPlanAdGroup"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_ad_group","is_entity_index":false}}},{"node":{"id":"1e29f771-e200-5f81-b4f3-6d16e9c18627","html":"// Deleting the entity\n\nawait customer.keywordPlanAdGroups.delete('customers/9262111890/keywordPlanAdGroups/104819196')// Example KeywordPlanCampaign\nconst keyword_plan_campaign = {\n cpc_bid_micros: 1000000,\n geo_targets: [{ geo_target_constant: 'geoTargetConstants/1021278' }],\n id: 115088623,\n keyword_plan: 'customers/9262111890/keywordPlans/115133472',\n keyword_plan_network: 2,\n language_constants: ['languageConstants/1000'],\n name: 'My keyword plan campaign',\n resource_name: 'customers/9262111890/keywordPlanCampaigns/115088623',\n}The customer.keywordPlanCampaigns.get(resource_name) method returns the KeywordPlanCampaign identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that KeywordPlanCampaign
\nReturns that KeywordPlanCampaign as an object.
","frontmatter":{"title":"Get KeywordPlanCampaign","order":2,"type":"get","entity":"KeywordPlanCampaign"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_campaign","is_entity_index":false}}},{"node":{"id":"bb7c3c11-04fe-51e4-a5ae-b773bed96381","html":"// Getting the entity\nlet result = await customer.keywordPlanCampaigns.get('customers/9262111890/keywordPlanCampaigns/115088623')// Example result\n;({\n cpc_bid_micros: 1000000,\n geo_targets: [{ geo_target_constant: 'geoTargetConstants/1021278' }],\n id: 115088623,\n keyword_plan: 'customers/9262111890/keywordPlans/115133472',\n keyword_plan_network: 2,\n language_constants: ['languageConstants/1000'],\n name: 'My keyword plan campaign',\n resource_name: 'customers/9262111890/keywordPlanCampaigns/115088623',\n})The customer.keywordPlanCampaigns.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of KeywordPlanCampaign.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a keyword_plan_campaign property. Any other resources that can be selected with keyword_plan_campaign will also be added as properities.
// Listing all the keywordPlanCampaigns in the account\nlet result = await customer.keywordPlanCampaigns.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.keywordPlanCampaigns.list({\n constraints: [\n {\n key: 'keyword_plan_campaign.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'keyword_plan_campaign.some_field.sub_field',\n})// Example result\n;[\n {\n keyword_plan_campaign: {\n cpc_bid_micros: 1000000,\n geo_targets: [{ geo_target_constant: 'geoTargetConstants/1021278' }],\n id: 115088623,\n keyword_plan: 'customers/9262111890/keywordPlans/115133472',\n keyword_plan_network: 2,\n language_constants: ['languageConstants/1000'],\n name: 'My keyword plan campaign',\n resource_name: 'customers/9262111890/keywordPlanCampaigns/115088623',\n },\n keyword_plan: {\n forecast_period: { date_interval: 4 },\n id: 115133472,\n name: 'My keyword plan',\n resource_name: 'customers/9262111890/keywordPlans/115133472',\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.keywordPlanCampaigns.create(keyword_plan_campaign) method makes a new KeywordPlanCampaign in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanCampaign object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst keyword_plan_campaign = {\n // Your KeywordPlanCampaign here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.keywordPlanCampaigns.create(keyword_plan_campaign)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.keywordPlanCampaigns.create([keyword_plan_campaign, other_keyword_plan_campaign], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/keywordPlanCampaigns/115088623'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanCampaigns.update(keyword_plan_campaign) method changes the attributes of an existing keywordPlanCampaigns in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanCampaign object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst keyword_plan_campaign = {\n resource_name: 'customers/9262111890/keywordPlanCampaigns/115088623', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.keywordPlanCampaigns.update(keyword_plan_campaign)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.keywordPlanCampaigns.update([keyword_plan_campaign, other_keyword_plan_campaign], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/keywordPlanCampaigns/115088623'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanCampaigns.delete(resource_name) sets the status field of a KeywordPlanCampaign to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that KeywordPlanCampaign
\nNothing
","frontmatter":{"title":"Delete KeywordPlanCampaign","order":6,"type":"delete","entity":"KeywordPlanCampaign"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_campaign","is_entity_index":false}}},{"node":{"id":"f417707f-f93e-5245-90e0-576e014ef68b","html":"// Deleting the entity\n\nawait customer.keywordPlanCampaigns.delete('customers/9262111890/keywordPlanCampaigns/115088623')// Example KeywordPlanKeyword\nconst keyword_plan_keyword = /* Todo: add example get() return here */The customer.keywordPlanKeywords.get(resource_name) method returns the KeywordPlanKeyword identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that KeywordPlanKeyword
\nReturns that KeywordPlanKeyword as an object.
","frontmatter":{"title":"Get KeywordPlanKeyword","order":2,"type":"get","entity":"KeywordPlanKeyword"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_keyword","is_entity_index":false}}},{"node":{"id":"8c1cb121-7702-5214-a945-7b24f7914ab1","html":"// Getting the entity\nlet result = await customer.keywordPlanKeywords.get('customers/1234567890/keywordPlanKeywords/123123123')// Example result\n(/* Todo: add example get() return here */)The customer.keywordPlanKeywords.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of KeywordPlanKeyword.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a keyword_plan_keyword property. Any other resources that can be selected with keyword_plan_keyword will also be added as properities.
// Listing all the keywordPlanKeywords in the account\nlet result = await customer.keywordPlanKeywords.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.keywordPlanKeywords.list({\n constraints: [\n {\n key: 'keyword_plan_keyword.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'keyword_plan_keyword.some_field.sub_field',\n})// Example result\n;[\n /* Todo: add example list() return here */\n]The customer.keywordPlanKeywords.create(keyword_plan_keyword) method makes a new KeywordPlanKeyword in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanKeyword object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst keyword_plan_keyword = {\n // Your KeywordPlanKeyword here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.keywordPlanKeywords.create(keyword_plan_keyword)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.keywordPlanKeywords.create([keyword_plan_keyword, other_keyword_plan_keyword], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/keywordPlanKeywords/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanKeywords.update(keyword_plan_keyword) method changes the attributes of an existing keywordPlanKeywords in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanKeyword object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst keyword_plan_keyword = {\n resource_name: 'customers/1234567890/keywordPlanKeywords/123123123', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.keywordPlanKeywords.update(keyword_plan_keyword)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.keywordPlanKeywords.update([keyword_plan_keyword, other_keyword_plan_keyword], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/keywordPlanKeywords/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanKeywords.delete(resource_name) sets the status field of a KeywordPlanKeyword to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that KeywordPlanKeyword
\nNothing
","frontmatter":{"title":"Delete KeywordPlanKeyword","order":6,"type":"delete","entity":"KeywordPlanKeyword"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_keyword","is_entity_index":false}}},{"node":{"id":"ce8f0786-d5b6-5f89-8a60-33407fabeab5","html":"// Deleting the entity\n\nawait customer.keywordPlanKeywords.delete('customers/1234567890/keywordPlanKeywords/123123123')// Example KeywordPlanNegativeKeyword\nconst keyword_plan_negative_keyword = {\n id: 13119148,\n keyword_plan_campaign: 'customers/9262111890/keywordPlanCampaigns/115088623',\n match_type: 4,\n resource_name: 'customers/9262111890/keywordPlanNegativeKeywords/13119148',\n text: 'moon walk',\n}The customer.keywordPlanNegativeKeywords.get(resource_name) method returns the KeywordPlanNegativeKeyword identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that KeywordPlanNegativeKeyword
\nReturns that KeywordPlanNegativeKeyword as an object.
","frontmatter":{"title":"Get KeywordPlanNegativeKeyword","order":2,"type":"get","entity":"KeywordPlanNegativeKeyword"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_negative_keyword","is_entity_index":false}}},{"node":{"id":"b5ae2ff0-5a12-5652-9c43-60a68dccc67d","html":"// Getting the entity\nlet result = await customer.keywordPlanNegativeKeywords.get('customers/9262111890/keywordPlanNegativeKeywords/13119148')// Example result\n;({\n id: 13119148,\n keyword_plan_campaign: 'customers/9262111890/keywordPlanCampaigns/115088623',\n match_type: 4,\n resource_name: 'customers/9262111890/keywordPlanNegativeKeywords/13119148',\n text: 'moon walk',\n})The customer.keywordPlanNegativeKeywords.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of KeywordPlanNegativeKeyword.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a keyword_plan_negative_keyword property. Any other resources that can be selected with keyword_plan_negative_keyword will also be added as properities.
// Listing all the keywordPlanNegativeKeywords in the account\nlet result = await customer.keywordPlanNegativeKeywords.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.keywordPlanNegativeKeywords.list({\n constraints: [\n {\n key: 'keyword_plan_negative_keyword.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'keyword_plan_negative_keyword.some_field.sub_field',\n})// Example result\n;[\n {\n keyword_plan_negative_keyword: {\n id: 13119148,\n keyword_plan_campaign: 'customers/9262111890/keywordPlanCampaigns/115088623',\n match_type: 4,\n resource_name: 'customers/9262111890/keywordPlanNegativeKeywords/13119148',\n text: 'moon walk',\n },\n keyword_plan: {\n forecast_period: { date_interval: 4 },\n id: 115133472,\n name: 'My keyword plan',\n resource_name: 'customers/9262111890/keywordPlans/115133472',\n },\n keyword_plan_campaign: {\n cpc_bid_micros: 1000000,\n geo_targets: [{ geo_target_constant: 'geoTargetConstants/1021278' }],\n id: 115088623,\n keyword_plan: 'customers/9262111890/keywordPlans/115133472',\n keyword_plan_network: 2,\n language_constants: ['languageConstants/1000'],\n name: 'My keyword plan campaign',\n resource_name: 'customers/9262111890/keywordPlanCampaigns/115088623',\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [8, 2],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.keywordPlanNegativeKeywords.create(keyword_plan_negative_keyword) method makes a new KeywordPlanNegativeKeyword in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanNegativeKeyword object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst keyword_plan_negative_keyword = {\n // Your KeywordPlanNegativeKeyword here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.keywordPlanNegativeKeywords.create(keyword_plan_negative_keyword)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.keywordPlanNegativeKeywords.create(\n [keyword_plan_negative_keyword, other_keyword_plan_negative_keyword],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/9262111890/keywordPlanNegativeKeywords/13119148'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanNegativeKeywords.update(keyword_plan_negative_keyword) method changes the attributes of an existing keywordPlanNegativeKeywords in an account. It also supports an array as its first agument for batch operations.
The KeywordPlanNegativeKeyword object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst keyword_plan_negative_keyword = {\n resource_name: 'customers/9262111890/keywordPlanNegativeKeywords/13119148', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.keywordPlanNegativeKeywords.update(keyword_plan_negative_keyword)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.keywordPlanNegativeKeywords.update(\n [keyword_plan_negative_keyword, other_keyword_plan_negative_keyword],\n {\n validate_only: true,\n }\n)// Example result\n{\n\tresults : ['customers/9262111890/keywordPlanNegativeKeywords/13119148'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.keywordPlanNegativeKeywords.delete(resource_name) sets the status field of a KeywordPlanNegativeKeyword to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that KeywordPlanNegativeKeyword
\nNothing
","frontmatter":{"title":"Delete KeywordPlanNegativeKeyword","order":6,"type":"delete","entity":"KeywordPlanNegativeKeyword"},"fields":{"group":"entities","mega_order":0,"directory":"entities/keyword_plan_negative_keyword","is_entity_index":false}}},{"node":{"id":"e22b5406-319d-57ea-9722-5a41e6f99006","html":"// Deleting the entity\n\nawait customer.keywordPlanNegativeKeywords.delete('customers/9262111890/keywordPlanNegativeKeywords/13119148')// Example Label\nconst label = {\n id: 3345231412,\n name: 'My label',\n resource_name: 'customers/3827277046/labels/3345231412',\n status: 2,\n text_label: { background_color: '#e993eb', description: 'Adgroups where Chloe will write new ads that kick butt.' },\n}The customer.labels.get(resource_name) method returns the Label identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that Label
\nReturns that Label as an object.
","frontmatter":{"title":"Get Label","order":2,"type":"get","entity":"Label"},"fields":{"group":"entities","mega_order":0,"directory":"entities/label","is_entity_index":false}}},{"node":{"id":"1692de05-9d10-541c-bd4f-a7fc6a5a7d83","html":"// Getting the entity\nlet result = await customer.labels.get('customers/3827277046/labels/3345231412')// Example result\n;({\n id: 3345231412,\n name: 'My label',\n resource_name: 'customers/3827277046/labels/3345231412',\n status: 2,\n text_label: { background_color: '#e993eb', description: 'Adgroups where Chloe will write new ads that kick butt.' },\n})The customer.labels.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of Label.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a label property. Any other resources that can be selected with label will also be added as properities.
// Listing all the labels in the account\nlet result = await customer.labels.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.labels.list({\n constraints: [\n {\n key: 'label.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'label.some_field.sub_field',\n})// Example result\n;[\n {\n label: {\n id: 3345231412,\n name: 'My label',\n resource_name: 'customers/3827277046/labels/3345231412',\n status: 2,\n text_label: {\n background_color: '#e993eb',\n description: 'Adgroups where Chloe will write new ads that kick butt.',\n },\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.labels.create(label) method makes a new Label in an account. It also supports an array as its first agument for batch operations.
The Label object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst label = {\n // Your Label here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.labels.create(label)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.labels.create([label, other_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/labels/3345231412'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.labels.update(label) method changes the attributes of an existing labels in an account. It also supports an array as its first agument for batch operations.
The Label object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst label = {\n resource_name: 'customers/3827277046/labels/3345231412', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.labels.update(label)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.labels.update([label, other_label], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/labels/3345231412'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.labels.delete(resource_name) sets the status field of a Label to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that Label
\nNothing
","frontmatter":{"title":"Delete Label","order":6,"type":"delete","entity":"Label"},"fields":{"group":"entities","mega_order":0,"directory":"entities/label","is_entity_index":false}}},{"node":{"id":"2b9d23dd-b0f3-5172-9078-0cbb5d0c0a18","html":"// Deleting the entity\n\nawait customer.labels.delete('customers/3827277046/labels/3345231412')// Example LanguageConstant\nconst language_constant = {\n code: 'zh_TW',\n id: 1018,\n name: 'Chinese (traditional)',\n resource_name: 'languageConstants/1018',\n targetable: true,\n}The customer.languageConstants.get(resource_name) method returns the LanguageConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that LanguageConstant
\nReturns that LanguageConstant as an object.
","frontmatter":{"title":"Get LanguageConstant","order":2,"type":"get","entity":"LanguageConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/language_constant","is_entity_index":false}}},{"node":{"id":"5b6c776d-7d88-59c3-bb5e-b54b2faf147d","html":"// Getting the entity\nlet result = await customer.languageConstants.get('languageConstants/1018')// Example result\n;({ code: 'zh_TW', id: 1018, name: 'Chinese (traditional)', resource_name: 'languageConstants/1018', targetable: true })The customer.languageConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of LanguageConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a language_constant property. Any other resources that can be selected with language_constant will also be added as properities.
// Listing all the languageConstants in the account\nlet result = await customer.languageConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.languageConstants.list({\n constraints: [\n {\n key: 'language_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'language_constant.some_field.sub_field',\n})// Example result\n;[\n {\n language_constant: {\n code: 'zh_TW',\n id: 1018,\n name: 'Chinese (traditional)',\n resource_name: 'languageConstants/1018',\n targetable: true,\n },\n },\n]// Example MediaFile\nconst media_file = {\n file_size: 5159,\n id: 44067075104,\n mime_type: 2,\n name: '',\n resource_name: 'customers/3827277046/mediaFiles/44067075104',\n source_url:\n 'https://lh3.googleusercontent.com/D3DAe038umSn2ap4q_Ll7HPSTNj5szBbJNOoXeblYkmlZHCGg1JiIq45WIr_CEGM9FXoH1vb9Hi1gF7CLw',\n type: 2,\n}The customer.mediaFiles.get(resource_name) method returns the MediaFile identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that MediaFile
\nReturns that MediaFile as an object.
","frontmatter":{"title":"Get MediaFile","order":2,"type":"get","entity":"MediaFile"},"fields":{"group":"entities","mega_order":0,"directory":"entities/media_file","is_entity_index":false}}},{"node":{"id":"9018fad0-4a5d-5ee1-a947-ff5f5910aee0","html":"// Getting the entity\nlet result = await customer.mediaFiles.get('customers/3827277046/mediaFiles/44067075104')// Example result\n;({\n file_size: 5159,\n id: 44067075104,\n mime_type: 2,\n name: '',\n resource_name: 'customers/3827277046/mediaFiles/44067075104',\n source_url:\n 'https://lh3.googleusercontent.com/D3DAe038umSn2ap4q_Ll7HPSTNj5szBbJNOoXeblYkmlZHCGg1JiIq45WIr_CEGM9FXoH1vb9Hi1gF7CLw',\n type: 2,\n})The customer.mediaFiles.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of MediaFile.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a media_file property. Any other resources that can be selected with media_file will also be added as properities.
// Listing all the mediaFiles in the account\nlet result = await customer.mediaFiles.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.mediaFiles.list({\n constraints: [\n {\n key: 'media_file.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'media_file.some_field.sub_field',\n})// Example result\n;[\n {\n media_file: {\n file_size: 5159,\n id: 44067075104,\n mime_type: 2,\n name: '',\n resource_name: 'customers/3827277046/mediaFiles/44067075104',\n source_url:\n 'https://lh3.googleusercontent.com/D3DAe038umSn2ap4q_Ll7HPSTNj5szBbJNOoXeblYkmlZHCGg1JiIq45WIr_CEGM9FXoH1vb9Hi1gF7CLw',\n type: 2,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.mediaFiles.create(media_file) method makes a new MediaFile in an account. It also supports an array as its first agument for batch operations.
The MediaFile object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst media_file = {\n // Your MediaFile here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.mediaFiles.create(media_file)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.mediaFiles.create([media_file, other_media_file], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/mediaFiles/44067075104'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.mediaFiles.update(media_file) method changes the attributes of an existing mediaFiles in an account. It also supports an array as its first agument for batch operations.
The MediaFile object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst media_file = {\n resource_name: 'customers/3827277046/mediaFiles/44067075104', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.mediaFiles.update(media_file)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.mediaFiles.update([media_file, other_media_file], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/mediaFiles/44067075104'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.mediaFiles.delete(resource_name) sets the status field of a MediaFile to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that MediaFile
\nNothing
","frontmatter":{"title":"Delete MediaFile","order":6,"type":"delete","entity":"MediaFile"},"fields":{"group":"entities","mega_order":0,"directory":"entities/media_file","is_entity_index":false}}},{"node":{"id":"0cd057ba-b0d0-56ce-ae9d-b3b809bcddae","html":"// Deleting the entity\n\nawait customer.mediaFiles.delete('customers/3827277046/mediaFiles/44067075104')// Example MobileAppCategoryConstant\nconst mobile_app_category_constant = {\n id: 60013,\n name: 'Video Players & Editors',\n resource_name: 'mobileAppCategoryConstants/60013',\n}The customer.mobileAppCategoryConstants.get(resource_name) method returns the MobileAppCategoryConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that MobileAppCategoryConstant
\nReturns that MobileAppCategoryConstant as an object.
","frontmatter":{"title":"Get MobileAppCategoryConstant","order":2,"type":"get","entity":"MobileAppCategoryConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/mobile_app_category_constant","is_entity_index":false}}},{"node":{"id":"506a9998-f518-558d-b7d5-ec2a6b14cd83","html":"// Getting the entity\nlet result = await customer.mobileAppCategoryConstants.get('mobileAppCategoryConstants/60013')// Example result\n;({ id: 60013, name: 'Video Players & Editors', resource_name: 'mobileAppCategoryConstants/60013' })The customer.mobileAppCategoryConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of MobileAppCategoryConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a mobile_app_category_constant property. Any other resources that can be selected with mobile_app_category_constant will also be added as properities.
// Listing all the mobileAppCategoryConstants in the account\nlet result = await customer.mobileAppCategoryConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.mobileAppCategoryConstants.list({\n constraints: [\n {\n key: 'mobile_app_category_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'mobile_app_category_constant.some_field.sub_field',\n})// Example result\n;[\n {\n mobile_app_category_constant: {\n id: 60013,\n name: 'Video Players & Editors',\n resource_name: 'mobileAppCategoryConstants/60013',\n },\n },\n]// Example MobileDeviceConstant\nconst mobile_device_constant = {\n id: 605309,\n manufacturer_name: 'T-Mobile',\n name: 'myTouch 3G Slide',\n operating_system_name: 'Android',\n resource_name: 'mobileDeviceConstants/605309',\n type: 2,\n}The customer.mobileDeviceConstants.get(resource_name) method returns the MobileDeviceConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that MobileDeviceConstant
\nReturns that MobileDeviceConstant as an object.
","frontmatter":{"title":"Get MobileDeviceConstant","order":2,"type":"get","entity":"MobileDeviceConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/mobile_device_constant","is_entity_index":false}}},{"node":{"id":"4d9f09fc-5d4a-5f85-ab69-c6aad5ace129","html":"// Getting the entity\nlet result = await customer.mobileDeviceConstants.get('mobileDeviceConstants/605309')// Example result\n;({\n id: 605309,\n manufacturer_name: 'T-Mobile',\n name: 'myTouch 3G Slide',\n operating_system_name: 'Android',\n resource_name: 'mobileDeviceConstants/605309',\n type: 2,\n})The customer.mobileDeviceConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of MobileDeviceConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a mobile_device_constant property. Any other resources that can be selected with mobile_device_constant will also be added as properities.
// Listing all the mobileDeviceConstants in the account\nlet result = await customer.mobileDeviceConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.mobileDeviceConstants.list({\n constraints: [\n {\n key: 'mobile_device_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'mobile_device_constant.some_field.sub_field',\n})// Example result\n;[\n {\n mobile_device_constant: {\n id: 605309,\n manufacturer_name: 'T-Mobile',\n name: 'myTouch 3G Slide',\n operating_system_name: 'Android',\n resource_name: 'mobileDeviceConstants/605309',\n type: 2,\n },\n },\n]// Example OperatingSystemVersionConstant\nconst operating_system_version_constant = {\n id: 630266,\n name: 'WindowsPhone',\n operator_type: 2,\n os_major_version: -1,\n os_minor_version: -1,\n resource_name: 'operatingSystemVersionConstants/630266',\n}The customer.operatingSystemVersionConstants.get(resource_name) method returns the OperatingSystemVersionConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that OperatingSystemVersionConstant
\nReturns that OperatingSystemVersionConstant as an object.
","frontmatter":{"title":"Get OperatingSystemVersionConstant","order":2,"type":"get","entity":"OperatingSystemVersionConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/operating_system_version_constant","is_entity_index":false}}},{"node":{"id":"08111541-7f18-5074-b579-6118f5104cf5","html":"// Getting the entity\nlet result = await customer.operatingSystemVersionConstants.get('operatingSystemVersionConstants/630266')// Example result\n;({\n id: 630266,\n name: 'WindowsPhone',\n operator_type: 2,\n os_major_version: -1,\n os_minor_version: -1,\n resource_name: 'operatingSystemVersionConstants/630266',\n})The customer.operatingSystemVersionConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of OperatingSystemVersionConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a operating_system_version_constant property. Any other resources that can be selected with operating_system_version_constant will also be added as properities.
// Listing all the operatingSystemVersionConstants in the account\nlet result = await customer.operatingSystemVersionConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.operatingSystemVersionConstants.list({\n constraints: [\n {\n key: 'operating_system_version_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'operating_system_version_constant.some_field.sub_field',\n})// Example result\n;[\n {\n operating_system_version_constant: {\n id: 630266,\n name: 'WindowsPhone',\n operator_type: 2,\n os_major_version: -1,\n os_minor_version: -1,\n resource_name: 'operatingSystemVersionConstants/630266',\n },\n },\n]// Example ProductBiddingCategoryConstant\nconst product_bidding_category_constant = {\n country_code: 'AU',\n id: 55,\n language_code: 'en',\n level: 4,\n localized_name: 'Musical Instrument & Orchestra Accessories',\n product_bidding_category_constant_parent: 'productBiddingCategoryConstants/AU~LEVEL2~5710',\n resource_name: 'productBiddingCategoryConstants/AU~LEVEL3~55',\n status: 2,\n}The customer.productBiddingCategoryConstants.get(resource_name) method returns the ProductBiddingCategoryConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that ProductBiddingCategoryConstant
\nReturns that ProductBiddingCategoryConstant as an object.
","frontmatter":{"title":"Get ProductBiddingCategoryConstant","order":2,"type":"get","entity":"ProductBiddingCategoryConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/product_bidding_category_constant","is_entity_index":false}}},{"node":{"id":"7336e3a6-3572-5e1a-9303-cf0780f38661","html":"// Getting the entity\nlet result = await customer.productBiddingCategoryConstants.get('productBiddingCategoryConstants/AU~LEVEL3~55')// Example result\n;({\n country_code: 'AU',\n id: 55,\n language_code: 'en',\n level: 4,\n localized_name: 'Musical Instrument & Orchestra Accessories',\n product_bidding_category_constant_parent: 'productBiddingCategoryConstants/AU~LEVEL2~5710',\n resource_name: 'productBiddingCategoryConstants/AU~LEVEL3~55',\n status: 2,\n})The customer.productBiddingCategoryConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of ProductBiddingCategoryConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a product_bidding_category_constant property. Any other resources that can be selected with product_bidding_category_constant will also be added as properities.
// Listing all the productBiddingCategoryConstants in the account\nlet result = await customer.productBiddingCategoryConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.productBiddingCategoryConstants.list({\n constraints: [\n {\n key: 'product_bidding_category_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'product_bidding_category_constant.some_field.sub_field',\n})// Example result\n;[\n {\n product_bidding_category_constant: {\n country_code: 'AU',\n id: 55,\n language_code: 'en',\n level: 4,\n localized_name: 'Musical Instrument & Orchestra Accessories',\n product_bidding_category_constant_parent: 'productBiddingCategoryConstants/AU~LEVEL2~5710',\n resource_name: 'productBiddingCategoryConstants/AU~LEVEL3~55',\n status: 2,\n },\n },\n]// Example Recommendation\nconst recommendation = {\n ad_group: 'customers/3827277046/adGroups/77057363272',\n campaign: 'customers/3827277046/campaigns/2081620948',\n campaign_budget: 'customers/3827277046/campaignBudgets/6449346162',\n dismissed: false,\n impact: {\n base_metrics: { clicks: 2, cost_micros: 20460000, impressions: 12 },\n potential_metrics: { clicks: 4, conversions: 0.05, cost_micros: 36006832, impressions: 110 },\n },\n keyword_recommendation: {\n keyword: { match_type: 2, text: 'google adwords management' },\n recommended_cpc_bid_micros: 9600000,\n },\n resource_name:\n 'customers/3827277046/recommendations/MTk5MDY3NzIzLTE2My0xNTk1MTg1NjIwMDAwLSsyMDgxNjIwOTQ4LTc3MDU3MzYzMjcyLTIyNzkzMTg2Nzk5NTk5NTgxOTU',\n type: 3,\n}The customer.recommendations.get(resource_name) method returns the Recommendation identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that Recommendation
\nReturns that Recommendation as an object.
","frontmatter":{"title":"Get Recommendation","order":2,"type":"get","entity":"Recommendation"},"fields":{"group":"entities","mega_order":0,"directory":"entities/recommendation","is_entity_index":false}}},{"node":{"id":"a5782e1e-5b31-5e8c-9c4d-b1589d640176","html":"// Getting the entity\nlet result = await customer.recommendations.get(\n 'customers/3827277046/recommendations/MTk5MDY3NzIzLTE2My0xNTk1MTg1NjIwMDAwLSsyMDgxNjIwOTQ4LTc3MDU3MzYzMjcyLTIyNzkzMTg2Nzk5NTk5NTgxOTU'\n)// Example result\n;({\n ad_group: 'customers/3827277046/adGroups/77057363272',\n campaign: 'customers/3827277046/campaigns/2081620948',\n campaign_budget: 'customers/3827277046/campaignBudgets/6449346162',\n dismissed: false,\n impact: {\n base_metrics: { clicks: 2, cost_micros: 20460000, impressions: 12 },\n potential_metrics: { clicks: 4, conversions: 0.05, cost_micros: 36006832, impressions: 110 },\n },\n keyword_recommendation: {\n keyword: { match_type: 2, text: 'google adwords management' },\n recommended_cpc_bid_micros: 9600000,\n },\n resource_name:\n 'customers/3827277046/recommendations/MTk5MDY3NzIzLTE2My0xNTk1MTg1NjIwMDAwLSsyMDgxNjIwOTQ4LTc3MDU3MzYzMjcyLTIyNzkzMTg2Nzk5NTk5NTgxOTU',\n type: 3,\n})The customer.recommendations.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of Recommendation.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a recommendation property. Any other resources that can be selected with recommendation will also be added as properities.
// Listing all the recommendations in the account\nlet result = await customer.recommendations.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.recommendations.list({\n constraints: [\n {\n key: 'recommendation.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'recommendation.some_field.sub_field',\n})// Example result\n;[\n {\n recommendation: {\n ad_group: 'customers/3827277046/adGroups/77057363272',\n campaign: 'customers/3827277046/campaigns/2081620948',\n campaign_budget: 'customers/3827277046/campaignBudgets/6449346162',\n dismissed: false,\n impact: {\n base_metrics: { clicks: 2, cost_micros: 20460000, impressions: 12 },\n potential_metrics: { clicks: 4, conversions: 0.05, cost_micros: 36006832, impressions: 110 },\n },\n keyword_recommendation: {\n keyword: { match_type: 2, text: 'google adwords management' },\n recommended_cpc_bid_micros: 9600000,\n },\n resource_name:\n 'customers/3827277046/recommendations/MTk5MDY3NzIzLTE2My0xNTk1MTg1NjIwMDAwLSsyMDgxNjIwOTQ4LTc3MDU3MzYzMjcyLTIyNzkzMTg2Nzk5NTk5NTgxOTU',\n type: 3,\n },\n campaign_budget: {\n amount_micros: 290000000,\n delivery_method: 2,\n explicitly_shared: false,\n has_recommended_budget: false,\n id: 6449346162,\n name: 'My campaign budget',\n period: 2,\n reference_count: 1,\n resource_name: 'customers/3827277046/campaignBudgets/6449346162',\n status: 2,\n type: 2,\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/77057363272',\n campaign: 'customers/3827277046/campaigns/2081620948',\n cpc_bid_micros: 9600000,\n cpm_bid_micros: 10000000,\n cpv_bid_micros: 0,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 12000000,\n effective_target_cpa_source: 6,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 77057363272,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/77057363272',\n status: 2,\n target_cpa_micros: 12000000,\n target_cpm_micros: 10000000,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: true },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: true },\n { targeting_dimension: 6, bid_only: true },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: true },\n { targeting_dimension: 9, bid_only: true },\n ],\n },\n type: 2,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/3827277046/campaigns/2081620948',\n bidding_strategy_type: 3,\n campaign_budget: 'customers/3827277046/campaignBudgets/6449346162',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 5, positive_geo_target_type: 7 },\n id: 2081620948,\n labels: [\n 'customers/3827277046/labels/3889728216',\n 'customers/3827277046/labels/3889728468',\n 'customers/3827277046/labels/3889728480',\n ],\n manual_cpc: { enhanced_cpc_enabled: true },\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: false,\n },\n optimization_score: 0.8309262174345264,\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/2081620948',\n serving_status: 2,\n start_date: '2019-07-30',\n status: 2,\n targeting_setting: { target_restrictions: [{ targeting_dimension: 3, bid_only: true }] },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]// Example RemarketingAction\nconst remarketing_action = /* Todo: add example get() return here */The customer.remarketingActions.get(resource_name) method returns the RemarketingAction identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that RemarketingAction
\nReturns that RemarketingAction as an object.
","frontmatter":{"title":"Get RemarketingAction","order":2,"type":"get","entity":"RemarketingAction"},"fields":{"group":"entities","mega_order":0,"directory":"entities/remarketing_action","is_entity_index":false}}},{"node":{"id":"0d523a49-cd0b-5517-8d01-dce1b5521f88","html":"// Getting the entity\nlet result = await customer.remarketingActions.get('customers/1234567890/remarketingActions/123123123')// Example result\n(/* Todo: add example get() return here */)The customer.remarketingActions.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of RemarketingAction.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a remarketing_action property. Any other resources that can be selected with remarketing_action will also be added as properities.
// Listing all the remarketingActions in the account\nlet result = await customer.remarketingActions.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.remarketingActions.list({\n constraints: [\n {\n key: 'remarketing_action.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'remarketing_action.some_field.sub_field',\n})// Example result\n;[\n /* Todo: add example list() return here */\n]The customer.remarketingActions.create(remarketing_action) method makes a new RemarketingAction in an account. It also supports an array as its first agument for batch operations.
The RemarketingAction object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst remarketing_action = {\n // Your RemarketingAction here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.remarketingActions.create(remarketing_action)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.remarketingActions.create([remarketing_action, other_remarketing_action], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/remarketingActions/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.remarketingActions.update(remarketing_action) method changes the attributes of an existing remarketingActions in an account. It also supports an array as its first agument for batch operations.
The RemarketingAction object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst remarketing_action = {\n resource_name: 'customers/1234567890/remarketingActions/123123123', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.remarketingActions.update(remarketing_action)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.remarketingActions.update([remarketing_action, other_remarketing_action], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/1234567890/remarketingActions/123123123'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.remarketingActions.delete(resource_name) sets the status field of a RemarketingAction to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that RemarketingAction
\nNothing
","frontmatter":{"title":"Delete RemarketingAction","order":6,"type":"delete","entity":"RemarketingAction"},"fields":{"group":"entities","mega_order":0,"directory":"entities/remarketing_action","is_entity_index":false}}},{"node":{"id":"d286340c-69b4-5f05-86b7-8effe1c1d3b8","html":"// Deleting the entity\n\nawait customer.remarketingActions.delete('customers/1234567890/remarketingActions/123123123')// Example SharedCriterion\nconst shared_criterion = {\n criterion_id: 627191652608,\n keyword: { match_type: 2, text: 'test-keyword-399026' },\n resource_name: 'customers/9262111890/sharedCriteria/1788591305~627191652608',\n shared_set: 'customers/9262111890/sharedSets/1788591305',\n type: 2,\n}The customer.sharedCriteria.get(resource_name) method returns the SharedCriterion identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that SharedCriterion
\nReturns that SharedCriterion as an object.
","frontmatter":{"title":"Get SharedCriterion","order":2,"type":"get","entity":"SharedCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/shared_criterion","is_entity_index":false}}},{"node":{"id":"ebd59b69-c221-5417-a661-7473484f57ac","html":"// Getting the entity\nlet result = await customer.sharedCriteria.get('customers/9262111890/sharedCriteria/1788591305~627191652608')// Example result\n;({\n criterion_id: 627191652608,\n keyword: { match_type: 2, text: 'test-keyword-399026' },\n resource_name: 'customers/9262111890/sharedCriteria/1788591305~627191652608',\n shared_set: 'customers/9262111890/sharedSets/1788591305',\n type: 2,\n})The customer.sharedCriteria.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of SharedCriterion.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a shared_criterion property. Any other resources that can be selected with shared_criterion will also be added as properities.
// Listing all the sharedCriteria in the account\nlet result = await customer.sharedCriteria.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.sharedCriteria.list({\n constraints: [\n {\n key: 'shared_criterion.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'shared_criterion.some_field.sub_field',\n})// Example result\n;[\n {\n shared_criterion: {\n criterion_id: 627191652608,\n keyword: { match_type: 2, text: 'test-keyword-399026' },\n resource_name: 'customers/9262111890/sharedCriteria/1788591305~627191652608',\n shared_set: 'customers/9262111890/sharedSets/1788591305',\n type: 2,\n },\n shared_set: {\n id: 1788591305,\n member_count: 6,\n name: 'My shared set',\n reference_count: 0,\n resource_name: 'customers/9262111890/sharedSets/1788591305',\n status: 2,\n type: 2,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.sharedCriteria.create(shared_criterion) method makes a new SharedCriterion in an account. It also supports an array as its first agument for batch operations.
The SharedCriterion object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst shared_criterion = {\n // Your SharedCriterion here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.sharedCriteria.create(shared_criterion)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.sharedCriteria.create([shared_criterion, other_shared_criterion], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/sharedCriteria/1788591305~627191652608'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.sharedCriteria.update(shared_criterion) method changes the attributes of an existing sharedCriteria in an account. It also supports an array as its first agument for batch operations.
The SharedCriterion object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst shared_criterion = {\n resource_name: 'customers/9262111890/sharedCriteria/1788591305~627191652608', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.sharedCriteria.update(shared_criterion)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.sharedCriteria.update([shared_criterion, other_shared_criterion], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/sharedCriteria/1788591305~627191652608'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.sharedCriteria.delete(resource_name) sets the status field of a SharedCriterion to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that SharedCriterion
\nNothing
","frontmatter":{"title":"Delete SharedCriterion","order":6,"type":"delete","entity":"SharedCriterion"},"fields":{"group":"entities","mega_order":0,"directory":"entities/shared_criterion","is_entity_index":false}}},{"node":{"id":"20ecb103-875d-51ef-8f7e-089f65505077","html":"// Deleting the entity\n\nawait customer.sharedCriteria.delete('customers/9262111890/sharedCriteria/1788591305~627191652608')// Example SharedSet\nconst shared_set = {\n id: 1788591305,\n member_count: 6,\n name: 'My shared set',\n reference_count: 0,\n resource_name: 'customers/9262111890/sharedSets/1788591305',\n status: 2,\n type: 2,\n}The customer.sharedSets.get(resource_name) method returns the SharedSet identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that SharedSet
\nReturns that SharedSet as an object.
","frontmatter":{"title":"Get SharedSet","order":2,"type":"get","entity":"SharedSet"},"fields":{"group":"entities","mega_order":0,"directory":"entities/shared_set","is_entity_index":false}}},{"node":{"id":"d1e42dcf-622a-5725-97bb-fdd2b02e388b","html":"// Getting the entity\nlet result = await customer.sharedSets.get('customers/9262111890/sharedSets/1788591305')// Example result\n;({\n id: 1788591305,\n member_count: 6,\n name: 'My shared set',\n reference_count: 0,\n resource_name: 'customers/9262111890/sharedSets/1788591305',\n status: 2,\n type: 2,\n})The customer.sharedSets.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of SharedSet.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a shared_set property. Any other resources that can be selected with shared_set will also be added as properities.
// Listing all the sharedSets in the account\nlet result = await customer.sharedSets.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.sharedSets.list({\n constraints: [\n {\n key: 'shared_set.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'shared_set.some_field.sub_field',\n})// Example result\n;[\n {\n shared_set: {\n id: 1788591305,\n member_count: 6,\n name: 'My shared set',\n reference_count: 0,\n resource_name: 'customers/9262111890/sharedSets/1788591305',\n status: 2,\n type: 2,\n },\n campaign_shared_set: {\n campaign: 'customers/9262111890/campaigns/1485014801',\n resource_name: 'customers/9262111890/campaignSharedSets/1485014801~1788591305',\n shared_set: 'customers/9262111890/sharedSets/1788591305',\n status: 3,\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 2,\n base_campaign: 'customers/9262111890/campaigns/1485014801',\n bidding_strategy_type: 9,\n campaign_budget: 'customers/9262111890/campaignBudgets/1548344372',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [],\n geo_target_type_setting: { negative_geo_target_type: 4, positive_geo_target_type: 5 },\n id: 1485014801,\n labels: [],\n name: 'My campaign',\n network_settings: {\n target_content_network: true,\n target_google_search: true,\n target_partner_search_network: false,\n target_search_network: true,\n },\n payment_mode: 4,\n resource_name: 'customers/9262111890/campaigns/1485014801',\n serving_status: 2,\n start_date: '2018-07-24',\n status: 2,\n target_spend: { cpc_bid_ceiling_micros: 1000000 },\n url_custom_parameters: [],\n video_brand_safety_suitability: 0,\n },\n customer: {\n auto_tagging_enabled: false,\n call_reporting_setting: {\n call_conversion_action: 'customers/9262111890/conversionActions/179',\n call_conversion_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 797556569 },\n currency_code: 'EUR',\n descriptive_name: 'My customer',\n has_partners_badge: false,\n id: 9262111890,\n manager: false,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 797556569 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-797556569\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-797556569');\\n</script>\\n\",\n },\n resource_name: 'customers/9262111890',\n test_account: true,\n time_zone: 'Europe/London',\n },\n },\n]The customer.sharedSets.create(shared_set) method makes a new SharedSet in an account. It also supports an array as its first agument for batch operations.
The SharedSet object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst shared_set = {\n // Your SharedSet here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.sharedSets.create(shared_set)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.sharedSets.create([shared_set, other_shared_set], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/sharedSets/1788591305'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.sharedSets.update(shared_set) method changes the attributes of an existing sharedSets in an account. It also supports an array as its first agument for batch operations.
The SharedSet object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst shared_set = {\n resource_name: 'customers/9262111890/sharedSets/1788591305', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.sharedSets.update(shared_set)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.sharedSets.update([shared_set, other_shared_set], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/9262111890/sharedSets/1788591305'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.sharedSets.delete(resource_name) sets the status field of a SharedSet to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that SharedSet
\nNothing
","frontmatter":{"title":"Delete SharedSet","order":6,"type":"delete","entity":"SharedSet"},"fields":{"group":"entities","mega_order":0,"directory":"entities/shared_set","is_entity_index":false}}},{"node":{"id":"870dec86-6471-5532-92ab-73f752a100ae","html":"// Deleting the entity\n\nawait customer.sharedSets.delete('customers/9262111890/sharedSets/1788591305')// Example TopicConstant\nconst topic_constant = {\n id: 115,\n path: [\n '',\n 'People & Society',\n 'Family & Relationships',\n 'Family',\n 'Parenting',\n 'Babies & Toddlers',\n 'Baby Care & Hygiene',\n ],\n resource_name: 'topicConstants/115',\n topic_constant_parent: 'topicConstants/1374',\n}The customer.topicConstants.get(resource_name) method returns the TopicConstant identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that TopicConstant
\nReturns that TopicConstant as an object.
","frontmatter":{"title":"Get TopicConstant","order":2,"type":"get","entity":"TopicConstant"},"fields":{"group":"entities","mega_order":0,"directory":"entities/topic_constant","is_entity_index":false}}},{"node":{"id":"caff0516-e042-5e0d-8bdc-4156fb95c5f4","html":"// Getting the entity\nlet result = await customer.topicConstants.get('topicConstants/115')// Example result\n;({\n id: 115,\n path: [\n '',\n 'People & Society',\n 'Family & Relationships',\n 'Family',\n 'Parenting',\n 'Babies & Toddlers',\n 'Baby Care & Hygiene',\n ],\n resource_name: 'topicConstants/115',\n topic_constant_parent: 'topicConstants/1374',\n})The customer.topicConstants.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of TopicConstant.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a topic_constant property. Any other resources that can be selected with topic_constant will also be added as properities.
// Listing all the topicConstants in the account\nlet result = await customer.topicConstants.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.topicConstants.list({\n constraints: [\n {\n key: 'topic_constant.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'topic_constant.some_field.sub_field',\n})// Example result\n;[\n {\n topic_constant: {\n id: 115,\n path: [\n '',\n 'People & Society',\n 'Family & Relationships',\n 'Family',\n 'Parenting',\n 'Babies & Toddlers',\n 'Baby Care & Hygiene',\n ],\n resource_name: 'topicConstants/115',\n topic_constant_parent: 'topicConstants/1374',\n },\n },\n]// Example UserInterest\nconst user_interest = {\n availabilities: [],\n launched_to_all: true,\n name: 'My user interest',\n resource_name: 'customers/9262111890/userInterests/84',\n taxonomy_type: 5,\n user_interest_id: 84,\n user_interest_parent: 'customers/9262111890/userInterests/302',\n}The customer.userInterests.get(resource_name) method returns the UserInterest identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that UserInterest
\nReturns that UserInterest as an object.
","frontmatter":{"title":"Get UserInterest","order":2,"type":"get","entity":"UserInterest"},"fields":{"group":"entities","mega_order":0,"directory":"entities/user_interest","is_entity_index":false}}},{"node":{"id":"13902bfe-406a-5e64-97ff-02a9174d9290","html":"// Getting the entity\nlet result = await customer.userInterests.get('customers/9262111890/userInterests/84')// Example result\n;({\n availabilities: [],\n launched_to_all: true,\n name: 'My user interest',\n resource_name: 'customers/9262111890/userInterests/84',\n taxonomy_type: 5,\n user_interest_id: 84,\n user_interest_parent: 'customers/9262111890/userInterests/302',\n})The customer.userInterests.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of UserInterest.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a user_interest property. Any other resources that can be selected with user_interest will also be added as properities.
// Listing all the userInterests in the account\nlet result = await customer.userInterests.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.userInterests.list({\n constraints: [\n {\n key: 'user_interest.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'user_interest.some_field.sub_field',\n})// Example result\n;[\n {\n user_interest: {\n availabilities: [],\n launched_to_all: true,\n name: 'My user interest',\n resource_name: 'customers/9262111890/userInterests/84',\n taxonomy_type: 5,\n user_interest_id: 84,\n user_interest_parent: 'customers/9262111890/userInterests/302',\n },\n },\n]// Example UserList\nconst user_list = {\n access_reason: 2,\n account_user_list_status: 2,\n closing_reason: 0,\n description: 'Combined audience based on available data sources',\n eligible_for_display: true,\n eligible_for_search: true,\n id: 509186086,\n logical_user_list: {\n rules: [\n {\n operator: 3,\n rule_operands_list: [\n { user_list: 'customers/3827277046/userLists/814539380' },\n { user_list: 'customers/3827277046/userLists/508846109' },\n { user_list: 'customers/3827277046/userLists/614318739' },\n ],\n },\n ],\n },\n membership_life_span: 30,\n membership_status: 2,\n name: 'My user list',\n read_only: true,\n resource_name: 'customers/3827277046/userLists/509186086',\n size_for_display: 320,\n size_for_search: 490,\n size_range_for_display: 2,\n size_range_for_search: 2,\n type: 3,\n}The customer.userLists.get(resource_name) method returns the UserList identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that UserList
\nReturns that UserList as an object.
","frontmatter":{"title":"Get UserList","order":2,"type":"get","entity":"UserList"},"fields":{"group":"entities","mega_order":0,"directory":"entities/user_list","is_entity_index":false}}},{"node":{"id":"5d68f17f-5b88-5c2a-a0f2-816b58a07779","html":"// Getting the entity\nlet result = await customer.userLists.get('customers/3827277046/userLists/509186086')// Example result\n;({\n access_reason: 2,\n account_user_list_status: 2,\n closing_reason: 0,\n description: 'Combined audience based on available data sources',\n eligible_for_display: true,\n eligible_for_search: true,\n id: 509186086,\n logical_user_list: {\n rules: [\n {\n operator: 3,\n rule_operands_list: [\n { user_list: 'customers/3827277046/userLists/814539380' },\n { user_list: 'customers/3827277046/userLists/508846109' },\n { user_list: 'customers/3827277046/userLists/614318739' },\n ],\n },\n ],\n },\n membership_life_span: 30,\n membership_status: 2,\n name: 'My user list',\n read_only: true,\n resource_name: 'customers/3827277046/userLists/509186086',\n size_for_display: 320,\n size_for_search: 490,\n size_range_for_display: 2,\n size_range_for_search: 2,\n type: 3,\n})The customer.userLists.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of UserList.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a user_list property. Any other resources that can be selected with user_list will also be added as properities.
// Listing all the userLists in the account\nlet result = await customer.userLists.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.userLists.list({\n constraints: [\n {\n key: 'user_list.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'user_list.some_field.sub_field',\n})// Example result\n;[\n {\n user_list: {\n access_reason: 2,\n account_user_list_status: 2,\n closing_reason: 0,\n description: 'Combined audience based on available data sources',\n eligible_for_display: true,\n eligible_for_search: true,\n id: 509186086,\n logical_user_list: {\n rules: [\n {\n operator: 3,\n rule_operands_list: [\n { user_list: 'customers/3827277046/userLists/814539380' },\n { user_list: 'customers/3827277046/userLists/508846109' },\n { user_list: 'customers/3827277046/userLists/614318739' },\n ],\n },\n ],\n },\n membership_life_span: 30,\n membership_status: 2,\n name: 'My user list',\n read_only: true,\n resource_name: 'customers/3827277046/userLists/509186086',\n size_for_display: 320,\n size_for_search: 490,\n size_range_for_display: 2,\n size_range_for_search: 2,\n type: 3,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]The customer.userLists.create(user_list) method makes a new UserList in an account. It also supports an array as its first agument for batch operations.
The UserList object or array of objects.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to create will cause the whole operation to be rolled back. When true, the system will still create the non-failed entities. Defaults to false.
An array of the resource_names created.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Creating the entity\n\nconst user_list = {\n // Your UserList here, without immutable fields such as resource_name\n}\n\n// Passing in a single entity to create\nconst result = await customer.userLists.create(user_list)\n\n// Passing in an array of entities to create, validating only\nconst result = await customer.userLists.create([user_list, other_user_list], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/userLists/509186086'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.userLists.update(user_list) method changes the attributes of an existing userLists in an account. It also supports an array as its first agument for batch operations.
The UserList object or array of objects. These must have a resource_name field set to identify the entity. Any other fields that you set will be updated.
\n Object of the form { validate_only, partial_failure }:
When true, only checks whether the operation is valid. Makes no changes to your google ads account. Defaults to false.
Only useful when passing in an array of entities. When false, a single failure in the array of entities to update will cause the whole operation to be rolled back. When true, the system will still update the non-failed entities. Defaults to false.
An array of the resource_names updated.
If partial_failure was set to true, an array of errors.
The request object sent to google's gRPC services. Useful for debugging.
\n// Updating the entity\n\nconst user_list = {\n resource_name: 'customers/3827277046/userLists/509186086', // The resource_name is required\n // ...any other fields that you would like to update\n}\n\n// Passing in a single entity to update\nconst result = await customer.userLists.update(user_list)\n\n// Passing in an array of entities to update, validating only\nconst result = await customer.userLists.update([user_list, other_user_list], {\n validate_only: true,\n})// Example result\n{\n\tresults : ['customers/3827277046/userLists/509186086'],\n\tpartial_failure_error : null,\n\trequest: { /* your request object */ }\n}The customer.userLists.delete(resource_name) sets the status field of a UserList to REMOVED. Those entities and their metrics will continue to exist, but they will be read-only. Removed entities cannot be re-enabled.
The resource_name of that UserList
\nNothing
","frontmatter":{"title":"Delete UserList","order":6,"type":"delete","entity":"UserList"},"fields":{"group":"entities","mega_order":0,"directory":"entities/user_list","is_entity_index":false}}},{"node":{"id":"30b6c9cc-d4a4-560c-a1ba-c05728136623","html":"// Deleting the entity\n\nawait customer.userLists.delete('customers/3827277046/userLists/509186086')// Example Video\nconst video = {\n channel_id: 'UCOSYb4yvogm0SAI8rX8kGWQ',\n duration_millis: 40356,\n id: 'V_jS8nLLpZI',\n resource_name: 'customers/3827277046/videos/Vl9qUzhuTExwWkk',\n title: 'Opteo',\n}The customer.videos.get(resource_name) method returns the Video identified by a resource_name.
\n\nNote: This function is heavily rate-limited by Google, so avoid using it in production.
\n
The resource_name of that Video
\nReturns that Video as an object.
","frontmatter":{"title":"Get Video","order":2,"type":"get","entity":"Video"},"fields":{"group":"entities","mega_order":0,"directory":"entities/video","is_entity_index":false}}},{"node":{"id":"1dd3f7da-e50a-5263-9c12-a22d3b47c934","html":"// Getting the entity\nlet result = await customer.videos.get('customers/3827277046/videos/Vl9qUzhuTExwWkk')// Example result\n;({\n channel_id: 'UCOSYb4yvogm0SAI8rX8kGWQ',\n duration_millis: 40356,\n id: 'V_jS8nLLpZI',\n resource_name: 'customers/3827277046/videos/Vl9qUzhuTExwWkk',\n title: 'Opteo',\n})The customer.videos.list() returns all of the entities in the account, including REMOVED entities. It also returns all other resources that can be selected with each instance of Video.
This method was designed for convenience and discovery. Internally, it uses the customer.report() method with all attributes fields included. For production code, we recommend using customer.report() with only the fields you need.
Object of the form { limit, order_by, constraints }:
Number of rows to return. Equivalent to the limit in customer.report(). Defaults to no limit.
The field to sort the returned rows by. Equivalent to the order_by in customer.report(). By default, no sorting is applied.
A constraints array or object. See the customer.report() documentation for details. By default, all entities are returned.
Returns an array of objects.\nEach object has a video property. Any other resources that can be selected with video will also be added as properities.
// Listing all the videos in the account\nlet result = await customer.videos.list()\n\n// Listing with constraints, sorting, and a limited number of results\nlet result = await customer.videos.list({\n constraints: [\n {\n key: 'video.some_field',\n op: '=',\n val: 'yellow submarine',\n },\n ],\n limit: 15,\n order_by: 'video.some_field.sub_field',\n})// Example result\n;[\n {\n video: {\n channel_id: 'UCOSYb4yvogm0SAI8rX8kGWQ',\n duration_millis: 40356,\n id: 'V_jS8nLLpZI',\n resource_name: 'customers/3827277046/videos/Vl9qUzhuTExwWkk',\n title: 'Opteo',\n },\n ad_group_ad: {\n ad: {\n added_by_google_ads: false,\n device_preference: 0,\n display_url: 'opteo.com',\n final_app_urls: [],\n final_mobile_urls: [],\n final_urls: ['https://opteo.com'],\n id: 376678647998,\n name: 'Animation',\n resource_name: 'customers/3827277046/ads/376678647998',\n system_managed_resource_source: 0,\n type: 29,\n url_collections: [],\n url_custom_parameters: [],\n video_ad: {\n in_stream: { companion_banner: 'customers/3827277046/mediaFiles/4570107325' },\n media_file: 'customers/3827277046/mediaFiles/4565915444',\n },\n },\n ad_group: 'customers/3827277046/adGroups/55719719421',\n ad_strength: 0,\n policy_summary: { approval_status: 4, policy_topic_entries: [], review_status: 3 },\n resource_name: 'customers/3827277046/adGroupAds/55719719421~376678647998',\n status: 2,\n },\n ad_group: {\n ad_rotation_mode: 0,\n base_ad_group: 'customers/3827277046/adGroups/55719719421',\n campaign: 'customers/3827277046/campaigns/1546686126',\n cpc_bid_micros: 0,\n cpm_bid_micros: 10000,\n cpv_bid_micros: 100000,\n display_custom_bid_dimension: 0,\n effective_target_cpa_micros: 0,\n effective_target_cpa_source: 0,\n effective_target_roas_source: 0,\n explorer_auto_optimizer_setting: { opt_in: false },\n id: 55719719421,\n labels: [],\n name: 'My ad group',\n resource_name: 'customers/3827277046/adGroups/55719719421',\n status: 2,\n target_cpa_micros: 0,\n targeting_setting: {\n target_restrictions: [\n { targeting_dimension: 3, bid_only: false },\n { targeting_dimension: 4, bid_only: false },\n { targeting_dimension: 5, bid_only: false },\n { targeting_dimension: 6, bid_only: false },\n { targeting_dimension: 7, bid_only: false },\n { targeting_dimension: 8, bid_only: false },\n { targeting_dimension: 9, bid_only: false },\n ],\n },\n type: 9,\n url_custom_parameters: [],\n },\n campaign: {\n ad_serving_optimization_status: 2,\n advertising_channel_sub_type: 0,\n advertising_channel_type: 6,\n base_campaign: 'customers/3827277046/campaigns/1546686126',\n bidding_strategy_type: 13,\n campaign_budget: 'customers/3827277046/campaignBudgets/1601905358',\n end_date: '2037-12-30',\n experiment_type: 2,\n frequency_caps: [{ key: { level: 4, event_type: 2, time_unit: 2, time_length: 1 }, cap: 1 }],\n geo_target_type_setting: { negative_geo_target_type: 5, positive_geo_target_type: 7 },\n id: 1546686126,\n labels: ['customers/3827277046/labels/3353203258'],\n manual_cpv: {},\n name: 'My campaign',\n network_settings: {\n target_content_network: false,\n target_google_search: false,\n target_partner_search_network: false,\n target_search_network: false,\n },\n payment_mode: 4,\n resource_name: 'customers/3827277046/campaigns/1546686126',\n serving_status: 2,\n start_date: '2018-09-07',\n status: 2,\n url_custom_parameters: [],\n video_brand_safety_suitability: 3,\n },\n customer: {\n auto_tagging_enabled: true,\n call_reporting_setting: {\n call_conversion_action: 'customers/3827277046/conversionActions/179',\n call_conversion_reporting_enabled: true,\n call_reporting_enabled: true,\n },\n conversion_tracking_setting: { conversion_tracking_id: 875176189 },\n currency_code: 'GBP',\n descriptive_name: 'My customer',\n final_url_suffix:\n 'wickedsource=google&wickedid={creative}&wtm_term={ifsearch:{keyword}}{ifcontent:{placement}}&wtm_campaign={campaignid}&wtm_content={adgroupid}&wickedplacement={placement}&wickedkeyword={keyword}&gclid={gclid}',\n has_partners_badge: false,\n id: 3827277046,\n manager: false,\n optimization_score: 0.8214771414132993,\n pay_per_conversion_eligibility_failure_reasons: [],\n remarketing_setting: {\n google_global_site_tag:\n \"<!-- Global site tag (gtag.js) - Google Ads: 875176189 -->\\n<script async src=\\\"https://www.googletagmanager.com/gtag/js?id=AW-875176189\\\"></script>\\n<script>\\n window.dataLayer = window.dataLayer || [];\\n function gtag(){dataLayer.push(arguments);}\\n gtag('js', new Date());\\n\\n gtag('config', 'AW-875176189');\\n</script>\\n\",\n },\n resource_name: 'customers/3827277046',\n test_account: false,\n time_zone: 'Europe/London',\n tracking_url_template:\n 'https://w.opteo.co/workers/ct?url={lpurl}&domain_id=123443&campaign_id={campaignid}&adgroup_id={adgroupid}&matchtype={matchtype}&network={network}&device={device}&keyword={keyword}&targetid={targetid}',\n },\n },\n]