Close httplib2 connections.
get(profileId, id, x__xgafv=None)
Gets one targeting template by ID.
insert(profileId, body=None, x__xgafv=None)
Inserts a new targeting template.
Retrieves a list of targeting templates, optionally filtered. This method supports paging.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(profileId, id, body=None, x__xgafv=None)
Updates an existing targeting template. This method supports patch semantics.
update(profileId, body=None, x__xgafv=None)
Updates an existing targeting template.
close()
Close httplib2 connections.
get(profileId, id, x__xgafv=None)
Gets one targeting template by ID. Args: profileId: string, User profile ID associated with this request. (required) id: string, Targeting template ID. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, }
insert(profileId, body=None, x__xgafv=None)
Inserts a new targeting template. Args: profileId: string, User profile ID associated with this request. (required) body: object, The request body. The object takes the form of: { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, }
list(profileId, advertiserId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
Retrieves a list of targeting templates, optionally filtered. This method supports paging. Args: profileId: string, User profile ID associated with this request. (required) advertiserId: string, Select only targeting templates with this advertiser ID. ids: string, Select only targeting templates with these IDs. (repeated) maxResults: integer, Maximum number of results to return. pageToken: string, Value of the nextPageToken from the previous result page. searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". sortField: string, Field by which to sort the list. Allowed values ID - NAME - sortOrder: string, Order of sorted results. Allowed values ASCENDING - DESCENDING - x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Targeting Template List Response "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". "nextPageToken": "A String", # Pagination token to be used for the next list operation. "targetingTemplates": [ # Targeting template collection. { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, }, ], }
list_next(previous_request, previous_response)
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
patch(profileId, id, body=None, x__xgafv=None)
Updates an existing targeting template. This method supports patch semantics. Args: profileId: string, User profile ID associated with this request. (required) id: string, TargetingTemplate ID. (required) body: object, The request body. The object takes the form of: { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, }
update(profileId, body=None, x__xgafv=None)
Updates an existing targeting template. Args: profileId: string, User profile ID associated with this request. (required) body: object, The request body. The object takes the form of: { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. "dimensionName": "A String", # The name of the dimension. "etag": "A String", # The eTag of this response for caching purposes. "id": "A String", # The ID associated with the value if available. "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. "value": "A String", # The value of the dimension. }, "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria. "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" "A String", ], "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. 42, ], "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies. }, "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria. "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. { # Contains information about a city that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this city belongs. "countryDartId": "A String", # DART ID of the country to which this city belongs. "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs. "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs. "name": "A String", # Name of this city. "regionCode": "A String", # Region code of the region to which this city belongs. "regionDartId": "A String", # DART ID of the region to which this city belongs. }, ], "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. { # Contains information about a country that can be targeted by ads. "countryCode": "A String", # Country code. "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". "name": "A String", # Name of this country. "sslEnabled": True or False, # Whether ad serving supports secure servers in this country. }, ], "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. { # Contains information about a metro region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this metro region belongs. "countryDartId": "A String", # DART ID of the country to which this metro region belongs. "dartId": "A String", # DART ID of this metro region. "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id. "name": "A String", # Name of this metro region. }, ], "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. { # Contains information about a postal code that can be targeted by ads. "code": "A String", # Postal code. This is equivalent to the id field. "countryCode": "A String", # Country code of the country to which this postal code belongs. "countryDartId": "A String", # DART ID of the country to which this postal code belongs. "id": "A String", # ID of this postal code. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". }, ], "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. { # Contains information about a region that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this region belongs. "countryDartId": "A String", # DART ID of the country to which this region belongs. "dartId": "A String", # DART ID of this region. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". "name": "A String", # Name of this region. "regionCode": "A String", # Region code. }, ], }, "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field. "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria. "expression": "A String", # Keyword expression being targeted by the ad. }, "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". "languageTargeting": { # Language Targeting. # Language targeting criteria. "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a language that can be targeted by ads. "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. "name": "A String", # Name of this language. }, ], }, "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria. "expression": "A String", # Expression describing which lists are being targeted by the ad. }, "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria. "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about a browser that can be targeted by ads. "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting. "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. "name": "A String", # Name of this browser. }, ], "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. "id": "A String", # ID of this connection type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". "name": "A String", # Name of this connection type. }, ], "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. { # Contains information about a mobile carrier that can be targeted by ads. "countryCode": "A String", # Country code of the country to which this mobile carrier belongs. "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs. "id": "A String", # ID of this mobile carrier. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". "name": "A String", # Name of this mobile carrier. }, ], "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. { # Contains information about a particular version of an operating system that can be targeted by ads. "id": "A String", # ID of this operating system version. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". "majorVersion": "A String", # Major version (leftmost number) of this operating system version. "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version. "name": "A String", # Name of this operating system version. "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, }, ], "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. { # Contains information about an operating system that can be targeted by ads. "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting. "desktop": True or False, # Whether this operating system is for desktop. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". "mobile": True or False, # Whether this operating system is for mobile. "name": "A String", # Name of this operating system. }, ], "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. { # Contains information about a platform type that can be targeted by ads. "id": "A String", # ID of this platform type. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". "name": "A String", # Name of this platform type. }, ], }, }